Treeland prelaunch splash v1

prelaunch splash screen management

Warning! This protocol is EXPERIMENTAL and under active development. It may change at any time, including in backward-incompatible ways, without incrementing the interface major version and without prior notice. No compatibility guarantees of any kind are provided. Clients and compositors must track the upstream definition in treeland-protocols and must not rely on the current interface names, requests, events, or semantics remaining stable across releases.

prelaunch splash screen manager

This interface is a manager for creating prelaunch splash screens. A prelaunch splash screen is a placeholder surface that is shown before an application's main window is mapped. This helps to improve the perceived startup time.

It is particularly useful for application launchers to provide immediate feedback to the user.

destroy()
destroy the manager
create_splash(app_id: string, sandbox_engine_name: string, icon_buffer: object<wl_buffer>)
Argument
Type
Description
app_idstring
the application ID
sandbox_engine_namestring
the sandbox engine / security context name (required, non-empty)
icon_bufferobject<wl_buffer>allow null
optional icon image as wl_buffer (e.g. wl_shm)
create a new splash screen

Creates a new prelaunch splash screen.

The `app_id` is a string that identifies the application. The compositor will use this ID together with `sandbox_engine_name` to match the splash screen with the actual application window when it appears. This matching mechanism should also work for XWayland windows.

Callers MUST provide a non-empty `sandbox_engine_name` string which identifies the sandboxing/container.

If there is already an active (not-yet-completed) splash for the same `sandbox_engine_name` and `app_id`, the compositor will silently ignore this request (no new splash will be created and no error is raised).


Compositor Support

treeland_prelaunch_splash_manager_v1↓
Compositors
CageCage0.3.0
x
COSMICCOSMIC1.11.0
x
flakewm3.0.5
x
GameScopeGameScope3.17.0
x
HyprlandHyprland0.57.2
x
Jay1.14.0
x
KWinKWin6.7
x
LabwcLabwc0.20.2
x
LouvreLouvre2.14.1
x
MangoMango0.16.3
x
MirMir2.26
x
MuffinMuffin6.7.4
x
MutterMutter51
x
niriniri26.04
x
phocphoc0.55
x
Pila0.5.1
x
QtileQtile0.37.1
x
riverriver0.5.0
x
SwaySway1.11
x
TreelandTreeland0.8.0
1
WayfireWayfire0.9.0
x
WestonWeston15.0.1
x

SPDX-FileCopyrightText: 2025 UnionTech Software Technology Co., Ltd. SPDX-License-Identifier: MIT