Display » Text module

Contents

Butano's text system, based on sprites.

Currently, it supports 8x8 and 8x16 fixed width AND variable width fonts of 16 colors (4 bits per pixel).

Text can be printed in one sprite per character or multiple characters per sprite.

Also, UTF-8 characters are supported.

Files

file bn_config_sprite_text.h
file bn_sprite_font.h
file bn_sprite_text_generator.h
file bn_utf8_character.h

Classes

class bn::sprite_font
Contains the required information to generate text sprites.
class bn::sprite_text_generator
Generates sprites containing text from a given sprite_font.
class bn::utf8_character
Decodes a single UTF-8 character from a string.

Defines

#define BN_CFG_SPRITE_TEXT_MAX_UTF8_CHARACTERS

Define documentation

#define BN_CFG_SPRITE_TEXT_MAX_UTF8_CHARACTERS
#include <bn_config_sprite_text.h>

Specifies the maximum number of UTF-8 characters that are supported by a bn::sprite_font.