From f1ca7bd167d3f28cbdcc29004231d8c1f372a938 Mon Sep 17 00:00:00 2001 From: Sam Lantinga Date: Wed, 9 Jul 2014 01:34:40 -0700 Subject: [PATCH] Clarified the documentation for SDL_FlushEvents() so people know it only affects currently queued events. --- include/SDL_events.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/include/SDL_events.h b/include/SDL_events.h index 3bf604adb0786..21ef3b9565ac2 100644 --- 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);