Wiki Page Content

Differences between revisions 6 and 8 (spanning 2 versions)
Revision 6 as of 2010-12-28 06:54:00
Size: 1117
Editor: SheenaSmith
Comment: minor change
Revision 8 as of 2013-08-08 23:17:35
Size: 903
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 16: Line 15:
||'''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^|| ||'''event'''||the [[SDL_Event]] structure to be filled in with the next event from the queue, or NULL||
Line 27: Line 26:
''You can add useful comments here''

<<Color2(green,Is this true in 1.3?)>>
*
As this function implicitly calls [[SDL_PumpEvents]](), you can only call this function in the thread that set the video mode. *
/!\As this function implicitly calls [[SDL_PumpEvents]](), you can only call this function in the thread that set the video mode.
Line 33: Line 29:
 .[[SDL_PollEvent]] *???
 .[[SDL_WaitEventTimeout]]???
 .[[SDL_PumpEvents]]
.[[SDL_PollEvent]]
 .[[SDL_WaitEventTimeout]]

SDL_WaitEvent

Use this function to wait indefinitely for the next available event.

Syntax

int SDL_WaitEvent(SDL_Event* event)

Function Parameters

event

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

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

Remarks

/!\As this function implicitly calls SDL_PumpEvents(), you can only call this function in the thread that set the video mode.


CategoryAPI, CategoryEvents

None: SDL_WaitEvent (last edited 2015-04-26 18:50:55 by PhilippWiesemann)

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