Package org.lwjgl.vulkan

Class KHRDynamicRenderingLocalRead

java.lang.Object

org.lwjgl.vulkan.KHRDynamicRenderingLocalRead

public class KHRDynamicRenderingLocalRead
extends Object

This extension enables reads from attachments and resources written by previous fragment shaders within a dynamic render pass.

Name String

VK_KHR_dynamic_rendering_local_read

Extension Type

Device extension

Registered Extension Number

233

Revision

1

Extension and Version Dependencies

VK_KHR_dynamic_rendering or Version 1.3

Contact

• Tobias Hector tobski

Extension Proposal

VK_KHR_dynamic_rendering_local_read

Other Extension Metadata

Last Modified Date

2023-11-03

Contributors

• Tobias Hector, AMD
• Hans-Kristian Arntzen, Valve
• Connor Abbott, Valve
• Pan Gao, Huawei
• Lionel Landwerlin, Intel
• Shahbaz Youssefi, Google
• Alyssa Rosenzweig, Valve
• Jan-Harald Fredriksen, Arm
• Mike Blumenkrantz, Valve
• Graeme Leese, Broadcom
• Piers Daniell, Nvidia
• Stuart Smith, AMD
• Daniel Story, Nintendo
• James Fitzpatrick, Imagination
• Piotr Byszewski, Mobica
• Spencer Fricke, LunarG
• Tom Olson, Arm
• Michal Pietrasiuk, Intel
• Matthew Netsch, Qualcomm
• Marty Johnson, Khronos
• Wyvern Wang, Huawei
• Jeff Bolz, Nvidia
• Samuel (Sheng-Wen) Huang, MediaTek

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VK_IMAGE_LAYOUT_RENDERING_LOCAL_READ_KHR	Extends VkImageLayout.
static final String	VK_KHR_DYNAMIC_RENDERING_LOCAL_READ_EXTENSION_NAME	The extension name.
static final int	VK_KHR_DYNAMIC_RENDERING_LOCAL_READ_SPEC_VERSION	The extension specification version.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_DYNAMIC_RENDERING_LOCAL_READ_FEATURES_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_RENDERING_ATTACHMENT_LOCATION_INFO_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_RENDERING_INPUT_ATTACHMENT_INDEX_INFO_KHR	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static void	nvkCmdSetRenderingAttachmentLocationsKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long pLocationInfo)	Unsafe version of: CmdSetRenderingAttachmentLocationsKHR
static void	nvkCmdSetRenderingInputAttachmentIndicesKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long pInputAttachmentIndexInfo)	Unsafe version of: CmdSetRenderingInputAttachmentIndicesKHR
static void	vkCmdSetRenderingAttachmentLocationsKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkRenderingAttachmentLocationInfoKHR pLocationInfo)	Set color attachment location mappings for a command buffer.
static void	vkCmdSetRenderingInputAttachmentIndicesKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkRenderingInputAttachmentIndexInfoKHR pInputAttachmentIndexInfo)	Set input attachment index mappings for a command buffer.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

VK_KHR_DYNAMIC_RENDERING_LOCAL_READ_SPEC_VERSION

public static final int VK_KHR_DYNAMIC_RENDERING_LOCAL_READ_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

VK_KHR_DYNAMIC_RENDERING_LOCAL_READ_EXTENSION_NAME

public static final String VK_KHR_DYNAMIC_RENDERING_LOCAL_READ_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

VK_IMAGE_LAYOUT_RENDERING_LOCAL_READ_KHR

public static final int VK_IMAGE_LAYOUT_RENDERING_LOCAL_READ_KHR

Extends VkImageLayout.

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_DYNAMIC_RENDERING_LOCAL_READ_FEATURES_KHR

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_DYNAMIC_RENDERING_LOCAL_READ_FEATURES_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_DYNAMIC_RENDERING_LOCAL_READ_FEATURES_KHR
• STRUCTURE_TYPE_RENDERING_ATTACHMENT_LOCATION_INFO_KHR
• STRUCTURE_TYPE_RENDERING_INPUT_ATTACHMENT_INDEX_INFO_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_RENDERING_ATTACHMENT_LOCATION_INFO_KHR

