vkGetRefreshCycleDurationGOOGLE(3)

Name

vkGetRefreshCycleDurationGOOGLE - Obtain the RC duration of the PE’s display

C Specification

To query the duration of a refresh cycle (RC) for the presentation engine’s display, call:

// Provided by VK_GOOGLE_display_timing
VkResult vkGetRefreshCycleDurationGOOGLE(
    VkDevice                                    device,
    VkSwapchainKHR                              swapchain,
    VkRefreshCycleDurationGOOGLE*               pDisplayTimingProperties);

Parameters

  • device is the device associated with swapchain.

  • swapchain is the swapchain to obtain the refresh duration for.

  • pDisplayTimingProperties is a pointer to a VkRefreshCycleDurationGOOGLE structure.

Description

Valid Usage (Implicit)

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

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

  • VUID-vkGetRefreshCycleDurationGOOGLE-pDisplayTimingProperties-parameter
    pDisplayTimingProperties must be a valid pointer to a VkRefreshCycleDurationGOOGLE structure

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

Host Synchronization

  • Host access to swapchain must be externally synchronized

Return Codes
Success
Failure

See Also

VK_GOOGLE_display_timing, VkDevice, VkRefreshCycleDurationGOOGLE, 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.