vkCmdBeginRenderingKHR - Begin a dynamic render pass instance

Description

After beginning a render pass instance, the command buffer is ready to record draw commands.

If pRenderingInfo->flags includes RENDERING_RESUMING_BIT_KHR then this render pass is resumed from a render pass instance that has been suspended earlier in submission order.

Valid Usage

• The dynamicRendering feature must be enabled

• If commandBuffer is a secondary command buffer, pRenderingInfo->flags must not include RENDERING_CONTENTS_SECONDARY_COMMAND_BUFFERS_BIT_KHR

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pRenderingInfo must be a valid pointer to a valid RenderingInfoKHR structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics operations
• This command must only be called outside of a render pass instance

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

See Also

VK_KHR_dynamic_rendering, CommandBuffer, RenderingInfoKHR

This function will call the supplied action between calls to cmdBeginRenderingKHR and cmdEndRenderingKHR

Note that cmdEndRenderingKHR is *not* called if an exception is thrown by the inner action.

vkCmdEndRenderingKHR - End a dynamic render pass instance

Description

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

Valid Usage

• The current render pass instance must have been begun with cmdBeginRenderingKHR

• The current render pass instance must have been begun in commandBuffer

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics operations
• This command must only be called inside of a render pass instance

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

See Also

VK_KHR_dynamic_rendering, CommandBuffer

VkPipelineRenderingCreateInfoKHR - Structure specifying attachment formats

Description

When a pipeline is created without a RenderPass, if this structure is present in the pNext chain of GraphicsPipelineCreateInfo, it specifies the view mask and format of attachments used for rendering. If this structure is not specified, and the pipeline does not include a RenderPass, viewMask and colorAttachmentCount are 0, and depthAttachmentFormat and stencilAttachmentFormat are FORMAT_UNDEFINED. If a graphics pipeline is created with a valid RenderPass, parameters of this structure are ignored.

If depthAttachmentFormat, stencilAttachmentFormat, or any element of pColorAttachmentFormats is FORMAT_UNDEFINED, it indicates that the corresponding attachment is unused within the render pass. Valid formats indicate that an attachment can be used - but it is still valid to set the attachment to NULL when beginning rendering.

Valid Usage

• If any element of pColorAttachmentFormats is not FORMAT_UNDEFINED, it must be a format with potential format features that include FORMAT_FEATURE_COLOR_ATTACHMENT_BIT

• If depthAttachmentFormat is not FORMAT_UNDEFINED, it must be a format with potential format features that include FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
• If stencilAttachmentFormat is not FORMAT_UNDEFINED, it must be a format with potential format features that include FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
• If depthAttachmentFormat is not FORMAT_UNDEFINED and stencilAttachmentFormat is not FORMAT_UNDEFINED, depthAttachmentFormat must equal stencilAttachmentFormat
• If the multiview feature is not enabled, viewMask must be 0
• The index of the most significant bit in viewMask must be less than maxMultiviewViewCount

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_RENDERING_CREATE_INFO_KHR

• If colorAttachmentCount is not 0, pColorAttachmentFormats must be a valid pointer to an array of colorAttachmentCount valid Format values
• depthAttachmentFormat must be a valid Format value
• stencilAttachmentFormat must be a valid Format value

See Also

VK_KHR_dynamic_rendering, Format, StructureType

VkRenderingInfoKHR - Structure specifying render pass instance begin info

Description

If viewMask is not 0, multiview is enabled.

If there is an instance of DeviceGroupRenderPassBeginInfo included in the pNext chain and its deviceCount member is not 0, then renderArea is ignored, and the render area is defined per-device by that structure.

Each element of the pColorAttachments array corresponds to an output location in the shader, i.e. if the shader declares an output variable decorated with a Location value of X, then it uses the attachment provided in pColorAttachments[X]. If the imageView member of any element of pColorAttachments is NULL_HANDLE, writes to the corresponding location by a fragment are discarded.

Valid Usage

• If viewMask is 0, layerCount must not be 0

