view docs/man3/SDL_PollEvent.3 @ 1790:828a17e05192

Date: Mon, 8 May 2006 14:19:30 -0700 From: Bob Ippolito Subject: SDL trunk (r2346) and Mac OS X The current state of the trunk doesn't quite compile on Mac OS X, I've attached a series of patches that gets it to compile and kills a few warnings. sdl-trunk-r2346-dlcompat-warnings.diff: The dlcompat thing is just loaded with incorrect type signatures .. some of them have changed since 10.2 and others are just flat wrong. This puts it in sync with the latest headers. People on 10.2 will get the warnings instead of people with new kits.
author Sam Lantinga <slouken@libsdl.org>
date Tue, 09 May 2006 07:26:58 +0000 (2006-05-09)
parents e5bc29de3f0a
children 546f7c1eb755
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