From c664d780cc9e7e8234cdaface63f8ff93e7ebfb2 Mon Sep 17 00:00:00 2001
From: frsfnrrg <frsfnrrg@users.noreply.github.com>
Date: Fri, 1 Jun 2018 17:04:58 -0400
Subject: Comment to explain sway_shortcut_state lists
---
include/sway/input/keyboard.h | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/include/sway/input/keyboard.h b/include/sway/input/keyboard.h
index c9a8d514..e99a54b1 100644
--- a/include/sway/input/keyboard.h
+++ b/include/sway/input/keyboard.h
@@ -6,7 +6,20 @@
#define SWAY_KEYBOARD_PRESSED_KEYS_CAP 32
struct sway_shortcut_state {
+ /**
+ * A list of pressed key ids (either keysyms or keycodes),
+ * including duplicates when different keycodes produce the same key id.
+ *
+ * Each key id is associated with the keycode (in `pressed_keycodes`)
+ * whose press generated it, so that the key id can be removed on
+ * keycode release without recalculating the transient link between
+ * keycode and key id at the time of the key press.
+ */
uint32_t pressed_keys[SWAY_KEYBOARD_PRESSED_KEYS_CAP];
+ /**
+ * The list of keycodes associated to currently pressed key ids,
+ * including duplicates when a keycode generates multiple key ids.
+ */
uint32_t pressed_keycodes[SWAY_KEYBOARD_PRESSED_KEYS_CAP];
int last_key_index;
};
--
cgit v1.2.3