Treeland screensaver v1
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.
treeland_screensaver_v1
This object implements a simple idle inhibit protocol used to implement org.freedesktop.ScreenSaver D-Bus interface.
Call inhibit to prevent treeland from entering idle state. Call uninhibit or disconnect from the global to release the inhibit.
If the client disconnects from the compositor, the inhibit associated with that client is automatically released.
There can be only one inhibit per client per time. Calling inhibit multiple times will raise an error. Call uninhibit before inhibit to update application_name and reason recorded.
inhibit(application_name: string, reason_for_inhibit: string)
Argument | Type | Description |
|---|---|---|
| application_name | string | name of the application requesting the inhibit |
| reason_for_inhibit | string | human-readable reason for the inhibit request |
Inhibit idleness with given application_name and reason_for_inhibit.
uninhibit()
Uninhibit idleness previously inhibited by inhibit request.
destroy()
error { not_yet_inhibited, already_inhibited }
Argument | Value | Description |
|---|---|---|
| not_yet_inhibited | 0 | Trying to uninhibit but no active inhibit existed |
| already_inhibited | 1 | Trying to inhibit with an active inhibit existed |
Compositor Support
Copyright
SPDX-FileCopyrightText: 2025 UnionTech Software Technology Co., Ltd. SPDX-License-Identifier: MIT