menuMegaRenderer.c File Reference

Macros
#define	ITEMS_PER_PAGE   5
#define	ITEM_MARGIN   1
#define	Y_SECTION_MARGIN   13
#define	Y_ITEM_START   55
#define	MAX_ITEM_TEXT_WIDTH   191
#define	ARROW_PERIOD_US   1000000
#define	DEFAULT_BODY_HEIGHT   66

Functions
menuMegaRenderer_t *	initMenuMegaRenderer (font_t *titleFont, font_t *titleFontOutline, font_t *menuFont)
	Initialize a and return a menu renderer.
void	deinitMenuMegaRenderer (menuMegaRenderer_t *renderer)
	Deinitialize a menu renderer and free associated memory. This will not free the font passed into initMenuMegaRenderer()
void	setDrawBody (menuMegaRenderer_t *renderer, bool drawBody)
	Set whether or not to draw the sci-fi rectangle background body.
void	setBodyHeight (menuMegaRenderer_t *renderer, int16_t height)
	Set the height of the body between top and bottom decorated parts If the given height is negative, it will be set to the default height.
void	recolorMenuMegaRenderer (menuMegaRenderer_t *renderer, paletteColor_t textFill, paletteColor_t textOutline, paletteColor_t hexaBackground, paletteColor_t bodyBackground, paletteColor_t bodyAccentDark, paletteColor_t bodyAccentLight, paletteColor_t bodyArrowBg, paletteColor_t rowUnselectedBg, paletteColor_t rowUnselectedShadow, paletteColor_t rowSelectedBg, paletteColor_t rowSelectedAccent, paletteColor_t rowSelectedOutline, paletteColor_t rowArrowBg, const paletteColor_t *bgColors, int32_t numBgColors)
	Recolor the Mega menu renderer.
void	drawMenuBody (uint16_t topLeftX, uint16_t topLeftY, uint8_t expansionHeight, bool flipLR, menuMegaRenderer_t *renderer)
	Draw the menu body background.
void	drawMenuMega (menu_t *menu, menuMegaRenderer_t *renderer, int64_t elapsedUs)
	Draw a themed menu to the display and control the LEDs.
void	setMegaLedsOn (menuMegaRenderer_t *renderer, bool ledsOn)
	Set the renderer's LEDs to be on or off.

Macro Definition Documentation

ITEMS_PER_PAGE

#define ITEMS_PER_PAGE   5

ITEM_MARGIN

#define ITEM_MARGIN   1

Y_SECTION_MARGIN

#define Y_SECTION_MARGIN   13

Y_ITEM_START

#define Y_ITEM_START   55

MAX_ITEM_TEXT_WIDTH

#define MAX_ITEM_TEXT_WIDTH   191

ARROW_PERIOD_US

#define ARROW_PERIOD_US   1000000

DEFAULT_BODY_HEIGHT

#define DEFAULT_BODY_HEIGHT   66

Function Documentation

initMenuMegaRenderer()

menuMegaRenderer_t * initMenuMegaRenderer	(	font_t *	titleFont,
		font_t *	titleFontOutline,
		font_t *	menuFont )

Initialize a and return a menu renderer.

Parameters

titleFont	The font used to draw the title, preferably RIGHTEOUS_150_FONT. If this is NULL it will be allocated by the renderer in SPIRAM.
titleFontOutline	The outline font used to draw the title. If this is NULL it will be allocated by the renderer in SPIRAM.
menuFont	The font used to draw this menu, preferably RODIN_EB_FONT. If this is NULL it will be allocated by the renderer in SPIRAM.

Returns

A pointer to the menu renderer. This memory is allocated and must be freed with deinitMenuMegaRenderer() when done

deinitMenuMegaRenderer()

void deinitMenuMegaRenderer

(

menuMegaRenderer_t *

renderer

)

Deinitialize a menu renderer and free associated memory. This will not free the font passed into initMenuMegaRenderer()

Parameters

renderer

The renderer to deinitialize. It must not be used after deinitialization.

setDrawBody()

void setDrawBody	(	menuMegaRenderer_t *	renderer,
		bool	drawBody )

Set whether or not to draw the sci-fi rectangle background body.

Parameters

renderer	The renderer.
drawBody	true to draw the body background, false to skip it

setBodyHeight()

void setBodyHeight	(	menuMegaRenderer_t *	renderer,
		int16_t	height )

Set the height of the body between top and bottom decorated parts If the given height is negative, it will be set to the default height.

Parameters

renderer	The renderer to adjust the body height for
height	The new height. If the given value is negative, the default height will be set.

recolorMenuMegaRenderer()

void recolorMenuMegaRenderer	(	menuMegaRenderer_t *	renderer,
		paletteColor_t	textFill,
		paletteColor_t	textOutline,
		paletteColor_t	hexaBackground,
		paletteColor_t	bodyBackground,
		paletteColor_t	bodyAccentDark,
		paletteColor_t	bodyAccentLight,
		paletteColor_t	bodyArrowBg,
		paletteColor_t	rowUnselectedBg,
		paletteColor_t	rowUnselectedShadow,
		paletteColor_t	rowSelectedBg,
		paletteColor_t	rowSelectedAccent,
		paletteColor_t	rowSelectedOutline,
		paletteColor_t	rowArrowBg,
		const paletteColor_t *	bgColors,
		int32_t	numBgColors )

Recolor the Mega menu renderer.

Parameters

renderer	The renderer to recolor
textFill	The color of the text fill, originally white
textOutline	The color of the text outline, originally black
hexaBackground	The color of the hexagonal background
bodyBackground	The color of the background between hexagons and items
bodyAccentDark	The dark accent color of the background
bodyAccentLight	The light accent color of the background
bodyArrowBg	The color of the up and down arrows
rowUnselectedBg	The color of the background of an unselected row
rowUnselectedShadow	The color of the shadow of an unselected row
rowSelectedBg	The color of the background of the selected row
rowSelectedAccent	The accent color of the selected row
rowSelectedOutline	The outline color of the selected row
rowArrowBg	The background color of left and right arrows
bgColors	A list of colors to cycle through in the hexagonal background. May be NULL for no change.
numBgColors	The length of bgColors

drawMenuBody()

void drawMenuBody	(	uint16_t	topLeftX,
		uint16_t	topLeftY,
		uint8_t	expansionHeight,
		bool	flipLR,
		menuMegaRenderer_t *	renderer )

Draw the menu body background.

Parameters

topLeftX	The X coordinate of the top left corner of the body
topLeftY	The Y coordinate of the top left corner of the body
expansionHeight	The y distance of filler rectangle between the top and bottom parts of the body
flipLR	true to flip the body horizontally
renderer	The renderer to draw a body with

drawMenuMega()

void drawMenuMega	(	menu_t *	menu,
		menuMegaRenderer_t *	renderer,
		int64_t	elapsedUs )

Draw a themed menu to the display and control the LEDs.

Parameters

menu	The menu to draw
renderer	The renderer to draw with
elapsedUs	The time elapsed since this function was last called, for LED animation

setMegaLedsOn()

void setMegaLedsOn	(	menuMegaRenderer_t *	renderer,
		bool	ledsOn )

Set the renderer's LEDs to be on or off.

Parameters

renderer	The renderer to set
ledsOn	true to animate the LEDs, false to keep them off