River libinput configuration

configure libinput devices

This protocol exposes libinput device configuration APIs. The libinput documentation should be referred to for detailed information on libinput's behavior.

This protocol is designed so that (hopefully) any backwards compatible change to libinput's API can be matched with a backwards compatible change to this protocol.

Note: the libinput API uses floating point types (float and double in C) which are not (yet?) natively supported by the Wayland protocol. However, the Wayland protocol does support sending arbitrary bytes through the array argument type. This protocol uses e.g. type="array" summary="double" to indicate a native-endian IEEE-754 64-bit double value.

The key words "must", "must not", "required", "shall", "shall not", "should", "should not", "recommended", "may", and "optional" in this document are to be interpreted as described in IETF RFC 2119.

river_libinput_config_v1

version 1

libinput config global interface

Global interface for configuring libinput devices. This global should only be advertised if river_input_manager_v1 is advertised as well.

river_libinput_config_v1::stop

stop()

stop sending events

This request indicates that the client no longer wishes to receive events on this object.

The Wayland protocol is asynchronous, which means the server may send further events until the stop request is processed. The client must wait for a river_libinput_config_v1.finished event before destroying this object.

river_libinput_config_v1::destroy

Type: destructor

destroy()

destroy the river_libinput_config_v1 object

This request should be called after the finished event has been received to complete destruction of the object.

It is a protocol error to make this request before the finished event has been received.

If a client wishes to destroy this object it should send a river_libinput_config_v1.stop request and wait for a river_libinput_config_v1.finished event. Once the finished event is received it is safe to destroy this object and any other objects created through this interface.

river_libinput_config_v1::create_accel_config

create_accel_config(id: new_id<river_libinput_accel_config_v1>, profile: uint<river_libinput_device_v1.accel_profile>)

Argument	Type	Description
id	new_id<river_libinput_accel_config_v1>
profile	uint<river_libinput_device_v1.accel_profile>

create a acceleration config

Create a acceleration config which can be applied with river_libinput_device_v1.apply_accel_config.

river_libinput_config_v1::finished

finished()

the server has finished with the object

This event indicates that the server will send no further events on this object. The client should destroy the object. See river_libinput_config_v1.destroy for more information.

river_libinput_config_v1::libinput_device

libinput_device(id: new_id<river_libinput_device_v1>)

Argument	Type	Description
id	new_id<river_libinput_device_v1>

new libinput device

A new libinput device has been created. Not every river_input_device_v1 is necessarily a libinput device as well.

river_libinput_config_v1::error

error { invalid_arg, invalid_destroy }

Argument	Value	Description
invalid_arg	0	invalid enum value or similar
invalid_destroy	1

river_libinput_device_v1

version 1

a libinput device

In general, *_support events will be sent exactly once directly after the river_libinput_device_v1 is created. *_default events will be sent after *_support events if the config option is supported, and *_current events willl be sent after the *_default events and again whenever the config option is changed.

river_libinput_device_v1::destroy

Type: destructor

destroy()

destroy the libinput device object

This request indicates that the client will no longer use the input device object and that it may be safely destroyed.

river_libinput_device_v1::set_send_events

set_send_events(result: new_id<river_libinput_result_v1>, mode: uint<river_libinput_device_v1.send_events_modes>)

Argument	Type	Description
result	new_id<river_libinput_result_v1>
mode	uint<river_libinput_device_v1.send_events_modes>

set send events mode

Set the send events mode for the device.

river_libinput_device_v1::set_tap

set_tap(result: new_id<river_libinput_result_v1>, state: uint<river_libinput_device_v1.tap_state>)

Argument	Type	Description
result	new_id<river_libinput_result_v1>
state	uint<river_libinput_device_v1.tap_state>

enable/disable tap-to-click

Configure tap-to-click on this device, with a default mapping of 1, 2, 3 finger tap mapping to left, right, middle click, respectively.

river_libinput_device_v1::set_tap_button_map

set_tap_button_map(result: new_id<river_libinput_result_v1>, button_map: uint<river_libinput_device_v1.tap_button_map>)

Argument	Type	Description
result	new_id<river_libinput_result_v1>
button_map	uint<river_libinput_device_v1.tap_button_map>

set tap-to-click button map

