Mirrors_Framework/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2026-05-27 02:46:08 +08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

Removed misleading documentation for SDL_AppEvent()

Browse Source 
Fixes https://github.com/libsdl-org/SDL/issues/9731
This commit is contained in:
Sam Lantinga
2024-05-09 08:59:59 -07:00
parent 793622ff1c
commit 88fc529261
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/README-main-functions.md
+4 -4
View File
@@ -181,10 +181,10 @@ Next:
int SDL_AppEvent(void *appstate, const SDL_Event *event); int SDL_AppEvent(void *appstate, const SDL_Event *event);
``` ```
This will be called whenever an SDL event arrives, on the thread that runs This will be called whenever an SDL event arrives. Your app should not call
SDL_AppIterate. Your app should also not call SDL_PollEvent, SDL_PumpEvent, SDL_PollEvent, SDL_PumpEvent, etc, as SDL will manage all this for you. Return
etc, as SDL will manage all this for you. Return values are the same as from values are the same as from SDL_AppIterate(), so you can terminate in response
SDL_AppIterate(), so you can terminate in response to SDL_EVENT_QUIT, etc. to SDL_EVENT_QUIT, etc.
Finally: Finally: