|
Size: 3191
Comment: update content - changeset 4624
|
Size: 2921
Comment: update content - changeset 4635
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 36: | Line 36: |
| <<Color2(green,NOTE: Recent changes have removed the '''mask''' param but the following information has not been adjusted to reflect this change yet.)>> <<Anchor(action)>> '''action''' may be any of the following <<Color2(green,(from enum SDL_eventaction which has no page))>>: | <<Anchor(action)>> '''action''' may be any of the following <<Color2(green,(from enum SDL_eventaction which has no page))>>: |
| Line 38: | Line 38: |
| ||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 || |
||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|| ||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|| |
| Line 46: | Line 46: |
| 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_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. |
| Line 48: | Line 48: |
| 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. | 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. |
| Line 50: | Line 50: |
| <<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 * |
|
| Line 62: | Line 53: |
| <<Color2(green,Is the following 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]](). | *<<BR>> <<Color2(green,Is the following 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]]().<<BR>>* |
| Line 65: | Line 57: |
| . [[SDL_PollEvent]] *??? . [[SDL_PumpEvents]] *??? . [[SDL_PushEvent]] *??? |
. [[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 minType,
Uint32 maxType)
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 |
minType |
the minimum number of events of a specified type ??? |
maxType |
the maximum number of events of a specified type ??? |
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 green
:
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, within the specified minimum and maximum type, will be returned and will not be removed from the queue |
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 |
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, 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.
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().
*
