docs/man3/SDL_PumpEvents.3

   1 .TH "SDL_PumpEvents" "3" "Tue 11 Sep 2001, 22:59" "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, Tue 11 Sep 2001, 22:59