TTF_SetTextWrapWidth(3)

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

💖 TTF_SetTextWrapWidth(3) 💖

okay bestie, so this one lives in the SDL_ttf3 FUNCTIONS section of the SDL_ttf manual, and it's genuinely one of the cutest little toggles in the whole library. no cap.

✨ NAME ✨

TTF_SetTextWrapWidth — set whether wrapping is enabled on a text object.

🎀 HEADER FILE 🎀

Defined in SDL3_ttf/SDL_ttf.h

🌸 SYNOPSIS 🌸

#include "SDL3_ttf/SDL_ttf.h"

bool TTF_SetTextWrapWidth(TTF_Text *text, int wrap_width);

🦋 DESCRIPTION 🦋

this is the function you call when you want your text to behave.

heads up though, and this is important: it may cause the internal text representation to be rebuilt. so like, it's not a free little vibe check — it might do actual work behind the scenes. 💅

⭐ FUNCTION PARAMETERS ⭐

  • text — the TTF_Text you wanna modify. your girl. your main character.
  • wrap_width — the maximum width in pixels. and ooh, plot twist: pass 0 and it wraps on newline characters instead. iconic behaviour honestly.

💀 RETURN VALUE 💀

returns true on success and false on failure. if it flops, call SDL_GetError() for more information — she'll tell you what went wrong, fr fr.

🧚 THREAD SAFETY 🧚

this function should be called on the thread that created the text. like, do not go handing your text object to some random other thread. it's giving "only the parent thread gets custody." 🫶

🌈 AVAILABILITY 🌈

this function is available since SDL_ttf 3.0.0. so it's been around, it's established, it's basically a legacy queen at this point. 👑

🔥 SEE ALSO 🔥

lowkey reminder: setting the wrap width is the move when you want text that respects your layout instead of just running off the edge of the screen like it has no responsibilities. obsessed.

and that's the whole page bestie!! this lil writeup is from the SDL_ttf manual, documenting SDL_ttf 3.2.2, and it's all about TTF_SetTextWrapWidth(3). go forth and wrap responsibly, mwah 💖✨🎀

📦 where this page comes from