table of contents
other versions
- experimental 3~git20241004~5992548+ds-1
TTF_SetTextWrapping(3) | SDL_ttf3 FUNCTIONS | TTF_SetTextWrapping(3) |
NAME¶
TTF_SetTextWrapping - Set 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_SetTextWrapping(TTF_Text *text, bool wrap, int wrapLength);
FUNCTION PARAMETERS¶
- text
- the TTF_Text
to modify. - wrap
- true if wrapping should be enabled, false if it should be disabled.
- wrapLength
- the maximum width in pixels, 0 to wrap on newline characters, or -1 to leave wrapLength unchanged.
RETURN VALUE¶
Returns true on success or false on failure; call SDL_GetError() for more information.
SDL_ttf 3.0.0 | SDL_ttf |