Graphics.Vulkan.Extensions.VK_EXT_hdr_metadata

Documentation

pattern VK_STRUCTURE_TYPE_HDR_METADATA_EXT :: VkStructureType

pattern VK_EXT_HDR_METADATA_SPEC_VERSION :: Integral a => a

pattern VK_EXT_HDR_METADATA_EXTENSION_NAME :: (Eq a, IsString a) => a

vkSetHdrMetadataEXT :: ("device" ::: VkDevice) -> ("swapchainCount" ::: Word32) -> ("pSwapchains" ::: Ptr VkSwapchainKHR) -> ("pMetadata" ::: Ptr VkHdrMetadataEXT) -> IO ()

vkSetHdrMetadataEXT - function to set Hdr metadata

Parameters

• device is the logical device where the swapchain(s) were created.

• swapchainCount is the number of swapchains included in pSwapchains.
• pSwapchains is a pointer to the array of swapchainCount VkSwapchainKHR handles.
• pMetadata is a pointer to the array of swapchainCount VkHdrMetadataEXT structures.

Description

Valid Usage (Implicit)

• device must be a valid VkDevice handle

• pSwapchains must be a valid pointer to an array of swapchainCount valid VkSwapchainKHR handles
• pMetadata must be a valid pointer to an array of swapchainCount valid VkHdrMetadataEXT structures
• swapchainCount must be greater than 0
• Both of device, and the elements of pSwapchains must have been created, allocated, or retrieved from the same VkInstance

See Also

VkDevice, VkHdrMetadataEXT, VkSwapchainKHR

data VkXYColorEXT

VkXYColorEXT - structure to specify X,Y chromaticity coordinates

Members

Description

See Also

VkHdrMetadataEXT

Constructors

VkXYColorEXT

Fields

• vkX :: CFloat
• vkY :: CFloat

Instances

Eq VkXYColorEXT

Methods

(==) :: VkXYColorEXT -> VkXYColorEXT -> Bool

(/=) :: VkXYColorEXT -> VkXYColorEXT -> Bool

Show VkXYColorEXT

Methods

showsPrec :: Int -> VkXYColorEXT -> ShowS

show :: VkXYColorEXT -> String

showList :: [VkXYColorEXT] -> ShowS

Storable VkXYColorEXT

Methods

sizeOf :: VkXYColorEXT -> Int

alignment :: VkXYColorEXT -> Int

peekElemOff :: Ptr VkXYColorEXT -> Int -> IO VkXYColorEXT

pokeElemOff :: Ptr VkXYColorEXT -> Int -> VkXYColorEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO VkXYColorEXT

pokeByteOff :: Ptr b -> Int -> VkXYColorEXT -> IO ()

peek :: Ptr VkXYColorEXT -> IO VkXYColorEXT

poke :: Ptr VkXYColorEXT -> VkXYColorEXT -> IO ()

data VkHdrMetadataEXT

VkHdrMetadataEXT - structure to specify Hdr metadata

Description

Note

The validity and use of this data is outside the scope of Vulkan and thus no Valid Usage is given.

See Also

VkStructureType, VkXYColorEXT, vkSetHdrMetadataEXT

Constructors

VkHdrMetadataEXT

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

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

• vkDisplayPrimaryRed :: VkXYColorEXT

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

• vkDisplayPrimaryGreen :: VkXYColorEXT

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

• vkDisplayPrimaryBlue :: VkXYColorEXT

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

• vkWhitePoint :: VkXYColorEXT

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

• vkMaxLuminance :: CFloat

  maxLuminance is the maximum luminance of the mastering display in nits

• vkMinLuminance :: CFloat

  minLuminance is the minimum luminance of the mastering display in nits

• vkMaxContentLightLevel :: CFloat

  maxContentLightLevel is content’s maximum luminance in nits

• vkMaxFrameAverageLightLevel :: CFloat

  maxFrameAverageLightLevel is the maximum frame average light level in nits

Instances

Eq VkHdrMetadataEXT

Methods

(==) :: VkHdrMetadataEXT -> VkHdrMetadataEXT -> Bool

(/=) :: VkHdrMetadataEXT -> VkHdrMetadataEXT -> Bool

Show VkHdrMetadataEXT

Methods

showsPrec :: Int -> VkHdrMetadataEXT -> ShowS

show :: VkHdrMetadataEXT -> String

showList :: [VkHdrMetadataEXT] -> ShowS

Storable VkHdrMetadataEXT

Methods

sizeOf :: VkHdrMetadataEXT -> Int

alignment :: VkHdrMetadataEXT -> Int

peekElemOff :: Ptr VkHdrMetadataEXT -> Int -> IO VkHdrMetadataEXT

pokeElemOff :: Ptr VkHdrMetadataEXT -> Int -> VkHdrMetadataEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO VkHdrMetadataEXT

pokeByteOff :: Ptr b -> Int -> VkHdrMetadataEXT -> IO ()

peek :: Ptr VkHdrMetadataEXT -> IO VkHdrMetadataEXT

poke :: Ptr VkHdrMetadataEXT -> VkHdrMetadataEXT -> IO ()