Function Prototype

vkGetSemaphoreCounterValue

Query the current state of a timeline semaphore

To query the current counter value of a semaphore created with a VkSemaphoreType of VK_SEMAPHORE_TYPE_TIMELINE from the host, call:

VkResult vkGetSemaphoreCounterValueKHR(
    VkDevice device,
    VkSemaphore semaphore,
    uint64_t* pValue);
  • device is the logical device that owns the semaphore.
  • semaphore is the handle of the semaphore to query.
  • pValue is a pointer to a 64-bit integer value in which the current counter value of the semaphore is returned.

If a queue submission command is pending execution, then the value returned by this command may immediately be out of date.

Valid Usage

VUID-vkGetSemaphoreCounterValue-semaphore-03255

semaphore must have been created with a VkSemaphoreType of VK_SEMAPHORE_TYPE_TIMELINE

Valid Usage (Implicit)

VUID-vkGetSemaphoreCounterValue-pValue-parameter

pValue must be a valid pointer to a uint64_t value

VUID-vkGetSemaphoreCounterValue-semaphore-parent

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