VKENDCOMMANDBUFFER(3)

NAME
vkEndCommandBuffer - Finish recording a command buffer

C SPECIFICATION

To complete recording of a command buffer, call:

    VkResult vkEndCommandBuffer(
        VkCommandBuffer                             commandBuffer);

PARAMETERS

    • commandBuffer is the command buffer to complete recording. The command buffer must have been in the recording state, and is moved to the executable state.

DESCRIPTION

If there was an error during recording, the application will be notified by an unsuccessful return code returned by vkEndCommandBuffer. If the application wishes to further use the command buffer, the command buffer must be reset.

VALID USAGE

    • commandBuffer must be a valid VkCommandBuffer handle

    • commandBuffer must be in the recording state

    • If commandBuffer is a primary command buffer, there must not be an active 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

VkCommandBuffer

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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.