RetroGXCache API

Collaboration diagram for RetroGXCache API:

Data Structures
struct	RETROFLAT_CACHE_ASSET
struct	RETROGXC_FONT_PARMS

Macros
#define	RETROGXC_PRESENT   1
#define	retrogxc_cachable_is_loaded(cachable)
#define	RETROGXC_INITIAL_SZ   16
#define	RETROGXC_TRACE_LVL   0
#define	RETROGXC_ERROR_CACHE_MISS   (-1)
#define	RETROGXC_ASSET_TYPE_NONE   0
#define	RETROGXC_ASSET_TYPE_BITMAP   1
#define	RETROGXC_ASSET_TYPE_FONT   2
#define	retrogxc_load_bitmap(res_p, flags)

Typedefs
typedef int8_t	retrogxc_asset_type_t
typedef retrogxc_asset_type_t(*	retrogxc_loader) (const maug_path res_p, MAUG_MHANDLE *handle_p, void *data, uint8_t flags)

Functions
MERROR_RETVAL	retrogxc_init (void)
void	retrogxc_clear_cache (void)
void	retrogxc_shutdown (void)
retrogxc_asset_type_t	retrogxc_loader_bitmap (const maug_path res_p, MAUG_MHANDLE *handle_p, void *data, uint8_t flags)
retrogxc_asset_type_t	retrogxc_loader_xpm (const maug_path res_p, MAUG_MHANDLE *handle_p, void *data, uint8_t flags)
retrogxc_asset_type_t	retrogxc_loader_font (const maug_path res_p, MAUG_MHANDLE *handle_p, void *data, uint8_t flags)
int16_t	retrogxc_load_font (const maug_path font_name, uint8_t glyph_h, uint16_t first_glyph, uint16_t glyphs_count)
int16_t	retrogxc_load_asset (const maug_path res_p, retrogxc_loader l, void *data, uint8_t flags)
	Try to load an asset by file path. Return a cached copy if it's already been loaded.
MAUG_MHANDLE	retrogxc_get_asset (size_t asset_idx, retrogxc_asset_type_t asset_type)
	Retrive an asset for which we have a prior cached index.
MERROR_RETVAL	retrogxc_blit_bitmap (retroflat_blit_t *target, size_t bitmap_idx, retroflat_pxxy_t s_x, retroflat_pxxy_t s_y, retroflat_pxxy_t d_x, retroflat_pxxy_t d_y, retroflat_pxxy_t w, retroflat_pxxy_t h, int16_t instance)
MERROR_RETVAL	retrogxc_bitmap_wh (size_t bitmap_idx, retroflat_pxxy_t *p_w, retroflat_pxxy_t *p_h)

Detailed Description

Macro Definition Documentation

retrogxc_cachable_is_loaded

#define retrogxc_cachable_is_loaded

(

cachable

)

Value:

(0 <= (cachable)->cache_idx)

retrogxc_load_bitmap

#define retrogxc_load_bitmap	(		res_p,
			flags )

Value:

retrogxc_load_asset( res_p, retrogxc_loader_bitmap, NULL, flags )

Function Documentation

retrogxc_get_asset()

MAUG_MHANDLE retrogxc_get_asset	(	size_t	asset_idx,
		retrogxc_asset_type_t	asset_type )

Retrive an asset for which we have a prior cached index.

This should be quicker than retrogxc_load_asset(), which has to compare paths for prior loaded assets by looping.