NAME¶

TTF_UpdateText - Update the layout of a text object.

HEADER FILE¶

Defined in SDL3_ttf/SDL_ttf.h

SYNOPSIS¶

#include "SDL3_ttf/SDL_ttf.h"

bool TTF_UpdateText(TTF_Text *text);

DESCRIPTION¶

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.