69 lines
1.7 KiB
Plaintext
69 lines
1.7 KiB
Plaintext
// Copyright (c) 2014-2016 Khronos Group. This work is licensed under a
|
|
// Creative Commons Attribution 4.0 International License; see
|
|
// http://creativecommons.org/licenses/by/4.0/
|
|
|
|
vkCmdEndQuery(3)
|
|
================
|
|
|
|
Name
|
|
----
|
|
vkCmdEndQuery - Ends a query.
|
|
|
|
C Specification
|
|
---------------
|
|
|
|
// refBegin vkCmdEndQuery Ends a query.
|
|
|
|
To end a query after the set of desired draw or dispatch commands is
|
|
executed, call:
|
|
|
|
include::../api/protos/vkCmdEndQuery.txt[]
|
|
|
|
|
|
Parameters
|
|
----------
|
|
|
|
* pname:commandBuffer is the command buffer into which this command will
|
|
be recorded.
|
|
* pname:queryPool is the query pool that is managing the results of the
|
|
query.
|
|
* pname:query is the query index within the query pool where the result is
|
|
stored.
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
[[queries-operation-finished]]
|
|
As queries operate asynchronously, ending a query does not immediately set
|
|
the query's status to available. A query is considered _finished_
|
|
when the final results of the query are ready to be retrieved by
|
|
flink:vkGetQueryPoolResults and flink:vkCmdCopyQueryPoolResults, and this
|
|
is when the query's status is set to available.
|
|
|
|
Once a query is ended the query must: finish in finite time, unless the
|
|
state of the query is changed using other commands, e.g. by issuing a reset
|
|
of the query.
|
|
|
|
include::../validity/protos/vkCmdEndQuery.txt[]
|
|
|
|
|
|
See Also
|
|
--------
|
|
|
|
slink:VkCommandBuffer, slink:VkQueryPool
|
|
|
|
|
|
Document Notes
|
|
--------------
|
|
|
|
For more information, see the Vulkan Specification at URL
|
|
|
|
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkCmdEndQuery
|
|
|
|
This page is extracted from the Vulkan Specification.
|
|
Fixes and changes should be made to the Specification,not directly.
|
|
|
|
include::footer.txt[]
|
|
|