summaryrefslogtreecommitdiffstats
path: root/quantum/debounce.h
diff options
context:
space:
mode:
authorStefan Kerkmann <karlk90@pm.me>2022-07-07 10:00:40 +0200
committerGitHub <noreply@github.com>2022-07-07 10:00:40 +0200
commit8224f62806b66f0825b68fd8c00436ee57a28e9a (patch)
tree33e16a84a05073fd439e6a86f09631132a546794 /quantum/debounce.h
parentcca5d3532128a9d1aa2ab39405d935fc132c752d (diff)
Make debounce() signal changes in the cooked matrix as return value (#17554)
Diffstat (limited to 'quantum/debounce.h')
-rw-r--r--quantum/debounce.h16
1 files changed, 11 insertions, 5 deletions
diff --git a/quantum/debounce.h b/quantum/debounce.h
index 3532d9cd7b..a8629654c2 100644
--- a/quantum/debounce.h
+++ b/quantum/debounce.h
@@ -1,10 +1,16 @@
#pragma once
-// raw is the current key state
-// on entry cooked is the previous debounced state
-// on exit cooked is the current debounced state
-// changed is true if raw has changed since the last call
-void debounce(matrix_row_t raw[], matrix_row_t cooked[], uint8_t num_rows, bool changed);
+/**
+ * @brief Debounce raw matrix events according to the choosen debounce algorithm.
+ *
+ * @param raw The current key state
+ * @param cooked The debounced key state
+ * @param num_rows Number of rows to debounce
+ * @param changed True if raw has changed since the last call
+ * @return true Cooked has new keychanges after debouncing
+ * @return false Cooked is the same as before
+ */
+bool debounce(matrix_row_t raw[], matrix_row_t cooked[], uint8_t num_rows, bool changed);
void debounce_init(uint8_t num_rows);