Wiki Page Content

Differences between revisions 1 and 9 (spanning 8 versions)
Revision 1 as of 2010-03-24 20:31:02
Size: 880
Editor: SheenaSmith
Comment: create page, add content (Rev 5540)
Revision 9 as of 2013-08-08 23:18:15
Size: 1028
Editor: RyanGordon
Comment: tweak
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 ||
<<Color2(green, SDL_Poll``Event said 'stored in event' from another author. Is that more accurate?)>>
||'''event'''||the [[SDL_Event]] structure to be filled in with the next event from the queue, or NULL||
Line 20: Line 18:
Returns 1, 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.
Line 28: Line 26:
''You can add useful comments here'' /!\As this function implicitly calls [[SDL_PumpEvents]](), you can only call this function in the thread that set the video mode.

If event is not NULL, the next event is removed from the queue and stored in the SDL_Event structure pointed to by event.
Line 31: Line 31:
 .[[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.

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


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