SDL_events.c File Reference
`#include "../SDL_internal.h"`
`#include "SDL.h"`
`#include "SDL_events.h"`
`#include "SDL_syswm.h"`
`#include "SDL_thread.h"`
`#include "SDL_events_c.h"`
`#include "../timer/SDL_timer_c.h"`
`#include "../joystick/SDL_joystick_c.h"`
`#include "../video/SDL_sysvideo.h"`
Include dependency graph for SDL_events.c:

Go to the source code of this file.

## Data Structures

struct | SDL_EventWatcher
struct | SDL_DisabledEventBlock
struct | SDL_EventEntry
struct | SDL_SysWMEntry

## Macros

#define | SDL_MAX_QUEUED_EVENTS 65535

## Functions

void | SDL_StopEventLoop (void)
int | SDL_StartEventLoop (void)
static int | SDL_AddEvent (SDL_Event *event)
static void | SDL_CutEvent (SDL_EventEntry *entry)
int | SDL_PeepEvents (SDL_Event *events, int numevents, SDL_eventaction action, Uint32 minType, Uint32 maxType)
SDL_bool | SDL_HasEvent (Uint32 type)
SDL_bool | SDL_HasEvents (Uint32 minType, Uint32 maxType)
void | SDL_FlushEvent (Uint32 type)
void | SDL_FlushEvents (Uint32 minType, Uint32 maxType)
void | SDL_PumpEvents (void)
int | SDL_PollEvent (SDL_Event *event)
| Polls for currently pending events. More...
int | SDL_WaitEvent (SDL_Event *event)
| Waits indefinitely for the next available event. More...
int | SDL_WaitEventTimeout (SDL_Event *event, int timeout)
| Waits until the specified timeout (in milliseconds) for the next available event. More...
int | SDL_PushEvent (SDL_Event *event)
| Add an event to the event queue. More...
void | SDL_SetEventFilter (SDL_EventFilter filter, void *userdata)
SDL_bool | SDL_GetEventFilter (SDL_EventFilter *filter, void **userdata)
void | SDL_AddEventWatch (SDL_EventFilter filter, void *userdata)
void | SDL_DelEventWatch (SDL_EventFilter filter, void *userdata)
void | SDL_FilterEvents (SDL_EventFilter filter, void *userdata)
Uint8 | SDL_EventState (Uint32 type, int state)
Uint32 | SDL_RegisterEvents (int numevents)
int | SDL_SendAppEvent (SDL_EventType eventType)
int | SDL_SendSysWMEvent (SDL_SysWMmsg *message)
int | SDL_SendKeymapChangedEvent (void)

## Variables

SDL_EventFilter | SDL_EventOK = NULL
void * | SDL_EventOKParam
static SDL_EventWatcher * | SDL_event_watchers = NULL
static SDL_DisabledEventBlock * | SDL_disabled_events [256]
static Uint32 | SDL_userevents = SDL_USEREVENT
struct {
SDL_mutex * lock
volatile SDL_bool active
volatile int count
volatile int max_events_seen
SDL_EventEntry * head
SDL_EventEntry * tail
SDL_EventEntry * free
SDL_SysWMEntry * wmmsg_used
SDL_SysWMEntry * wmmsg_free
} | SDL_EventQ = { NULL, SDL_TRUE, 0, 0, NULL, NULL, NULL, NULL, NULL }

## Macro Definition Documentation

#define SDL_MAX_QUEUED_EVENTS 65535

Definition at line 37 of file SDL_events.c.

Referenced by SDL_AddEvent().

## Function Documentation

static int SDL_AddEvent | ( | SDL_Event * | event | ) |

static

Definition at line 191 of file SDL_events.c.

References SDL_EventEntry::event, SDL_EventEntry::msg, SDL_SysWMmsg::msg, SDL_SysWMEvent::msg, SDL_EventEntry::next, NULL, SDL_EventEntry::prev, SDL_assert, SDL_EventQ, SDL_malloc, SDL_MAX_QUEUED_EVENTS, SDL_SetError, SDL_SYSWMEVENT, SDL_Event::syswm, and SDL_Event::type.

Referenced by SDL_PeepEvents().

{
SDL_EventEntry *entry;
if (SDL_EventQ.count >= SDL_MAX_QUEUED_EVENTS) {
SDL_SetError("Event queue is full (%d events)", SDL_EventQ.count);
return 0;
}
if (SDL_EventQ.free == NULL) {
entry = (SDL_EventEntry *)SDL_malloc(sizeof(*entry));
if (!entry) {
return 0;
}
} else {
entry = SDL_EventQ.free;
SDL_EventQ.free = entry->next;
}
entry->event = *event;
if (event->type == SDL_SYSWMEVENT) {
entry->msg = *event->syswm.msg;
entry->event.syswm.msg = &entry->msg;
}
if (SDL_EventQ.tail) {
SDL_EventQ.tail->next = entry;
entry->prev = SDL_EventQ.tail;
SDL_EventQ.tail = entry;
entry->next = NULL;
} else {
SDL_assert(!SDL_EventQ.head);
SDL_EventQ.head = entry;
SDL_EventQ.tail = entry;
entry->prev = NULL;
entry->next = NULL;
}
++SDL_EventQ.count;
if (SDL_EventQ.count > SDL_EventQ.max_events_seen) {
SDL_EventQ.max_events_seen = SDL_EventQ.count;
}
return 1;
}
SDL_EventEntry::next
struct _SDL_EventEntry * next
Definition: SDL_events.c:64
SDL_SysWMEvent::msg
SDL_SysWMmsg * msg
Definition: SDL_events.h:515
SDL_SYSWMEVENT
Definition: SDL_events.h:90
SDL_MAX_QUEUED_EVENTS
#define SDL_MAX_QUEUED_EVENTS
Definition: SDL_events.c:37
SDL_EventEntry::event
SDL_Event event
Definition: SDL_events.c:61
SDL_SysWMmsg::msg
union SDL_SysWMmsg::@16 msg
SDL_EventQ
static struct @22 SDL_EventQ
event
struct _cl_event * event
Definition: SDL_opengl_glext.h:2649
SDL_EventEntry
Definition: SDL_events.c:59
SDL_assert
#define SDL_assert(condition)
Definition: SDL_assert.h:167
NULL
#define NULL
Definition: begin_code.h:143
SDL_SetError
#define SDL_SetError
Definition: SDL_dynapi_overrides.h:36
SDL_Event::syswm
SDL_SysWMEvent syswm
Definition: SDL_events.h:543
SDL_EventEntry::prev
struct _SDL_EventEntry * prev
Definition: SDL_events.c:63
SDL_malloc
#define SDL_malloc
Definition: SDL_dynapi_overrides.h:380
SDL_Event::type
Uint32 type
Definition: SDL_events.h:523
SDL_EventEntry::msg
SDL_SysWMmsg msg
Definition: SDL_events.c:62

