RETROFLAT_STATE Struct Reference

Global singleton containing state for the current platform. More...

#include <retroflt.h>

Collaboration diagram for RETROFLAT_STATE:

Data Fields
size_t	sz
size_t	offset_pal
size_t	offset_tex_pal
void *	loop_data
MERROR_RETVAL	retval
uint8_t	retroflat_flags
	maug_retroflt_flags indicating current system status.
maug_path	config_path
maug_path	assets_path
maug_path	saves_path
int	screen_scale
	Off-screen buffer bitmap.
struct RETROFLAT_BITMAP *	vdp_buffer
	A buffer assembled and passed to the RetroFlat VDP API for it to modify, or NULL if no VDP is loaded.
void *	vdp_exe
	A handle for the loaded RetroFlat VDP API module.
void *	vdp_data
	Pointer to data defined by the RetroFlat VDP API for its use.
char	vdp_args [RETROFLAT_VDP_ARGS_SZ_MAX]
	CLI args passed with -vdp to the RetroFlat VDP API.
uint8_t	vdp_flags
	Flags set by the RetroFlat VDP API.
struct RETROFLAT_VIEWPORT	viewport
size_t	screen_v_w
	The screen width as seen by our program, before scaling. More...
size_t	screen_v_h
	The screen height as seen by our program, before scaling. More...
size_t	screen_w
	The screen width as seen by the system, after scaling.
size_t	screen_h
	The screen height as seen by the system, after scaling.
size_t	screen_colors
	The number of colors the screen is capable of displaying.
retroflat_ms_t	heartbeat_next
uint16_t	heartbeat_len
	Number of ms to stay on current value of RETROFLAT_STATE::heartbeat_frame before incrementing. Modify with retroflat_heartbeat_set().
uint8_t	heartbeat_frame
	Simple iteration loop that can be used to time e.g. perpetual sprite animations. Modify parameters with retroflat_heartbeat_set().
uint8_t	heartbeat_max
	When RETROFLAT_STATE::heartbeat_frame reaches this value, it will reset to 0.
retroflat_proc_resize_t	on_resize
void *	on_resize_data
RETROFLAT_COLOR_DEF	palette [RETROFLAT_COLORS_SZ]
	Index of available colors, initialized on platform init.
retroflat_loop_iter	loop_iter
retroflat_loop_iter	frame_iter
struct RETROFLAT_PLATFORM	platform
struct RETROFLAT_INPUT_STATE	input
retroflat_timer_cb_t	timers_cb [RETROFLAT_TIMER_CT_MAX]
	List of installable timers that should be tended every frame with retroflat_handle_timers().
retroflat_ms_t	timers_at [RETROFLAT_TIMER_CT_MAX]
void *	timers_data [RETROFLAT_TIMER_CT_MAX]
size_t	timers_ct
struct RETROFLAT_SOUND_STATE	sound

Related Functions
(Note that these are not member functions.)
#define	RETROFLAT_FLAGS_RUNNING   0x01
	Flag indicating that retroflat_loop() should continue executing. More...
#define	RETROFLAT_FLAGS_UNLOCK_FPS   0x02
	Flag indicating FPS should not be capped. More...
#define	RETROFLAT_FLAGS_KEY_REPEAT   0x04
	Flag indicating keyboard repeat is enabled. More...
#define	RETROFLAT_FLAGS_SCREENSAVER   0x08
	Flag indicating the current application is running as a screensaver. More...
#define	RETROFLAT_FLAGS_WAIT_FOR_FPS   0x20
	Do not execute any more inter-frame loops until next frame.
#define	retroflat_heartbeat_set(len, max)
	Set parameters for the RETROFLAT_STATE::heartbeat_frame. More...
#define	retroflat_heartbeat()   (g_retroflat_state->heartbeat_frame)
	Get current value of RETROFLAT_STATE::heartbeat_frame.
#define	retroflat_heartbeat_update()
	Check and update RETROFLAT_STATE::heartbeat_frame. More...

Detailed Description

Global singleton containing state for the current platform.

The first few members are size and offset info that the VDP can use to work with STATE structs from different kinds of binaries without crashing.

Friends And Related Function Documentation

RETROFLAT_FLAGS_KEY_REPEAT

#define RETROFLAT_FLAGS_KEY_REPEAT   0x04

related

Flag indicating keyboard repeat is enabled.

Warning

This flag should only be set inside retroflat!

RETROFLAT_FLAGS_RUNNING

#define RETROFLAT_FLAGS_RUNNING   0x01

related

Flag indicating that retroflat_loop() should continue executing.

Warning

This flag is not used on all platforms! It should only be removed using retroflat_quit().

RETROFLAT_FLAGS_SCREENSAVER

#define RETROFLAT_FLAGS_SCREENSAVER   0x08

related

Flag indicating the current application is running as a screensaver.

Warning

This flag should only be set inside retroflat!

RETROFLAT_FLAGS_UNLOCK_FPS

#define RETROFLAT_FLAGS_UNLOCK_FPS   0x02

related

Flag indicating FPS should not be capped.

Warning

This flag should only be set inside retroflat!

retroflat_heartbeat_set

#define retroflat_heartbeat_set (   len,   max  )

related

Value:

   g_retroflat_state->heartbeat_max = max; \
   g_retroflat_state->heartbeat_len = len;

Set parameters for the RETROFLAT_STATE::heartbeat_frame.

Parameters

len	Number of ms between updates to RETROFLAT_STATE::heartbeat_frame.
max	Value of RETROFLAT_STATE::heartbeat_frame on which to reset to 0.

retroflat_heartbeat_update

#define retroflat_heartbeat_update ( )

related

Value:

   /* Update the heartbeat animation frame. */ \
   if( g_retroflat_state->heartbeat_next <= retroflat_get_ms() ) { \
      g_retroflat_state->heartbeat_frame++; \
      if( \
         g_retroflat_state->heartbeat_frame >= \
            g_retroflat_state->heartbeat_max \
      ) { \
         g_retroflat_state->heartbeat_frame = 0; \
      } \
      g_retroflat_state->heartbeat_next = \
         retroflat_get_ms() + g_retroflat_state->heartbeat_len; \
   }

Check and update RETROFLAT_STATE::heartbeat_frame.

Note

This should be called in the API HAL on every iteration of the main loop (this is done automatically in the generic main loop).

Field Documentation

screen_v_h

size_t RETROFLAT_STATE::screen_v_h

The screen height as seen by our program, before scaling.

This is the scale of the buffer, which the platform-specific code should then scale to match screen_v_w on blit.

screen_v_w

size_t RETROFLAT_STATE::screen_v_w

The screen width as seen by our program, before scaling.

This is the scale of the buffer, which the platform-specific code should then scale to match screen_v_h on blit.

---

The documentation for this struct was generated from the following file:

• retroflt.h