Package org.lwjgl.vulkan

Class KHRMaintenance6

java.lang.Object

org.lwjgl.vulkan.KHRMaintenance6

public class KHRMaintenance6
extends Object

VK_KHR_maintenance6 adds a collection of minor features, none of which would warrant an entire extension of their own.

The new features are as follows:

• VkBindMemoryStatusKHR may be included in the pNext chain of VkBindBufferMemoryInfo and VkBindImageMemoryInfo, allowing applications to identify individual resources for which memory binding failed during calls to BindBufferMemory2 and BindImageMemory2.
• A new property fragmentShadingRateClampCombinerInputs to indicate if an implementation clamps the inputs to fragment shading rate combiner operations.
• NULL_HANDLE is allowed to be used when binding an index buffer, instead of a valid VkBuffer handle. When the nullDescriptor feature is enabled, every index fetched results in a value of zero.
• A new property maxCombinedImageSamplerDescriptorCount to indicate the maximum number of descriptors needed for any of the formats that require a sampler Y′C_BC_R conversion supported by the implementation.
• A new property blockTexelViewCompatibleMultipleLayers indicating whether IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT is allowed to be used with layerCount > 1
• pNext extensible *2 versions of all descriptor binding commands.

Promotion to Vulkan 1.4

Functionality in this extension is included in core Vulkan 1.4 with the KHR suffix omitted. The original type, enum and command names are still available as aliases of the core functionality.

Name String

VK_KHR_maintenance6

Extension Type

Device extension

Registered Extension Number

546

Revision

1

Extension and Version Dependencies

Version 1.1

API Interactions

• Interacts with VK_EXT_descriptor_buffer
• Interacts with VK_KHR_push_descriptor

Deprecation State

• Promoted to Vulkan 1.4

Contact

• Jon Leech oddhack

Extension Proposal

VK_KHR_maintenance6

Other Extension Metadata

Last Modified Date

2023-08-03

Interactions and External Dependencies

• Interacts with VK_EXT_robustness2

Contributors

• Jon Leech, Khronos
• Stu Smith, AMD
• Mike Blumenkrantz, Valve
• Ralph Potter, Samsung
• James Fitzpatrick, Imagination Technologies
• Piers Daniell, NVIDIA
• Daniel Story, Nintendo

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VK_KHR_MAINTENANCE_6_EXTENSION_NAME	The extension name.
static final int	VK_KHR_MAINTENANCE_6_SPEC_VERSION	The extension specification version.
static final int	VK_STRUCTURE_TYPE_BIND_DESCRIPTOR_BUFFER_EMBEDDED_SAMPLERS_INFO_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_BIND_DESCRIPTOR_SETS_INFO_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_BIND_MEMORY_STATUS_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_MAINTENANCE_6_FEATURES_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_MAINTENANCE_6_PROPERTIES_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PUSH_CONSTANTS_INFO_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PUSH_DESCRIPTOR_SET_INFO_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PUSH_DESCRIPTOR_SET_WITH_TEMPLATE_INFO_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_SET_DESCRIPTOR_BUFFER_OFFSETS_INFO_EXT	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static void	nvkCmdBindDescriptorBufferEmbeddedSamplers2EXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long pBindDescriptorBufferEmbeddedSamplersInfo)	Unsafe version of: CmdBindDescriptorBufferEmbeddedSamplers2EXT
static void	nvkCmdBindDescriptorSets2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long pBindDescriptorSetsInfo)	Unsafe version of: CmdBindDescriptorSets2KHR
static void	nvkCmdPushConstants2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long pPushConstantsInfo)	Unsafe version of: CmdPushConstants2KHR
static void	nvkCmdPushDescriptorSet2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long pPushDescriptorSetInfo)	Unsafe version of: CmdPushDescriptorSet2KHR
static void	nvkCmdPushDescriptorSetWithTemplate2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long pPushDescriptorSetWithTemplateInfo)	Unsafe version of: CmdPushDescriptorSetWithTemplate2KHR
static void	nvkCmdSetDescriptorBufferOffsets2EXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long pSetDescriptorBufferOffsetsInfo)	Unsafe version of: CmdSetDescriptorBufferOffsets2EXT
static void	vkCmdBindDescriptorBufferEmbeddedSamplers2EXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkBindDescriptorBufferEmbeddedSamplersInfoEXT pBindDescriptorBufferEmbeddedSamplersInfo)	Setting embedded immutable samplers offsets in a command buffer.
static void	vkCmdBindDescriptorSets2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkBindDescriptorSetsInfo pBindDescriptorSetsInfo)	See CmdBindDescriptorSets2.
static void	vkCmdPushConstants2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkPushConstantsInfo pPushConstantsInfo)	See CmdPushConstants2.
static void	vkCmdPushDescriptorSet2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkPushDescriptorSetInfo pPushDescriptorSetInfo)	See CmdPushDescriptorSet2.
static void	vkCmdPushDescriptorSetWithTemplate2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkPushDescriptorSetWithTemplateInfo pPushDescriptorSetWithTemplateInfo)	See CmdPushDescriptorSetWithTemplate2.
static void	vkCmdSetDescriptorBufferOffsets2EXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkSetDescriptorBufferOffsetsInfoEXT pSetDescriptorBufferOffsetsInfo)	Setting descriptor buffer offsets in a command buffer.

