fdo-mirrors/libinput
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libinput/libinput.git synced 2026-01-10 02:10:17 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

tablet: spell out that we always include all values

Browse source 
This behavior is intended and to save the caller from having to buffer all
values.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
This commit is contained in:
Peter Hutterer 2015-02-16 14:30:13 +10:00
parent 1c3de35abb
commit 898e93cd9a
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
src/libinput.h
View file

@ -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