Struct wgpu::BufferSlice
source · [−]pub struct BufferSlice<'a> { /* private fields */ }
Expand description
Slice into a Buffer
.
Created by calling Buffer::slice
. To use the whole buffer, call with unbounded slice:
buffer.slice(..)
Implementations
sourceimpl<'a> BufferSlice<'a>
impl<'a> BufferSlice<'a>
sourcepub fn map_async(
&self,
mode: MapMode,
callback: impl FnOnce(Result<(), BufferAsyncError>) + Send + 'static
)
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.
sourcepub fn get_mapped_range(&self) -> BufferView<'a>
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.
sourcepub fn get_mapped_range_mut(&self) -> BufferViewMut<'a>
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
sourceimpl<'a> Clone for BufferSlice<'a>
impl<'a> Clone for BufferSlice<'a>
sourcefn clone(&self) -> BufferSlice<'a>
fn clone(&self) -> BufferSlice<'a>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<'a> Debug for BufferSlice<'a>
impl<'a> Debug for BufferSlice<'a>
impl<'a> Copy for BufferSlice<'a>
Auto Trait Implementations
impl<'a> !RefUnwindSafe for BufferSlice<'a>
impl<'a> Send for BufferSlice<'a>
impl<'a> Sync for BufferSlice<'a>
impl<'a> Unpin for BufferSlice<'a>
impl<'a> !UnwindSafe for BufferSlice<'a>
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