Methods inherited from class java.lang.Object

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

Field Details

VK_KHR_MAINTENANCE_6_SPEC_VERSION

public static final int VK_KHR_MAINTENANCE_6_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

VK_KHR_MAINTENANCE_6_EXTENSION_NAME

public static final String VK_KHR_MAINTENANCE_6_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_MAINTENANCE_6_FEATURES_KHR

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_MAINTENANCE_6_FEATURES_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_MAINTENANCE_6_FEATURES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_MAINTENANCE_6_PROPERTIES_KHR
• STRUCTURE_TYPE_BIND_MEMORY_STATUS_KHR
• STRUCTURE_TYPE_BIND_DESCRIPTOR_SETS_INFO_KHR
• STRUCTURE_TYPE_PUSH_CONSTANTS_INFO_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_MAINTENANCE_6_PROPERTIES_KHR

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_MAINTENANCE_6_PROPERTIES_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_MAINTENANCE_6_FEATURES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_MAINTENANCE_6_PROPERTIES_KHR
• STRUCTURE_TYPE_BIND_MEMORY_STATUS_KHR
• STRUCTURE_TYPE_BIND_DESCRIPTOR_SETS_INFO_KHR
• STRUCTURE_TYPE_PUSH_CONSTANTS_INFO_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_BIND_MEMORY_STATUS_KHR

public static final int VK_STRUCTURE_TYPE_BIND_MEMORY_STATUS_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_MAINTENANCE_6_FEATURES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_MAINTENANCE_6_PROPERTIES_KHR
• STRUCTURE_TYPE_BIND_MEMORY_STATUS_KHR
• STRUCTURE_TYPE_BIND_DESCRIPTOR_SETS_INFO_KHR
• STRUCTURE_TYPE_PUSH_CONSTANTS_INFO_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_BIND_DESCRIPTOR_SETS_INFO_KHR

public static final int VK_STRUCTURE_TYPE_BIND_DESCRIPTOR_SETS_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_MAINTENANCE_6_FEATURES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_MAINTENANCE_6_PROPERTIES_KHR
• STRUCTURE_TYPE_BIND_MEMORY_STATUS_KHR
• STRUCTURE_TYPE_BIND_DESCRIPTOR_SETS_INFO_KHR
• STRUCTURE_TYPE_PUSH_CONSTANTS_INFO_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PUSH_CONSTANTS_INFO_KHR

