VkRenderingFlagBits(3)

# VkRenderingFlagBits(3) Manual Page

## Name

VkRenderingFlagBits - Bitmask specifying additional properties of a dynamic render pass instance

Loading… please wait.

## C Specification

Bits which can be set in VkRenderingInfo::`flags` describing additional properties of the render pass are:

    // Provided by VK_VERSION_1_3
    typedef enum VkRenderingFlagBits {
        VK_RENDERING_CONTENTS_SECONDARY_COMMAND_BUFFERS_BIT = 0x00000001,
        VK_RENDERING_SUSPENDING_BIT = 0x00000002,
        VK_RENDERING_RESUMING_BIT = 0x00000004,
      // Provided by VK_EXT_nested_command_buffer
        VK_RENDERING_CONTENTS_INLINE_BIT_EXT = 0x00000010,
      // Provided by VK_VERSION_1_3 with VK_EXT_legacy_dithering, VK_KHR_dynamic_rendering with VK_EXT_legacy_dithering
        VK_RENDERING_ENABLE_LEGACY_DITHERING_BIT_EXT = 0x00000008,
        VK_RENDERING_CONTENTS_SECONDARY_COMMAND_BUFFERS_BIT_KHR = VK_RENDERING_CONTENTS_SECONDARY_COMMAND_BUFFERS_BIT,
        VK_RENDERING_SUSPENDING_BIT_KHR = VK_RENDERING_SUSPENDING_BIT,
        VK_RENDERING_RESUMING_BIT_KHR = VK_RENDERING_RESUMING_BIT,
    } VkRenderingFlagBits;

or the equivalent

    // Provided by VK_KHR_dynamic_rendering
    typedef VkRenderingFlagBits VkRenderingFlagBitsKHR;

## Description

- `VK_RENDERING_CONTENTS_SECONDARY_COMMAND_BUFFERS_BIT` specifies that draw calls for the render pass instance will be recorded in secondary command buffers. If the `nestedCommandBuffer` feature is enabled, the draw calls can come from both inline and vkCmdExecuteCommands.

- `VK_RENDERING_RESUMING_BIT` specifies that the render pass instance is resuming an earlier suspended render pass instance.

- `VK_RENDERING_SUSPENDING_BIT` specifies that the render pass instance will be suspended.

- `VK_RENDERING_ENABLE_LEGACY_DITHERING_BIT_EXT` specifies that Legacy Dithering is enabled for the render pass instance.

- `VK_RENDERING_CONTENTS_INLINE_BIT_EXT` specifies that draw calls for the render pass instance can be recorded inline within the current command buffer. When the `nestedCommandBuffer` feature is enabled this can be combined with the `VK_RENDERING_CONTENTS_SECONDARY_COMMAND_BUFFERS_BIT` bit to allow draw calls to be recorded both inline and in secondary command buffers.

The contents of `pRenderingInfo` must match between suspended render pass instances and the render pass instances that resume them, other than the presence or absence of the `VK_RENDERING_RESUMING_BIT`, `VK_RENDERING_SUSPENDING_BIT`, and `VK_RENDERING_CONTENTS_SECONDARY_COMMAND_BUFFERS_BIT` flags. No action or synchronization commands, or other render pass instances, are allowed between suspending and resuming render pass instances.

## See Also

VK_KHR_dynamic_rendering, VK_VERSION_1_3, VkRenderingFlags

## 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-2023 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0