• If neither the VK_AMD_mixed_attachment_samples nor the VK_NV_framebuffer_mixed_samples extensions are enabled, imageView members of pDepthAttachment, pStencilAttachment, and elements of pColorAttachments that are not NULL_HANDLE must have been created with the same sampleCount
• If the pNext chain does not contain DeviceGroupRenderPassBeginInfo or its deviceRenderAreaCount member is equal to 0, renderArea.offset.x must be greater than or equal to 0
• If the pNext chain does not contain DeviceGroupRenderPassBeginInfo or its deviceRenderAreaCount member is equal to 0, renderArea.offset.y must be greater than or equal to 0
• If the pNext chain does not contain DeviceGroupRenderPassBeginInfo or its deviceRenderAreaCount member is equal to 0, the width of the imageView member of any element of pColorAttachments, pDepthAttachment, or pStencilAttachment that is not NULL_HANDLE must be greater than or equal to renderArea.offset.x + renderArea.extent.width
• If the pNext chain does not contain DeviceGroupRenderPassBeginInfo or its deviceRenderAreaCount member is equal to 0, the height of the imageView member of any element of pColorAttachments, pDepthAttachment, or pStencilAttachment that is not NULL_HANDLE must be greater than or equal to renderArea.offset.y + renderArea.extent.height
• If the pNext chain contains DeviceGroupRenderPassBeginInfo, the offset.x member of each element of pDeviceRenderAreas must be greater than or equal to 0
• If the pNext chain contains DeviceGroupRenderPassBeginInfo, the offset.y member of each element of pDeviceRenderAreas must be greater than or equal to 0
• If the pNext chain contains DeviceGroupRenderPassBeginInfo, the width of the imageView member of any element of pColorAttachments, pDepthAttachment, or pStencilAttachment that is not NULL_HANDLE must be greater than or equal to the sum of the offset.x and extent.width members of each element of pDeviceRenderAreas
• If the pNext chain contains DeviceGroupRenderPassBeginInfo, the height of the imageView member of any element of pColorAttachments, pDepthAttachment, or pStencilAttachment that is not NULL_HANDLE must be greater than or equal to the sum of the offset.y and extent.height members of each element of pDeviceRenderAreas
• If neither pDepthAttachment or pStencilAttachment are NULL and the imageView member of either structure is not NULL_HANDLE, the imageView member of each structure must be the same
• If neither pDepthAttachment or pStencilAttachment are NULL, and the resolveMode member of each is not RESOLVE_MODE_NONE, the resolveImageView member of each structure must be the same
• If colorAttachmentCount is not 0 and the imageView member of an element of pColorAttachments is not NULL_HANDLE, that imageView must have been created with IMAGE_USAGE_COLOR_ATTACHMENT_BIT
• If pDepthAttachment is not NULL and pDepthAttachment->imageView is not NULL_HANDLE, pDepthAttachment->imageView must have been created with IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
• If pStencilAttachment is not NULL and pStencilAttachment->imageView is not NULL_HANDLE, pStencilAttachment->imageView must have been created with a stencil usage including IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
• If colorAttachmentCount is not 0 and the imageView member of an element of pColorAttachments is not NULL_HANDLE, the layout member of that element of pColorAttachments must not be IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL
• If colorAttachmentCount is not 0 and the imageView member of an element of pColorAttachments is not NULL_HANDLE, if the resolveMode member of that element of pColorAttachments is not RESOLVE_MODE_NONE, its resolveImageLayout member must not be IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL
• If pDepthAttachment is not NULL and pDepthAttachment->imageView is not NULL_HANDLE, pDepthAttachment->layout must not be IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
• If pDepthAttachment is not NULL, pDepthAttachment->imageView is not NULL_HANDLE, and pDepthAttachment->resolveMode is not RESOLVE_MODE_NONE, pDepthAttachment->resolveImageLayout must not be IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
• If pStencilAttachment is not NULL and pStencilAttachment->imageView is not NULL_HANDLE, pStencilAttachment->layout must not be IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
• If pStencilAttachment is not NULL, pStencilAttachment->imageView is not NULL_HANDLE, and pStencilAttachment->resolveMode is not RESOLVE_MODE_NONE, pStencilAttachment->resolveImageLayout must not be IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
• If colorAttachmentCount is not 0 and the imageView member of an element of pColorAttachments is not NULL_HANDLE, the layout member of that element of pColorAttachments must not be IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL
• If colorAttachmentCount is not 0 and the imageView member of an element of pColorAttachments is not NULL_HANDLE, if the resolveMode member of that element of pColorAttachments is not RESOLVE_MODE_NONE, its resolveImageLayout member must not be IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL
• If pDepthAttachment is not NULL, pDepthAttachment->imageView is not NULL_HANDLE, and pDepthAttachment->resolveMode is not RESOLVE_MODE_NONE, pDepthAttachment->resolveImageLayout must not be IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL
• If pStencilAttachment is not NULL, pStencilAttachment->imageView is not NULL_HANDLE, and pStencilAttachment->resolveMode is not RESOLVE_MODE_NONE, pStencilAttachment->resolveImageLayout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL
• If colorAttachmentCount is not 0 and the imageView member of an element of pColorAttachments is not NULL_HANDLE, the layout member of that element of pColorAttachments must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
• If colorAttachmentCount is not 0 and the imageView member of an element of pColorAttachments is not NULL_HANDLE, if the resolveMode member of that element of pColorAttachments is not RESOLVE_MODE_NONE, its resolveImageLayout member must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
• If pDepthAttachment is not NULL and pDepthAttachment->imageView is not NULL_HANDLE, pDepthAttachment->resolveMode must be one of the bits set in PhysicalDeviceDepthStencilResolveProperties::supportedDepthResolveModes
• If pStencilAttachment is not NULL and pStencilAttachment->imageView is not NULL_HANDLE, pStencilAttachment->resolveMode must be one of the bits set in PhysicalDeviceDepthStencilResolveProperties::supportedStencilResolveModes
• If pDepthAttachment or pStencilAttachment are both not NULL, pDepthAttachment->imageView and pStencilAttachment->imageView are both not NULL_HANDLE, and PhysicalDeviceDepthStencilResolveProperties::independentResolveNone is FALSE, the resolveMode of both structures must be the same value
• If pDepthAttachment or pStencilAttachment are both not NULL, pDepthAttachment->imageView and pStencilAttachment->imageView are both not NULL_HANDLE, PhysicalDeviceDepthStencilResolveProperties::independentResolve is FALSE, and the resolveMode of neither structure is RESOLVE_MODE_NONE, the resolveMode of both structures must be the same value
• colorAttachmentCount must be less than or equal to PhysicalDeviceLimits::maxColorAttachments
• If the imageView member of a RenderingFragmentDensityMapAttachmentInfoEXT structure included in the pNext chain is not NULL_HANDLE, and non-subsample image feature is not enabled, valid imageView and resolveImageView members of pDepthAttachment, pStencilAttachment, and each element of pColorAttachments must be a ImageView created with IMAGE_CREATE_SUBSAMPLED_BIT_EXT
• If the imageView member of a RenderingFragmentDensityMapAttachmentInfoEXT structure included in the pNext chain is not NULL_HANDLE, and viewMask is not 0, imageView must have a layerCount greater than or equal to the index of the most significant bit in viewMask
• If the imageView member of a RenderingFragmentDensityMapAttachmentInfoEXT structure included in the pNext chain is not NULL_HANDLE, and viewMask is 0, imageView must have a layerCount equal to 1
• If the pNext chain does not contain DeviceGroupRenderPassBeginInfo or its deviceRenderAreaCount member is equal to 0 and the imageView member of a RenderingFragmentDensityMapAttachmentInfoEXT structure included in the pNext chain is not NULL_HANDLE, imageView must have a width greater than or equal to \(\left\lceil{\frac{renderArea_{x}+renderArea_{width}}{maxFragmentDensityTexelSize_{width}}}\right\rceil\)
• If the pNext chain contains a DeviceGroupRenderPassBeginInfo structure, its deviceRenderAreaCount member is not 0, and the imageView member of a RenderingFragmentDensityMapAttachmentInfoEXT structure included in the pNext chain is not NULL_HANDLE, imageView must have a width greater than or equal to \(\left\lceil{\frac{pDeviceRenderAreas_{x}+pDeviceRenderAreas_{width}}{maxFragmentDensityTexelSize_{width}}}\right\rceil\) for each element of pDeviceRenderAreas
• If the pNext chain does not contain DeviceGroupRenderPassBeginInfo or its deviceRenderAreaCount member is equal to 0 and the imageView member of a RenderingFragmentDensityMapAttachmentInfoEXT structure included in the pNext chain is not NULL_HANDLE, imageView must have a height greater than or equal to \(\left\lceil{\frac{renderArea_{y}+renderArea_{height}}{maxFragmentDensityTexelSize_{height}}}\right\rceil\)
• If the pNext chain contains a DeviceGroupRenderPassBeginInfo structure, its deviceRenderAreaCount member is not 0, and the imageView member of a RenderingFragmentDensityMapAttachmentInfoEXT structure included in the pNext chain is not NULL_HANDLE, imageView must have a height greater than or equal to \(\left\lceil{\frac{pDeviceRenderAreas_{y}+pDeviceRenderAreas_{height}}{maxFragmentDensityTexelSize_{height}}}\right\rceil\) for each element of pDeviceRenderAreas
• If the imageView member of a RenderingFragmentDensityMapAttachmentInfoEXT structure included in the pNext chain is not NULL_HANDLE, it must not be equal to the imageView or resolveImageView member of pDepthAttachment, pStencilAttachment, or any element of pColorAttachments
• If the pNext chain does not contain DeviceGroupRenderPassBeginInfo or its deviceRenderAreaCount member is equal to 0 and the imageView member of a RenderingFragmentShadingRateAttachmentInfoKHR structure included in the pNext chain is not NULL_HANDLE, imageView must have a width greater than or equal to \(\left\lceil{\frac{renderArea_{x}+renderArea_{width}}{shadingRateAttachmentTexelSize_{width}}}\right\rceil\)
• If the pNext chain contains a DeviceGroupRenderPassBeginInfo structure, its deviceRenderAreaCount member is not 0, and the imageView member of a RenderingFragmentShadingRateAttachmentInfoKHR structure included in the pNext chain is not NULL_HANDLE, imageView must have a width greater than or equal to \(\left\lceil{\frac{pDeviceRenderAreas_{x}+pDeviceRenderAreas_{width}}{shadingRateAttachmentTexelSize_{width}}}\right\rceil\) for each element of pDeviceRenderAreas
• If the pNext chain does not contain DeviceGroupRenderPassBeginInfo or its deviceRenderAreaCount member is equal to 0 and the imageView member of a RenderingFragmentShadingRateAttachmentInfoKHR structure included in the pNext chain is not NULL_HANDLE, imageView must have a height greater than or equal to \(\left\lceil{\frac{renderArea_{y}+renderArea_{height}}{shadingRateAttachmentTexelSize_{height}}}\right\rceil\)
• If the pNext chain contains a DeviceGroupRenderPassBeginInfo structure, its deviceRenderAreaCount member is not 0, and the imageView member of a RenderingFragmentShadingRateAttachmentInfoKHR structure included in the pNext chain is not NULL_HANDLE, imageView must have a height greater than or equal to \(\left\lceil{\frac{pDeviceRenderAreas_{y}+pDeviceRenderAreas_{height}}{shadingRateAttachmentTexelSize_{height}}}\right\rceil\) for each element of pDeviceRenderAreas
• If the imageView member of a RenderingFragmentShadingRateAttachmentInfoKHR structure included in the pNext chain is not NULL_HANDLE, and viewMask is 0, imageView must have a layerCount that is either equal to 1 or greater than or equal to layerCount
• If the imageView member of a RenderingFragmentShadingRateAttachmentInfoKHR structure included in the pNext chain is not NULL_HANDLE, and viewMask is not 0, imageView must have a layerCount that either equal to 1 or greater than or equal to the index of the most significant bit in viewMask
• If the imageView member of a RenderingFragmentShadingRateAttachmentInfoKHR structure included in the pNext chain is not NULL_HANDLE, it must not be equal to the imageView or resolveImageView member of pDepthAttachment, pStencilAttachment, or any element of pColorAttachments
• If the imageView member of a RenderingFragmentShadingRateAttachmentInfoKHR structure included in the pNext chain is not NULL_HANDLE, it must not be equal to the imageView member of a RenderingFragmentDensityMapAttachmentInfoEXT structure included in the pNext chain
• If the multiview feature is not enabled, viewMask must be 0
• The index of the most significant bit in viewMask must be less than maxMultiviewViewCount

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RENDERING_INFO_KHR

• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of DeviceGroupRenderPassBeginInfo, MultiviewPerViewAttributesInfoNVX, RenderingFragmentDensityMapAttachmentInfoEXT, or RenderingFragmentShadingRateAttachmentInfoKHR
• The sType value of each struct in the pNext chain must be unique
• flags must be a valid combination of RenderingFlagBitsKHR values
• If colorAttachmentCount is not 0, pColorAttachments must be a valid pointer to an array of colorAttachmentCount valid RenderingAttachmentInfoKHR structures
• If pDepthAttachment is not NULL, pDepthAttachment must be a valid pointer to a valid RenderingAttachmentInfoKHR structure
• If pStencilAttachment is not NULL, pStencilAttachment must be a valid pointer to a valid RenderingAttachmentInfoKHR structure

See Also

VK_KHR_dynamic_rendering, Rect2D, RenderingAttachmentInfoKHR, RenderingFlagsKHR, StructureType, cmdBeginRenderingKHR

VkRenderingAttachmentInfoKHR - Structure specifying attachment information

Description

Values in imageView are loaded and stored according to the values of loadOp and storeOp, within the render area for each device specified in RenderingInfoKHR. If imageView is NULL_HANDLE, other members of this structure are ignored; writes to this attachment will be discarded, and no load, store, or resolve operations will be performed.

