SDL_ConvertPixels(3)

💖 SDL_ConvertPixels(3) 💖

okay so bestie, welcome to the SDL3 FUNCTIONS corner of the manual, and today's main character is SDL_ConvertPixels 💅

---

✨ NAME ✨

SDL_ConvertPixels — copy a block of pixels of one format to another format. literally just glow-up-ing your pixels into a different format, no cap 🦋

---

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_surface.h>

bool SDL_ConvertPixels(int width, int height, SDL_PixelFormat src_format, const void *src, int src_pitch, SDL_PixelFormat dst_format, void *dst, int dst_pitch);

---

🎀 FUNCTION PARAMETERS 🎀

• width — the width of the block you're copying, in pixels. yes queen, measured in pixels, not bytes, don't get it twisted 🙈
• height — the height of the block to copy, in pixels. also pixels. we stay consistent 💅
• src_format — an SDL_PixelFormat value describing what format the src pixels are in. iykyk 🧚
• src — a pointer to the source pixels. the originals, the before pic 💖
• src_pitch — the pitch of the source pixels, in bytes. (pitch = how many bytes per row, bestie, it's giving row stride energy)
• dst_format — an SDL_PixelFormat value describing what format the dst pixels should be. the after pic ✨
• dst — a pointer to be filled in with new pixel data. this is where the glow-up lands 🫶
• dst_pitch — the pitch of the destination pixels, in bytes. again: bytes, not pixels, ok? 😭

---

🔥 RETURN VALUE 🔥

Returns true on success or false on failure — and if it's giving false, call SDL_GetError() for more information. she will tell you what went wrong, fr fr 💀

---

👑 THREAD SAFETY 👑

The same destination pixels should not be used from two threads at once.

but listen — it is safe to use the same source pixels from multiple threads. so many readers, exactly one writer. that's the vibe check 🌈

---

⭐ AVAILABILITY ⭐

This function is available since SDL 3.2.0. iconic behaviour, truly 👑

---

🦋 SEE ALSO 🦋

• SDL_ConvertPixelsAndColorspace(3) — the cousin who also handles colorspace, go say hi 💜

---

and that's the whole page bestie, you ate 💅✨

this lil gem comes to you from the Simple Directmedia Layer, version SDL 3.4.18, and it's the SDL_ConvertPixels(3) page — mwah, take care of her 🎀💖