SDL_SetSurfaceColorMod(3)

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

✨ SDL_SetSurfaceColorMod ✨

okay bestie, so like... you know how when you blit a surface you can tint it? this is that function. it's a SDL3 FUNCTIONS girlie, header file SDL3/SDL_surface.h, and she's here to let you multiply a color into every blit. no cap. 💅

🌸 NAME 🌸

SDL_SetSurfaceColorMod — set an additional color value multiplied into blit operations. literally that's it, that's the whole vibe 🎀

🦋 SYNOPSIS 🦋

#include <SDL3/SDL_surface.h>

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

💖 DESCRIPTION 💖

so the tea is: when this surface gets blitted, during the blit operation each source color channel is modulated by the appropriate color value — and the formula is giving:

srcC = srcC * (color / 255)

that's it. that's the math. iconic behavior fr fr 🌈

🫶 FUNCTION PARAMETERS 🫶

  • surface — the SDL_Surface structure to update. the main character, the one we're touching 💜
  • r — the red color value multiplied into blit operations.
  • g — the green color value multiplied into blit operations.
  • b — the blue color value multiplied into blit operations.

👑 RETURN VALUE 👑

Returns true on success or false on failure; call SDL_GetError() for more information. so if it flops, go ask SDL_GetError() what happened, she always knows 😭

🧚 THREAD SAFETY 🧚

This function can be called on different threads with different surfaces. so like, share the load babes, just keep your surfaces separate ✨

⭐ AVAILABILITY ⭐

This function is available since SDL 3.2.0. she's new-ish but she's thriving 💅

🔥 SEE ALSO 🔥

and that's the whole page bestie 🎀 go modulate some colors, you're gonna eat 💖

this lil writeup is from the Simple Directmedia Layer girlies, version SDL 3.4.18, dated SDL_SetSurfaceColorMod(3) — mwah, love u, bye 🦋

📦 where this page comes from