Struct wgpu_core::resource::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>>,
}

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>>

Implementations

impl Buffer

pub(crate) fn raw<'a>( &'a self, guard: &'a SnatchGuard<'_>, ) -> Option<&'a dyn DynBuffer>

pub(crate) fn try_raw<'a>( &'a self, guard: &'a SnatchGuard<'_>, ) -> Result<&dyn DynBuffer, DestroyedResourceError>

pub(crate) fn check_destroyed<'a>( &'a self, guard: &'a 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(crate) fn map_async( self: &Arc<Self>, offset: BufferAddress, size: Option<BufferAddress>, op: BufferMapOperation, ) -> Result<(), (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 unmap( self: &Arc<Self>, buffer_id: BufferId, ) -> Result<(), BufferAccessError>

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

pub(crate) fn destroy(self: &Arc<Self>) -> Result<(), DestroyError>

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 ResourceType for Buffer

const TYPE: &'static str = "Buffer"

impl StorageItem for Buffer

type Marker = Buffer

impl Trackable for Buffer

fn tracker_index(&self) -> TrackerIndex