River input management

configure input devices

This protocol supports creating/destroying seats, assigning input devices to seats, and configuring input devices (e.g. setting keyboard repeat rate).

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_input_manager_v1

version 1

input manager global interface

Input manager global interface.

river_input_manager_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_input_manager_v1.finished event before destroying this object.

river_input_manager_v1::destroy

Type: destructor

destroy()

destroy the river_input_manager_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_input_manager_v1.stop request and wait for a river_input_manager_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_input_manager_v1::create_seat

create_seat(name: string)

Argument	Type	Description
name	string

create a new seat

Create a new seat with the given name. Has no effect if a seat with the given name already exists.

The default seat with name "default" always exists and does not need to be explicitly created.

river_input_manager_v1::destroy_seat

destroy_seat(name: string)

Argument	Type	Description
name	string

destroy a seat

Destroy the seat with the given name. Has no effect if a seat with the given name does not exist.

The default seat with name "default" cannot be destroyed and attempting to destroy it will have no effect.

Any input devices assigned to the destroyed seat at the time of destruction are assigned to the default seat.

river_input_manager_v1::finished

finished()

the server has finished with the input manager

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

river_input_manager_v1::input_device

input_device(id: new_id<river_input_device_v1>)

Argument	Type	Description
id	new_id<river_input_device_v1>

new input device

A new input device has been created.

river_input_manager_v1::error

error { invalid_destroy }

Argument	Value	Description
invalid_destroy	0

river_input_device_v1

version 1

an input device

An input device represents a physical keyboard, mouse, touchscreen, or drawing tablet tool. It is assigned to exactly one seat at a time. By default, all input devices are assigned to the default seat.

river_input_device_v1::destroy

Type: destructor

destroy()

destroy the input device object

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

river_input_device_v1::assign_to_seat

assign_to_seat(name: string)

Argument	Type	Description
name	string	name of the seat

assign the input device to a seat

Assign the input device to a seat. All input devices not explicitly assigned to a seat are considered assigned to the default seat.

Has no effect if a seat with the given name does not exist.

river_input_device_v1::set_repeat_info

set_repeat_info(rate: int, delay: int)

Argument	Type	Description
rate	int	rate in key repeats per second
delay	int	delay in milliseconds

set keyboard repeat rate and delay

Set repeat rate and delay for a keyboard input device. Has no effect if the device is not a keyboard.

Negative values for either rate or delay are illegal. A rate of zero will disable any repeating (regardless of the value of delay).

river_input_device_v1::set_scroll_factor

set_scroll_factor(factor: fixed)

Argument	Type	Description
factor	fixed

set scroll factor

Set the scroll factor for a pointer input device. Has no effect if the device is not a pointer.

For example, a factor of 0.5 will make scrolling twice as slow while a factor of 3.0 will make scrolling 3 times as fast.

Setting a scroll factor less than 0 is a protocol error.

river_input_device_v1::map_to_output

map_to_output(output: object<wl_output>)

Argument	Type	Description
output	object<wl_output>allow null

map input device to the given output

Map the input device to the given output. Has no effect if the device is not a pointer, touch, or tablet device.

If mapped to both an output and a rectangle, the rectangle has priority.

Passing null clears an existing mapping.

river_input_device_v1::map_to_rectangle

map_to_rectangle(x: int, y: int, width: int, height: int)

Argument	Type	Description
x	int
y	int
width	int
height	int

map input device to the given rectangle

Map the input device to the given rectangle in the global compositor coordinate space. Has no effect if the device is not a pointer, touch, or tablet device.

If mapped to both an output and a rectangle, the rectangle has priority.

Width and height must be greater than or equal to 0.

Passing 0 for width or height clears an existing mapping.

river_input_device_v1::removed

removed()

the input device is removed

This event indicates that the input device has been removed.

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

river_input_device_v1::type

type(type: uint<river_input_device_v1.type>)

Argument	Type	Description
type	uint<river_input_device_v1.type>

the type of the input device

The type of the input device. This event is sent once when the river_input_device_v1 object is created. The device type cannot change during the lifetime of the object.

river_input_device_v1::name

name(name: string)

Argument	Type	Description
name	string

the name of the input device

The name of the input device. This event is sent once when the river_input_device_v1 object is created. The device name cannot change during the lifetime of the object.

river_input_device_v1::error

error { invalid_repeat_info, invalid_scroll_factor, invalid_map_to_rectangle }

Argument	Value	Description
invalid_repeat_info	0
invalid_scroll_factor	1
invalid_map_to_rectangle	2

river_input_device_v1::type

type { keyboard, pointer, touch, tablet }

Argument	Value	Description
keyboard	0
pointer	1
touch	2
tablet	3

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.