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

include: Added documentation to SDL_CaptureMouse about auto-capture.

This commit is contained in:
Ryan C. Gordon 2022-08-06 09:19:10 -04:00
parent a6179e85c0
commit e2452ede66
No known key found for this signature in database
GPG Key ID: FA148B892AB48044
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
include/SDL_mouse.h
View File

@ -245,6 +245,15 @@ extern DECLSPEC int SDLCALL SDL_SetRelativeMouseMode(SDL_bool enabled);
* While capturing is enabled, the current window will have the * While capturing is enabled, the current window will have the
* `SDL_WINDOW_MOUSE_CAPTURE` flag set. * `SDL_WINDOW_MOUSE_CAPTURE` flag set.
* *
* Please note that as of SDL 2.0.22, SDL will attempt to "auto capture"
* the mouse while the user is pressing a button; this is to try and make
* mouse behavior more consistent between platforms, and deal with the common
* case of a user dragging the mouse outside of the window. This means that
* if you are calling SDL_CaptureMouse() only to deal with this situation,
* you no longer have to (although it is safe to do so). If this causes
* problems for your app, you can disable auto capture by setting the
* `SDL_HINT_MOUSE_AUTO_CAPTURE` hint to zero.
*
* \param enabled SDL_TRUE to enable capturing, SDL_FALSE to disable. * \param enabled SDL_TRUE to enable capturing, SDL_FALSE to disable.
* \returns 0 on success or -1 if not supported; call SDL_GetError() for more * \returns 0 on success or -1 if not supported; call SDL_GetError() for more
* information. * information.