#include "rpage/utils.h"

Enumerations
enum	rpage_screen_modes { mode_lowres, mode_medres, mode_hires }

Functions
void	rpage_init (void)

void	rpage_uninit (void)
	Un-initialize the framework, close the system libraries. More...

BYTE	rpage_set_process_priority (BYTE new_priority)

void	rpage_system_alert (char *alert_message)
	Opens a GURU MEDITATION message. More...

void	rpage_system_flash (void)
	Use the system function BELL/RING/FLASH to send a visual/audio alert. More...

void	rpage_free_memory_block (BYTE *block_ptr, UWORD block_size)
	Wrapper to the system-specific memory deallocator. More...

ULONG	rpage_get_avail_video_memory (void)
	Return how many free memory is available to store the graphics data (aka Chipram on the Amiga side). More...

ULONG	rpage_get_avail_largest_video_memory (void)
	Return the largest free memory block available to store the graphics data (aka Chipram on the Amiga side). More...

ULONG	rpage_get_avail_non_video_memory (void)
	Return how many general purpose free memory is available (aka Fastram/Slowram on the Amiga side). More...

ULONG	rpage_get_avail_memory (void)
	Return the total of available memory. More...

void	rpage_reclaim_system_memory (void)
	Try to deallocate as many system resources as possible. More...

ULONG	rpage_get_clock (void)
	Get the elapsed time, in milliseconds, since rpage_init was invoked. More...

rpage_file	rpage_file_open (char *filename, long mode)

void	rpage_file_close (rpage_file file)
	Close a current file. More...

long	rpage_file_read (rpage_file file, void *buffer, long len)
	Read data from file into a buffer. More...

long	rpage_file_write (rpage_file file, void *buffer, long len)
	Write a data buffer into the file. More...

void	rpage_video_open (int screen_mode)

void	rpage_video_close (void)
	Close the video output, deallocate the screen framebuffer. More...

UWORD	rpage_video_get_depth (void)
	Get bit depth of the screen. More...

void	rpage_video_clear (void)
	Clear the screen. More...

void	rpage_video_clear_bit_mask (UBYTE bit_mask)
	Set the default font file/size for every next call to rpage_video_draw_text. More...

void	rpage_video_set_font (char *font_filename, short font_size)

void	rpage_video_vsync (void)
	Wait for the vertical blank. More...

void	rpage_video_wait_dma (void)
	Wait for the completion of all ongoing DMA transfert (including the blitter operation, on the Amiga side). More...

void	rpage_video_flip_buffers (void)

void	rpage_video_present_screen (void)
	Tell R-PAGE to swap the logical and the physical buffers. Everything that was drawn into the logical buffer will become visible. More...

void	rpage_video_present_palette (void)
	Swap logical & physical palettes. More...

void	rpage_video_sync_buffers (void)
	Hard copy the content of the physical buffer to the logical buffer. On the Amiga side This function may use the Blitter. More...

void	rpage_video_screen_to_front (void)
	Bring the game screen to top (Amiga only) More...

void	rpage_video_screen_to_back (void)
	Send the game screen to the back (Amiga only) More...

void	rpage_video_scroll (short x, short y)
	Hardware scrolling. More...

void	rpage_video_scroll_bit_mask (short x, short y, UBYTE bit_mask)
	FIXME! More...

void	rpage_video_blt_bmp (rpage_bitmap *source_bitmap, short source_x, short source_y, short width, short height, short x, short y)
	Blit a bitmap into the screen. More...

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)
	Blit a bitmap into the screen using a bitplan mask, each bit of the 'bt' parameter being the mask for each bitplan. More...

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)
	Blacken the current palette of the screen. More...

void	rpage_video_set_palette_to_grey (short first_color, short last_color)
	Set the current palette of the screen to a gradient of greys. More...

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)
	Draw a pixel to the screen. More...

short	rpage_video_get_pixel (short x, short y)
	Get the color of a pixel on screen. More...

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)
	Get text width in pixels. More...

