Product SiteDocumentation Site

A.15. wl_seat - group of input devices

A seat is a group of keyboards, pointer and touch devices. This object is published as a global during start up, or when such a device is hot plugged. A seat typically has a pointer and maintains a keyboard focus and a pointer focus.

A.15.1. Requests provided by wl_seat

A.15.1.1. wl_seat::get_pointer - return pointer object

The ID provided will be initialized to the wl_pointer interface for this seat.
This request only takes effect if the seat has the pointer capability.

wl_seat::get_pointer arguments

id
Type: new_id

A.15.1.2. wl_seat::get_keyboard - return keyboard object

The ID provided will be initialized to the wl_keyboard interface for this seat.
This request only takes effect if the seat has the keyboard capability.

wl_seat::get_keyboard arguments

id
Type: new_id

A.15.1.3. wl_seat::get_touch - return touch object

The ID provided will be initialized to the wl_touch interface for this seat.
This request only takes effect if the seat has the touch capability.

wl_seat::get_touch arguments

id
Type: new_id

A.15.2. Events provided by wl_seat

A.15.2.1. wl_seat::capabilities - seat capabilities changed

This is emitted whenever a seat gains or loses the pointer, keyboard or touch capabilities. The argument is a capability enum containing the complete set of capabilities this seat has.

wl_seat::capabilities arguments

capabilities
Type: uint

A.15.2.2. wl_seat::name - unique identifier for this seat

In a multiseat configuration this can be used by the client to help identify which physical devices the seat represents. Based on the seat configuration used by the compositor.

wl_seat::name arguments

name
Type: string

A.15.3. Enums provided by wl_seat

A.15.3.1. wl_seat::capability - seat capability bitmask

This is a bitmask of capabilities this seat has; if a member is set, then it is present on the seat.

wl_seat::capability values

pointer
Value: 1
The seat has pointer devices
keyboard
Value: 2
The seat has one or more keyboards
touch
Value: 4
The seat has touch devices