summaryrefslogtreecommitdiff
path: root/src/libinput.h
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2020-05-18 11:47:29 +1000
committerPeter Hutterer <peter.hutterer@who-t.net>2020-05-21 07:29:44 +0000
commit4ff6d6e3171713f5168a5dc9ca02702a46797bcb (patch)
tree43708d098ffbbaee61eb49a820219c7570d8ef6c /src/libinput.h
parent152837f44a5863c68000d13ec89dc51631acc5d4 (diff)
Deprecate wheel tilt as separate axis source
This has never been supported through the stack. No device ever had the required MOUSE_WHEEL_TILT_VERTICAL/HORIZONTAL udev property set, so libinput never set the right axis source. Neither weston nor mutter added the code for it. Even if we added wheel tilt for devices now, it would break those devices. And the benefit we get from having those separate is miniscule at best. So let's do the long-term thing and just deprecate this axis source. The wheel tilt mouse test device remains in the test suite, with the udev properties set just to verify that we do indeed ignore those now. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Diffstat (limited to 'src/libinput.h')
-rw-r--r--src/libinput.h14
1 files changed, 6 insertions, 8 deletions
diff --git a/src/libinput.h b/src/libinput.h
index 5a19f79d..9570648c 100644
--- a/src/libinput.h
+++ b/src/libinput.h
@@ -272,6 +272,10 @@ enum libinput_pointer_axis_source {
* The event is caused by the tilting of a mouse wheel rather than
* its rotation. This method is commonly used on mice without
* separate horizontal scroll wheels.
+ *
+ * @deprecated This axis source is deprecated as of libinput 1.16.
+ * It was never used by any device before libinput 1.16. All wheel
+ * tilt devices use @ref LIBINPUT_POINTER_AXIS_SOURCE_WHEEL instead.
*/
LIBINPUT_POINTER_AXIS_SOURCE_WHEEL_TILT,
};
@@ -1472,14 +1476,8 @@ libinput_event_pointer_get_axis_value(struct libinput_event_pointer *event,
* The coordinate system is identical to the cursor movement, i.e. a
* scroll value of 1 represents the equivalent relative motion of 1.
*
- * If the source is @ref LIBINPUT_POINTER_AXIS_SOURCE_WHEEL_TILT, no
- * terminating event is guaranteed (though it may happen).
- * Scrolling is in discrete steps and there is no physical equivalent for
- * the value returned here. For backwards compatibility, the value returned
- * by this function is identical to a single mouse wheel rotation by this
- * device (see the documentation for @ref LIBINPUT_POINTER_AXIS_SOURCE_WHEEL
- * above). Callers should not use this value but instead exclusively refer
- * to the value returned by libinput_event_pointer_get_axis_value_discrete().
+ * @deprecated The source @ref LIBINPUT_POINTER_AXIS_SOURCE_WHEEL_TILT is
+ * deprecated as of libinput 1.16. No device has ever sent this source.
*
* For pointer events that are not of type @ref LIBINPUT_EVENT_POINTER_AXIS,
* this function returns 0.