void	rpage_video_draw_tileset (rpage_bitmap tileset_bitmap, UBYTE tileset, rect *tile_rect, short tileset_width)
	Draw a tileset-based image to the current screen. More...

void	rpage_video_save_to_bitmap (rpage_bitmap *dest_bitmap, short source_x, short source_y, short width, short height)
	Store a part of the current screen into a bitmap. More...

void	rpage_video_show_freemem (short x, short y, short width, short height)
	Display the amount of free memory (DEBUG ONLY) More...

void	rpage_bitmap_draw_tileset (rpage_bitmap dest_bitmap, rpage_bitmap tileset_bitmap, UBYTE tileset, rect tile_rect, short tileset_width)
	Draw a tileset-based image into a bitmap. More...

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)
	Blit the destination bitmap into the source bitmap. More...

ULONG	rpage_bitmap_calculate_bytesize (short width, short height, short depth)
	Return the size in bytes of a ::rpage_bitmap. More...

rpage_bitmap *	rpage_bitmap_new (short width, short height, short depth)
	Allocate a new ::rpage_bitmap and return its address in video memory. More...

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)
	Return the width in pixels of a ::rpage_bitmap. More...

short	rpage_bitmap_get_height (rpage_bitmap *bitmap)
	Return the height in pixels of a ::rpage_bitmap. More...

short	rpage_bitmap_get_depth (rpage_bitmap *bitmap)
	Return the bitwise depth of a ::rpage_bitmap. More...

void	rpage_bitmap_clear (rpage_bitmap *bitmap)
	Clear the current bitmap (fill it with 0, aka index 0 color) More...

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)
	Refresh the image/position of an hardware sprite. More...

void	rpage_remove_sprite (short sprite_index)
	Remove the sprite based on his index. More...

BOOL	rpage_sprite_is_enabled (short sprite_index)
	Returns TRUE is the sprite with this index is currently enabled. More...

BOOL	rpage_input_init (void)

void	rpage_input_update (void)
	Pull the mouse/keyboard update from the input system. More...

void	rpage_input_enable (BOOL enabled)
	Enable or disable the input pooling (Enabled by default) More...

void	rpage_mouse_button_flush (void)

void	rpage_mouse_set_system_image (unsigned short img_index)
	Private function that sets a bitmap to the mouse cursor. More...

void	rpage_mouse_show (void)
	Show the mouse cursor. More...

void	rpage_mouse_wait (void)
	Change the look of the mouse cursor to warn the end-user that the application is currently busy. More...

void	rpage_mouse_read (void)
	Change the look of the mouse cursor to warn the end-user that s.he should read some text. More...

void	rpage_mouse_hide (void)
	Hide the mouse cursor. More...

void	rpage_mouse_set_bitmap (UWORD sprite_data, vec2 hotspot)
	Defines the new aspect of the mouse cursor. Bitmap format is the regular Amiga hardware sprite format. More...

void	rpage_mouse_get_values (short button, vec2 mouse_coords)
	Read the current mouse coordinates and button states. More...

void	rpage_mouse_get_prev_values (short button, vec2 mouse_coords)

BOOL	rpage_mouse_button_left_is_down (void)
	Test if the left mouse button is currently pressed. More...

BOOL	rpage_mouse_button_right_is_down (void)
	Test if the right mouse button is currently pressed. More...

BOOL	rpage_mouse_button_left_was_down (void)
	Test if the left mouse button was pressed but isn't anymore. More...

BOOL	rpage_mouse_button_right_was_down (void)
	Test if the right mouse button was pressed but isn't anymore. More...

unsigned short	rpage_keyboard_rawkey (void)
	Raw read the keyboard input. More...

Enumeration Type Documentation

enum rpage_screen_modes

Enumerator
mode_lowres
mode_medres
mode_hires

Definition at line 51 of file frwk.h.

Function Documentation

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
	)

Blit the destination bitmap into the source bitmap.

ULONG rpage_bitmap_calculate_bytesize	(	short	width,
		short	height,
		short	depth
	)

