Functions
helpPageVars_t *	initHelpScreen (menu_t bgMenu, menuMegaRenderer_t menuRenderer, const helpPage_t *pages, int32_t numPages)
	Initialize a help screen.

void	deinitHelpScreen (helpPageVars_t *help)
	Deinitialize a help screen.

void	drawHelp (helpPageVars_t *help, int32_t elapsedUs)
	Draw the help screen.

bool	buttonHelp (helpPageVars_t help, buttonEvt_t evt)
	Handle a button event on the help screen.

Macro Definition Documentation

◆ TEXT_MARGIN

#define TEXT_MARGIN 4

#define TEXT_MARGIN_L (22 + TEXT_MARGIN)

#define TEXT_MARGIN_R (24 + TEXT_MARGIN)

#define TEXT_MARGIN_U (50 + TEXT_MARGIN)

#define ARROW_BLINK_PERIOD 1000000

helpPageVars_t * initHelpScreen	(	menu_t *	bgMenu,
		menuMegaRenderer_t *	menuRenderer,
		const helpPage_t *	pages,
		int32_t	numPages )

Initialize a help screen.

Parameters

bgMenu	A menu to draw behind the help screen. It should not have any entries!
menuRenderer	A renderer to draw the menu
pages	The pages to be displayed on the help screen
numPages	The total number of pages

void deinitHelpScreen ( helpPageVars_t * help )

Deinitialize a help screen.

Parameters

help	The help screen to deinitialize

void drawHelp	(	helpPageVars_t *	help,
		int32_t	elapsedUs )

Draw the help screen.

Parameters

help	The help screen state
elapsedUs	The time elapsed since the last function call

bool buttonHelp	(	helpPageVars_t *	help,
		buttonEvt_t *	evt )

Handle a button event on the help screen.

Parameters

help	The help screen state
evt	The button event to handle