diff docs/man3/SDL_PollEvent.3 @ 0:74212992fb08

Initial revision
author Sam Lantinga <slouken@lokigames.com>
date Thu, 26 Apr 2001 16:45:43 +0000
parents
children 55f1f1b3e27d
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/man3/SDL_PollEvent.3	Thu Apr 26 16:45:43 2001 +0000
@@ -0,0 +1,44 @@
+.TH "SDL_PollEvent" "3" "Mon 12 Mar 2001, 01:03" "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, Mon 12 Mar 2001, 01:03