XApp Shell
xapp_shell_v1
xapp_shell is a private protocol extension that lets clients attach XApp-specific window-manager hints to their toplevel surfaces. It is the Wayland counterpart of the X11 _NET_WM_XAPP_* window properties used by the Cinnamon desktop: a themed icon name (resolved crisply by the compositor at any scale) and task-manager progress information.
The compositor advertises which hints it understands through the 'capabilities' event, allowing clients to negotiate features instead of relying on the interface version alone.
get_xapp_surface(id: new_id<xapp_surface_v1>, surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| id | new_id<xapp_surface_v1> | |
| surface | object<wl_surface> |
Create an xapp_surface_v1 object associated with the given wl_surface, through which XApp hints can be set on the corresponding window.
destroy()
Destroy the xapp_shell_v1 object. This does not affect any xapp_surface_v1 objects created with it.
capabilities(capabilities: uint<xapp_shell_v1.capability>)
Argument | Type | Description |
|---|---|---|
| capabilities | uint<xapp_shell_v1.capability> |
This event is sent once when the client binds the global, describing the set of hints the compositor supports.
xapp_surface_v1
An xapp_surface_v1 carries XApp hints for the wl_surface it was created for. Setting a hint takes effect immediately. The hints persist until changed or unset; destroying the object does not reset them.
set_icon_name(icon_name: string)
Argument | Type | Description |
|---|---|---|
| icon_name | stringallow null |
Set a themed icon name, or an absolute path to an icon file, that the compositor and its desktop shell should use for this window in titlebars, task lists and window switchers. Pass a null name to unset it.
set_progress(progress: int)
Argument | Type | Description |
|---|---|---|
| progress | int |
Set a progress value, from 0 to 100, to be displayed by a task manager for this window. A value of 0 clears the progress. Setting an explicit progress value also clears the pulsing state.
set_progress_pulse(pulse: uint)
Argument | Type | Description |
|---|---|---|
| pulse | uint |
Set whether the window should show indeterminate ('pulsing') progress. A non-zero value enables pulsing.
destroy()
Destroy the xapp_surface_v1 object. Hints already set on the window are left untouched.
Compositor Support
| xapp_shell_v1 | ↓ | ||
| Compositors | |||
 | Cage | 0.3.0 | x |
 | COSMIC | 1.0.0~beta.8 | x |
 | GameScope | 3.15.14 | x |
 | Hyprland | 0.52.1 | x |
| Jay | 1.14.0 | x | |
 | KWin | 6.6 | x |
 | Labwc | 0.20.2 | x |
 | Louvre | 2.14.1 | x |
 | Mir | 2.26 | x |
 | Muffin | 6.7.4 | 1 |
 | Mutter | 50.4 | x |
 | niri | 26.04 | x |
 | phoc | 0.55 | x |
 | river | 0.3.13 | x |
 | Sway | 1.11 | x |
 | Treeland | 0.8.0 | x |
 | Wayfire | 0.9.0 | x |
 | Weston | 14.0.2 | x |
Copyright
Copyright © 2026 Linux Mint
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 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.