Return the size in bytes of a ::rpage_bitmap.

void rpage_bitmap_clear ( rpage_bitmap * bitmap )

Clear the current bitmap (fill it with 0, aka index 0 color)

void rpage_bitmap_draw_tileset	(	rpage_bitmap *	dest_bitmap,
		rpage_bitmap *	tileset_bitmap,
		UBYTE *	tileset,
		rect *	tile_rect,
		short	tileset_width
	)

Draw a tileset-based image into a bitmap.

void rpage_bitmap_free ( rpage_bitmap * bitmap )

Free the memory allocated by a ::rpage_bitmap.
The possiblity related ::rpage_palette is not automatically freed.

short rpage_bitmap_get_depth ( rpage_bitmap * bitmap )

Return the bitwise depth of a ::rpage_bitmap.

short rpage_bitmap_get_height ( rpage_bitmap * bitmap )

Return the height in pixels of a ::rpage_bitmap.

short rpage_bitmap_get_width ( rpage_bitmap * bitmap )

Return the width in pixels of a ::rpage_bitmap.

rpage_bitmap* rpage_bitmap_new	(	short	width,
		short	height,
		short	depth
	)

Allocate a new ::rpage_bitmap and return its address in video memory.

void rpage_file_close ( rpage_file file )

Close a current file.

rpage_file rpage_file_open	(	char *	filename,
		long	mode
	)

Standard file open, using the OS layer. 'mode' can be set to:

MODE_OPEN_FILE: an existing file is opened for reading or writing
MODE_CREATE_FILE: a new file is created for writing
MODE_OPEN_OR_CREATE: opens a file with an shared lock, but creates it if it didn't exist

long rpage_file_read	(	rpage_file	file,
		void *	buffer,
		long	len
	)

Read data from file into a buffer.

long rpage_file_write	(	rpage_file	file,
		void *	buffer,
		long	len
	)

Write a data buffer into the file.

void rpage_free_memory_block	(	BYTE *	block_ptr,
		UWORD	block_size
	)

Wrapper to the system-specific memory deallocator.

ULONG rpage_get_avail_largest_video_memory ( void )

Return the largest free memory block available to store the graphics data (aka Chipram on the Amiga side).

ULONG rpage_get_avail_memory ( void )

Return the total of available memory.

ULONG rpage_get_avail_non_video_memory ( void )

Return how many general purpose free memory is available (aka Fastram/Slowram on the Amiga side).

ULONG rpage_get_avail_video_memory ( void )

Return how many free memory is available to store the graphics data (aka Chipram on the Amiga side).

ULONG rpage_get_clock ( void )

Get the elapsed time, in milliseconds, since rpage_init was invoked.

void rpage_init ( void )

Initialize the framework.
Open the required system libraries (Graphics, Intuition, DiskFont on the Amiga side), reset the global timer and get the current task ID.

void rpage_input_enable ( BOOL enabled )

Enable or disable the input pooling (Enabled by default)

BOOL rpage_input_init ( void )

Initialize the input system.
On the Amiga side, the input system needs a Window to be created. This is done automatically by R-PAGE when calling rpage_video_open. As a consequence, the input won't work if no screen was created first.

void rpage_input_update ( void )

Pull the mouse/keyboard update from the input system.

unsigned short rpage_keyboard_rawkey ( void )

Raw read the keyboard input.

BOOL rpage_load_pak_into_bitmap	(	rpage_bitmap **	bitmap,
		rpage_palette **	palette,
		BYTE *	packed_buffer,
		char *	filename
	)

Load a .PAK bitmap file into an existing bitmap.

The ::rpage_bitmap and ::rpage_palette must be allocated before calling this function.
the packed_buffer must be allocated before calling this function.

BOOL rpage_load_pak_to_new_bitmap	(	rpage_bitmap **	new_bitmap,
		rpage_palette **	new_palette,
		BYTE *	packed_buffer,
		char *	bitmap_filename
	)

Load a .PAK bitmap file into a new bitmap, self allocated by the function.

