Fixed the documentation for SDL_SetRelativeMouseMode()

(cherry picked from commit fb0c3197e0e4696551822815bdce0e187a0b06fc)
This commit is contained in:
Sam Lantinga 2023-03-08 22:32:54 -08:00
parent 8f7427c158
commit d9c07d9ef7

View file

@ -198,13 +198,9 @@ extern DECLSPEC int SDLCALL SDL_WarpMouseGlobal(int x, int y);
/** /**
* Set relative mouse mode. * Set relative mouse mode.
* *
* While the mouse is in relative mode, the cursor is hidden, and the driver * While the mouse is in relative mode, the cursor is hidden, the mouse
* will try to report continuous motion in the current window. Only relative * position is constrained to the window, and SDL will report continuous
* motion events will be delivered, the mouse position will not change. * relative mouse motion even if the mouse is at the edge of the window.
*
* Note that this function will not be able to provide continuous relative
* motion when used over Microsoft Remote Desktop, instead motion is limited
* to the bounds of the screen.
* *
* This function will flush any pending mouse motion. * This function will flush any pending mouse motion.
* *