VKDESTROYCOMMANDPOOL(3)

NAME
vkDestroyCommandPool - Destroy a command pool object

C SPECIFICATION

    void vkDestroyCommandPool(
        VkDevice                                    device,
        VkCommandPool                               commandPool,
        const VkAllocationCallbacks*                pAllocator);

PARAMETERS

device
    Logical device which owns the object.

commandPool
    The command pool to destroy.

DESCRIPTION

vkDestroyCommandPool destroys the command pool object whose handle is specified in commandPool. commandPool must be a valid handle to command object created through a successful call to vkCreateCommandPool on device. Attempts to destroy VK_NULL_HANDLE are silently ignored. After a command pool object has been destroyed, its handle becomes invalid and must not be accessed again. Any command buffers allocated from the pool also become invalid and must not be accessed.

All command buffers allocated from the pool must be freed by a call to vkFreeCommandBuffers before the pool is destroyed. Failure to return command buffers to their command pools before destroying the pool object may result in resource leaks.

VALID USAGE

    • device must be a valid VkDevice handle

    • If commandPool is not VK_NULL_HANDLE, commandPool must be a valid VkCommandPool handle

    • If pAllocator is not NULL, pAllocator must be a pointer to a valid VkAllocationCallbacks structure

    • If commandPool is a valid handle, it must have been created, allocated or retrieved from device

    • Each of device and commandPool that are valid handles must have been created, allocated or retrieved from the same VkPhysicalDevice

    • All VkCommandBuffer objects allocated from commandPool must not be pending execution

    • If VkAllocationCallbacks were provided when commandPool was created, a compatible set of callbacks must be provided here

    • If no VkAllocationCallbacks were provided when commandPool was created, pAllocator must be NULL

HOST SYNCHRONIZATION

    • Host access to commandPool must be externally synchronized

SEE ALSO

vkCreateCommandPool, vkResetCommandPool

COPYRIGHT

Copyright © 2014-2016 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.

AUTHOR

Khronos Group
    Author.