---
name: "wayland_seat_t"
section: "3"
platform: "linux"
package: "waylandpp-dev"
version: "1.0.0-6+b2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/wayland_seat_t"
---

# wayland\_seat\_t(3)

group of input devices

## NAME

wayland::seat\_t - group of input devices

## SYNOPSIS

`#include <wayland-client-protocol.hpp>`

Inherits **wayland::proxy\_t**.

### Public Types

enum class **wrapper\_type** { **standard**, **display**, **foreign**, **proxy\_wrapper** }\

### Public Member Functions

**pointer\_t** **get\_pointer** ()\
 return pointer object  **keyboard\_t** **get\_keyboard** ()\
 return keyboard object  **touch\_t** **get\_touch** ()\
 return touch object  void **release** ()\
 release the seat object  bool **can\_release** () const\
 Check whether the **release** function is available with the currently bound version of the protocol.  std::function\< void(**seat\_capability**)\> & **on\_capabilities** ()\
 seat capabilities changed  std::function\< void(std::string)\> & **on\_name** ()\
 unique identifier for this seat  uint32\_t **get\_id** () const\
 Get the id of a proxy object.  std::string **get\_class** () const\
 Get the interface name (class) of a proxy object.  uint32\_t **get\_version** () const\
 Get the protocol object version of a proxy object.  **wrapper\_type** **get\_wrapper\_type** () const\
 Get the type of a proxy object.  void **set\_queue** (**event\_queue\_t** queue)\
 Assign a proxy to an event queue.  wl\_proxy \* **c\_ptr** () const\
 Get a pointer to the underlying C struct.  bool **proxy\_has\_object** () const\
 Check whether this wrapper actually wraps an object.  **operator bool** () const\
 Check whether this wrapper actually wraps an object.  bool **operator==** (const **proxy\_t** &right) const\
 Check whether two wrappers refer to the same object.  bool **operator!=** (const **proxy\_t** &right) const\
 Check whether two wrappers refer to different objects.  void **proxy\_release** ()\
 Release the wrapped object (if any), making this an empty wrapper.

### Static Public Attributes

static constexpr std::uint32\_t **get\_pointer\_since\_version** = 1\
 Minimum protocol version required for the **get\_pointer** function.  static constexpr std::uint32\_t **get\_keyboard\_since\_version** = 1\
 Minimum protocol version required for the **get\_keyboard** function.  static constexpr std::uint32\_t **get\_touch\_since\_version** = 1\
 Minimum protocol version required for the **get\_touch** function.  static constexpr std::uint32\_t **release\_since\_version** = 5\
 Minimum protocol version required for the **release** function.

## Detailed Description

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.

**Examples** **egl.cpp**, **proxy\_wrapper.cpp**, and **shm.cpp**.

Definition at line **2490** of file **wayland-client-protocol.hpp**.

## Member Enumeration Documentation

### enum class wayland::proxy\_t::wrapper\_type` [strong]`, ` [inherited]`

Underlying wl\_proxy type and properties of a **proxy\_t** that affect construction, destruction, and event handling

**Enumerator**

- *standard*

  *C pointer is a standard type compatible with wl\_proxy\*. Events are dispatched and it is destructed when the* **proxy\_t** *is destructed. User data is set.*

- *display*

  *C pointer is a wl\_display\*. No events are dispatched, wl\_display\_disconnect is called when the* **proxy\_t** *is destructed. User data is set.*

- *foreign*

  *C pointer is a standard type compatible with wl\_proxy\*, but another library owns it and it should not be touched in a way that could affect the operation of the other library. No events are dispatched, wl\_proxy\_destroy is not called when the* **proxy\_t** *is destructed, user data is not touched. Consequently, there is no reference counting for the* **proxy\_t***. Lifetime of such wrappers should preferably be short to minimize the chance that the owning library decides to destroy the wl\_proxy.*

- *proxy\_wrapper*

  *C pointer is a wl\_proxy\* that was constructed with wl\_proxy\_create\_wrapper. No events are dispatched, wl\_proxy\_wrapper\_destroy is called when the* **proxy\_t** *is destroyed. Reference counting is active. A reference to the* **proxy\_t** *creating this proxy wrapper is held to extend its lifetime until after the proxy wrapper is destroyed.*

*Definition at line* **116** *of file* **wayland-client.hpp***.*

## Member Function Documentation

### wl\_proxy \* wayland::proxy\_t::c\_ptr () const` [inherited]`

*Get a pointer to the underlying C struct.*

**Returns**

*The underlying wl\_proxy wrapped by this* **proxy\_t** *if it exists, otherwise an exception is thrown*

### bool seat\_t::can\_release () const

*Check whether the* **release** *function is available with the currently bound version of the protocol.*

*Definition at line* **2875** *of file* **wayland-client-protocol.cpp***.*

### std::string wayland::proxy\_t::get\_class () const` [inherited]`

*Get the interface name (class) of a proxy object.*

**Returns**

*The interface name of the object associated with the proxy*

### uint32\_t wayland::proxy\_t::get\_id () const` [inherited]`

*Get the id of a proxy object.*

**Returns**

*The id the object associated with the proxy*

### keyboard\_t seat\_t::get\_keyboard ()

*return keyboard object*

**Returns**

*seat keyboard*

*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, or has had the keyboard capability in the past. It is a protocol violation to issue this request on a seat that has never had the keyboard capability. The missing\_capability error will be sent in this case.*

**Examples** **egl.cpp***,* **proxy\_wrapper.cpp***, and* **shm.cpp***.*

*Definition at line* **2856** *of file* **wayland-client-protocol.cpp***.*

### pointer\_t seat\_t::get\_pointer ()

