1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
|
.TH "al_wait_for_event_timed" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_wait_for_event_timed \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>
bool\ al_wait_for_event_timed(ALLEGRO_EVENT_QUEUE\ *queue,
\ \ \ ALLEGRO_EVENT\ *ret_event,\ float\ secs)
\f[]
.fi
.SH DESCRIPTION
.PP
Wait until the event queue specified is non\-empty.
If \f[C]ret_event\f[] is not NULL, the first event in the queue will be
copied into \f[C]ret_event\f[] and removed from the queue.
If \f[C]ret_event\f[] is NULL the first event is left at the head of the
queue.
.PP
\f[C]secs\f[] determines approximately how many seconds to wait.
If the call times out, false is returned.
Otherwise, if an event ocurred, true is returned.
.PP
For compatibility with all platforms, \f[C]secs\f[] must be
2,147,483.647 seconds or less.
.SH SEE ALSO
.PP
ALLEGRO_EVENT(3), al_wait_for_event(3), al_wait_for_event_until(3)
|
