TTF_GetTextSubStringForPoint3
Get the portion of a text string that is closest to a point.
Usage
#include "SDL3_ttf/SDL_ttf.h"
bool TTF_GetTextSubStringForPoint(TTF_Text *text, int x, int y, TTF_SubString *substring);
Header file
Defined in SDL3_ttf/SDL_ttf.h
Overview
This will return the closest substring of text to the given point.
Function parameters
- text
-
the
TTF_Text
to query.
- x
-
the x coordinate relative to the left side of the text, may be outside the bounds of the text area.
- y
-
the y coordinate relative to the top side of the text, may be outside the bounds of the text area.
- substring
-
a pointer filled in with the closest substring of text to the given point.
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.