Struct Buffer

pub struct Buffer {
    pub(crate) raw: Snatchable<Box<dyn DynBuffer>>,
    pub(crate) device: Arc<Device>,
    pub(crate) usage: BufferUsages,
    pub(crate) size: BufferAddress,
    pub(crate) initialization_status: RwLock<InitTracker<BufferAddress>>,
    pub(crate) label: String,
    pub(crate) tracking_data: TrackingData,
    pub(crate) map_state: Mutex<BufferMapState>,
    pub(crate) bind_groups: Mutex<WeakVec<BindGroup>>,
    pub(crate) timestamp_normalization_bind_group: Snatchable<TimestampNormalizationBindGroup>,
    pub(crate) indirect_validation_bind_groups: Snatchable<BindGroups>,
}

Fields

raw: Snatchable<Box<dyn DynBuffer>>

device: Arc<Device>

usage: BufferUsages

size: BufferAddress

initialization_status: RwLock<InitTracker<BufferAddress>>

label: String

The label from the descriptor used to create the resource.

tracking_data: TrackingData

map_state: Mutex<BufferMapState>

bind_groups: Mutex<WeakVec<BindGroup>>

timestamp_normalization_bind_group: Snatchable<TimestampNormalizationBindGroup>

indirect_validation_bind_groups: Snatchable<BindGroups>

Implementations

impl Buffer

pub(crate) fn check_destroyed( &self, guard: &SnatchGuard<'_>, ) -> Result<(), DestroyedResourceError>

pub(crate) fn check_usage( &self, expected: BufferUsages, ) -> Result<(), MissingBufferUsageError>

Checks that the given buffer usage contains the required buffer usage, returns an error otherwise.

pub fn resolve_binding_size( &self, offset: BufferAddress, binding_size: Option<BufferSize>, ) -> Result<u64, BindingError>

Resolve the size of a binding for buffer with offset and size.

If size is None, then the remainder of the buffer starting from offset is used.

If the binding would overflow the buffer, then an error is returned.

Zero-size bindings are permitted here for historical reasons. Although zero-size bindings are permitted by WebGPU, they are not permitted by some backends. See Buffer::binding and #3170.

pub fn binding<'a>( &'a self, offset: BufferAddress, binding_size: Option<BufferSize>, snatch_guard: &'a SnatchGuard<'_>, ) -> Result<(BufferBinding<'a, dyn DynBuffer>, u64), BindingError>

Create a new hal::BufferBinding for the buffer with offset and binding_size.

If binding_size is None, then the remainder of the buffer starting from offset is used.

If the binding would overflow the buffer, then an error is returned.

A zero-size binding at the end of the buffer is permitted here for historical reasons. Although zero-size bindings are permitted by WebGPU, they are not permitted by some backends. The zero-size binding need to be quashed or remapped to a non-zero size, either universally in wgpu-core, or in specific backends that do not support them. See #3170.

Although it seems like it would be simpler and safer to use the resolved size in the returned hal::BufferBinding, doing this (and removing redundant logic in backends to resolve the implicit size) was observed to cause problems in certain CTS tests, so an implicit size specification is preserved in the output.

pub(crate) fn map_async( self: &Arc<Self>, offset: BufferAddress, size: Option<BufferAddress>, op: BufferMapOperation, ) -> Result<SubmissionIndex, (BufferMapOperation, BufferAccessError)>

Returns the mapping callback in case of error so that the callback can be fired outside of the locks that are held in this function.

pub(crate) fn map( &self, snatch_guard: &SnatchGuard<'_>, ) -> Option<BufferMapPendingClosure>

This function returns None only if Self::map_state is not BufferMapState::Waiting.

pub(crate) fn unmap(self: &Arc<Self>) -> Result<(), BufferAccessError>

fn unmap_inner( self: &Arc<Self>, ) -> Result<Option<BufferMapPendingClosure>, BufferAccessError>

pub(crate) fn destroy(self: &Arc<Self>)

Trait Implementations

impl Debug for Buffer

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

Formats the value using the given formatter.

impl Drop for Buffer

fn drop(&mut self)

Executes the destructor for this type.

impl Labeled for Buffer

fn label(&self) -> &str

Returns a string identifying this resource for logging and errors.

fn error_ident(&self) -> ResourceErrorIdent

impl ParentDevice for Buffer

fn device(&self) -> &Arc<Device>

fn is_equal(self: &Arc<Self>, other: &Arc<Self>) -> bool

fn same_device_as<O: ParentDevice>(&self, other: &O) -> Result<(), DeviceError>

fn same_device(&self, device: &Device) -> Result<(), DeviceError>

impl RawResourceAccess for Buffer

type DynResource = dyn DynBuffer

fn raw<'a>( &'a self, guard: &'a SnatchGuard<'_>, ) -> Option<&'a Self::DynResource>

Get access to the raw resource if it is not destroyed.

fn try_raw<'a>( &'a self, guard: &'a SnatchGuard<'_>, ) -> Result<&'a Self::DynResource, DestroyedResourceError>

Get access to the raw resource if it is not destroyed.

impl ResourceType for Buffer

const TYPE: &'static str = "Buffer"

impl StorageItem for Buffer

type Marker = Buffer

impl Trackable for Buffer

fn tracker_index(&self) -> TrackerIndex