SDL_CompareAndSwapAtomicU32(3)

💖 SDL_CompareAndSwapAtomicU32 💖

okay bestie, so this is a page from the SDL3 FUNCTIONS manual, and we're talking about SDL_CompareAndSwapAtomicU32 — the little compare-and-swap diva of the atomic world. 🦋

---

✨ NAME ✨

SDL_CompareAndSwapAtomicU32 — set an atomic variable to a new value if it is currently an old value.

like, the glow-up only happens if the vibe check passes first 💅

---

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_atomic.h>

bool SDL_CompareAndSwapAtomicU32(SDL_AtomicU32 *a, Uint32 oldval, Uint32 newval);

---

👑 DESCRIPTION 👑

Note: If you don't know what this function is for, you shouldn't use it!

fr fr, that's not me being mean, that's literally in the manual 😭 this is a low-level little creature and it does not play about correctness. if you're reading this like "hmm what does this even do tho" — step away from the keyboard, bestie, this one isn't for you yet. no cap.

---

🎀 FUNCTION PARAMETERS 🎀

• a — a pointer to an SDL_AtomicU32 variable to be modified. this is the main character getting the makeover ✨
• oldval — the old value. the before pic 📸
• newval — the new value. the after pic 💖

---

⭐ RETURN VALUE ⭐

Returns true if the atomic variable was set, false otherwise.

so basically: true = slay, we swapped it. false = nope, the value wasn't what you said it was, no swap happened, we move on 🫶

---

🧚 THREAD SAFETY 🧚

It is safe to call this function from any thread.

every thread can pull up, it's giving inclusive 💜 no drama, no fighting over the variable, that's the whole point of an atomic iykyk

---

🌈 AVAILABILITY 🌈

This function is available since SDL 3.2.0. if your SDL is older than that, it's simply not gonna show up, and that's that 💀

---

🍓 SEE ALSO 🍓

• SDL_GetAtomicU32(3)
• SDL_SetAtomicU32(3)

the whole atomic squad, go read them too, they're all iconic 👑

---

Simple Directmedia Layer · SDL 3.4.18 — that's the source and the version, mwah, and that's the whole page bestie, thanks for reading, go write some thread-safe code and slay 🎀✨💅