Set the finger number to button number mapping for tap-to-click. The default mapping on most devices is to have a 1, 2 and 3 finger tap to map to the left, right and middle button, respectively.

river_libinput_device_v1::set_drag

set_drag(result: new_id<river_libinput_result_v1>, state: uint<river_libinput_device_v1.drag_state>)

Argument	Type	Description
result	new_id<river_libinput_result_v1>
state	uint<river_libinput_device_v1.drag_state>

set tap-and-drag state

Configure tap-and-drag functionality on the device.

river_libinput_device_v1::set_drag_lock

set_drag_lock(result: new_id<river_libinput_result_v1>, state: uint<river_libinput_device_v1.drag_lock_state>)

Argument	Type	Description
result	new_id<river_libinput_result_v1>
state	uint<river_libinput_device_v1.drag_lock_state>

set drag lock state

Configure drag-lock during tapping on this device. When enabled, a finger may be lifted and put back on the touchpad and the drag process continues. A timeout for lifting the finger is optional. When disabled, lifting the finger during a tap-and-drag will immediately stop the drag. See the libinput documentation for more details.

river_libinput_device_v1::set_three_finger_drag

set_three_finger_drag(result: new_id<river_libinput_result_v1>, state: uint<river_libinput_device_v1.three_finger_drag_state>)

Argument	Type	Description
result	new_id<river_libinput_result_v1>
state	uint<river_libinput_device_v1.three_finger_drag_state>

set three finger drag state

Configure three finger drag functionality for the device.

river_libinput_device_v1::set_calibration_matrix

set_calibration_matrix(result: new_id<river_libinput_result_v1>, matrix: array)

Argument	Type	Description
result	new_id<river_libinput_result_v1>
matrix	array	array of 6 floats

set calibration matrix

Set calibration matrix.

river_libinput_device_v1::set_accel_profile

set_accel_profile(result: new_id<river_libinput_result_v1>, profile: uint<river_libinput_device_v1.accel_profile>)

Argument	Type	Description
result	new_id<river_libinput_result_v1>
profile	uint<river_libinput_device_v1.accel_profile>

set send events mode

Set the acceleration profile.

river_libinput_device_v1::set_accel_speed

set_accel_speed(result: new_id<river_libinput_result_v1>, speed: array)

Argument	Type	Description
result	new_id<river_libinput_result_v1>
speed	array	double

set acceleration speed

Set the acceleration speed within a range of [-1, 1], where 0 is the default acceleration for this device, -1 is the slowest acceleration and 1 is the maximum acceleration available on this device.

river_libinput_device_v1::apply_accel_config

apply_accel_config(result: new_id<river_libinput_result_v1>, config: object<river_libinput_accel_config_v1>)

Argument	Type	Description
result	new_id<river_libinput_result_v1>
config	object<river_libinput_accel_config_v1>

apply acceleration config

Apply a pointer accleration config.

river_libinput_device_v1::set_natural_scroll

set_natural_scroll(result: new_id<river_libinput_result_v1>, state: uint<river_libinput_device_v1.natural_scroll_state>)

Argument	Type	Description
result	new_id<river_libinput_result_v1>
state	uint<river_libinput_device_v1.natural_scroll_state>

set natural scroll state

Set natural scroll state.

river_libinput_device_v1::set_left_handed

set_left_handed(result: new_id<river_libinput_result_v1>, state: uint<river_libinput_device_v1.left_handed_state>)

Argument	Type	Description
result	new_id<river_libinput_result_v1>
state	uint<river_libinput_device_v1.left_handed_state>

set left-handed mode state

Set left-handed mode state.

river_libinput_device_v1::set_click_method

set_click_method(result: new_id<river_libinput_result_v1>, method: uint<river_libinput_device_v1.click_method>)

Argument	Type	Description
result	new_id<river_libinput_result_v1>
method	uint<river_libinput_device_v1.click_method>

set click method

Set click method.

river_libinput_device_v1::set_clickfinger_button_map

set_clickfinger_button_map(result: new_id<river_libinput_result_v1>, button_map: uint<river_libinput_device_v1.clickfinger_button_map>)

Argument	Type	Description
result	new_id<river_libinput_result_v1>
button_map	uint<river_libinput_device_v1.clickfinger_button_map>

set clickfinger button map

Set clickfinger button map. Supported if click_methods.clickfinger is supported.

