SDL_RunOnMainThread(3)

💖 SDL_RunOnMainThread(3) 💖

okay bestie, this one lives in the SDL3 FUNCTIONS section of the manual and it's genuinely so useful, come sit with me 🫶

---

✨ NAME ✨

SDL_RunOnMainThread — call a function on the main thread during event processing. that's the whole vibe. 🎀

---

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_init.h>

bool SDL_RunOnMainThread(SDL_MainThreadCallback callback, void *userdata, bool wait_complete);

---

💅 DESCRIPTION 💅

okay so here's the tea, and it's actually really simple:

• if you call this on the main thread, the callback runs immediately. like, right now, no queue, no waiting, just go 🏃♀️
• if you call this on another thread, the callback gets queued for execution on the main thread during event processing. so it'll happen, just on the main thread's schedule, not yours ✨

⚠️ be careful of deadlocks when you use this, fr fr. you should not have the main thread wait for the current thread while this function is being called with wait_complete set to true. that's a deadlock recipe and we do NOT do that in this house 💀

---

🌈 FUNCTION PARAMETERS 🌈

• callback — the callback to call on the main thread. this is the thing you want to happen, main-character edition 👑
• userdata — a pointer that is passed to callback. your lil goodie bag of stuff 🎁
• wait_complete — true to wait for the callback to complete, false to return immediately. blocking mode or girlboss mode, your call 💅

---

⭐ RETURN VALUE ⭐

returns true on success or false on failure — and bestie, if it fails, call SDL_GetError() for more information. she will tell you what went wrong, no cap 🔍

---

🦋 THREAD SAFETY 🦋

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

---

🧚 AVAILABILITY 🧚

this function is available since SDL 3.2.0. so if you're on something older... upgrade, babe 💜

---

🔥 SEE ALSO 🔥

• SDL_IsMainThread(3)

---

Simple Directmedia Layer 🫶 SDL 3.4.18 — that's the source and version right there, mwah, hope this helped bestie, go slay your main thread ✨💖🎀