Package org.lwjgl.vulkan
Class EXTHdrMetadata
- java.lang.Object
-
- org.lwjgl.vulkan.EXTHdrMetadata
-
public class EXTHdrMetadata extends java.lang.Object
This extension defines two new structures and a function to assign SMPTE (the Society of Motion Picture and Television Engineers) 2086 metadata and CTA (Consumer Technology Association) 861.3 metadata to a swapchain. The metadata includes the color primaries, white point, and luminance range of the mastering display, which all together define the color volume that contains all the possible colors the mastering display can produce. The mastering display is the display where creative work is done and creative intent is established. To preserve such creative intent as much as possible and achieve consistent color reproduction on different viewing displays, it is useful for the display pipeline to know the color volume of the original mastering display where content was created or tuned. This avoids performing unnecessary mapping of colors that are not displayable on the original mastering display. The metadata also includes themaxContentLightLevel
andmaxFrameAverageLightLevel
as defined by CTA 861.3.While the general purpose of the metadata is to assist in the transformation between different color volumes of different displays and help achieve better color reproduction, it is not in the scope of this extension to define how exactly the metadata should be used in such a process. It is up to the implementation to determine how to make use of the metadata.
- Name String
VK_EXT_hdr_metadata
- Extension Type
- Device extension
- Registered Extension Number
- 106
- Revision
- 2
- Extension and Version Dependencies
- Requires Vulkan 1.0
- Requires
VK_KHR_swapchain
- Contact
- Courtney Goeltzenleuchter courtney-g
- Last Modified Date
- 2018-12-19
- IP Status
- No known IP claims.
- Contributors
- Courtney Goeltzenleuchter, Google
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
VK_EXT_HDR_METADATA_EXTENSION_NAME
The extension name.static int
VK_EXT_HDR_METADATA_SPEC_VERSION
The extension specification version.static int
VK_STRUCTURE_TYPE_HDR_METADATA_EXT
ExtendsVkStructureType
.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static void
nvkSetHdrMetadataEXT(VkDevice device, int swapchainCount, long pSwapchains, long pMetadata)
Unsafe version of:SetHdrMetadataEXT
static void
vkSetHdrMetadataEXT(VkDevice device, long[] pSwapchains, VkHdrMetadataEXT.Buffer pMetadata)
Array version of:SetHdrMetadataEXT
static void
vkSetHdrMetadataEXT(VkDevice device, java.nio.LongBuffer pSwapchains, VkHdrMetadataEXT.Buffer pMetadata)
function to set Hdr metadata.
-
-
-
Field Detail
-
VK_EXT_HDR_METADATA_SPEC_VERSION
public static final int VK_EXT_HDR_METADATA_SPEC_VERSION
The extension specification version.- See Also:
- Constant Field Values
-
VK_EXT_HDR_METADATA_EXTENSION_NAME
public static final java.lang.String VK_EXT_HDR_METADATA_EXTENSION_NAME
The extension name.- See Also:
- Constant Field Values
-
VK_STRUCTURE_TYPE_HDR_METADATA_EXT
public static final int VK_STRUCTURE_TYPE_HDR_METADATA_EXT
ExtendsVkStructureType
.- See Also:
- Constant Field Values
-
-
Method Detail
-
nvkSetHdrMetadataEXT
public static void nvkSetHdrMetadataEXT(VkDevice device, int swapchainCount, long pSwapchains, long pMetadata)
Unsafe version of:SetHdrMetadataEXT
- Parameters:
swapchainCount
- the number of swapchains included inpSwapchains
.
-
vkSetHdrMetadataEXT
public static void vkSetHdrMetadataEXT(VkDevice device, java.nio.LongBuffer pSwapchains, VkHdrMetadataEXT.Buffer pMetadata)
function to set Hdr metadata.C Specification
void vkSetHdrMetadataEXT( VkDevice device, uint32_t swapchainCount, const VkSwapchainKHR* pSwapchains, const VkHdrMetadataEXT* pMetadata);
Valid Usage (Implicit)
device
must be a validVkDevice
handlepSwapchains
must be a valid pointer to an array ofswapchainCount
validVkSwapchainKHR
handlespMetadata
must be a valid pointer to an array ofswapchainCount
validVkHdrMetadataEXT
structuresswapchainCount
must be greater than 0- Both of
device
, and the elements ofpSwapchains
must have been created, allocated, or retrieved from the sameVkInstance
See Also
- Parameters:
device
- the logical device where the swapchain(s) were created.pSwapchains
- a pointer to the array ofswapchainCount
VkSwapchainKHR
handles.pMetadata
- a pointer to the array ofswapchainCount
VkHdrMetadataEXT
structures.
-
vkSetHdrMetadataEXT
public static void vkSetHdrMetadataEXT(VkDevice device, long[] pSwapchains, VkHdrMetadataEXT.Buffer pMetadata)
Array version of:SetHdrMetadataEXT
-
-