1<?xml version="1.0" encoding="UTF-8"?>
2<protocol name="ext_background_effect_v1">
3 <copyright>
4 Copyright (C) 2015 Martin Gräßlin
5 Copyright (C) 2015 Marco Martin
6 Copyright (C) 2020 Vlad Zahorodnii
7 Copyright (C) 2024 Xaver Hugl
8
9 Permission is hereby granted, free of charge, to any person obtaining a
10 copy of this software and associated documentation files (the "Software"),
11 to deal in the Software without restriction, including without limitation
12 the rights to use, copy, modify, merge, publish, distribute, sublicense,
13 and/or sell copies of the Software, and to permit persons to whom the
14 Software is furnished to do so, subject to the following conditions:
15
16 The above copyright notice and this permission notice (including the next
17 paragraph) shall be included in all copies or substantial portions of the
18 Software.
19
20 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
23 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
25 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
26 DEALINGS IN THE SOFTWARE.
27 </copyright>
28
29 <interface name="ext_background_effect_manager_v1" version="1">
30 <description summary="background effect factory">
31 This protocol provides a way to improve visuals of translucent surfaces
32 by applying effects like blur to the background behind them.
33
34 The capabilities are send when the global is bound, and every time they
35 change. Note that when the capability goes away, the corresponding effect
36 is no longer applied by the compositor, even if it was set before.
37
38 Warning! The protocol described in this file is currently in the testing
39 phase. Backward compatible changes may be added together with the
40 corresponding interface version bump. Backward incompatible changes can
41 only be done by creating a new major version of the extension.
42 </description>
43
44 <request name="destroy" type="destructor">
45 <description summary="destroy the background effect manager">
46 Informs the server that the client will no longer be using this
47 protocol object. Existing objects created by this object are not
48 affected.
49 </description>
50 </request>
51
52 <enum name="error">
53 <entry name="background_effect_exists" value="0"
54 summary="the surface already has a background effect object"/>
55 </enum>
56
57 <enum name="capability" bitfield="true">
58 <entry name="blur" value="1"
59 summary="the compositor supports applying blur"/>
60 </enum>
61
62 <event name="capabilities">
63 <description summary="capabilities of the compositor"/>
64 <arg name="flags" type="uint" enum="capability"/>
65 </event>
66
67 <request name="get_background_effect">
68 <description summary="get a background effects object">
69 Instantiate an interface extension for the given wl_surface to add
70 effects like blur for the background behind it.
71
72 If the given wl_surface already has a ext_background_effect_surface_v1
73 object associated, the background_effect_exists protocol error will be
74 raised.
75 </description>
76 <arg name="id" type="new_id" interface="ext_background_effect_surface_v1"
77 summary="the new ext_background_effect_surface_v1 object"/>
78 <arg name="surface" type="object" interface="wl_surface"
79 summary="the surface"/>
80 </request>
81 </interface>
82
83 <interface name="ext_background_effect_surface_v1" version="1">
84 <description summary="background effects for a surface">
85 The background effect object provides a way to specify a region behind
86 a surface that should have background effects like blur applied.
87
88 If the wl_surface associated with the ext_background_effect_surface_v1
89 object has been destroyed, this object becomes inert.
90 </description>
91
92 <request name="destroy" type="destructor">
93 <description summary="release the blur object">
94 Informs the server that the client will no longer be using this protocol
95 object. The effect regions will be removed on the next commit.
96 </description>
97 </request>
98
99 <enum name="error">
100 <entry name="surface_destroyed" value="0"
101 summary="the associated surface has been destroyed"/>
102 </enum>
103
104 <request name="set_blur_region">
105 <description summary="set blur region">
106 This request sets the region of the surface that will have its
107 background blurred.
108
109 The blur region is specified in the surface-local coordinates, and
110 clipped by the compositor to the surface size.
111
112 The initial value for the blur region is empty. Setting the pending
113 blur region has copy semantics, and the wl_region object can be
114 destroyed immediately. A NULL wl_region removes the effect.
115
116 The blur region is double-buffered state, and will be applied on
117 the next wl_surface.commit.
118
119 The blur algorithm is subject to compositor policies.
120
121 If the associated surface has been destroyed, the surface_destroyed
122 error will be raised.
123 </description>
124 <arg name="region" type="object" interface="wl_region" allow-null="true"
125 summary="blur region of the surface"/>
126 </request>
127
128 </interface>
129</protocol>