aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon Ser <contact@emersion.fr>2024-02-02 13:22:31 +0100
committerSimon Ser <contact@emersion.fr>2024-02-02 17:52:56 +0100
commita8aeadeab2820e670316ddae3e0da0d6815dd253 (patch)
treef38cfb1299747783f29276c09c5310e65efc4190
parent967e788bc841bae395b115cd95a349dd6b158f10 (diff)
switch: add docs
-rw-r--r--include/wlr/types/wlr_switch.h8
1 files changed, 7 insertions, 1 deletions
diff --git a/include/wlr/types/wlr_switch.h b/include/wlr/types/wlr_switch.h
index b560f0ba..641df199 100644
--- a/include/wlr/types/wlr_switch.h
+++ b/include/wlr/types/wlr_switch.h
@@ -15,13 +15,19 @@
struct wlr_switch_impl;
+/**
+ * A switch input device. Typically a switch input device can indicate whether
+ * a laptop lid is opened or closed, or whether tablet mode is enabled.
+ *
+ * See https://wayland.freedesktop.org/libinput/doc/latest/switches.html
+ */
struct wlr_switch {
struct wlr_input_device base;
const struct wlr_switch_impl *impl;
struct {
- struct wl_signal toggle;
+ struct wl_signal toggle; // struct wlr_switch_toggle_event
} events;
void *data;