public Class KHRPipelineExecutableProperties

The extension name.

The extension specification version.

Extends VkPipelineCreateFlagBits.

Enum values:

• PIPELINE_CREATE_CAPTURE_STATISTICS_BIT_KHR
• PIPELINE_CREATE_CAPTURE_INTERNAL_REPRESENTATIONS_BIT_KHR

Extends VkPipelineCreateFlagBits.

Enum values:

• PIPELINE_CREATE_CAPTURE_STATISTICS_BIT_KHR
• PIPELINE_CREATE_CAPTURE_INTERNAL_REPRESENTATIONS_BIT_KHR

VkPipelineExecutableStatisticFormatKHR - Enum describing a pipeline executable statistic

Description

• PIPELINE_EXECUTABLE_STATISTIC_FORMAT_BOOL32_KHR specifies that the statistic is returned as a 32-bit boolean value which must be either TRUE or FALSE and should be read from the b32 field of VkPipelineExecutableStatisticValueKHR.
• PIPELINE_EXECUTABLE_STATISTIC_FORMAT_INT64_KHR specifies that the statistic is returned as a signed 64-bit integer and should be read from the i64 field of VkPipelineExecutableStatisticValueKHR.
• PIPELINE_EXECUTABLE_STATISTIC_FORMAT_UINT64_KHR specifies that the statistic is returned as an unsigned 64-bit integer and should be read from the u64 field of VkPipelineExecutableStatisticValueKHR.
• PIPELINE_EXECUTABLE_STATISTIC_FORMAT_FLOAT64_KHR specifies that the statistic is returned as a 64-bit floating-point value and should be read from the f64 field of VkPipelineExecutableStatisticValueKHR.

See Also

VkPipelineExecutableStatisticKHR

VkPipelineExecutableStatisticFormatKHR - Enum describing a pipeline executable statistic

Description

• PIPELINE_EXECUTABLE_STATISTIC_FORMAT_BOOL32_KHR specifies that the statistic is returned as a 32-bit boolean value which must be either TRUE or FALSE and should be read from the b32 field of VkPipelineExecutableStatisticValueKHR.
• PIPELINE_EXECUTABLE_STATISTIC_FORMAT_INT64_KHR specifies that the statistic is returned as a signed 64-bit integer and should be read from the i64 field of VkPipelineExecutableStatisticValueKHR.
• PIPELINE_EXECUTABLE_STATISTIC_FORMAT_UINT64_KHR specifies that the statistic is returned as an unsigned 64-bit integer and should be read from the u64 field of VkPipelineExecutableStatisticValueKHR.
• PIPELINE_EXECUTABLE_STATISTIC_FORMAT_FLOAT64_KHR specifies that the statistic is returned as a 64-bit floating-point value and should be read from the f64 field of VkPipelineExecutableStatisticValueKHR.

See Also

VkPipelineExecutableStatisticKHR

VkPipelineExecutableStatisticFormatKHR - Enum describing a pipeline executable statistic

Description

• PIPELINE_EXECUTABLE_STATISTIC_FORMAT_BOOL32_KHR specifies that the statistic is returned as a 32-bit boolean value which must be either TRUE or FALSE and should be read from the b32 field of VkPipelineExecutableStatisticValueKHR.
• PIPELINE_EXECUTABLE_STATISTIC_FORMAT_INT64_KHR specifies that the statistic is returned as a signed 64-bit integer and should be read from the i64 field of VkPipelineExecutableStatisticValueKHR.
• PIPELINE_EXECUTABLE_STATISTIC_FORMAT_UINT64_KHR specifies that the statistic is returned as an unsigned 64-bit integer and should be read from the u64 field of VkPipelineExecutableStatisticValueKHR.
• PIPELINE_EXECUTABLE_STATISTIC_FORMAT_FLOAT64_KHR specifies that the statistic is returned as a 64-bit floating-point value and should be read from the f64 field of VkPipelineExecutableStatisticValueKHR.

See Also

VkPipelineExecutableStatisticKHR

VkPipelineExecutableStatisticFormatKHR - Enum describing a pipeline executable statistic

Description

• PIPELINE_EXECUTABLE_STATISTIC_FORMAT_BOOL32_KHR specifies that the statistic is returned as a 32-bit boolean value which must be either TRUE or FALSE and should be read from the b32 field of VkPipelineExecutableStatisticValueKHR.
• PIPELINE_EXECUTABLE_STATISTIC_FORMAT_INT64_KHR specifies that the statistic is returned as a signed 64-bit integer and should be read from the i64 field of VkPipelineExecutableStatisticValueKHR.
• PIPELINE_EXECUTABLE_STATISTIC_FORMAT_UINT64_KHR specifies that the statistic is returned as an unsigned 64-bit integer and should be read from the u64 field of VkPipelineExecutableStatisticValueKHR.
• PIPELINE_EXECUTABLE_STATISTIC_FORMAT_FLOAT64_KHR specifies that the statistic is returned as a 64-bit floating-point value and should be read from the f64 field of VkPipelineExecutableStatisticValueKHR.

