TTF_RenderGlyph_Shaded(3)

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

✨ TTF_RenderGlyph_Shaded(3) ✨

okay bestie, pull up a chair 💖 this one lives in the SDL_ttf manual (that's the whole manual name, she's famous) and it's giving single glyph, high quality, new surface energy. no cap.

🌸 NAME 🌸

TTF_RenderGlyph_Shaded — render a single UNICODE codepoint at high quality to a new 8-bit surface.

🎀 HEADER FILE 🎀

she's defined in SDL3_ttf/SDL_ttf.h — that's the one, the only 🫶

✨ SYNOPSIS ✨

#include "SDL3_ttf/SDL_ttf.h"

SDL_Surface * TTF_RenderGlyph_Shaded(TTF_Font *font, Uint32 ch, SDL_Color fg, SDL_Color bg);

💅 DESCRIPTION 💅

so what this does is allocate a brand new 8-bit, palettized surface. and listen — the surface's 0 pixel? that's your background color, exactly as you specified it. every other pixel is the foreground color but with varying degrees of it. it's a whole gradient situation, lowkey iconic.

this function hands you back that new surface… or NULL if there was an error 😭 (yes, check it, bestie, always check it).

the glyph gets rendered with no padding and no centering in the X direction, and aligned normally in the Y direction. so she's left-hugging, no extra personal space. periodt.

and if you want a different quality level, you can totally render with:

  • TTF_RenderGlyph_Solid
  • TTF_RenderGlyph_Blended
  • TTF_RenderGlyph_LCD

pick your vibe 🌈

🦋 FUNCTION PARAMETERS 🦋

  • font — the font to render with. your girl, your typeface, your whole aesthetic.
  • ch — the codepoint to render. the actual character, UNICODE and all.
  • fg — the foreground color for the text. main character color energy 👑
  • bg — the background color for the text. the supporting cast, still slaying.

🌟 RETURN VALUE 🌟

returns a new 8-bit, palettized surface 🎉 — or NULL if there was an error. that's it, that's the tea. don't sleep on the NULL check fr fr.

🧚 THREAD SAFETY 🧚

call this on the thread that created the font. literally. that's the rule. don't be out here passing fonts between threads like they're notes in class 🙈

⭐ AVAILABILITY ⭐

available since SDL_ttf 3.0.0 — she's been around, she's established, she ate.

💜 SEE ALSO 💜

⚠️ quick reminder bestie: the 0 pixel is the background color, everything else is the foreground at varying degrees, there's no X padding or centering, and you must call it from the thread that made the font. that's not a vibe check, that's a fact check. 💖

and that's the whole page! brought to you by SDL_ttf 3.2.2, the SDL_ttf crew, out here keeping your text looking cute since forever. bye bestie, go render something gorgeous 🎀✨💅

📦 where this page comes from