From d7065106ef87f8afb86387499325b698f1c754ce Mon Sep 17 00:00:00 2001
From: Michael Alexsander <michaelalexsander@protonmail.com>
Date: Fri, 21 Aug 2020 23:06:56 -0300
Subject: [PATCH] State how 'MOUSE_MODE_CAPTURED' actually works in the 'Input'
 docs

(cherry picked from commit 4f13a7f47f787abce9e608bdb15d30d97096cd29)
---
 doc/classes/Input.xml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml
index e699cb7896c..70d75e0479e 100644
--- a/doc/classes/Input.xml
+++ b/doc/classes/Input.xml
@@ -417,7 +417,8 @@
 			Makes the mouse cursor hidden if it is visible.
 		</constant>
 		<constant name="MOUSE_MODE_CAPTURED" value="2" enum="MouseMode">
-			Captures the mouse. The mouse will be hidden and unable to leave the game window, but it will still register movement and mouse button presses. On Windows and Linux, the mouse will use raw input mode, which means the reported movement will be unaffected by the OS' mouse acceleration settings.
+			Captures the mouse. The mouse will be hidden and its position locked at the center of the screen.
+			[b]Note:[/b] If you want to process the mouse's movement in this mode, you need to use [member InputEventMouseMotion.relative].
 		</constant>
 		<constant name="MOUSE_MODE_CONFINED" value="3" enum="MouseMode">
 			Makes the mouse cursor visible but confines it to the game window.