Scroll to navigation

TTF_RenderGlyph_Solid(3) SDL_ttf3 FUNCTIONS TTF_RenderGlyph_Solid(3)

NAME

TTF_RenderGlyph_Solid - Render a single 16-bit glyph at fast quality to a new 8-bit surface.

SYNOPSIS

#include "SDL3_ttf/SDL_ttf.h"
SDL_Surface * TTF_RenderGlyph_Solid(TTF_Font *font,
                Uint16 ch, 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.

The glyph is rendered without any padding or centering in the X direction, and aligned normally in the Y direction.

Note that this version of the function takes a 16-bit character code, which covers the Basic Multilingual Plane, but is insufficient to cover the entire set of possible Unicode values, including emoji glyphs. You should use TTF_RenderGlyph32_Solid () instead, which offers the same functionality but takes a 32-bit codepoint instead.

The only reason to use this function is that it was available since the beginning of time, more or less.

You can render at other quality levels with

TTF_RenderGlyph_Shaded ,

TTF_RenderGlyph_Blended , and

TTF_RenderGlyph_LCD .

FUNCTION PARAMETERS

the font to render with.
the character to render.
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_RenderGlyph32_Solid(3)

SDL_ttf 3.0.0 SDL_ttf