From dbeb915196149d957b8619a09019bff6fcb9b2bd Mon Sep 17 00:00:00 2001 From: Michael Richters Date: Sun, 30 May 2021 09:32:57 -0500 Subject: [PATCH] Add note about `afterReportingState()` to UPGRADING.md Signed-off-by: Michael Richters --- docs/UPGRADING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/UPGRADING.md b/docs/UPGRADING.md index ae3963a7..49b21c38 100644 --- a/docs/UPGRADING.md +++ b/docs/UPGRADING.md @@ -7,6 +7,7 @@ If any of this does not make sense to you, or you have trouble updating your .in * [Upgrade notes](#upgrade-notes) + [New features](#new-features) + - [New event handler](#new-event-handler) - [Event-driven main loop](#event-driven-main-loop) - [Keyboard state array](#keyboard-state-array) - [New build system](#new-build-system) @@ -37,6 +38,10 @@ any API we've included in a release. Typically, this means that any code that us ## New features +### New event handler + +One more `KeyEvent` handler has been added: `afterReportingState(const KeyEvent &event)`. This handler gets called after HID reports are sent for an event, providing a point for plugins to act after an event has been fully processed by `Runtime.handleKeyEvent()`. + ### Event-driven main loop Kaleidoscope's main loop has been rewritten. It now responds to key toggle-on and toggle-off events, dealing with one event at a time (and possibly more than one in a given cycle). Instead of sending a keyboard HID report at the end of every scan cycle (and letting the HID module suppress duplicates), it now only sends HID reports in response to input events.