TTF_GetStringSize(3)

📦 version 3.2.2, in debian trixie, fedora 43, fedora 44, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 TTF_GetStringSize(3) 💖

okay bestie, so this is a page from the SDL_ttf3 functions manual, and it's literally about measuring how big your text is gonna be before you render it. iconic behavior honestly.

✨ NAME ✨

TTF_GetStringSize — calculate the dimensions of a rendered string of UTF-8 text.

Like. It tells you how much space your string is gonna take up. That's the whole job. 🎀

🌸 HEADER FILE 🌸

Defined in SDL3_ttf/SDL_ttf.h

🦋 SYNOPSIS 🦋

#include "SDL3_ttf/SDL_ttf.h"

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

💅 DESCRIPTION 💅

So the way that this works is: it reports the width and height, in pixels, of the space that the specified string will take to fully render. That's it. That's the tea. ☕

No cap, if you've ever been like "hmm will this fit in my box" — this is the function. iykyk. ✨

🫶 FUNCTION PARAMETERS 🫶

  • font — the font to query. yes, the font. the main character. 👑
  • text — text to calculate, in UTF-8 encoding. keep it UTF-8 bestie, we're not doing that other stuff. 🌈
  • length — the length of the text, in bytes, or 0 for null terminated text. so if you pass 0, it just keeps going until it hits the null. easy. 🍓
  • w — will be filled with width, in pixels, on return. it gets written into, so hand it a real pointer fr fr. ✍️
  • h — will be filled with height, in pixels, on return. same deal, it's an out-param. 💜

💀 RETURN VALUE 💀

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

so if it comes back false, don't just sit there — go call SDL_GetError() and find out what went wrong. it's giving "read the error message" energy. 😭

🧚 THREAD SAFETY 🧚

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

bestie. listen. same thread that made the font, okay? don't be out here calling it from some random thread, that's not the vibe. 🙈

⭐ AVAILABILITY ⭐

This function is available since SDL_ttf 3.0.0.

🌈 SEE ALSO 🌈

okay there's no SEE ALSO section on this one, we're keeping it cute and self-contained. slay. 💅

and that's the whole page!! this one came out of the SDL_ttf manual, version SDL_ttf 3.2.2, page TTF_GetStringSize(3). mwah. go measure some strings, bestie 🫶✨🎀

📦 where this page comes from