Clarified the documentation for SDL_FlushEvents() so people know it o…

…nly affects currently queued events.
libsdl-org · Jul 9, 2014 · f1ca7bd · f1ca7bd
1 parent f7461cd
commit f1ca7bd
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/include/SDL_events.h b/include/SDL_events.h
@@ -584,6 +584,9 @@ extern DECLSPEC SDL_bool SDLCALL SDL_HasEvents(Uint32 minType, Uint32 maxType);
 
 /**
  *  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);