aboutsummaryrefslogtreecommitdiff
path: root/unstable/xdg-output/xdg-output-unstable-v1.xml
diff options
context:
space:
mode:
Diffstat (limited to 'unstable/xdg-output/xdg-output-unstable-v1.xml')
-rw-r--r--unstable/xdg-output/xdg-output-unstable-v1.xml49
1 files changed, 47 insertions, 2 deletions
diff --git a/unstable/xdg-output/xdg-output-unstable-v1.xml b/unstable/xdg-output/xdg-output-unstable-v1.xml
index 0c0c481..bd9a8a8 100644
--- a/unstable/xdg-output/xdg-output-unstable-v1.xml
+++ b/unstable/xdg-output/xdg-output-unstable-v1.xml
@@ -54,7 +54,7 @@
reset.
</description>
- <interface name="zxdg_output_manager_v1" version="1">
+ <interface name="zxdg_output_manager_v1" version="2">
<description summary="manage xdg_output objects">
A global factory interface for xdg_output objects.
</description>
@@ -77,7 +77,7 @@
</request>
</interface>
- <interface name="zxdg_output_v1" version="1">
+ <interface name="zxdg_output_v1" version="2">
<description summary="compositor logical output region">
An xdg_output describes part of the compositor geometry.
@@ -157,5 +157,50 @@
</description>
</event>
+ <!-- Version 2 additions -->
+
+ <event name="name" since="2">
+ <description summary="name of this output">
+ Many compositors will assign names to their outputs, show them to the
+ user, allow them to be configured by name, etc. The client may wish to
+ know this name as well to offer the user similar behaviors.
+
+ The naming convention is compositor defined, but limited to
+ alphanumeric characters and dashes (-). Each name is unique among all
+ wl_output globals, but if a wl_output global is destroyed the same name
+ may be reused later. The names will also remain consistent across
+ sessions with the same hardware and software configuration.
+
+ Examples of names include 'HDMI-A-1', 'WL-1', 'X11-1', etc. However, do
+ not assume that the name is a reflection of an underlying DRM
+ connector, X11 connection, etc.
+
+ The name event is sent after creating an xdg_output (see
+ xdg_output_manager.get_xdg_output). This event is only sent once per
+ xdg_output, and the name does not change over the lifetime of the
+ wl_output global.
+ </description>
+ <arg name="name" type="string" summary="output name"/>
+ </event>
+
+ <event name="description" since="2">
+ <description summary="human-readable description of this output">
+ Many compositors can produce human-readable descriptions of their
+ outputs. The client may wish to know this description as well, to
+ communicate the user for various purposes.
+
+ The description is a UTF-8 string with no convention defined for its
+ contents. Examples might include 'Foocorp 11" Display' or 'Virtual X11
+ output via :1'.
+
+ The description event is sent after creating an xdg_output (see
+ xdg_output_manager.get_xdg_output). This event is only sent once per
+ xdg_output, and the description does not change over the lifetime of
+ the wl_output global. The description is optional, and may not be sent
+ at all.
+ </description>
+ <arg name="description" type="string" summary="output description"/>
+ </event>
+
</interface>
</protocol>