SDL_PushEvent

Name

SDL_PushEvent -- Pushes an event onto the event queue

Synopsis

#include "SDL.h"

int SDL_PushEvent(SDL_Event *event);

Description

The event queue can actually be used as a two way communication channel. Not only can events be read from the queue, but the user can also push their own events onto it. event is a pointer to the event structure you wish to push onto the queue. The event is copied into the queue, and the caller may dispose of the memory pointed to after SDL_PushEvent returns.

Note: Pushing device input events onto the queue doesn't modify the state of the device within SDL.

This function is thread safe, and can be called from other threads safely.

Return Value

Returns 0 on success or -1 if the event couldn't be pushed.

Examples