aboutsummaryrefslogtreecommitdiffstats
path: root/docs/feature_mouse_keys.md
diff options
context:
space:
mode:
authorfrancislan <francis.lan16@gmail.com>2020-03-13 09:49:44 -0700
committerGitHub <noreply@github.com>2020-03-13 12:49:44 -0400
commit3cd2a27ac0f963bc2023c3004f6f8eff0eb62a81 (patch)
treecb50af68f1c25943003ed12446822c599e607fdc /docs/feature_mouse_keys.md
parent28d94b72484967f12b521e87b2745bc24d792471 (diff)
downloadfirmware-3cd2a27ac0f963bc2023c3004f6f8eff0eb62a81.tar.gz
firmware-3cd2a27ac0f963bc2023c3004f6f8eff0eb62a81.tar.bz2
firmware-3cd2a27ac0f963bc2023c3004f6f8eff0eb62a81.zip
Decouple mouse cursor and mouse wheel in accelerated mode (#6685)
* Decouples mouse cursor and mouse wheel movements in accelerated mode. * Fixed comment indentation. * Updated docs Co-authored-by: Francis LAN <francislan@google.com>
Diffstat (limited to 'docs/feature_mouse_keys.md')
-rw-r--r--docs/feature_mouse_keys.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/feature_mouse_keys.md b/docs/feature_mouse_keys.md
index 363662f63..88a2c7c05 100644
--- a/docs/feature_mouse_keys.md
+++ b/docs/feature_mouse_keys.md
@@ -58,6 +58,8 @@ This is the default mode. You can adjust the cursor and scrolling acceleration u
|`MOUSEKEY_INTERVAL` |50 |Time between cursor movements |
|`MOUSEKEY_MAX_SPEED` |10 |Maximum cursor speed at which acceleration stops |
|`MOUSEKEY_TIME_TO_MAX` |20 |Time until maximum cursor speed is reached |
+|`MOUSEKEY_WHEEL_DELAY` |300 |Delay between pressing a wheel key and wheel movement |
+|`MOUSEKEY_WHEEL_INTERVAL` |100 |Time between wheel movements |
|`MOUSEKEY_WHEEL_MAX_SPEED` |8 |Maximum number of scroll steps per scroll action |
|`MOUSEKEY_WHEEL_TIME_TO_MAX`|40 |Time until maximum scroll speed is reached |
@@ -66,6 +68,7 @@ Tips:
* Setting `MOUSEKEY_DELAY` too low makes the cursor unresponsive. Setting it too high makes small movements difficult.
* For smoother cursor movements, lower the value of `MOUSEKEY_INTERVAL`. If the refresh rate of your display is 60Hz, you could set it to `16` (1/60). As this raises the cursor speed significantly, you may want to lower `MOUSEKEY_MAX_SPEED`.
* Setting `MOUSEKEY_TIME_TO_MAX` or `MOUSEKEY_WHEEL_TIME_TO_MAX` to `0` will disable acceleration for the cursor or scrolling respectively. This way you can make one of them constant while keeping the other accelerated, which is not possible in constant speed mode.
+* Setting `MOUSEKEY_WHEEL_INTERVAL` too low will make scrolling too fast. Setting it too high will make scrolling too slow when the wheel key is held down.
Cursor acceleration uses the same algorithm as the X Window System MouseKeysAccel feature. You can read more about it [on Wikipedia](https://en.wikipedia.org/wiki/Mouse_keys).