Add tap_code function (#3784)

* Add tap_code

* formatting

* Doc clarification

* Rename variable to make more consistent
master
Drashna Jaelre 2018-10-01 17:53:47 -07:00 committed by Jack Humbert
parent e885c793bc
commit 26f4e7031a
2 changed files with 5 additions and 0 deletions

View File

@ -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. 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();` ### `clear_keyboard();`
This will clear all mods and keys currently pressed. This will clear all mods and keys currently pressed.

View File

@ -88,6 +88,7 @@ void process_record(keyrecord_t *record);
void process_action(keyrecord_t *record, action_t action); void process_action(keyrecord_t *record, action_t action);
void register_code(uint8_t code); void register_code(uint8_t code);
void unregister_code(uint8_t code); void unregister_code(uint8_t code);
inline void tap_code(uint8_t code) { register_code(code); unregister_code(code); }
void register_mods(uint8_t mods); void register_mods(uint8_t mods);
void unregister_mods(uint8_t mods); void unregister_mods(uint8_t mods);
//void set_mods(uint8_t mods); //void set_mods(uint8_t mods);