river_libinput_device_v1::set_middle_emulation

set_middle_emulation(result: new_id<river_libinput_result_v1>, state: uint<river_libinput_device_v1.middle_emulation_state>)

Argument	Type	Description
result	new_id<river_libinput_result_v1>
state	uint<river_libinput_device_v1.middle_emulation_state>

set middle mouse button emulation state

Set middle mouse button emulation state.

river_libinput_device_v1::set_scroll_method

set_scroll_method(result: new_id<river_libinput_result_v1>, method: uint<river_libinput_device_v1.scroll_method>)

Argument	Type	Description
result	new_id<river_libinput_result_v1>
method	uint<river_libinput_device_v1.scroll_method>

set scroll method

Set scroll method.

river_libinput_device_v1::set_scroll_button

set_scroll_button(result: new_id<river_libinput_result_v1>, button: uint)

Argument	Type	Description
result	new_id<river_libinput_result_v1>
button	uint

set scroll button

Set scroll button. Supported if scroll_methods.on_button_down is supported.

river_libinput_device_v1::set_scroll_button_lock

set_scroll_button_lock(result: new_id<river_libinput_result_v1>, state: uint<river_libinput_device_v1.scroll_button_lock_state>)

Argument	Type	Description
result	new_id<river_libinput_result_v1>
state	uint<river_libinput_device_v1.scroll_button_lock_state>

set scroll button lock state

Set scroll button lock state. Supported if scroll_methods.on_button_down is supported.

river_libinput_device_v1::set_dwt

set_dwt(result: new_id<river_libinput_result_v1>, state: uint<river_libinput_device_v1.dwt_state>)

Argument	Type	Description
result	new_id<river_libinput_result_v1>
state	uint<river_libinput_device_v1.dwt_state>

set disable-while-typing state

Set disable-while-typing state.

river_libinput_device_v1::set_dwtp

set_dwtp(result: new_id<river_libinput_result_v1>, state: uint<river_libinput_device_v1.dwtp_state>)

Argument	Type	Description
result	new_id<river_libinput_result_v1>
state	uint<river_libinput_device_v1.dwtp_state>

set disable-while-trackpointing state

Set disable-while-trackpointing state.

river_libinput_device_v1::set_rotation

set_rotation(result: new_id<river_libinput_result_v1>, angle: uint)

Argument	Type	Description
result	new_id<river_libinput_result_v1>
angle	uint

set rotation angle

Set rotation angle in degrees clockwise off the logical neutral position. Angle must be in the range [0-360).

river_libinput_device_v1::removed

removed()

the libinput device is removed

This event indicates that the libinput device has been removed.

The server will send no further events on this object and ignore any request (other than river_libinput_device_v1.destroy) made after this event is sent. The client should destroy this object with the river_libinput_device_v1.destroy request to free up resources.

river_libinput_device_v1::input_device

input_device(device: object<river_input_device_v1>)

Argument	Type	Description
device	object<river_input_device_v1>

corresponding river input device

The river_input_device_v1 corresponding to this libinput device. This event will always be the first event sent on the river_libinput_device_v1 object, and it will be sent exactly once.

river_libinput_device_v1::send_events_support

send_events_support(modes: uint<river_libinput_device_v1.send_events_modes>)

Argument	Type	Description
modes	uint<river_libinput_device_v1.send_events_modes>

supported send events modes

Supported send events modes.

river_libinput_device_v1::send_events_default

send_events_default(mode: uint<river_libinput_device_v1.send_events_modes>)

Argument	Type	Description
mode	uint<river_libinput_device_v1.send_events_modes>

default send events mode

Default send events mode.

river_libinput_device_v1::send_events_current

send_events_current(mode: uint<river_libinput_device_v1.send_events_modes>)

Argument	Type	Description
mode	uint<river_libinput_device_v1.send_events_modes>

current send events mode

Current send events mode.

river_libinput_device_v1::tap_support

tap_support(finger_count: int)

Argument	Type	Description
finger_count	int

tap-to-click/drag support

The number of fingers supported for tap-to-click/drag. If finger_count is 0, tap-to-click and drag are unsupported.

river_libinput_device_v1::tap_default

tap_default(state: uint<river_libinput_device_v1.tap_state>)

