VkDataGraphPipelinePropertyQueryResultARM(3)

Name

VkDataGraphPipelinePropertyQueryResultARM - Structure describing a data graph pipeline property query or result

C Specification

The VkDataGraphPipelinePropertyQueryResultARM structure is defined as:

// Provided by VK_ARM_data_graph
typedef struct VkDataGraphPipelinePropertyQueryResultARM {
    VkStructureType                   sType;
    const void*                       pNext;
    VkDataGraphPipelinePropertyARM    property;
    VkBool32                          isText;
    size_t                            dataSize;
    void*                             pData;
} VkDataGraphPipelinePropertyQueryResultARM;

Members

  • sType is a VkStructureType value identifying this structure.

  • pNext is NULL or a pointer to a structure extending this structure.

  • property is a VkDataGraphPipelinePropertyARM specifying the property of the data graph pipeline being queried.

  • isText specifies whether the returned data is text or opaque data. If isText is VK_TRUE then the data returned in pData is text and guaranteed to be a null-terminated UTF-8 string.

  • dataSize is an integer related to the size, in bytes, of the data, as described below.

  • pData is either NULL or a pointer to a block of memory into which the implementation will return the property data.

Description

If pData is NULL, then the size, in bytes, of the property 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 NUL character. If dataSize is less than the size, in bytes, of the property data, at most dataSize bytes of data will be written to pData, and VK_INCOMPLETE will be returned by vkGetDataGraphPipelinePropertiesARM instead of VK_SUCCESS, to indicate that not all the available property data was returned. If isText is VK_TRUE and pData is not NULL and dataSize is not zero, the last byte written to pData will be a NUL character.

Valid Usage
Valid Usage (Implicit)

  • VUID-VkDataGraphPipelinePropertyQueryResultARM-sType-sType
    sType must be VK_STRUCTURE_TYPE_DATA_GRAPH_PIPELINE_PROPERTY_QUERY_RESULT_ARM

  • VUID-VkDataGraphPipelinePropertyQueryResultARM-pNext-pNext
    pNext must be NULL

  • VUID-VkDataGraphPipelinePropertyQueryResultARM-property-parameter
    property must be a valid VkDataGraphPipelinePropertyARM value

  • VUID-VkDataGraphPipelinePropertyQueryResultARM-pData-parameter
    If dataSize is not 0, and pData is not NULL, pData must be a valid pointer to an array of dataSize bytes

See Also

VK_ARM_data_graph, VkBool32, VkDataGraphPipelinePropertyARM, VkStructureType, vkGetDataGraphPipelinePropertiesARM

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.