kde_lockscreen_overlay_v1

• # kde_lockscreen_overlay_v1

  Allows a client to request a surface to be visible when the system is locked. This is meant to be used for specific high urgency cases like phone calls or alarms. 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

  • #

    allow

    Tell about which surface could be raised above the lockscreen
    void kde_lockscreen_overlay_v1_allow(

    struct kde_lockscreen_overlay_v1* kde_lockscreen_overlay_v1,

    struct wl_surface* surface

    )
    Informs the compositor that the surface could be shown when the screen is locked. This request should be called while the surface is unmapped.
  • #

    destroy

    Destroy the kde_lockscreen_overlay_v1
    void kde_lockscreen_overlay_v1_destroy(

    struct kde_lockscreen_overlay_v1* kde_lockscreen_overlay_v1

    )
    This won't affect the surface previously marked with the allow request.

  Enums

  • #

    error
    KDE_LOCKSCREEN_OVERLAY_V1_ERROR_INVALID_SURFACE_STATE /* the client provided an invalid surface state */

Copyright Info