summaryrefslogtreecommitdiffstats
path: root/docs/feature_pointing_device.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2021-02-04 01:25:39 +0000
committerQMK Bot <hello@qmk.fm>2021-02-04 01:25:39 +0000
commit711388d3e380dd2bb4c8e3e060fa7a599722b83c (patch)
treeecf8b282ad40307676ec485f3b205cafdf663e1f /docs/feature_pointing_device.md
parent1861ace7d2d27ead04ee242cabd286e64c6d5f19 (diff)
parent780ca5565d2bdb8e03aa2669a3203373a0a4d9dd (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs/feature_pointing_device.md')
-rw-r--r--docs/feature_pointing_device.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/feature_pointing_device.md b/docs/feature_pointing_device.md
index c6d3560f31..905c2a8f95 100644
--- a/docs/feature_pointing_device.md
+++ b/docs/feature_pointing_device.md
@@ -27,6 +27,10 @@ Once you have made the necessary changes to the mouse report, you need to send i
When the mouse report is sent, the x, y, v, and h values are set to 0 (this is done in `pointing_device_send()`, which can be overridden to avoid this behavior). This way, button states persist, but movement will only occur once. For further customization, both `pointing_device_init` and `pointing_device_task` can be overridden.
+Additionally, by default, `pointing_device_send()` will only send a report when the report has actually changed. This prevents it from continuously sending mouse reports, which will keep the host system awake. This behavior can be changed by creating your own `pointing_device_send()` function.
+
+Also, you use the `has_mouse_report_changed(new, old)` function to check to see if the report has changed.
+
In the following example, a custom key is used to click the mouse and scroll 127 units vertically and horizontally, then undo all of that when released - because that's a totally useful function. Listen, this is an example:
```c