NAME¶

TTF_RenderText_Solid - Render Latin1 text at fast quality to a new 8-bit surface.

SYNOPSIS¶

#include "SDL3_ttf/SDL_ttf.h"

SDL_Surface * TTF_RenderText_Solid(TTF_Font *font,
                const char *text, SDL_Color fg);

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.

This will not word-wrap the string; you'll get a surface with a single line of text, as long as the string requires. You can use

TTF_RenderText_Solid_Wrapped () instead if you need to wrap the output to multiple lines.

This will not wrap on newline characters.

You almost certainly want TTF_RenderUTF8_Solid () 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 ,

TTF_RenderText_Blended , and

TTF_RenderText_LCD .

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(3), TTF_RenderUNICODE_Solid(3)