TTF_GetTextWrapWidth - Man Page

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)

Referenced By

TTF_SetTextWrapWidth(3).

SDL_ttf 3.2.2 SDL_ttf3 FUNCTIONS