Function Prototype
vkGetSwapchainCounterEXT
Query the current value of a surface counter
The requested counters become active when the first presentation command for the associated swapchain is processed by the presentation engine. To query the value of an active counter, use:
VkResult vkGetSwapchainCounterEXT(
VkDevice device,
VkSwapchainKHR swapchain,
VkSurfaceCounterFlagBitsEXT counter,
uint64_t* pCounterValue);
device
is the VkDevice associated withswapchain
.swapchain
is the swapchain from which to query the counter value.counter
is a VkSurfaceCounterFlagBitsEXT value specifying the counter to query.pCounterValue
will return the current value of the counter.
If a counter is not available because the swapchain is out of date, the
implementation may return VK_ERROR_OUT_OF_DATE_KHR
.
Valid Usage
VUID-vkGetSwapchainCounterEXT-swapchain-01245
One or more present commands on swapchain
must have been
processed by the presentation engine
Valid Usage (Implicit)
VUID-vkGetSwapchainCounterEXT-device-parameter
device
must be a valid VkDevice handle
VUID-vkGetSwapchainCounterEXT-swapchain-parameter
swapchain
must be a valid VkSwapchainKHR handle
VUID-vkGetSwapchainCounterEXT-counter-parameter
counter
must be a valid VkSurfaceCounterFlagBitsEXT value
VUID-vkGetSwapchainCounterEXT-pCounterValue-parameter
pCounterValue
must be a valid pointer to a uint64_t
value
VUID-vkGetSwapchainCounterEXT-swapchain-parent
swapchain
must have been created, allocated, or retrieved from device