Struct wayland_protocols::wp::alpha_modifier::v1::generated::client::wp_alpha_modifier_surface_v1::WpAlphaModifierSurfaceV1

pub struct WpAlphaModifierSurfaceV1 {
    id: ObjectId,
    version: u32,
    data: Option<Arc<dyn ObjectData>>,
    backend: WeakBackend,
}

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 wl_surface. Once the wl_surface is destroyed, all request on this object will raise the no_surface error.

This interface has no events.

Fields

id: ObjectId

version: u32

data: Option<Arc<dyn ObjectData>>

backend: WeakBackend

Implementations

impl WpAlphaModifierSurfaceV1

pub fn destroy(&self)

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.

pub fn set_multiplier(&self, factor: u32)

specify the alpha multiplier

Sets the alpha multiplier for the surface. The alpha multiplier is double-buffered state, see wl_surface.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 wl_surface. 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 wl_surface 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.

Trait Implementations

impl Borrow<ObjectId> for WpAlphaModifierSurfaceV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for WpAlphaModifierSurfaceV1

fn clone(&self) -> WpAlphaModifierSurfaceV1

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WpAlphaModifierSurfaceV1

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for WpAlphaModifierSurfaceV1

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Weak<WpAlphaModifierSurfaceV1>> for WpAlphaModifierSurfaceV1

fn eq(&self, other: &Weak<WpAlphaModifierSurfaceV1>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for WpAlphaModifierSurfaceV1

fn eq(&self, other: &WpAlphaModifierSurfaceV1) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Proxy for WpAlphaModifierSurfaceV1

type Request<'request> = Request<'request>

The request enum for this interface

type Event = Event

The event enum for this interface

fn interface() -> &'static Interface

The interface description

fn id(&self) -> ObjectId

The ID of this object

fn version(&self) -> u32

The version of this object

fn data<U: Send + Sync + 'static>(&self) -> Option<&U>

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn ObjectData>>

Access the raw data associated with this object.

fn backend(&self) -> &WeakBackend

Access the backend associated with this object

fn send_request(&self, req: Self::Request<'_>) -> Result<(), InvalidId>

Send a request for this object.

fn send_constructor<I: Proxy>( &self, req: Self::Request<'_>, data: Arc<dyn ObjectData>, ) -> Result<I, InvalidId>

Send a request for this object that creates another object.

fn from_id(conn: &Connection, id: ObjectId) -> Result<Self, InvalidId>

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> Self

Create an inert object proxy

fn parse_event( conn: &Connection, msg: Message<ObjectId, OwnedFd>, ) -> Result<(Self, Self::Event), DispatchError>

Parse a event for this object

fn write_request<'a>( &self, conn: &Connection, msg: Self::Request<'a>, ) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>

Serialize a request for this object

fn is_alive(&self) -> bool

Checks if the Wayland object associated with this proxy is still alive

fn downgrade(&self) -> Weak<Self>

Creates a weak handle to this object

impl Eq for WpAlphaModifierSurfaceV1