Sync SDL3 wiki -> header

This commit is contained in:
SDL Wiki Bot 2024-06-16 13:21:56 +00:00
parent ee559d51be
commit 65f0691866

View File

@ -2290,13 +2290,16 @@ extern "C" {
#define SDL_HINT_MOUSE_RELATIVE_WARP_MOTION "SDL_MOUSE_RELATIVE_WARP_MOTION"
/**
* \brief A variable controlling whether the hardware cursor stays visible when relative mode is active.
* A variable controlling whether the hardware cursor stays visible when
* relative mode is active.
*
* This variable can be set to the following values:
* "0" - The cursor will be hidden while relative mode is active (default)
* "1" - The cursor will remain visible while relative mode is active
* This variable can be set to the following values: "0" - The cursor will be
* hidden while relative mode is active (default) "1" - The cursor will remain
* visible while relative mode is active
*
* Note that for systems without raw hardware inputs, relative mode is implemented using warping, so the hardware cursor will visibly warp between frames if this is enabled on those systems.
* Note that for systems without raw hardware inputs, relative mode is
* implemented using warping, so the hardware cursor will visibly warp between
* frames if this is enabled on those systems.
*/
#define SDL_HINT_MOUSE_RELATIVE_CURSOR_VISIBLE "SDL_MOUSE_RELATIVE_CURSOR_VISIBLE"