comparison 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
comparison
equal deleted inserted replaced
-1:000000000000 0:74212992fb08
1 .TH "SDL_PumpEvents" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference"
2 .SH "NAME"
3 SDL_PumpEvents\- Pumps the event loop, gathering events from the input devices\&.
4 .SH "SYNOPSIS"
5 .PP
6 \fB#include "SDL\&.h"
7 .sp
8 \fBvoid \fBSDL_PumpEvents\fP\fR(\fBvoid\fR);
9 .SH "DESCRIPTION"
10 .PP
11 Pumps the event loop, gathering events from the input devices\&.
12 .PP
13 \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\&.
14 .PP
15 .RS
16 \fBNote:
17 .PP
18 You can only call this function in the thread that set the video mode\&.
19 .RE
20 .SH "SEE ALSO"
21 .PP
22 \fI\fBSDL_PollEvent\fP\fR
23 ...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03