void SDL_AddEventWatch | ( | SDL_EventFilter | filter,
|  | void * | userdata
| ) |  |

Add a function which is called when an event is added to the queue.

Definition at line 505 of file SDL_events.c.

References SDL_EventWatcher::callback, SDL_EventWatcher::next, NULL, SDL_malloc, tail, and SDL_EventWatcher::userdata.

{
SDL_EventWatcher *watcher, *tail;
watcher = (SDL_EventWatcher *)SDL_malloc(sizeof(*watcher));
if (!watcher) {
/* Uh oh... */
return;
}
/* create the watcher */
watcher->callback = filter;
watcher->userdata = userdata;
watcher->next = NULL;
/* add the watcher to the end of the list */
if (SDL_event_watchers) {
for (tail = SDL_event_watchers; tail->next; tail = tail->next) {
continue;
}
tail->next = watcher;
} else {
SDL_event_watchers = watcher;
}
}
SDL_event_watchers
static SDL_EventWatcher * SDL_event_watchers
Definition: SDL_events.c:49
SDL_EventWatcher::callback
SDL_EventFilter callback
Definition: SDL_events.c:44
SDL_EventWatcher::next
struct SDL_EventWatcher * next
Definition: SDL_events.c:46
NULL
#define NULL
Definition: begin_code.h:143
tail
SDL_EventEntry * tail
Definition: SDL_events.c:80
SDL_malloc
#define SDL_malloc
Definition: SDL_dynapi_overrides.h:380
SDL_EventWatcher::userdata
void * userdata
Definition: SDL_events.c:45
SDL_EventWatcher
Definition: SDL_events.c:43
filter
GLint GLint GLint GLint GLint GLint GLint GLbitfield GLenum filter
Definition: SDL_opengl_glext.h:1184

static void SDL_CutEvent | ( | SDL_EventEntry * | entry | ) |

static

Definition at line 239 of file SDL_events.c.

References SDL_EventEntry::next, NULL, SDL_EventEntry::prev, SDL_assert, and SDL_EventQ.

Referenced by SDL_FilterEvents(), SDL_FlushEvents(), and SDL_PeepEvents().

{
if (entry->prev) {
entry->prev->next = entry->next;
}
if (entry->next) {
entry->next->prev = entry->prev;
}
if (entry == SDL_EventQ.head) {
SDL_assert(entry->prev == NULL);
SDL_EventQ.head = entry->next;
}
if (entry == SDL_EventQ.tail) {
SDL_assert(entry->next == NULL);
SDL_EventQ.tail = entry->prev;
}
entry->next = SDL_EventQ.free;
SDL_EventQ.free = entry;
SDL_assert(SDL_EventQ.count > 0);
--SDL_EventQ.count;
}
SDL_EventEntry::next
struct _SDL_EventEntry * next
Definition: SDL_events.c:64
SDL_EventQ
static struct @22 SDL_EventQ
SDL_assert
#define SDL_assert(condition)
Definition: SDL_assert.h:167
NULL
#define NULL
Definition: begin_code.h:143
SDL_EventEntry::prev
struct _SDL_EventEntry * prev
Definition: SDL_events.c:63

void SDL_DelEventWatch | ( | SDL_EventFilter | filter,
|  | void * | userdata
| ) |  |

Remove an event watch function added with SDL_AddEventWatch()

Definition at line 533 of file SDL_events.c.

References SDL_EventWatcher::next, NULL, and SDL_free().

{
SDL_EventWatcher *prev = NULL;
SDL_EventWatcher *curr;
for (curr = SDL_event_watchers; curr; prev = curr, curr = curr->next) {
if (curr->callback == filter && curr->userdata == userdata) {
if (prev) {
prev->next = curr->next;
} else {
SDL_event_watchers = curr->next;
}
SDL_free(curr);
break;
}
}
}
SDL_event_watchers
static SDL_EventWatcher * SDL_event_watchers
Definition: SDL_events.c:49
SDL_EventWatcher::next
struct SDL_EventWatcher * next
Definition: SDL_events.c:46
SDL_free
void SDL_free(void *mem)
NULL
#define NULL
Definition: begin_code.h:143
SDL_EventWatcher
Definition: SDL_events.c:43
filter
GLint GLint GLint GLint GLint GLint GLint GLbitfield GLenum filter
Definition: SDL_opengl_glext.h:1184

Uint8 SDL_EventState | ( | Uint32 | type,
|  | int | state
| ) |  |

This function allows you to set the state of processing certain events.

- If `state` is set to SDL_IGNORE, that event will be automatically dropped from the event queue and will not event be filtered.
- If `state` is set to SDL_ENABLE, that event will be processed normally.
- If `state` is set to SDL_QUERY, SDL_EventState() will return the current processing state of the specified event.

Definition at line 567 of file SDL_events.c.

References SDL_DisabledEventBlock::bits, SDL_calloc(), SDL_DISABLE, SDL_ENABLE, and SDL_FlushEvent().

Referenced by SDL_StartEventLoop().

