From d89f4b3ae48a69873c31c31b7a66e463f5063a9b Mon Sep 17 00:00:00 2001
From: Sam Lantinga <[EMAIL REDACTED]>
Date: Sat, 24 Jul 2021 10:29:34 -0700
Subject: [PATCH] Note that mouse warping doesn't work over Microsoft Remote
Desktop
Fixes the documentation portion of bug https://github.com/libsdl-org/SDL/issues/4206
---
include/SDL_mouse.h | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/include/SDL_mouse.h b/include/SDL_mouse.h
index 2b0e6a2f9..6375c5f3a 100644
--- a/include/SDL_mouse.h
+++ b/include/SDL_mouse.h
@@ -150,6 +150,9 @@ extern DECLSPEC Uint32 SDLCALL SDL_GetRelativeMouseState(int *x, int *y);
*
* This function generates a mouse motion event.
*
+ * Note that this function will appear to succeed, but not actually move
+ * the mouse when used over Microsoft Remote Desktop.
+ *
* \param window the window to move the mouse into, or NULL for the current
* mouse focus
* \param x the x coordinate within the window
@@ -168,6 +171,9 @@ extern DECLSPEC void SDLCALL SDL_WarpMouseInWindow(SDL_Window * window,
* A failure of this function usually means that it is unsupported by a
* platform.
*
+ * Note that this function will appear to succeed, but not actually move
+ * the mouse when used over Microsoft Remote Desktop.
+ *
* \param x the x coordinate
* \param y the y coordinate
* \returns 0 on success or a negative error code on failure; call
@@ -186,6 +192,10 @@ extern DECLSPEC int SDLCALL SDL_WarpMouseGlobal(int x, int y);
* will try to report continuous motion in the current window. Only relative
* motion events will be delivered, the mouse position will not change.
*
+ * 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.
*
* \param enabled SDL_TRUE to enable relative mode, SDL_FALSE to disable.