<?xml version="1.0" encoding="UTF-8"?>
<protocol name="layer_shadow">
<copyright><![CDATA[
Copyright © 2024 Playtron
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice (including the next
paragraph) shall be included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
]]></copyright>
<description summary="request shadow rendering for layer surfaces">
This protocol provides a way for clients to request that the compositor
render a shadow behind their layer shell surfaces.
This is useful for floating panels, notifications, and other overlay
elements that want a drop shadow effect without having to render it
themselves.
</description>
<interface name="layer_shadow_manager_v1" version="1">
<description summary="shadow manager for layer surfaces">
Manager for creating shadow objects for surfaces.
This is designed for layer shell surfaces but works with any wl_surface.
</description>
<request name="destroy" type="destructor">
<description summary="Destroy the global">
Informs the server that the client will no longer use this global.
Any previously created shadow objects remain valid until destroyed.
</description>
</request>
<request name="get_shadow">
<description summary="Create a new shadow object for a surface">
Instantiate an interface extension for the given wl_surface to request shadow.
If the given wl_surface already has a layer_shadow_surface_v1 object associated,
the shadow_exists protocol error will be raised.
</description>
<arg name="id" type="new_id" interface="layer_shadow_surface_v1"
summary="the new layer_shadow_surface_v1 object"/>
<arg name="surface" type="object" interface="wl_surface"
summary="the surface"/>
</request>
<enum name="error">
<entry name="shadow_exists" value="0"
summary="the surface already has a shadow object"/>
</enum>
</interface>
<interface name="layer_shadow_surface_v1" version="1">
<description summary="shadow for a surface">
The shadow object provides a way to request a shadow
for its associated surface.
If the wl_surface associated with the layer_shadow_surface_v1
object has been destroyed, this object becomes inert. Any further requests
other than destroy will raise the surface_destroyed protocol error.
</description>
<request name="destroy" type="destructor">
<description summary="Destroy the shadow object">
Informs the server that the client will no longer be using this protocol
object. The shadow will be removed on the next commit.
</description>
</request>
<request name="enable">
<description summary="Enable shadow rendering">
This request enables shadow rendering for the surface.
The shadow state is double-buffered and will be applied on
the next wl_surface.commit.
</description>
</request>
<request name="disable">
<description summary="Disable shadow rendering">
This request disables shadow rendering for the surface.
The shadow state is double-buffered and will be applied on
the next wl_surface.commit.
</description>
</request>
<enum name="error">
<entry name="surface_destroyed" value="0"
summary="the wl_surface was destroyed"/>
</enum>
</interface>
</protocol>