Vulkan.Extensions.VK_KHR_pipeline_executable_properties

vkGetPipelineExecutablePropertiesKHR - Get the executables associated with a pipeline

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 application 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 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

• INCOMPLETE

• SUCCESS

Failure

• ERROR_OUT_OF_DEVICE_MEMORY

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

See Also

VK_KHR_pipeline_executable_properties, Device, PipelineExecutablePropertiesKHR, PipelineInfoKHR

vkGetPipelineExecutableStatisticsKHR - Get compile time statistics associated with a pipeline executable

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 application 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 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

• INCOMPLETE

• SUCCESS

Failure

• ERROR_OUT_OF_DEVICE_MEMORY

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

See Also

VK_KHR_pipeline_executable_properties, Device, PipelineExecutableInfoKHR, PipelineExecutableStatisticKHR

vkGetPipelineExecutableInternalRepresentationsKHR - Get internal representations of the pipeline executable

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 application 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 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

• INCOMPLETE

• SUCCESS

Failure

• ERROR_OUT_OF_DEVICE_MEMORY

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

See Also

VK_KHR_pipeline_executable_properties, Device, PipelineExecutableInfoKHR, PipelineExecutableInternalRepresentationKHR

VkPhysicalDevicePipelineExecutablePropertiesFeaturesKHR - Structure describing whether pipeline executable properties are available

Members

This structure describes the following feature:

Description

If the PhysicalDevicePipelineExecutablePropertiesFeaturesKHR structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. If the application wishes to use a Device with any features described by PhysicalDevicePipelineExecutablePropertiesFeaturesKHR, it must add an instance of the structure, with the desired feature members set to TRUE, to the pNext chain of DeviceCreateInfo when creating the Device.

Structure Chaining

Extends the structures

• DeviceCreateInfo

• PhysicalDeviceFeatures2

See Also

VK_KHR_pipeline_executable_properties, Bool32, StructureType

VkPipelineInfoKHR - Structure describing a pipeline

Valid Usage (Implicit)

See Also

VK_EXT_pipeline_properties, VK_KHR_pipeline_executable_properties, Pipeline, StructureType, getPipelineExecutablePropertiesKHR, getPipelinePropertiesEXT

VkPipelineExecutablePropertiesKHR - Structure describing a pipeline executable

Description

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 pipeline 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

VK_KHR_pipeline_executable_properties, ShaderStageFlags, StructureType, getPipelineExecutablePropertiesKHR

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

Valid Usage (Implicit)

See Also

VK_KHR_pipeline_executable_properties, Pipeline, StructureType, getPipelineExecutableInternalRepresentationsKHR, getPipelineExecutableStatisticsKHR

VkPipelineExecutableStatisticKHR - Structure describing a compile time pipeline executable statistic

Valid Usage (Implicit)

See Also

VK_KHR_pipeline_executable_properties, 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’s data, at most dataSize bytes of data will be written to pData, and INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available representation was returned.

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

VK_KHR_pipeline_executable_properties, Bool32, StructureType, getPipelineExecutableInternalRepresentationsKHR

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 PipelineExecutableStatisticValueKHR.

• 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 PipelineExecutableStatisticValueKHR.

• 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 PipelineExecutableStatisticValueKHR.

• 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 PipelineExecutableStatisticValueKHR.

See Also

VK_KHR_pipeline_executable_properties, PipelineExecutableStatisticKHR