aboutsummaryrefslogtreecommitdiffstats
path: root/docs/feature_ps2_mouse.md
diff options
context:
space:
mode:
authorGravatar Manna Harbour <51143715+manna-harbour@users.noreply.github.com>2020-04-09 18:29:27 +1000
committerGravatar GitHub <noreply@github.com>2020-04-09 01:29:27 -0700
commit07c75feba3f2c0b4baf1c230750483004e502020 (patch)
treeb07e03f3463b06077e9bfbfe6170fa3c67a2a1bd /docs/feature_ps2_mouse.md
parentb5aa5e4338750f6a7d969a30b2fe96f0f5382405 (diff)
downloadqmk_firmware-07c75feba3f2c0b4baf1c230750483004e502020.tar.gz
Add PS2_MOUSE_ROTATE to compensate for device orientation (#8650)
* Add PS2_MOUSE_ROTATE to compensate for device orientation * fixup! Add PS2_MOUSE_ROTATE to compensate for device orientation * Reformat with IndentPPDirectives: AfterHash as per #6316
Diffstat (limited to 'docs/feature_ps2_mouse.md')
-rw-r--r--docs/feature_ps2_mouse.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/feature_ps2_mouse.md b/docs/feature_ps2_mouse.md
index ce072fbe9..c1bd8bff5 100644
--- a/docs/feature_ps2_mouse.md
+++ b/docs/feature_ps2_mouse.md
@@ -266,6 +266,25 @@ To reverse the scroll axes you can put:
into config.h.
+### Rotate Mouse Axes :id=rotate-mouse-axes
+
+Transform the output of the device with a clockwise rotation of 90, 180, or 270
+degrees.
+
+When compensating for device orientation, rotate the output the same amount in
+the opposite direction. E.g. if the normal device orientation is considered to
+be North-facing, compensate as follows:
+
+```c
+#define PS2_MOUSE_ROTATE 270 /* Compensate for East-facing device orientation. */
+```
+```c
+#define PS2_MOUSE_ROTATE 180 /* Compensate for South-facing device orientation. */
+```
+```c
+#define PS2_MOUSE_ROTATE 90 /* Compensate for West-facing device orientation. */
+```
+
### Debug Settings :id=debug-settings
To debug the mouse, add `debug_mouse = true` or enable via bootmagic.