Structures
VkHdrMetadataEXT
Specify HDR metadata
The VkHdrMetadataEXT structure is defined as:
typedef struct VkHdrMetadataEXT {
// Display primary in chromaticity coordinates;
VkStructureType sType;
const void* pNext;
// From SMPTE 2086;
VkXYColorEXT displayPrimaryRed;
VkXYColorEXT displayPrimaryGreen;
VkXYColorEXT displayPrimaryBlue;
VkXYColorEXT whitePoint;
float maxLuminance;
float minLuminance;
// From CTA 861.3;
float maxContentLightLevel;
float maxFrameAverageLightLevel;
} VkHdrMetadataEXT;
pub struct HdrMetadataEXT {
/// Display primary in chromaticity coordinates
s_type: vk::StructureType,
p_next: *const c_void,
/// From SMPTE 2086
display_primary_red: vk::XYColorEXT, // Display primary's Red
display_primary_green: vk::XYColorEXT, // Display primary's Green
display_primary_blue: vk::XYColorEXT, // Display primary's Blue
white_point: vk::XYColorEXT, // Display primary's Blue
max_luminance: f32, // Display maximum luminance
min_luminance: f32, // Display minimum luminance
/// From CTA 861.3
max_content_light_level: f32, // Content maximum luminance
max_frame_average_light_level: f32,
}
sTypeis a VkStructureType value identifying this structure.pNextisNULLor a pointer to a structure extending this structure.displayPrimaryRedis a VkXYColorEXT structure specifying the red primary of the display used to optimize the contentdisplayPrimaryGreenis a VkXYColorEXT structure specifying the green primary of the display used to optimize the contentdisplayPrimaryBlueis a VkXYColorEXT structure specifying the blue primary of the display used to optimize the contentwhitePointis a VkXYColorEXT structure specifying the white-point of the display used to optimize the contentmaxLuminanceis the maximum luminance of the display used to optimize the content in nitsminLuminanceis the minimum luminance of the display used to optimize the content in nitsmaxContentLightLevelis the value in nits of the desired luminance for the brightest pixels in the displayed image.maxFrameAverageLightLevelis the value in nits of the average luminance of the frame which has the brightest average luminance anywhere in the content.
If any of the above values are unknown, they can be set to 0.
The meta-data provided here is intended to be used as defined in the SMPTE
2086, CTA 861.3 and CIE 15:2004 specifications.
The validity and use of this data is outside the scope of Vulkan.
Valid Usage (Implicit)
VUID-VkHdrMetadataEXT-sType-sType
sType must be VK_STRUCTURE_TYPE_HDR_METADATA_EXT
VUID-VkHdrMetadataEXT-pNext-pNext
pNext must be NULL or a pointer to a valid instance of VkHdrVividDynamicMetadataHUAWEI
VUID-VkHdrMetadataEXT-sType-unique
The sType value of each structure in the pNext chain must be unique