If resolveMode is RESOLVE_MODE_NONE, then resolveImageView is ignored. If resolveMode is not RESOLVE_MODE_NONE, values in resolveImageView within the render area become undefined once rendering begins. At the end of rendering, the color values written to each pixel location in imageView will be resolved according to resolveMode and stored into the the same location in resolveImageView.

Note

The resolve mode and store operation are independent; it is valid to write both resolved and unresolved values, and equally valid to discard the unresolved values while writing the resolved ones.

Store and resolve operations are only performed at the end of a render pass instance that does not specify the RENDERING_SUSPENDING_BIT_KHR flag.

Load operations are only performed at the beginning of a render pass instance that does not specify the RENDERING_RESUMING_BIT_KHR flag.

Image contents at the end of a suspended render pass instance remain defined for access by a resuming render pass instance.

Valid Usage

• If imageView is not NULL_HANDLE and has a non-integer color format, resolveMode must be RESOLVE_MODE_NONE or RESOLVE_MODE_AVERAGE_BIT

• If imageView is not NULL_HANDLE and has an integer color format, resolveMode must be RESOLVE_MODE_NONE or RESOLVE_MODE_SAMPLE_ZERO_BIT
• If imageView is not NULL_HANDLE and resolveMode is not RESOLVE_MODE_NONE, imageView must not have a sample count of SAMPLE_COUNT_1_BIT
• If imageView is not NULL_HANDLE and resolveMode is not RESOLVE_MODE_NONE, resolveImageView must have a sample count of SAMPLE_COUNT_1_BIT
• If imageView is not NULL_HANDLE and resolveMode is not RESOLVE_MODE_NONE, imageView and resolveImageView must have the same Format
• If imageView is not NULL_HANDLE, layout must not be IMAGE_LAYOUT_UNDEFINED, IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, or IMAGE_LAYOUT_PREINITIALIZED
• If imageView is not NULL_HANDLE and resolveMode is not RESOLVE_MODE_NONE, resolveImageLayout must not be IMAGE_LAYOUT_UNDEFINED, IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, or IMAGE_LAYOUT_PREINITIALIZED
• If imageView is not NULL_HANDLE and resolveMode is not RESOLVE_MODE_NONE, resolveImageLayout must not be IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
• If imageView is not NULL_HANDLE, layout must not be IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV
• If imageView is not NULL_HANDLE and resolveMode is not RESOLVE_MODE_NONE, resolveImageLayout must not be IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV
• If imageView is not NULL_HANDLE, layout must not be IMAGE_LAYOUT_FRAGMENT_DENSITY_MAP_OPTIMAL_EXT
• If imageView is not NULL_HANDLE and resolveMode is not RESOLVE_MODE_NONE, resolveImageLayout must not be IMAGE_LAYOUT_FRAGMENT_DENSITY_MAP_OPTIMAL_EXT
• If imageView is not NULL_HANDLE and resolveMode is not RESOLVE_MODE_NONE, resolveImageLayout must not be IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR
• If imageView is not NULL_HANDLE, layout must not be IMAGE_LAYOUT_FRAGMENT_SHADING_RATE_ATTACHMENT_OPTIMAL_KHR
• If imageView is not NULL_HANDLE and resolveMode is not RESOLVE_MODE_NONE, resolveImageLayout must not be IMAGE_LAYOUT_FRAGMENT_SHADING_RATE_ATTACHMENT_OPTIMAL_KHR
• If imageView is not NULL_HANDLE, layout must not be IMAGE_LAYOUT_PRESENT_SRC_KHR
• If imageView is not NULL_HANDLE and resolveMode is not RESOLVE_MODE_NONE, resolveImageLayout must not be IMAGE_LAYOUT_PRESENT_SRC_KHR

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RENDERING_ATTACHMENT_INFO_KHR

