C Specification

To query the properties of a data graph pipeline that can be obtained, call:

// Provided by VK_ARM_data_graph
VkResult vkGetDataGraphPipelineAvailablePropertiesARM(
    VkDevice                                    device,
    const VkDataGraphPipelineInfoARM*           pPipelineInfo,
    uint32_t*                                   pPropertiesCount,
    VkDataGraphPipelinePropertyARM*             pProperties);

Parameters

  • device is the logical device that created the data graph pipeline.

  • pPipelineInfo is a VkDataGraphPipelineInfoARM that describes the VkPipeline being queried.

  • pPropertiesCount is a pointer to an integer related to the number of properties available or queried, as described below.

  • pProperties is either NULL or a pointer to an array of VkDataGraphPipelinePropertyARM enums.

Description

If pProperties is NULL, then the number of properties associated with the data graph pipeline is returned in pPropertiesCount. Otherwise, pPropertiesCount 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 enums actually written to pProperties. If pPropertiesCount is less than the number of properties associated with the data graph pipeline, at most pPropertiesCount structures will be written, and VK_INCOMPLETE will be returned instead of VK_SUCCESS, to indicate that not all the available properties were returned.

Valid Usage
  • VUID-vkGetDataGraphPipelineAvailablePropertiesARM-dataGraphPipeline-09887
    The dataGraphPipeline member of pPipelineInfo must have been returned by a call to vkCreateDataGraphPipelinesARM

  • VUID-vkGetDataGraphPipelineAvailablePropertiesARM-dataGraphPipeline-09888
    The dataGraphPipeline member of pPipelineInfo must have been created with device

Valid Usage (Implicit)
  • VUID-vkGetDataGraphPipelineAvailablePropertiesARM-device-parameter
    device must be a valid VkDevice handle

  • VUID-vkGetDataGraphPipelineAvailablePropertiesARM-pPipelineInfo-parameter
    pPipelineInfo must be a valid pointer to a valid VkDataGraphPipelineInfoARM structure

  • VUID-vkGetDataGraphPipelineAvailablePropertiesARM-pPropertiesCount-parameter
    pPropertiesCount must be a valid pointer to a uint32_t value

  • VUID-vkGetDataGraphPipelineAvailablePropertiesARM-pProperties-parameter
    If the value referenced by pPropertiesCount is not 0, and pProperties is not NULL, pProperties must be a valid pointer to an array of pPropertiesCount VkDataGraphPipelinePropertyARM values

Return Codes
On success, this command returns
  • VK_SUCCESS

  • VK_INCOMPLETE

On failure, this command returns
  • VK_ERROR_OUT_OF_HOST_MEMORY

  • VK_ERROR_OUT_OF_DEVICE_MEMORY

See Also

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 2014-2025 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0