logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

TTF_RenderText_Shaded - Render UTF-8 text at high quality to a new 8-bit surface.

Availability

       This function is available since SDL_ttf 3.0.0.

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 can render at other quality levels with

       TTF_RenderText_Solid ,

       TTF_RenderText_Blended , and

       TTF_RenderText_LCD .

Function Parameters

font   the font to render with.

       text   text to render, in UTF-8 encoding.

       length the length of the text, in bytes, or 0 for null terminated text.

       fg     the foreground color for the text.

       bg     the background color for the text.

Header File

       Defined in SDL3_ttf/SDL_ttf.h

Name

       TTF_RenderText_Shaded - Render UTF-8 text at high quality to a new 8-bit surface.

Return Value

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

See Also

(3), TTF_RenderText_Blended(3),  (3),  TTF_RenderText_LCD(3),  (3),  TTF_RenderText_Shaded_Wrapped(3),
       (3), TTF_RenderText_Solid(3)

SDL_ttf                                           SDL_ttf 3.2.2                         TTF_RenderText_Shaded(3)

Synopsis

#include"SDL3_ttf/SDL_ttf.h"SDL_Surface*TTF_RenderText_Shaded(TTF_Font*font,constchar*text,size_tlength,SDL_Colorfg,SDL_Colorbg);

Thread Safety

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

See Also