Browse Source

Clarified the documentation for SDL_FlushEvents() so people know it only affects currently queued events.

Sam Lantinga 10 years ago
parent
commit
f1ca7bd167
1 changed files with 3 additions and 0 deletions
  1. 3 0
      include/SDL_events.h

+ 3 - 0
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);