In-Situ Console API

Data Structures
struct	RETROCON

Macros
#define	RETROCON_SBUFFER_SZ_MAX   4096
#define	RETROCON_SBUFFER_LINES_MAX   30
#define	RETROCON_LBUFFER_SZ_MAX   256
#define	RETROCON_ACTIVE_KEY   RETROFLAT_KEY_GRAVE
#define	RETROCON_CB_NAME_SZ_MAX   32
#define	RETROCON_CB_SZ_MAX   128
#define	RETROCON_WIN_H   110

Typedefs
typedef MERROR_RETVAL(*	retrocon_cb) (struct RETROCON *con, const char *line, size_t line_sz, void *data)

Functions
MERROR_RETVAL	retrocon_init (struct RETROCON *con, const char *font_name, size_t x, size_t y, size_t w, size_t h)
MERROR_RETVAL	retrocon_add_command (struct RETROCON *con, const char *cmd, retrocon_cb cb, void *cb_data)
MERROR_RETVAL	retrocon_print_line (struct RETROCON *con, const char *line)
MERROR_RETVAL	retrocon_exec_line (struct RETROCON *con, char *line, size_t line_sz)
int	retrocon_debounce (struct RETROCON *con, int c)
MERROR_RETVAL	retrocon_input (struct RETROCON *con, RETROFLAT_IN_KEY *p_c, struct RETROFLAT_INPUT *input_evt, retrogui_idc_t *p_idc_out, struct MDATA_VECTOR *win_stack)
	Process input from retroflat_poll_input() and apply it to the console, if open.
MERROR_RETVAL	retrocon_display (struct RETROCON *con, struct RETROFLAT_BITMAP *gui_bmp)
void	retrocon_shutdown (struct RETROCON *con)

Detailed Description

Function Documentation

retrocon_input()

MERROR_RETVAL retrocon_input	(	struct RETROCON *	con,
		RETROFLAT_IN_KEY *	p_c,
		struct RETROFLAT_INPUT *	input_evt,
		retrogui_idc_t *	p_idc_out,
		struct MDATA_VECTOR *	win_stack )

Process input from retroflat_poll_input() and apply it to the console, if open.

Parameters

p_c	Pointer to the input value returned from retroflat_poll_input().

Note

This function will set input to 0 (nothing) if it was handled by an open console!