al_wait_for_event_timed(3)

💖 NAME 💖

okay so bestie, welcome to al_wait_for_event_timed(3) — it's straight outta the Library Functions Manual and it's the Allegro 5 API. that's the name sitch, periodt.

---

🌸 SYNOPSIS 🌸

#include <allegro5/allegro.h>

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

---

✨ DESCRIPTION ✨

So al_wait_for_event_timed waits until the event queue you specified is non-empty. That's the whole mission, no cap.

Now the ret_event tea: if ret_event is not NULL, the first event in the queue gets copied into ret_event and removed from the queue. If ret_event is NULL, the first event is left at the head of the queue. literally left there, untouched, main character energy.

secs determines approximately how many seconds to wait. If the call times out, false is returned. Otherwise, if an event occurred, true is returned. yes bestie, that's a bool and it's giving success/failure realness.

for compatibility with all platforms, secs must be 2,147,483.647 seconds or less. that's the compatibility ceiling, fr fr — don't get cute with a bigger number.

---

🦋 SEE ALSO 🦋

• ALLEGRO_EVENT(3) — the event type situation
• al_wait_for_event(3) — the non-timed waiting bestie
• al_wait_for_event_until(3) — the wait-until-a-deadline bestie

---

xoxo, source/version: the Allegro reference manual (no separate version listed) 🫶 page: al_wait_for_event_timed(3) — date: none printed on this one, just pure documentation energy, mwah 💋