*return pointer object*

**Returns**

*seat pointer*

*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, or has had the pointer capability in the past. It is a protocol violation to issue this request on a seat that has never had the pointer capability. The missing\_capability error will be sent in this case.*

**Examples** **egl.cpp***, and* **shm.cpp***.*

*Definition at line* **2849** *of file* **wayland-client-protocol.cpp***.*

### touch\_t seat\_t::get\_touch ()

*return touch object*

**Returns**

*seat touch interface*

*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, or has had the touch capability in the past. It is a protocol violation to issue this request on a seat that has never had the touch capability. The missing\_capability error will be sent in this case.*

*Definition at line* **2863** *of file* **wayland-client-protocol.cpp***.*

### uint32\_t wayland::proxy\_t::get\_version () const` [inherited]`

*Get the protocol object version of a proxy object. Gets the protocol object version of a proxy object, or 0 if the proxy was created with unversioned API.*

*A returned value of 0 means that no version information is available, so the caller must make safe assumptions about the object's real version.*

**display\_t** *will always return version 0.*

**Returns**

*The protocol object version of the proxy or 0*

### wrapper\_type wayland::proxy\_t::get\_wrapper\_type () const` [inline]`, ` [inherited]`

*Get the type of a proxy object.*

*Definition at line* **302** *of file* **wayland-client.hpp***.*

### std::function\< void(seat\_capability)\> & seat\_t::on\_capabilities ()

*seat capabilities changed*

**Parameters**

*capabilities capabilities of the seat*

*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.*

*When the pointer capability is added, a client may create a wl\_pointer object using the wl\_seat.get\_pointer request. This object will receive pointer events until the capability is removed in the future.*

*When the pointer capability is removed, a client should destroy the wl\_pointer objects associated with the seat where the capability was removed, using the wl\_pointer.release request. No further pointer events will be received on these objects.*

*In some compositors, if a seat regains the pointer capability and a client has a previously obtained wl\_pointer object of version 4 or less, that object may start sending pointer events again. This behavior is considered a misinterpretation of the intended behavior and must not be relied upon by the client. wl\_pointer objects of version 5 or later must not send events if created before the most recent event notifying the client of an added pointer capability.*

*The above behavior also applies to wl\_keyboard and wl\_touch with the keyboard and touch capabilities, respectively.*

**Examples** **egl.cpp***, and* **shm.cpp***.*

*Definition at line* **2881** *of file* **wayland-client-protocol.cpp***.*

### std::function\< void(std::string)\> & seat\_t::on\_name ()

*unique identifier for this seat*

**Parameters**

*name seat identifier*

*In a multi-seat configuration the seat name can be used by clients to help identify which physical devices the seat represents.*

*The seat name is a UTF-8 string with no convention defined for its contents. Each name is unique among all wl\_seat globals. The name is only guaranteed to be unique for the current compositor instance.*

*The same seat names are used for all clients. Thus, the name can be shared across processes to refer to a specific wl\_seat global.*

*The name event is sent after binding to the seat global. This event is only sent once per seat object, and the name does not change over the lifetime of the wl\_seat global.*

*Compositors may re-use the same seat name if the wl\_seat global is destroyed and re-created later.*

*Definition at line* **2886** *of file* **wayland-client-protocol.cpp***.*

### wayland::proxy\_t::operator bool () const` [inherited]`

*Check whether this wrapper actually wraps an object.*

**Returns**

*true if there is an underlying object, false if this wrapper is empty*

### bool wayland::proxy\_t::operator!= (const proxy\_t & right) const` [inherited]`

*Check whether two wrappers refer to different objects.*

### bool wayland::proxy\_t::operator== (const proxy\_t & right) const` [inherited]`

*Check whether two wrappers refer to the same object.*

### bool wayland::proxy\_t::proxy\_has\_object () const` [inherited]`

*Check whether this wrapper actually wraps an object.*

**Returns**

*true if there is an underlying object, false if this wrapper is empty*

### void wayland::proxy\_t::proxy\_release ()` [inherited]`

*Release the wrapped object (if any), making this an empty wrapper. Note that* **display\_t** *instances cannot be released this way. Attempts to do so are ignored.*

**Examples** **foreign\_display.cpp***.*

### void seat\_t::release ()

*release the seat object Using this request a client can tell the server that it is not going to use the seat object anymore.*

*Definition at line* **2870** *of file* **wayland-client-protocol.cpp***.*

### void wayland::proxy\_t::set\_queue (event\_queue\_t queue)` [inherited]`

*Assign a proxy to an event queue.*

**Parameters**

*queue The event queue that will handle this proxy*

*Assign proxy to event queue. Events coming from proxy will be queued in queue instead of the display's main queue.*

*See also:* **display\_t::dispatch\_queue()***.*

**Examples** **proxy\_wrapper.cpp***.*

## Member Data Documentation

### constexpr std::uint32\_t wayland::seat\_t::get\_keyboard\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **get\_keyboard** *function.*

*Definition at line* **2550** *of file* **wayland-client-protocol.hpp***.*

### constexpr std::uint32\_t wayland::seat\_t::get\_pointer\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **get\_pointer** *function.*

*Definition at line* **2531** *of file* **wayland-client-protocol.hpp***.*

### constexpr std::uint32\_t wayland::seat\_t::get\_touch\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **get\_touch** *function.*

*Definition at line* **2569** *of file* **wayland-client-protocol.hpp***.*

### constexpr std::uint32\_t wayland::seat\_t::release\_since\_version = 5` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **release** *function.*

*Definition at line* **2581** *of file* **wayland-client-protocol.hpp***.*

## Author

*Generated automatically by Doxygen for Wayland++ from the source code.*