SDL_CopyProperties(3)

💖 SDL_CopyProperties 💖

okay bestie, welcome to the SDL3 FUNCTIONS corner of the manual, where today's main character is SDL_CopyProperties(3). she copies properties. she's literally so good at it. let's get into it 🫶

---

✨ NAME ✨

SDL_CopyProperties — copy a group of properties. that's it. that's the whole job. no cap. 💅

---

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_properties.h>

bool SDL_CopyProperties(SDL_PropertiesID src, SDL_PropertiesID dst);

look at her. two args. returns a bool. iconic. 🎀

---

🦋 DESCRIPTION 🦋

so here's the tea, bestie: this function copies all the properties from one group of properties to another. every single one. she's thorough.

BUT — and this is the plot twist — properties that require cleanup are not copied. those are the ones you set with SDL_SetPointerPropertyWithCleanup(), and they get left behind. no forwarding address. just gone. 💀

also important: any property that already exists on dst will be overwritten. so like, if dst had something cute going on, src is walking in and redecorating. respectfully? maybe not. but that's the vibe. 🙈

---

🎯 FUNCTION PARAMETERS 🎯

• src — the properties to copy. she's the giver, the source material, the blueprint. ✨
• dst — the destination properties. she's receiving. she's the one getting a whole makeover. 💖

---

⭐ RETURN VALUE ⭐

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

---

🔥 THREAD SAFETY 🔥

it is safe to call this function from any thread. periodt. 🫶

and the way that she does it? this function acquires simultaneous mutex locks on both the source and destination property sets. both of them. at the same time. she's holding two things and she's not dropping either one. queen behavior. 👑

---

🌈 AVAILABILITY 🌈

this function is available since SDL 3.2.0. so if you're on anything older, bestie... it's not giving. upgrade. 💜

---

🍓 sign-off 🍓

that's the whole page, no notes. brought to you by Simple Directmedia Layer, version SDL 3.4.18 — go forth and copy those properties, you absolute legend. mwah. 💅✨🧚