0<?xml version="1.0" encoding="UTF-8"?>
1<protocol name="xdg_toplevel_icon_v1">
3 <copyright>
4 Copyright © 2023-2024 Matthias Klumpp
5 Copyright © 2024 David Edmundson
7 Permission is hereby granted, free of charge, to any person obtaining a
8 copy of this software and associated documentation files (the "Software"),
9 to deal in the Software without restriction, including without limitation
10 the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 and/or sell copies of the Software, and to permit persons to whom the
12 Software is furnished to do so, subject to the following conditions:
14 The above copyright notice and this permission notice (including the next
15 paragraph) shall be included in all copies or substantial portions of the
16 Software.
18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24 DEALINGS IN THE SOFTWARE.
25 </copyright>
27 <description summary="protocol to assign icons to toplevels">
28 This protocol allows clients to set icons for their toplevel surfaces
29 either via the XDG icon stock (using an icon name), or from pixel data.
31 A toplevel icon represents the individual toplevel (unlike the application
32 or launcher icon, which represents the application as a whole), and may be
33 shown in window switchers, window overviews and taskbars that list
34 individual windows.
36 This document adheres to RFC 2119 when using words like "must",
37 "should", "may", etc.
39 Warning! The protocol described in this file is currently in the testing
40 phase. Backward compatible changes may be added together with the
41 corresponding interface version bump. Backward incompatible changes can
42 only be done by creating a new major version of the extension.
43 </description>
45 <interface name="xdg_toplevel_icon_manager_v1" version="1">
46 <description summary="interface to manage toplevel icons">
47 This interface allows clients to create toplevel window icons and set
48 them on toplevel windows to be displayed to the user.
49 </description>
51 <request name="destroy" type="destructor">
52 <description summary="destroy the toplevel icon manager">
53 Destroy the toplevel icon manager.
54 This does not destroy objects created with the manager.
55 </description>
56 </request>
58 <request name="create_icon">
59 <description summary="create a new icon instance">
60 Creates a new icon object. This icon can then be attached to a
61 xdg_toplevel via the 'set_icon' request.
62 </description>
63 <arg name="id" type="new_id" interface="xdg_toplevel_icon_v1"/>
64 </request>
66 <request name="set_icon">
67 <description summary="set an icon on a toplevel window">
68 This request assigns the icon 'icon' to 'toplevel', or clears the
69 toplevel icon if 'icon' was null.
70 This state is double-buffered and is applied on the next
71 wl_surface.commit of the toplevel.
73 After making this call, the xdg_toplevel_icon_v1 provided as 'icon'
74 can be destroyed by the client without 'toplevel' losing its icon.
75 The xdg_toplevel_icon_v1 is immutable from this point, and any
76 future attempts to change it must raise the
77 'xdg_toplevel_icon_v1.immutable' protocol error.
79 The compositor must set the toplevel icon from either the pixel data
80 the icon provides, or by loading a stock icon using the icon name.
81 See the description of 'xdg_toplevel_icon_v1' for details.
83 If 'icon' is set to null, the icon of the respective toplevel is reset
84 to its default icon (usually the icon of the application, derived from
85 its desktop-entry file, or a placeholder icon).
86 If this request is passed an icon with no pixel buffers or icon name
87 assigned, the icon must be reset just like if 'icon' was null.
88 </description>
89 <arg name="toplevel" type="object" interface="xdg_toplevel" summary="the toplevel to act on"/>
90 <arg name="icon" type="object" interface="xdg_toplevel_icon_v1" allow-null="true"/>
91 </request>
93 <event name="icon_size">
94 <description summary="describes a supported & preferred icon size">
95 This event indicates an icon size the compositor prefers to be
96 available if the client has scalable icons and can render to any size.
98 When the 'xdg_toplevel_icon_manager_v1' object is created, the
99 compositor may send one or more 'icon_size' events to describe the list
100 of preferred icon sizes. If the compositor has no size preference, it
101 may not send any 'icon_size' event, and it is up to the client to
102 decide a suitable icon size.
104 A sequence of 'icon_size' events must be finished with a 'done' event.
105 If the compositor has no size preferences, it must still send the
106 'done' event, without any preceding 'icon_size' events.
107 </description>
108 <arg name="size" type="int"
109 summary="the edge size of the square icon in surface-local coordinates, e.g. 64"/>
110 </event>
112 <event name="done">
113 <description summary="all information has been sent">
114 This event is sent after all 'icon_size' events have been sent.
115 </description>
116 </event>
117 </interface>
119 <interface name="xdg_toplevel_icon_v1" version="1">
120 <description summary="a toplevel window icon">
121 This interface defines a toplevel icon.
122 An icon can have a name, and multiple buffers.
123 In order to be applied, the icon must have either a name, or at least
124 one buffer assigned. Applying an empty icon (with no buffer or name) to
125 a toplevel should reset its icon to the default icon.
127 It is up to compositor policy whether to prefer using a buffer or loading
128 an icon via its name. See 'set_name' and 'add_buffer' for details.
129 </description>
131 <enum name="error">
132 <entry name="invalid_buffer"
133 summary="the provided buffer does not satisfy requirements"
134 value="1"/>
135 <entry name="immutable"
136 summary="the icon has already been assigned to a toplevel and must not be changed"
137 value="2"/>
138 <entry name="no_buffer"
139 summary="the provided buffer has been destroyed before the toplevel icon"
140 value="3"/>
141 </enum>
143 <request name="destroy" type="destructor">
144 <description summary="destroy the icon object">
145 Destroys the 'xdg_toplevel_icon_v1' object.
146 The icon must still remain set on every toplevel it was assigned to,
147 until the toplevel icon is reset explicitly.
148 </description>
149 </request>
151 <request name="set_name">
152 <description summary="set an icon name">
153 This request assigns an icon name to this icon.
154 Any previously set name is overridden.
156 The compositor must resolve 'icon_name' according to the lookup rules
157 described in the XDG icon theme specification[1] using the
158 environment's current icon theme.
160 If the compositor does not support icon names or cannot resolve
161 'icon_name' according to the XDG icon theme specification it must
162 fall back to using pixel buffer data instead.
164 If this request is made after the icon has been assigned to a toplevel
165 via 'set_icon', a 'immutable' error must be raised.
167 [1]: https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html
168 </description>
169 <arg name="icon_name" type="string"/>
170 </request>
172 <request name="add_buffer">
173 <description summary="add icon data from a pixel buffer">
174 This request adds pixel data supplied as wl_buffer to the icon.
176 The client should add pixel data for all icon sizes and scales that
177 it can provide, or which are explicitly requested by the compositor
178 via 'icon_size' events on xdg_toplevel_icon_manager_v1.
180 The wl_buffer supplying pixel data as 'buffer' must be backed by wl_shm
181 and must be a square (width and height being equal).
182 If any of these buffer requirements are not fulfilled, a 'invalid_buffer'
183 error must be raised.
185 If this icon instance already has a buffer of the same size and scale
186 from a previous 'add_buffer' request, data from the last request
187 overrides the preexisting pixel data.
189 The wl_buffer must be kept alive for as long as the xdg_toplevel_icon
190 it is associated with is not destroyed, otherwise a 'no_buffer' error
191 is raised. The buffer contents must not be modified after it was
192 assigned to the icon. As a result, the region of the wl_shm_pool's
193 backing storage used for the wl_buffer must not be modified after this
194 request is sent. The wl_buffer.release event is unused.
196 If this request is made after the icon has been assigned to a toplevel
197 via 'set_icon', a 'immutable' error must be raised.
198 </description>
199 <arg name="buffer" type="object" interface="wl_buffer"/>
200 <arg name="scale" type="int"
201 summary="the scaling factor of the icon, e.g. 1"/>
202 </request>
203 </interface>
204</protocol>
index : raylib-jai
---