Wayland compositor (wlroots)
git clone https://git.lucas.co/cce-compositor.git
protocol/river-layer-shell-v1.xml (8.5K)
1 <?xml version="1.0" encoding="UTF-8"?>
2 <protocol name="river_layer_shell_v1">
3 <copyright>
4 SPDX-FileCopyrightText: © 2025 Isaac Freund
5 SPDX-License-Identifier: MIT
6
7 Permission is hereby granted, free of charge, to any person obtaining a copy
8 of this software and associated documentation files (the "Software"), to
9 deal in the Software without restriction, including without limitation the
10 rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
11 sell copies of the Software, and to permit persons to whom the Software is
12 furnished to do so, subject to the following conditions:
13
14 The above copyright notice and this permission notice shall be included in
15 all copies or substantial portions of the Software.
16
17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
23 IN THE SOFTWARE.
24 </copyright>
25
26 <description summary="optional layer shell support">
27 This protocol allows the river-window-management-v1 window manager to
28 support the wlr-layer-shell-unstable-v1 protocol.
29
30 The key words "must", "must not", "required", "shall", "shall not",
31 "should", "should not", "recommended", "may", and "optional" in this
32 document are to be interpreted as described in IETF RFC 2119.
33 </description>
34
35 <interface name="river_layer_shell_v1" version="1">
36 <description summary="river layer shell global interface">
37 This global interface should only be advertised to the client if the
38 river_window_manager_v1 global is also advertised. Binding this interface
39 indicates that the window manager supports layer shell.
40
41 If the window manager does not bind this interface, the compositor should
42 not allow clients to map layer surfaces. This can be achieved by
43 closing layer surfaces immediately.
44 </description>
45
46 <enum name="error">
47 <entry name="object_already_created" value="0"
48 summary="the layer_shell_output/seat object was already created."/>
49 </enum>
50
51 <request name="destroy" type="destructor">
52 <description summary="destroy the river_layer_shell_v1 object">
53 This request indicates that the client will no longer use the
54 river_layer_shell_v1 object.
55 </description>
56 </request>
57
58 <request name="get_output">
59 <description summary="get layer shell output state">
60 It is a protocol error to make this request more than once for a given
61 river_output_v1 object.
62 </description>
63 <arg name="id" type="new_id" interface="river_layer_shell_output_v1"/>
64 <arg name="output" type="object" interface="zcce_output_v1"/>
65 </request>
66
67 <request name="get_seat">
68 <description summary="get layer shell seat state">
69 It is a protocol error to make this request more than once for a given
70 river_seat_v1 object.
71 </description>
72 <arg name="id" type="new_id" interface="river_layer_shell_seat_v1"/>
73 <arg name="seat" type="object" interface="zcce_seat_v1"/>
74 </request>
75 </interface>
76
77 <interface name="river_layer_shell_output_v1" version="1">
78 <description summary="layer shell output state">
79 The lifetime of this object is tied to the corresponding river_output_v1.
80 This object is made inert when the river_output_v1.removed event is sent
81 and should be destroyed.
82 </description>
83
84 <request name="destroy" type="destructor">
85 <description summary="destroy the object">
86 This request indicates that the client will no longer use the
87 river_layer_shell_output_v1 object and that it may be safely destroyed.
88
89 This request should be made after the river_output_v1.removed event is
90 received to complete destruction of the output.
91 </description>
92 </request>
93
94 <event name="non_exclusive_area">
95 <description summary="area left after subtracting exclusive zones">
96 This event indicates the area of the output remaining after subtracting
97 the exclusive zones of layer surfaces. Exclusive zones are a hint, the
98 window manager is free to ignore this area hint if it wishes.
99
100 The x and y values are in the global coordinate space, not relative to
101 the position of the output.
102
103 This event will be followed by a manage_start event after all other new
104 state has been sent by the server.
105 </description>
106 <arg name="x" type="int" summary="global x coordinate"/>
107 <arg name="y" type="int" summary="global y coordinate"/>
108 <arg name="width" type="int" summary="area width"/>
109 <arg name="height" type="int" summary="area height"/>
110 </event>
111
112 <request name="set_default">
113 <description summary="Set default output for layer surfaces">
114 Mark this output as the default for new layer surfaces which do not
115 request a specific output themselves. This request overrides any
116 previous set_default request on any river_layer_shell_output_v1 object.
117
118 If no set_default request is made or if the default output is destroyed,
119 the default output is undefined until the next set_default request.
120
121 This request modifies window management state and may only be made as
122 part of a manage sequence, see the river_window_manager_v1 description.
123 </description>
124 </request>
125 </interface>
126
127 <interface name="river_layer_shell_seat_v1" version="1">
128 <description summary="layer shell seat state">
129 The lifetime of this object is tied to the corresponding river_seat_v1.
130 This object is made inert when the river_seat_v1.removed event is sent and
131 should be destroyed.
132 </description>
133
134 <request name="destroy" type="destructor">
135 <description summary="destroy the object">
136 This request indicates that the client will no longer use the
137 river_layer_shell_seat_v1 object and that it may be safely destroyed.
138
139 This request should be made after the river_seat_v1.removed event is
140 received to complete destruction of the seat.
141 </description>
142 </request>
143
144 <event name="focus_exclusive">
145 <description summary="layer shell surface has exclusive focus">
146 A layer shell surface will be given exclusive keyboard focus at the end
147 of the manage sequence in which this event is sent. The window manager
148 may want to update window decorations or similar to indicate that no
149 window is focused.
150
151 Until the focus_non_exclusive or focus_none event is sent, all window
152 manager requests to change focus are ignored.
153
154 This event will be followed by a manage_start event after all other new
155 state has been sent by the server.
156 </description>
157 </event>
158
159 <event name="focus_non_exclusive">
160 <description summary="layer shell surface wants non-exclusive focus">
161 A layer shell surface will be given non-exclusive keyboard focus at the
162 end of the manage sequence in which this event is sent. The window
163 manager may want to update window decorations or similar to indicate
164 that no window is focused.
165
166 The window manager continues to control focus and may choose to focus a
167 different window/shell surface at any time. If the window manager sets
168 focus during the same manage sequence in which this event is sent, the
169 layer surface will not be focused.
170
171 If the layer surface with non-exclusive focus is closed or the window
172 manager chooses to move focus away from the layer surface, a focus_none
173 event will be sent in the next manage sequence.
174
175 This event will be followed by a manage_start event after all other new
176 state has been sent by the server.
177 </description>
178 </event>
179
180 <event name="focus_none">
181 <description summary="no layer shell surface has focus">
182 No layer shell surface will have keyboard focus at the end of the manage
183 sequence in which this event is sent. The window manager may want to
184 return focus to whichever window last had focus, for example.
185
186 This event will be followed by a manage_start event after all other new
187 state has been sent by the server.
188 </description>
189 </event>
190 </interface>
191 </protocol>