Struct WlBuffer 

pub struct WlBuffer { /* private fields */ }

A wl_buffer object.

See the documentation of the module for the interface description.

Implementations

impl WlBuffer

pub fn set_handler(&self, handler: impl WlBufferHandler)

Sets a new handler.

pub fn set_boxed_handler(&self, handler: Box<dyn WlBufferHandler>)

Sets a new, already boxed handler.

impl WlBuffer

pub const MSG__DESTROY__SINCE: u32 = 1u32

Since when the destroy message is available.

pub const MSG__RELEASE__SINCE: u32 = 1u32

Since when the release message is available.

pub fn try_send_destroy(&self) -> Result<(), ObjectError>

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.

pub fn send_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.

pub fn try_send_release(&self) -> Result<(), ObjectError>

compositor releases buffer

Sent when this wl_buffer is no longer used by the compositor.

For more information on when release events may or may not be sent, and what consequences it has, please see the description of wl_surface.attach.

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.

pub fn send_release(&self)

compositor releases buffer

Sent when this wl_buffer is no longer used by the compositor.

For more information on when release events may or may not be sent, and what consequences it has, please see the description of wl_surface.attach.

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

const XML_VERSION: u32 = 1u32

The interface version from the XML file that the interface was generated from.

const INTERFACE: ObjectInterface = ObjectInterface::WlBuffer

The interface of the object.

const INTERFACE_NAME: &str = "wl_buffer"

The interface of the object as a string.

impl Debug for WlBuffer

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

Formats the value using the given formatter.

impl Object for WlBuffer

fn core(&self) -> &ObjectCore

Returns the ObjectCore of this object.

fn unset_handler(&self)

Unsets the handler of this object.

fn get_handler_any_ref( &self, ) -> Result<HandlerRef<'_, dyn Any>, HandlerAccessError>

Returns a shared reference to the handler.

fn get_handler_any_mut( &self, ) -> Result<HandlerMut<'_, dyn Any>, HandlerAccessError>

Returns a mutable reference to the handler.