Argument	Type	Description
state	uint<river_libinput_device_v1.tap_state>

default tap-to-click state

Default tap-to-click state.

river_libinput_device_v1::tap_current

tap_current(state: uint<river_libinput_device_v1.tap_state>)

Argument	Type	Description
state	uint<river_libinput_device_v1.tap_state>

current tap-to-click state

Current tap-to-click state.

river_libinput_device_v1::tap_button_map_default

tap_button_map_default(button_map: uint<river_libinput_device_v1.tap_button_map>)

Argument	Type	Description
button_map	uint<river_libinput_device_v1.tap_button_map>

default tap-to-click button map

Default tap-to-click button map.

river_libinput_device_v1::tap_button_map_current

tap_button_map_current(button_map: uint<river_libinput_device_v1.tap_button_map>)

Argument	Type	Description
button_map	uint<river_libinput_device_v1.tap_button_map>

current tap-to-click button map

Current tap-to-click button map.

river_libinput_device_v1::drag_default

drag_default(state: uint<river_libinput_device_v1.drag_state>)

Argument	Type	Description
state	uint<river_libinput_device_v1.drag_state>

default tap-and-drag state

Default tap-and-drag state.

river_libinput_device_v1::drag_current

drag_current(state: uint<river_libinput_device_v1.drag_state>)

Argument	Type	Description
state	uint<river_libinput_device_v1.drag_state>

current tap-and-drag state

Current tap-and-drag state.

river_libinput_device_v1::drag_lock_default

drag_lock_default(state: uint<river_libinput_device_v1.drag_lock_state>)

Argument	Type	Description
state	uint<river_libinput_device_v1.drag_lock_state>

default drag lock state

Default drag lock state.

river_libinput_device_v1::drag_lock_current

drag_lock_current(state: uint<river_libinput_device_v1.drag_lock_state>)

Argument	Type	Description
state	uint<river_libinput_device_v1.drag_lock_state>

current drag lock state

Current drag lock state.

river_libinput_device_v1::three_finger_drag_support

three_finger_drag_support(finger_count: int)

Argument	Type	Description
finger_count	int

three finger drag support

The number of fingers supported for three/four finger drag. If finger_count is less than 3, three finger drag is unsupported.

river_libinput_device_v1::three_finger_drag_default

three_finger_drag_default(state: uint<river_libinput_device_v1.three_finger_drag_state>)

Argument	Type	Description
state	uint<river_libinput_device_v1.three_finger_drag_state>

default three finger drag state

Default three finger drag state.

river_libinput_device_v1::three_finger_drag_current

three_finger_drag_current(state: uint<river_libinput_device_v1.three_finger_drag_state>)

Argument	Type	Description
state	uint<river_libinput_device_v1.three_finger_drag_state>

current three finger drag state

Current three finger drag state.

river_libinput_device_v1::calibration_matrix_support

calibration_matrix_support(supported: int)

Argument	Type	Description
supported	int	boolean

support for a calibration matrix

A calibration matrix is supported if the supported argument is non-zero.

river_libinput_device_v1::calibration_matrix_default

calibration_matrix_default(matrix: array)

Argument	Type	Description
matrix	array	array of 6 floats

default calibration matrix

Default calibration matrix.

river_libinput_device_v1::calibration_matrix_current

calibration_matrix_current(matrix: array)

Argument	Type	Description
matrix	array	array of 6 floats

current calibration matrix

Current calibration matrix.

river_libinput_device_v1::accel_profiles_support

accel_profiles_support(profiles: uint<river_libinput_device_v1.accel_profiles>)

Argument	Type	Description
profiles	uint<river_libinput_device_v1.accel_profiles>

supported acceleration profiles

Supported acceleration profiles.

river_libinput_device_v1::accel_profile_default

accel_profile_default(profile: uint<river_libinput_device_v1.accel_profile>)

Argument	Type	Description
profile	uint<river_libinput_device_v1.accel_profile>

default acceleration profile

Default acceleration profile.

river_libinput_device_v1::accel_profile_current

accel_profile_current(profile: uint<river_libinput_device_v1.accel_profile>)

Argument	Type	Description
profile	uint<river_libinput_device_v1.accel_profile>

current send events mode

Current acceleration profile.

river_libinput_device_v1::accel_speed_default

accel_speed_default(speed: array)

