vkCmdSetRenderingAttachmentLocationsKHR - Set color attachment location mappings for a command buffer

Description

This command sets the attachment location mappings for subsequent drawing commands, and must match the mappings provided to the bound pipeline, if one is bound, which can be set by chaining RenderingAttachmentLocationInfoKHR to GraphicsPipelineCreateInfo.

Until this command is called, mappings in the command buffer state are treated as each color attachment specified in cmdBeginRendering having a location equal to its index in RenderingInfo::pColorAttachments. This state is reset whenever cmdBeginRendering is called.

Valid Usage

• dynamicRenderingLocalRead must be enabled

• pLocationInfo->colorAttachmentCount must be equal to the value of RenderingInfo::colorAttachmentCount used to begin the current render pass instance
• The current render pass instance must have been started or resumed by cmdBeginRendering in this commandBuffer

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pLocationInfo must be a valid pointer to a valid RenderingAttachmentLocationInfoKHR 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 inside of a render pass instance
• 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 CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

See Also

VK_KHR_dynamic_rendering_local_read, CommandBuffer, RenderingAttachmentLocationInfoKHR

vkCmdSetRenderingInputAttachmentIndicesKHR - Set input attachment index mappings for a command buffer

Description

This command sets the input attachment index mappings for subsequent drawing commands, and must match the mappings provided to the bound pipeline, if one is bound, which can be set by chaining RenderingInputAttachmentIndexInfoKHR to GraphicsPipelineCreateInfo.

Until this command is called, mappings in the command buffer state are treated as each color attachment specified in cmdBeginRendering mapping to subpass inputs with a InputAttachmentIndex equal to its index in RenderingInfo::pColorAttachments, and depth/stencil attachments mapping to input attachments without these decorations. This state is reset whenever cmdBeginRendering is called.

Valid Usage

• dynamicRenderingLocalRead must be enabled

• pInputAttachmentIndexInfo->colorAttachmentCount must be equal to the value of RenderingInfo::colorAttachmentCount used to begin the current render pass instance
• The current render pass instance must have been started or resumed by cmdBeginRendering in this commandBuffer

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pInputAttachmentIndexInfo must be a valid pointer to a valid RenderingInputAttachmentIndexInfoKHR 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 inside of a render pass instance
• 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 CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

See Also

VK_KHR_dynamic_rendering_local_read, CommandBuffer, RenderingInputAttachmentIndexInfoKHR

VkPhysicalDeviceDynamicRenderingLocalReadFeaturesKHR - Structure indicating support for local reads in dynamic render pass instances

Members

This structure describes the following feature:

Description

If the PhysicalDeviceDynamicRenderingLocalReadFeaturesKHR 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. PhysicalDeviceDynamicRenderingLocalReadFeaturesKHR can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

See Also

VK_KHR_dynamic_rendering_local_read, Bool32, StructureType

VkRenderingAttachmentLocationInfoKHR - Structure specifying attachment locations

Description

This structure allows applications to remap the locations of color attachments to different fragment shader output locations.

Each element of pColorAttachmentLocations set to ATTACHMENT_UNUSED will be inaccessible to this pipeline as a color attachment; no location will map to it. Each element of pColorAttachmentLocations set to any other value will map the specified location value to the color attachment specified in the render pass at the corresponding index in the pColorAttachmentLocations array. Any writes to a fragment output location that is not mapped to an attachment must be discarded.

If pColorAttachmentLocations is NULL, it is equivalent to setting each element to its index within the array.

This structure can be included in the pNext chain of a GraphicsPipelineCreateInfo structure to set this state for a pipeline. If this structure is not included in the pNext chain of GraphicsPipelineCreateInfo, it is equivalent to specifying this structure with the following properties:

• colorAttachmentCount set to PipelineRenderingCreateInfo::colorAttachmentCount.
• pColorAttachmentLocations set to NULL.

This structure can be included in the pNext chain of a CommandBufferInheritanceInfo structure to specify inherited state from the primary command buffer. If CommandBufferInheritanceInfo::renderPass is not NULL_HANDLE, or COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT is not specified in CommandBufferBeginInfo::flags, members of this structure are ignored. If this structure is not included in the pNext chain of CommandBufferInheritanceInfo, it is equivalent to specifying this structure with the following properties:

