Man page - ttf_settextfont(3)

Packages contas this manual

Package: libsdl3-ttf-doc
apt-get install libsdl3-ttf-doc

Documentations in package:

Manual

TTF_SetTextFont(3)

SDL_ttf3 FUNCTIONS

TTF_SetTextFont(3)

NAME

TTF_SetTextFont - Set the font used by a text object.

HEADER FILE

Defined in SDL3_ttf/SDL_ttf.h

SYNOPSIS

#include "SDL3_ttf/SDL_ttf.h"

bool TTF_SetTextFont(TTF_Text *text, TTF_Font *font);

DESCRIPTION

When a text object has a font, any changes to the font will automatically regenerate the text. If you set the font to NULL, the text will continue to render but changes to the font will no longer affect the text.

This function may cause the internal text representation to be rebuilt.

FUNCTION PARAMETERS

text: the TTF_Text
to modify.
font: the font to use, may be NULL.

RETURN VALUE

Returns false if the text pointer is null; otherwise, true. call SDL_GetError() for more information.

THREAD SAFETY

This function should be called on the thread that created the text.

AVAILABILITY

This function is available since SDL_ttf 3.0.0.