TTF_UpdateText(3)

TTF_UpdateText3

Update the layout of a text object.

Usage

#include "SDL3_ttf/SDL_ttf.h"

bool TTF_UpdateText(TTF_Text *text);

Header file

Defined in SDL3_ttf/SDL_ttf.h

Overview

This is automatically done when the layout is requested or the text is rendered, but you can call this if you need more control over the timing of when the layout and text engine representation are updated.

Function parameters

text

the TTF_Text
to update.

Return value

Returns true on success or false on failure; 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.

From libsdl3-ttf-doc 3.2.2+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.