Argument	Type	Description
speed	array	double

default acceleration speed

Default acceleration speed.

river_libinput_device_v1::accel_speed_current

accel_speed_current(speed: array)

Argument	Type	Description
speed	array	double

current acceleration speed

Current acceleration speed.

river_libinput_device_v1::natural_scroll_support

natural_scroll_support(supported: int)

Argument	Type	Description
supported	int	boolean

support for natural scroll

Natural scroll is supported if the supported argument is non-zero.

river_libinput_device_v1::natural_scroll_default

natural_scroll_default(state: uint<river_libinput_device_v1.natural_scroll_state>)

Argument	Type	Description
state	uint<river_libinput_device_v1.natural_scroll_state>

default natural scroll

Default natural scroll.

river_libinput_device_v1::natural_scroll_current

natural_scroll_current(state: uint<river_libinput_device_v1.natural_scroll_state>)

Argument	Type	Description
state	uint<river_libinput_device_v1.natural_scroll_state>

current natural scroll state

Current natural scroll.

river_libinput_device_v1::left_handed_support

left_handed_support(supported: int)

Argument	Type	Description
supported	int	boolean

support for left-handed mode

Left-handed mode is supported if the supported argument is non-zero.

river_libinput_device_v1::left_handed_default

left_handed_default(state: uint<river_libinput_device_v1.left_handed_state>)

Argument	Type	Description
state	uint<river_libinput_device_v1.left_handed_state>

default left-handed mode

Default left-handed mode.

river_libinput_device_v1::left_handed_current

left_handed_current(state: uint<river_libinput_device_v1.left_handed_state>)

Argument	Type	Description
state	uint<river_libinput_device_v1.left_handed_state>

current left-handed mode state

Current left-handed mode.

river_libinput_device_v1::click_method_support

click_method_support(methods: uint<river_libinput_device_v1.click_methods>)

Argument	Type	Description
methods	uint<river_libinput_device_v1.click_methods>

supported click methods

The click methods supported by the device.

river_libinput_device_v1::click_method_default

click_method_default(method: uint<river_libinput_device_v1.click_method>)

Argument	Type	Description
method	uint<river_libinput_device_v1.click_method>

default click method

Default click method.

river_libinput_device_v1::click_method_current

click_method_current(method: uint<river_libinput_device_v1.click_method>)

Argument	Type	Description
method	uint<river_libinput_device_v1.click_method>

current click method

Current click method.

river_libinput_device_v1::clickfinger_button_map_default

clickfinger_button_map_default(button_map: uint<river_libinput_device_v1.clickfinger_button_map>)

Argument	Type	Description
button_map	uint<river_libinput_device_v1.clickfinger_button_map>

default clickfinger button map

Default clickfinger button map. Supported if click_methods.clickfinger is supported.

river_libinput_device_v1::clickfinger_button_map_current

clickfinger_button_map_current(button_map: uint<river_libinput_device_v1.clickfinger_button_map>)

Argument	Type	Description
button_map	uint<river_libinput_device_v1.clickfinger_button_map>

current clickfinger button map

Current clickfinger button map. Supported if click_methods.clickfinger is supported.

river_libinput_device_v1::middle_emulation_support

middle_emulation_support(supported: int)

Argument	Type	Description
supported	int	boolean

support for middle mouse button emulation

Middle mouse button emulation is supported if the supported argument is non-zero.

river_libinput_device_v1::middle_emulation_default

middle_emulation_default(state: uint<river_libinput_device_v1.middle_emulation_state>)

Argument	Type	Description
state	uint<river_libinput_device_v1.middle_emulation_state>

default middle mouse button emulation

Default middle mouse button emulation.

river_libinput_device_v1::middle_emulation_current

middle_emulation_current(state: uint<river_libinput_device_v1.middle_emulation_state>)

Argument	Type	Description
state	uint<river_libinput_device_v1.middle_emulation_state>

current middle mouse button emulation state

Current middle mouse button emulation.

river_libinput_device_v1::scroll_method_support

scroll_method_support(methods: uint<river_libinput_device_v1.scroll_methods>)

Argument	Type	Description
methods	uint<river_libinput_device_v1.scroll_methods>

supported scroll methods

The scroll methods supported by the device.

river_libinput_device_v1::scroll_method_default

