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

TTF_GetTextSubStringForLine

Get the substring of a text object that contains the given line.

Header File

Defined in <SDL3_ttf/SDL_ttf.h>

Syntax

bool TTF_GetTextSubStringForLine(TTF_Text *text, int line, TTF_SubString *substring);

Function Parameters

TTF_Text *	text	the TTF_Text to query.
int	line	a zero-based line index, in the range [0 .. text->num_lines-1].
TTF_SubString *	substring	a pointer filled in with the substring containing the offset.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

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.

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.

---

CategoryAPI, CategoryAPIFunction

[ 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.