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

51 lines
1.4 KiB
Plaintext

vkCreateQueryPool(3)
=====================
Name
----
vkCreateQueryPool - Create a new query pool object.
C Specification
---------------
include::../protos/vkCreateQueryPool.txt[]
Parameters
----------
pname:device::
The device with which to create the query pool object.
pname:pCreateInfo::
A pointer to a structure containing information to be placed in the object.
pname:pQueryPool::
A pointer to a variable which will receive the handle to the new object.
Description
-----------
fname:vkCreateQueryPool creates a new query pool object using the information contained in
pname:pCreateInfo and the device specified in pname:device. Upon success, a handle to
the new query pool object is deposited in the variable pointed to by pname:pQueryPool.
pname:pCreateInfo should point to an instance of the slink:VkQueryPoolCreateInfo structure,
the definition of which is:
include::../structs/VkQueryPoolCreateInfo.txt[]
include::../validity/protos/vkCreateQueryPool.txt[]
Return Value
------------
Upon success, fname:vkCreateQueryPool returns ename:VK_SUCCESS and deposits the resulting
query pool handle in the variable pointed to by pname:pQueryPool. Upon failure, a
descriptive error code is returned.
See Also
--------
flink:vkCmdResetQueryPool, flink:vkCmdBeginQuery, flink:vkCmdEndQuery, flink:vkDestroyQueryPool, flink:vkGetQueryPoolResults, flink:vkCmdCopyQueryPoolResults
include::footer.txt[]