(This function is part of SDL_ttf, a separate library from SDL.)

TTF_MeasureUTF8

Calculate how much of a UTF-8 string will fit in a given width.

Header File

Defined in <SDL3_ttf/SDL_ttf.h>

Syntax

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

Function Parameters

TTF_Font *	font	the font to query.
const char *	text	text to calculate, in UTF-8 encoding.
int	measure_width	maximum width, in pixels, available for the string.
int *	extent	on return, filled with latest calculated width.
int *	count	on return, filled with number of characters that can be rendered.

Return Value

(int) Returns 0 if successful, -1 on error.

Remarks

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.

Version

This function is available since SDL_ttf 3.0.0.

See Also

• TTF_MeasureText
• TTF_MeasureUTF8
• TTF_MeasureUNICODE

---

CategoryAPI, CategoryAPIFunction

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.