TTF_GetTextColorFloat(3)

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

💖 TTF_GetTextColorFloat(3) 💖

okay bestie, welcome to the SDL_ttf3 functions corner of the SDL_ttf manual — this one's about peeking at what color a text object is rocking. no cap.

🌸 NAME 🌸

TTF_GetTextColorFloat — get the color of a text object. that's it, that's the whole job ✨

🎀 HEADER FILE 🎀

defined in SDL3_ttf/SDL_ttf.h — yeah she lives there, go say hi 🫶

✨ SYNOPSIS ✨

#include "SDL3_ttf/SDL_ttf.h"

bool TTF_GetTextColorFloat(TTF_Text *text, float *r, float *g, float *b, float *a);

🦋 FUNCTION PARAMETERS 🦋

  • text — the TTF_Text to query. the main character, literally. 👑
  • r — a pointer that gets filled in with the red color value, normally in the range of 0-1, and it may be NULL. 🙈
  • g — a pointer that gets filled in with the green color value, normally in the range of 0-1, and it may be NULL. 🌿
  • b — a pointer that gets filled in with the blue color value, normally in the range of 0-1, and it may be NULL. 💙
  • a — a pointer that gets filled in with the alpha value in the range of 0-1, and it may be NULL. 💅

💀 RETURN VALUE 💀

returns true on success or false on failure — and if it fails, bestie, call SDL_GetError() for more information. the error message is giving what you need to know, fr fr.

🧵 THREAD SAFETY 🧵

this function should be called on the thread that created the text. no wandering off to another thread, she's loyal like that. 😭

⭐ AVAILABILITY ⭐

this function is available since SDL_ttf 3.0.0. been iconic for a minute.

🌈 SEE ALSO 🌈

and that's the whole page, periodt. 💜 brought to you by SDL_ttf, version SDL_ttf 3.2.2 — no date on this one so we're just gonna vibe with the version, mwah 💋🎀

📦 where this page comes from