TTF_GetTextScript(3)

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

✨ TTF_GetTextScript ✨

okay bestie, so this is TTF_GetTextScript(3) from the SDL_ttf3 function family, and it's literally the little detective that tells you which script your text object is getting shaped with 💅

🌸 NAME 🌸

TTF_GetTextScript — get the script used for text shaping a text object 🦋

🎀 HEADER FILE 🎀

it lives in SDL3_ttf/SDL_ttf.h, no cap 💖

✨ SYNOPSIS ✨

#include "SDL3_ttf/SDL_ttf.h"

Uint32 TTF_GetTextScript(TTF_Text *text);

💜 DESCRIPTION 💜

so like… this one just asks your text object "hey girl, what script are you?" 🫶

If nobody set one explicitly, it defaults to the script of the font used by the text object. so it's giving "inherited from the font" energy ✨

🍓 FUNCTION PARAMETERS 🍓

  • text — the text to query 👑 (that's the one you're asking about, bestie)

🌈 RETURN VALUE 🌈

Returns an ISO 15924 code ⭐

like, from this list:

https://
unicode.www:lenstrwww:splitstr:nwww:splitstr:r[char46]org/iso15924/
iso15924-codes.www:lenstrwww:splitstr:nwww:splitstr:r[char46]html
not me side-eyeing the man page renderer for chewing up that URL 💀 that's literally what it says in the source page though, so I'm keeping it exactly as-is. iykyk.

OR it returns 0 if a script hasn't been set on either the text object or the font 😭 (no script anywhere = sad little zero)

🧚 THREAD SAFETY 🧚

this function should be called on the thread that created the text. periodt. 🔥 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 — so it's been iconic for a while now ✨

💖 SEE ALSO 💖

and that's the whole thing, bestie! 🎀 this page is from SDL_ttf version 3.2.2 (the SDL_ttf 3.2.2 footer energy), and yeah the title line is just TTF_GetTextScript(3) again because man pages love repeating themselves 💅 go forth and query your scripts, you main character 🦋💖

📦 where this page comes from