From 997808a945a36419fc005c1bc73ea9f0dd561ae2 Mon Sep 17 00:00:00 2001 From: Sam Lantinga Date: Fri, 30 Jan 2026 16:23:46 -0800 Subject: [PATCH] Updated SDL_PollEvent() documentation Fixes https://github.com/libsdl-org/sdlwiki/issues/911 (cherry picked from commit 63a95a4a4dbe039b83288b31b6d8e4f34cca12f4) --- include/SDL3/SDL_events.h | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/include/SDL3/SDL_events.h b/include/SDL3/SDL_events.h index 077c9d541c..d82a615f89 100644 --- a/include/SDL3/SDL_events.h +++ b/include/SDL3/SDL_events.h @@ -1256,15 +1256,13 @@ extern SDL_DECLSPEC void SDLCALL SDL_FlushEvents(Uint32 minType, Uint32 maxType) * Poll for currently pending events. * * If `event` is not NULL, the next event is removed from the queue and stored - * in the SDL_Event structure pointed to by `event`. The 1 returned refers to - * this event, immediately stored in the SDL Event structure -- not an event - * to follow. + * in the SDL_Event structure pointed to by `event`. * - * If `event` is NULL, it simply returns 1 if there is an event in the queue, + * If `event` is NULL, it simply returns true if there is an event in the queue, * but will not remove it from the queue. * * As this function may implicitly call SDL_PumpEvents(), you can only call - * this function in the thread that set the video mode. + * this function in the thread that initialized the video subsystem. * * SDL_PollEvent() is the favored way of receiving system events since it can * be done from the main loop and does not suspend the main loop while waiting