alpha_modifier_v1 Module
************************


WpAlphaModifierSurfaceV1
========================

class pywayland.protocol.alpha_modifier_v1.WpAlphaModifierSurfaceV1

   Alpha modifier object for a surface

   This interface allows the client to set a factor for the alpha
   values on a surface, which can be used to offload such operations
   to the compositor. The default factor is UINT32_MAX.

   This object has to be destroyed before the associated "WlSurface".
   Once the "WlSurface" is destroyed, all request on this object will
   raise the no_surface error.

   destroy() -> 'None'

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

      Destroy the alpha modifier object

      This destroys the object, and is equivalent to set_multiplier
      with a value of UINT32_MAX, with the same double-buffered
      semantics as set_multiplier.

   set_multiplier(factor: 'int') -> 'None'

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

      Specify the alpha multiplier

      Sets the alpha multiplier for the surface. The alpha multiplier
      is double-buffered state, see "WlSurface.commit()" for details.

      This factor is applied in the compositor's blending space, as an
      additional step after the processing of per-pixel alpha values
      for the "WlSurface". The exact meaning of the factor is thus
      undefined, unless the blending space is specified in a different
      extension.

      This multiplier is applied even if the buffer attached to the
      "WlSurface" doesn't have an alpha channel; in that case an alpha
      value of one is used instead.

      Zero means completely transparent, UINT32_MAX means completely
      opaque.

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


WpAlphaModifierV1
=================

class pywayland.protocol.alpha_modifier_v1.WpAlphaModifierV1

   Surface alpha modifier manager

   This interface allows a client to set a factor for the alpha values
   on a surface, which can be used to offload such operations to the
   compositor, which can in turn for example offload them to KMS.

   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 alpha modifier manager object

      Destroy the alpha modifier manager. This doesn't destroy objects
      created with the manager.

   get_surface(surface: 'WlSurfaceProxy') -> 'WpAlphaModifierSurfaceV1Proxy'

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

      Create a new alpha modifier surface object

      Create a new alpha modifier surface object associated with the
      given "WlSurface". If there is already such an object associated
      with the "WlSurface", the already_constructed error will be
      raised.

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

      Returns:
         "WpAlphaModifierSurfaceV1"
