Scroll to navigation

SDL_PumpEvents(3) SDL3 FUNCTIONS SDL_PumpEvents(3)

NAME

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

SYNOPSIS

#include "SDL3/SDL.h"
void SDL_PumpEvents(void);

DESCRIPTION

This function updates the event queue and internal input device state. WARNING : This should only be run in the thread that initialized the video subsystem, and for extra safety, you should consider only doing those things on the main thread in any case.

SDL_PumpEvents () gathers all the pending input information from devices and places it in the event queue. Without calls to

SDL_PumpEvents () no events would ever be placed on the queue. Often the need for calls to 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. you are filtering them), then you must call

SDL_PumpEvents () to force an event queue update.

AVAILABILITY

This function is available since SDL 3.0.0.

SEE ALSO

SDL_PollEvent(3), SDL_WaitEvent(3)

SDL 3.1.0 SDL