KDE output management v2
kde_output_management_v2
This interface enables clients to set properties of output devices for screen configuration purposes via the server. To this end output devices are referenced by global kde_output_device_v2 objects.
outputmanagement (wl_global) -------------------------- request:
- create_configuration -> outputconfiguration (wl_resource)
outputconfiguration (wl_resource) -------------------------- requests:
- enable(outputdevice, bool)
- mode(outputdevice, mode)
- transformation(outputdevice, flag)
- position(outputdevice, x, y)
- apply
events:
- applied
- failed
The server registers one outputmanagement object as a global object. In order to configure outputs a client requests create_configuration, which provides a resource referencing an outputconfiguration for one-time configuration. That way the server knows which requests belong together and can group them by that.
On the outputconfiguration object the client calls for each output whether the output should be enabled, which mode should be set (by referencing the mode from the list of announced modes) and the output's global position. Once all outputs are configured that way, the client calls apply. At that point and not earlier the server should try to apply the configuration. If this succeeds the server emits the applied signal, otherwise the failed signal, such that the configuring client is noticed about the success of its configuration request.
Through this design the interface enables atomic output configuration changes if internally supported by the server.
Warning! The protocol described in this file is a desktop environment implementation detail. Regular clients must not use this protocol. Backward incompatible changes may be added without bumping the major version of the extension.
create_configuration(id: new_id<kde_output_configuration_v2>)
Argument | Type | Description |
|---|---|---|
| id | new_id<kde_output_configuration_v2> |
Request an outputconfiguration object through which the client can configure output devices.
kde_output_configuration_v2
outputconfiguration is a client-specific resource that can be used to ask the server to apply changes to available output devices.
The client receives a list of output devices from the registry. When it wants to apply new settings, it creates a configuration object from the outputmanagement global, writes changes through this object's enable, scale, transform and mode calls. It then asks the server to apply these settings in an atomic fashion, for example through Linux' DRM interface.
The server signals back whether the new settings have applied successfully or failed to apply. outputdevice objects are updated after the changes have been applied to the hardware and before the server side sends the applied event.
enable(outputdevice: object<kde_output_device_v2>, enable: int)
Argument | Type | Description |
|---|---|---|
| outputdevice | object<kde_output_device_v2> | outputdevice to be en- or disabled |
| enable | int | 1 to enable or 0 to disable this output |
Mark the output as enabled or disabled.
mode(outputdevice: object<kde_output_device_v2>, mode: object<kde_output_device_mode_v2>)
Argument | Type | Description |
|---|---|---|
| outputdevice | object<kde_output_device_v2> | outputdevice this mode change applies to |
| mode | object<kde_output_device_mode_v2> | the mode to apply |
Sets the mode for a given output.
transform(outputdevice: object<kde_output_device_v2>, transform: int)
Argument | Type | Description |
|---|---|---|
| outputdevice | object<kde_output_device_v2> | outputdevice this transformation change applies to |
| transform | int | transform enum |
Sets the transformation for a given output.
position(outputdevice: object<kde_output_device_v2>, x: int, y: int)
Argument | Type | Description |
|---|---|---|
| outputdevice | object<kde_output_device_v2> | outputdevice this position applies to |
| x | int | position on the x-axis |
| y | int | position on the y-axis |
Sets the position for this output device. (x,y) describe the top-left corner of the output in global space, whereby the origin (0,0) of the global space has to be aligned with the top-left corner of the most left and in case this does not define a single one the top output.
There may be no gaps or overlaps between outputs, i.e. the outputs are stacked horizontally, vertically, or both on each other.
scale(outputdevice: object<kde_output_device_v2>, scale: fixed)
Argument | Type | Description |
|---|---|---|
| outputdevice | object<kde_output_device_v2> | outputdevice this scale change applies to |
| scale | fixed | scaling factor |
Sets the scaling factor for this output device.
apply()
Asks the server to apply property changes requested through this outputconfiguration object to all outputs on the server side.
The output configuration can be applied only once. The already_applied protocol error will be posted if the apply request is called the second time.
overscan(outputdevice: object<kde_output_device_v2>, overscan: uint)
Argument | Type | Description |
|---|---|---|
| outputdevice | object<kde_output_device_v2> | outputdevice overscan applies to |
| overscan | uint | overscan value |
Set the overscan value of this output device with a value in percent.
set_vrr_policy(outputdevice: object<kde_output_device_v2>, policy: uint<kde_output_configuration_v2.vrr_policy>)
Argument | Type | Description |
|---|---|---|
| outputdevice | object<kde_output_device_v2> | outputdevice this VRR policy applies to |
| policy | uint<kde_output_configuration_v2.vrr_policy> | the vrr policy to apply |
Set what policy the compositor should employ regarding its use of variable refresh rate.
set_rgb_range(outputdevice: object<kde_output_device_v2>, rgb_range: uint<kde_output_configuration_v2.rgb_range>)
Argument | Type | Description |
|---|---|---|
| outputdevice | object<kde_output_device_v2> | outputdevice the rgb range applies to |
| rgb_range | uint<kde_output_configuration_v2.rgb_range> |
Whether full or limited color range should be used
set_primary_output(output: object<kde_output_device_v2>)
Argument | Type | Description |
|---|---|---|
| output | object<kde_output_device_v2>allow null |
set_priority(outputdevice: object<kde_output_device_v2>, priority: uint)
Argument | Type | Description |
|---|---|---|
| outputdevice | object<kde_output_device_v2> | outputdevice the index applies to |
| priority | uint | the priority of the output |
The order of outputs can be used to assign desktop environment components to a specific screen, see kde_output_order_v1 for details. The priority is 1-based for outputs that will be enabled after this changeset is applied, all outputs that are disabled need to have the index set to zero.
set_high_dynamic_range(outputdevice: object<kde_output_device_v2>, enable_hdr: uint)
Argument | Type | Description |
|---|---|---|
| outputdevice | object<kde_output_device_v2> | outputdevice this setting applies to |
| enable_hdr | uint | 1 to enable, 0 to disable hdr |
Sets whether or not the output should be set to HDR mode.
set_sdr_brightness(outputdevice: object<kde_output_device_v2>, sdr_brightness: uint)
Argument | Type | Description |
|---|---|---|
| outputdevice | object<kde_output_device_v2> | outputdevice this setting applies to |
| sdr_brightness | uint |
Sets the brightness of standard dynamic range content in nits. Only has an effect while the output is in HDR mode. Note that while the value is in nits, that doesn't necessarily translate to the same brightness on the screen.
set_wide_color_gamut(outputdevice: object<kde_output_device_v2>, enable_wcg: uint)
Argument | Type | Description |
|---|---|---|
| outputdevice | object<kde_output_device_v2> | outputdevice this setting applies to |
| enable_wcg | uint | 1 to enable, 0 to disable wcg |
Whether or not the output should use a wide color gamut
set_auto_rotate_policy(outputdevice: object<kde_output_device_v2>, policy: uint<kde_output_configuration_v2.auto_rotate_policy>)
Argument | Type | Description |
|---|---|---|
| outputdevice | object<kde_output_device_v2> | outputdevice this setting applies to |
| policy | uint<kde_output_configuration_v2.auto_rotate_policy> |
set_icc_profile_path(outputdevice: object<kde_output_device_v2>, profile_path: string)
Argument | Type | Description |
|---|---|---|
| outputdevice | object<kde_output_device_v2> | outputdevice this setting applies to |
| profile_path | string |
set_brightness_overrides(outputdevice: object<kde_output_device_v2>, max_peak_brightness: int, max_frame_average_brightness: int, min_brightness: int)
Argument | Type | Description |
|---|---|---|
| outputdevice | object<kde_output_device_v2> | outputdevice this setting applies to |
| max_peak_brightness | int | -1 for not overriding, or positive values in nits |
| max_frame_average_brightness | int | -1 for not overriding, or positive values in nits |
| min_brightness | int | -1 for not overriding, or positive values in 0.0001 nits |
set_sdr_gamut_wideness(outputdevice: object<kde_output_device_v2>, gamut_wideness: uint)
Argument | Type | Description |
|---|---|---|
| outputdevice | object<kde_output_device_v2> | outputdevice this setting applies to |
| gamut_wideness | uint | 0 means rec.709 primaries, 10000 means native primaries |
This can be used to provide the colors users assume sRGB applications should have based on the default experience on many modern sRGB screens.
set_color_profile_source(outputdevice: object<kde_output_device_v2>, color_profile_source: uint<kde_output_configuration_v2.color_profile_source>)
Argument | Type | Description |
|---|---|---|
| outputdevice | object<kde_output_device_v2> | outputdevice this setting applies to |
| color_profile_source | uint<kde_output_configuration_v2.color_profile_source> | the color profile source |
set_brightness(outputdevice: object<kde_output_device_v2>, brightness: uint)
Argument | Type | Description |
|---|---|---|
| outputdevice | object<kde_output_device_v2> | outputdevice this setting applies to |
| brightness | uint | brightness in 0-10000 |
Set the brightness modifier of the output. It doesn't specify any absolute values, but is merely a multiplier on top of other brightness values, like sdr_brightness and brightness_metadata. 0 is the minimum brightness (not completely dark) and 10000 is the maximum brightness. This is supported while HDR is active in versions 8 and below, or when the device supports the brightness_control capability in versions 9 and above.
set_color_power_tradeoff(outputdevice: object<kde_output_device_v2>, preference: uint<kde_output_configuration_v2.color_power_tradeoff>)
Argument | Type | Description |
|---|---|---|
| outputdevice | object<kde_output_device_v2> | outputdevice this setting applies to |
| preference | uint<kde_output_configuration_v2.color_power_tradeoff> |
set_dimming(outputdevice: object<kde_output_device_v2>, multiplier: uint)
Argument | Type | Description |
|---|---|---|
| outputdevice | object<kde_output_device_v2> | outputdevice this setting applies to |
| multiplier | uint | multiplier in 0-10000 |
Set the dimming multiplier of the output. This is similar to the brightness setting, except it's meant to be a temporary setting only, not persistent and may be implemented differently depending on the display. 0 is the minimum dimming factor (not completely dark) and 10000 means the output is not dimmed.
This is supported only when the brightness_control capability is also supported.
applied()
Sent after the server has successfully applied the changes. .
failed()
Sent if the server rejects the changes or failed to apply them.
failure_reason(reason: string)
Argument | Type | Description |
|---|---|---|
| reason | string | reason for failure |
Describes why applying the output configuration failed. Is only sent before the failure event.
error { already_applied }
Argument | Value | Description |
|---|---|---|
| already_applied | 0 | the config is already applied |
These error can be emitted in response to kde_output_configuration_v2 requests.
Describes when the compositor may employ variable refresh rate
Whether this output should use full or limited rgb.
auto_rotate_policy { never, in_tablet_mode, always }
Argument | Value | Description |
|---|---|---|
| never | 0 | |
| in_tablet_mode | 1 | |
| always | 2 |
color_power_tradeoff { efficiency, accuracy }
Argument | Value | Description |
|---|---|---|
| efficiency | 0 | prefer efficiency and performance |
| accuracy | 1 | prefer accuracy |
The compositor can do a lot of things that trade between performance, power and color accuracy. This setting describes a high level preference from the user about in which direction that tradeoff should be made.
Compositor Support
Mutter  | KWin  | Sway  | COSMIC  | Hyprland  | niri | Weston  | Labwc  | Cage | Wayfire  | GameScope  | Jay | Mir  | Treeland  | Louvre  | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| kde_output_management_v2 | x | 12 | x | x | x | x | x | x | x | x | x | x | x | x | x |
Copyright
SPDX-FileCopyrightText: 2008-2011 Kristian Høgsberg SPDX-FileCopyrightText: 2010-2011 Intel Corporation SPDX-FileCopyrightText: 2012-2013 Collabora, Ltd. SPDX-FileCopyrightText: 2015 Sebastian Kügler <sebas@kde.org> SPDX-FileCopyrightText: 2021 Méven Car <meven.car@enioka.com> SPDX-FileCopyrightText: 2023 Xaver Hugl <xaver.hugl@kde.org>
SPDX-License-Identifier: MIT-CMU