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

TTF_GetNextTextSubString

Get the next substring in a text object

Header File

Defined in <SDL3_ttf/SDL_ttf.h>

Syntax

bool TTF_GetNextTextSubString(TTF_Text *text, const TTF_SubString *substring, TTF_SubString *next);

Function Parameters

TTF_Text *	text	the TTF_Text to query.
const TTF_SubString *	substring	the TTF_SubString to query.
TTF_SubString *	next	a pointer filled in with the next substring.

Return Value

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

Remarks

If called at the end of the text, this will return a zero length substring 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.