Scroll to navigation

TTF_SizeText(3) SDL_ttf3 FUNCTIONS TTF_SizeText(3)

NAME

TTF_SizeText - Calculate the dimensions of a rendered string of Latin1 text.

HEADER FILE

Defined in SDL3_ttf/SDL_ttf.h

SYNOPSIS

#include "SDL3_ttf/SDL_ttf.h"
SDL_bool TTF_SizeText(TTF_Font *font, const char *text, int *w, int *h);

DESCRIPTION

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

This does not need to render the string to do this calculation.

You almost certainly want TTF_SizeUTF8 () unless you're sure you have a 1-byte Latin1 encoding. US ASCII characters will work with either function, but most other Unicode characters packed into a const char * will need UTF-8.

FUNCTION PARAMETERS

the font to query.
text to calculate, in Latin1 encoding.
will be filled with width, in pixels, on return.
will be filled with height, in pixels, on return.

RETURN VALUE

Returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() for more information.

AVAILABILITY

This function is available since SDL_ttf 3.0.0.

SEE ALSO

•(3), TTF_SizeUTF8(3), •(3), TTF_SizeUNICODE(3)

SDL_ttf 3.0.0 SDL_ttf