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_GetStringSizeWrapped - Calculate the dimensions of a rendered string of UTF-8 text.

Availability

       This function is available since SDL_ttf 3.0.0.

SDL_ttf                                           SDL_ttf 3.2.2                      TTF_GetStringSizeWrapped(3)

Description

       This  will  report  the  width and height, in pixels, of the space that the specified string will take to
       fully render.

       Text is wrapped to multiple lines on line endings and on word boundaries if it extends beyond  wrap_width
       in pixels.

       If wrap_width is 0, this function will only wrap on newline characters.

Function Parameters

font   the font to query.

       text   text to calculate, in UTF-8 encoding.

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

       wrap_width
              the maximum width or 0 to wrap on newline characters.

       w      will be filled with width, in pixels, on return.

       h      will be filled with height, in pixels, on return.

Header File

       Defined in SDL3_ttf/SDL_ttf.h

Name

       TTF_GetStringSizeWrapped - Calculate the dimensions of a rendered string of UTF-8 text.

Return Value

       Returns true on success or false on failure; call SDL_GetError() for more information.

Synopsis

#include"SDL3_ttf/SDL_ttf.h"boolTTF_GetStringSizeWrapped(TTF_Font*font,constchar*text,size_tlength,intwrap_width,int*w,int*h);

Thread Safety

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

See Also