eden-emu/SDL
18
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added documentation for mouse handling in relative mode

Browse source 
Fixes https://github.com/libsdl-org/SDL/issues/11805
This commit is contained in:
Sam Lantinga 2025-01-13 09:49:03 -08:00
parent 438075a83a
commit 66408308b8
1 changed files with 2 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
include/SDL3/SDL_mouse.h
View file

@ -359,6 +359,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WarpMouseGlobal(float x, float y);
* report continuous relative mouse motion even if the mouse is at the edge of
* the window.
*
* If you'd like to keep the mouse position fixed while in relative mode you can use SDL_SetWindowMouseRect(). If you'd like the cursor to be at a specific location when relative mode ends, you should use SDL_WarpMouseInWindow() before disabling relative mode.
*
* This function will flush any pending mouse motion for this window.
*
* \param window the window to change.