table of contents
other versions
- experimental 3~git20240320~6e260a2+ds-1
TTF_MeasureUTF8(3) | SDL_ttf3 FUNCTIONS | TTF_MeasureUTF8(3) |
NAME¶
TTF_MeasureUTF8 - Calculate how much of a UTF-8 string will fit in a given width.
SYNOPSIS¶
#include "SDL3_ttf/SDL_ttf.h"
int TTF_MeasureUTF8(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.
FUNCTION PARAMETERS¶
- font
- the font to query.
- text
- text to calculate, in UTF-8 encoding.
- measure_width
- maximum width, in pixels, available for the string.
- count
- on return, filled with number of characters that can be rendered.
- extent
- on return, filled with latest calculated width.
RETURN VALUE¶
Returns 0 if successful, -1 on error.
AVAILABILITY¶
This function is available since SDL_ttf 3.0.0.
SEE ALSO¶
TTF_MeasureText(3), TTF_MeasureUTF8(3), TTF_MeasureUNICODE(3)
SDL_ttf 3.0.0 | SDL_ttf |