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

TTF_GetStringSize

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

Header File

Defined in <SDL3_ttf/SDL_ttf.h>

Syntax

bool TTF_GetStringSize(TTF_Font *font, const char *text, size_t length, int *w, int *h);

Function Parameters

TTF_Font *	font	the font to query.
const char *	text	text to calculate, in UTF-8 encoding.
size_t	length	the length of the text, in bytes, or 0 for null terminated text.
int *	w	will be filled with width, in pixels, on return.
int *	h	will be filled with height, in pixels, on return.

Return Value

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

Remarks

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

Thread Safety

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

Version

This function is available since SDL_ttf 3.0.0.

---

CategoryAPI, CategoryAPIFunction, CategorySDLTTF

[ 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.