Struct ExtBackgroundEffectManagerV1

pub struct ExtBackgroundEffectManagerV1 { /* private fields */ }

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.

See also the Event enum for this interface.

Implementations

impl ExtBackgroundEffectManagerV1

pub fn destroy(&self)

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.

pub fn get_background_effect<U: Send + Sync + 'static, D: Dispatch<ExtBackgroundEffectSurfaceV1, U> + 'static>( &self, surface: &WlSurface, qh: &QueueHandle<D>, udata: U, ) -> ExtBackgroundEffectSurfaceV1

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.

Trait Implementations

impl Borrow<ObjectId> for ExtBackgroundEffectManagerV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ExtBackgroundEffectManagerV1

fn clone(&self) -> ExtBackgroundEffectManagerV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExtBackgroundEffectManagerV1

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

Formats the value using the given formatter.

impl Hash for ExtBackgroundEffectManagerV1

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<ExtBackgroundEffectManagerV1>> for ExtBackgroundEffectManagerV1

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for ExtBackgroundEffectManagerV1

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Proxy for ExtBackgroundEffectManagerV1

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 ExtBackgroundEffectManagerV1