Vulkan-Docs/doc/specs/vulkan/man/vkCmdBeginQuery.txt

50 lines
1.3 KiB
Plaintext

vkCmdBeginQuery(3)
===================
Name
----
vkCmdBeginQuery - Begin a query.
C Specification
---------------
include::../protos/vkCmdBeginQuery.txt[]
Parameters
----------
pname:commandBuffer::
The command buffer upon which to execute the query.
pname:queryPool::
The query pool which contains the requested query.
pname:entry::
The index of the entry within pname:queryPool at which the query resides.
pname:flags::
A set of flags controlling how the query should be executed (see elink:VkQueryControlFlags).
Description
-----------
fname:vkCmdBeginQuery begins the query located at the entry indicated by pname:entry in
the pool specified in pname:queryPool. The pname:flags parameter specifies how the query
should be executed and must be one of the flags defined in elink:VkQueryControlFlags.
include::../validity/protos/vkCmdBeginQuery.txt[]
Notes
-----
Although fname:vkCmdBeginQuery does not generate errors or return a value, enabled
validation layers may detect possible error conditions or potentially undefined
behavior and report this via some other means.
See Also
--------
flink:vkCmdEndQuery, flink:vkCreateQueryPool, flink:vkCmdResetQueryPool, flink:vkCmdCopyQueryPoolResults, flink:vkGetQueryPoolResults, flink:vkDestroyQueryPool
include::footer.txt[]