Struct StagingBuffer

struct StagingBuffer {
    global: Arc<Global>,
    buffer_id: BufferId,
    state: StagingBufferState,
}

A staging buffer used for texture to buffer to CPU copy operations.

Fields

global: Arc<Global>

buffer_id: BufferId

state: StagingBufferState

Implementations

impl StagingBuffer

fn new(global: Arc<Global>, buffer_id: BufferId) -> Self

const fn is_mapped(&self) -> bool

fn is_available_and_has_compatible_config( &self, config: &ContextConfiguration, ) -> bool

Return true if buffer can be used directly with provided config without any additional work

const fn needs_assignment(&self) -> bool

Return true if buffer is not mapping or being mapped

fn ensure_available( &mut self, config: &ContextConfiguration, ) -> Result<(), CreateBufferError>

Make buffer available by unmapping / destroying it and then recreating it if needed.

fn prepare_load_texture_command_buffer( &mut self, texture_id: TextureId, encoder_id: CommandEncoderId, config: &ContextConfiguration, ) -> Result<CommandBufferId, Box<dyn Error>>

Makes buffer available and prepares command encoder that will copy texture to this staging buffer.

Caller must submit command buffer to queue.

fn unmap(&mut self)

Unmaps the buffer or cancels a mapping operation if one is in progress.

fn snapshot(&self) -> Option<Snapshot>

Obtain a snapshot from this buffer if is mapped or return None if it is not mapped.

Trait Implementations

impl Debug for StagingBuffer

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

Formats the value using the given formatter.

impl Drop for StagingBuffer

fn drop(&mut self)

Executes the destructor for this type.

impl Sync for StagingBuffer