ext_background_effect_v1 Module
*******************************


ExtBackgroundEffectManagerV1
============================

class pywayland.protocol.ext_background_effect_v1.ExtBackgroundEffectManagerV1

   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.

   destroy() -> 'None'

      -[ Request -- opcode 0 (attached to "Resource" instance) ]-

      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: 'WlSurfaceProxy') -> 'ExtBackgroundEffectSurfaceV1Proxy'

      -[ Request -- opcode 1 (attached to "Resource" instance) ]-

      Get a background effects object

      Instantiate an interface extension for the given "WlSurface" to
      add effects like blur for the background behind it.

      If the given "WlSurface" already has a
      "ExtBackgroundEffectSurfaceV1" object associated, the
      background_effect_exists protocol error will be raised.

      Parameters:
         **surface** ("WlSurface") -- the surface

      Returns:
         "ExtBackgroundEffectSurfaceV1" -- the new
         "ExtBackgroundEffectSurfaceV1" object

   capabilities(flags: 'int') -> 'None'

      -[ Event -- opcode 0 (attached to "Proxy" instance) ]-

      Capabilities of the compositor

      Parameters:
         **flags** (*ArgumentType.Uint*)


ExtBackgroundEffectSurfaceV1
============================

class pywayland.protocol.ext_background_effect_v1.ExtBackgroundEffectSurfaceV1

   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 "WlSurface" associated with the
   "ExtBackgroundEffectSurfaceV1" object has been destroyed, this
   object becomes inert.

   destroy() -> 'None'

      -[ Request -- opcode 0 (attached to "Resource" instance) ]-

      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(region: 'WlRegionProxy | None') -> 'None'

      -[ Request -- opcode 1 (attached to "Resource" instance) ]-

      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 "WlRegion"
      object can be destroyed immediately. A NULL "WlRegion" removes
      the effect.

      The blur region is double-buffered state, and will be applied on
      the next "WlSurface.commit()".

      The blur algorithm is subject to compositor policies.

      If the associated surface has been destroyed, the
      surface_destroyed error will be raised.

      Parameters:
         **region** ("WlRegion" or *None*) -- blur region of the
         surface
