encounter
/
SDL
mirror of https://github.com/encounter/SDL.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation to reflect that a single SDL_PumpEvents() each frame is the recommended way to handle events

This commit is contained in:
Sam Lantinga 2021-10-14 19:10:30 -07:00
parent 88e9f7765c
commit ddf1d5c553
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
include/SDL_events.h
View File

@ -801,9 +801,8 @@ extern DECLSPEC void SDLCALL SDL_FlushEvents(Uint32 minType, Uint32 maxType);
* As this function implicitly calls SDL_PumpEvents(), you can only call this
* function in the thread that set the video mode.
*
* 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
* on an event to be posted.
* SDL_PollEvent() is deprecated as some sensors and mice with extremely high
* update rates can generate events each time this function is called.
*
* The common practice is to fully process the event queue once every frame,
* usually as a first step before updating the game's state:
@ -811,7 +810,8 @@ extern DECLSPEC void SDLCALL SDL_FlushEvents(Uint32 minType, Uint32 maxType);
* ```c
* while (game_is_still_running) {
* SDL_Event event;
* while (SDL_PollEvent(&event)) { // poll until all events are handled!
* SDL_PumpEvents();
* while (SDL_PeepEvents(&event, 1, SDL_GETEVENT, 0, SDL_LASTEVENT) == 1) { // poll until all events are handled!
* // decide what to do with this event.
* }
*