.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL_ttf's wiki page for TTF_RenderUNICODE_Shaded:
.\"   https://wiki.libsdl.org/SDL_ttf/TTF_RenderUNICODE_Shaded
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision 3~git20240320~6e260a2+ds-1
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20TTF_RenderUNICODE_Shaded
.\" SDL_ttf can be found at https://libsdl.org/projects/SDL_ttf
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH TTF_RenderUNICODE_Shaded 3 "SDL_ttf 3.0.0" "SDL_ttf" "SDL_ttf3 FUNCTIONS"
.SH NAME
TTF_RenderUNICODE_Shaded \- Render UCS-2 text at high quality to a new 8-bit surface\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3_ttf/SDL_ttf.h\(dq
.PP
.BI "SDL_Surface * TTF_RenderUNICODE_Shaded(TTF_Font *font,
.BI "                const Uint16 *text, SDL_Color fg, SDL_Color bg);
.fi
.SH DESCRIPTION
This function will allocate a new 8-bit, palettized surface\[char46] The surface's
0 pixel will be the specified background color, while other pixels have
varying degrees of the foreground color\[char46] This function returns the new
surface, or NULL if there was an error\[char46]

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

.BR TTF_RenderUNICODE_Shaded_Wrapped
()
instead if you need to wrap the output to multiple lines\[char46]

This will not wrap on newline characters\[char46]

Please note that this function is named "Unicode" but currently expects
UCS-2 encoding (16 bits per codepoint)\[char46] This does not give you access to
large Unicode values, such as emoji glyphs\[char46] These codepoints are accessible
through the UTF-8 version of this function\[char46]

You can render at other quality levels with

.BR TTF_RenderUNICODE_Solid
,

.BR TTF_RenderUNICODE_Blended
, and

.BR TTF_RenderUNICODE_LCD
\[char46]

.SH FUNCTION PARAMETERS
.TP
.I font
the font to render with\[char46]
.TP
.I text
text to render, in UCS-2 encoding\[char46]
.TP
.I fg
the foreground color for the text\[char46]
.SH RETURN VALUE
Returns a new 8-bit, palettized surface, or NULL if there was an error\[char46]

.SH AVAILABILITY
This function is available since SDL_ttf 3\[char46]0\[char46]0\[char46]

.SH SEE ALSO
.BR TTF_RenderUTF8_Shaded (3)