SDL Wiki
(This function is part of SDL_ttf, a separate library from SDL.)

TTF_InsertTextString

Insert UTF-8 text into a text object.

Header File

Defined in <SDL3_ttf/SDL_ttf.h>

Syntax

bool TTF_InsertTextString(TTF_Text *text, int offset, const char *string, size_t length);

Function Parameters

TTF_Text * text the TTF_Text to modify.
int offset the offset, in bytes, from the beginning of the string if >= 0, the offset from the end of the string if < 0. Note that this does not do UTF-8 validation, so you should only insert at UTF-8 sequence boundaries.
const char * string the UTF-8 text to insert.
size_t length the length of the text, in bytes, or 0 for null terminated text.

Return Value

(bool) 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.

Version

This function is available since SDL_ttf 3.0.0.

See Also


CategoryAPI, CategoryAPIFunction


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.