summaryrefslogtreecommitdiffstats
path: root/docs/feature_macros.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2018-10-02 02:53:47 +0200
committerJack Humbert <jack.humb@gmail.com>2018-10-02 02:53:47 +0200
commit26f4e7031a643ce2760ae7b6df3bd2c79710451a (patch)
treeb678c4f87a6060c62b10a0bbee53dd70a771dfe4 /docs/feature_macros.md
parente885c793bcffcba03e18e93e41120b21cdfb6b75 (diff)
downloadqmk_firmware-26f4e7031a643ce2760ae7b6df3bd2c79710451a.tar.gz
qmk_firmware-26f4e7031a643ce2760ae7b6df3bd2c79710451a.tar.xz
Add tap_code function (#3784)
* Add tap_code * formatting * Doc clarification * Rename variable to make more consistent
Diffstat (limited to 'docs/feature_macros.md')
-rw-r--r--docs/feature_macros.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/feature_macros.md b/docs/feature_macros.md
index 673153081..ba5d91882 100644
--- a/docs/feature_macros.md
+++ b/docs/feature_macros.md
@@ -228,6 +228,10 @@ This sends the `<kc>` keydown event to the computer. Some examples would be `KC_
Parallel to `register_code` function, this sends the `<kc>` keyup event to the computer. If you don't use this, the key will be held down until it's sent.
+### `tap_code(<kc>);`
+
+This will send `register_code(<kc>)` and then `unregister_code(<kc>)`. This is useful if you want to send both the press and release events ("tap" the key, rather than hold it).
+
### `clear_keyboard();`
This will clear all mods and keys currently pressed.