diff options
Diffstat (limited to 'protocol')
| -rw-r--r-- | protocol/wlr-layer-shell-unstable-v1.xml | 29 |
1 files changed, 16 insertions, 13 deletions
diff --git a/protocol/wlr-layer-shell-unstable-v1.xml b/protocol/wlr-layer-shell-unstable-v1.xml index fe2c72cd..3181c0bb 100644 --- a/protocol/wlr-layer-shell-unstable-v1.xml +++ b/protocol/wlr-layer-shell-unstable-v1.xml @@ -93,8 +93,9 @@ <request name="set_size"> <description summary="sets the size of the surface"> - Sets the size of the surface in pixels. The compositor will display the - surface centered with respect to its anchors. + Sets the size of the surface in surface-local coordinates. The + compositor will display the surface centered with respect to its + anchors. If you pass 0 for either value, the compositor will assign it and inform you of the assignment in the configure event. You must set your @@ -128,8 +129,8 @@ 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 pixels from the - edge that are considered exclusive. + edge, rather than a corner. The zone is the number of surface-local + coordinates from the edge that are considered 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 @@ -139,13 +140,15 @@ surfaces, and the compositor should extend it all the way to the edges it is anchored to. - For example, a panel might set its exclusive zone to 10 pixels, so that + For example, a panel might set its exclusive zone to 10, so that maximized shell surfaces are not shown on top of it. A notification - might set its exclusive zone to zero, so that it is moved to avoid + might set its exclusive zone to 0, so that it is moved to avoid occluding the panel, but shell surfaces are shown underneath it. A wallpaper or lock screen might set their exclusive zone to -1, so that they stretch below or over the panel. + The default value is 0. + Exclusive zone is double-buffered, see wl_surface.commit. </description> <arg name="zone" type="int"/> @@ -154,8 +157,8 @@ <request name="set_margin"> <description summary="sets a margin from the anchor point"> Requests that the surface be placed some distance away from the anchor - point on the output, in pixels. Setting this value for edges you are - not anchored to has no effect. + point on the output, in surface-local coordinates. Setting this value + for edges you are not anchored to has no effect. The exclusive zone includes the margin. @@ -254,11 +257,11 @@ <event name="closed"> <description summary="surface should be closed"> - The closed event is sent by the compositor when the surface will no - longer be shown. The output may have been destroyed or the user may have - asked for it to be removed. Further changes to the surface will be ignored. - The client should destroy the resource after receiving this event, and - create a new surface if they so choose. + The closed event is sent by the compositor when the surface will no + longer be shown. The output may have been destroyed or the user may + have asked for it to be removed. Further changes to the surface will be + ignored. The client should destroy the resource after receiving this + event, and create a new surface if they so choose. </description> </event> |