Clarified the documentation for SDL_FlushEvents() so people know it only affects currently queued events.
authorSam Lantinga <slouken@libsdl.org>
Wed, 09 Jul 2014 01:34:40 -0700
changeset 9002 c1bd00f50724
parent 9001 c750aab87e82
child 9003 446ed0fe0fc3
Clarified the documentation for SDL_FlushEvents() so people know it only affects currently queued events.
include/SDL_events.h
--- a/include/SDL_events.h	Wed Jul 09 00:09:57 2014 -0400
+++ b/include/SDL_events.h	Wed Jul 09 01:34:40 2014 -0700
@@ -584,6 +584,9 @@
 
 /**
  *  This function clears events from the event queue
+ *  This function only affects currently queued events. If you want to make
+ *  sure that all pending OS events are flushed, you can call SDL_PumpEvents()
+ *  on the main thread immediately before the flush call.
  */
 extern DECLSPEC void SDLCALL SDL_FlushEvent(Uint32 type);
 extern DECLSPEC void SDLCALL SDL_FlushEvents(Uint32 minType, Uint32 maxType);