|
@@ -1218,8 +1218,9 @@ extern SDL_DECLSPEC int SDLCALL SDL_PushEvent(SDL_Event *event);
|
|
|
* \param userdata what was passed as `userdata` to SDL_SetEventFilter() or
|
|
|
* SDL_AddEventWatch, etc.
|
|
|
* \param event the event that triggered the callback.
|
|
|
- * \returns SDL_TRUE to permit event to be added to the queue, and SDL_FALSE to disallow it.
|
|
|
- * When used with SDL_AddEventWatch, the return value is ignored.
|
|
|
+ * \returns SDL_TRUE to permit event to be added to the queue, and SDL_FALSE
|
|
|
+ * to disallow it. When used with SDL_AddEventWatch, the return value
|
|
|
+ * is ignored.
|
|
|
*
|
|
|
* \threadsafety SDL may call this callback at any time from any thread; the
|
|
|
* application is responsible for locking resources the callback
|
|
@@ -1236,10 +1237,10 @@ typedef SDL_bool (SDLCALL *SDL_EventFilter)(void *userdata, SDL_Event *event);
|
|
|
* Set up a filter to process all events before they change internal state and
|
|
|
* are posted to the internal event queue.
|
|
|
*
|
|
|
- * If the filter function returns SDL_TRUE when called, then the event will be added
|
|
|
- * to the internal queue. If it returns SDL_FALSE, then the event will be dropped from
|
|
|
- * the queue, but the internal state will still be updated. This allows
|
|
|
- * selective filtering of dynamically arriving events.
|
|
|
+ * If the filter function returns SDL_TRUE when called, then the event will be
|
|
|
+ * added to the internal queue. If it returns SDL_FALSE, then the event will
|
|
|
+ * be dropped from the queue, but the internal state will still be updated.
|
|
|
+ * This allows selective filtering of dynamically arriving events.
|
|
|
*
|
|
|
* **WARNING**: Be very careful of what you do in the event filter function,
|
|
|
* as it may run in a different thread!
|