TTF_GetTextSubString - Man Page
Get the substring of a text object that surrounds a text offset.
Header File
Defined in SDL3_ttf/SDL_ttf.h
Synopsis
#include "SDL3_ttf/SDL_ttf.h" bool TTF_GetTextSubString(TTF_Text *text, int offset, TTF_SubString *substring);
Description
If offset is less than 0, this will return a zero length substring at the beginning of the text with the
TTF_SUBSTRING_TEXT_START
flag set. If offset is greater than or equal to the length of the text string, this will return a zero length substring at the end of the text with the
TTF_SUBSTRING_TEXT_END
flag set.
Function Parameters
- text
the TTF_Text
to query.- offset
a byte offset into the text string.
- substring
a pointer filled in with the substring containing the offset.
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.
Referenced By
SDL_ttf 3.2.2 SDL_ttf3 FUNCTIONS