NAME¶

TTF_MeasureText - Calculate how much of a Latin1 string will fit in a given width.

HEADER FILE¶

Defined in SDL3_ttf/SDL_ttf.h

SYNOPSIS¶

#include "SDL3_ttf/SDL_ttf.h"

SDL_bool TTF_MeasureText(TTF_Font *font, const char *text, int measure_width, int *extent, int *count);

DESCRIPTION¶

This reports the number of characters that can be rendered before reaching measure_width .

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

You almost certainly want TTF_MeasureUTF8 () 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 constchar* will need UTF-8.

FUNCTION PARAMETERS¶

font

the font to query.

text

text to calculate, in Latin1 encoding.

measure_width

maximum width, in pixels, available for the string.

extent

on return, filled with latest calculated width.

count

on return, filled with number of characters that can be rendered.

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_MeasureText(3), •(3), TTF_MeasureUTF8(3), •(3), TTF_MeasureUNICODE(3)