Module: font

Synopsis

#include <core/font.h>

Open and use fonts for rendering UTF-8 text.

Enums

font_style

Specify the font style to use.

Enumerator	Description
FONT_STYLE_ANTIALIASED	Pretty antialiasing looking.
FONT_STYLE_NONE	No antialiasing.

Structs

font

A font handle to render text.

Field	Access	Type
style	(+)	enum font_style

style

Font style to use for the next rendering operations.

Functions

font_open

Open and load font of the given pixel size from file path. Returns false on errors.

bool
font_open(struct font *font, const char *path, unsigned int size)

font_openmem

Open font and load font from the const memory buffer pointed by buffer and of size buflen using a pixel size of size. Returns false on errors.

Note

The argument buffer must stay valid until the font is no longer used.

bool
font_openmem(struct font *font, const void *buffer, size_t buflen, unsigned int size)

font_ok

Returns true if the font is properly loaded.

bool
font_ok(const struct font *font)

font_render

Render the UTF-8 text into the texture tex using the font pointed by font. The foreground color will be used to draw the text.

Returns false in case of rendering error, in this case tex remains uninitialized and must not be used.

bool
font_render(struct font *font, struct texture *tex, const char *text, unsigned int color)

font_height

Returns the maximum glyph height in pixels present in font.

unsigned int
font_height(const struct font *font)

font_query

Query the dimensions that the UTF-8 text would require with this font. Store the dimensions into the w, h pointers which can be both NULL.

Return false in case of error, in this case both w and h remain uninitialized and must not be used.

bool
font_query(const struct font *font, const char *text, unsigned int *w, unsigned int *h)

font_finish

Close this font.

void
font_finish(struct font *font)