Struct wgpu::BufferSlice

source ·
pub struct BufferSlice<'a> { /* private fields */ }
Expand description

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§

source§

impl<'a> BufferSlice<'a>

source

pub fn map_async( &self, mode: MapMode, callback: impl FnOnce(Result<(), BufferAsyncError>) + WasmNotSend + '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.

source

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.

source

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§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> Downcast<T> for T

source§

fn downcast(&self) -> &T

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> Upcast<T> for T

source§

fn upcast(&self) -> Option<&T>

source§

impl<T> WasmNotSend for T
where T: Send,

source§

impl<T> WasmNotSync for T
where T: Sync,