view docs/man3/SDL_PollEvent.3 @ 4440:7bb8f748a14d SDL-1.2

Fixed bug 978 Yann Leprince 2010-03-31 11:07:53 PDT Please add a #serial line as below to sdl.m4 and increase the serial number with each revision of this file. This allows using aclocal --install, thereby enabling automatic updating of sdl.m4 in SDL-based packages that distribute it. # serial 1 The complete documentation and rationale for #serial can be found in the Automake documentation: <http://www.gnu.org/software/automake/manual/html_node/Serials.html>.
author Sam Lantinga <slouken@libsdl.org>
date Fri, 23 Apr 2010 02:19:19 -0700
parents 1238da4a7112
children
line wrap: on
line source

.TH "SDL_PollEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" 
.SH "NAME"
SDL_PollEvent \- Polls for currently pending events\&.
.SH "SYNOPSIS"
.PP
\fB#include "SDL\&.h"
.sp
\fBint \fBSDL_PollEvent\fP\fR(\fBSDL_Event *event\fR);
.SH "DESCRIPTION"
.PP
Polls for currently pending events, and returns \fB1\fR if there are any pending events, or \fB0\fR if there are none available\&. 
.PP
If \fBevent\fR is not \fBNULL\fP, the next event is removed from the queue and stored in that area\&.
.SH "EXAMPLES"
.PP
.PP
.nf
\f(CWSDL_Event event; /* Event structure */

\&.
\&.
\&.
/* Check for events */
while(SDL_PollEvent(&event)){  /* Loop until there are no events left on the queue */
  switch(event\&.type){  /* Process the appropiate event type */
    case SDL_KEYDOWN:  /* Handle a KEYDOWN event */         
      printf("Oh! Key press
");
      break;
    case SDL_MOUSEMOTION:
      \&.
      \&.
      \&.
    default: /* Report an unhandled event */
      printf("I don\&'t know what this event is!
");
  }
}\fR
.fi
.PP
.SH "SEE ALSO"
.PP
\fI\fBSDL_Event\fR\fR, \fI\fBSDL_WaitEvent\fP\fR, \fI\fBSDL_PeepEvents\fP\fR
.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59