To retrieve status and results for a set of queries, call:
// Provided by VK_VERSION_1_0 VkResult vkGetQueryPoolResults( VkDevice device, VkQueryPool queryPool, uint32_t firstQuery, uint32_t queryCount, size_t dataSize, void* pData, VkDeviceSize stride, VkQueryResultFlags flags);
deviceis the logical device that owns the query pool.
queryPoolis the query pool managing the queries containing the desired results.
firstQueryis the initial query index.
queryCountis the number of queries to read.
dataSizeis the size in bytes of the buffer pointed to by
pDatais a pointer to a user-allocated buffer where the results will be written
strideis the stride in bytes between results for individual queries within
flagsis a bitmask of VkQueryResultFlagBits specifying how and when results are returned.
The range of queries read is defined by [
queryCount - 1].
For pipeline statistics queries, each query index in the pool contains one
integer value for each bit that is enabled in
pipelineStatistics when the pool is
If no bits are set in
flags, and all requested queries are in the
available state, results are written as an array of 32-bit unsigned integer
The behavior when not all queries are available, is described
VK_QUERY_RESULT_64_BIT is not set and the result overflows a 32-bit
value, the value may either wrap or saturate.
VK_QUERY_RESULT_64_BIT is set and the result overflows a
64-bit value, the value may either wrap or saturate.
VK_QUERY_RESULT_WAIT_BIT is set, Vulkan will wait for each query to
be in the available state before retrieving the numerical results for that
In this case,
vkGetQueryPoolResults is guaranteed to succeed and
VK_SUCCESS if the queries become available in a finite time
(i.e. if they have been issued and not reset).
If queries will never finish (e.g. due to being reset but not issued), then
vkGetQueryPoolResults may not return in finite time.
both not set then no result values are written to
pData for queries
that are in the unavailable state at the time of the call, and
However, availability state is still written to
pData for those
VK_QUERY_RESULT_WITH_AVAILABILITY_BIT is set.
Similarly, the status is still written to
pData for those queries if
VK_QUERY_RESULT_WITH_STATUS_BIT_KHR is set.
VK_QUERY_RESULT_WAIT_BIT is not set,
VK_NOT_READY if there are queries in the unavailable
Applications must take care to ensure that use of the
For example, if a query has been used previously and a command buffer
records the commands
The above also applies when
A similar situation can arise with the
Applications can double-buffer query pool usage, with a pool per frame, and reset queries at the end of the frame in which they are read.
VK_QUERY_RESULT_PARTIAL_BIT is set,
is not set, and the query’s status is unavailable, an intermediate result
value between zero and the final result value is written to
VK_QUERY_RESULT_WITH_AVAILABILITY_BIT is set, the final integer
value written for each query is non-zero if the query’s status was available
or zero if the status was unavailable.
VK_QUERY_RESULT_WITH_AVAILABILITY_BIT is used, implementations
must guarantee that if they return a non-zero availability value then the
numerical results must be valid, assuming the results are not reset by a
Satisfying this guarantee may require careful ordering by the application, e.g. to read the availability status before reading the results.
VK_QUERY_RESULT_WITH_STATUS_BIT_KHR is set, the final integer value
written for each query indicates whether the result is available or not, and
whether an error occurred.
A value of zero indicates that the results are not yet available.
Positive values indicate that the operations within the query completed
successfully, and the query results are valid.
Negative values indicate that the operations within the query completed
Specific result codes are defined by the VkQueryResultStatusKHR enumeration.
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.