TTF_RenderText_Solid_Wrapped3
Render word-wrapped utf-8 text at fast quality to a new 8-bit surface.
Usage
#include "SDL3_ttf/SDL_ttf.h"
SDL_Surface * TTF_RenderText_Solid_Wrapped(TTF_Font *font, const char *text, size_t length, SDL_Color fg, int wrapLength);
Header file
Defined in SDL3_ttf/SDL_ttf.h
Overview
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.
Text is wrapped to multiple lines on line endings and on word boundaries if it extends beyond wrapLength in pixels.
If wrapLength is 0, this function will only wrap on newline characters.
You can render at other quality levels with
TTF_RenderText_Shaded_Wrapped ,
TTF_RenderText_Blended_Wrapped , and
TTF_RenderText_LCD_Wrapped .
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. |
wrapLength
|
the maximum width of the text surface or 0 to wrap on newline characters. |
Return value
Returns a new 8-bit, palettized surface, or NULL if there was an error.
Thread safety
This function should be called on the thread that created the font.