{
Uint8 current_state;
Uint8 hi = ((type >> 8) & 0xff);
Uint8 lo = (type & 0xff);
if (SDL_disabled_events[hi] &&
(SDL_disabled_events[hi]->bits[lo/32] & (1 << (lo&31)))) {
current_state = SDL_DISABLE;
} else {
current_state = SDL_ENABLE;
}
if (state != current_state)
{
switch (state) {
case SDL_DISABLE:
/* Disable this event type and discard pending events */
if (!SDL_disabled_events[hi]) {
SDL_disabled_events[hi] = (SDL_DisabledEventBlock*) SDL_calloc(1, sizeof(SDL_DisabledEventBlock));
if (!SDL_disabled_events[hi]) {
/* Out of memory, nothing we can do... */
break;
}
}
SDL_disabled_events[hi]->bits[lo/32] |= (1 << (lo&31));
SDL_FlushEvent(type);
break;
case SDL_ENABLE:
SDL_disabled_events[hi]->bits[lo/32] &= ~(1 << (lo&31));
break;
default:
/* Querying state... */
break;
}
}
return current_state;
}
state
struct xkb_state * state
Definition: SDL_waylandsym.h:97
SDL_ENABLE
#define SDL_ENABLE
Definition: SDL_events.h:718
bits
GLenum GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const void * bits
Definition: SDL_opengl_glext.h:6176
SDL_DisabledEventBlock::bits
Uint32 bits[8]
Definition: SDL_events.c:52
type
GLuint GLuint GLsizei GLenum type
Definition: SDL_opengl.h:1564
SDL_calloc
void * SDL_calloc(size_t nmemb, size_t size)
Uint8
uint8_t Uint8
An unsigned 8-bit integer type.
Definition: SDL_stdinc.h:139
SDL_DisabledEventBlock
Definition: SDL_events.c:51
SDL_FlushEvent
void SDL_FlushEvent(Uint32 type)
Definition: SDL_events.c:357
SDL_DISABLE
#define SDL_DISABLE
Definition: SDL_events.h:717
SDL_disabled_events
static SDL_DisabledEventBlock * SDL_disabled_events[256]
Definition: SDL_events.c:55

void SDL_FilterEvents | ( | SDL_EventFilter | filter,
|  | void * | userdata
| ) |  |

Run the filter function on the current event queue, removing any events for which the filter returns 0.

Definition at line 552 of file SDL_events.c.

References SDL_EventEntry::event, SDL_EventWatcher::next, SDL_EventEntry::next, SDL_CutEvent(), SDL_EventQ, SDL_LockMutex, and SDL_UnlockMutex.

{
if (SDL_EventQ.lock && SDL_LockMutex(SDL_EventQ.lock) == 0) {
SDL_EventEntry *entry, *next;
for (entry = SDL_EventQ.head; entry; entry = next) {
next = entry->next;
if (!filter(userdata, &entry->event)) {
SDL_CutEvent(entry);
}
}
SDL_UnlockMutex(SDL_EventQ.lock);
}
}
SDL_LockMutex
#define SDL_LockMutex
Definition: SDL_dynapi_overrides.h:266
SDL_EventEntry::next
struct _SDL_EventEntry * next
Definition: SDL_events.c:64
SDL_EventEntry::event
SDL_Event event
Definition: SDL_events.c:61
SDL_EventQ
static struct @22 SDL_EventQ
SDL_EventEntry
Definition: SDL_events.c:59
SDL_CutEvent
static void SDL_CutEvent(SDL_EventEntry *entry)
Definition: SDL_events.c:239
SDL_UnlockMutex
#define SDL_UnlockMutex
Definition: SDL_dynapi_overrides.h:268
filter
GLint GLint GLint GLint GLint GLint GLint GLbitfield GLenum filter
Definition: SDL_opengl_glext.h:1184

void SDL_FlushEvent | ( | Uint32 | type | ) |

This function clears events from the event queue This function only affects currently queued events. If you want to make sure that all pending OS events are flushed, you can call SDL_PumpEvents() on the main thread immediately before the flush call.

Definition at line 357 of file SDL_events.c.

References SDL_FlushEvents().

Referenced by SDL_EventState().

{
SDL_FlushEvents(type, type);
}
type
GLuint GLuint GLsizei GLenum type
Definition: SDL_opengl.h:1564
SDL_FlushEvents
void SDL_FlushEvents(Uint32 minType, Uint32 maxType)
Definition: SDL_events.c:363

void SDL_FlushEvents | ( | Uint32 | minType,
|  | Uint32 | maxType
| ) |  |

Definition at line 363 of file SDL_events.c.

References SDL_EventEntry::event, SDL_EventWatcher::next, SDL_EventEntry::next, SDL_CutEvent(), SDL_EventQ, SDL_LockMutex, SDL_PumpEvents(), SDL_UnlockMutex, and SDL_Event::type.

Referenced by SDL_FlushEvent(), and SDL_SetEventFilter().

{
/* Don't look after we've quit */
if (!SDL_EventQ.active) {
return;
}
/* Make sure the events are current */
#if 0
/* Actually, we can't do this since we might be flushing while processing
a resize event, and calling this might trigger further resize events.
*/
SDL_PumpEvents();
#endif
/* Lock the event queue */
if (SDL_LockMutex(SDL_EventQ.lock) == 0) {
SDL_EventEntry *entry, *next;
Uint32 type;
for (entry = SDL_EventQ.head; entry; entry = next) {
next = entry->next;
type = entry->event.type;
if (minType <= type && type <= maxType) {
SDL_CutEvent(entry);
}
}
SDL_UnlockMutex(SDL_EventQ.lock);
}
}
SDL_LockMutex
#define SDL_LockMutex
Definition: SDL_dynapi_overrides.h:266
SDL_EventEntry::next
struct _SDL_EventEntry * next
Definition: SDL_events.c:64
SDL_PumpEvents
void SDL_PumpEvents(void)
Definition: SDL_events.c:395
Uint32
uint32_t Uint32
An unsigned 32-bit integer type.
Definition: SDL_stdinc.h:157
SDL_EventEntry::event
SDL_Event event
Definition: SDL_events.c:61
SDL_EventQ
static struct @22 SDL_EventQ
type
GLuint GLuint GLsizei GLenum type
Definition: SDL_opengl.h:1564
SDL_EventEntry
Definition: SDL_events.c:59
SDL_CutEvent
static void SDL_CutEvent(SDL_EventEntry *entry)
Definition: SDL_events.c:239
SDL_UnlockMutex
#define SDL_UnlockMutex
Definition: SDL_dynapi_overrides.h:268
SDL_Event::type
Uint32 type
Definition: SDL_events.h:523

SDL_bool SDL_GetEventFilter | ( | SDL_EventFilter * | filter,
|  | void ** | userdata
| ) |  |

Return the current event filter - can be used to "chain" filters. If there is no event filter set, this function returns SDL_FALSE.

Definition at line 492 of file SDL_events.c.

References SDL_EventOK, SDL_EventOKParam, SDL_FALSE, and SDL_TRUE.