• pNext must be NULL
• If imageView is not NULL_HANDLE, imageView must be a valid ImageView handle
• imageLayout must be a valid ImageLayout value
• If resolveMode is not 0, resolveMode must be a valid ResolveModeFlagBits value
• If resolveImageView is not NULL_HANDLE, resolveImageView must be a valid ImageView handle
• resolveImageLayout must be a valid ImageLayout value
• loadOp must be a valid AttachmentLoadOp value
• storeOp must be a valid AttachmentStoreOp value
• clearValue must be a valid ClearValue union
• Both of imageView, and resolveImageView that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

See Also

VK_KHR_dynamic_rendering, AttachmentLoadOp, AttachmentStoreOp, ClearValue, ImageLayout, ImageView, RenderingInfoKHR, ResolveModeFlagBits, StructureType

VkRenderingFragmentShadingRateAttachmentInfoKHR - Structure specifying fragment shading rate attachment information

Description

This structure can be included in the pNext chain of RenderingInfoKHR to define a fragment shading rate attachment. If imageView is NULL_HANDLE, or if this structure is not specified, the implementation behaves as if a valid shading rate attachment was specified with all texels specifying a single pixel per fragment.

Valid Usage

• If imageView is not NULL_HANDLE, layout must be IMAGE_LAYOUT_GENERAL or IMAGE_LAYOUT_FRAGMENT_SHADING_RATE_ATTACHMENT_OPTIMAL_KHR

