VKCOMMANDPOOLCREATEI(3)

NAME
VkCommandPoolCreateInfo - Structure specifying parameters of a newly created command pool

C SPECIFICATION

The VkCommandPoolCreateInfo structure is defined as:

    typedef struct VkCommandPoolCreateInfo {
        VkStructureType             sType;
        const void*                 pNext;
        VkCommandPoolCreateFlags    flags;
        uint32_t                    queueFamilyIndex;
    } VkCommandPoolCreateInfo;

MEMBERS

    • sType is the type of this structure.

    • pNext is NULL or a pointer to an extension-specific structure.

    • flags is a bitmask indicating usage behavior for the pool and command buffers allocated from it. Bits which can be set include:

        typedef enum VkCommandPoolCreateFlagBits {
            VK_COMMAND_POOL_CREATE_TRANSIENT_BIT = 0x00000001,
            VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT = 0x00000002,
        } VkCommandPoolCreateFlagBits;

        • VK_COMMAND_POOL_CREATE_TRANSIENT_BIT indicates that command buffers allocated from the pool will be short-lived, meaning that they will be reset or freed in a relatively short timeframe. This flag may be used by the implementation to control memory allocation behavior within the pool.

        • VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT controls whether command buffers allocated from the pool can be individually reset. If this flag is set, individual command buffers allocated from the pool can be reset either explicitly, by calling vkResetCommandBuffer, or implicitly, by calling vkBeginCommandBuffer on an executable command buffer. If this flag is not set, then vkResetCommandBuffer and vkBeginCommandBuffer (on an executable command buffer) must not be called on the command buffers allocated from the pool, and they can only be reset in bulk by calling vkResetCommandPool.

    • queueFamilyIndex designates a queue family as described in section Queue Family Properties. All command buffers allocated from this command pool must be submitted on queues from the same queue family.

DESCRIPTION
Valid Usage

    • queueFamilyIndex must be the index of a queue family available in the calling command’s device parameter
Valid Usage (Implicit)

    • sType must be VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO

    • pNext must be NULL

    • flags must be a valid combination of VkCommandPoolCreateFlagBits values

SEE ALSO

VkCommandPoolCreateFlags, VkStructureType, vkCreateCommandPool

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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.