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:
// Provided by VK_KHR_pipeline_executable_properties
VkResult vkGetPipelineExecutablePropertiesKHR(
VkDevice device,
const VkPipelineInfoKHR* pPipelineInfo,
uint32_t* pExecutableCount,
VkPipelineExecutablePropertiesKHR* pProperties);
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 eitherNULL
or a pointer to an array of VkPipelineExecutablePropertiesKHR structures.
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 VK_INCOMPLETE
will be returned instead of
VK_SUCCESS
, to indicate that not all the available properties were
returned.
Document Notes
For more information, see the Vulkan Specification
This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.