Scroll to navigation

TTF_RenderUTF8_LCD_Wrapped(3) SDL_ttf3 FUNCTIONS TTF_RenderUTF8_LCD_Wrapped(3)

NAME

TTF_RenderUTF8_LCD_Wrapped - Render word-wrapped UTF-8 text at LCD subpixel quality to a new ARGB surface.

HEADER FILE

Defined in SDL3_ttf/SDL_ttf.h

SYNOPSIS

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

DESCRIPTION

This function will allocate a new 32-bit, ARGB surface, and render alpha-blended text using FreeType's LCD subpixel rendering. This function returns the new surface, or NULL if there was an error.

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_Solid_Wrapped ,

TTF_RenderUTF8_Shaded_Wrapped , and

TTF_RenderUTF8_Blended_Wrapped .

FUNCTION PARAMETERS

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

RETURN VALUE

Returns a new 32-bit, ARGB surface, or NULL if there was an error.

AVAILABILITY

This function is available since SDL_ttf 3.0.0.

SEE ALSO

•(3), TTF_RenderUTF8_Solid_Wrapped(3), •(3), TTF_RenderUTF8_Shaded_Wrapped(3), •(3), TTF_RenderUTF8_Blended_Wrapped(3)

SDL_ttf 3.0.0 SDL_ttf