{
if (filter) {
*filter = SDL_EventOK;
}
if (userdata) {
*userdata = SDL_EventOKParam;
}
return SDL_EventOK ? SDL_TRUE : SDL_FALSE;
}
SDL_EventOK
SDL_EventFilter SDL_EventOK
Definition: SDL_events.c:40
SDL_TRUE
Definition: SDL_stdinc.h:129
SDL_EventOKParam
void * SDL_EventOKParam
Definition: SDL_events.c:41
SDL_FALSE
Definition: SDL_stdinc.h:128
filter
GLint GLint GLint GLint GLint GLint GLint GLbitfield GLenum filter
Definition: SDL_opengl_glext.h:1184

SDL_bool SDL_HasEvent | ( | Uint32 | type | ) |

Checks to see if certain event types are in the event queue.

Definition at line 345 of file SDL_events.c.

References NULL, SDL_PEEKEVENT, and SDL_PeepEvents().

{
return (SDL_PeepEvents(NULL, 0, SDL_PEEKEVENT, type, type) > 0);
}
SDL_PeepEvents
int SDL_PeepEvents(SDL_Event *events, int numevents, SDL_eventaction action, Uint32 minType, Uint32 maxType)
Definition: SDL_events.c:265
SDL_PEEKEVENT
Definition: SDL_events.h:575
type
GLuint GLuint GLsizei GLenum type
Definition: SDL_opengl.h:1564
NULL
#define NULL
Definition: begin_code.h:143

SDL_bool SDL_HasEvents | ( | Uint32 | minType,
|  | Uint32 | maxType
| ) |  |

Definition at line 351 of file SDL_events.c.

References NULL, SDL_PEEKEVENT, and SDL_PeepEvents().

{
return (SDL_PeepEvents(NULL, 0, SDL_PEEKEVENT, minType, maxType) > 0);
}
SDL_PeepEvents
int SDL_PeepEvents(SDL_Event *events, int numevents, SDL_eventaction action, Uint32 minType, Uint32 maxType)
Definition: SDL_events.c:265
SDL_PEEKEVENT
Definition: SDL_events.h:575
NULL
#define NULL
Definition: begin_code.h:143

int SDL_PeepEvents | ( | SDL_Event * | events,
|  | int | numevents,
|  | SDL_eventaction | action,
|  | Uint32 | minType,
|  | Uint32 | maxType
| ) |  |

Checks the event queue for messages and optionally returns them.

If `action` is SDL_ADDEVENT, up to `numevents` events will be added to the back of the event queue.

If `action` is SDL_PEEKEVENT, up to `numevents` events at the front of the event queue, within the specified minimum and maximum type, will be returned and will not be removed from the queue.

If `action` is SDL_GETEVENT, up to `numevents` events at the front of the event queue, within the specified minimum and maximum type, will be returned and will be removed from the queue.

Returns
  The number of events actually stored, or -1 if there was an error.

This function is thread-safe.

Definition at line 265 of file SDL_events.c.

References SDL_EventEntry::event, i, SDL_SysWMEntry::msg, SDL_SysWMEvent::msg, SDL_EventWatcher::next, SDL_EventEntry::next, SDL_SysWMEntry::next, NULL, SDL_AddEvent(), SDL_ADDEVENT, SDL_CutEvent(), SDL_EventQ, SDL_GETEVENT, SDL_LockMutex, SDL_malloc, SDL_PEEKEVENT, SDL_SetError, SDL_SYSWMEVENT, SDL_UnlockMutex, SDL_Event::syswm, and SDL_Event::type.

Referenced by SDL_HasEvent(), SDL_HasEvents(), SDL_PushEvent(), and SDL_WaitEventTimeout().

{
int i, used;
/* Don't look after we've quit */
if (!SDL_EventQ.active) {
/* We get a few spurious events at shutdown, so don't warn then */
if (action != SDL_ADDEVENT) {
SDL_SetError("The event system has been shut down");
}
return (-1);
}
/* Lock the event queue */
used = 0;
if (!SDL_EventQ.lock || SDL_LockMutex(SDL_EventQ.lock) == 0) {
if (action == SDL_ADDEVENT) {
for (i = 0; i < numevents; ++i) {
used += SDL_AddEvent(&events[i]);
}
} else {
SDL_EventEntry *entry, *next;
SDL_SysWMEntry *wmmsg, *wmmsg_next;
SDL_Event tmpevent;
Uint32 type;
/* If 'events' is NULL, just see if they exist */
if (events == NULL) {
action = SDL_PEEKEVENT;
numevents = 1;
events = &tmpevent;
}
/* Clean out any used wmmsg data
FIXME: Do we want to retain the data for some period of time?
*/
for (wmmsg = SDL_EventQ.wmmsg_used; wmmsg; wmmsg = wmmsg_next) {
wmmsg_next = wmmsg->next;
wmmsg->next = SDL_EventQ.wmmsg_free;
SDL_EventQ.wmmsg_free = wmmsg;
}
SDL_EventQ.wmmsg_used = NULL;
for (entry = SDL_EventQ.head; entry && used < numevents; entry = next) {
next = entry->next;
type = entry->event.type;
if (minType <= type && type <= maxType) {
events[used] = entry->event;
if (entry->event.type == SDL_SYSWMEVENT) {
/* We need to copy the wmmsg somewhere safe.
For now we'll guarantee it's valid at least until
the next call to SDL_PeepEvents()
*/
if (SDL_EventQ.wmmsg_free) {
wmmsg = SDL_EventQ.wmmsg_free;
SDL_EventQ.wmmsg_free = wmmsg->next;
} else {
wmmsg = (SDL_SysWMEntry *)SDL_malloc(sizeof(*wmmsg));
}
wmmsg->msg = *entry->event.syswm.msg;
wmmsg->next = SDL_EventQ.wmmsg_used;
SDL_EventQ.wmmsg_used = wmmsg;
events[used].syswm.msg = &wmmsg->msg;
}
++used;
if (action == SDL_GETEVENT) {
SDL_CutEvent(entry);
}
}
}
}
SDL_UnlockMutex(SDL_EventQ.lock);
} else {
return SDL_SetError("Couldn't lock event queue");
}
return (used);
}
SDL_LockMutex
#define SDL_LockMutex
Definition: SDL_dynapi_overrides.h:266
SDL_EventEntry::next
struct _SDL_EventEntry * next
Definition: SDL_events.c:64
SDL_SysWMEntry::msg
SDL_SysWMmsg msg
Definition: SDL_events.c:69
Uint32
uint32_t Uint32
An unsigned 32-bit integer type.
Definition: SDL_stdinc.h:157
SDL_AddEvent
static int SDL_AddEvent(SDL_Event *event)
Definition: SDL_events.c:191
SDL_SysWMEvent::msg
SDL_SysWMmsg * msg
Definition: SDL_events.h:515
SDL_SYSWMEVENT
Definition: SDL_events.h:90
SDL_PEEKEVENT
Definition: SDL_events.h:575
SDL_EventEntry::event
SDL_Event event
Definition: SDL_events.c:61
SDL_SysWMEntry
Definition: SDL_events.c:67
SDL_EventQ
static struct @22 SDL_EventQ
SDL_SysWMEntry::next
struct _SDL_SysWMEntry * next
Definition: SDL_events.c:70
type
GLuint GLuint GLsizei GLenum type
Definition: SDL_opengl.h:1564
SDL_EventEntry
Definition: SDL_events.c:59
SDL_CutEvent
static void SDL_CutEvent(SDL_EventEntry *entry)
Definition: SDL_events.c:239
i
return Display return Display Bool Bool int int int return Display XEvent Bool(*) XPointer return Display return Display Drawable _Xconst char unsigned int unsigned int return Display Pixmap Pixmap XColor XColor unsigned int unsigned int return Display _Xconst char char int char return Display Visual unsigned int int int char unsigned int unsigned int in i)
Definition: SDL_x11sym.h:42
NULL
#define NULL
Definition: begin_code.h:143
SDL_SetError
#define SDL_SetError
Definition: SDL_dynapi_overrides.h:36
SDL_Event::syswm
SDL_SysWMEvent syswm
Definition: SDL_events.h:543
SDL_UnlockMutex
#define SDL_UnlockMutex
Definition: SDL_dynapi_overrides.h:268
SDL_Event
General event structure.
Definition: SDL_events.h:521
SDL_malloc
#define SDL_malloc
Definition: SDL_dynapi_overrides.h:380
SDL_GETEVENT
Definition: SDL_events.h:576
SDL_ADDEVENT
Definition: SDL_events.h:574
SDL_Event::type
Uint32 type
Definition: SDL_events.h:523