• If imageView is not NULL_HANDLE, it must have been created with IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR
• If imageView is not NULL_HANDLE, shadingRateAttachmentTexelSize.width must be a power of two value
• If imageView is not NULL_HANDLE, shadingRateAttachmentTexelSize.width must be less than or equal to maxFragmentShadingRateAttachmentTexelSize.width
• If imageView is not NULL_HANDLE, shadingRateAttachmentTexelSize.width must be greater than or equal to minFragmentShadingRateAttachmentTexelSize.width
• If imageView is not NULL_HANDLE, shadingRateAttachmentTexelSize.height must be a power of two value
• If imageView is not NULL_HANDLE, shadingRateAttachmentTexelSize.height must be less than or equal to maxFragmentShadingRateAttachmentTexelSize.height
• If imageView is not NULL_HANDLE, shadingRateAttachmentTexelSize.height must be greater than or equal to minFragmentShadingRateAttachmentTexelSize.height
• If imageView is not NULL_HANDLE, the quotient of shadingRateAttachmentTexelSize.width and shadingRateAttachmentTexelSize.height must be less than or equal to maxFragmentShadingRateAttachmentTexelSizeAspectRatio
• If imageView is not NULL_HANDLE, the quotient of shadingRateAttachmentTexelSize.height and shadingRateAttachmentTexelSize.width must be less than or equal to maxFragmentShadingRateAttachmentTexelSizeAspectRatio

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RENDERING_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR

