Scroll to navigation

TTF_RenderUTF8_Solid_Wrapped(3) SDL_ttf3 FUNCTIONS TTF_RenderUTF8_Solid_Wrapped(3)

NAME

TTF_RenderUTF8_Solid_Wrapped - Render word-wrapped UTF-8 text at fast quality to a new 8-bit surface.

HEADER FILE

Defined in SDL3_ttf/SDL_ttf.h

SYNOPSIS

#include "SDL3_ttf/SDL_ttf.h"
SDL_Surface * TTF_RenderUTF8_Solid_Wrapped(TTF_Font *font,
                const char *text, SDL_Color fg, Uint32 wrapLength);

DESCRIPTION

This function will allocate a new 8-bit, palettized surface. The surface's 0 pixel will be the colorkey, giving a transparent background. The 1 pixel will be set to the text color.

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.

You can render at other quality levels with

TTF_RenderUTF8_Shaded_Wrapped ,

TTF_RenderUTF8_Blended_Wrapped , and

TTF_RenderUTF8_LCD_Wrapped .

FUNCTION PARAMETERS

the font to render with.
text to render, in UTF-8 encoding.
the foreground color for the text.

RETURN VALUE

Returns a new 8-bit, palettized surface, or NULL if there was an error.

AVAILABILITY

This function is available since SDL_ttf 3.0.0.

SEE ALSO

•(3), TTF_RenderUTF8_Shaded_Wrapped(3), •(3), TTF_RenderUTF8_Blended_Wrapped(3), •(3), TTF_RenderUTF8_LCD_Wrapped(3)

SDL_ttf 3.0.0 SDL_ttf