int SDL_PollEvent | ( | SDL_Event * | event | ) |

Polls for currently pending events.

Returns
  1 if there are any pending events, or 0 if there are none available.

Parameters

  event | If not NULL, the next event is removed from the queue and stored in that area.

Definition at line 416 of file SDL_events.c.

References SDL_WaitEventTimeout().

{
return SDL_WaitEventTimeout(event, 0);
}
SDL_WaitEventTimeout
int SDL_WaitEventTimeout(SDL_Event *event, int timeout)
Waits until the specified timeout (in milliseconds) for the next available event. ...
Definition: SDL_events.c:428

void SDL_PumpEvents | ( | void |  | ) |

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

This function updates the event queue and internal input device state.

This should only be run in the thread that sets the video mode.

Definition at line 395 of file SDL_events.c.

References _this, SDL_VideoDevice::PumpEvents, SDL_GetVideoDevice(), SDL_JOYAXISMOTION, SDL_JoystickEventState, SDL_JoystickUpdate, SDL_QUERY, and SDL_SendPendingQuit().

Referenced by SDL_FlushEvents(), and SDL_WaitEventTimeout().

{
SDL_VideoDevice *_this = SDL_GetVideoDevice();
/* Get events from the video subsystem */
if (_this) {
_this->PumpEvents(_this);
}
#if !SDL_JOYSTICK_DISABLED
/* Check for joystick state change */
if ((!SDL_disabled_events[SDL_JOYAXISMOTION >> 8] || SDL_JoystickEventState(SDL_QUERY))) {
SDL_JoystickUpdate();
}
#endif
SDL_SendPendingQuit(); /* in case we had a signal handler fire, etc. */
}
SDL_JOYAXISMOTION
Definition: SDL_events.h:108
_this
static SDL_VideoDevice * _this
Definition: SDL_video.c:114
SDL_JoystickUpdate
#define SDL_JoystickUpdate
Definition: SDL_dynapi_overrides.h:215
SDL_disabled_events
static SDL_DisabledEventBlock * SDL_disabled_events[256]
Definition: SDL_events.c:55
SDL_VideoDevice
Definition: SDL_sysvideo.h:142
SDL_JoystickEventState
#define SDL_JoystickEventState
Definition: SDL_dynapi_overrides.h:216
SDL_GetVideoDevice
SDL_VideoDevice * SDL_GetVideoDevice(void)
Definition: SDL_video.c:573
SDL_SendPendingQuit
void SDL_SendPendingQuit(void)
Definition: SDL_quit.c:146
SDL_QUERY
#define SDL_QUERY
Definition: SDL_events.h:715
SDL_VideoDevice::PumpEvents
void(* PumpEvents)(_THIS)
Definition: SDL_sysvideo.h:249

int SDL_PushEvent | ( | SDL_Event * | event | ) |

Add an event to the event queue.

Returns
  1 on success, 0 if the event was filtered, or -1 if the event queue was full or there was some other error.

Definition at line 458 of file SDL_events.c.

References SDL_EventWatcher::callback, SDL_EventWatcher::next, SDL_ADDEVENT, SDL_EventOK, SDL_EventOKParam, SDL_GestureProcessEvent(), SDL_GetTicks(), SDL_PeepEvents(), and SDL_EventWatcher::userdata.

Referenced by SDL_SendAppEvent(), and SDL_SendSysWMEvent().

