|
Size: 1760
Comment: minor correction
|
Size: 2914
Comment: update content, formatting
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 21: | Line 21: |
| ||'''action'''||^how to handle the events in the queue^; see [[#Remarks|Remarks]] for details|| ||'''mask'''||^criteria by which to select events from the queue^|| |
||'''action'''||^how to handle the events in the queue^; see [[#action|Remarks]] for details|| ||'''mask'''||*a bit-wise OR of SDL_EVENTMASK(event_type), for all event types you are interested in*; see [[#mask|Remarks]] and [[SDL_EventMask]] for details ???|| |
| Line 33: | Line 33: |
| <<Anchor(action)>> | |
| Line 34: | Line 35: |
| ||SDL_ADDEVENT|| ||SDL_PEEKEVENT|| ||SDL_GETEVENT|| |
||SDL_ADDEVENT||up to '''numevents''' events will be added to the back of the event queue|| ||SDL_PEEKEVENT||up to '''numevents''' events at the front of the event queue, matching '''mask''', will be returned and will not be removed from the queue|| ||SDL_GETEVENT||up to '''numevents''' events at the front of the event queue, matching '''mask''', will be returned and will be removed from the queue|| <<Color2(green,The below is taken directly from the header. The info has been transferred to the table above as an optional way of being presented. Which should be kept?)>> |
| Line 44: | Line 48: |
| This function is thread-safe. | <<Anchor(mask)>>*Examples of '''mask''': *SDL_EVENTMASK (SDL_KEYUP) *(SDL_EVENTMASK (SDL_MOUSEBUTTONDOWN) | SDL_EVENTMASK (SDL_MOUSEBUTTONUP)) *SDL_ALLEVENTS *SDL_KEYUPMASK *SDL_ALLEVENTS ^ SDL_QUITMASK * {i} This function is thread-safe. <<Color2(green,Is this true in 1.3?)>> You may have to call [[SDL_PumpEvents]]() before calling this function. Otherwise, the events may not be ready to be filtered when you call [[SDL_PeepEvents]](). |
| Line 47: | Line 62: |
| .[[SDL_PollEvent]] *??? .[[SDL_PumpEvents]] *??? .[[SDL_PushEvent]] *??? |
DRAFT |
SDL_PeepEvents
Use this function to check the event queue for messages and optionally return them.
Contents
Syntax
int SDL_PeepEvents(SDL_Event* events,
int numevents,
SDL_eventaction action,
Uint32 mask)
Function Parameters
events |
a pointer to the ID of the event queue to query |
numevents |
the number of events to work with; see Remarks for details |
action |
how to handle the events in the queue; see Remarks for details |
mask |
*a bit-wise OR of SDL_EVENTMASK(event_type), for all event types you are interested in*; see Remarks and SDL_EventMask for details ??? |
Return Value
Returns the number of events actually stored, or -1 if there was an error; call SDL_GetError() for more information.
Code Examples
You can add your code example here
Remarks
action may be any of the following (from enum SDL_eventaction):
SDL_ADDEVENT |
up to numevents events will be added to the back of the event queue |
SDL_PEEKEVENT |
up to numevents events at the front of the event queue, matching mask, will be returned and will not be removed from the queue |
SDL_GETEVENT |
up to numevents events at the front of the event queue, matching mask, will be returned and will be removed from the queue |
green
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, matching mask, 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, matching mask, will be returned and will be removed from the queue.
*Examples of mask:
- SDL_EVENTMASK (SDL_KEYUP)
- (SDL_EVENTMASK (SDL_MOUSEBUTTONDOWN) | SDL_EVENTMASK (SDL_MOUSEBUTTONUP))
- SDL_ALLEVENTS
- SDL_KEYUPMASK
- SDL_ALLEVENTS ^ SDL_QUITMASK
*
This function is thread-safe.
green
You may have to call SDL_PumpEvents() before calling this function. Otherwise, the events may not be ready to be filtered when you call SDL_PeepEvents().
Related Functions
SDL_PollEvent *???
SDL_PumpEvents *???
SDL_PushEvent *???
