diff options
| author | nathanvercaemert <50712356+nathanvercaemert@users.noreply.github.com> | 2020-07-20 19:28:38 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-07-21 09:28:38 +1000 |
| commit | 19006c9753e490bf5e0136e59476530e345c4a8a (patch) | |
| tree | d5987c7781242d613a275527ab0d1a8ecc0a9bb6 /docs/feature_mouse_keys.md | |
| parent | 2e08c72e956748996544a0c3071632427994ed67 (diff) | |
Implemented New MK_COMBINED Functionality (#9557)
* implemented new mousekey_combined functionality
* minor formatting change to documentation
* Update tmk_core/common/mousekey.c
Co-authored-by: Ryan <fauxpark@gmail.com>
* Update tmk_core/common/mousekey.c
Co-authored-by: Ryan <fauxpark@gmail.com>
* Update tmk_core/common/mousekey.c
Co-authored-by: Ryan <fauxpark@gmail.com>
* Update tmk_core/common/mousekey.c
Co-authored-by: Ryan <fauxpark@gmail.com>
* Update docs/feature_mouse_keys.md
Co-authored-by: Nick Brassel <nick@tzarc.org>
* Update docs/feature_mouse_keys.md
Co-authored-by: Nick Brassel <nick@tzarc.org>
* Update docs/feature_mouse_keys.md
Co-authored-by: Nick Brassel <nick@tzarc.org>
* Update docs/feature_mouse_keys.md
Co-authored-by: Nick Brassel <nick@tzarc.org>
Co-authored-by: Nathan Vercaemert <nathan.vercaemert@gmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Nick Brassel <nick@tzarc.org>
Diffstat (limited to 'docs/feature_mouse_keys.md')
| -rw-r--r-- | docs/feature_mouse_keys.md | 22 |
1 files changed, 21 insertions, 1 deletions
diff --git a/docs/feature_mouse_keys.md b/docs/feature_mouse_keys.md index 88a2c7c05e..a6b46bc151 100644 --- a/docs/feature_mouse_keys.md +++ b/docs/feature_mouse_keys.md @@ -39,10 +39,11 @@ In your keymap you can use the following keycodes to map key presses to mouse ac ## Configuring mouse keys -Mouse keys supports two different modes to move the cursor: +Mouse keys supports three different modes to move the cursor: * **Accelerated (default):** Holding movement keys accelerates the cursor until it reaches its maximum speed. * **Constant:** Holding movement keys moves the cursor at constant speeds. +* **Combined:** Holding movement keys accelerates the cursor until it reaches its maximum speed, but holding acceleration and movement keys simultaneously moves the cursor at constant speeds. The same principle applies to scrolling. @@ -120,3 +121,22 @@ Use the following settings if you want to adjust cursor movement or scrolling: |`MK_W_INTERVAL_1` |120 |Time between scroll steps (`KC_ACL1`) | |`MK_W_OFFSET_2` |1 |Scroll steps per scroll action (`KC_ACL2`) | |`MK_W_INTERVAL_2` |20 |Time between scroll steps (`KC_ACL2`) | + +### Combined mode + +This mode functions like **Accelerated** mode, however, you can hold `KC_ACL0`, `KC_ACL1` and `KC_ACL2` +to momentarily (while held) set the cursor and scroll speeds to constant speeds. When no acceleration +keys are held, this mode is identical to **Accelerated** mode, and can be modified using all of the +relevant settings. + +* **KC_ACL0:** This acceleration sets your cursor to the slowest possible speed. This is useful for very +small and detailed movements of the cursor. +* **KC_ACL1:** This acceleration sets your cursor to half the maximum (user defined) speed. +* **KC_ACL2:** This acceleration sets your cursor to the maximum (computer defined) speed. This is +useful for moving the cursor large distances without much accuracy. + +To use constant speed mode, you must at least define `MK_COMBINED` in your keymap’s `config.h` file: + +```c +#define MK_COMBINED +``` |