|
Size: 2918
Comment: Replace 1.3 with 2.0
|
Size: 3054
Comment: Documented numevents, minType, and maxType from a read of the code.
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 21: | Line 21: |
| ||'''events''' ||^the [[SDL_Event]] queue to query^???|| ||'''numevents''' ||^the number of events in the queue^???; see [[#Remarks|Remarks]] for details || ||'''action''' ||^how to handle the events in the queue^; see [[#action|Remarks]] for details || ||'''minType''' ||^the minimum number of events of a specified type^ ??? || ||'''maxType''' ||^the maximum number of events of a specified type^ ??? || |
||'''events''' || Destination buffer for the retrieved events. || ||'''numevents''' || If action is SDL_ADDEVENT, the number of events to add back to the event queue. If action is SDL_PEEKEVENT or SDL_GETEVENT, the maximum number of events to retrieve. || ||'''action''' || Action to take; see [[#action|Remarks]] for details || ||'''minType''' || Minimum value of the event type to be considered. SDL_FIRSTEVENT is a safe choice. || ||'''maxType''' || Maximum value of the event type to be considered. SDL_LASTEVENT is a safe choice. || |
| Line 32: | Line 32: |
| You can add your code example here | Add a code example here. |
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 |
Destination buffer for the retrieved events. |
numevents |
If action is SDL_ADDEVENT, the number of events to add back to the event queue. If action is SDL_PEEKEVENT or SDL_GETEVENT, the maximum number of events to retrieve. |
action |
Action to take; see Remarks for details |
minType |
Minimum value of the event type to be considered. SDL_FIRSTEVENT is a safe choice. |
maxType |
Maximum value of the event type to be considered. SDL_LASTEVENT is a safe choice. |
Return Value
Returns the number of events actually stored or a negative error code on failure; call SDL_GetError() for more information.
Code Examples
Add a 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().
*
