outputmanagement protocol

org_kde_kwin_outputmanagement interface version 4

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 org_kde_kwin_outputdevice objects. outputmanagement (wl_global) -------------------------- request: * create_configuration -> outputconfiguration (wl_resource) outputconfiguration (wl_resource) -------------------------- requests: * enable(outputdevice, bool) * mode(outputdevice, mode_id) * 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.

Requests

create_configuration(id new_id[org_kde_kwin_outputconfiguration])

org_kde_kwin_outputconfiguration interface version 4

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.

Requests

enable(outputdevice object[org_kde_kwin_outputdevice], enable int)

mode(outputdevice object[org_kde_kwin_outputdevice], mode_id int)

transform(outputdevice object[org_kde_kwin_outputdevice], transform int)

position(outputdevice object[org_kde_kwin_outputdevice], x int, y int)

scale(outputdevice object[org_kde_kwin_outputdevice], scale int)

apply()

scalef(outputdevice object[org_kde_kwin_outputdevice], scale fixed)

colorcurves(outputdevice object[org_kde_kwin_outputdevice], red array, green array, blue array)

~destroy()

overscan(outputdevice object[org_kde_kwin_outputdevice], overscan uint)

set_vrr_policy(outputdevice object[org_kde_kwin_outputdevice], policy uint)

Events

applied()

failed()

Enums

enum vrr_policy {
    never = 0,
    always = 1,
    automatic = 2,
}

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-License-Identifier: MIT-CMU