Package org.lwjgl.vulkan

Class EXTShaderModuleIdentifier

java.lang.Object

org.lwjgl.vulkan.EXTShaderModuleIdentifier

public class EXTShaderModuleIdentifier
extends Object

Some applications generate SPIR-V code at runtime. When pipeline caches are primed, either explicitly through e.g. VkPipelineCache mechanisms, or implicitly through driver managed caches, having to re-generate SPIR-V modules is redundant. SPIR-V modules could be cached on disk by an application, but the extra disk size requirement might be prohibitive in some use cases.

This extension adds the ability for an application to query a small identifier associated with a VkShaderModule. On subsequent runs of the application, the same identifier can be provided in lieu of a VkShaderModule object. A pipeline creation call with such a module may succeed if a pipeline could be created without invoking compilation, and information inside the SPIR-V module is not required by the implementation.

PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT must be used if only the identifier is provided, and this use case is intended to work like a non-blocking, speculative compile. Applications can fallback as necessary.

The main motivation for identifying the module itself and not the entire pipeline is that pipeline identifiers change when a driver is updated, but module identifiers are expected to be stable for any particular driver implementation. This approach is helpful for shader pre-compilation systems which can prime pipeline caches ahead of time. When on-disk pipeline caches are updated, the same shader identifiers could lead to a pipeline cache hit.

Name String

VK_EXT_shader_module_identifier

Extension Type

Device extension

Registered Extension Number

463

Revision

1

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2 or Version 1.1 and VK_EXT_pipeline_creation_cache_control or Version 1.3

Contact

• Hans-Kristian Arntzen HansKristian-Work

Extension Proposal

VK_EXT_shader_module_identifier

Other Extension Metadata

Last Modified Date

2022-05-16

IP Status

No known IP claims.

Contributors

• Hans-Kristian Arntzen, Valve
• Ricardo Garcia, Igalia
• Piers Daniell, NVIDIA
• Jan-Harald Fredriksen, Arm
• Tom Olson, Arm
• Faith Ekstrand, Collabora

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VK_EXT_SHADER_MODULE_IDENTIFIER_EXTENSION_NAME	The extension name.
static final int	VK_EXT_SHADER_MODULE_IDENTIFIER_SPEC_VERSION	The extension specification version.
static final int	VK_MAX_SHADER_MODULE_IDENTIFIER_SIZE_EXT	VK_MAX_SHADER_MODULE_IDENTIFIER_SIZE_EXT
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_MODULE_IDENTIFIER_FEATURES_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_MODULE_IDENTIFIER_PROPERTIES_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_MODULE_IDENTIFIER_CREATE_INFO_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_SHADER_MODULE_IDENTIFIER_EXT	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static void	nvkGetShaderModuleCreateInfoIdentifierEXT(org.lwjgl.vulkan.VkDevice device, long pCreateInfo, long pIdentifier)	Unsafe version of: GetShaderModuleCreateInfoIdentifierEXT
static void	nvkGetShaderModuleIdentifierEXT(org.lwjgl.vulkan.VkDevice device, long shaderModule, long pIdentifier)	Unsafe version of: GetShaderModuleIdentifierEXT
static void	vkGetShaderModuleCreateInfoIdentifierEXT(org.lwjgl.vulkan.VkDevice device, VkShaderModuleCreateInfo pCreateInfo, VkShaderModuleIdentifierEXT pIdentifier)	Query a unique identifier for a shader module create info.
static void	vkGetShaderModuleIdentifierEXT(org.lwjgl.vulkan.VkDevice device, long shaderModule, VkShaderModuleIdentifierEXT pIdentifier)	Query a unique identifier for a shader module.

Methods inherited from class java.lang.Object

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

Field Details

VK_EXT_SHADER_MODULE_IDENTIFIER_SPEC_VERSION

public static final int VK_EXT_SHADER_MODULE_IDENTIFIER_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

VK_EXT_SHADER_MODULE_IDENTIFIER_EXTENSION_NAME

public static final String VK_EXT_SHADER_MODULE_IDENTIFIER_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_MODULE_IDENTIFIER_FEATURES_EXT

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_MODULE_IDENTIFIER_FEATURES_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_MODULE_IDENTIFIER_FEATURES_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_MODULE_IDENTIFIER_PROPERTIES_EXT
• STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_MODULE_IDENTIFIER_CREATE_INFO_EXT
• STRUCTURE_TYPE_SHADER_MODULE_IDENTIFIER_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_MODULE_IDENTIFIER_PROPERTIES_EXT

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_MODULE_IDENTIFIER_PROPERTIES_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_MODULE_IDENTIFIER_FEATURES_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_MODULE_IDENTIFIER_PROPERTIES_EXT
• STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_MODULE_IDENTIFIER_CREATE_INFO_EXT
• STRUCTURE_TYPE_SHADER_MODULE_IDENTIFIER_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_MODULE_IDENTIFIER_CREATE_INFO_EXT

