From e2877acb89edcba93e3567e86082a1247e179008 Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Tue, 24 Jan 2017 14:58:17 +1000 Subject: [PATCH] Clarify the default 'off' position of a switch So we don't need to send an "off" event for every switch on startup. Signed-off-by: Peter Hutterer --- src/libinput.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/libinput.h b/src/libinput.h index f8b123a4..436923d4 100644 --- a/src/libinput.h +++ b/src/libinput.h @@ -601,7 +601,11 @@ libinput_tablet_pad_mode_group_get_user_data( /** * @ingroup device * - * The state of a switch. + * The state of a switch. The default state of a switch is @ref + * LIBINPUT_SWITCH_STATE_OFF and no event is sent to confirm a switch in the + * off position. If a switch is logically on during initialization, libinput + * sends an event of type @ref LIBINPUT_EVENT_SWITCH_TOGGLE with a state + * @ref LIBINPUT_SWITCH_STATE_ON. */ enum libinput_switch_state { LIBINPUT_SWITCH_STATE_OFF = 0,