mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-11-08 03:25:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

Browse Source
This commit is contained in:
SDL Wiki Bot
2024-07-25 23:58:09 +00:00
parent 66eb2ea443
commit a880410cb2
1 changed files with 11 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
include/SDL3/SDL_hints.h
View File

@@ -2194,22 +2194,24 @@ extern "C" {
* A variable controlling whether warping a hidden mouse cursor will activate * A variable controlling whether warping a hidden mouse cursor will activate
* relative mouse mode. * relative mouse mode.
* *
* When this hint is set and the mouse cursor is hidden, SDL will emulate mouse * When this hint is set and the mouse cursor is hidden, SDL will emulate
* warps using relative mouse mode. This can provide smoother and more reliable * mouse warps using relative mouse mode. This can provide smoother and more
* mouse motion for some older games, which continuously calculate the distance * reliable mouse motion for some older games, which continuously calculate
* travelled by the mouse pointer and warp it back to the center of the window, * the distance travelled by the mouse pointer and warp it back to the center
* rather than using relative mouse motion. * of the window, rather than using relative mouse motion.
* *
* Note that relative mouse mode may have different mouse acceleration behavior * Note that relative mouse mode may have different mouse acceleration
* than pointer warps. * behavior than pointer warps.
* *
* If your game or application needs to warp the mouse cursor while hidden for * If your game or application needs to warp the mouse cursor while hidden for
* other purposes, such as drawing a software cursor, it should disable this hint. * other purposes, such as drawing a software cursor, it should disable this
* hint.
* *
* The variable can be set to the following values: * The variable can be set to the following values:
* *
* - "0": Attempts to warp the mouse will always be made. * - "0": Attempts to warp the mouse will always be made.
* - "1": Some mouse warps will be emulated by forcing relative mouse mode. (default) * - "1": Some mouse warps will be emulated by forcing relative mouse mode.
* (default)
* *
* If not set, this is automatically enabled unless an application uses * If not set, this is automatically enabled unless an application uses
* relative mouse mode directly. * relative mouse mode directly.