• colorAttachmentCount set to CommandBufferInheritanceRenderingInfo::colorAttachmentCount.
• pColorAttachmentLocations set to NULL.

Valid Usage

• If the dynamicRenderingLocalRead feature is not enabled, and pColorAttachmentLocations is not NULL, each element must be the value of its index within the array

• Elements of pColorAttachmentLocations that are not ATTACHMENT_UNUSED must each be unique
• colorAttachmentCount must be less than or equal to maxColorAttachments
• Each element of pColorAttachmentLocations must be less than maxColorAttachments

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RENDERING_ATTACHMENT_LOCATION_INFO_KHR

See Also

VK_KHR_dynamic_rendering_local_read, StructureType, cmdSetRenderingAttachmentLocationsKHR

VkRenderingInputAttachmentIndexInfoKHR - Structure specifying input attachment indices

Description

This structure allows applications to remap attachments to different input attachment indices.

Each element of pColorAttachmentInputIndices set to a value of ATTACHMENT_UNUSED indicates that the corresponding attachment will not be used as an input attachment in this pipeline. Any other value in each of those elements will map the corresponding attachment to a InputAttachmentIndex value defined in shader code.

If pColorAttachmentInputIndices is NULL, it is equivalent to setting each element to its index within the array.

If pDepthInputAttachmentIndex or pStencilInputAttachmentIndex are set to NULL, they map to input attachments without a InputAttachmentIndex decoration. If they point to a value of ATTACHMENT_UNUSED, it indicates that the corresponding attachment will not be used as an input attachment in this pipeline. If they point to any other value it maps the corresponding attachment to a InputAttachmentIndex value defined in shader code.

This structure can be included in the pNext chain of a GraphicsPipelineCreateInfo structure to set this state for a pipeline. If this structure is not included in the pNext chain of GraphicsPipelineCreateInfo, it is equivalent to specifying this structure with the following properties:

• colorAttachmentCount set to PipelineRenderingCreateInfo::colorAttachmentCount.
• pColorAttachmentInputIndices set to NULL.
• pDepthInputAttachmentIndex set to NULL.
• pStencilInputAttachmentIndex set to NULL.

This structure can be included in the pNext chain of a CommandBufferInheritanceInfo structure to specify inherited state from the primary command buffer. If this structure is not included in the pNext chain of CommandBufferInheritanceInfo, it is equivalent to specifying this structure with the following properties:

• colorAttachmentCount set to CommandBufferInheritanceRenderingInfo::colorAttachmentCount.
• pColorAttachmentInputIndices set to NULL.
• pDepthInputAttachmentIndex set to NULL.
• pStencilInputAttachmentIndex set to NULL.

Valid Usage

• If the dynamicRenderingLocalRead feature is not enabled, and pColorAttachmentInputIndices is not NULL, each element must be ATTACHMENT_UNUSED

• If the dynamicRenderingLocalRead feature is not enabled, pDepthInputAttachmentIndex must be a valid pointer to a value of ATTACHMENT_UNUSED
• If the dynamicRenderingLocalRead feature is not enabled, pStencilInputAttachmentIndex must be a valid pointer to a value of ATTACHMENT_UNUSED
• Elements of pColorAttachmentInputIndices that are not ATTACHMENT_UNUSED must each be unique
• Elements of pColorAttachmentInputIndices that are not ATTACHMENT_UNUSED must not take the same value as the content of pDepthInputAttachmentIndex
• Elements of pColorAttachmentInputIndices that are not ATTACHMENT_UNUSED must not take the same value as the content of pStencilInputAttachmentIndex
• colorAttachmentCount must be less than or equal to maxColorAttachments

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RENDERING_INPUT_ATTACHMENT_INDEX_INFO_KHR

• If colorAttachmentCount is not 0, and pColorAttachmentInputIndices is not NULL, pColorAttachmentInputIndices must be a valid pointer to an array of colorAttachmentCount uint32_t values
• If pDepthInputAttachmentIndex is not NULL, pDepthInputAttachmentIndex must be a valid pointer to a valid uint32_t value
• If pStencilInputAttachmentIndex is not NULL, pStencilInputAttachmentIndex must be a valid pointer to a valid uint32_t value

See Also

VK_KHR_dynamic_rendering_local_read, StructureType, cmdSetRenderingInputAttachmentIndicesKHR