|
0
|
1 .TH "SDL_PollEvent" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference"
|
|
|
2 .SH "NAME"
|
|
|
3 SDL_PollEvent\- Polls for currently pending events\&.
|
|
|
4 .SH "SYNOPSIS"
|
|
|
5 .PP
|
|
|
6 \fB#include "SDL\&.h"
|
|
|
7 .sp
|
|
|
8 \fBint \fBSDL_PollEvent\fP\fR(\fBSDL_Event *event\fR);
|
|
|
9 .SH "DESCRIPTION"
|
|
|
10 .PP
|
|
|
11 Polls for currently pending events, and returns \fB1\fR if there are any pending events, or \fB0\fR if there are none available\&.
|
|
|
12 .PP
|
|
|
13 If \fBevent\fR is not \fBNULL\fP, the next event is removed from the queue and stored in that area\&.
|
|
|
14 .SH "EXAMPLES"
|
|
|
15 .PP
|
|
|
16 .PP
|
|
|
17 .nf
|
|
|
18 \f(CWSDL_Event event; /* Event structure */
|
|
|
19
|
|
|
20 \&.
|
|
|
21 \&.
|
|
|
22 \&.
|
|
|
23 /* Check for events */
|
|
|
24 while(SDL_PollEvent(&event)){ /* Loop until there are no events left on the queue */
|
|
|
25 switch(event\&.type){ /* Process the appropiate event type */
|
|
|
26 case SDL_KEYDOWN: /* Handle a KEYDOWN event */
|
|
|
27 printf("Oh! Key press
|
|
|
28 ");
|
|
|
29 break;
|
|
|
30 case SDL_MOUSEMOTION:
|
|
|
31 \&.
|
|
|
32 \&.
|
|
|
33 \&.
|
|
|
34 default: /* Report an unhandled event */
|
|
|
35 printf("I don\&'t know what this event is!
|
|
|
36 ");
|
|
|
37 }
|
|
|
38 }\fR
|
|
|
39 .fi
|
|
|
40 .PP
|
|
|
41 .SH "SEE ALSO"
|
|
|
42 .PP
|
|
|
43 \fI\fBSDL_Event\fR\fR, \fI\fBSDL_WaitEvent\fP\fR, \fI\fBSDL_PeepEvents\fP\fR
|
|
|
44 ...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03
|
