(This function is part of SDL_ttf, a separate library from SDL.)

TTF_RenderGlyph_Shaded

Render a single UNICODE codepoint at high quality to a new 8-bit surface.

Header File

Syntax

SDL_Surface * TTF_RenderGlyph_Shaded(TTF_Font *font, Uint32 ch, SDL_Color fg, SDL_Color bg);

Function Parameters

TTF_Font *	font	the font to render with.
Uint32	ch	the codepoint to render.
SDL_Color	fg	the foreground color for the text.
SDL_Color	bg	the background color for the text.

Return Value

(SDL_Surface *) Returns a new 8-bit, palettized surface, or NULL if there was an error.

Remarks

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.

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

You can render at other quality levels with TTF_RenderGlyph_Solid, TTF_RenderGlyph_Blended, and TTF_RenderGlyph_LCD.

Thread Safety

This function should be called on the thread that created the font.

Version

This function is available since SDL_ttf 3.0.0.