Struct wayland_client::protocol::wl_shm_pool::WlShmPool
source · [−]pub struct WlShmPool { /* private fields */ }
Expand description
a shared memory pool
The wl_shm_pool object encapsulates a piece of memory shared between the compositor and client. Through the wl_shm_pool object, the client can allocate shared memory wl_buffer objects. All objects created through the same pool share the same underlying mapped memory. Reusing the mapped memory avoids the setup/teardown overhead and is useful when interactively resizing a surface or for many small buffers.
This interface has no events.
Implementations
sourceimpl WlShmPool
impl WlShmPool
sourcepub fn create_buffer<U: Send + Sync + 'static, D: Dispatch<WlBuffer, U> + 'static>(
&self,
offset: i32,
width: i32,
height: i32,
stride: i32,
format: Format,
qh: &QueueHandle<D>,
udata: U
) -> Result<WlBuffer, InvalidId>
pub fn create_buffer<U: Send + Sync + 'static, D: Dispatch<WlBuffer, U> + 'static>(
&self,
offset: i32,
width: i32,
height: i32,
stride: i32,
format: Format,
qh: &QueueHandle<D>,
udata: U
) -> Result<WlBuffer, InvalidId>
create a buffer from the pool
Create a wl_buffer object from the pool.
The buffer is created offset bytes into the pool and has width and height as specified. The stride argument specifies the number of bytes from the beginning of one row to the beginning of the next. The format is the pixel format of the buffer and must be one of those advertised through the wl_shm.format event.
A buffer will keep a reference to the pool it was created from so it is valid to destroy the pool immediately after creating a buffer from it.
Trait Implementations
sourceimpl Proxy for WlShmPool
impl Proxy for WlShmPool
sourcefn data<U: Send + Sync + 'static>(&self) -> Option<&U>
fn data<U: Send + Sync + 'static>(&self) -> Option<&U>
Access the user-data associated with this object
sourcefn object_data(&self) -> Option<&Arc<dyn ObjectData>>
fn object_data(&self) -> Option<&Arc<dyn ObjectData>>
Access the raw data associated with this object. Read more
sourcefn backend(&self) -> &WeakBackend
fn backend(&self) -> &WeakBackend
Access the backend associated with this object
sourcefn send_request(&self, req: Self::Request) -> Result<(), InvalidId>
fn send_request(&self, req: Self::Request) -> Result<(), InvalidId>
Send a request for this object. Read more
sourcefn send_constructor<I: Proxy>(
&self,
req: Self::Request,
data: Arc<dyn ObjectData>
) -> Result<I, InvalidId>
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. Read more
sourcefn from_id(conn: &Connection, id: ObjectId) -> Result<Self, InvalidId>
fn from_id(conn: &Connection, id: ObjectId) -> Result<Self, InvalidId>
Create an object proxy from its ID Read more
sourcefn parse_event(
conn: &Connection,
msg: Message<ObjectId>
) -> Result<(Self, Self::Event), DispatchError>
fn parse_event(
conn: &Connection,
msg: Message<ObjectId>
) -> Result<(Self, Self::Event), DispatchError>
Parse a event for this object Read more
impl Eq for WlShmPool
Auto Trait Implementations
impl !RefUnwindSafe for WlShmPool
impl Send for WlShmPool
impl Sync for WlShmPool
impl Unpin for WlShmPool
impl !UnwindSafe for WlShmPool
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more