Struct wgpu_async::AsyncBuffer

pub struct AsyncBufferwhere
    Self: Send,{ /* private fields */ }

A wrapper around a wgpu::Buffer which shadows some methods to allow for async mapping using Rust’s async API.

Implementations

impl AsyncBuffer

pub fn slice<'a, S: RangeBounds<BufferAddress>>( &'a self, bounds: S ) -> AsyncBufferSlice<'a>

Takes a slice of this buffer, in the same way a call to wgpu::Buffer::slice would, except wraps the result in an AsyncBufferSlice so that the map_async method can be awaited.

Methods from Deref<Target = Buffer>

pub fn as_entire_binding(&self) -> BindingResource<'_>

Return the binding view of the entire buffer.

pub fn as_entire_buffer_binding(&self) -> BufferBinding<'_>

Return the binding view of the entire buffer.

pub fn slice<S>(&self, bounds: S) -> BufferSlice<'_>where S: RangeBounds<u64>,

Use only a portion of this Buffer for a given operation. Choosing a range with no end will use the rest of the buffer. Using a totally unbounded range will use the entire buffer.

pub fn unmap(&self)

Flushes any pending write operations and unmaps the buffer from host memory.

pub fn destroy(&self)

Destroy the associated native resources as soon as possible.

pub fn size(&self) -> u64

Returns the length of the buffer allocation in bytes.

This is always equal to the size that was specified when creating the buffer.

pub fn usage(&self) -> BufferUsages

Returns the allowed usages for this Buffer.

This is always equal to the usage that was specified when creating the buffer.

Trait Implementations

impl<T> AsMut<T> for AsyncBufferwhere <AsyncBuffer 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<T> AsRef<T> for AsyncBufferwhere T: ?Sized, <AsyncBuffer as Deref>::Target: AsRef<T>,

fn as_ref(&self) -> &T

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

impl Debug for AsyncBufferwhere Self: Send,

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

Formats the value using the given formatter.

impl Deref for AsyncBuffer

type Target = Buffer

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for AsyncBuffer

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

Mutably dereferences the value.