Wiki Page Content

Differences between revisions 7 and 8
Revision 7 as of 2010-12-28 06:53:35
Size: 1118
Editor: SheenaSmith
Comment: minor change
Revision 8 as of 2013-08-08 23:22:45
Size: 1476
Editor: RyanGordon
Comment: Edited
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
||<tablewidth="100%" style="color: #FF0000;" :> DRAFT||
Line 5: Line 4:
= SDL_WaitEventTimeout = = SDL_WaitEvent =
Line 17: Line 16:
||'''event'''||,,if not NULL, the next event is removed from the queue and stored in that area,, ''-or-'' ^the [[SDL_Event]] structure to be filled in with the next event from the queue, or NULL^||
||'''timeout'''||^the number of milliseconds to wait for the next available event^||
||'''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||
Line 21: Line 20:
Returns 1 on success or 0 if there was an error while waiting for events; call [[SDL_GetError]]() for more information. 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.
Line 29: Line 28:
''You can add useful comments here'' 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 set the video mode.

As of SDL 2.0, this function does not put the application's process to sleep waiting for events; it polls for events in a loop internally. This may change in the future to improve power savings.
Line 32: Line 35:
 .[[SDL_PollEvent]] ???
 .[[SDL_WaitEvent]] ???
 .[[SDL_PumpEvents]]
.[[SDL_PollEvent]]
 .[[SDL_WaitEvent]]

SDL_WaitEvent

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 set the video mode.

As of SDL 2.0, this function does not put the application's process to sleep waiting for events; it polls for events in a loop internally. This may change in the future to improve power savings.


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