dpms protocol

org_kde_kwin_dpms_manager interface version 1

The Dpms manager allows to get a org_kde_kwin_dpms for a given wl_output. The org_kde_kwin_dpms provides the currently used VESA Display Power Management Signaling state (see https://en.wikipedia.org/wiki/VESA_Display_Power_Management_Signaling ). In addition it allows to request a state change. A compositor is not obliged to honor it and will normally automatically switch back to on state.

Requests

get since version 0

get(id new_id[org_kde_kwin_dpms], output object[wl_output])

Factory request to get the org_kde_kwin_dpms for a given wl_output.

Arguments

Name	Type	Description
id	new_id[org_kde_kwin_dpms]
output	object[wl_output]

org_kde_kwin_dpms interface version 1

This interface provides information about the VESA DPMS state for a wl_output. It gets created through the request get on the org_kde_kwin_dpms_manager interface. On creating the resource the server will push whether DPSM is supported for the output, the currently used DPMS state and notifies the client through the done event once all states are pushed. Whenever a state changes the set of changes is committed with the done event.

Requests

set since version 0

set(mode uint)

Requests that the compositor puts the wl_output into the passed mode. The compositor is not obliged to change the state. In addition the compositor might leave the mode whenever it seems suitable. E.g. the compositor might return to On state on user input. The client should not assume that the mode changed after requesting a new mode. Instead the client should listen for the mode event.

Arguments

Name	Type	Description
mode	uint	Requested mode

release (destructor) since version 0

~release()

Events

supported since version 0

supported(supported uint)

This event gets pushed on binding the resource and indicates whether the wl_output supports DPMS. There are operation modes of a Wayland server where DPMS might not make sense (e.g. nested compositors).

Arguments

Name	Type	Description
supported	uint	Boolean value whether DPMS is supported (1) for the wl_output or not (0)

mode since version 0

mode(mode uint)

This mode gets pushed on binding the resource and provides the currently used DPMS mode. It also gets pushed if DPMS is not supported for the wl_output, in that case the value will be On. The event is also pushed whenever the state changes.

Arguments

Name	Type	Description
mode	uint	The new currently used mode

done since version 0

done()

This event gets pushed on binding the resource once all other states are pushed. In addition it gets pushed whenever a state changes to tell the client that all state changes have been pushed.

Enums

mode since version 0

enum mode {
    On = 0,
    Standby = 1,
    Suspend = 2,
    Off = 3,
}

Entries

Name	Value	Description
On	0
Standby	1
Suspend	2
Off	3

SPDX-FileCopyrightText: 2015 Martin Gräßlin SPDX-License-Identifier: LGPL-2.1-or-later