RetroFlat VDP API

Video Display Processor tools for modifying display output. More...

Collaboration diagram for RetroFlat VDP API:

Macros
#define	RETROFLAT_VDP_FLAG_PXLOCK   0x01
	Flag for RETROFLAT_STATE::vdp_flags indicating the VDP requires RetroFlat to pixel-lock the frame before passing it (almost always true!)

Typedefs
typedef MERROR_RETVAL(*	retroflat_vdp_proc_t) (struct RETROFLAT_STATE *)
	VDP function called from the VDP library.

Functions
MERROR_RETVAL	retroflat_vdp_call (const char *proc_name)
	Call a function from the retroflat VDP.

Detailed Description

Video Display Processor tools for modifying display output.

The VDP system allows for a plugin to post-process frames in programs that use RetroFlat. The VDP is provided with a bitmap of every frame in RETROFLAT_STATE::vdp_buffer which it processes and outputs to RETROFLAT_STATE::buffer, which is then displayed on the screen.

Macro Definition Documentation

RETROFLAT_VDP_FLAG_PXLOCK

#define RETROFLAT_VDP_FLAG_PXLOCK   0x01

Flag for RETROFLAT_STATE::vdp_flags indicating the VDP requires RetroFlat to pixel-lock the frame before passing it (almost always true!)

This should be set by the VDP during its initialization.

Typedef Documentation

retroflat_vdp_proc_t

typedef MERROR_RETVAL(* retroflat_vdp_proc_t) (struct RETROFLAT_STATE *)

VDP function called from the VDP library.

The VDP plugin should export three functions with this signature:

Function Name	Called From
retroflat_vdp_init()	retroflat_init()
retroflat_vdp_flip()	retroflat_draw_release() on screen buffer
retroflat_vdp_shutdown	retroflat_shutdown()