al_wait_for_event_until(3)

okay so bestie, this is al_wait_for_event_until(3) from the Library Functions Manual — the Allegro 5 API page for waiting on an event queue until a timeout says stop. it's giving “waiting but make it timed” energy ✨

💖 NAME 💖

al_wait_for_event_until — Allegro 5 API. that's the whole name line, no cap 🫶

✨ SYNOPSIS ✨

#include <allegro5/allegro.h>

bool al_wait_for_event_until(ALLEGRO_EVENT_QUEUE *queue,
   ALLEGRO_EVENT *ret_event, ALLEGRO_TIMEOUT *timeout)

🌸 DESCRIPTION 🌸

okay so here's the vibe: this function waits until the event queue you passed in is non-empty. if ret_event is not NULL, the first event in the queue gets copied into ret_event and removed from the queue. periodt. 💅

if ret_event is NULL, the first event is left at the head of the queue — it does not get removed, bestie. it stays right there at the front. 🫶

timeout determines how long to wait. if the call times out, false is returned. otherwise, if an event ocurred, true is returned. that's the whole return-value situation, fr fr. 😭

for compatibility with all platforms, timeout must be 2,147,483.647 seconds or less. that's the rule, so don't try to be cute with a bigger number 💀

---

🦋 SEE ALSO 🦋

go check out these iconique related pages:

• ALLEGRO_EVENT(3)
• ALLEGRO_TIMEOUT(3)
• al_init_timeout(3)
• al_wait_for_event(3)
• al_wait_for_event_timed(3)

---

source/version: Allegro reference manual ✨ page: al_wait_for_event_until(3) 🎀 date: the footer didn't give me one, so we're keeping it mysterious — love that for us 💜