{
SDL_EventWatcher *curr;
event->common.timestamp = SDL_GetTicks();
if (SDL_EventOK && !SDL_EventOK(SDL_EventOKParam, event)) {
return 0;
}
for (curr = SDL_event_watchers; curr; curr = curr->next) {
curr->callback(curr->userdata, event);
}
if (SDL_PeepEvents(event, 1, SDL_ADDEVENT, 0, 0) <= 0) {
return -1;
}
SDL_GestureProcessEvent(event);
return 1;
}
SDL_PeepEvents
int SDL_PeepEvents(SDL_Event *events, int numevents, SDL_eventaction action, Uint32 minType, Uint32 maxType)
Definition: SDL_events.c:265
SDL_event_watchers
static SDL_EventWatcher * SDL_event_watchers
Definition: SDL_events.c:49
SDL_EventWatcher::callback
SDL_EventFilter callback
Definition: SDL_events.c:44
SDL_GestureProcessEvent
void SDL_GestureProcessEvent(SDL_Event *event)
Definition: SDL_gesture.c:510
SDL_GetTicks
Uint32 SDL_GetTicks(void)
Get the number of milliseconds since the SDL library initialization.
SDL_EventWatcher::next
struct SDL_EventWatcher * next
Definition: SDL_events.c:46
SDL_EventOK
SDL_EventFilter SDL_EventOK
Definition: SDL_events.c:40
SDL_EventOKParam
void * SDL_EventOKParam
Definition: SDL_events.c:41
SDL_ADDEVENT
Definition: SDL_events.h:574
SDL_EventWatcher::userdata
void * userdata
Definition: SDL_events.c:45
SDL_EventWatcher
Definition: SDL_events.c:43

Uint32 SDL_RegisterEvents | ( | int | numevents | ) |

This function allocates a set of user-defined events, and returns the beginning event number for that set of events.

If there aren't enough user-defined events left, this function returns (Uint32)-1

Definition at line 608 of file SDL_events.c.

References SDL_LASTEVENT, and SDL_userevents.

{
Uint32 event_base;
if ((numevents > 0) && (SDL_userevents+numevents <= SDL_LASTEVENT)) {
event_base = SDL_userevents;
SDL_userevents += numevents;
} else {
event_base = (Uint32)-1;
}
return event_base;
}
Uint32
uint32_t Uint32
An unsigned 32-bit integer type.
Definition: SDL_stdinc.h:157
SDL_userevents
static Uint32 SDL_userevents
Definition: SDL_events.c:56
SDL_LASTEVENT
Definition: SDL_events.h:156

int SDL_SendAppEvent | ( | SDL_EventType | eventType | ) |

Definition at line 622 of file SDL_events.c.

References SDL_ENABLE, SDL_GetEventState, and SDL_PushEvent().

Referenced by IsSDLWindowEventPending(), SDL_SendKeymapChangedEvent(), and SDL_SendQuit().

{
int posted;
posted = 0;
if (SDL_GetEventState(eventType) == SDL_ENABLE) {
SDL_Event event;
event.type = eventType;
posted = (SDL_PushEvent(&event) > 0);
}
return (posted);
}
SDL_ENABLE
#define SDL_ENABLE
Definition: SDL_events.h:718
SDL_GetEventState
#define SDL_GetEventState(type)
Definition: SDL_events.h:731
event
struct _cl_event * event
Definition: SDL_opengl_glext.h:2649
SDL_PushEvent
int SDL_PushEvent(SDL_Event *event)
Add an event to the event queue.
Definition: SDL_events.c:458
SDL_Event
General event structure.
Definition: SDL_events.h:521

int SDL_SendKeymapChangedEvent | ( | void |  | ) |

Definition at line 653 of file SDL_events.c.

References SDL_KEYMAPCHANGED, and SDL_SendAppEvent().

{
return SDL_SendAppEvent(SDL_KEYMAPCHANGED);
}
SDL_SendAppEvent
int SDL_SendAppEvent(SDL_EventType eventType)
Definition: SDL_events.c:622
SDL_KEYMAPCHANGED
Definition: SDL_events.h:97

int SDL_SendSysWMEvent | ( | SDL_SysWMmsg * | message | ) |

Definition at line 636 of file SDL_events.c.

References SDL_ENABLE, SDL_GetEventState, SDL_memset, SDL_PushEvent(), and SDL_SYSWMEVENT.

{
int posted;
posted = 0;
if (SDL_GetEventState(SDL_SYSWMEVENT) == SDL_ENABLE) {
SDL_Event event;
SDL_memset(&event, 0, sizeof(event));
event.type = SDL_SYSWMEVENT;
event.syswm.msg = message;
posted = (SDL_PushEvent(&event) > 0);
}
/* Update internal event state */
return (posted);
}
message
GLuint GLsizei const GLchar * message
Definition: SDL_opengl_glext.h:2483
SDL_SYSWMEVENT
Definition: SDL_events.h:90
SDL_ENABLE
#define SDL_ENABLE
Definition: SDL_events.h:718
SDL_GetEventState
#define SDL_GetEventState(type)
Definition: SDL_events.h:731
event
struct _cl_event * event
Definition: SDL_opengl_glext.h:2649
SDL_PushEvent
int SDL_PushEvent(SDL_Event *event)
Add an event to the event queue.
Definition: SDL_events.c:458
SDL_Event
General event structure.
Definition: SDL_events.h:521
SDL_memset
#define SDL_memset
Definition: SDL_dynapi_overrides.h:392

void SDL_SetEventFilter | ( | SDL_EventFilter | filter,
|  | void * | userdata
| ) |  |

Sets up a filter to process all events before they change internal state and are posted to the internal event queue.

The filter is prototyped as:

int SDL_EventFilter(void *userdata, SDL_Event * event);

If the filter returns 1, then the event will be added to the internal queue. If it returns 0, then the event will be dropped from the queue, but the internal state will still be updated. This allows selective filtering of dynamically arriving events.

Warning
  Be very careful of what you do in the event filter function, as it may run in a different thread!

There is one caveat when dealing with the SDL_QuitEvent event type. The event filter is only called when the window manager desires to close the application window. If the event filter returns 1, then the window will be closed, otherwise the window will remain open if possible.

If the quit event is generated by an interrupt signal, it will bypass the internal queue and be delivered to the application at the next event poll.

Definition at line 482 of file SDL_events.c.

References NULL, SDL_EventOK, SDL_EventOKParam, SDL_FIRSTEVENT, SDL_FlushEvents(), SDL_LASTEVENT, and SDL_EventWatcher::userdata.

{
/* Set filter and discard pending events */
SDL_EventOK = NULL;
SDL_FlushEvents(SDL_FIRSTEVENT, SDL_LASTEVENT);
SDL_EventOKParam = userdata;
SDL_EventOK = filter;
}
SDL_FlushEvents
void SDL_FlushEvents(Uint32 minType, Uint32 maxType)
Definition: SDL_events.c:363
SDL_EventOK
SDL_EventFilter SDL_EventOK
Definition: SDL_events.c:40
SDL_EventOKParam
void * SDL_EventOKParam
Definition: SDL_events.c:41
SDL_FIRSTEVENT
Definition: SDL_events.h:57
NULL
#define NULL
Definition: begin_code.h:143
SDL_LASTEVENT
Definition: SDL_events.h:156
filter
GLint GLint GLint GLint GLint GLint GLint GLbitfield GLenum filter
Definition: SDL_opengl_glext.h:1184

