Wiki Page Content

Differences between revisions 10 and 11
Revision 10 as of 2014-01-18 19:14:19
Size: 1298
Comment: Updated.
Revision 11 as of 2015-04-26 18:51:25
Size: 1298
Comment: Sorted releated functions, see SGFunctions.
Deletions are marked like this. Additions are marked like this.
Line 33: Line 33:
 .[[SDL_PollEvent]]
Line 34: Line 35:
 .[[SDL_PollEvent]]

SDL_WaitEventTimeout

Use this function to wait until the specified timeout (in milliseconds) for the next available event.

Syntax

int SDL_WaitEventTimeout(SDL_Event* event,
                         int        timeout)

Function Parameters

event

the SDL_Event structure to be filled in with the next event from the queue, or NULL

timeout

the maximum number of milliseconds to wait for the next available event

Return Value

Returns 1 on success or 0 if there was an error while waiting for events; call SDL_GetError() for more information. This also returns 0 if the timeout elapsed without an event arriving.

Code Examples

You can add your code example here

Remarks

If event is not NULL, the next event is removed from the queue and stored in the SDL_Event structure pointed to by event.

As this function implicitly calls SDL_PumpEvents(), you can only call this function in the thread that initialized the video subsystem.


CategoryAPI, CategoryEvents

None: SDL_WaitEventTimeout (last edited 2015-04-26 18:51:25 by PhilippWiesemann)

Feedback
Please include your contact information if you'd like to receive a reply.
Submit