Struct smithay_client_toolkit::shm::slot::SlotPool
source · pub struct SlotPool { /* private fields */ }
Implementations§
source§impl SlotPool
impl SlotPool
pub fn new( len: usize, shm: &impl ProvidesBoundGlobal<WlShm, 1>, ) -> Result<Self, CreatePoolError>
sourcepub fn create_buffer(
&mut self,
width: i32,
height: i32,
stride: i32,
format: Format,
) -> Result<(Buffer, &mut [u8]), CreateBufferError>
pub fn create_buffer( &mut self, width: i32, height: i32, stride: i32, format: Format, ) -> Result<(Buffer, &mut [u8]), CreateBufferError>
Create a new buffer in a new slot.
This returns the buffer and the canvas. The parameters are:
width
: the width of this buffer (in pixels)height
: the height of this buffer (in pixels)stride
: distance (in bytes) between the beginning of a row and the next oneformat
: the encoding format of the pixels. Using a format that was not advertised to thewl_shm
global by the server is a protocol error and will terminate your connection.
The Slot for this buffer will have exactly the size required for the data. It can be accessed via Buffer::slot to create additional buffers that point to the same data. This is required if you wish to change formats, buffer dimensions, or attach a canvas to multiple surfaces.
For more control over sizing, use Self::new_slot and Self::create_buffer_in.
sourcepub fn canvas(&mut self, key: &impl CanvasKey) -> Option<&mut [u8]>
pub fn canvas(&mut self, key: &impl CanvasKey) -> Option<&mut [u8]>
Get the bytes corresponding to a given slot or buffer if drawing to the slot is permitted.
Returns None
if there are active buffers in the slot or if the slot does not correspond
to this pool.
sourcepub fn resize(&mut self, size: usize) -> Result<()>
pub fn resize(&mut self, size: usize) -> Result<()>
Resizes the memory pool, notifying the server the pool has changed in size.
This is an optimization; the pool automatically resizes when you allocate new slots.
sourcepub fn new_slot(&mut self, len: usize) -> Result<Slot>
pub fn new_slot(&mut self, len: usize) -> Result<Slot>
Create a new slot with the given size in bytes.
sourcepub fn raw_data_mut(&mut self, slot: &Slot) -> &mut [u8] ⓘ
pub fn raw_data_mut(&mut self, slot: &Slot) -> &mut [u8] ⓘ
Get the bytes corresponding to a given slot.
Note: prefer using Self::canvas, which will prevent drawing to a buffer that has not been released by the server.
Returns an empty buffer if the slot does not belong to this pool.
sourcepub fn create_buffer_in(
&mut self,
slot: &Slot,
width: i32,
height: i32,
stride: i32,
format: Format,
) -> Result<Buffer, CreateBufferError>
pub fn create_buffer_in( &mut self, slot: &Slot, width: i32, height: i32, stride: i32, format: Format, ) -> Result<Buffer, CreateBufferError>
Create a new buffer corresponding to a slot.
The parameters are:
width
: the width of this buffer (in pixels)height
: the height of this buffer (in pixels)stride
: distance (in bytes) between the beginning of a row and the next oneformat
: the encoding format of the pixels. Using a format that was not advertised to thewl_shm
global by the server is a protocol error and will terminate your connection
Trait Implementations§
Auto Trait Implementations§
impl Freeze for SlotPool
impl !RefUnwindSafe for SlotPool
impl Send for SlotPool
impl Sync for SlotPool
impl Unpin for SlotPool
impl !UnwindSafe for SlotPool
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.