See Also

VkPipelineExecutableStatisticKHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_EXECUTABLE_PROPERTIES_FEATURES_KHR
• STRUCTURE_TYPE_PIPELINE_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_PROPERTIES_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_STATISTIC_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_INTERNAL_REPRESENTATION_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_EXECUTABLE_PROPERTIES_FEATURES_KHR
• STRUCTURE_TYPE_PIPELINE_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_PROPERTIES_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_STATISTIC_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_INTERNAL_REPRESENTATION_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_EXECUTABLE_PROPERTIES_FEATURES_KHR
• STRUCTURE_TYPE_PIPELINE_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_PROPERTIES_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_STATISTIC_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_INTERNAL_REPRESENTATION_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_EXECUTABLE_PROPERTIES_FEATURES_KHR
• STRUCTURE_TYPE_PIPELINE_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_PROPERTIES_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_STATISTIC_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_INTERNAL_REPRESENTATION_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_EXECUTABLE_PROPERTIES_FEATURES_KHR
• STRUCTURE_TYPE_PIPELINE_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_PROPERTIES_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_STATISTIC_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_INTERNAL_REPRESENTATION_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_EXECUTABLE_PROPERTIES_FEATURES_KHR
• STRUCTURE_TYPE_PIPELINE_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_PROPERTIES_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_STATISTIC_KHR
• STRUCTURE_TYPE_PIPELINE_EXECUTABLE_INTERNAL_REPRESENTATION_KHR

Unsafe version of: GetPipelineExecutableInternalRepresentationsKHR

Parameters

pInternalRepresentationCount:long

a pointer to an integer related to the number of internal representations available or queried, as described below.

Unsafe version of: GetPipelineExecutablePropertiesKHR

Parameters

pExecutableCount:long

a pointer to an integer related to the number of pipeline executables available or queried, as described below.

Unsafe version of: GetPipelineExecutableStatisticsKHR

Parameters

pStatisticCount:long

a pointer to an integer related to the number of statistics available or queried, as described below.

Get internal representations of the pipeline executable.

C Specification

Each pipeline executable may have one or more text or binary internal representations associated with it which are generated as part of the compile process. These may include the final shader assembly, a binary form of the compiled shader, or the shader compiler’s internal representation at any number of intermediate compile steps. To query the internal representations associated with a pipeline executable, call:

VkResult vkGetPipelineExecutableInternalRepresentationsKHR(
    VkDevice                                    device,
    const VkPipelineExecutableInfoKHR*          pExecutableInfo,
    uint32_t*                                   pInternalRepresentationCount,
    VkPipelineExecutableInternalRepresentationKHR* pInternalRepresentations);

Description

If pInternalRepresentations is NULL, then the number of internal representations associated with the pipeline executable is returned in pInternalRepresentationCount. Otherwise, pInternalRepresentationCount must point to a variable set by the user to the number of elements in the pInternalRepresentations array, and on return the variable is overwritten with the number of structures actually written to pInternalRepresentations. If pInternalRepresentationCount is less than the number of internal representations associated with the pipeline executable, at most pInternalRepresentationCount structures will be written, and INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available representations were returned.

While the details of the internal representations remain implementation-dependent, the implementation should order the internal representations in the order in which they occur in the compiled pipeline with the final shader assembly (if any) last.

Valid Usage

• The pipelineExecutableInfo feature must be enabled
• The pipeline member of pExecutableInfo must have been created with device
• The pipeline member of pExecutableInfo must have been created with PIPELINE_CREATE_CAPTURE_INTERNAL_REPRESENTATIONS_BIT_KHR

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pExecutableInfo must be a valid pointer to a valid VkPipelineExecutableInfoKHR structure
• pInternalRepresentationCount must be a valid pointer to a uint32_t value
• If the value referenced by pInternalRepresentationCount is not 0, and pInternalRepresentations is not NULL, pInternalRepresentations must be a valid pointer to an array of pInternalRepresentationCount VkPipelineExecutableInternalRepresentationKHR structures

Return Codes

On success, this command returns

• SUCCESS
• INCOMPLETE

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkPipelineExecutableInfoKHR, VkPipelineExecutableInternalRepresentationKHR

Parameters

device:VkDevice

the device that created the pipeline.

pExecutableInfo:VkPipelineExecutableInfoKHR

describes the pipeline executable being queried.

pInternalRepresentationCount:IntBuffer

a pointer to an integer related to the number of internal representations available or queried, as described below.

pInternalRepresentations:VkPipelineExecutableInternalRepresentationKHR.Buffer

