Sync SDL3 wiki -> header

This commit is contained in:
SDL Wiki Bot 2024-05-03 16:34:33 +00:00
parent 3979ea8ed0
commit 7559acaf75
1 changed files with 8 additions and 7 deletions

View File

@ -2995,21 +2995,22 @@ extern "C" {
#define SDL_HINT_VIDEO_WAYLAND_ALLOW_LIBDECOR "SDL_VIDEO_WAYLAND_ALLOW_LIBDECOR" #define SDL_HINT_VIDEO_WAYLAND_ALLOW_LIBDECOR "SDL_VIDEO_WAYLAND_ALLOW_LIBDECOR"
/** /**
* Enable or disable hidden mouse pointer warp emulation, needed by some older games. * Enable or disable hidden mouse pointer warp emulation, needed by some older
* games.
* *
* Wayland requires the pointer confinement protocol to warp the mouse, but * Wayland requires the pointer confinement protocol to warp the mouse, but
* that is just a hint that the compositor is free to ignore, and warping the * that is just a hint that the compositor is free to ignore, and warping the
* the pointer to or from regions outside of the focused window is prohibited. * the pointer to or from regions outside of the focused window is prohibited.
* When this hint is set and the pointer is hidden, SDL will emulate mouse warps * When this hint is set and the pointer is hidden, SDL will emulate mouse
* using relative mouse mode. This is required for some older games (such as Source * warps using relative mouse mode. This is required for some older games
* engine games), which warp the mouse to the centre of the screen rather than using * (such as Source engine games), which warp the mouse to the centre of the
* relative mouse motion. Note that relative mouse mode may have different mouse * screen rather than using relative mouse motion. Note that relative mouse
* acceleration behaviour than pointer warps. * mode may have different mouse acceleration behaviour than pointer warps.
* *
* 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 be made, if the appropriate protocol * - "0": Attempts to warp the mouse will be made, if the appropriate protocol
* is available. * is available.
* - "1": Some mouse warps will be emulated by forcing relative mouse mode. * - "1": Some mouse warps will be emulated by forcing relative mouse mode.
* *
* If not set, this is automatically enabled unless an application uses * If not set, this is automatically enabled unless an application uses