int SDL_StartEventLoop | ( | void |  | ) |

Definition at line 160 of file SDL_events.c.

References NULL, SDL_CreateMutex, SDL_DISABLE, SDL_EventQ, SDL_EventState(), SDL_SYSWMEVENT, SDL_TEXTEDITING, SDL_TEXTINPUT, and SDL_TRUE.

Referenced by SDL_InitSubSystem().

{
/* We'll leave the event queue alone, since we might have gotten
some important events at launch (like SDL_DROPFILE)
FIXME: Does this introduce any other bugs with events at startup?
*/
/* Create the lock and set ourselves active */
#if !SDL_THREADS_DISABLED
if (!SDL_EventQ.lock) {
SDL_EventQ.lock = SDL_CreateMutex();
}
if (SDL_EventQ.lock == NULL) {
return (-1);
}
#endif /* !SDL_THREADS_DISABLED */
/* Process most event types */
SDL_EventState(SDL_TEXTINPUT, SDL_DISABLE);
SDL_EventState(SDL_TEXTEDITING, SDL_DISABLE);
SDL_EventState(SDL_SYSWMEVENT, SDL_DISABLE);
SDL_EventQ.active = SDL_TRUE;
return (0);
}
SDL_SYSWMEVENT
Definition: SDL_events.h:90
SDL_CreateMutex
#define SDL_CreateMutex
Definition: SDL_dynapi_overrides.h:265
SDL_EventQ
static struct @22 SDL_EventQ
SDL_TRUE
Definition: SDL_stdinc.h:129
SDL_EventState
Uint8 SDL_EventState(Uint32 type, int state)
Definition: SDL_events.c:567
SDL_DISABLE
#define SDL_DISABLE
Definition: SDL_events.h:717
NULL
#define NULL
Definition: begin_code.h:143
SDL_TEXTINPUT
Definition: SDL_events.h:96
SDL_TEXTEDITING
Definition: SDL_events.h:95

void SDL_StopEventLoop | ( | void |  | ) |

Definition at line 90 of file SDL_events.c.

References i, SDL_EventWatcher::next, SDL_EventEntry::next, SDL_SysWMEntry::next, NULL, SDL_arraysize, SDL_atoi, SDL_DestroyMutex, SDL_event_watchers, SDL_EventOK, SDL_EventQ, SDL_FALSE, SDL_free(), SDL_GetHint, SDL_LockMutex, SDL_Log, and SDL_UnlockMutex.

Referenced by SDL_QuitSubSystem().

{
const char *report = SDL_GetHint("SDL_EVENT_QUEUE_STATISTICS");
int i;
SDL_EventEntry *entry;
SDL_SysWMEntry *wmmsg;
if (SDL_EventQ.lock) {
SDL_LockMutex(SDL_EventQ.lock);
}
SDL_EventQ.active = SDL_FALSE;
if (report && SDL_atoi(report)) {
SDL_Log("SDL EVENT QUEUE: Maximum events in-flight: %d\n",
SDL_EventQ.max_events_seen);
}
/* Clean out EventQ */
for (entry = SDL_EventQ.head; entry; ) {
SDL_EventEntry *next = entry->next;
SDL_free(entry);
entry = next;
}
for (entry = SDL_EventQ.free; entry; ) {
SDL_EventEntry *next = entry->next;
SDL_free(entry);
entry = next;
}
for (wmmsg = SDL_EventQ.wmmsg_used; wmmsg; ) {
SDL_SysWMEntry *next = wmmsg->next;
SDL_free(wmmsg);
wmmsg = next;
}
for (wmmsg = SDL_EventQ.wmmsg_free; wmmsg; ) {
SDL_SysWMEntry *next = wmmsg->next;
SDL_free(wmmsg);
wmmsg = next;
}
SDL_EventQ.count = 0;
SDL_EventQ.max_events_seen = 0;
SDL_EventQ.head = NULL;
SDL_EventQ.tail = NULL;
SDL_EventQ.free = NULL;
SDL_EventQ.wmmsg_used = NULL;
SDL_EventQ.wmmsg_free = NULL;
/* Clear disabled event state */
for (i = 0; i < SDL_arraysize(SDL_disabled_events); ++i) {
SDL_free(SDL_disabled_events[i]);
SDL_disabled_events[i] = NULL;
}
while (SDL_event_watchers) {
SDL_EventWatcher *tmp = SDL_event_watchers;
SDL_event_watchers = tmp->next;
SDL_free(tmp);
}
SDL_EventOK = NULL;
if (SDL_EventQ.lock) {
SDL_UnlockMutex(SDL_EventQ.lock);
SDL_DestroyMutex(SDL_EventQ.lock);
SDL_EventQ.lock = NULL;
}
}
SDL_LockMutex
#define SDL_LockMutex
Definition: SDL_dynapi_overrides.h:266
SDL_event_watchers
static SDL_EventWatcher * SDL_event_watchers
Definition: SDL_events.c:49
SDL_EventEntry::next
struct _SDL_EventEntry * next
Definition: SDL_events.c:64
SDL_GetHint
#define SDL_GetHint
Definition: SDL_dynapi_overrides.h:197
SDL_SysWMEntry
Definition: SDL_events.c:67
SDL_EventQ
static struct @22 SDL_EventQ
SDL_SysWMEntry::next
struct _SDL_SysWMEntry * next
Definition: SDL_events.c:70
SDL_Log
#define SDL_Log
Definition: SDL_dynapi_overrides.h:37
SDL_EventWatcher::next
struct SDL_EventWatcher * next
Definition: SDL_events.c:46
SDL_free
void SDL_free(void *mem)
SDL_EventOK
SDL_EventFilter SDL_EventOK
Definition: SDL_events.c:40
SDL_EventEntry
Definition: SDL_events.c:59
SDL_atoi
#define SDL_atoi
Definition: SDL_dynapi_overrides.h:416
i
return Display return Display Bool Bool int int int return Display XEvent Bool(*) XPointer return Display return Display Drawable _Xconst char unsigned int unsigned int return Display Pixmap Pixmap XColor XColor unsigned int unsigned int return Display _Xconst char char int char return Display Visual unsigned int int int char unsigned int unsigned int in i)
Definition: SDL_x11sym.h:42
NULL
#define NULL
Definition: begin_code.h:143
SDL_DestroyMutex
#define SDL_DestroyMutex
Definition: SDL_dynapi_overrides.h:269
SDL_disabled_events
static SDL_DisabledEventBlock * SDL_disabled_events[256]
Definition: SDL_events.c:55
SDL_FALSE
Definition: SDL_stdinc.h:128
SDL_UnlockMutex
#define SDL_UnlockMutex
Definition: SDL_dynapi_overrides.h:268
SDL_arraysize
#define SDL_arraysize(array)
Definition: SDL_stdinc.h:93
SDL_EventWatcher
Definition: SDL_events.c:43

