summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2019-07-11 08:51:44 +0200
committerGitHub <noreply@github.com>2019-07-11 08:51:44 +0200
commit49ce6bacc338d4279c121e13d4c7434d4318e4e4 (patch)
tree080b277d7388f6d795a4429bbed08214026a3798
parent84fb8ac5d4a00f6f87ef9b89c6860ece8a7ae78d (diff)
parentf4e99e2e39b262e339bd7c1b47169ddf3c55f1a6 (diff)
Merge pull request #30504 from Calinou/input-mouse-captured-raw
doc: Mention `Input.MOUSE_MODE_CAPTURED` is raw on Windows and Linux
-rw-r--r--doc/classes/Input.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml
index efd8d33faf..bbf1ee186f 100644
--- a/doc/classes/Input.xml
+++ b/doc/classes/Input.xml
@@ -392,7 +392,7 @@
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.
+ 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.
</constant>
<constant name="MOUSE_MODE_CONFINED" value="3" enum="MouseMode">
Makes the mouse cursor visible but confines it to the game window.