SDL_CONVERTPIXELSANDCOLORSPACE(3)

✨ SDL_ConvertPixelsAndColorspace 💅

okay bestie, gather round, because this one is a baddie from the SDL3 functions crew 🫶

🌸 NAME 🌸

SDL_ConvertPixelsAndColorspace — copy a block of pixels of one format and colorspace to another format and colorspace. yes. format AND colorspace. both. it's giving glow-up for your pixel data ✨

---

🎀 SYNOPSIS 🎀

#include <SDL3/SDL_surface.h>

bool SDL_ConvertPixelsAndColorspace(int width, int height, SDL_PixelFormat src_format, SDL_Colorspace src_colorspace, SDL_PropertiesID src_properties, const void *src, int src_pitch, SDL_PixelFormat dst_format, SDL_Colorspace dst_colorspace, SDL_PropertiesID dst_properties, void *dst, int dst_pitch);

look at that signature. it's long. it's dramatic. it's the main character 😌

---

💖 FUNCTION PARAMETERS 💖

• width — how wide the block you're copying is, in pixels. width rights, literally 💅
• height — how tall that block is, in pixels. yes queen, we're doing 2D 🌈
• src_format — an SDL_PixelFormat value describing the format of the src pixels. the vibe of the source pixels, if you will.
• src_colorspace — an SDL_Colorspace value describing the colorspace of the src pixels. so we know what color world they're living in 🦋
• src_properties — an SDL_PropertiesID with extra source color properties, or 0 if you got nothing to add (valid, we respect it).
• src — a pointer to the source pixels. the originals. the blueprint 👑
• src_pitch — the pitch of the source pixels, in bytes. slay, pitch, slay.
• dst_format — an SDL_PixelFormat value describing the format of the dst pixels. what they're gonna become.
• dst_colorspace — an SDL_Colorspace value describing the colorspace of the dst pixels. their new color universe ✨
• dst_properties — an SDL_PropertiesID with extra destination color properties, or 0 if it's giving minimal.
• dst — a pointer that gets filled in with the new pixel data. this is where the glow-up lands 💖
• dst_pitch — the pitch of the destination pixels, in bytes. consistent queen.

---

🦋 RETURN VALUE 🦋

Returns true on success or false on failure — and if it flops, call SDL_GetError() for more info, because it will tell you what went wrong. no secrets here, bestie 🔍

---

🔥 THREAD SAFETY 🔥

The same destination pixels should not be used from two threads at once. do not do it. that's a fight you will lose 💀

It is safe to use the same source pixels from multiple threads though, so go off, share the source, it's fine 🌸

---

⭐ AVAILABILITY ⭐

This function is available since SDL 3.2.0. periodt. don't come at it with an older version, it simply will not be there 🙈

---

💜 SEE ALSO 💜

• SDL_ConvertPixels(3)

---

ok that's the whole page, no notes. go convert some pixels and be iconic about it ✨

mwah 💋 — this page came to you from Simple Directmedia Layer, rockin' SDL 3.4.18, and the header on top was SDL_ConvertPi...AndColorspace(3). stay gorgeous, stay pitch-aligned 🫶