summaryrefslogtreecommitdiff
path: root/protocol
diff options
context:
space:
mode:
authorSimon Ser <contact@emersion.fr>2021-06-29 12:47:04 +0200
committerSimon Ser <contact@emersion.fr>2021-07-06 11:57:39 +0000
commit767765d584df2c7ec759eab8edfaa79f31a2b692 (patch)
tree46748d7a133e6387f98013eebc1dd45718c996c3 /protocol
parent92038fa39497f0a481b38e623bd604feb6a01882 (diff)
downloadwayland-767765d584df2c7ec759eab8edfaa79f31a2b692.tar.gz
protocol: clarify wl_seat.name description
Define the expected properties of the seat name. Signed-off-by: Simon Ser <contact@emersion.fr>
Diffstat (limited to 'protocol')
-rw-r--r--protocol/wayland.xml19
1 files changed, 16 insertions, 3 deletions
diff --git a/protocol/wayland.xml b/protocol/wayland.xml
index ef65714..a87e9dd 100644
--- a/protocol/wayland.xml
+++ b/protocol/wayland.xml
@@ -1842,9 +1842,22 @@
<event name="name" since="2">
<description summary="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.
+ 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.
</description>
<arg name="name" type="string" summary="seat identifier"/>
</event>