Struct wayland_client::protocol::wl_buffer::WlBuffer

pub struct WlBuffer { /* private fields */ }

content for a wl_surface

A buffer provides the content for a wl_surface. Buffers are created through factory interfaces such as wl_shm, wp_linux_buffer_params (from the linux-dmabuf protocol extension) or similar. It has a width and a height and can be attached to a wl_surface, but the mechanism by which a client provides and updates the contents is defined by the buffer factory interface.

If the buffer uses a format that has an alpha channel, the alpha channel is assumed to be premultiplied in the color channels unless otherwise specified.

Note, because wl_buffer objects are created from multiple independent factory interfaces, the wl_buffer interface is frozen at version 1.

See also the Event enum for this interface.

Implementations

impl WlBuffer

pub fn destroy(&self)

destroy a buffer

Destroy a buffer. If and how you need to release the backing storage is defined by the buffer factory interface.

For possible side-effects to a surface, see wl_surface.attach.

Trait Implementations

impl Borrow<ObjectId> for WlBuffer

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for WlBuffer

fn clone(&self) -> WlBuffer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WlBuffer

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

Formats the value using the given formatter.

impl Hash for WlBuffer

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

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

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

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 WlBuffer