Treeland DDM

private communication between treeland and ddm

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_ddm_v1

Deprecatedversion 2
core global for treeland - ddm connection

This is the treeland - ddm private communication protocol.

This object is primarily used for establish connection between treeland and ddm.

switch_to_greeter()
send treeland to greeter mode

Send treeland to Greeter mode.

switch_to_user(username: string)
Argument
Type
Description
usernamestring
the user to switch to
call treeland to switch lockscreen user

Set lockscreen user to username. Ignore when username is "ddm". This is used to prevent ddm from triggering a user switch back to the greeter.

activate_session()
activate wayland session

Activate treeland session. This will makes treeland try to take control of screen.

deactivate_session()
deactivate wayland session

Deactivate treeland session. This will release control of the screen, but not to close the current seats.

enable_render()
start treeland rendering

Enable treeland rendering. This is primarily called after disable_render to resume treeland.

disable_render(callback: new_id<wl_callback>)
Argument
Type
Description
callbacknew_id<wl_callback>
callback sent when rendering has been disabled
stop treeland rendering

Disable treeland rendering. This will prevent treeland from output to DRM device.

destroy
Type: destructorsince 2
destroy()
Destroy the treeland_ddm_v1

Destroys this treeland_ddm_v1 object.

switch_to_vt(vtnr: int)
Argument
Type
Description
vtnrint
the virtual terminal number to switch to
switch to virtual terminal

Call ddm to switch current virtual terminal to vtnr. ddm should take care of the switch and call ioctl respectively.

acquire_vt(vtnr: int)
Argument
Type
Description
vtnrint
the virtual terminal number to acquire
acquire control of virtual terminal

Call ddm to acquire control of VT at vtnr. ddm should call VT_SETMODE respectively.


Compositor Support

No compositor support found

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