aboutsummaryrefslogtreecommitdiff
path: root/protocol/wlr-layer-shell-unstable-v1.xml
diff options
context:
space:
mode:
authorSimon Ser <contact@emersion.fr>2019-10-17 13:53:12 +0300
committerDrew DeVault <sir@cmpwn.com>2019-10-17 09:12:33 -0400
commit02d664b37f78f70adaaee6d0fedd88bab2d80b22 (patch)
treeb8d397bb96e51fbd8e53dcb43d363bdb54a68305 /protocol/wlr-layer-shell-unstable-v1.xml
parent1724261910728bfa63eecb0f1729995c00c7ffe8 (diff)
protocol: sync layer-shell with upstream
Fixes this warning: ../protocol/wlr-layer-shell-unstable-v1.xml:241: warning: since version not increasing
Diffstat (limited to 'protocol/wlr-layer-shell-unstable-v1.xml')
-rw-r--r--protocol/wlr-layer-shell-unstable-v1.xml43
1 files changed, 26 insertions, 17 deletions
diff --git a/protocol/wlr-layer-shell-unstable-v1.xml b/protocol/wlr-layer-shell-unstable-v1.xml
index 257d369b..adc6a176 100644
--- a/protocol/wlr-layer-shell-unstable-v1.xml
+++ b/protocol/wlr-layer-shell-unstable-v1.xml
@@ -90,9 +90,9 @@
are designed to be rendered as a layer of a stacked desktop-like
environment.
- Layer surface state (size, anchor, exclusive zone, margin, interactivity)
- is double-buffered, and will be applied at the time wl_surface.commit of
- the corresponding wl_surface is called.
+ Layer surface state (layer, size, anchor, exclusive zone,
+ margin, interactivity) is double-buffered, and will be applied at the
+ time wl_surface.commit of the corresponding wl_surface is called.
</description>
<request name="set_size">
@@ -115,7 +115,7 @@
<request name="set_anchor">
<description summary="configures the anchor point of the surface">
Requests that the compositor anchor the surface to the specified edges
- and corners. If two orthoginal edges are specified (e.g. 'top' and
+ and corners. If two orthogonal edges are specified (e.g. 'top' and
'left'), then the anchor point will be the intersection of the edges
(e.g. the top left corner of the output); otherwise the anchor point
will be centered on that edge, or in the center if none is specified.
@@ -127,19 +127,24 @@
<request name="set_exclusive_zone">
<description summary="configures the exclusive geometry of this surface">
- Requests that the compositor avoids occluding an area of the surface
- with other surfaces. The compositor's use of this information is
+ Requests that the compositor avoids occluding an area with other
+ surfaces. The compositor's use of this information is
implementation-dependent - do not assume that this region will not
actually be occluded.
- A positive value is only meaningful if the surface is anchored to an
- edge, rather than a corner. The zone is the number of surface-local
- coordinates from the edge that are considered exclusive.
+ A positive value is only meaningful if the surface is anchored to one
+ edge or an edge and both perpendicular edges. If the surface is not
+ anchored, anchored to only two perpendicular edges (a corner), anchored
+ to only two parallel edges or anchored to all edges, a positive value
+ will be treated the same as zero.
+
+ A positive zone is the distance from the edge in surface-local
+ coordinates to consider exclusive.
Surfaces that do not wish to have an exclusive zone may instead specify
how they should interact with surfaces that do. If set to zero, the
surface indicates that it would like to be moved to avoid occluding
- surfaces with a positive excluzive zone. If set to -1, the surface
+ surfaces with a positive exclusive zone. If set to -1, the surface
indicates that it would not like to be moved to accommodate for other
surfaces, and the compositor should extend it all the way to the edges
it is anchored to.
@@ -231,13 +236,6 @@
</description>
</request>
- <request name="set_layer" since="2">
- <description summary="change the layer of the surface">
- Change the layer that the surface is rendered on.
- </description>
- <arg name="layer" type="uint" enum="layer" summary="layer to move this surface to"/>
- </request>
-
<event name="configure">
<description summary="suggest a surface change">
The configure event asks the client to resize its surface.
@@ -288,5 +286,16 @@
<entry name="left" value="4" summary="the left edge of the anchor rectangle"/>
<entry name="right" value="8" summary="the right edge of the anchor rectangle"/>
</enum>
+
+ <!-- Version 2 additions -->
+
+ <request name="set_layer" since="2">
+ <description summary="change the layer of the surface">
+ Change the layer that the surface is rendered on.
+
+ Layer is double-buffered, see wl_surface.commit.
+ </description>
+ <arg name="layer" type="uint" enum="layer" summary="layer to move this surface to"/>
+ </request>
</interface>
</protocol>