fs_wsg.c File Reference

Functions
bool	loadWsg (cnfsFileIdx_t fIdx, wsg_t *wsg, bool spiRam)
	Load a WSG from ROM to RAM. WSGs placed in the assets_image folder before compilation will be automatically flashed to ROM.
bool	loadWsgInplace (cnfsFileIdx_t fIdx, wsg_t *wsg, bool spiRam, uint8_t *decompressedBuf, heatshrink_decoder *hsd)
	Load a WSG from ROM to RAM. WSGs placed in the assets_image folder before compilation will be automatically flashed to ROM. You must provide a decoder and decode space to this function. It's useful when creating one decoder & space to decode many consecutive WSGs.
bool	loadWsgNvs (const char *namespace, const char *key, wsg_t *wsg, bool spiRam)
bool	saveWsgNvs (const char *namespace, const char *key, const wsg_t *wsg)
void	freeWsg (wsg_t *wsg)
	Free the memory for a loaded WSG.

Function Documentation

loadWsg()

bool loadWsg	(	cnfsFileIdx_t	fIdx,
		wsg_t *	wsg,
		bool	spiRam )

Load a WSG from ROM to RAM. WSGs placed in the assets_image folder before compilation will be automatically flashed to ROM.

Parameters

fIdx	The cnfsFileIdx_t the WSG to load
wsg	A handle to load the WSG to
spiRam	true to load to SPI RAM, false to load to normal RAM. SPI RAM is more plentiful but slower to access than normal RAM

Returns

true if the WSG was loaded successfully, false if the WSG load failed and should not be used

loadWsgInplace()

bool loadWsgInplace	(	cnfsFileIdx_t	fIdx,
		wsg_t *	wsg,
		bool	spiRam,
		uint8_t *	decompressedBuf,
		heatshrink_decoder *	hsd )

Load a WSG from ROM to RAM. WSGs placed in the assets_image folder before compilation will be automatically flashed to ROM. You must provide a decoder and decode space to this function. It's useful when creating one decoder & space to decode many consecutive WSGs.

Parameters

fIdx	The cnfsFileIdx_t the WSG to load
wsg	A handle to load the WSG to
spiRam	true to load to SPI RAM, false to load to normal RAM. SPI RAM is more plentiful but slower to access than normal RAM
decompressedBuf	Memory to store decoded data. This must be as large as the decoded data
hsd	A heatshrink decoder

Returns

true if the WSG was loaded successfully, false if the WSG load failed and should not be used

loadWsgNvs()

bool loadWsgNvs	(	const char *	namespace,
		const char *	key,
		wsg_t *	wsg,
		bool	spiRam )

saveWsgNvs()

bool saveWsgNvs	(	const char *	namespace,
		const char *	key,
		const wsg_t *	wsg )

freeWsg()

void freeWsg

(

wsg_t *

wsg

)

Free the memory for a loaded WSG.

Parameters

wsg	The WSG handle to free memory from