KDE lockscreen overlay

kde-lockscreen-overlay-v1

kde_lockscreen_overlay_v1

version 1

Allow surfaces over the lockscreen

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.

allow(surface: object<wl_surface>)

Argument	Type	Description
surface	object<wl_surface>

Tell about which surface could be raised above the lockscreen

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

Type: destructor

destroy()

Destroy the kde_lockscreen_overlay_v1

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

error { invalid_surface_state }

Argument	Value	Description
invalid_surface_state	0	the client provided an invalid surface state

No compositor support found

SPDX-FileCopyrightText: 2022 Aleix Pol Gonzalez <aleixpol@kde.org>

SPDX-License-Identifier: LGPL-2.1-or-later