VkHdrMetadataEXT(3)

# VkHdrMetadataEXT(3) Manual Page

## Name

VkHdrMetadataEXT - structure to specify Hdr metadata

Loading... please wait.

## C Specification

    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;

## Members

- `sType` is the type of this structure.

- `pNext` is `NULL` or a pointer to an extension-specific structure.

- `displayPrimaryRed` is the mastering display’s red primary in chromaticity coordinates

- `displayPrimaryGreen` is the mastering display’s green primary in chromaticity coordinates

- `displayPrimaryBlue` is the mastering display’s blue primary in chromaticity coordinates

- `whitePoint` is the mastering display’s white-point in chromaticity coordinates

- `maxLuminance` is the maximum luminance of the mastering display in nits

- `minLuminance` is the minimum luminance of the mastering display in nits

- `maxContentLightLevel` is content’s maximum luminance in nits

- `maxFrameAverageLightLevel` is the maximum frame average light level in nits

## Description

Valid Usage (Implicit)

- `sType` must be `VK_STRUCTURE_TYPE_HDR_METADATA_EXT`

- `pNext` must be `NULL`

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

## See Also

VkStructureType, VkXYColorEXT, vkSetHdrMetadataEXT

## 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 (c) 2014-2020 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.