aboutsummaryrefslogtreecommitdiff
path: root/docs/understanding_qmk.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2020-03-22 06:29:05 -0700
committerGitHub <noreply@github.com>2020-03-23 00:29:05 +1100
commit5117dff6a26aec4eca04fb9787b4f428884739bc (patch)
treeecc94acb888c3ed330c11008fa6324b1d73b12cc /docs/understanding_qmk.md
parente5d34fd084a7bdde0867749470b27c50e8144eb8 (diff)
downloadqmk_firmware-5117dff6a26aec4eca04fb9787b4f428884739bc.tar.gz
qmk_firmware-5117dff6a26aec4eca04fb9787b4f428884739bc.zip
Add Post Processing to process_record (#4892)
* Improve process_record system Code based on @colinta's * Rename and better handle functions * Fix incorrect function call to process_record_user * Add documentation for post_process_record * Add both get_event_keycode and get_record_keycode functions And add some comments about these functions * Update code format * Cleanup merge artifacts
Diffstat (limited to 'docs/understanding_qmk.md')
-rw-r--r--docs/understanding_qmk.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/understanding_qmk.md b/docs/understanding_qmk.md
index 81cedfcf5..939642425 100644
--- a/docs/understanding_qmk.md
+++ b/docs/understanding_qmk.md
@@ -162,6 +162,15 @@ The `process_record()` function itself is deceptively simple, but hidden within
162 162
163At any step during this chain of events a function (such as `process_record_kb()`) can `return false` to halt all further processing. 163At any step during this chain of events a function (such as `process_record_kb()`) can `return false` to halt all further processing.
164 164
165After this is called, `post_process_record()` is called, which can be used to handle additional cleanup that needs to be run after the keycode is normally handled.
166
167* [`void post_process_record(keyrecord_t *record)`]()
168 * [`void post_process_record_quantum(keyrecord_t *record)`]()
169 * [Map this record to a keycode]()
170 * [`void post_process_clicky(uint16_t keycode, keyrecord_t *record)`]()
171 * [`void post_process_record_kb(uint16_t keycode, keyrecord_t *record)`]()
172 * [`void post_process_record_user(uint16_t keycode, keyrecord_t *record)`]()
173
165<!-- 174<!--
166#### Mouse Handling 175#### Mouse Handling
167 176