diff docs/man3/SDL_PumpEvents.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_PumpEvents.3	Thu Apr 26 16:45:43 2001 +0000
@@ -0,0 +1,23 @@
+.TH "SDL_PumpEvents" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" 
+.SH "NAME"
+SDL_PumpEvents\- Pumps the event loop, gathering events from the input devices\&.
+.SH "SYNOPSIS"
+.PP
+\fB#include "SDL\&.h"
+.sp
+\fBvoid \fBSDL_PumpEvents\fP\fR(\fBvoid\fR);
+.SH "DESCRIPTION"
+.PP
+Pumps the event loop, gathering events from the input devices\&.
+.PP
+\fBSDL_PumpEvents\fP gathers all the pending input information from devices and places it on the event queue\&. Without calls to \fBSDL_PumpEvents\fP no events would ever be placed on the queue\&. Often calls the need for \fBSDL_PumpEvents\fP is hidden from the user since \fI\fBSDL_PollEvent\fP\fR and \fI\fBSDL_WaitEvent\fP\fR implicitly call \fBSDL_PumpEvents\fP\&. However, if you are not polling or waiting for events (e\&.g\&. your filtering them), then you must call \fBSDL_PumpEvents\fP to force an event queue update\&.
+.PP
+.RS
+\fBNote:  
+.PP
+You can only call this function in the thread that set the video mode\&.
+.RE
+.SH "SEE ALSO"
+.PP
+\fI\fBSDL_PollEvent\fP\fR
+...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03