logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

TTF_GetTextSubString - Get the substring of a text object that surrounds a text offset.

Availability

       This function is available since SDL_ttf 3.0.0.

SDL_ttf                                           SDL_ttf 3.2.2                          TTF_GetTextSubString(3)

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.

Header File

       Defined in SDL3_ttf/SDL_ttf.h

Name

       TTF_GetTextSubString - Get the substring of a text object that surrounds a text offset.

Return Value

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

Synopsis

#include"SDL3_ttf/SDL_ttf.h"boolTTF_GetTextSubString(TTF_Text*text,intoffset,TTF_SubString*substring);

Thread Safety

       This function should be called on the thread that created the text.

See Also