Treeland output UUID head
Companion of treeland-output-uuid-unstable-v1 for clients that identify outputs through the wlr-output-management protocol. It lets a client obtain the same stable treeland_output_uuid_v1 object from a zwlr_output_head_v1 instead of a wl_output.
A zwlr_output_head_v1 is advertised by the wlr-output-management protocol even while the output is disabled and has no live wl_output global, so this protocol lets clients identify an output in that state. The uuid returned for a head is the same uuid that treeland_output_uuid_manager_v1.get_uuid returns for the wl_output of the same physical output device.
The treeland_output_uuid_v1 interface, including the meaning and stability of the uuid, is defined by treeland-output-uuid-unstable-v1 and is not duplicated here; this protocol only adds a second factory that creates the same object.
The terms "must", "must not", "should", and "may" in this document are to be interpreted as described in RFC 2119.
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_output_uuid_head_manager_v1
A singleton global that creates treeland_output_uuid_v1 objects from zwlr_output_head_v1 objects. The client calls get_uuid for each head it wants to identify; the compositor reports the uuid in the initial uuid event on the returned object. Multiple uuid objects may be created for the same output, whether through this manager or through treeland_output_uuid_manager_v1; each reports independently.
destroy()
Destroy the treeland_output_uuid_head_manager_v1 object and release the client's binding to the manager global.
Existing treeland_output_uuid_v1 objects created through this manager are not affected and must be destroyed separately by the client.
get_uuid(id: new_id<treeland_output_uuid_v1>, head: object<zwlr_output_head_v1>)
Argument | Type | Description |
|---|---|---|
| id | new_id<treeland_output_uuid_v1> | the new output uuid object |
| head | object<zwlr_output_head_v1> | the wlr output head to identify |
Create a treeland_output_uuid_v1 object for the output represented by the given zwlr_output_head_v1. The head may be in any state, including disabled: a wlr_output_head is advertised even when the output is turned off, so this request can identify an output with no live wl_output global.
Compositor Support
Copyright
SPDX-FileCopyrightText: 2024 - 2026 UnionTech Software Technology Co., Ltd. SPDX-License-Identifier: MIT