Struct wgpu::BufferSlice

pub struct BufferSlice<'a> { /* private fields */ }

Slice into a Buffer.

It can be created with Buffer::slice. To use the whole buffer, call with unbounded slice:

buffer.slice(..)

This type is unique to the Rust API of wgpu. In the WebGPU specification, an offset and size are specified as arguments to each call working with the Buffer, instead.

Implementations

impl<'a> BufferSlice<'a>

pub fn map_async( &self, mode: MapMode, callback: impl FnOnce(Result<(), BufferAsyncError>) + Send + 'static )

Map the buffer. Buffer is ready to map once the callback is called.

For the callback to complete, either queue.submit(..), instance.poll_all(..), or device.poll(..) must be called elsewhere in the runtime, possibly integrated into an event loop or run on a separate thread.

The callback will be called on the thread that first calls the above functions after the gpu work has completed. There are no restrictions on the code you can run in the callback, however on native the call to the function will not complete until the callback returns, so prefer keeping callbacks short and used to set flags, send messages, etc.

pub fn get_mapped_range(&self) -> BufferView<'a>

Synchronously and immediately map a buffer for reading. If the buffer is not immediately mappable through BufferDescriptor::mapped_at_creation or BufferSlice::map_async, will panic.

pub fn get_mapped_range_mut(&self) -> BufferViewMut<'a>

Synchronously and immediately map a buffer for writing. If the buffer is not immediately mappable through BufferDescriptor::mapped_at_creation or BufferSlice::map_async, will panic.

Trait Implementations

impl<'a> Clone for BufferSlice<'a>

fn clone(&self) -> BufferSlice<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BufferSlice<'a>

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

Formats the value using the given formatter.

impl<'a> Copy for BufferSlice<'a>