Wiki Page Content

SDL_PollEvent

Use this function to poll for currently pending events.

Syntax

int SDL_PollEvent(SDL_Event* event)

Function Parameters

event

the SDL_Event structure to be filled with the next event from the queue, or NULL

Return Value

Returns 1 if there is a pending event or 0 if there are none available.

Code Examples

while (1) {
    SDL_Event event;
    while (SDL_PollEvent(&event)) {
         // handle your event here
    }
    // do some other stuff here -- draw your app, etc.
}

Remarks

If event is not NULL, the next event is removed from the queue and stored in the SDL_Event structure pointed to by event.

As this function implicitly calls SDL_PumpEvents(), you can only call this function in the thread that set the video mode.

SDL_PollEvent() is the favored way of receiving system events since it can be done from the main loop and does not suspend the main loop while waiting on an event to be posted.


CategoryAPI, CategoryEvents

None: SDL_PollEvent (last edited 2013-08-08 22:58:45 by RyanGordon)

Feedback
Please include your contact information if you'd like to receive a reply.
Submit