ext_background_effect_manager_v1¤
Background effect factory
This protocol provides a way to improve visuals of translucent surfaces by applying effects like blur to the background behind them.
The capabilities are send when the global is bound, and every time they change. Note that when the capability goes away, the corresponding effect is no longer applied by the compositor, even if it was set before.
Warning! The protocol described in this file is currently in the testing phase. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes can only be done by creating a new major version of the extension.
Methods:
-
destroy–Destroy the background effect manager
-
get_background_effect–Get a background effects object
-
on_capabilities–Capabilities of the compositor.
-
background_effect_exists–The surface already has a background effect object
destroy() -> None
Destroy the background effect manager
Informs the server that the client will no longer be using this protocol object. Existing objects created by this object are not affected.
get_background_effect(surface: wl_surface) -> ext_background_effect_surface_v1
Get a background effects object
Instantiate an interface extension for the given wl_surface to add effects like blur for the background behind it.
If the given wl_surface already has a ext_background_effect_surface_v1 object associated, the background_effect_exists protocol error will be raised.
Parameters:
-
(surface¤wl_surface) –The surface
Returns:
-
ext_background_effect_surface_v1(ext_background_effect_surface_v1) –The created object
on_capabilities(flags: capability) -> None
Capabilities of the compositor.
Override to handle wayland.ext_background_effect_manager_v1.events.capabilities.