scroll_method_default(method: uint<river_libinput_device_v1.scroll_method>)

Argument	Type	Description
method	uint<river_libinput_device_v1.scroll_method>

default scroll method

Default scroll method.

river_libinput_device_v1::scroll_method_current

scroll_method_current(method: uint<river_libinput_device_v1.scroll_method>)

Argument	Type	Description
method	uint<river_libinput_device_v1.scroll_method>

current scroll method

Current scroll method.

river_libinput_device_v1::scroll_button_default

scroll_button_default(button: uint)

Argument	Type	Description
button	uint

default scroll button

Default scroll button. Supported if scroll_methods.on_button_down is supported.

river_libinput_device_v1::scroll_button_current

scroll_button_current(button: uint)

Argument	Type	Description
button	uint

current scroll button

Current scroll button. Supported if scroll_methods.on_button_down is supported.

river_libinput_device_v1::scroll_button_lock_default

scroll_button_lock_default(state: uint<river_libinput_device_v1.scroll_button_lock_state>)

Argument	Type	Description
state	uint<river_libinput_device_v1.scroll_button_lock_state>

default scroll button lock state

Default scroll button lock state. Supported if scroll_methods.on_button_down is supported.

river_libinput_device_v1::scroll_button_lock_current

scroll_button_lock_current(state: uint<river_libinput_device_v1.scroll_button_lock_state>)

Argument	Type	Description
state	uint<river_libinput_device_v1.scroll_button_lock_state>

current scroll button lock state

Current scroll button lock state. Supported if scroll_methods.on_button_down is supported.

river_libinput_device_v1::dwt_support

dwt_support(supported: int)

Argument	Type	Description
supported	int	boolean

support for disable-while-typing

Disable-while-typing is supported if the supported argument is non-zero.

river_libinput_device_v1::dwt_default

dwt_default(state: uint<river_libinput_device_v1.dwt_state>)

Argument	Type	Description
state	uint<river_libinput_device_v1.dwt_state>

default disable-while-typing state

Default disable-while-typing state.

river_libinput_device_v1::dwt_current

dwt_current(state: uint<river_libinput_device_v1.dwt_state>)

Argument	Type	Description
state	uint<river_libinput_device_v1.dwt_state>

current disable-while-typing state

Current disable-while-typing state.

river_libinput_device_v1::dwtp_support

dwtp_support(supported: int)

Argument	Type	Description
supported	int	boolean

support for disable-while-trackpointing

Disable-while-trackpointing is supported if the supported argument is non-zero.

river_libinput_device_v1::dwtp_default

dwtp_default(state: uint<river_libinput_device_v1.dwtp_state>)

Argument	Type	Description
state	uint<river_libinput_device_v1.dwtp_state>

default disable-while-trackpointing state

Default disable-while-trackpointing state.

river_libinput_device_v1::dwtp_current

dwtp_current(state: uint<river_libinput_device_v1.dwtp_state>)

Argument	Type	Description
state	uint<river_libinput_device_v1.dwtp_state>

current disable-while-trackpointing state

Current disable-while-trackpointing state.

river_libinput_device_v1::rotation_support

rotation_support(supported: int)

Argument	Type	Description
supported	int	boolean

support for rotation

Rotation is supported if the supported argument is non-zero.

river_libinput_device_v1::rotation_default

rotation_default(angle: uint)

Argument	Type	Description
angle	uint

default rotation angle

Default rotation angle.

river_libinput_device_v1::rotation_current

rotation_current(angle: uint)

Argument	Type	Description
angle	uint

current rotation angle

Current rotation angle.

river_libinput_device_v1::error

error { invalid_arg }

Argument	Value	Description
invalid_arg	0	invalid enum value or similar

river_libinput_device_v1::send_events_modes

bitfield

send_events_modes { enabled, disabled, disabled_on_external_mouse }

Argument	Value	Description
enabled	0
disabled	1
disabled_on_external_mouse	2

river_libinput_device_v1::tap_state

tap_state { disabled, enabled }

Argument	Value	Description
disabled	0
enabled	1

river_libinput_device_v1::tap_button_map

tap_button_map { lrm, lmr }

Argument	Value	Description
lrm	0	1/2/3 finger tap maps to left/right/middle
lmr	1	1/2/3 finger tap maps to left/middle/right