public static final int VK_STRUCTURE_TYPE_PUSH_CONSTANTS_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_MAINTENANCE_6_FEATURES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_MAINTENANCE_6_PROPERTIES_KHR
• STRUCTURE_TYPE_BIND_MEMORY_STATUS_KHR
• STRUCTURE_TYPE_BIND_DESCRIPTOR_SETS_INFO_KHR
• STRUCTURE_TYPE_PUSH_CONSTANTS_INFO_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PUSH_DESCRIPTOR_SET_INFO_KHR

public static final int VK_STRUCTURE_TYPE_PUSH_DESCRIPTOR_SET_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PUSH_DESCRIPTOR_SET_INFO_KHR
• STRUCTURE_TYPE_PUSH_DESCRIPTOR_SET_WITH_TEMPLATE_INFO_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PUSH_DESCRIPTOR_SET_WITH_TEMPLATE_INFO_KHR

public static final int VK_STRUCTURE_TYPE_PUSH_DESCRIPTOR_SET_WITH_TEMPLATE_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PUSH_DESCRIPTOR_SET_INFO_KHR
• STRUCTURE_TYPE_PUSH_DESCRIPTOR_SET_WITH_TEMPLATE_INFO_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_SET_DESCRIPTOR_BUFFER_OFFSETS_INFO_EXT

public static final int VK_STRUCTURE_TYPE_SET_DESCRIPTOR_BUFFER_OFFSETS_INFO_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_SET_DESCRIPTOR_BUFFER_OFFSETS_INFO_EXT
• STRUCTURE_TYPE_BIND_DESCRIPTOR_BUFFER_EMBEDDED_SAMPLERS_INFO_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_BIND_DESCRIPTOR_BUFFER_EMBEDDED_SAMPLERS_INFO_EXT

public static final int VK_STRUCTURE_TYPE_BIND_DESCRIPTOR_BUFFER_EMBEDDED_SAMPLERS_INFO_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_SET_DESCRIPTOR_BUFFER_OFFSETS_INFO_EXT
• STRUCTURE_TYPE_BIND_DESCRIPTOR_BUFFER_EMBEDDED_SAMPLERS_INFO_EXT

See Also:

• Constant Field Values

Method Details

nvkCmdBindDescriptorSets2KHR

public static void nvkCmdBindDescriptorSets2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 long pBindDescriptorSetsInfo)

Unsafe version of: CmdBindDescriptorSets2KHR

vkCmdBindDescriptorSets2KHR

public static void vkCmdBindDescriptorSets2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 VkBindDescriptorSetsInfo pBindDescriptorSetsInfo)

See CmdBindDescriptorSets2.

Parameters:

commandBuffer - the command buffer that the descriptor sets will be bound to.

pBindDescriptorSetsInfo - a pointer to a VkBindDescriptorSetsInfo structure.

nvkCmdPushConstants2KHR

public static void nvkCmdPushConstants2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 long pPushConstantsInfo)

Unsafe version of: CmdPushConstants2KHR

vkCmdPushConstants2KHR

public static void vkCmdPushConstants2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 VkPushConstantsInfo pPushConstantsInfo)

See CmdPushConstants2.

Parameters:

commandBuffer - the command buffer in which the push constant update will be recorded.

pPushConstantsInfo - a pointer to a VkPushConstantsInfo structure.

nvkCmdPushDescriptorSet2KHR

public static void nvkCmdPushDescriptorSet2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 long pPushDescriptorSetInfo)

Unsafe version of: CmdPushDescriptorSet2KHR

vkCmdPushDescriptorSet2KHR

public static void vkCmdPushDescriptorSet2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 VkPushDescriptorSetInfo pPushDescriptorSetInfo)

See CmdPushDescriptorSet2.

Parameters:

commandBuffer - the command buffer that the descriptors will be recorded in.

pPushDescriptorSetInfo - a pointer to a VkPushDescriptorSetInfo structure.

nvkCmdPushDescriptorSetWithTemplate2KHR

public static void nvkCmdPushDescriptorSetWithTemplate2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 long pPushDescriptorSetWithTemplateInfo)

Unsafe version of: CmdPushDescriptorSetWithTemplate2KHR

