VKFREECOMMANDBUFFERS(3)

NAME
vkFreeCommandBuffers - Free command buffers.

C SPECIFICATION

To free command buffers, call:

    void vkFreeCommandBuffers(
        VkDevice                                    device,
        VkCommandPool                               commandPool,
        uint32_t                                    commandBufferCount,
        const VkCommandBuffer*                      pCommandBuffers);

PARAMETERS

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

    • commandPool is the handle of the command pool that the command buffers were allocated from.

    • commandBufferCount is the length of the pCommandBuffers array.

    • pCommandBuffers is an array of handles of command buffers to free.

DESCRIPTION

VALID USAGE

    • device must be a valid VkDevice handle

    • commandPool must be a valid VkCommandPool handle

    • commandBufferCount must be greater than 0

    • commandPool must have been created, allocated or retrieved from device

    • Each element of pCommandBuffers that is a valid handle must have been created, allocated or retrieved from commandPool

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

    • All elements of pCommandBuffers must not be pending execution

    • pCommandBuffers must be a pointer to an array of commandBufferCount VkCommandBuffer handles, each element of which must either be a valid handle or VK_NULL_HANDLE

HOST SYNCHRONIZATION

    • Host access to commandPool must be externally synchronized

    • Host access to each member of pCommandBuffers must be externally synchronized

SEE ALSO

VkCommandBuffer, VkCommandPool, VkDevice

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkFreeCommandBuffers

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

COPYRIGHT

Copyright (c) 2014-2016 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.

AUTHOR

Khronos Group
    Author.