aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_ps2_mouse.md
diff options
context:
space:
mode:
authorManna Harbour <51143715+manna-harbour@users.noreply.github.com>2020-07-03 06:54:15 +1000
committerGitHub <noreply@github.com>2020-07-02 21:54:15 +0100
commitb7dc2eb9ab2bb3c6ac9ac8e975728002e0e9d62d (patch)
treec711547dbd79f0dee916a7cf2e28f64ab0820645 /docs/feature_ps2_mouse.md
parent00fc35539d774c43cde383a8d2cc8b254787ce6c (diff)
downloadqmk_firmware-b7dc2eb9ab2bb3c6ac9ac8e975728002e0e9d62d.tar.gz
qmk_firmware-b7dc2eb9ab2bb3c6ac9ac8e975728002e0e9d62d.zip
Add movement hook to ps2_mouse (#8805)
Process mouse movement in the keymap before it is sent to the host. Example uses include filtering noise, adding acceleration, and automatically activating a layer. To use, define the following function in your keymap: void ps2_mouse_moved_user(report_mouse_t *mouse_report);
Diffstat (limited to 'docs/feature_ps2_mouse.md')
-rw-r--r--docs/feature_ps2_mouse.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/feature_ps2_mouse.md b/docs/feature_ps2_mouse.md
index c1bd8bff5..e54981085 100644
--- a/docs/feature_ps2_mouse.md
+++ b/docs/feature_ps2_mouse.md
@@ -294,3 +294,13 @@ To debug the mouse, add `debug_mouse = true` or enable via bootmagic.
294#define PS2_MOUSE_DEBUG_HID 294#define PS2_MOUSE_DEBUG_HID
295#define PS2_MOUSE_DEBUG_RAW 295#define PS2_MOUSE_DEBUG_RAW
296``` 296```
297
298### Movement Hook :id=movement-hook
299
300Process mouse movement in the keymap before it is sent to the host. Example
301uses include filtering noise, adding acceleration, and automatically activating
302a layer. To use, define the following function in your keymap:
303
304```c
305void ps2_mouse_moved_user(report_mouse_t *mouse_report);
306```