Wiki Page Content

Differences between revisions 2 and 3
Revision 2 as of 2010-03-26 00:43:54
Size: 1118
Editor: SheenaSmith
Comment: in progress
Revision 3 as of 2010-03-31 15:45:23
Size: 1009
Editor: SheenaSmith
Comment: create page, add content (Wed Mar 10 ver)
Deletions are marked like this. Additions are marked like this.
Line 21: Line 21:
''Remove this section if there is no return value.
Many SDL functions use this standard text (remove if not applicable):''
Returns 0 on success, or a negative error code on failure; 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.
Line 34: Line 32:
 .[[SDL_OtherFunction]]  .[[SDL_WaitEvent]] ???
Line 37: Line 35:
[[CategoryAPI]], [[CategoryHeader]] [[CategoryAPI]], [[CategoryEvents]]



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


int SDL_WaitEventTimeout(SDL_Event* event,
                         int        timeout)

Function Parameters


if not NULL, the next event is removed from the queue and stored in that area '''event'''


the 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.

Code Examples

You can add your code example here


You can add useful comments here

CategoryAPI, CategoryEvents

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

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