Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_HUAWEI_hdr_vivid

Description

Name

VK_HUAWEI_hdr_vivid - device extension

VK_HUAWEI_hdr_vivid

Name String: VK_HUAWEI_hdr_vivid

Extension Type: Device extension
Registered Extension Number: 591
Revision: 1
Ratification Status: Not ratified
Extension and Version Dependencies

VK_KHR_get_physical_device_properties2 or

Vulkan Version 1.1 and VK_KHR_swapchain and VK_EXT_hdr_metadata

Contact

Zehui Lin @bactlink%0A*Here describe the issue or question you have about the VK_HUAWEI_hdr_vivid extension*

Other Extension Metadata

Last Modified Date: 2024-10-08

IP Status

No known IP claims.

Contributors

Juntao Li, Huawei
Pan Gao, Huawei
Xiufeng Zhang, Huawei
Zehui Lin, Huawei

Description

This extension allows applications to assign HDR Vivid (T/UWA 005.1-2022) metadata to swapchains.

HDR Vivid is an HDR standard released by UWA (UHD World Association). It defines tone mapping from the metadata to better preserve the creator’s intentions and achieve better consistency across devices with different display capabilities.

New Structures

Extending HdrMetadataEXT:
- HdrVividDynamicMetadataHUAWEI

Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDeviceHdrVividFeaturesHUAWEI

New Enum Constants

HUAWEI_HDR_VIVID_EXTENSION_NAME

Version History

Revision 1, 2024-10-08 (Zehui Lin)
- Initial version

Document Notes

For more information, see the Vulkan Specification.

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Synopsis

data HdrVividDynamicMetadataHUAWEI = HdrVividDynamicMetadataHUAWEI {
- dynamicMetadataSize :: Word64
- dynamicMetadata :: Ptr ()
}
data PhysicalDeviceHdrVividFeaturesHUAWEI = PhysicalDeviceHdrVividFeaturesHUAWEI {
- hdrVivid :: Bool
}
type HUAWEI_HDR_VIVID_SPEC_VERSION = 1
pattern HUAWEI_HDR_VIVID_SPEC_VERSION :: Integral a => a
type HUAWEI_HDR_VIVID_EXTENSION_NAME = "VK_HUAWEI_hdr_vivid"
pattern HUAWEI_HDR_VIVID_EXTENSION_NAME :: (Eq a, IsString a) => a

Documentation

data HdrVividDynamicMetadataHUAWEI Source #

VkHdrVividDynamicMetadataHUAWEI - specify HDR Vivid dynamic metadata

Description

The HDR Vivid metadata is intended to be used as defined in the T/UWA 005.1-2022 specification. The validity and use of this data is outside the scope of Vulkan.

Valid Usage (Implicit)

HdrVividDynamicMetadataHUAWEI
Fields dynamicMetadataSize :: Word64 `dynamicMetadataSize` is the size in bytes of the dynamic metadata. `dynamicMetadataSize` must be greater than `0` dynamicMetadata :: Ptr () `pDynamicMetadata` is a pointer to the dynamic metadata. `pDynamicMetadata` must be a valid pointer to an array of `dynamicMetadataSize` bytes

Instances

Instances details

Storable HdrVividDynamicMetadataHUAWEI Source #
Instance details Defined in Vulkan.Extensions.VK_HUAWEI_hdr_vivid Methods sizeOf :: HdrVividDynamicMetadataHUAWEI -> Int # alignment :: HdrVividDynamicMetadataHUAWEI -> Int # peekElemOff :: Ptr HdrVividDynamicMetadataHUAWEI -> Int -> IO HdrVividDynamicMetadataHUAWEI # pokeElemOff :: Ptr HdrVividDynamicMetadataHUAWEI -> Int -> HdrVividDynamicMetadataHUAWEI -> IO () # peekByteOff :: Ptr b -> Int -> IO HdrVividDynamicMetadataHUAWEI # pokeByteOff :: Ptr b -> Int -> HdrVividDynamicMetadataHUAWEI -> IO () # peek :: Ptr HdrVividDynamicMetadataHUAWEI -> IO HdrVividDynamicMetadataHUAWEI # poke :: Ptr HdrVividDynamicMetadataHUAWEI -> HdrVividDynamicMetadataHUAWEI -> IO () #
Show HdrVividDynamicMetadataHUAWEI Source #
Instance details Defined in Vulkan.Extensions.VK_HUAWEI_hdr_vivid Methods showsPrec :: Int -> HdrVividDynamicMetadataHUAWEI -> ShowS # show :: HdrVividDynamicMetadataHUAWEI -> String # showList :: [HdrVividDynamicMetadataHUAWEI] -> ShowS #
FromCStruct HdrVividDynamicMetadataHUAWEI Source #
Instance details Defined in Vulkan.Extensions.VK_HUAWEI_hdr_vivid Methods peekCStruct :: Ptr HdrVividDynamicMetadataHUAWEI -> IO HdrVividDynamicMetadataHUAWEI Source #
ToCStruct HdrVividDynamicMetadataHUAWEI Source #
Instance details Defined in Vulkan.Extensions.VK_HUAWEI_hdr_vivid Methods withCStruct :: HdrVividDynamicMetadataHUAWEI -> (Ptr HdrVividDynamicMetadataHUAWEI -> IO b) -> IO b Source # pokeCStruct :: Ptr HdrVividDynamicMetadataHUAWEI -> HdrVividDynamicMetadataHUAWEI -> IO b -> IO b Source # withZeroCStruct :: (Ptr HdrVividDynamicMetadataHUAWEI -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr HdrVividDynamicMetadataHUAWEI -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero HdrVividDynamicMetadataHUAWEI Source #
Instance details Defined in Vulkan.Extensions.VK_HUAWEI_hdr_vivid Methods zero :: HdrVividDynamicMetadataHUAWEI Source #

