C Specification

The VkShaderInstrumentationMetricDescriptionARM structure is defined as:

// Provided by VK_ARM_shader_instrumentation
typedef struct VkShaderInstrumentationMetricDescriptionARM {
    VkStructureType    sType;
    void*              pNext;
    char               name[VK_MAX_DESCRIPTION_SIZE];
    char               description[VK_MAX_DESCRIPTION_SIZE];
} VkShaderInstrumentationMetricDescriptionARM;

Members

  • sType is a VkStructureType value identifying this structure.

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

  • name is an array of VK_MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which is a short human readable name for this shader instrumentation metric.

  • description is an array of VK_MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which is a human readable description for this shader instrumentation metric.

Description

Valid Usage (Implicit)

  • VUID-VkShaderInstrumentationMetricDescriptionARM-sType-sType
    sType must be VK_STRUCTURE_TYPE_SHADER_INSTRUMENTATION_METRIC_DESCRIPTION_ARM

  • VUID-VkShaderInstrumentationMetricDescriptionARM-pNext-pNext
    pNext must be NULL

  • VUID-VkShaderInstrumentationMetricDescriptionARM-name-parameter
    name must be a null-terminated UTF-8 string whose length is less than or equal to VK_MAX_DESCRIPTION_SIZE

  • VUID-VkShaderInstrumentationMetricDescriptionARM-description-parameter
    description must be a null-terminated UTF-8 string whose length is less than or equal to VK_MAX_DESCRIPTION_SIZE

See Also

VK_ARM_shader_instrumentation, VkStructureType, vkEnumeratePhysicalDeviceShaderInstrumentationMetricsARM

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

SPDX-License-Identifier: CC-BY-4.0