C Specification

To enable or disable low latency mode on a swapchain, call:

// Provided by VK_NV_low_latency2
VkResult vkSetLatencySleepModeNV(
    VkDevice                                    device,
    VkSwapchainKHR                              swapchain,
    const VkLatencySleepModeInfoNV*             pSleepModeInfo);

Parameters

  • device is the device associated with swapchain.

  • swapchain is the swapchain to enable or disable low latency mode on.

  • pSleepModeInfo is NULL or a pointer to a VkLatencySleepModeInfoNV structure specifying the parameters of the latency sleep mode.

Description

If pSleepModeInfo is NULL, vkSetLatencySleepModeNV will disable low latency mode, low latency boost, and set the minimum present interval previously specified by VkLatencySleepModeInfoNV to zero on swapchain. As an exception to the normal rules for objects which are externally synchronized, the swapchain passed to vkSetLatencySleepModeNV may be simultaneously used by other threads in calls to functions other than vkDestroySwapchainKHR. Access to the swapchain data associated with this extension must be atomic within the implementation.

Valid Usage (Implicit)

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

  • VUID-vkSetLatencySleepModeNV-swapchain-parameter
    swapchain must be a valid VkSwapchainKHR handle

  • VUID-vkSetLatencySleepModeNV-pSleepModeInfo-parameter
    pSleepModeInfo must be a valid pointer to a valid VkLatencySleepModeInfoNV structure

  • VUID-vkSetLatencySleepModeNV-swapchain-parent
    swapchain must have been created, allocated, or retrieved from device

Return Codes
On success, this command returns

  • VK_SUCCESS

On failure, this command returns

  • VK_ERROR_INITIALIZATION_FAILED

See Also

VK_NV_low_latency2, VkDevice, VkLatencySleepModeInfoNV, 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 2014-2024 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0