Struct wgpu_core::resource::StagingBuffer

pub struct StagingBuffer<A: Api> {
    pub(crate) raw: A::Buffer,
    pub(crate) size: BufferAddress,
    pub(crate) is_coherent: bool,
}

A temporary buffer, consumed by the command that uses it.

A StagingBuffer is designed for one-shot uploads of data to the GPU. It is always created mapped, and the command that uses it destroys the buffer when it is done.

StagingBuffers can be created with queue_create_staging_buffer and used with queue_write_staging_buffer. They are also used internally by operations like queue_write_texture that need to upload data to the GPU, but that don’t belong to any particular wgpu command buffer.

Used StagingBuffers are accumulated in Device::pending_writes, to be freed once their associated operation’s queue submission has finished execution.

Fields

raw: A::Buffer

size: BufferAddress

is_coherent: bool

Implementations

impl<A: Api> StagingBuffer<A>

unsafe fn flush(&self, device: &A::Device) -> Result<(), DeviceError>

Trait Implementations

impl<A: Api> Resource for StagingBuffer<A>

const TYPE: &'static str = "StagingBuffer"

fn life_guard(&self) -> &LifeGuard

fn label(&self) -> &str

impl<A: HalApi> Access<StagingBuffer<A>> for Device<A>