ext_background_effect_surface_v1¤
wayland.ext_background_effect_surface_v1 ¤
Background effects for a surface
The background effect object provides a way to specify a region behind a surface that should have background effects like blur applied.
If the wl_surface associated with the ext_background_effect_surface_v1 object has been destroyed, this object becomes inert.
Methods:
-
destroy
–Release the blur object
-
set_blur_region
–Set blur region
error ¤
-
surface_destroyed
–The associated surface has been destroyed
destroy ¤
destroy() -> None
Release the blur object
Informs the server that the client will no longer be using this protocol object. The effect regions will be removed on the next commit.
set_blur_region ¤
Set blur region
This request sets the region of the surface that will have its background blurred.
The blur region is specified in the surface-local coordinates, and clipped by the compositor to the surface size.
The initial value for the blur region is empty. Setting the pending blur region has copy semantics, and the wl_region object can be destroyed immediately. A NULL wl_region removes the effect.
The blur region is double-buffered state, and will be applied on the next wl_surface.commit.
The blur algorithm is subject to compositor policies.
If the associated surface has been destroyed, the surface_destroyed error will be raised.
Parameters: