aboutsummaryrefslogtreecommitdiff
path: root/docs/custom_quantum_functions.md
diff options
context:
space:
mode:
authorskullY <skullydazed@gmail.com>2017-07-03 01:30:36 -0700
committerskullY <skullydazed@gmail.com>2017-07-03 01:30:36 -0700
commitd8e29b53fe5d57f2102b77f0ce9932cdb8b021b2 (patch)
tree14dd7d4c51a3d0bb046acb29ad96ca2b5f76f55b /docs/custom_quantum_functions.md
parentea8df568f23b79eba13ef9e914d8b1ce94688858 (diff)
downloadqmk_firmware-d8e29b53fe5d57f2102b77f0ce9932cdb8b021b2.tar.gz
qmk_firmware-d8e29b53fe5d57f2102b77f0ce9932cdb8b021b2.zip
Update a bunch of docs
Diffstat (limited to 'docs/custom_quantum_functions.md')
-rw-r--r--docs/custom_quantum_functions.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/custom_quantum_functions.md b/docs/custom_quantum_functions.md
index 0d6def45b..c017c0cdb 100644
--- a/docs/custom_quantum_functions.md
+++ b/docs/custom_quantum_functions.md
@@ -34,9 +34,9 @@ enum my_keycodes {
34}; 34};
35``` 35```
36 36
37## Programming The Behavior Of A Keycode 37## Programming The Behavior Of Any Keycode
38 38
39When you want to override the behavior of an existing key, or define the behavior for a new key, you should use the `process_record_{kb,user}()` functions. These are called by QMK during key processing before the actual key event is handled. If these functions return `true` QMK will process the keycodes as usual. That can be handy for extending the functionality of a key rather than replacing it. If these functions return `false` QMK will skip the normal key handling, and it will be up you to send and key up or down events that are required. 39When you want to override the behavior of an existing key, or define the behavior for a new key, you should use the `process_record_kb()' and `process_record_user()` functions. These are called by QMK during key processing before the actual key event is handled. If these functions return `true` QMK will process the keycodes as usual. That can be handy for extending the functionality of a key rather than replacing it. If these functions return `false` QMK will skip the normal key handling, and it will be up you to send any key up or down events that are required.
40 40
41These function are called every time a key is pressed or released. 41These function are called every time a key is pressed or released.
42 42
@@ -57,7 +57,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
57 case KC_ENTER: 57 case KC_ENTER:
58 // Play a tone when enter is pressed 58 // Play a tone when enter is pressed
59 if (record->event.pressed) { 59 if (record->event.pressed) {
60 PLAY_NOTE_ARRAY(tone_enter); 60 PLAY_NOTE_ARRAY(tone_qwerty);
61 } 61 }
62 return true; // Let QMK send the enter press/release events 62 return true; // Let QMK send the enter press/release events
63 } 63 }