VkDebugUtilsLabelEXT(3)

# VkDebugUtilsLabelEXT(3) Manual Page

## Name

VkDebugUtilsLabelEXT - Specify parameters of a label region

Loading… please wait.

## C Specification

The `VkDebugUtilsLabelEXT` structure is defined as:

    // Provided by VK_EXT_debug_utils
    typedef struct VkDebugUtilsLabelEXT {
        VkStructureType    sType;
        const void*        pNext;
        const char*        pLabelName;
        float              color[4];
    } VkDebugUtilsLabelEXT;

## Members

- `sType` is the type of this structure.

- `pNext` is `NULL` or a pointer to a structure extending this structure.

- `pLabelName` is a pointer to a null-terminated UTF-8 string containing the name of the label.

- `color` is an optional RGBA color value that can be associated with the label. A particular implementation may choose to ignore this color value. The values contain RGBA values in order, in the range 0.0 to 1.0. If all elements in `color` are set to 0.0 then it is ignored.

## Description

Valid Usage (Implicit)

- VUID-VkDebugUtilsLabelEXT-sType-sType
  `sType` must be `VK_STRUCTURE_TYPE_DEBUG_UTILS_LABEL_EXT`

- VUID-VkDebugUtilsLabelEXT-pNext-pNext
  `pNext` must be `NULL`

- VUID-VkDebugUtilsLabelEXT-pLabelName-parameter
  `pLabelName` must be a null-terminated UTF-8 string

## See Also

VkDebugUtilsMessengerCallbackDataEXT, VkStructureType, vkCmdBeginDebugUtilsLabelEXT, vkCmdInsertDebugUtilsLabelEXT, vkQueueBeginDebugUtilsLabelEXT, vkQueueInsertDebugUtilsLabelEXT

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

SPDX-License-Identifier: CC-BY-4.0