SDL_GetMasksForPixelFormat(3)

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

💅 SDL_GetMasksForPixelFormat 💅

okay bestie, welcome to the SDL_GetMasksForPixelFormat(3) page — yes it lives in the SDL3 FUNCTIONS crew, and yes it's about pixels, which means it's automatically iconic. 💖

✨ NAME ✨

SDL_GetMasksForPixelFormat — converts one of the enumerated pixel formats into a bpp value plus RGBA masks. that's the whole job. she's a translator. a pixel-format-to-masks translator. slay. 🌈

🎀 SYNOPSIS 🎀

#include <SDL3/SDL_pixels.h>

bool SDL_GetMasksForPixelFormat(SDL_PixelFormat format, int *bpp, Uint32 *Rmask, Uint32 *Gmask, Uint32 *Bmask, Uint32 *Amask);

look at her. six whole parameters. main character energy fr fr. 👑

🫶 FUNCTION PARAMETERS 🫶

  • format — one of the SDL_PixelFormat values. just hand her the format you're curious about and she'll spill everything.
  • bpp — a bits-per-pixel value; usually 15, 16, or 32. lowkey those three are the usual suspects.
  • Rmask — a pointer that gets filled in with the red mask for the format. 🔴
  • Gmask — a pointer that gets filled in with the green mask for the format. 🟢
  • Bmask — a pointer that gets filled in with the blue mask for the format. 🔵
  • Amask — a pointer that gets filled in with the alpha mask for the format. the transparency one. the vibe one. 🫥
bestie these are pointers, so she's writing into them. don't pass her something uninitialized and then act surprised, i'm begging. 😭

💀 RETURN VALUE 💀

Returns true on success or false on failure. and if it fails?? call SDL_GetError() for more information, because she will NOT be explaining herself unprompted. 🙈

🧚 THREAD SAFETY 🧚

It is safe to call this function from any thread. yes, any thread. she does not gatekeep, she does not play favourites, she is safe everywhere. periodt. 💜

⭐ AVAILABILITY ⭐

This function is available since SDL 3.2.0. so if you're on something older, no masks for you, sorry babe. 🎀

🌸 SEE ALSO 🌸

  • SDL_GetPixelFormatForMasks(3) — the reverse direction, the uno reverse card, the "okay but what format do these masks make" question. iykyk. 🦋

and that's the page!! this lil writeup came to you from Simple Directmedia Layer, version SDL 3.4.18, and it's literally the SDL_GetMasksForPixelFormat(3) manpage but make it cute. go forth and mask responsibly, bestie 💖✨🍓

📦 where this page comes from