dpms

• # org_kde_kwin_dpms_manager

  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. 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.

  Requests

  • #

    get

    Get org_kde_kwin_dpms for wl_output
    struct org_kde_kwin_dpms* org_kde_kwin_dpms_manager_get(

    struct org_kde_kwin_dpms_manager* org_kde_kwin_dpms_manager,

    struct wl_output* output

    )
    Factory request to get the org_kde_kwin_dpms for a given wl_output.

• # org_kde_kwin_dpms

  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

    Request DPMS state change for the wl_output
    void org_kde_kwin_dpms_set(

    struct org_kde_kwin_dpms* org_kde_kwin_dpms,

    uint32_t mode /* Requested mode */

    )
    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.
  • #

    release

    release the dpms object
    void org_kde_kwin_dpms_release(

    struct org_kde_kwin_dpms* org_kde_kwin_dpms

    )

  Events

  • #

    supported

    Event indicating whether DPMS is supported on the wl_output
    uint32_t supported /* Boolean value whether DPMS is supported (1) for the wl_output or not (0) */
    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).
  • #

    mode

    Event indicating used DPMS mode
    uint32_t mode /* The new currently used mode */
    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.
  • #

    done

    All changes are pushed
    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
    ORG_KDE_KWIN_DPMS_MODE_ON
    ORG_KDE_KWIN_DPMS_MODE_STANDBY
    ORG_KDE_KWIN_DPMS_MODE_SUSPEND
    ORG_KDE_KWIN_DPMS_MODE_OFF

Copyright Info