Struct ExtBackgroundEffectSurfaceV1

pub struct ExtBackgroundEffectSurfaceV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

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

This interface has no events.

Implementations

impl ExtBackgroundEffectSurfaceV1

pub fn destroy(&self)

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.

pub fn set_blur_region(&self, region: Option<&WlRegion>)

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

The blur region is double-buffered state, and will be applied on the next wl_surface.commit.

The blur algorithm is subject to compositor policies.

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

Trait Implementations

impl Borrow<ObjectId> for ExtBackgroundEffectSurfaceV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ExtBackgroundEffectSurfaceV1

fn clone(&self) -> ExtBackgroundEffectSurfaceV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExtBackgroundEffectSurfaceV1

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

Formats the value using the given formatter.

impl Hash for ExtBackgroundEffectSurfaceV1

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

where H: Hasher,

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

fn eq(&self, other: &Weak<ExtBackgroundEffectSurfaceV1>) -> 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 ExtBackgroundEffectSurfaceV1

fn eq(&self, other: &ExtBackgroundEffectSurfaceV1) -> 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 ExtBackgroundEffectSurfaceV1

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>(&self) -> Option<&U>

where U: Send + Sync + 'static,

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: <ExtBackgroundEffectSurfaceV1 as Proxy>::Request<'_>, ) -> Result<(), InvalidId>

Send a request for this object.

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

where I: Proxy,

Send a request for this object that creates another object.

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

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> ExtBackgroundEffectSurfaceV1

Create an inert object proxy

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

Parse a event for this object

fn write_request<'a>( &self, conn: &Connection, msg: <ExtBackgroundEffectSurfaceV1 as Proxy>::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 ExtBackgroundEffectSurfaceV1