• If imageView is not NULL_HANDLE, imageView must be a valid ImageView handle
• imageLayout must be a valid ImageLayout value

See Also

VK_KHR_dynamic_rendering, VK_KHR_fragment_shading_rate, Extent2D, ImageLayout, ImageView, StructureType

VkRenderingFragmentDensityMapAttachmentInfoEXT - Structure specifying fragment shading rate attachment information

Description

This structure can be included in the pNext chain of RenderingInfoKHR to define a fragment density map. If imageView is NULL_HANDLE, or if this structure is not specified, imageView is NULL_HANDLE.

Valid Usage

• If imageView is not NULL_HANDLE, layout must be IMAGE_LAYOUT_GENERAL or IMAGE_LAYOUT_FRAGMENT_DENSITY_MAP_OPTIMAL_EXT

• If imageView is not NULL_HANDLE, it must have been created with IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT
• If imageView is not NULL_HANDLE, it must not have been created with IMAGE_CREATE_SUBSAMPLED_BIT_EXT

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RENDERING_FRAGMENT_DENSITY_MAP_ATTACHMENT_INFO_EXT

• imageView must be a valid ImageView handle
• imageLayout must be a valid ImageLayout value

See Also

VK_EXT_fragment_density_map, VK_KHR_dynamic_rendering, ImageLayout, ImageView, StructureType

VkPhysicalDeviceDynamicRenderingFeaturesKHR - Structure indicating support for dynamic render pass instances

Members

The members of the PhysicalDeviceDynamicRenderingFeaturesKHR structure describe the following features:

Description

If the PhysicalDeviceDynamicRenderingFeaturesKHR structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. PhysicalDeviceDynamicRenderingFeaturesKHR can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

See Also

VK_KHR_dynamic_rendering, Bool32, StructureType

VkCommandBufferInheritanceRenderingInfoKHR - Structure specifying command buffer inheritance info for dynamic render pass instances

Description

If the pNext chain of CommandBufferInheritanceInfo includes a CommandBufferInheritanceRenderingInfoKHR structure, then that structure controls parameters of dynamic render pass instances that the CommandBuffer can be executed within. If CommandBufferInheritanceInfo::renderPass is not NULL_HANDLE, or COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT is not specified in CommandBufferBeginInfo::flags, parameters of this structure are ignored.

If colorAttachmentCount is 0 and the variableMultisampleRate feature is enabled, rasterizationSamples is ignored.

If depthAttachmentFormat, stencilAttachmentFormat, or any element of pColorAttachmentFormats is FORMAT_UNDEFINED, it indicates that the corresponding attachment is unused within the render pass.

Valid Usage

• If colorAttachmentCount is not 0, rasterizationSamples must be a valid SampleCountFlagBits value

• If the variableMultisampleRate feature is not enabled, rasterizationSamples must be a valid SampleCountFlagBits value
• If any element of pColorAttachmentFormats is not FORMAT_UNDEFINED, it must be a format with potential format features that include FORMAT_FEATURE_COLOR_ATTACHMENT_BIT
• If depthAttachmentFormat is not FORMAT_UNDEFINED, it must be a format with potential format features that include FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
• If stencilAttachmentFormat is not FORMAT_UNDEFINED, it must be a format with potential format features that include FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
• If depthAttachmentFormat is not FORMAT_UNDEFINED and stencilAttachmentFormat is not FORMAT_UNDEFINED, depthAttachmentFormat must equal stencilAttachmentFormat
• If the multiview feature is not enabled, viewMask must be 0
• The index of the most significant bit in viewMask must be less than maxMultiviewViewCount

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_RENDERING_INFO_KHR

