table of contents
other versions
- unstable 3.1.0+ds-1
- experimental 3~git20250124~a7040ba+ds-1
TTF_InsertTextString(3) | SDL_ttf3 FUNCTIONS | TTF_InsertTextString(3) |
NAME¶
TTF_InsertTextString - Insert UTF-8 text into a text object.
HEADER FILE¶
Defined in SDL3_ttf/SDL_ttf.h
SYNOPSIS¶
#include "SDL3_ttf/SDL_ttf.h"
bool TTF_InsertTextString(TTF_Text *text, int offset, const char *string, size_t length);
FUNCTION PARAMETERS¶
- text
- the TTF_Text
to modify. - 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.
- string
- the UTF-8 text to insert.
- 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_SetTextString(3)
SDL_ttf 3.1.0 | SDL_ttf |