VKCOMMANDBUFFERALLOC(3)

NAME
VkCommandBufferAllocateInfo - Structure specifying the allocation parameters for command buffer object.

C SPECIFICATION

The VkCommandBufferAllocateInfo structure is defined as:

    typedef struct VkCommandBufferAllocateInfo {
        VkStructureType         sType;
        const void*             pNext;
        VkCommandPool           commandPool;
        VkCommandBufferLevel    level;
        uint32_t                commandBufferCount;
    } VkCommandBufferAllocateInfo;

MEMBERS

    • sType is the type of this structure.

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

    • commandPool is the name of the command pool that the command buffers allocate their memory from.

    • level determines whether the command buffers are primary or secondary command buffers. Possible values include:

        typedef enum VkCommandBufferLevel {
            VK_COMMAND_BUFFER_LEVEL_PRIMARY = 0,
            VK_COMMAND_BUFFER_LEVEL_SECONDARY = 1,
        } VkCommandBufferLevel;

    • commandBufferCount is the number of command buffers to allocate from the pool.

DESCRIPTION

VALID USAGE

    • sType must be VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO

    • pNext must be NULL

    • commandPool must be a valid VkCommandPool handle

    • level must be a valid VkCommandBufferLevel value

    • commandBufferCount must be greater than 0

SEE ALSO

VkCommandBufferLevel, VkCommandPool, VkStructureType, vkAllocateCommandBuffers

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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.