SDL_WaitEvent(3)

💤 SDL_WaitEvent(3) 💤

okay bestie, we're in the SDL3 FUNCTIONS section of the manual and this one is literally just "chill until something happens" ✨

---

✨ NAME ✨

SDL_WaitEvent — wait indefinitely for the next available event. like, no timer, no vibes check, just vibes. you sit there. you wait. 🫶

---

✨ SYNOPSIS ✨

#include <SDL3/SDL_events.h>

bool SDL_WaitEvent(SDL_Event *event);

---

✨ DESCRIPTION ✨

okay so here's the tea ☕ — if event is not NULL, the next event gets removed from the queue and stored in the SDL_Event structure pointed to by event. it's giving "gimme the next one, I'll hold it" 💅

⚠️ important bestie!! because this function may implicitly call SDL_PumpEvents(), you can only call this function in the thread that initialized the video subsystem. do not try to be cute and call it from some random thread. that's not the move. 🚫🧵

---

✨ FUNCTION PARAMETERS ✨

• event — the SDL_Event structure to be filled in with the next event from the queue, or NULL. that's it. that's the whole parameter. simple queen behaviour 👑

---

✨ RETURN VALUE ✨

• returns true on success 🎉
• returns false if there was an error while waiting for events 😭

if you get false, call SDL_GetError() for more information — she will tell you what went wrong, fr fr.

---

✨ THREAD SAFETY ✨

this function should only be called on the main thread. periodt. 💅

---

✨ AVAILABILITY ✨

this function is available since SDL 3.2.0. so if you're on anything older, no she's not there yet, sorry babe 🎀

---

✨ SEE ALSO ✨

• SDL_PollEvent(3) — for when you simply cannot commit to waiting
• SDL_PushEvent(3) — for when you're the one making events happen
• SDL_WaitEventTimeout(3) — waiting but with a deadline, main character with boundaries energy ⏰

---

and that's the whole page bestie!! this one came to you from Simple Directmedia Layer, running SDL 3.4.18 — go forth and wait for events responsibly, mwah 💖🦋🌸