al_wait_for_event_timed(3alleg5)

💖 al_wait_for_event_timed 💖

okay bestie, so this is a page straight out of the Allegro 5 API — yes, the <pink>al_wait_for_event_timed(3alleg5)</pink> one, we been knew 💅

---

✨ NAME ✨

al_wait_for_event_timed — Allegro 5 API 🦋

---

🌸 SYNOPSIS 🌸

#include <allegro5/allegro.h>

bool al_wait_for_event_timed(ALLEGRO_EVENT_QUEUE *queue,
   ALLEGRO_EVENT *ret_event, float secs)

---

🎀 DESCRIPTION 🎀

so basically you're gonna wait until the event queue you passed in is not empty. that's the whole vibe. sitting there. patiently. like a good little main character 👑

now here's the tea about ret_event, and it's giving fork-in-the-road:

• if ret_event is not NULL, the first event in the queue gets copied into ret_event and then removed from the queue. it's gone, bestie, it left the group chat 😭
• if ret_event is NULL, that first event just stays right at the head of the queue. nobody touches it. it's still there, unbothered, living its truth ✨

and secs? that's your girl telling the function approximately how many seconds to hang around waiting. roughly. approximately. don't come for her about precision 💅

then the return value does a little vibe check:

• if the call times out → false comes back 🥲
• otherwise, if an event occurred → true comes back, slay 🎉

⚠️ okay important one, no cap: for compatibility with all platforms, secs must be 2,147,483.647 seconds or less. that's the ceiling. do not test it. do not try to be cute about it. 🫶

---

👀 SEE ALSO 👀

• ALLEGRO_EVENT(3alleg5)
• al_wait_for_event(3alleg5)
• al_wait_for_event_until(3alleg5)

---

and that's the whole page, periodt 🎀 this was the Allegro reference manual talking about al_wait_for_event_timed(3alleg5) — go forth and wait for your events, you icon 💖🦋✨