Detailed Description

Design Philosophy

Ths Swadge loads an assets "image" as cnfs_files and cnfs_data.

During the build, assets in the /assets/ folder, such as PNG images and MIDI songs, are processed into Swadge-friendly formats and written to the /assets_image/ folder. The contents of the /assets_image/ are then packaged into a matching cnfs_files and cnfs_data image which are stored as a C file and loaded alongside cnfs.c.

Usage

You don't need to call cnfsInit() or cnfsDeinit(). The system does that the appropriate time.

cnfsReadFile() may be used to read a file straight from cnfs, but this probably should not be done directly.

cnfsGetFile() gets a reference to the file in flash, to obviate need to "load it into RAM"

Each asset type has it's own file loader which handles things like decompression if the asset type is compressed, and writing values from the read file into a convenient struct. The loader functions are:

loadFont() & freeFont() - Load font assets from CNFS to draw text to the display
loadWsg() & freeWsg() - Load image assets from CNFS to draw images to the display
loadJson() & freeJson() - Load JSON assets from CNFS to configure games
loadTxt() & freeTxt() - Load text assets from CNFS to use in a Swadge mode

Assets may be loaded to either SPI RAM or normal RAM. There is more SPI RAM available, but it is slower to access than normal RAM. Swadge modes should use normal RAM if they can, and use SPI RAM if the mode is asset-heavy.

Example

// Declare and load a font
font_t ibm;
loadFont("ibm_vga8.font", &ibm, false);
// Draw some white text
drawText(&ibm, c555, "Hello World", 0, 0);
// Free the font
freeFont(&ibm);
 
// Declare and load an image
wsg_t king_donut;
loadWsg("kid0.wsg", &king_donut, true);
// Draw the image to the display
drawWsg(&king_donut, 100, 100, false, false, 0);
// Free the image
freeWsg(&king_donut);

Go to the source code of this file.

Functions
bool	initCnfs (void)
	Initialize the CNFS file system. This is used to store assets like WSGs and fonts.

bool	deinitCnfs (void)
	De-initialize the CNFS file system (right now a noop)

const uint8_t *	cnfsGetFile (const char fname, size_t flen)
	Get a pointer to a file, without needing to read it. Same rules that apply to cnfsGetFile, and under the hood, cnfsGetFile uses this function.

uint8_t *	cnfsReadFile (const char fname, size_t outsize, bool readToSpiRam)
	Read a file from CNFS into an output array. Files that are in the assets_image folder before compilation and flashing will automatically be included in the firmware.

Function Documentation

◆ initCnfs()

bool initCnfs ( void )

Initialize the CNFS file system. This is used to store assets like WSGs and fonts.

Returns: true if CNFS was initialized and can be used, false if it failed

◆ deinitCnfs()

bool deinitCnfs ( void )

De-initialize the CNFS file system (right now a noop)

Returns: true if de-initialize ok, false if it was not

◆ cnfsGetFile()

const uint8_t * cnfsGetFile	(	const char *	fname,
		size_t *	flen )

Get a pointer to a file, without needing to read it. Same rules that apply to cnfsGetFile, and under the hood, cnfsGetFile uses this function.

Parameters

fname	The name of the file to find.
flen	A pointer to a size_t to return the size of the file.

Returns: A pointer to the read data if successful, or NULL if there is a failure Do not free this pointer. It is pointing to flash.

◆ cnfsReadFile()

uint8_t * cnfsReadFile	(	const char *	fname,
		size_t *	outsize,
		bool	readToSpiRam )

Read a file from CNFS into an output array. Files that are in the assets_image folder before compilation and flashing will automatically be included in the firmware.