SDL_GetPixelFormatName(3)

💖 SDL_GetPixelFormatName(3) 💖

okay bestie, welcome to the SDL3 FUNCTIONS corner of the manual, where we learn how to ask a pixel format for its government name 💅

---

✨ NAME ✨

SDL_GetPixelFormatName</puruple> — get the human readable name of a pixel format 🎀

Like, you hand it a pixel format and it hands you back a cute lil string. That's the whole gig. Iconic, honestly.

---

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_pixels.h>

const char * SDL_GetPixelFormatName(SDL_PixelFormat format);

no cap, that's the whole signature. one function, one arg, one const char * walking back out the door ✨

---

🦋 FUNCTION PARAMETERS 🦋

• format — the pixel format to query. that's the one you're curious about, bestie, so go ahead and pass it in 🫶

---

💜 RETURN VALUE 💜

It returns the human readable name of the specified pixel format 💖

and if the format isn't recognized? it gives you back "SDL_PIXELFORMAT_UNKNOWN" instead. like a little "idk her" but in string form 😭

---

🔥 THREAD SAFETY 🔥

It is safe to call this function from any thread. yes, literally any. go wild, main character 🌈

---

⭐ AVAILABILITY ⭐

This function is available since SDL 3.2.0 👑

---

ngl that's the entire page — short and sweet, just like a good group chat message 🍓

Simple Directmedia Layer 🎀 SDL 3.4.18 🎀 SDL_GetPixelFormatName(3) — mwah, that's the version and date, thanks for coming to my ted talk, slay, bye bestie 💅✨🦋💖