int SDL_WaitEvent | ( | SDL_Event * | event | ) |

Waits indefinitely for the next available event.

Returns
  1, or 0 if there was an error while waiting for events.

Parameters

  event | If not NULL, the next event is removed from the queue and stored in that area.

Definition at line 422 of file SDL_events.c.

References SDL_WaitEventTimeout().

{
return SDL_WaitEventTimeout(event, -1);
}
SDL_WaitEventTimeout
int SDL_WaitEventTimeout(SDL_Event *event, int timeout)
Waits until the specified timeout (in milliseconds) for the next available event. ...
Definition: SDL_events.c:428

int SDL_WaitEventTimeout | ( | SDL_Event * | event,
|  | int | timeout
| ) |  |

Waits until the specified timeout (in milliseconds) for the next available event.

Returns
  1, or 0 if there was an error while waiting for events.

Parameters

  event | If not NULL, the next event is removed from the queue and stored in that area.
  timeout | The timeout (in milliseconds) to wait for next event.

Definition at line 428 of file SDL_events.c.

References SDL_Delay, SDL_FIRSTEVENT, SDL_GETEVENT, SDL_GetTicks(), SDL_LASTEVENT, SDL_PeepEvents(), SDL_PumpEvents(), and SDL_TICKS_PASSED.

Referenced by SDL_PollEvent(), and SDL_WaitEvent().

{
Uint32 expiration = 0;
if (timeout > 0)
expiration = SDL_GetTicks() + timeout;
for (;;) {
SDL_PumpEvents();
switch (SDL_PeepEvents(event, 1, SDL_GETEVENT, SDL_FIRSTEVENT, SDL_LASTEVENT)) {
case -1:
return 0;
case 1:
return 1;
case 0:
if (timeout == 0) {
/* Polling and no events, just return */
return 0;
}
if (timeout > 0 && SDL_TICKS_PASSED(SDL_GetTicks(), expiration)) {
/* Timeout expired and no events */
return 0;
}
SDL_Delay(10);
break;
}
}
}
SDL_PeepEvents
int SDL_PeepEvents(SDL_Event *events, int numevents, SDL_eventaction action, Uint32 minType, Uint32 maxType)
Definition: SDL_events.c:265
SDL_PumpEvents
void SDL_PumpEvents(void)
Definition: SDL_events.c:395
Uint32
uint32_t Uint32
An unsigned 32-bit integer type.
Definition: SDL_stdinc.h:157
SDL_GetTicks
Uint32 SDL_GetTicks(void)
Get the number of milliseconds since the SDL library initialization.
SDL_Delay
#define SDL_Delay
Definition: SDL_dynapi_overrides.h:490
SDL_FIRSTEVENT
Definition: SDL_events.h:57
timeout
GLbitfield GLuint64 timeout
Definition: SDL_opengl_glext.h:1483
SDL_GETEVENT
Definition: SDL_events.h:576
SDL_TICKS_PASSED
#define SDL_TICKS_PASSED(A, B)
Compare SDL ticks values, and return true if A has passed B.
Definition: SDL_timer.h:56
SDL_LASTEVENT
Definition: SDL_events.h:156

## Variable Documentation

volatile SDL_bool active

Definition at line 76 of file SDL_events.c.

volatile int count

Definition at line 77 of file SDL_events.c.

SDL_EventEntry* free

Definition at line 81 of file SDL_events.c.

Referenced by decode_edid(), SDL_BWin::DirectConnected(), main(), and SDL_BWin::~SDL_BWin().

SDL_EventEntry* head

Definition at line 79 of file SDL_events.c.

Referenced by change_mparam(), and mmap_alloc().

SDL_mutex* lock

Definition at line 75 of file SDL_events.c.

Referenced by RunBasicTest(), SDL_AtomicTryLock(), SDL_SYS_GetTLSData(), and SDL_ThreadID().

volatile int max_events_seen

Definition at line 78 of file SDL_events.c.

SDL_DisabledEventBlock* SDL_disabled_events[256]

static

Definition at line 55 of file SDL_events.c.

SDL_EventWatcher* SDL_event_watchers = NULL

static

Definition at line 49 of file SDL_events.c.

Referenced by SDL_StopEventLoop().

SDL_EventFilter SDL_EventOK = NULL

Definition at line 40 of file SDL_events.c.

Referenced by SDL_GetEventFilter(), SDL_PushEvent(), SDL_SetEventFilter(), SDL_StopEventLoop(), SDL_SYS_AddJoystickDevice(), and SDL_SYS_RemoveJoystickDevice().

void* SDL_EventOKParam

Definition at line 41 of file SDL_events.c.

Referenced by SDL_GetEventFilter(), SDL_PushEvent(), SDL_SetEventFilter(), SDL_SYS_AddJoystickDevice(), and SDL_SYS_RemoveJoystickDevice().

struct { ... } SDL_EventQ

Referenced by SDL_AddEvent(), SDL_CutEvent(), SDL_FilterEvents(), SDL_FlushEvents(), SDL_PeepEvents(), SDL_StartEventLoop(), and SDL_StopEventLoop().

Uint32 SDL_userevents = SDL_USEREVENT

static

Definition at line 56 of file SDL_events.c.

Referenced by SDL_RegisterEvents().

SDL_EventEntry* tail

Definition at line 80 of file SDL_events.c.

Referenced by SDL_AddEventWatch().

SDL_SysWMEntry* wmmsg_free

Definition at line 83 of file SDL_events.c.

SDL_SysWMEntry* wmmsg_used

Definition at line 82 of file SDL_events.c.