TTF_GetTextSubStringForLine - Get the substring of a text object that contains the given line.
Contents
Availability
This function is available since SDL_ttf 3.0.0.
SDL_ttf SDL_ttf 3.2.2 TTF_GetTextSubStringForLine(3)
Description
If line 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 line is greater than or equal to text->num_lines 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.
line a zero-based line index, in the range [0 .. text->num_lines-1].
substring
a pointer filled in with the substring containing the offset.
Header File
Defined in SDL3_ttf/SDL_ttf.h
Name
TTF_GetTextSubStringForLine - Get the substring of a text object that contains the given line.
Return Value
Returns true on success or false on failure; call SDL_GetError() for more information.
Synopsis
#include"SDL3_ttf/SDL_ttf.h"boolTTF_GetTextSubStringForLine(TTF_Text*text,intline,TTF_SubString*substring);
Thread Safety
This function should be called on the thread that created the text.
