|
Size: 2147
Comment: update content - standard return value
|
Size: 2157
Comment: update content - pointers, structs
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 16: | Line 16: |
| ||'''event'''||^a pointer to the [[SDL_Event]] to be added to the queue^|| | ||'''event'''||^the [[SDL_Event]] to be added to the queue^|| |
| Line 18: | Line 18: |
| <<Color2(green,Most other functions w/ the event param say "If not NULL the next event is removed from the queue and stored in that area.")>> | <<Color2(green,Most other functions w/ the event param say "If not NULL the next event is removed from the queue and stored in that area." Does that apply here?)>> |
DRAFT |
SDL_PushEvent
Use this function to add an event to the event queue.
Contents
Syntax
int SDL_PushEvent(SDL_Event* event)
Function Parameters
event |
the [[SDL_Event]] to be added to the queue |
green
Return Value
Returns 1 on success, 0 if the event was filtered, or a negative error code on failure; call SDL_GetError() for more information.
purple
Code Examples
You can add your code example here
Remarks
*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. *
green
typedef int (SDLCALL * SDL_EventFilter) (void *userdata, SDL_Event * event);
*green
Note: Events pushed onto the queue with SDL_PushEvent() or SDL_PeepEvents() do not get passed through the event filter. *
Related Functions
SDL_PeepEvents *???
SDL_PollEvent *???
