Treeland output manager

treeland_output_manager_v1

version 2

expose which is the primary display

Protocol for telling which is the primary display among the selection of enabled outputs.

treeland_output_manager_v1::set_primary_output

set_primary_output(output: string)

Argument	Type	Description
output	stringallow null

Select which primary output to use

treeland_output_manager_v1::get_color_control

since 2

get_color_control(id: new_id<treeland_output_color_control_v1>, output: object<wl_output>)

Argument	Type	Description
id	new_id<treeland_output_color_control_v1>
output	object<wl_output>

Get color control interface for output.

treeland_output_manager_v1::destroy

Type: destructorsince 2

destroy()

Destroy the primary output notifier.

treeland_output_manager_v1::primary_output

primary_output(output_name: string)

Argument	Type	Description
output_name	string	the name of the output

Provide the current primary output's name

Specifies which output is the primary one identified by their name.

treeland_output_color_control_v1

version 1

Color control interface for output.

Protocol for controlling color temperature and brightness settings of a specific output.

treeland_output_color_control_v1::set_color_temperature

set_color_temperature(temperature: uint)

Argument	Type	Description
temperature	uint	color temperature in Kelvin

Set color temperature for output

Color temperature settings are applied only after a commit request is made. Setting a value outside the range [1000, 20000] is a protocol error.

treeland_output_color_control_v1::set_brightness

set_brightness(brightness: fixed)

Argument	Type	Description
brightness	fixed	brightness level (in range [0.0, 100.0])

Set brightness for output.

Brightness settings are applied only after a commit request is made. Setting a value outside the range [0.0, 100.0] is a protocol error.

treeland_output_color_control_v1::commit

commit()

Commit the pending color settings changes for output.

treeland_output_color_control_v1::destroy

Type: destructor

destroy()

Destroy the color control interface.

treeland_output_color_control_v1::result

result(success: uint)

Argument	Type	Description
success	uint	1 if the commit was successful, 0 otherwise.

The result of the last commit request.

treeland_output_color_control_v1::color_temperature

color_temperature(temperature: uint)

Argument	Type	Description
temperature	uint	current color temperature in Kelvin

Current color temperature for output.

Provides the current color temperature setting of the output. Color temperature is valued in the range [1000, 20000]. Color temperature is defined as the corresponding temperature (in Kelvin) of the current white point of the display on a Planckian locus. With the current implementation, the neutral temperature is 6600K. This event is sent once after the treeland_output_color_control_v1 object is created, or right after when a color temperature change for the output is successfully commited.

treeland_output_color_control_v1::brightness

brightness(brightness: fixed)

Argument	Type	Description
brightness	fixed	current brightness level (in range [0.0, 100.0])

Current brightness for output.

Provides the current brightness setting of the output. Brightness is valued in the range [0.0, 100.0]. This event is sent once after the treeland_output_color_control_v1 object is created, or right after when a brightness change for the output is successfully commited.

treeland_output_color_control_v1::error

error { invalid_color_temperature, invalid_brightness }

Argument	Value	Description
invalid_color_temperature	1	Invalid color temperature value provided.
invalid_brightness	2	Invalid brightness value provided.

Compositor Support

treeland_output_manager_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.7	x
	Labwc	0.20.2	x
	Louvre	2.14.1	x
	Mir	2.26	x
	Muffin	6.7.4	x
	Mutter	51	x
	niri	26.04	x
	phoc	0.55	x
	river	0.3.13	x
	Sway	1.11	x
	Treeland	0.8.0	2
	Wayfire	0.9.0	x
	Weston	15.0.1	x

Copyright

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