table of contents
- experimental 3~git20240320~6e260a2+ds-1
TTF_RenderText_Shaded(3) | SDL_ttf3 FUNCTIONS | TTF_RenderText_Shaded(3) |
NAME¶
TTF_RenderText_Shaded - Render Latin1 text at high quality to a new 8-bit surface.
SYNOPSIS¶
#include "SDL3_ttf/SDL_ttf.h"
SDL_Surface * TTF_RenderText_Shaded(TTF_Font *font, const char *text, SDL_Color fg, SDL_Color bg);
DESCRIPTION¶
This function will allocate a new 8-bit, palettized surface. The surface's 0 pixel will be the specified background color, while other pixels have varying degrees of the foreground color. This function returns the new surface, or NULL if there was an error.
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_Shaded_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_Shaded () 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_Solid ,
TTF_RenderText_Blended , and
TTF_RenderText_LCD .
FUNCTION PARAMETERS¶
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¶
SDL_ttf 3.0.0 | SDL_ttf |