Function Prototype

vkGetSwapchainTimingPropertiesEXT

Obtain the display timing properties of the PE's display

The implementation maintains an internal monotonically increasing counter which updates when the presentation engine’s timing properties are modified.

To query the presentation engine’s current timing properties for a given swapchain, call:

VkResult vkGetSwapchainTimingPropertiesEXT(
    VkDevice device,
    VkSwapchainKHR swapchain,
    VkSwapchainTimingPropertiesEXT* pSwapchainTimingProperties,
    uint64_t* pSwapchainTimingPropertiesCounter);
  • device is the device associated with swapchain.
  • swapchain is the swapchain to obtain timing properties for.
  • pSwapchainTimingProperties is a pointer to an instance of the VkSwapchainTimingPropertiesEXT structure.
  • pSwapchainTimingPropertiesCounter is NULL or a pointer to a 64-bit unsigned integer set by the implementation to the current value of the swapchain’s internal timing properties counter.

If vkGetSwapchainTimingPropertiesEXT returns VK_NOT_READY, the implementation was not able to determine the current refresh cycle duration. Some platforms may not provide timing properties until after at least one image has been presented to the swapchain. If timing properties change for the swapchain, these platforms may not provide updated results until after at least one additional image has been presented to the swapchain.

Valid Usage (Implicit)

VUID-vkGetSwapchainTimingPropertiesEXT-pSwapchainTimingPropertiesCounter-parameter

If pSwapchainTimingPropertiesCounter is not NULL, pSwapchainTimingPropertiesCounter must be a valid pointer to a uint64_t value

VUID-vkGetSwapchainTimingPropertiesEXT-swapchain-parent

swapchain must have been created, allocated, or retrieved from device

Host Synchronization

  • Host access to swapchain must be externally synchronized