Enum rafx_api::RafxCommandPool

pub enum RafxCommandPool {
    Empty(RafxCommandPoolEmpty),
}

A pool of command buffers. A command pool is necessary to create a command buffer.

A command pool cannot be modified (including allocating from it) if one of its command buffers is being modified or in-use by the GPU.

Resetting a command pool clears all of the command buffers allocated from it, but the command buffers remain allocated.

The command pool must not be dropped while any of its command buffers are in use. However, it is ok to drop a command pool while command buffers are allocated, as long as those command buffers are never used again. (The command pool owns the memory the command buffer points to)

Variants

Empty(RafxCommandPoolEmpty)

Implementations

impl RafxCommandPool

pub fn device_context(&self) -> RafxDeviceContext

pub fn create_command_buffer(
    &mut self,
    command_buffer_def: &RafxCommandBufferDef
) -> RafxResult<RafxCommandBuffer>

Allocate a command buffer from the pool. This must not be called if a command buffer from this pool is being written or is in-use by the GPU.

pub fn reset_command_pool(&mut self) -> RafxResult<()>

Reset all command buffers to an “unwritten” state. This must not be called if any command buffers allocated from this pool are in use by the GPU.

This does not “free” allocated command buffers for reallocation.

pub fn empty_command_pool(&self) -> Option<&RafxCommandPoolEmpty>