Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

SDL_PumpEvents (3)

Name

SDL_PumpEvents - Pumps the event loop, gathering events from the input devices.

Synopsis

#include "SDL.h"

void SDL_PumpEvents(void);

Description

SDL_PumpEvents(3)              SDL API Reference             SDL_PumpEvents(3)



NAME
       SDL_PumpEvents  - Pumps the event loop, gathering events from the input
       devices.

SYNOPSIS
       #include "SDL.h"

       void SDL_PumpEvents(void);

DESCRIPTION
       Pumps the event loop, gathering events from the input devices.

       SDL_PumpEvents gathers all the pending input information  from  devices
       and  places  it  on the event queue. Without calls to SDL_PumpEvents no
       events would ever be placed on the queue.  Often  calls  the  need  for
       SDL_PumpEvents   is  hidden  from  the  user  since  SDL_PollEvent  and
       SDL_WaitEvent implicitly call SDL_PumpEvents. However, if you  are  not
       polling or waiting for events (e.g. your filtering them), then you must
       call SDL_PumpEvents to force an event queue update.

              Note:

              You can only call this function in the thread that set the video
              mode.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/sdl      |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+
SEE ALSO
       SDL_PollEvent



NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source        was        downloaded        from        https://www.lib-
       sdl.org/release/SDL-1.2.15.tar.gz

       Further information about this software can be found on the open source
       community website at https://www.libsdl.org/.



SDL                         Tue 11 Sep 2001, 22:59           SDL_PumpEvents(3)