• flags must be a valid combination of RenderingFlagBitsKHR values
• pColorAttachmentFormats must be a valid pointer to an array of colorAttachmentCount valid Format values
• depthAttachmentFormat must be a valid Format value
• stencilAttachmentFormat must be a valid Format value
• If rasterizationSamples is not 0, rasterizationSamples must be a valid SampleCountFlagBits value
• colorAttachmentCount must be greater than 0

See Also

VK_KHR_dynamic_rendering, Format, RenderingFlagsKHR, SampleCountFlagBits, StructureType

VkAttachmentSampleCountInfoAMD - Structure specifying command buffer inheritance info for dynamic render pass instances

Description

If CommandBufferInheritanceInfo::renderPass is NULL_HANDLE, COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT is specified in CommandBufferBeginInfo::flags, and the pNext chain of CommandBufferInheritanceInfo includes AttachmentSampleCountInfoAMD, then this structure defines the sample counts of each attachment within the render pass instance. If AttachmentSampleCountInfoAMD is not included, the value of CommandBufferInheritanceRenderingInfoKHR::rasterizationSamples is used as the sample count for each attachment. If CommandBufferInheritanceInfo::renderPass is not NULL_HANDLE, or COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT is not specified in CommandBufferBeginInfo::flags, parameters of this structure are ignored.

AttachmentSampleCountInfoAMD can also be included in the pNext chain of GraphicsPipelineCreateInfo. When a graphics pipeline is created without a RenderPass, if this structure is present in the pNext chain of GraphicsPipelineCreateInfo, it specifies the sample count of attachments used for rendering. If this structure is not specified, and the pipeline does not include a RenderPass, the value of PipelineMultisampleStateCreateInfo::rasterizationSamples is used as the sample count for each attachment. If a graphics pipeline is created with a valid RenderPass, parameters of this structure are ignored.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ATTACHMENT_SAMPLE_COUNT_INFO_AMD

• pColorAttachmentSamples must be a valid pointer to an array of colorAttachmentCount valid or NULL_HANDLE SampleCountFlagBits values
• If depthStencilAttachmentSamples is not 0, depthStencilAttachmentSamples must be a valid SampleCountFlagBits value
• colorAttachmentCount must be greater than 0

See Also

VK_AMD_mixed_attachment_samples, VK_KHR_dynamic_rendering, VK_NV_framebuffer_mixed_samples, SampleCountFlagBits, StructureType

VkMultiviewPerViewAttributesInfoNVX - Structure specifying the multiview per-attribute properties

Description

When dynamic render pass instances are being used, instead of specifying SUBPASS_DESCRIPTION_PER_VIEW_ATTRIBUTES_BIT_NVX or SUBPASS_DESCRIPTION_PER_VIEW_POSITION_X_ONLY_BIT_NVX in the subpass description flags, the per-attibute properties of the render pass instance must be specified by the MultiviewPerViewAttributesInfoNVX structure Include the MultiviewPerViewAttributesInfoNVX structure in the pNext chain of GraphicsPipelineCreateInfo when creating a graphics pipeline for dynamic rendering, RenderingInfoKHR when starting a dynamic render pass instance, and CommandBufferInheritanceInfo when specifying the dynamic render pass instance parameters for secondary command buffers.

Valid Usage

• If perViewAttributesPositionXOnly is TRUE then perViewAttributes must also be TRUE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_MULTIVIEW_PER_VIEW_ATTRIBUTES_INFO_NVX

See Also

VK_KHR_dynamic_rendering, VK_NVX_multiview_per_view_attributes, Bool32, StructureType

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

Description

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 RENDERING_RESUMING_BIT_KHR, RENDERING_SUSPENDING_BIT_KHR, and RENDERING_CONTENTS_SECONDARY_COMMAND_BUFFERS_BIT_KHR 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, RenderingFlagsKHR