vkDestroyCommandPool(3)

Name

vkDestroyCommandPool - Destroy a command pool object

C Specification

To destroy a command pool, call:

// Provided by VK_VERSION_1_0void vkDestroyCommandPool(    VkDevice                                    device,    VkCommandPool                               commandPool,    const VkAllocationCallbacks*                pAllocator);

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 theMemory Allocation chapter.

Description

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

Any primary command buffer allocated from anotherVkCommandPool thatis in therecording or executable state andhas a secondary command buffer allocated fromcommandPool recordedinto it, becomesinvalid.

Valid Usage

VUID-vkDestroyCommandPool-commandPool-00041
AllVkCommandBuffer objects allocated fromcommandPoolmustnot be in thepending state
VUID-vkDestroyCommandPool-commandPool-00042
IfVkAllocationCallbacks were provided whencommandPool wascreated, a compatible set of callbacksmust be provided here
VUID-vkDestroyCommandPool-commandPool-00043
If noVkAllocationCallbacks were provided whencommandPoolwas created,pAllocatormust beNULL

Valid Usage (Implicit)

VUID-vkDestroyCommandPool-device-parameter
devicemust be a validVkDevice handle
VUID-vkDestroyCommandPool-commandPool-parameter
IfcommandPool is notVK_NULL_HANDLE,commandPoolmust be a validVkCommandPool handle
VUID-vkDestroyCommandPool-pAllocator-parameter
IfpAllocator is notNULL,pAllocatormust be a valid pointer to a validVkAllocationCallbacks structure
VUID-vkDestroyCommandPool-commandPool-parent
IfcommandPool is a valid handle, itmust have been created, allocated, or retrieved fromdevice

Host Synchronization

Host access tocommandPoolmust be externally synchronized

Document Notes

For more information, see theVulkan Specification.

This page is extracted from the Vulkan Specification.Fixes and changes should be made to the Specification, not directly.

Movatterモバイル変換