Skip to content

Commit

Permalink
protocol: add axis_source.wheel_tilt
Browse files Browse the repository at this point in the history 
Unlike a wheel rotation, a wheel tilt is a discrete-only axis. Wheel rotations
are mapped to degrees in libinput but that that does not apply to wheel tilt
axes where there is no physical equivalent.

Signed-off-by: Peter Hutterer <[email protected]>
Reviewed-by: Jonas Ådahl <[email protected]>
Acked-by: Daniel Stone <[email protected]>
Reviewed-by: Daniel Stone <[email protected]>
Reviewed-by: Yong Bakos <[email protected]>
  • Loading branch information
@whot @ppaalanen
whot authored and ppaalanen committed Jan 24, 2017
1 parent f8ab476 commit 2f72d0a
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 4 deletions.
10 changes: 8 additions & 2 deletions protocol/wayland.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1986,10 +1986,15 @@
finger. One example for this source is button-based scrolling where
the vertical motion of a device is converted to scroll events while
a button is held down.

The "wheel tilt" axis source indicates that the actual device is a
wheel but the scroll event is not caused by a rotation but a
(usually sideways) tilt of the wheel.
</description>
<entry name="wheel" value="0" summary="a physical wheel" />
<entry name="wheel" value="0" summary="a physical wheel rotation" />
<entry name="finger" value="1" summary="finger on a touch surface" />
<entry name="continuous" value="2" summary="continuous coordinate space"/>
<entry name="wheel_tilt" value="3" summary="a physical wheel tilt" since="6"/>
</enum>

<event name="axis_source" since="5">
Expand All @@ -2004,7 +2009,8 @@
wl_pointer.axis_source.finger, a wl_pointer.axis_stop event will be
sent when the user lifts the finger off the device.

If the source is wl_pointer axis_source.wheel or
If the source is wl_pointer.axis_source.wheel,
wl_pointer.axis_source.wheel_tilt or
wl_pointer.axis_source.continuous, a wl_pointer.axis_stop event may
or may not be sent. Whether a compositor sends an axis_stop event
for these sources is hardware-specific and implementation-dependent;
Expand Down
16 changes: 15 additions & 1 deletion tests/data/example-client.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4035,6 +4035,10 @@ enum wl_pointer_axis {
* finger. One example for this source is button-based scrolling where
* the vertical motion of a device is converted to scroll events while
* a button is held down.
*
* The "wheel tilt" axis source indicates that the actual device is a
* wheel but the scroll event is not caused by a rotation but a
* (usually sideways) tilt of the wheel.
*/
enum wl_pointer_axis_source {
/**
Expand All @@ -4049,7 +4053,16 @@ enum wl_pointer_axis_source {
* continuous coordinate space
*/
WL_POINTER_AXIS_SOURCE_CONTINUOUS = 2,
/**
* a physical wheel tilt
* @since 6
*/
WL_POINTER_AXIS_SOURCE_WHEEL_TILT = 3,
};
/**
* @ingroup iface_wl_pointer
*/
#define WL_POINTER_AXIS_SOURCE_WHEEL_TILT_SINCE_VERSION 6
#endif /* WL_POINTER_AXIS_SOURCE_ENUM */

/**
Expand Down Expand Up @@ -4216,7 +4229,8 @@ struct wl_pointer_listener {
* is wl_pointer.axis_source.finger, a wl_pointer.axis_stop event
* will be sent when the user lifts the finger off the device.
*
* If the source is wl_pointer axis_source.wheel or
* If the source is wl_pointer.axis_source.wheel,
* wl_pointer.axis_source.wheel_tilt or
* wl_pointer.axis_source.continuous, a wl_pointer.axis_stop event
* may or may not be sent. Whether a compositor sends an axis_stop
* event for these sources is hardware-specific and
Expand Down
13 changes: 13 additions & 0 deletions tests/data/example-server.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3244,6 +3244,10 @@ enum wl_pointer_axis {
* finger. One example for this source is button-based scrolling where
* the vertical motion of a device is converted to scroll events while
* a button is held down.
*
* The "wheel tilt" axis source indicates that the actual device is a
* wheel but the scroll event is not caused by a rotation but a
* (usually sideways) tilt of the wheel.
*/
enum wl_pointer_axis_source {
/**
Expand All @@ -3258,7 +3262,16 @@ enum wl_pointer_axis_source {
* continuous coordinate space
*/
WL_POINTER_AXIS_SOURCE_CONTINUOUS = 2,
/**
* a physical wheel tilt
* @since 6
*/
WL_POINTER_AXIS_SOURCE_WHEEL_TILT = 3,
};
/**
* @ingroup iface_wl_pointer
*/
#define WL_POINTER_AXIS_SOURCE_WHEEL_TILT_SINCE_VERSION 6
#endif /* WL_POINTER_AXIS_SOURCE_ENUM */

/**
Expand Down
8 changes: 7 additions & 1 deletion tests/data/example.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1986,10 +1986,15 @@
finger. One example for this source is button-based scrolling where
the vertical motion of a device is converted to scroll events while
a button is held down.

The "wheel tilt" axis source indicates that the actual device is a
wheel but the scroll event is not caused by a rotation but a
(usually sideways) tilt of the wheel.
</description>
<entry name="wheel" value="0" summary="a physical wheel rotation" />
<entry name="finger" value="1" summary="finger on a touch surface" />
<entry name="continuous" value="2" summary="continuous coordinate space"/>
<entry name="wheel_tilt" value="3" summary="a physical wheel tilt" since="6"/>
</enum>

<event name="axis_source" since="5">
Expand All @@ -2004,7 +2009,8 @@
wl_pointer.axis_source.finger, a wl_pointer.axis_stop event will be
sent when the user lifts the finger off the device.

If the source is wl_pointer axis_source.wheel or
If the source is wl_pointer.axis_source.wheel,
wl_pointer.axis_source.wheel_tilt or
wl_pointer.axis_source.continuous, a wl_pointer.axis_stop event may
or may not be sent. Whether a compositor sends an axis_stop event
for these sources is hardware-specific and implementation-dependent;
Expand Down

0 comments on commit 2f72d0a

Please sign in to comment.