VKENDCOMMANDBUFFER(3)

NAME
vkEndCommandBuffer - Finish recording a command buffer

C SPECIFICATION

    VkResult vkEndCommandBuffer(
        VkCommandBuffer                             commandBuffer);

PARAMETERS

commandBuffer
    A handle to the command buffer for which recording is to end.

DESCRIPTION

vkEndCommandBuffer ends the recording of a command buffer. The command buffer must be in the recording state. After recording of a primary command buffer is completed, it may be submitted to a queue using vkQueueSubmit. After recording of a secondary command buffer is completed, it may be called from a primary command buffer by a call to vkCmdExecuteCommands. No further modification to a completed command buffer may be performed until vkResetCommandBuffer is called on it.

VALID USAGE

    • commandBuffer must be a valid VkCommandBuffer handle

    • commandBuffer must be in the recording state

    • vkEndCommandBuffer must not be called inside a render pass instance

    • All queries made active during the recording of commandBuffer must have been made inactive

HOST SYNCHRONIZATION

    • Host access to commandBuffer must be externally synchronized

RETURN CODES

On success, this command returns

        • VK_SUCCESS

On failure, this command returns

        • VK_ERROR_OUT_OF_HOST_MEMORY

        • VK_ERROR_OUT_OF_DEVICE_MEMORY

SEE ALSO

vkAllocateCommandBuffers, vkFreeCommandBuffers, vkBeginCommandBuffer, vkResetCommandBuffer, vkCmdExecuteCommands

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.