SDL_CreateMutex(3)

💖 SDL_CreateMutex(3) — SDL3 FUNCTIONS 💖

okay bestie, welcome to the SDL3 FUNCTIONS section of the manual, and today's main character is SDL_CreateMutex 🎀

---

✨ NAME ✨

SDL_CreateMutex — Create a new mutex. that's it, that's the vibe 💅

---

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_mutex.h>

SDL_Mutex * SDL_CreateMutex(void);

like, you include the header, you call the function, no arguments, we love a no-argument icon 👑

---

🦋 DESCRIPTION 🦋

okay so when you make a mutex, it starts off in the _unlocked_ state. brand new, unlocked, fresh out the box, no cap ✨

and here's the tea: when you call SDL_LockMutex(), it will NOT return while that mutex is locked by another thread. it just sits there. waiting. patient. main character energy fr fr 😭 if you don't wanna block like that, go look at SDL_TryLockMutex() instead — that one attempts to lock without blocking 🫶

also important: SDL mutexes are reentrant. yes bestie, reentrant. iykyk 💚

---

🌈 RETURN VALUE 🌈

it returns the initialized and unlocked mutex, or NULL on failure 😭 and if you get NULL, call SDL_GetError() for more information. always check, bestie, always check 💀

---

🔥 THREAD SAFETY 🔥

it is safe to call this function from any thread. any thread. all the threads. slay 👑

---

⭐ AVAILABILITY ⭐

this function is available since SDL 3.2.0. periodt 💅

---

💜 SEE ALSO 💜

• SDL_DestroyMutex(3)
• SDL_LockMutex(3)
• SDL_TryLockMutex(3)
• SDL_UnlockMutex(3)

go read those too, they're literally the rest of the story 🎀

---

and that's a wrap, bestie!! this page is brought to you by Simple Directmedia Layer, SDL 3.4.18, and it's giving SDL_CreateMutex(3) energy 🦋✨ mwah, ily, go lock something 💖