Struct bedrock::CommandPool

pub struct CommandPool(_, _);

Opaque handle to a command pool object

Methods

impl CommandPool

Following methods are enabled with [feature = "Implements"]

pub fn new(
    device: &Device,
    queue_family: u32,
    transient: bool,
    indiv_resettable: bool
) -> Result<Self>

Create a new command pool object

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY

pub fn alloc(&self, count: u32, primary: bool) -> Result<Vec<CommandBuffer>>

Allocate command buffers from an existing command pool

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY

pub fn reset(&self, release_resources: bool) -> Result<()>

Resets a command pool

Safety

Application cannot use command buffers after this call

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY

pub fn free(&self, buffers: &[CommandBuffer])

Free command buffers

Trait Implementations

impl Clone for CommandPool

fn clone(&self) -> CommandPool

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DeviceChild for CommandPool

fn device(&self) -> &Device

Retrieve a reference to a device object that creates this object

impl Drop for CommandPool

fn drop(&mut self)

Executes the destructor for this type.

impl VkHandle for CommandPool

type Handle = VkCommandPool

fn native_ptr(&self) -> VkCommandPool

Retrieve an underlying handle