TTF_SetTextWrapWidth(3)

TTF_SetTextWrapWidth3

Set whether wrapping is enabled on a text object.

Usage

#include "SDL3_ttf/SDL_ttf.h"

bool TTF_SetTextWrapWidth(TTF_Text *text, int wrap_width);

Header file

Defined in SDL3_ttf/SDL_ttf.h

Overview

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

Function parameters

text

the TTF_Text
to modify.

wrap_width

the maximum width in pixels, 0 to wrap 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.

From libsdl3-ttf-doc 3.2.2+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.