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

TTF_CreateText_Wrapped

Create a text object from word-wrapped UTF-8 text and a text engine.

Header File

Defined in <SDL3_ttf/SDL_ttf.h>

Syntax

TTF_Text * TTF_CreateText_Wrapped(TTF_TextEngine *engine, TTF_Font *font, const char *text, size_t length, int wrapLength);

Function Parameters

TTF_TextEngine *	engine	the text engine to use when creating the text object, may be NULL.
TTF_Font *	font	the font to render with.
const char *	text	the text to use, in UTF-8 encoding.
size_t	length	the length of the text, in bytes, or 0 for null terminated text.
int	wrapLength	the maximum width of the text surface or 0 to wrap on newline characters.

Return Value

(TTF_Text *) Returns a TTF_Text object or NULL on failure; call SDL_GetError() for more information.

Remarks

Text is wrapped to multiple lines on line endings and on word boundaries if it extends beyond wrapLength in pixels.

If wrapLength is 0, this function will only wrap on newline characters.

Thread Safety

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

Version

This function is available since SDL_ttf 3.0.0.

See Also

• TTF_CreateText
• TTF_DestroyText

---

CategoryAPI, CategoryAPIFunction

[ 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.