river_libinput_device_v1::drag_state

drag_state { disabled, enabled }

Argument	Value	Description
disabled	0
enabled	1

river_libinput_device_v1::drag_lock_state

drag_lock_state { disabled, enabled_timeout, enabled_sticky }

Argument	Value	Description
disabled	0
enabled_timeout	1
enabled_sticky	2

river_libinput_device_v1::three_finger_drag_state

three_finger_drag_state { disabled, enabled_3fg, enabled_4fg }

Argument	Value	Description
disabled	0
enabled_3fg	1
enabled_4fg	2

river_libinput_device_v1::accel_profile

accel_profile { none, flat, adaptive, custom }

Argument	Value	Description
none	0
flat	1
adaptive	2
custom	4

river_libinput_device_v1::accel_profiles

bitfield

accel_profiles { none, flat, adaptive, custom }

Argument	Value	Description
none	0
flat	1
adaptive	2
custom	4

river_libinput_device_v1::natural_scroll_state

natural_scroll_state { disabled, enabled }

Argument	Value	Description
disabled	0
enabled	1

river_libinput_device_v1::left_handed_state

left_handed_state { disabled, enabled }

Argument	Value	Description
disabled	0
enabled	1

river_libinput_device_v1::click_method

click_method { none, button_areas, clickfinger }

Argument	Value	Description
none	0
button_areas	1
clickfinger	2

river_libinput_device_v1::click_methods

bitfield

click_methods { none, button_areas, clickfinger }

Argument	Value	Description
none	0
button_areas	1
clickfinger	2

river_libinput_device_v1::clickfinger_button_map

clickfinger_button_map { lrm, lmr }

Argument	Value	Description
lrm	0
lmr	1

river_libinput_device_v1::middle_emulation_state

middle_emulation_state { disabled, enabled }

Argument	Value	Description
disabled	0
enabled	1

river_libinput_device_v1::scroll_method

scroll_method { no_scroll, two_finger, edge, on_button_down }

Argument	Value	Description
no_scroll	0
two_finger	1
edge	2
on_button_down	4

river_libinput_device_v1::scroll_methods

bitfield

scroll_methods { no_scroll, two_finger, edge, on_button_down }

Argument	Value	Description
no_scroll	0
two_finger	1
edge	2
on_button_down	4

river_libinput_device_v1::scroll_button_lock_state

scroll_button_lock_state { disabled, enabled }

Argument	Value	Description
disabled	0
enabled	1

river_libinput_device_v1::dwt_state

dwt_state { disabled, enabled }

Argument	Value	Description
disabled	0
enabled	1

river_libinput_device_v1::dwtp_state

dwtp_state { disabled, enabled }

Argument	Value	Description
disabled	0
enabled	1

river_libinput_accel_config_v1

version 1

acceleration config

The result returned by libinput on setting configuration for a device.

river_libinput_accel_config_v1::destroy

Type: destructor

destroy()

destroy the accel object

This request indicates that the client will no longer use the accel config object and that it may be safely destroyed.

river_libinput_accel_config_v1::set_points

set_points(result: new_id<river_libinput_result_v1>, type: uint<river_libinput_accel_config_v1.accel_type>, step: array, points: array)

Argument	Type	Description
result	new_id<river_libinput_result_v1>
type	uint<river_libinput_accel_config_v1.accel_type>
step	array	double
points	array	array of doubles

define custom acceleration function

Defines the acceleration function for a given movement type in an acceleration configuration with custom accel profile.

river_libinput_accel_config_v1::error

error { invalid_arg }

Argument	Value	Description
invalid_arg	0	invalid enum value or similar

river_libinput_accel_config_v1::accel_type

accel_type { fallback, motion, scroll }

Argument	Value	Description
fallback	0
motion	1
scroll	2

river_libinput_result_v1

version 1

config application result

The result returned by libinput on setting configuration for a device.

river_libinput_result_v1::success

Type: destructor

success()

config success

The configuration was successfully applied to the device.

river_libinput_result_v1::unsupported

Type: destructor

unsupported()

config unsupported

The configuration is unsupported by the device and was ignored.

river_libinput_result_v1::invalid

Type: destructor

invalid()

config invalid

The configuration is invalid and was ignored.

Compositor Support

No compositor support found

Copyright

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.