TTF_SetTextString - Man Page

Set the UTF-8 text used by a text object.

Header File

Defined in SDL3_ttf/SDL_ttf.h

Synopsis

#include "SDL3_ttf/SDL_ttf.h"

bool TTF_SetTextString(TTF_Text *text, const char *string, size_t length);

Description

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

Function Parameters

text

the TTF_Text
to modify.

string

the UTF-8 text to use, may be NULL.

length

the length of the text, in bytes, or 0 for null terminated text.

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.

See Also

·(3), TTF_AppendTextString(3), ·(3), TTF_DeleteTextString(3), ·(3), TTF_InsertTextString(3)

Referenced By

TTF_AppendTextString(3), TTF_DeleteTextString(3), TTF_InsertTextString(3).

SDL_ttf 3.2.2 SDL_ttf3 FUNCTIONS