vkSetLocalDimmingAMD(3)

# vkSetLocalDimmingAMD(3) Manual Page

## Name

vkSetLocalDimmingAMD - 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);

## 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)

- `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 vkSetLocalDimmingAMD if VkDisplayNativeHdrSurfaceCapabilitiesAMD::`localDimmingSupport` is supported.

## See Also

`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.

## Copyright

Copyright (c) 2014-2019 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.