From 898e93cd9a6f9efe2dafecb2ea5f58014e0514e0 Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Mon, 16 Feb 2015 14:30:13 +1000 Subject: [PATCH] tablet: spell out that we always include all values This behavior is intended and to save the caller from having to buffer all values. Signed-off-by: Peter Hutterer --- src/libinput.h | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/libinput.h b/src/libinput.h index 402877a9..a4413b67 100644 --- a/src/libinput.h +++ b/src/libinput.h @@ -1039,6 +1039,10 @@ libinput_event_tablet_axis_has_changed(struct libinput_event_tablet *event, * normalized value between -1 and 1 that indicates the X or Y tilt of the * tool * + * @note This function may be called for a specific axis even if + * libinput_event_tablet_axis_has_changed() returns 0 for that axis. + * libinput always includes all device axes in the event. + * * @param event The libinput tablet event * @param axis The axis to retrieve the value of * @return The current value of the the axis @@ -1053,6 +1057,10 @@ libinput_event_tablet_get_axis_value(struct libinput_event_tablet *event, * Return the current absolute x coordinate of the tablet event, transformed to * screen coordinates. * + * @note This function may be called for a specific axis even if + * libinput_event_tablet_axis_has_changed() returns 0 for that axis. + * libinput always includes all device axes in the event. + * * @param event The libinput tablet event * @param width The current output screen width * @return the current absolute x coordinate transformed to a screen coordinate @@ -1067,6 +1075,10 @@ libinput_event_tablet_get_x_transformed(struct libinput_event_tablet *event, * Return the current absolute y coordinate of the tablet event, transformed to * screen coordinates. * + * @note This function may be called for a specific axis even if + * libinput_event_tablet_axis_has_changed() returns 0 for that axis. + * libinput always includes all device axes in the event. + * * @param event The libinput tablet event * @param height The current output screen height * @return the current absolute y coordinate transformed to a screen coordinate