SDL_GetSurfaceColorspace(3)

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

✨ SDL_GetSurfaceColorspace ✨

okay bestie, welcome to the SDL3 FUNCTIONS corner of the man pages 💖 this one's called SDL_GetSurfaceColorspace, and no cap, it's a lil baby function that just tells you what colorspace a surface is vibing in. super simple, super useful, let's get into it 🦋

🌸 NAME 🌸

SDL_GetSurfaceColorspace — get the colorspace used by a surface. that's it. that's the whole job. iconic behavior honestly 👑

🎀 SYNOPSIS 🎀

#include <SDL3/SDL_surface.h>

SDL_Colorspace SDL_GetSurfaceColorspace(SDL_Surface *surface);

look at her. one include, one function call, zero drama 💅

💜 DESCRIPTION 💜

so here's the tea ☕ — the colorspace of your surface isn't just random, it defaults based on what kind of format the surface is using. the rules are:

  • floating point formats → defaults to SDL_COLORSPACE_SRGB_LINEAR
  • 10-bit formats → defaults to SDL_COLORSPACE_HDR10
  • other RGB surfaces → defaults to SDL_COLORSPACE_SRGB
  • YUV textures → defaults to SDL_COLORSPACE_BT709_FULL

so yeah, it's giving "the surface already knows what it is" energy 🌈

🫶 FUNCTION PARAMETERS 🫶

  • surface — the SDL_Surface structure you wanna query. just hand her over and she'll tell you her colorspace secrets 🔍

⭐ RETURN VALUE ⭐

returns the colorspace used by the surface 🎉 ... BUT — and this is the important part bestie — if the surface is NULL, you get SDL_COLORSPACE_UNKNOWN back. so like, don't be surprised, it's not throwing hands, it's just telling you there's nothing there 💀

🧚 THREAD SAFETY 🧚

good news!! this function can be called on different threads with different surfaces 🔥 so as long as you're not poking the same surface from two threads at once, you're chilling. parallel vibes only ✨

💖 AVAILABILITY 💖

this function has been around since SDL 3.2.0 🎂 so if you're on anything older, sorry babe, she's not there yet 😭

🌈 SEE ALSO 🌈

reminder bestie: getting a colorspace is read-only, it doesn't change anything. if you wanna change the vibe, go see SDL_SetSurfaceColorspace(3). iykyk 💅

and that's the whole page, periodt 🎀 this little love letter to the colorspace API came to you from Simple Directmedia Layer, SDL 3.4.18, and yeah she's filed under SDL_GetSurfaceColorspace(3) — go forth and query those surfaces, you absolute main character 👑💖

📦 where this page comes from