frwk.h

Go to the documentation of this file.

/*  \mainpage My Personal Index Page
    Resistance's Portable-Adventure-Game-Engine (R-PAGE), Copyright (C) 2019 François Gutherz, Resistance.no
    Released under MIT License, see license.txt for details.
*/

#ifndef _FRAMEWORK_HEADER_
#define _FRAMEWORK_HEADER_

#include "rpage/utils.h"

#ifdef LATTICE
#include <exec/types.h>
#include <graphics/gfx.h>
#include "rpage/aos/color.h"
#include "rpage/aos/screen_size.h"

typedef BPTR rpage_file;
typedef struct BitMap rpage_bitmap;
#ifdef VGA_ENABLED
typedef unsigned long rpage_palette;
#else
typedef unsigned short rpage_palette;
#endif
typedef struct SimpleSprite rpage_hardware_sprite;

#define MAX_HARDWARE_SPRITES 8
#define PLATFORM_DRAW_TWICE(_EXPR_){rpage_video_flip_buffers(); _EXPR_; rpage_video_present_screen(); rpage_video_flip_buffers(); _EXPR_; rpage_video_present_screen(); }

#define MODE_OPEN_FILE      MODE_OLDFILE
#define MODE_CREATE_FILE    MODE_NEWFILE
#define MODE_OPEN_OR_CREATE MODE_READWRITE

#endif

#ifdef WIN32
#define SDL_MAIN_HANDLED
#include <SDL.h>
#include <Windows.h>
typedef SDL_Texture rpage_bitmap;
typedef SDL_Color rpage_palette;
#define PLATFORM_DRAW_TWICE(_EXPR_);
#endif



/* Platform-agnostic game interface */

enum rpage_screen_modes
{
    mode_lowres,
    mode_medres,
    mode_hires
};

void rpage_init(void);
void rpage_uninit(void);

BYTE rpage_set_process_priority(BYTE new_priority);
void rpage_system_alert(char *alert_message);
void rpage_system_flash(void);
void rpage_free_memory_block(BYTE *block_ptr, UWORD block_size);
ULONG rpage_get_avail_video_memory(void);
ULONG rpage_get_avail_largest_video_memory(void);
ULONG rpage_get_avail_non_video_memory(void);
ULONG rpage_get_avail_memory(void);
void rpage_reclaim_system_memory(void);

ULONG rpage_get_clock(void);

rpage_file rpage_file_open(char *filename, long mode);
void rpage_file_close(rpage_file file);
long rpage_file_read(rpage_file file, void *buffer, long len);
long rpage_file_write(rpage_file file, void *buffer, long len);

void rpage_video_open(int screen_mode);
void rpage_video_close(void);
UWORD rpage_video_get_depth(void);
void rpage_video_clear(void);
void rpage_video_clear_bit_mask(UBYTE bit_mask);
void rpage_video_set_font(char *font_filename, short font_size);
void rpage_video_vsync(void);
void rpage_video_wait_dma(void);
void rpage_video_flip_buffers(void);
void rpage_video_present_screen(void);
void rpage_video_present_palette(void);
void rpage_video_sync_buffers(void);
void rpage_video_screen_to_front(void);
void rpage_video_screen_to_back(void);
void rpage_video_scroll(short x, short y);

