C Specification

// Provided by VK_EXT_hdr_metadata
typedef struct VkHdrMetadataEXT {
    VkStructureType    sType;
    const void*        pNext;
    VkXYColorEXT       displayPrimaryRed;
    VkXYColorEXT       displayPrimaryGreen;
    VkXYColorEXT       displayPrimaryBlue;
    VkXYColorEXT       whitePoint;
    float              maxLuminance;
    float              minLuminance;
    float              maxContentLightLevel;
    float              maxFrameAverageLightLevel;
} VkHdrMetadataEXT;


  • sType is the type of this structure.

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

  • displayPrimaryRed is the reference monitor’s red primary in chromaticity coordinates

  • displayPrimaryGreen is the reference monitor’s green primary in chromaticity coordinates

  • displayPrimaryBlue is the reference monitor’s blue primary in chromaticity coordinates

  • whitePoint is the reference monitor’s white-point in chromaticity coordinates

  • maxLuminance is the maximum luminance of the reference monitor in nits

  • minLuminance is the minimum luminance of the reference monitor in nits

  • maxContentLightLevel is content’s maximum luminance in nits

  • maxFrameAverageLightLevel is the maximum frame average light level in nits


Valid Usage (Implicit)
  • VUID-VkHdrMetadataEXT-sType-sType

  • VUID-VkHdrMetadataEXT-pNext-pNext
    pNext must be NULL


The validity and use of this data is outside the scope of Vulkan.

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

SPDX-License-Identifier: CC-BY-4.0