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_Solid_Wrapped - Render word-wrapped UTF-8 text at fast 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 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.

Header File

       Defined in SDL3_ttf/SDL_ttf.h

Name

       TTF_RenderText_Solid_Wrapped - Render word-wrapped UTF-8 text at fast 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_Wrapped(3),       (3),      TTF_RenderText_LCD_Wrapped(3),      (3),
       TTF_RenderText_Shaded_Wrapped(3), (3), TTF_RenderText_Solid(3)

SDL_ttf                                           SDL_ttf 3.2.2                  TTF_RenderText_Solid_Wrapped(3)

Synopsis

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

Thread Safety

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

See Also