1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
<?xml version="1.0" encoding="UTF-8"?>
<protocol name="agl_shell">
<copyright>
Copyright © 2019, 2022 Collabora, Ltd.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice (including the next
paragraph) shall be included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
</copyright>
<interface name="agl_shell" version="4">
<description summary="user interface for Automotive Grade Linux platform">
Starting with version 2 of the protocol, the client is required to wait
for the 'bound_ok' or 'bound_fail' events in order to proceed further.
In case the client gets a 'bound_fail' event then it should consider that
there's another client already bound to the agl_shell protocol.
A client that receives a 'bound_ok' event should consider that there's
no other client already bound to the interface and can proceed further.
If the client uses an older version of the protocol it will receive
automatically an error and the compositor will terminate the connection,
if there's another client already bound the interface.
If the client receives the 'bound_fail' event and attempts to use the
interface further it will receive an error and the compositor will
terminate the connection. After the 'bound_fail' event was received the
client should call the destructor, which has been added with version 2
of the protocol. The client is free to try at a later point in time to
see if it will receive the 'bound_ok' event, but there's no explicit way
of finding out when that event will be delivered.
It is assumed that it can infer that information through other
means/other channels.
</description>
<enum name="error">
<entry name="invalid_argument" value="0"/>
<entry name="background_exists" value="1"/>
<entry name="panel_exists" value="2"/>
</enum>
<enum name="edge">
<entry name="top" value="0"/>
<entry name="bottom" value="1"/>
<entry name="left" value="2"/>
<entry name="right" value="3"/>
</enum>
<enum name="app_state" since="3">
<entry name="started" value="0"/>
<entry name="terminated" value="1"/>
<entry name="activated" value="2"/>
<entry name="deactivated" value="3"/>
</enum>
<request name="ready">
<description summary="client is ready to be shown">
Tell the server that this client is ready to be shown. The server
will delay presentation during start-up until all shell clients are
ready to be shown, and will display a black screen instead.
This gives the client an opportunity to set up and configure several
surfaces into a coherent interface.
The client that binds to this interface must send this request, otherwise
they may stall the compositor unnecessarily.
If this request is called after the compositor has already finished
start-up, no operation is performed.
</description>
</request>
<request name="set_background">
<description summary="set surface as output's background">
Set the surface to act as the background of an output. After this
request, the server will immediately send a configure event with
the dimensions the client should use to cover the entire output.
The surface must have a "desktop" surface role, as supported by
libweston-desktop.
Only a single surface may be the background for any output. If a
background surface already exists, a protocol error is raised.
</description>
<arg name="surface" type="object" interface="wl_surface"/>
<arg name="output" type="object" interface="wl_output"/>
</request>
<request name="set_panel">
<description summary="set surface as panel">
Set the surface to act as a panel of an output. The 'edge' argument
says what edge of the output the surface will be anchored to.
After this request, the server will send a configure event with the
corresponding width/height that the client should use, and 0 for the
other dimension. E.g. if the edge is 'top', the width will be the
output's width, and the height will be 0.
The surface must have a "desktop" surface role, as supported by
libweston-desktop.
The compositor will take the panel's window geometry into account when
positioning other windows, so the panels are not covered.
XXX: What happens if e.g. both top and left are used at the same time?
Who gets to have the corner?
Only a single surface may be the panel for an output's edge. If a
surface already exists on an edge, a protocol error is raised.
</description>
<arg name="surface" type="object" interface="wl_surface"/>
<arg name="output" type="object" interface="wl_output"/>
<arg name="edge" type="uint" enum="edge"/>
</request>
<request name="activate_app">
<description summary="make client current window">
Ask the compositor to make a toplevel to become the current/focused
window for window management purposes.
See xdg_toplevel.set_app_id from the xdg-shell protocol for a
description of app_id.
If multiple toplevels have the same app_id, the result is unspecified.
XXX: Do we need feedback to say it didn't work? (e.g. client does
not exist)
</description>
<arg name="app_id" type="string"/>
<arg name="output" type="object" interface="wl_output"/>
</request>
<event name="bound_ok" since="2">
<description summary="event sent if binding was ok">
Informs the client that it was able to bind the agl_shell
interface succesfully. Clients are required to wait for this
event before continuing further.
</description>
</event>
<event name="bound_fail" since="2">
<description summary="event sent if binding was nok">
Informs the client that binding to the agl_shell interface was
unsuccesfull. Clients are required to wait for this event for
continuing further.
</description>
</event>
<request name="destroy" type="destructor" since="2">
<description summary="destroys the factory object">
</description>
</request>
<event name="app_state" since="3">
<description summary="event sent when an application suffered state modification">
Informs the client that an application has changed its state to another,
specified by the app_state enum. Client can use this event to track
current application state. For instance to know when the application has
started, or when terminated/stopped.
</description>
<arg name="app_id" type="string"/>
<arg name="state" type="uint" enum="app_state"/>
</event>
<request name="set_activate_region" since="4">
<description summary="sets a specific region to activate">
A hint for the compositor to use a custom area, rather than
inferring the activation area. If any panels are used
the compositor computes the activation area by subtracting the
panels geometry area. If no panels are used then the entire output
is being used. This request changes that as to hint the compositor
to use the supplied rectangle and ignore any potential panels
that might been set-up previously.
In order for this request to take effect it will need to happen
before the 'ready' request in order for the compositor to make use of it.
Note that any 'set_panel' request be will not be honored, if this request
has been called.
The x and y coordinates use the top-left corner as the origin. The
rectangle area shouldn't exceed the output area, while an area smaller
than the output, would basically result in showing up the background
surface.
</description>
<arg name="output" type="object" interface="wl_output"/>
<arg name="x" type="int" summary="x position of rectangle"/>
<arg name="y" type="int" summary="y position of rectangle"/>
<arg name="width" type="int" summary="width of rectangle"/>
<arg name="height" type="int" summary="height of rectangle"/>
</request>
</interface>
</protocol>
|
