TTF_SetFontOutline(3)

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

💖 TTF_SetFontOutline(3) 💖

okay bestie, welcome to the SDL_ttf3 FUNCTIONS corner of the group chat 🫶 today's main character is TTF_SetFontOutline, and she's here to give your font a lil glow-up around the edges. yes, literally an outline. iconic behavior.

✨ NAME ✨

TTF_SetFontOutline — sets a font's current outline. that's it, that's the whole vibe 💅

📁 HEADER FILE 📁

she lives in SDL3_ttf/SDL_ttf.h. that's where you'll find her defined, no cap.

🌸 SYNOPSIS 🌸

#include "SDL3_ttf/SDL_ttf.h"

bool TTF_SetFontOutline(TTF_Font *font, int outline);

look at that signature. clean. stunning. slay.

💫 DESCRIPTION 💫

so here's the tea 🍓 — when you set the font outline, this function pulls in a whole little committee of font properties to make it happen:

  • TTF_PROP_FONT_OUTLINE_LINE_CAP_NUMBER
  • TTF_PROP_FONT_OUTLINE_LINE_JOIN_NUMBER
  • TTF_PROP_FONT_OUTLINE_MITER_LIMIT_NUMBER

those three get used when setting the font outline. periodt.

and it doesn't stop there, bestie — this also updates any TTF_Text objects using this font, and it clears already-generated glyphs, if any, from the cache. so like, she refreshes the whole friend group, not just herself. the way that she keeps everyone in sync 😭💖

🎀 FUNCTION PARAMETERS 🎀

  • font — the font you're giving a brand new outline to. your canvas, your queen 👑
  • outline — a positive outline value, or 0 to go back to the default. (yes, 0 is the "never mind, back to factory settings" option 💅)

🔥 RETURN VALUE 🔥

Returns true on success or false on failure. if it flops, call SDL_GetError() for more info — she will tell you exactly what went wrong, fr fr.

🧚 THREAD SAFETY 🧚

this function should be called on the thread that created the font. don't be messy and call her from some random thread, bestie — she's loyal like that 🙈

⭐ AVAILABILITY ⭐

this function has been available since SDL_ttf 3.0.0. so she's been serving looks for a while now.

🌈 SEE ALSO 🌈

lowkey important reminder: outline wants a positive value, and 0 means default. don't come at her with some negative nonsense, okay? 🫶

kay that's the whole page, you're basically a font outline expert now 💅✨ go forth and outline responsibly, bestie 🦋

this lil gem comes from the SDL_ttf manual, version SDL_ttf 3.2.2 — mwah, sending love from the SDL_ttf squad 🎀💜

📦 where this page comes from