either NULL or a pointer to an array of VkPipelineExecutableInternalRepresentationKHR structures.

Annotations

@NativeType:VkResult

Array version of: GetPipelineExecutableInternalRepresentationsKHR

Annotations

@NativeType:VkResult

Get the executables associated with a pipeline.

C Specification

When a pipeline is created, its state and shaders are compiled into zero or more device-specific executables, which are used when executing commands against that pipeline. To query the properties of these pipeline executables, call:

VkResult vkGetPipelineExecutablePropertiesKHR(
    VkDevice                                    device,
    const VkPipelineInfoKHR*                    pPipelineInfo,
    uint32_t*                                   pExecutableCount,
    VkPipelineExecutablePropertiesKHR*          pProperties);

Description

If pProperties is NULL, then the number of pipeline executables associated with the pipeline is returned in pExecutableCount. Otherwise, pExecutableCount must point to a variable set by the user to the number of elements in the pProperties array, and on return the variable is overwritten with the number of structures actually written to pProperties. If pExecutableCount is less than the number of pipeline executables associated with the pipeline, at most pExecutableCount structures will be written, and INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available properties were returned.

Valid Usage

• The pipelineExecutableInfo feature must be enabled
• The pipeline member of pPipelineInfo must have been created with device

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pPipelineInfo must be a valid pointer to a valid VkPipelineInfoKHR structure
• pExecutableCount must be a valid pointer to a uint32_t value
• If the value referenced by pExecutableCount is not 0, and pProperties is not NULL, pProperties must be a valid pointer to an array of pExecutableCount VkPipelineExecutablePropertiesKHR structures

Return Codes

On success, this command returns

• SUCCESS
• INCOMPLETE

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkPipelineExecutablePropertiesKHR, VkPipelineInfoKHR

Parameters

device:VkDevice

the device that created the pipeline.

pPipelineInfo:VkPipelineInfoKHR

describes the pipeline being queried.

pExecutableCount:IntBuffer

a pointer to an integer related to the number of pipeline executables available or queried, as described below.

pProperties:VkPipelineExecutablePropertiesKHR.Buffer

either NULL or a pointer to an array of VkPipelineExecutablePropertiesKHR structures.

Annotations

@NativeType:VkResult

Array version of: GetPipelineExecutablePropertiesKHR

Annotations

@NativeType:VkResult

Get compile time statistics associated with a pipeline executable.

C Specification

Each pipeline executable may have a set of statistics associated with it that are generated by the pipeline compilation process. These statistics may include things such as instruction counts, amount of spilling (if any), maximum number of simultaneous threads, or anything else which may aid developers in evaluating the expected performance of a shader. To query the compile time statistics associated with a pipeline executable, call:

VkResult vkGetPipelineExecutableStatisticsKHR(
    VkDevice                                    device,
    const VkPipelineExecutableInfoKHR*          pExecutableInfo,
    uint32_t*                                   pStatisticCount,
    VkPipelineExecutableStatisticKHR*           pStatistics);

Description

If pStatistics is NULL, then the number of statistics associated with the pipeline executable is returned in pStatisticCount. Otherwise, pStatisticCount must point to a variable set by the user to the number of elements in the pStatistics array, and on return the variable is overwritten with the number of structures actually written to pStatistics. If pStatisticCount is less than the number of statistics associated with the pipeline executable, at most pStatisticCount structures will be written, and INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available statistics were returned.

Valid Usage

• The pipelineExecutableInfo feature must be enabled
• The pipeline member of pExecutableInfo must have been created with device
• The pipeline member of pExecutableInfo must have been created with PIPELINE_CREATE_CAPTURE_STATISTICS_BIT_KHR

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pExecutableInfo must be a valid pointer to a valid VkPipelineExecutableInfoKHR structure
• pStatisticCount must be a valid pointer to a uint32_t value
• If the value referenced by pStatisticCount is not 0, and pStatistics is not NULL, pStatistics must be a valid pointer to an array of pStatisticCount VkPipelineExecutableStatisticKHR structures

Return Codes

On success, this command returns

• SUCCESS
• INCOMPLETE

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkPipelineExecutableInfoKHR, VkPipelineExecutableStatisticKHR

Parameters

device:VkDevice

the device that created the pipeline.

pExecutableInfo:VkPipelineExecutableInfoKHR

describes the pipeline executable being queried.

pStatisticCount:IntBuffer

a pointer to an integer related to the number of statistics available or queried, as described below.

pStatistics:VkPipelineExecutableStatisticKHR.Buffer

either NULL or a pointer to an array of VkPipelineExecutableStatisticKHR structures.

Annotations

@NativeType:VkResult

Array version of: GetPipelineExecutableStatisticsKHR

Annotations

@NativeType:VkResult