data PhysicalDeviceHdrVividFeaturesHUAWEI Source #

VkPhysicalDeviceHdrVividFeaturesHUAWEI - Structure describing whether HDR Vivid metadata is supported

Description

If the PhysicalDeviceHdrVividFeaturesHUAWEI structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. If the application wishes to use a Device with any features described by PhysicalDeviceHdrVividFeaturesHUAWEI, it must add an instance of the structure, with the desired feature members set to TRUE, to the pNext chain of DeviceCreateInfo when creating the Device.

Valid Usage (Implicit)

Eq PhysicalDeviceHdrVividFeaturesHUAWEI Source #
Instance details Defined in Vulkan.Extensions.VK_HUAWEI_hdr_vivid Methods (==) :: PhysicalDeviceHdrVividFeaturesHUAWEI -> PhysicalDeviceHdrVividFeaturesHUAWEI -> Bool # (/=) :: PhysicalDeviceHdrVividFeaturesHUAWEI -> PhysicalDeviceHdrVividFeaturesHUAWEI -> Bool #
Storable PhysicalDeviceHdrVividFeaturesHUAWEI Source #
Instance details Defined in Vulkan.Extensions.VK_HUAWEI_hdr_vivid Methods sizeOf :: PhysicalDeviceHdrVividFeaturesHUAWEI -> Int # alignment :: PhysicalDeviceHdrVividFeaturesHUAWEI -> Int # peekElemOff :: Ptr PhysicalDeviceHdrVividFeaturesHUAWEI -> Int -> IO PhysicalDeviceHdrVividFeaturesHUAWEI # pokeElemOff :: Ptr PhysicalDeviceHdrVividFeaturesHUAWEI -> Int -> PhysicalDeviceHdrVividFeaturesHUAWEI -> IO () # peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceHdrVividFeaturesHUAWEI # pokeByteOff :: Ptr b -> Int -> PhysicalDeviceHdrVividFeaturesHUAWEI -> IO () # peek :: Ptr PhysicalDeviceHdrVividFeaturesHUAWEI -> IO PhysicalDeviceHdrVividFeaturesHUAWEI # poke :: Ptr PhysicalDeviceHdrVividFeaturesHUAWEI -> PhysicalDeviceHdrVividFeaturesHUAWEI -> IO () #
Show PhysicalDeviceHdrVividFeaturesHUAWEI Source #
Instance details Defined in Vulkan.Extensions.VK_HUAWEI_hdr_vivid Methods showsPrec :: Int -> PhysicalDeviceHdrVividFeaturesHUAWEI -> ShowS # show :: PhysicalDeviceHdrVividFeaturesHUAWEI -> String # showList :: [PhysicalDeviceHdrVividFeaturesHUAWEI] -> ShowS #
FromCStruct PhysicalDeviceHdrVividFeaturesHUAWEI Source #
Instance details Defined in Vulkan.Extensions.VK_HUAWEI_hdr_vivid Methods peekCStruct :: Ptr PhysicalDeviceHdrVividFeaturesHUAWEI -> IO PhysicalDeviceHdrVividFeaturesHUAWEI Source #
ToCStruct PhysicalDeviceHdrVividFeaturesHUAWEI Source #
Instance details Defined in Vulkan.Extensions.VK_HUAWEI_hdr_vivid Methods withCStruct :: PhysicalDeviceHdrVividFeaturesHUAWEI -> (Ptr PhysicalDeviceHdrVividFeaturesHUAWEI -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDeviceHdrVividFeaturesHUAWEI -> PhysicalDeviceHdrVividFeaturesHUAWEI -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDeviceHdrVividFeaturesHUAWEI -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDeviceHdrVividFeaturesHUAWEI -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDeviceHdrVividFeaturesHUAWEI Source #
Instance details Defined in Vulkan.Extensions.VK_HUAWEI_hdr_vivid Methods zero :: PhysicalDeviceHdrVividFeaturesHUAWEI Source #