Struct rafx::framework::DynCommandPoolAllocator

pub struct DynCommandPoolAllocator { /* private fields */ }

An allocator for DynCommandPools, objects that are short-lived and NOT persisted across frames. Meant for allocating command buffers that are usually single use and only for the current frame. The allocator is multi-thread friendly, but the pools themselves are not. So if writing command buffers from multiple threads, allocate a pool per thread.

Implementations

impl DynCommandPoolAllocator

pub fn new(max_frames_in_flight: u32) -> DynCommandPoolAllocator

Create an allocator for DynCommandPools.

pub fn allocate_dyn_pool( &self, queue: &RafxQueue, command_pool_def: &RafxCommandPoolDef, delay_submission_by_frame_count: u64 ) -> Result<DynCommandPool, RafxError>

Allocates a pool. DynPools wrap CommandPools. The parameters match inputs for CommandPool::new. delay_submission_by_frame_count indicates how many frames will pass before the commands will be submitted (which affects how long-lived they will be). DO NOT submit command buffers earlier than this as the commands pools themselves are pooled and may be available to writing in future frames.

The common case for delay_submission_by_frame_count is to pass 0. You might pass 1 if for example, you are building a command buffer for frame N + 1 while frame N is not yet submitted.

pub fn on_frame_complete(&self) -> Result<(), RafxError>

Call every frame to recycle command pools that are no-longer in flight

Trait Implementations

impl Clone for DynCommandPoolAllocator

fn clone(&self) -> DynCommandPoolAllocator

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.