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.

Promotion to Vulkan 1.4

Functionality in this extension is included in core Vulkan 1.4, with the KHR suffix omitted. However, Vulkan 1.4 implementations only have to support local read for storage resources and single sampled color attachments.

Support for reading depth/stencil attachments and multi-sampled attachments are respectively gated behind the new boolean dynamicRenderingLocalReadDepthStencilAttachments and dynamicRenderingLocalReadMultisampledAttachments properties, as described in the Version 1.4 appendix.

The original type, enum, and command names are still available as aliases of the core functionality.

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

Deprecation State

• Promoted to Vulkan 1.4

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, VkRenderingAttachmentLocationInfo pLocationInfo)	See CmdSetRenderingAttachmentLocations.
static void	vkCmdSetRenderingInputAttachmentIndicesKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkRenderingInputAttachmentIndexInfo pInputAttachmentIndexInfo)	See CmdSetRenderingInputAttachmentIndices.

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,
 VkRenderingAttachmentLocationInfo pLocationInfo)

See CmdSetRenderingAttachmentLocations.

Parameters:

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

pLocationInfo - a VkRenderingAttachmentLocationInfo 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,
 VkRenderingInputAttachmentIndexInfo pInputAttachmentIndexInfo)

See CmdSetRenderingInputAttachmentIndices.

Parameters:

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

pInputAttachmentIndexInfo - a VkRenderingInputAttachmentIndexInfo structure indicating the new mappings.