Struct wayland_server::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.

See also the Request enum for this interface.

Implementations

impl WlBuffer

pub fn release(&self)

compositor releases buffer

Sent when this wl_buffer is no longer used by the compositor. The client is now free to reuse or destroy this buffer and its backing storage.

If a client receives a release event before the frame callback requested in the same wl_surface.commit that attaches this wl_buffer to a surface, then the client is immediately free to reuse the buffer and its backing storage, and does not need a second buffer for the next surface content update. Typically this is possible, when the compositor maintains a copy of the wl_surface contents, e.g. as a GL texture. This is an important optimization for GL(ES) compositors with wl_shm clients.

Trait Implementations

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 PartialEq<WlBuffer> 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 !=.

impl Resource for WlBuffer

type Request = Request

type Event = Event

fn interface() -> &'static Interface

fn id(&self) -> ObjectId

fn version(&self) -> u32

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

fn object_data(&self) -> Option<&Arc<dyn Any + Send + Sync>>

fn handle(&self) -> &WeakHandle

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

fn send_event(&self, evt: Self::Event) -> Result<(), InvalidId>

fn parse_request(
    conn: &DisplayHandle,
    msg: Message<ObjectId>
) -> Result<(Self, Self::Request), DispatchError>

fn write_event(
    &self,
    conn: &DisplayHandle,
    msg: Self::Event
) -> Result<Message<ObjectId>, InvalidId>

fn post_error(
    &self,
    dh: &DisplayHandle,
    code: impl Into<u32>,
    error: impl Into<String>
)

impl Eq for WlBuffer