NAME¶

TTF_RenderText_Solid_Wrapped - Render word-wrapped Latin1 text at fast quality to a new 8-bit surface.

SYNOPSIS¶

#include "SDL3_ttf/SDL_ttf.h"

SDL_Surface * TTF_RenderText_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 almost certainly want

TTF_RenderUTF8_Solid_Wrapped () unless you're sure you have a 1-byte Latin1 encoding. US ASCII characters will work with either function, but most other Unicode characters packed into a constchar* will need UTF-8.

You can render at other quality levels with

TTF_RenderText_Shaded_Wrapped ,

TTF_RenderText_Blended_Wrapped , and

TTF_RenderText_LCD_Wrapped .

FUNCTION PARAMETERS¶

font

the font to render with.

text

text to render, in Latin1 encoding.

fg

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¶

TTF_RenderUTF8_Solid_Wrapped(3), TTF_RenderUNICODE_Solid_Wrapped(3)