vkCreateCommandPool - Create a new command pool object

Parameters

• Device is the logical device that creates the command pool.

• pCreateInfo is a pointer to a CommandPoolCreateInfo structure specifying the state of the command pool object.
• pAllocator controls host memory allocation as described in the Memory Allocation chapter.
• pCommandPool is a pointer to a CommandPool handle in which the created pool is returned.

Valid Usage

• pCreateInfo->queueFamilyIndex must be the index of a queue family available in the logical device Device.

Valid Usage (Implicit)

• Device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid CommandPoolCreateInfo structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pCommandPool must be a valid pointer to a CommandPool handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

AllocationCallbacks, CommandPool, CommandPoolCreateInfo, Device

A safe wrapper for createCommandPool and destroyCommandPool using bracket

The allocated value must not be returned from the provided computation

vkDestroyCommandPool - Destroy a command pool object

Parameters

• Device is the logical device that destroys the command pool.

• CommandPool is the handle of the command pool to destroy.
• pAllocator controls host memory allocation as described in the Memory Allocation chapter.

Description

When a pool is destroyed, all command buffers allocated from the pool are freed.

Any primary command buffer allocated from another CommandPool that is in the recording or executable state and has a secondary command buffer allocated from CommandPool recorded into it, becomes invalid.

Valid Usage

• All CommandBuffer objects allocated from CommandPool must not be in the pending state.

• If AllocationCallbacks were provided when CommandPool was created, a compatible set of callbacks must be provided here
• If no AllocationCallbacks were provided when CommandPool was created, pAllocator must be NULL

Valid Usage (Implicit)

• Device must be a valid Device handle

• If CommandPool is not NULL_HANDLE, CommandPool must be a valid CommandPool handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• If CommandPool is a valid handle, it must have been created, allocated, or retrieved from Device

Host Synchronization

• Host access to CommandPool must be externally synchronized

See Also

AllocationCallbacks, CommandPool, Device

vkResetCommandPool - Reset a command pool

Parameters

• Device is the logical device that owns the command pool.

• CommandPool is the command pool to reset.
• Flags is a bitmask of CommandPoolResetFlagBits controlling the reset operation.

Description

Resetting a command pool recycles all of the resources from all of the command buffers allocated from the command pool back to the command pool. All command buffers that have been allocated from the command pool are put in the initial state.

Any primary command buffer allocated from another CommandPool that is in the recording or executable state and has a secondary command buffer allocated from CommandPool recorded into it, becomes invalid.

Valid Usage

• All CommandBuffer objects allocated from CommandPool must not be in the pending state

Valid Usage (Implicit)

• Device must be a valid Device handle

• CommandPool must be a valid CommandPool handle
• Flags must be a valid combination of CommandPoolResetFlagBits values
• CommandPool must have been created, allocated, or retrieved from Device

Host Synchronization

• Host access to CommandPool must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

CommandPool, CommandPoolResetFlags, Device

VkCommandPoolCreateInfo - Structure specifying parameters of a newly created command pool

Valid Usage

• If the protected memory feature is not enabled, the COMMAND_POOL_CREATE_PROTECTED_BIT bit of Flags must not be set.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO

• pNext must be NULL
• Flags must be a valid combination of CommandPoolCreateFlagBits values

See Also

CommandPoolCreateFlags, StructureType, createCommandPool