void rpage_video_scroll_bit_mask(short x, short y, UBYTE bit_mask);
void rpage_video_blt_bmp(rpage_bitmap *source_bitmap, short source_x, short source_y, short width, short height, short x, short y);
void rpage_video_blt_bmp_bt(rpage_bitmap *source_bitmap, short source_x, short source_y, short width, short height, short x, short y, UBYTE bit_mask);
void rpage_video_blt_bmp_mask(rpage_bitmap *source_bitmap, short source_x, short source_y, short width, short height, short x, short y, rpage_bitmap *mask_bitmap);
void rpage_video_blt_bmp_clip(rpage_bitmap *source_bitmap, short source_x, short source_y, short width, short height, short x, short y, rect *clipping_rect);
void rpage_video_blt_bmp_clip_mask(rpage_bitmap *source_bitmap, short source_x, short source_y, short width, short height, short x, short y, rpage_bitmap *mask_bitmap, rect *clipping_rect);
void rpage_video_blt_bmp_clip_mask_bt(rpage_bitmap *source_bitmap, short source_x, short source_y, short width, short height, short x, short y, rpage_bitmap *mask_bitmap, rect *clipping_rect, UBYTE bit_mask);
void rpage_video_set_palette(rpage_palette *palette, short palette_size);
void rpage_video_set_palette_to_black(short first_color, short last_color);
void rpage_video_set_palette_to_grey(short first_color, short last_color);
void rpage_video_draw_polygon(poly *p, short color);
void rpage_video_draw_rect(rect *r, short color_index);
void rpage_video_fill_rect(rect *r, short color);
void rpage_video_fill_rect_clip(rect *r, short color, rect *clipping_rect);
void rpage_video_set_pixel(short x, short y, short color_index);
short rpage_video_get_pixel(short x, short y);
void rpage_video_draw_text(char *str, short x, short y, short color_index);
void rpage_video_draw_text_bit_mask(char *str, short x, short y, short color_index, UBYTE bit_mask);
short rpage_video_get_text_width(char *str);
void rpage_video_draw_tileset(rpage_bitmap *tileset_bitmap, UBYTE *tileset, rect *tile_rect, short tileset_width);
void rpage_video_save_to_bitmap(rpage_bitmap *dest_bitmap, short source_x, short source_y, short width, short height);
void rpage_video_show_freemem(short x, short y, short width, short height);

void rpage_bitmap_draw_tileset(rpage_bitmap *dest_bitmap, rpage_bitmap *tileset_bitmap, UBYTE *tileset, rect *tile_rect, short tileset_width);
void rpage_bitmap_blit(rpage_bitmap *source_bitmap, short source_x, short source_y, short width, short height, short x, short y, rpage_bitmap *dest_bitmap);

ULONG rpage_bitmap_calculate_bytesize(short width, short height, short depth);
rpage_bitmap *rpage_bitmap_new(short width, short height, short depth);
BOOL rpage_load_pak_into_bitmap(rpage_bitmap **bitmap, rpage_palette **palette, BYTE *packed_buffer, char *filename);
short rpage_bitmap_get_width(rpage_bitmap *bitmap);
short rpage_bitmap_get_height(rpage_bitmap *bitmap);
short rpage_bitmap_get_depth(rpage_bitmap *bitmap);
void rpage_bitmap_clear(rpage_bitmap *bitmap);
BOOL rpage_load_pak_to_new_bitmap(rpage_bitmap **new_bitmap, rpage_palette **new_palette, BYTE *packed_buffer, char *bitmap_filename);
void rpage_bitmap_free(rpage_bitmap *bitmap);

void rpage_move_sprite(short sprite_index, rpage_hardware_sprite *sprite, vec2 *position);
void rpage_remove_sprite(short sprite_index);
BOOL rpage_sprite_is_enabled(short sprite_index);

BOOL rpage_input_init(void);
void rpage_input_update(void);
void rpage_input_enable(BOOL enabled);
void rpage_mouse_button_flush(void);
void rpage_mouse_set_system_image(unsigned short img_index);
void rpage_mouse_show(void);
void rpage_mouse_wait(void);
void rpage_mouse_read(void);
void rpage_mouse_hide(void);
void rpage_mouse_set_bitmap(UWORD *sprite_data, vec2 *hotspot);
void rpage_mouse_get_values(short *button, vec2 *mouse_coords);
void rpage_mouse_get_prev_values(short *button, vec2 *mouse_coords);
BOOL rpage_mouse_button_left_is_down(void);
BOOL rpage_mouse_button_right_is_down(void);
BOOL rpage_mouse_button_left_was_down(void);
BOOL rpage_mouse_button_right_was_down(void);
unsigned short rpage_keyboard_rawkey(void);

#endif