.\" 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_RenderText_Shaded_Wrapped:
.\"   https://wiki.libsdl.org/SDL_ttf/TTF_RenderText_Shaded_Wrapped
.\" 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_RenderText_Shaded_Wrapped
.\" 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_RenderText_Shaded_Wrapped 3 "SDL_ttf 3.0.0" "SDL_ttf" "SDL_ttf3 FUNCTIONS"
.SH NAME
TTF_RenderText_Shaded_Wrapped \- Render word-wrapped Latin1 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_RenderText_Shaded_Wrapped(TTF_Font *font,
.BI "                const char *text, SDL_Color fg, SDL_Color bg, Uint32 wrapLength);
.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]

Text is wrapped to multiple lines on line endings and on word boundaries if
it extends beyond
.BR wrapLength
in pixels\[char46]

If wrapLength is 0, this function will only wrap on newline characters\[char46]

You almost certainly want

.BR TTF_RenderUTF8_Shaded_Wrapped
() unless
you're sure you have a 1-byte Latin1 encoding\[char46] US ASCII characters will
work with either function, but most other Unicode characters packed into a
.BR const char *
will need UTF-8\[char46]

You can render at other quality levels with

.BR TTF_RenderText_Solid_Wrapped
,

.BR TTF_RenderText_Blended_Wrapped
, and

.BR TTF_RenderText_LCD_Wrapped
\[char46]

.SH FUNCTION PARAMETERS
.TP
.I font
the font to render with\[char46]
.TP
.I text
text to render, in Latin1 encoding\[char46]
.TP
.I fg
the foreground color for the text\[char46]
.TP
.I bg
the background 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_Wrapped (3),
.BR TTF_RenderUNICODE_Shaded_Wrapped (3)