Struct wgpu_async::AsyncBufferSlice

pub struct AsyncBufferSlice<'a>where
    Self: Send,{ /* private fields */ }

A smart-pointer wrapper around a wgpu::BufferSlice, offering a map_async method than can be awaited.

Implementations

impl<'a> AsyncBufferSlice<'a>

pub fn map_async( &self, mode: MapMode ) -> WgpuFuture<Result<(), BufferAsyncError>>

An awaitable version of [wgpu::Buffer::map_async].

Methods from Deref<Target = 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, T> AsMut<T> for AsyncBufferSlice<'a>where <AsyncBufferSlice<'a> as Deref>::Target: AsMut<T>,

fn as_mut(&mut self) -> &mut T

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'a, T> AsRef<T> for AsyncBufferSlice<'a>where T: ?Sized, <AsyncBufferSlice<'a> as Deref>::Target: AsRef<T>,

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Debug for AsyncBufferSlice<'a>where Self: Send,

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

Formats the value using the given formatter.

impl<'a> Deref for AsyncBufferSlice<'a>

type Target = BufferSlice<'a>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> DerefMut for AsyncBufferSlice<'a>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.