浏览代码

Document that you can pass -1 to SDL_WaitEventTimeout() to wait indefinitely

Sam Lantinga 2 月之前
父节点
当前提交
19f70284ad
共有 1 个文件被更改,包括 1 次插入1 次删除
  1. 1 1
      include/SDL3/SDL_events.h

+ 1 - 1
include/SDL3/SDL_events.h

@@ -1343,7 +1343,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WaitEvent(SDL_Event *event);
  * \param event the SDL_Event structure to be filled in with the next event
  * \param event the SDL_Event structure to be filled in with the next event
  *              from the queue, or NULL.
  *              from the queue, or NULL.
  * \param timeoutMS the maximum number of milliseconds to wait for the next
  * \param timeoutMS the maximum number of milliseconds to wait for the next
- *                  available event.
+ *                  available event, or -1 to wait indefinitely.
  * \returns true if this got an event or false if the timeout elapsed without
  * \returns true if this got an event or false if the timeout elapsed without
  *          any events available.
  *          any events available.
  *
  *