aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDrashna Jaelre <[email protected]>2024-03-09 21:34:41 -0800
committerGitHub <[email protected]>2024-03-10 05:34:41 +0000
commitc0dbe9a33662a651fb91afb2e4810bae3f6a825e (patch)
tree468357a8433820dac27585d147e82c83b4bc6c9f /docs
parent9f4a9d5826dde903aa0dcec3264cbf192b5044da (diff)
downloadqmk_firmware-c0dbe9a33662a651fb91afb2e4810bae3f6a825e.tar.gz
qmk_firmware-c0dbe9a33662a651fb91afb2e4810bae3f6a825e.zip
Add utility functions for Pointing Device Auto Mouse feature (#23144)
* Make is_auto_mouse_active() available globally * Add mouse key tracker functions for auto mouse layer
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_pointing_device.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/feature_pointing_device.md b/docs/feature_pointing_device.md
index b091dec08b..f55b308286 100644
--- a/docs/feature_pointing_device.md
+++ b/docs/feature_pointing_device.md
@@ -780,6 +780,9 @@ There are several functions that allow for more advanced interaction with the au
| `get_auto_mouse_timeout(void)` | Return the current timeout for turing off the layer | | `uint16_t` |
| `set_auto_mouse_debounce(uint16_t timeout)` | Change/set the debounce for preventing layer activation | | `void`(None) |
| `get_auto_mouse_debounce(void)` | Return the current debounce for preventing layer activation | | `uint8_t` |
+| `is_auto_mouse_active(void)` | Returns the active state of the auto mouse layer (eg if the layer has been triggered)| | `bool` |
+| `get_auto_mouse_key_tracker(void)` | Gets the current count for the auto mouse key tracker. | | `int8_t` |
+| `set_auto_mouse_key_tracker(int8_t key_tracker)` | Sets/Overrides the current count for the auto mouse key tracker. | | `void`(None) |
_NOTES:_
- _Due to the nature of how some functions work, the `auto_mouse_trigger_reset`, and `auto_mouse_layer_off` functions should never be called in the `layer_state_set_*` stack as this can cause indefinite loops._