Struct draw2d::graphics::vulkan::command_pool::OwnedCommandPool

pub struct OwnedCommandPool { /* fields omitted */ }

This structure holds resources for managing an owned command pool. “Owned” means that the owner is responsible for destroying the contained resources before this struct is dropped.

Implementations

impl OwnedCommandPool

pub fn new(logical_device: &Device, queue_family_index: u32) -> Result<Self>

Create the command buffer pool.

The caller is responsible for destroying the pool.

pub unsafe fn raw(&self) -> &CommandPool

The raw command pool handle.

Unsafe Because

• The returned reference is still logically ‘owned’ by this struct and must not be destroyed except via a call to Self::destroy.

pub unsafe fn allocate_command_buffer(
    &self,
    logical_device: &Device
) -> Result<CommandBuffer>

Allocate a new command buffer.

Unsafe Because

• the caller must eventually call Self::reset or else resources will be leaked

pub unsafe fn free_command_buffer(
    &self,
    logical_device: &Device,
    command_buffer: CommandBuffer
)

Free a command buffer’s resources to be used by the pool again.

Unsafe Because

• the caller is responsible for ensuring that the command buffer is not being used anymore
• only command buffers created by previous calls to Self::allocate_command_buffer on this instance can be passed to this function

pub unsafe fn reset(&self, logical_device: &Device) -> Result<()>

Reset all command buffers allocated by this pool.

Unsafe Because

• the caller is responsible for ensuring that none of the command buffers are still in use

pub unsafe fn destroy(&mut self, logical_device: &Device)

Destroy the command pool.

Unsafe Because

• the caller must ensure that the command pool is not in use when it is destroyed.