NAME¶

TTF_GetNextTextSubString - Get the next substring in a text object

HEADER FILE¶

Defined in SDL3_ttf/SDL_ttf.h

SYNOPSIS¶

#include "SDL3_ttf/SDL_ttf.h"

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

DESCRIPTION¶

If called at the end of the text, this will return a zero length substring with the TTF_SUBSTRING_TEXT_END
flag set.

FUNCTION PARAMETERS¶

text

the TTF_Text
to query.

substring

the TTF_SubString
to query.

next

a pointer filled in with the next substring.

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.