public static final int VK_STRUCTURE_TYPE_RENDERING_ATTACHMENT_LOCATION_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_DYNAMIC_RENDERING_LOCAL_READ_FEATURES_KHR
• STRUCTURE_TYPE_RENDERING_ATTACHMENT_LOCATION_INFO_KHR
• STRUCTURE_TYPE_RENDERING_INPUT_ATTACHMENT_INDEX_INFO_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_RENDERING_INPUT_ATTACHMENT_INDEX_INFO_KHR

public static final int VK_STRUCTURE_TYPE_RENDERING_INPUT_ATTACHMENT_INDEX_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_DYNAMIC_RENDERING_LOCAL_READ_FEATURES_KHR
• STRUCTURE_TYPE_RENDERING_ATTACHMENT_LOCATION_INFO_KHR
• STRUCTURE_TYPE_RENDERING_INPUT_ATTACHMENT_INDEX_INFO_KHR

See Also:

• Constant Field Values

Method Details

nvkCmdSetRenderingAttachmentLocationsKHR

public static void nvkCmdSetRenderingAttachmentLocationsKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 long pLocationInfo)

Unsafe version of: CmdSetRenderingAttachmentLocationsKHR

vkCmdSetRenderingAttachmentLocationsKHR

public static void vkCmdSetRenderingAttachmentLocationsKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 VkRenderingAttachmentLocationInfoKHR pLocationInfo)

Set color attachment location mappings for a command buffer.

C Specification

To set the fragment output location mappings during rendering, call:

 void vkCmdSetRenderingAttachmentLocationsKHR(
     VkCommandBuffer                             commandBuffer,
     const VkRenderingAttachmentLocationInfoKHR* pLocationInfo);

Description

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

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 VkRenderingInfo::pColorAttachments. This state is reset whenever CmdBeginRendering is called.

Valid Usage

• dynamicRenderingLocalRead must be enabled
• pLocationInfo→colorAttachmentCount must be equal to the value of VkRenderingInfo::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 VkCommandBuffer handle
• pLocationInfo must be a valid pointer to a valid VkRenderingAttachmentLocationInfoKHR structure
• commandBuffer must be in the recording state
• The VkCommandPool 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 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	State

See Also

VkRenderingAttachmentLocationInfoKHR

Parameters:

commandBuffer - the command buffer into which the command will be recorded.

pLocationInfo - a VkRenderingAttachmentLocationInfoKHR structure indicating the new mappings.

nvkCmdSetRenderingInputAttachmentIndicesKHR

public static void nvkCmdSetRenderingInputAttachmentIndicesKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 long pInputAttachmentIndexInfo)

Unsafe version of: CmdSetRenderingInputAttachmentIndicesKHR

vkCmdSetRenderingInputAttachmentIndicesKHR

public static void vkCmdSetRenderingInputAttachmentIndicesKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 VkRenderingInputAttachmentIndexInfoKHR pInputAttachmentIndexInfo)

Set input attachment index mappings for a command buffer.

C Specification

To set the input attachment index mappings during dynamic rendering, call:

 void vkCmdSetRenderingInputAttachmentIndicesKHR(
     VkCommandBuffer                             commandBuffer,
     const VkRenderingInputAttachmentIndexInfoKHR* pInputAttachmentIndexInfo);

Description

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

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 VkRenderingInfo::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 VkRenderingInfo::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 VkCommandBuffer handle
• pInputAttachmentIndexInfo must be a valid pointer to a valid VkRenderingInputAttachmentIndexInfoKHR structure
• commandBuffer must be in the recording state
• The VkCommandPool 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 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	State

See Also

VkRenderingInputAttachmentIndexInfoKHR

Parameters:

commandBuffer - the command buffer into which the command will be recorded.

pInputAttachmentIndexInfo - a VkRenderingInputAttachmentIndexInfoKHR structure indicating the new mappings.