public static final int VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_MODULE_IDENTIFIER_CREATE_INFO_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_MODULE_IDENTIFIER_FEATURES_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_MODULE_IDENTIFIER_PROPERTIES_EXT
• STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_MODULE_IDENTIFIER_CREATE_INFO_EXT
• STRUCTURE_TYPE_SHADER_MODULE_IDENTIFIER_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_SHADER_MODULE_IDENTIFIER_EXT

public static final int VK_STRUCTURE_TYPE_SHADER_MODULE_IDENTIFIER_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_MODULE_IDENTIFIER_FEATURES_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_MODULE_IDENTIFIER_PROPERTIES_EXT
• STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_MODULE_IDENTIFIER_CREATE_INFO_EXT
• STRUCTURE_TYPE_SHADER_MODULE_IDENTIFIER_EXT

See Also:

• Constant Field Values

VK_MAX_SHADER_MODULE_IDENTIFIER_SIZE_EXT

public static final int VK_MAX_SHADER_MODULE_IDENTIFIER_SIZE_EXT

VK_MAX_SHADER_MODULE_IDENTIFIER_SIZE_EXT

See Also:

• Constant Field Values

Method Details

nvkGetShaderModuleIdentifierEXT

public static void nvkGetShaderModuleIdentifierEXT(org.lwjgl.vulkan.VkDevice device,
 long shaderModule,
 long pIdentifier)

Unsafe version of: GetShaderModuleIdentifierEXT

vkGetShaderModuleIdentifierEXT

public static void vkGetShaderModuleIdentifierEXT(org.lwjgl.vulkan.VkDevice device,
 long shaderModule,
 VkShaderModuleIdentifierEXT pIdentifier)

Query a unique identifier for a shader module.

C Specification

Shader modules have unique identifiers associated with them. To query an implementation provided identifier, call:

 void vkGetShaderModuleIdentifierEXT(
     VkDevice                                    device,
     VkShaderModule                              shaderModule,
     VkShaderModuleIdentifierEXT*                pIdentifier);

Description

The identifier returned by the implementation must only depend on shaderIdentifierAlgorithmUUID and information provided in the VkShaderModuleCreateInfo which created shaderModule. The implementation may return equal identifiers for two different VkShaderModuleCreateInfo structures if the difference does not affect pipeline compilation. Identifiers are only meaningful on different VkDevice objects if the device the identifier was queried from had the same shaderModuleIdentifierAlgorithmUUID as the device consuming the identifier.

Valid Usage

• shaderModuleIdentifier feature must be enabled

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• shaderModule must be a valid VkShaderModule handle
• pIdentifier must be a valid pointer to a VkShaderModuleIdentifierEXT structure
• shaderModule must have been created, allocated, or retrieved from device

See Also

VkShaderModuleIdentifierEXT

Parameters:

device - the logical device that created the shader module.

shaderModule - the handle of the shader module.

pIdentifier - a pointer to the returned VkShaderModuleIdentifierEXT.

nvkGetShaderModuleCreateInfoIdentifierEXT

public static void nvkGetShaderModuleCreateInfoIdentifierEXT(org.lwjgl.vulkan.VkDevice device,
 long pCreateInfo,
 long pIdentifier)

Unsafe version of: GetShaderModuleCreateInfoIdentifierEXT

vkGetShaderModuleCreateInfoIdentifierEXT

public static void vkGetShaderModuleCreateInfoIdentifierEXT(org.lwjgl.vulkan.VkDevice device,
 VkShaderModuleCreateInfo pCreateInfo,
 VkShaderModuleIdentifierEXT pIdentifier)

Query a unique identifier for a shader module create info.

C Specification

VkShaderModuleCreateInfo structures have unique identifiers associated with them. To query an implementation provided identifier, call:

 void vkGetShaderModuleCreateInfoIdentifierEXT(
     VkDevice                                    device,
     const VkShaderModuleCreateInfo*             pCreateInfo,
     VkShaderModuleIdentifierEXT*                pIdentifier);

Description

The identifier returned by implementation must only depend on shaderIdentifierAlgorithmUUID and information provided in the VkShaderModuleCreateInfo. The implementation may return equal identifiers for two different VkShaderModuleCreateInfo structures if the difference does not affect pipeline compilation. Identifiers are only meaningful on different VkDevice objects if the device the identifier was queried from had the same shaderModuleIdentifierAlgorithmUUID as the device consuming the identifier.

The identifier returned by the implementation in GetShaderModuleCreateInfoIdentifierEXT must be equal to the identifier returned by GetShaderModuleIdentifierEXT given equivalent definitions of VkShaderModuleCreateInfo and any chained pNext structures.

Valid Usage

• shaderModuleIdentifier feature must be enabled

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pCreateInfo must be a valid pointer to a valid VkShaderModuleCreateInfo structure
• pIdentifier must be a valid pointer to a VkShaderModuleIdentifierEXT structure

See Also

VkShaderModuleCreateInfo, VkShaderModuleIdentifierEXT

Parameters:

device - the logical device that can create a VkShaderModule from pCreateInfo.

pCreateInfo - a pointer to a VkShaderModuleCreateInfo structure.

pIdentifier - a pointer to the returned VkShaderModuleIdentifierEXT.