SDL_GetSurfaceColorMod(3)

📦
version 3.4.18 · 9 versions
, in fedora 43, fedora 44

💖 SDL_GetSurfaceColorMod 💖

okay bestie, welcome to the SDL3 FUNCTIONS corner of the man pages, where we're talking about SDL_GetSurfaceColorMod — the little cutie that tells you what extra color value is getting multiplied into your blit operations. ✨

🌸 NAME 🌸

SDL_GetSurfaceColorMod — get the additional color value multiplied into blit operations. that's it, that's the whole vibe check. 🎀

🦋 SYNOPSIS 🦋

#include <SDL3/SDL_surface.h>

bool SDL_GetSurfaceColorMod(SDL_Surface *surface, Uint8 *r, Uint8 *g, Uint8 *b);

✨ FUNCTION PARAMETERS ✨

so you're passing in four things, and like, each one matters, no cap:

  • surface — the SDL_Surface structure you wanna query. it's the main character here, she's the one getting interrogated. 👑
  • r — a pointer that gets filled in with the current red color value. yes it's a pointer, yes you have to give her somewhere to live.
  • g — a pointer that gets filled in with the current green color value. same deal, she needs a home too. 🌿
  • b — a pointer that gets filled in with the current blue color value. trio complete, slay. 💙

🫶 RETURN VALUE 🫶

returns true on success or false on failure — and if it's giving failure, call SDL_GetError() for more information, because she will tell you what went wrong, bestie. 😭

🧚 THREAD SAFETY 🧚

this function can be called on different threads with different surfaces. so like, parallel besties, different surfaces, everyone minding their own business. periodt. 💅

🌈 AVAILABILITY 🌈

this function is available since SDL 3.2.0. iconic behavior from day one, honestly. ⭐

💜 SEE ALSO 💜

ngl if you're reading the whole set of these you're lowkey becoming a surface mod connoisseur and i'm obsessed with that for you. 🔥

and that's the tea, bestie — this page came straight out of the Simple Directmedia Layer era, version SDL 3.4.18, with SDL_GetSurfaceColorMod(3) holding it down. go forth and multiply those color values, you got this. 💖🦋✨

📦 where this page comes from