Struct rendy::command::CommandPool

pub struct CommandPool<B, C = QueueType, R = NoIndividualReset> where
    B: Backend,  { /* fields omitted */ }

Simple pool wrapper. Doesn't provide any guarantees. Wraps raw buffers into CommandCommand buffer.

Methods

impl<B, C, R> CommandPool<B, C, R> where
    B: Backend,
    R: Reset, 

pub unsafe fn create(
    family: FamilyId,
    capability: C,
    device: &Device<B>
) -> Result<CommandPool<B, C, R>, OutOfMemory> where
    C: Capability,
    R: Reset, 

Create command pool associated with the family. Command buffers created from the pool could be submitted to the queues of the family.

Safety

Family must belong to specified device. Family must have specified capability.

pub unsafe fn from_raw(
    raw: <B as Backend>::CommandPool,
    capability: C,
    reset: R,
    family: FamilyId
) -> CommandPool<B, C, R>

Wrap raw command pool.

Safety

• raw must be valid command pool handle.
• The command pool must be created for specified family index.
• capability must be subset of capabilites of the family the pool was created for.
• if reset is IndividualReset the pool must be created with individual command buffer reset flag set.

pub fn allocate_buffers<L>(
    &mut self,
    count: usize
) -> Vec<CommandBuffer<B, C, InitialState, L, R>> where
    C: Capability,
    L: Level, 

Allocate new command buffers.

pub unsafe fn free_buffers<impl Resettable, impl Level, impl IntoIterator>>(
    &mut self,
    buffers: impl IntoIterator>
) where
    impl IntoIterator>: IntoIterator<Item = CommandBuffer<B, C, impl Resettable, impl Level, R>>,
    impl Level: Level,
    impl Resettable: Resettable, 

Free buffers. Buffers must be in droppable state. TODO: Validate buffers were allocated from this pool.

pub unsafe fn reset(&mut self)

Reset all buffers of this pool.

Safety

All buffers allocated from this pool must be marked reset. See [CommandBuffer::mark_reset](struct.Command buffer.html#method.mark_reset)

pub unsafe fn dispose(self, device: &Device<B>)

Dispose of command pool.

Safety

All buffers allocated from this pool must be freed.

pub fn with_queue_type(self) -> CommandPool<B, QueueType, R> where
    C: Capability, 

Convert capability level

pub fn with_capability<U>(
    self
) -> Result<CommandPool<B, U, R>, CommandPool<B, C, R>> where
    C: Supports<U>, 

Convert capability level

impl<B, C, R> CommandPool<B, C, R> where
    B: Backend, 

pub fn family_id(&self) -> FamilyId

Get owner id.

pub fn assert_family_owner(&self, family: &Family<B, C>)

Assert specified family is owner.

pub fn assert_device_owner(&self, device: &Device<B>)

Assert specified device is owner.

pub fn assert_instance_owner(&self, instance: &Instance<B>)

Assert specified instance is owner.

Trait Implementations

impl<B, C, R> Debug for CommandPool<B, C, R> where
    B: Backend,
    C: Debug,
    R: Debug, 

fn fmt(&self, __f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.