org.lwjgl.vulkan

Class AMDDisplayNativeHdr

java.lang.Object

org.lwjgl.vulkan.AMDDisplayNativeHdr

public class AMDDisplayNativeHdr
extends java.lang.Object

This extension introduces the following display native HDR features to Vulkan:

• A new VkColorSpaceKHR enum for setting the native display colorspace. For example, this color space would be set by the swapchain to use the native color space in Freesync2 displays.
• Local dimming control

Examples

None.

Name String

VK_AMD_display_native_hdr

Extension Type

Device extension

Registered Extension Number

214

Revision

1

Extension and Version Dependencies

• Requires Vulkan 1.0
• Requires VK_KHR_get_physical_device_properties2
• Requires VK_KHR_get_surface_capabilities2
• Requires VK_KHR_swapchain

Contact

• Matthaeus G. Chajdas anteru

Last Modified Date

2018-12-18

IP Status

No known IP claims.

Contributors

• Matthaeus G. Chajdas, AMD
• Aaron Hagan, AMD
• Aric Cyr, AMD
• Timothy Lottes, AMD
• Derrick Owens, AMD
• Daniel Rakos, AMD

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VK_AMD_DISPLAY_NATIVE_HDR_EXTENSION_NAME The extension name.
static int	VK_AMD_DISPLAY_NATIVE_HDR_SPEC_VERSION The extension specification version.
static int	VK_COLOR_SPACE_DISPLAY_NATIVE_AMD Extends VkColorSpaceKHR.
static int	VK_STRUCTURE_TYPE_DISPLAY_NATIVE_HDR_SURFACE_CAPABILITIES_AMD Extends VkStructureType.
static int	VK_STRUCTURE_TYPE_SWAPCHAIN_DISPLAY_NATIVE_HDR_CREATE_INFO_AMD Extends VkStructureType.

Method Summary

Modifier and Type	Method and Description
static void	vkSetLocalDimmingAMD(org.lwjgl.vulkan.VkDevice device, long swapChain, boolean localDimmingEnable) Set Local Dimming.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VK_AMD_DISPLAY_NATIVE_HDR_SPEC_VERSION

public static final int VK_AMD_DISPLAY_NATIVE_HDR_SPEC_VERSION

The extension specification version.

See Also:

Constant Field Values

VK_AMD_DISPLAY_NATIVE_HDR_EXTENSION_NAME

public static final java.lang.String VK_AMD_DISPLAY_NATIVE_HDR_EXTENSION_NAME

The extension name.

See Also:

Constant Field Values

VK_STRUCTURE_TYPE_DISPLAY_NATIVE_HDR_SURFACE_CAPABILITIES_AMD

public static final int VK_STRUCTURE_TYPE_DISPLAY_NATIVE_HDR_SURFACE_CAPABILITIES_AMD

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_DISPLAY_NATIVE_HDR_SURFACE_CAPABILITIES_AMD
• STRUCTURE_TYPE_SWAPCHAIN_DISPLAY_NATIVE_HDR_CREATE_INFO_AMD

See Also:

Constant Field Values

VK_STRUCTURE_TYPE_SWAPCHAIN_DISPLAY_NATIVE_HDR_CREATE_INFO_AMD

public static final int VK_STRUCTURE_TYPE_SWAPCHAIN_DISPLAY_NATIVE_HDR_CREATE_INFO_AMD

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_DISPLAY_NATIVE_HDR_SURFACE_CAPABILITIES_AMD
• STRUCTURE_TYPE_SWAPCHAIN_DISPLAY_NATIVE_HDR_CREATE_INFO_AMD

See Also:

Constant Field Values

VK_COLOR_SPACE_DISPLAY_NATIVE_AMD

public static final int VK_COLOR_SPACE_DISPLAY_NATIVE_AMD

Extends VkColorSpaceKHR.

See Also:

Constant Field Values

Method Detail

vkSetLocalDimmingAMD

public static void vkSetLocalDimmingAMD(org.lwjgl.vulkan.VkDevice device,
                                        long swapChain,
                                        boolean localDimmingEnable)

Set Local Dimming.

C Specification

The local dimming HDR setting may also be changed over the life of a swapchain by calling:

 void vkSetLocalDimmingAMD(
     VkDevice                                    device,
     VkSwapchainKHR                              swapChain,
     VkBool32                                    localDimmingEnable);

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• swapChain must be a valid VkSwapchainKHR handle
• Both of device, and swapChain must have been created, allocated, or retrieved from the same VkInstance

Valid Usage

• It is only valid to call SetLocalDimmingAMD if VkDisplayNativeHdrSurfaceCapabilitiesAMD::localDimmingSupport is supported.

Parameters:

device - the device associated with swapChain.

swapChain - handle to enable local dimming.

localDimmingEnable - specifies whether local dimming is enabled for the swapchain.