docs/man3/SDL_PollEvent.3
author Sam Lantinga <slouken@libsdl.org>
Wed, 08 Mar 2006 18:30:12 +0000
changeset 1486 9d77fc9d0ace
parent 181 e5bc29de3f0a
child 2283 546f7c1eb755
permissions -rw-r--r--
Re-added C runtime support for Visual C++ 5,6
slouken@181
     1
.TH "SDL_PollEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" 
slouken@0
     2
.SH "NAME"
slouken@0
     3
SDL_PollEvent\- Polls for currently pending events\&.
slouken@0
     4
.SH "SYNOPSIS"
slouken@0
     5
.PP
slouken@0
     6
\fB#include "SDL\&.h"
slouken@0
     7
.sp
slouken@0
     8
\fBint \fBSDL_PollEvent\fP\fR(\fBSDL_Event *event\fR);
slouken@0
     9
.SH "DESCRIPTION"
slouken@0
    10
.PP
slouken@0
    11
Polls for currently pending events, and returns \fB1\fR if there are any pending events, or \fB0\fR if there are none available\&. 
slouken@0
    12
.PP
slouken@0
    13
If \fBevent\fR is not \fBNULL\fP, the next event is removed from the queue and stored in that area\&.
slouken@0
    14
.SH "EXAMPLES"
slouken@0
    15
.PP
slouken@0
    16
.PP
slouken@0
    17
.nf
slouken@0
    18
\f(CWSDL_Event event; /* Event structure */
slouken@0
    19
slouken@0
    20
\&.
slouken@0
    21
\&.
slouken@0
    22
\&.
slouken@0
    23
/* Check for events */
slouken@0
    24
while(SDL_PollEvent(&event)){  /* Loop until there are no events left on the queue */
slouken@0
    25
  switch(event\&.type){  /* Process the appropiate event type */
slouken@0
    26
    case SDL_KEYDOWN:  /* Handle a KEYDOWN event */         
slouken@0
    27
      printf("Oh! Key press
slouken@0
    28
");
slouken@0
    29
      break;
slouken@0
    30
    case SDL_MOUSEMOTION:
slouken@0
    31
      \&.
slouken@0
    32
      \&.
slouken@0
    33
      \&.
slouken@0
    34
    default: /* Report an unhandled event */
slouken@0
    35
      printf("I don\&'t know what this event is!
slouken@0
    36
");
slouken@0
    37
  }
slouken@0
    38
}\fR
slouken@0
    39
.fi
slouken@0
    40
.PP
slouken@0
    41
.SH "SEE ALSO"
slouken@0
    42
.PP
slouken@0
    43
\fI\fBSDL_Event\fR\fR, \fI\fBSDL_WaitEvent\fP\fR, \fI\fBSDL_PeepEvents\fP\fR
slouken@181
    44
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59