(This function is part of SDL_ttf, a separate library from SDL.)

TTF_SetTextWrapWidth

Set whether wrapping is enabled on a text object.

Header File

Defined in <SDL3_ttf/SDL_ttf.h>

Syntax

bool TTF_SetTextWrapWidth(TTF_Text *text, int wrap_width);

Function Parameters

TTF_Text *	text	the TTF_Text to modify.
int	wrap_width	the maximum width in pixels, 0 to wrap on newline characters.

Return Value

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

Remarks

This function may cause the internal text representation to be rebuilt.

Thread Safety

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

Version

This function is available since SDL_ttf 3.0.0.

See Also

• TTF_GetTextWrapWidth

---

CategoryAPI, CategoryAPIFunction, CategorySDLTTF

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.