Package org.lwjgl.vulkan

Class EXTPipelineProperties

java.lang.Object

org.lwjgl.vulkan.EXTPipelineProperties

public class EXTPipelineProperties
extends Object

Vulkan SC requires offline compilation of pipelines. In order to support this, the pipeline state is represented in a JSON schema that is read by an offline tool for compilation.

One method of developing a Vulkan SC application is to author a Vulkan application and use a layer to record and serialize the pipeline state and shaders for offline compilation. Each pipeline is represented by a separate JSON file, and can be identified with a pipelineIdentifier.

Once the pipelines have been compiled by the offline pipeline cache compiler, the Vulkan SC application can then use this pipelineIdentifier for identifying the pipeline via Vulkan SC’s VkPipelineIdentifierInfo structure.

This extension allows the Vulkan application to query the pipelineIdentifier associated with each pipeline so that the application can store this with its pipeline metadata and the Vulkan SC application will then use to map the same state to an entry in the Vulkan SC pipeline cache.

It is expected that this extension will initially be implemented in the json generation layer, although we can envision that there might be future uses for it in native Vulkan drivers as well.

Name String

VK_EXT_pipeline_properties

Extension Type

Device extension

Registered Extension Number

373

Revision

1

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2 or Version 1.1

Contact

• Mukund Keshava mkeshavanv

Other Extension Metadata

Last Modified Date

2022-04-19

IP Status

No known IP claims.

Contributors

• Mukund Keshava, NVIDIA
• Daniel Koch, NVIDIA
• Mark Bellamy, Arm

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VK_EXT_PIPELINE_PROPERTIES_EXTENSION_NAME	The extension name.
static final int	VK_EXT_PIPELINE_PROPERTIES_SPEC_VERSION	The extension specification version.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_PROPERTIES_FEATURES_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PIPELINE_INFO_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PIPELINE_PROPERTIES_IDENTIFIER_EXT	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nvkGetPipelinePropertiesEXT(org.lwjgl.vulkan.VkDevice device, long pPipelineInfo, long pPipelineProperties)	Unsafe version of: GetPipelinePropertiesEXT
static int	vkGetPipelinePropertiesEXT(org.lwjgl.vulkan.VkDevice device, VkPipelineInfoEXT pPipelineInfo, @Nullable VkBaseOutStructure pPipelineProperties)	Query pipeline properties.

Methods inherited from class java.lang.Object

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

Field Details

VK_EXT_PIPELINE_PROPERTIES_SPEC_VERSION

public static final int VK_EXT_PIPELINE_PROPERTIES_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

VK_EXT_PIPELINE_PROPERTIES_EXTENSION_NAME

public static final String VK_EXT_PIPELINE_PROPERTIES_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PIPELINE_PROPERTIES_IDENTIFIER_EXT

public static final int VK_STRUCTURE_TYPE_PIPELINE_PROPERTIES_IDENTIFIER_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PIPELINE_PROPERTIES_IDENTIFIER_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_PROPERTIES_FEATURES_EXT
• STRUCTURE_TYPE_PIPELINE_INFO_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_PROPERTIES_FEATURES_EXT

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_PROPERTIES_FEATURES_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PIPELINE_PROPERTIES_IDENTIFIER_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_PROPERTIES_FEATURES_EXT
• STRUCTURE_TYPE_PIPELINE_INFO_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PIPELINE_INFO_EXT

public static final int VK_STRUCTURE_TYPE_PIPELINE_INFO_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PIPELINE_PROPERTIES_IDENTIFIER_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_PROPERTIES_FEATURES_EXT
• STRUCTURE_TYPE_PIPELINE_INFO_EXT

See Also:

• Constant Field Values

Method Details

nvkGetPipelinePropertiesEXT

public static int nvkGetPipelinePropertiesEXT(org.lwjgl.vulkan.VkDevice device,
 long pPipelineInfo,
 long pPipelineProperties)

Unsafe version of: GetPipelinePropertiesEXT

vkGetPipelinePropertiesEXT

public static int vkGetPipelinePropertiesEXT(org.lwjgl.vulkan.VkDevice device,
 VkPipelineInfoEXT pPipelineInfo,
 @Nullable VkBaseOutStructure pPipelineProperties)

Query pipeline properties.

C Specification

To query the pipeline properties call:

 VkResult vkGetPipelinePropertiesEXT(
     VkDevice                                    device,
     const VkPipelineInfoEXT*                    pPipelineInfo,
     VkBaseOutStructure*                         pPipelineProperties);

Description

To query a pipeline’s pipelineIdentifier pass a VkPipelinePropertiesIdentifierEXT structure in pPipelineProperties. Each pipeline is associated with a pipelineIdentifier and the identifier is implementation specific.

Valid Usage

• The pipeline member of pPipelineInfo must have been created with device
• pPipelineProperties must be a valid pointer to a VkPipelinePropertiesIdentifierEXT structure
• The pipelinePropertiesIdentifier feature must be enabled

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pPipelineInfo must be a valid pointer to a valid VkPipelineInfoEXT structure

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY

See Also

VkBaseOutStructure, VkPipelineInfoEXT

Parameters:

device - the logical device that created the pipeline.

pPipelineInfo - a pointer to a VkPipelineInfoEXT structure which describes the pipeline being queried.

pPipelineProperties - a pointer to a VkBaseOutStructure structure in which the pipeline properties will be written.