table of contents
other versions
- unstable 3.1.0+ds-1
- experimental 3~git20250124~a7040ba+ds-1
TTF_GetTextWrapWidth(3) | SDL_ttf3 FUNCTIONS | TTF_GetTextWrapWidth(3) |
NAME¶
TTF_GetTextWrapWidth - Get whether wrapping is enabled on a text object.
HEADER FILE¶
Defined in SDL3_ttf/SDL_ttf.h
SYNOPSIS¶
#include "SDL3_ttf/SDL_ttf.h"
bool TTF_GetTextWrapWidth(TTF_Text *text, int *wrap_width);
FUNCTION PARAMETERS¶
- text
- the TTF_Text
to query. - wrap_width
- a pointer filled in with the maximum width in pixels or 0 if the text is being wrapped on newline characters.
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.
SEE ALSO¶
•(3), TTF_SetTextWrapWidth(3)
SDL_ttf 3.1.0 | SDL_ttf |