SDL_ConvertS...AndColorspace(3)

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

✨ NAME ✨

SDL_ConvertSurfaceAndColorspace — bestie, it copies an existing surface into a brand new surface with the format and colorspace you picked. glow-up for your pixels 💅

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_surface.h>

SDL_Surface * SDL_ConvertSurfaceAndColorspace(SDL_Surface *surface, SDL_PixelFormat format, SDL_Palette *palette, SDL_Colorspace colorspace, SDL_PropertiesID props);

💖 DESCRIPTION 💖

okay so here's the tea 🫖 — this function takes an existing surface, converts it to a new format and a new colorspace, and hands you back the new surface. it does literally all the pixel format conversion and colorspace conversion that needs doing. no extra steps, no manual labor, it just handles it.

and the sweetest part? if your original surface has alternate images, the new surface keeps a reference to them too. it's giving "we come as a package deal" 🎀

🦋 FUNCTION PARAMETERS 🦋

  • surface — the existing SDL_Surface structure you wanna convert. your main character.
  • format — the new pixel format. yes, a whole new look.
  • palette — an optional palette to use for indexed formats. can be NULL, no pressure 💜
  • colorspace — the new colorspace. slay.
  • props — an SDL_PropertiesID with additional color properties, or 0. extra flair optional.

⭐ RETURN VALUE ⭐

returns the new SDL_Surface structure that gets created — iconic ✨ — or NULL on failure 😭. if it fails, call SDL_GetError() for more info, it'll tell you what went wrong.

🧚 THREAD SAFETY 🧚

you can call this on different threads with different surfaces. no cap. 💅

🌈 AVAILABILITY 🌈

this function has been available since SDL 3.2.0. so it's not new new, but it's also not ancient. iykyk 🦋

👑 SEE ALSO 👑

and that's the whole vibe, bestie 💖 this lil page came from Simple Directmedia Layer — SDL 3.4.18, the SDL_ConvertS...AndColorspace(3) page. go convert something pretty, periodt. 🎀✨

📦 where this page comes from