Function Prototype

vkGetPipelineExecutableInternalRepresentationsKHR

Get internal representations of the pipeline executable

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);
  • 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 VkPipelineExecutableInternalRepresentationKHR structures.

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 VK_INCOMPLETE will be returned instead of VK_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

VUID-vkGetPipelineExecutableInternalRepresentationsKHR-pipeline-03277

The pipeline member of pExecutableInfo must have been created with device

VUID-vkGetPipelineExecutableInternalRepresentationsKHR-pipeline-03278

The pipeline member of pExecutableInfo must have been created with VK_PIPELINE_CREATE_CAPTURE_INTERNAL_REPRESENTATIONS_BIT_KHR

Valid Usage (Implicit)

VUID-vkGetPipelineExecutableInternalRepresentationsKHR-pInternalRepresentationCount-parameter

pInternalRepresentationCount must be a valid pointer to a uint32_t value

VUID-vkGetPipelineExecutableInternalRepresentationsKHR-pInternalRepresentations-parameter

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