The ::rpage_bitmap and ::rpage_palette will be automatically allocated by the function.
If packed_buffer equals ::NULL, it will be automatically allocated by the function. Otherwise, R-PAGE will assume it contains the address of an already allocated block of memory.

void rpage_mouse_button_flush ( void )

Flush the latest mouse update from the input system.
This maybe required on a multitasking system.

BOOL rpage_mouse_button_left_is_down ( void )

Test if the left mouse button is currently pressed.

BOOL rpage_mouse_button_left_was_down ( void )

Test if the left mouse button was pressed but isn't anymore.

BOOL rpage_mouse_button_right_is_down ( void )

Test if the right mouse button is currently pressed.

BOOL rpage_mouse_button_right_was_down ( void )

Test if the right mouse button was pressed but isn't anymore.

void rpage_mouse_get_prev_values	(	short *	button,
		vec2 *	mouse_coords
	)

Read the previous mouse coordinates and button states.
This might be useful when you need to calculate the delta/velocity of the mouse, or check is the mouse buttons where previously pressed.

void rpage_mouse_get_values	(	short *	button,
		vec2 *	mouse_coords
	)

Read the current mouse coordinates and button states.

void rpage_mouse_hide ( void )

Hide the mouse cursor.

void rpage_mouse_read ( void )

Change the look of the mouse cursor to warn the end-user that s.he should read some text.

void rpage_mouse_set_bitmap	(	UWORD *	sprite_data,
		vec2 *	hotspot
	)

Defines the new aspect of the mouse cursor. Bitmap format is the regular Amiga hardware sprite format.

void rpage_mouse_set_system_image ( unsigned short img_index )

Private function that sets a bitmap to the mouse cursor.

void rpage_mouse_show ( void )

Show the mouse cursor.

void rpage_mouse_wait ( void )

Change the look of the mouse cursor to warn the end-user that the application is currently busy.

void rpage_move_sprite	(	short	sprite_index,
		rpage_hardware_sprite *	sprite,
		vec2 *	position
	)

Refresh the image/position of an hardware sprite.

void rpage_reclaim_system_memory ( void )

Try to deallocate as many system resources as possible.

void rpage_remove_sprite ( short sprite_index )

Remove the sprite based on his index.

BYTE rpage_set_process_priority ( BYTE new_priority )

Set the multitasking priority of the current task.
On the Amiga side, this function takes -127 to +127 as a parameter, the higher the more CPU time is allocated to the task.

BOOL rpage_sprite_is_enabled ( short sprite_index )

Returns TRUE is the sprite with this index is currently enabled.

void rpage_system_alert ( char * alert_message )

Opens a GURU MEDITATION message.

void rpage_system_flash ( void )

Use the system function BELL/RING/FLASH to send a visual/audio alert.

void rpage_uninit ( void )

Un-initialize the framework, close the system libraries.

void rpage_video_blt_bmp	(	rpage_bitmap *	source_bitmap,
		short	source_x,
		short	source_y,
		short	width,
		short	height,
		short	x,
		short	y
	)

Blit a bitmap into the screen.

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
	)

Blit a bitmap into the screen using a bitplan mask, each bit of the 'bt' parameter being the mask for each bitplan.

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
	)

Blit a bitmap into the screen.

A 2D clipping operation is done, based on the clipping rect provided

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
	)

Blit a bitmap into the screen.
A bitmap mask is used to merge the source into the destination. The bitmap mask should be 1bit wide.

A 2D clipping operation is done, based on the clipping rect provided

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
	)

Blit a bitmap into the screen.

A 2D clipping operation is done, based on the clipping rect provided
A bitmask is applied to every pixel during the blit.

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
	)

Blit a bitmap into the screen.
A bitmap mask is used to merge the source into the destination. The bitmap mask should be 1bit wide.

void rpage_video_clear ( void )

Clear the screen.

void rpage_video_clear_bit_mask ( UBYTE bit_mask )

Set the default font file/size for every next call to rpage_video_draw_text.

void rpage_video_close ( void )

Close the video output, deallocate the screen framebuffer.

