vkSetLocalDimmingAMD(3)

Name

vkSetLocalDimmingAMD - Set Local Dimming

C Specification

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

// Provided by VK_AMD_display_native_hdr
void vkSetLocalDimmingAMD(
    VkDevice                                    device,
    VkSwapchainKHR                              swapChain,
    VkBool32                                    localDimmingEnable);

Parameters

  • device is the device associated with swapChain.

  • swapChain handle to enable local dimming.

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

Description

Valid Usage (Implicit)

  • VUID-vkSetLocalDimmingAMD-device-parameter
    device must be a valid VkDevice handle

  • VUID-vkSetLocalDimmingAMD-swapChain-parameter
    swapChain must be a valid VkSwapchainKHR handle

  • VUID-vkSetLocalDimmingAMD-swapChain-parent
    swapChain must have been created, allocated, or retrieved from device

Valid Usage

See Also

VK_AMD_display_native_hdr, VkBool32, VkDevice, VkSwapchainKHR

Document Notes

For more information, see the Vulkan Specification.

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.