vkCmdEndRendering(3)

# vkCmdEndRendering(3) Manual Page

## Name

vkCmdEndRendering - End a dynamic render pass instance

Loading… please wait.

## C Specification

To end a render pass instance, call:

    // Provided by VK_VERSION_1_3
    void vkCmdEndRendering(
        VkCommandBuffer                             commandBuffer);

or the equivalent command

    // Provided by VK_KHR_dynamic_rendering
    void vkCmdEndRenderingKHR(
        VkCommandBuffer                             commandBuffer);

## Parameters

- `commandBuffer` is the command buffer in which to record the command.

## Description

If the value of `pRenderingInfo->flags` used to begin this render pass instance included `VK_RENDERING_SUSPENDING_BIT`, then this render pass is suspended and will be resumed later in submission order.

Valid Usage

- VUID-vkCmdEndRendering-None-06161
  The current render pass instance must have been begun with vkCmdBeginRendering

- VUID-vkCmdEndRendering-commandBuffer-06162
  The current render pass instance must have been begun in `commandBuffer`

- VUID-vkCmdEndRendering-None-06781
  This command must not be recorded when transform feedback is active

- VUID-vkCmdEndRendering-None-06999
  If `vkCmdBeginQuery`* was called within the render pass, the corresponding `vkCmdEndQuery`* must have been called subsequently within the same subpass

Valid Usage (Implicit)

- VUID-vkCmdEndRendering-commandBuffer-parameter
  `commandBuffer` must be a valid VkCommandBuffer handle

- VUID-vkCmdEndRendering-commandBuffer-recording
  `commandBuffer` must be in the recording state

- VUID-vkCmdEndRendering-commandBuffer-cmdpool
  The `VkCommandPool` that `commandBuffer` was allocated from must support graphics operations

- VUID-vkCmdEndRendering-renderpass
  This command must only be called inside of a render pass instance

- VUID-vkCmdEndRendering-videocoding
  This command must only be called outside of a video coding scope

Host Synchronization

- Host access to `commandBuffer` must be externally synchronized

- Host access to the `VkCommandPool` that `commandBuffer` was allocated from must be externally synchronized

Command Properties

Command Buffer Levels | Render Pass Scope | Video Coding Scope | Supported Queue Types | Command Type
--- | --- | --- | --- | ---
Primary Secondary | Inside | Outside | Graphics | Action State

## See Also

VK_KHR_dynamic_rendering, VK_VERSION_1_3, VkCommandBuffer

## Document Notes

For more information, see the Vulkan Specification

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

## Copyright

Copyright 2014-2024 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0