void rpage_video_draw_polygon	(	poly *	p,
		short	color
	)

Draw an empty polygon (quad only) to the screen.

Color index range is (0,31) on the Amiga side.

void rpage_video_draw_rect	(	rect *	r,
		short	color_index
	)

Draw an empty rect to the screen.

Color index range is (0,31) on the Amiga side.

void rpage_video_draw_text	(	char *	str,
		short	x,
		short	y,
		short	color_index
	)

Draw a text string to the screen.

The font must be defined prior to this operation, see rpage_video_set_font

void rpage_video_draw_text_bit_mask	(	char *	str,
		short	x,
		short	y,
		short	color_index,
		UBYTE	bit_mask
	)

void rpage_video_draw_tileset	(	rpage_bitmap *	tileset_bitmap,
		UBYTE *	tileset,
		rect *	tile_rect,
		short	tileset_width
	)

Draw a tileset-based image to the current screen.

void rpage_video_fill_rect	(	rect *	r,
		short	color
	)

Draw a filled rect to the screen.

Color index range is (0,31) on the Amiga side.
A 2D clipping operation is done, based on the clipping rect provided

void rpage_video_fill_rect_clip	(	rect *	r,
		short	color,
		rect *	clipping_rect
	)

void rpage_video_flip_buffers ( void )

Tell R-PAGE to redirect every next graphic drawing operations to the logical buffer.
If the function is called again, all the drawing operations will be performed in the physical buffer again.
This is how double buffering is handled by R-PAGE.

UWORD rpage_video_get_depth ( void )

Get bit depth of the screen.

short rpage_video_get_pixel	(	short	x,
		short	y
	)

Get the color of a pixel on screen.

short rpage_video_get_text_width ( char * str )

Get text width in pixels.

void rpage_video_open ( int screen_mode )

Open the main video output by allocating a blank screen framebuffer.
The screenmode is defined by rpage_screen_modes. The current enum is tied to the regular Amiga OCS specifications.

void rpage_video_present_palette ( void )

Swap logical & physical palettes.

void rpage_video_present_screen ( void )

Tell R-PAGE to swap the logical and the physical buffers. Everything that was drawn into the logical buffer will become visible.

void rpage_video_save_to_bitmap	(	rpage_bitmap *	dest_bitmap,
		short	source_x,
		short	source_y,
		short	width,
		short	height
	)

Store a part of the current screen into a bitmap.

void rpage_video_screen_to_back ( void )

Send the game screen to the back (Amiga only)

void rpage_video_screen_to_front ( void )

Bring the game screen to top (Amiga only)

void rpage_video_scroll	(	short	x,
		short	y
	)

Hardware scrolling.

void rpage_video_scroll_bit_mask	(	short	x,
		short	y,
		UBYTE	bit_mask
	)

FIXME!

void rpage_video_set_font	(	char *	font_filename,
		short	font_size
	)

void rpage_video_set_palette	(	rpage_palette *	palette,
		short	palette_size
	)

Set the current palette of the screen.
The color format is RGB444.

void rpage_video_set_palette_to_black	(	short	first_color,
		short	last_color
	)

Blacken the current palette of the screen.

void rpage_video_set_palette_to_grey	(	short	first_color,
		short	last_color
	)

Set the current palette of the screen to a gradient of greys.

void rpage_video_set_pixel	(	short	x,
		short	y,
		short	color_index
	)

Draw a pixel to the screen.

void rpage_video_show_freemem	(	short	x,
		short	y,
		short	width,
		short	height
	)

Display the amount of free memory (DEBUG ONLY)

void rpage_video_sync_buffers ( void )

Hard copy the content of the physical buffer to the logical buffer. On the Amiga side This function may use the Blitter.

void rpage_video_vsync ( void )

Wait for the vertical blank.

void rpage_video_wait_dma ( void )

Wait for the completion of all ongoing DMA transfert (including the blitter operation, on the Amiga side).

Enumerations

Functions

Enumeration Type Documentation

Function Documentation