mirrors
/
SDL
mirror of https://github.com/libsdl-org/SDL
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

This commit is contained in:
SDL Wiki Bot 2024-08-06 15:00:23 +00:00
parent 627cb8acd0
commit 57fa3bc08e
2 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
include/SDL3/SDL_events.h
View File

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

10
include/SDL3/SDL_mouse.h
View File

@ -290,9 +290,10 @@ extern SDL_DECLSPEC int SDLCALL SDL_WarpMouseGlobal(float x, float y);
/** /**
* Set relative mouse mode for a window. * Set relative mouse mode for a window.
* *
* While the window has focus and relative mouse mode is enabled, the cursor is hidden, the mouse * While the window has focus and relative mouse mode is enabled, the cursor
* position is constrained to the window, and SDL will report continuous * is hidden, the mouse position is constrained to the window, and SDL will
* relative mouse motion even if the mouse is at the edge of the window. * report continuous relative mouse motion even if the mouse is at the edge of
* the window.
* *
* This function will flush any pending mouse motion for this window. * This function will flush any pending mouse motion for this window.
* *
@ -311,7 +312,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetWindowRelativeMouseMode(SDL_Window *windo
* Query whether relative mouse mode is enabled for a window. * Query whether relative mouse mode is enabled for a window.
* *
* \param window the window to query. * \param window the window to query.
* \returns SDL_TRUE if relative mode is enabled for a window or SDL_FALSE otherwise. * \returns SDL_TRUE if relative mode is enabled for a window or SDL_FALSE
* otherwise.
* *
* \since This function is available since SDL 3.0.0. * \since This function is available since SDL 3.0.0.
* *