vkCmdPushDescriptorSetWithTemplate2KHR

public static void vkCmdPushDescriptorSetWithTemplate2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 VkPushDescriptorSetWithTemplateInfo pPushDescriptorSetWithTemplateInfo)

See CmdPushDescriptorSetWithTemplate2.

Parameters:

commandBuffer - the command buffer that the descriptors will be recorded in.

pPushDescriptorSetWithTemplateInfo - a pointer to a VkPushDescriptorSetWithTemplateInfo structure.

nvkCmdSetDescriptorBufferOffsets2EXT

public static void nvkCmdSetDescriptorBufferOffsets2EXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 long pSetDescriptorBufferOffsetsInfo)

Unsafe version of: CmdSetDescriptorBufferOffsets2EXT

vkCmdSetDescriptorBufferOffsets2EXT

public static void vkCmdSetDescriptorBufferOffsets2EXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 VkSetDescriptorBufferOffsetsInfoEXT pSetDescriptorBufferOffsetsInfo)

Setting descriptor buffer offsets in a command buffer.

C Specification

Alternatively, to set descriptor buffer offsets in a command buffer, call:

 void vkCmdSetDescriptorBufferOffsets2EXT(
     VkCommandBuffer                             commandBuffer,
     const VkSetDescriptorBufferOffsetsInfoEXT*  pSetDescriptorBufferOffsetsInfo);

Valid Usage

• The descriptorBuffer feature must be enabled
• Each bit in pSetDescriptorBufferOffsetsInfo→stageFlags must be a stage supported by the commandBuffer’s parent VkCommandPool’s queue family

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle
• pSetDescriptorBufferOffsetsInfo must be a valid pointer to a valid VkSetDescriptorBufferOffsetsInfoEXT structure
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support graphics, or compute operations
• 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	Both	Outside	Graphics Compute	State

See Also

VkSetDescriptorBufferOffsetsInfoEXT

Parameters:

commandBuffer - the command buffer in which the descriptor buffer offsets will be set.

pSetDescriptorBufferOffsetsInfo - a pointer to a VkSetDescriptorBufferOffsetsInfoEXT structure.

nvkCmdBindDescriptorBufferEmbeddedSamplers2EXT

public static void nvkCmdBindDescriptorBufferEmbeddedSamplers2EXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 long pBindDescriptorBufferEmbeddedSamplersInfo)

Unsafe version of: CmdBindDescriptorBufferEmbeddedSamplers2EXT

vkCmdBindDescriptorBufferEmbeddedSamplers2EXT

public static void vkCmdBindDescriptorBufferEmbeddedSamplers2EXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 VkBindDescriptorBufferEmbeddedSamplersInfoEXT pBindDescriptorBufferEmbeddedSamplersInfo)

Setting embedded immutable samplers offsets in a command buffer.

C Specification

Alternatively, to bind an embedded immutable sampler set to a command buffer, call:

 void vkCmdBindDescriptorBufferEmbeddedSamplers2EXT(
     VkCommandBuffer                             commandBuffer,
     const VkBindDescriptorBufferEmbeddedSamplersInfoEXT* pBindDescriptorBufferEmbeddedSamplersInfo);

Valid Usage

• The descriptorBuffer feature must be enabled
• Each bit in pBindDescriptorBufferEmbeddedSamplersInfo→stageFlags must be a stage supported by the commandBuffer’s parent VkCommandPool’s queue family

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle
• pBindDescriptorBufferEmbeddedSamplersInfo must be a valid pointer to a valid VkBindDescriptorBufferEmbeddedSamplersInfoEXT structure
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support graphics, or compute operations
• 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	Both	Outside	Graphics Compute	State

See Also

VkBindDescriptorBufferEmbeddedSamplersInfoEXT

Parameters:

commandBuffer - the command buffer that the embedded immutable samplers will be bound to.

pBindDescriptorBufferEmbeddedSamplersInfo - a pointer to a VkBindDescriptorBufferEmbeddedSamplersInfoEXT structure.