vkGetPipelinePropertiesEXT(3)

# vkGetPipelinePropertiesEXT(3) Manual Page

## Name

vkGetPipelinePropertiesEXT - Query pipeline properties

Loading… please wait.

## C Specification

To query the pipeline properties call:

    // Provided by VK_EXT_pipeline_properties
    VkResult vkGetPipelinePropertiesEXT(
        VkDevice                                    device,
        const VkPipelineInfoEXT*                    pPipelineInfo,
        VkBaseOutStructure*                         pPipelineProperties);

## Parameters

- `device` is the logical device that created the pipeline.

- `pPipelineInfo` is a pointer to a VkPipelineInfoEXT structure which describes the pipeline being queried.

- `pPipelineProperties` is a pointer to a VkBaseOutStructure structure in which the pipeline properties will be written.

## Description

To query a pipeline’s `pipelineIdentifier` pass a VkPipelinePropertiesIdentifierEXT structure in `pPipelineProperties`. Each pipeline is associated with a `pipelineIdentifier` and the identifier is implementation specific.

Valid Usage

- VUID-vkGetPipelinePropertiesEXT-pipeline-06738
  The `pipeline` member of `pPipelineInfo` must have been created with `device`

- VUID-vkGetPipelinePropertiesEXT-pPipelineProperties-06739
  `pPipelineProperties` must be a valid pointer to a VkPipelinePropertiesIdentifierEXT structure

- VUID-vkGetPipelinePropertiesEXT-None-06766
  The `pipelinePropertiesIdentifier` feature must be enabled

Valid Usage (Implicit)

- VUID-vkGetPipelinePropertiesEXT-device-parameter
  `device` must be a valid VkDevice handle

- VUID-vkGetPipelinePropertiesEXT-pPipelineInfo-parameter
  `pPipelineInfo` must be a valid pointer to a valid VkPipelineInfoEXT structure

Return Codes

On success, this command returns

  - `VK_SUCCESS`

On failure, this command returns

  - `VK_ERROR_OUT_OF_HOST_MEMORY`

## See Also

VK_EXT_pipeline_properties, VkBaseOutStructure, VkDevice, VkPipelineInfoEXT

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

## Copyright

Copyright 2014-2023 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0