vkGetPipelineExecutablePropertiesKHR - Get the executables associated with a pipeline

Parameters

• Device is the device that created the pipeline.

• pPipelineInfo describes the pipeline being queried.
• pExecutableCount is a pointer to an integer related to the number of pipeline executables available or queried, as described below.
• pProperties is either NULL or a pointer to an array of PipelineExecutablePropertiesKHR structures.

Description

If pProperties is NULL, then the number of 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 executables associated with the pipeline, at most pExecutableCount structures will be written and getPipelineExecutablePropertiesKHR will return INCOMPLETE.

Valid Usage

• pipelineExecutableInfo must be enabled.

• Pipeline member of pPipelineInfo must have been created with Device.

Valid Usage (Implicit)

• Device must be a valid Device handle

• pPipelineInfo must be a valid pointer to a valid PipelineInfoKHR 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 PipelineExecutablePropertiesKHR structures

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

Device, PipelineExecutablePropertiesKHR, PipelineInfoKHR

vkGetPipelineExecutableStatisticsKHR - Get compile time statistics associated with a pipeline executable

Parameters

• Device is the device that created the pipeline.

• pExecutableInfo describes the pipeline executable being queried.
• pStatisticCount is a pointer to an integer related to the number of statistics available or queried, as described below.
• pStatistics is either NULL or a pointer to an array of PipelineExecutableStatisticKHR structures.

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 getPipelineExecutableStatisticsKHR will return INCOMPLETE.

Valid Usage

• pipelineExecutableInfo must be enabled.

• Pipeline member of pExecutableInfo must have been created with Device.
• Pipeline member of pExecutableInfo must have been created with PIPELINE_CREATE_CAPTURE_STATISTICS_BIT_KHR set in the Flags field of GraphicsPipelineCreateInfo or ComputePipelineCreateInfo.

Valid Usage (Implicit)

• Device must be a valid Device handle

• pExecutableInfo must be a valid pointer to a valid PipelineExecutableInfoKHR 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 PipelineExecutableStatisticKHR structures

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

Device, PipelineExecutableInfoKHR, PipelineExecutableStatisticKHR

vkGetPipelineExecutableInternalRepresentationsKHR - Get internal representations of the pipeline executable

Parameters

• Device is the device that created the pipeline.

• pExecutableInfo describes the pipeline executable being queried.
• pInternalRepresentationCount is a pointer to an integer related to the number of internal representations available or queried, as described below.
• pInternalRepresentations is either NULL or a pointer to an array of PipelineExecutableInternalRepresentationKHR structures.

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 getPipelineExecutableInternalRepresentationsKHR will return INCOMPLETE.

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 compile pipeline with the final shader assembly (if any) last.

Valid Usage

• pipelineExecutableInfo must be enabled.

• Pipeline member of pExecutableInfo must have been created with Device.
• Pipeline member of pExecutableInfo must have been created with PIPELINE_CREATE_CAPTURE_INTERNAL_REPRESENTATIONS_BIT_KHR set in the Flags field of GraphicsPipelineCreateInfo or ComputePipelineCreateInfo.

Valid Usage (Implicit)

• Device must be a valid Device handle

• pExecutableInfo must be a valid pointer to a valid PipelineExecutableInfoKHR 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 PipelineExecutableInternalRepresentationKHR structures

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

Device, PipelineExecutableInfoKHR, PipelineExecutableInternalRepresentationKHR

VkPhysicalDevicePipelineExecutablePropertiesFeaturesKHR - Structure describing whether pipeline executable properties are available

Members

The members of the PhysicalDevicePipelineExecutablePropertiesFeaturesKHR structure describe the following features:

Description

If the PhysicalDevicePipelineExecutablePropertiesFeaturesKHR structure is included in the pNext chain of PhysicalDeviceFeatures2, it is filled with values indicating whether the feature is supported. PhysicalDevicePipelineExecutablePropertiesFeaturesKHR can also be included in the pNext chain of DeviceCreateInfo to enable features.

Valid Usage (Implicit)

See Also

Bool32, StructureType

VkPipelineInfoKHR - Structure describing a pipeline

Valid Usage (Implicit)

See Also

Pipeline, StructureType, getPipelineExecutablePropertiesKHR

VkPipelineExecutablePropertiesKHR - Structure describing a pipeline executable

Description

The stages field may be zero or it may contain one or more bits describing the stages principally used to compile this pipeline. Not all implementations have a 1:1 mapping between shader stages and pipeline executables and some implementations may reduce a given shader stage to fixed function hardware programming such that no executable is available. No guarantees are provided about the mapping between shader stages and pipeline executables and stages should be considered a best effort hint. Because the application cannot rely on the stages field to provide an exact description, name and description provide a human readable name and description which more accurately describes the given pipeline executable.

Valid Usage (Implicit)

See Also

ShaderStageFlags, StructureType, getPipelineExecutablePropertiesKHR

VkPipelineExecutableInfoKHR - Structure describing a pipeline executable to query for associated statistics or internal representations

Valid Usage (Implicit)

See Also

Pipeline, StructureType, getPipelineExecutableInternalRepresentationsKHR, getPipelineExecutableStatisticsKHR

VkPipelineExecutableStatisticKHR - Structure describing a compile-time pipeline executable statistic

Valid Usage (Implicit)

See Also

PipelineExecutableStatisticFormatKHR, PipelineExecutableStatisticValueKHR, StructureType, getPipelineExecutableStatisticsKHR

VkPipelineExecutableInternalRepresentationKHR - Structure describing the textual form of a pipeline executable internal representation

Description

If pData is NULL, then the size, in bytes, of the internal representation data is returned in dataSize. Otherwise, dataSize must be the size of the buffer, in bytes, pointed to by pData and on return dataSize is overwritten with the number of bytes of data actually written to pData including any trailing null character. If dataSize is less than the size, in bytes, of the internal representation data, at most dataSize bytes of data will be written to pData and getPipelineExecutableInternalRepresentationsKHR will return INCOMPLETE. If isText is TRUE and pData is not NULL and dataSize is not zero, the last byte written to pData will be a null character.

Valid Usage (Implicit)

See Also

Bool32, StructureType, getPipelineExecutableInternalRepresentationsKHR

VkPipelineExecutableStatisticFormatKHR - Enum describing a pipeline executable statistic

See Also

PipelineExecutableStatisticKHR