56 lines
2.5 KiB
Plaintext
56 lines
2.5 KiB
Plaintext
|
// WARNING: DO NOT MODIFY! This file is automatically generated from the vk.xml registry
|
||
|
|
ifndef::doctype-manpage[]
|
||
|
|
.Valid Usage
|
||
|
|
********************************************************************************
|
||
|
|
endif::doctype-manpage[]
|
||
|
|
ifdef::doctype-manpage[]
|
||
|
|
Valid Usage
|
||
|
|
-----------
|
||
|
|
endif::doctype-manpage[]
|
||
|
|
* pname:device must: be a valid sname:VkDevice handle
|
||
|
|
* pname:queryPool must: be a valid sname:VkQueryPool handle
|
||
|
|
* pname:pData must: be a pointer to an array of pname:dataSize bytes
|
||
|
|
* pname:flags must: be a valid combination of elink:VkQueryResultFlagBits values
|
||
|
|
* The value of pname:dataSize must: be greater than `0`
|
||
|
|
* pname:queryPool must: have been created, allocated or retrieved from pname:device
|
||
|
|
* Each of pname:device and pname:queryPool must: have been created, allocated or retrieved from the same sname:VkPhysicalDevice
|
||
|
|
* pname:firstQuery must: be less than the number of queries in pname:queryPool
|
||
|
|
* If ename:VK_QUERY_RESULT_64_BIT is not set in pname:flags then pname:pData and pname:stride must be multiples of `4`
|
||
|
|
* If ename:VK_QUERY_RESULT_64_BIT is set in pname:flags then pname:pData and pname:stride must be multiples of `8`
|
||
|
|
* The sum of pname:firstQuery and pname:queryCount must: be less than or equal to the number of queries in pname:queryPool
|
||
|
|
* pname:dataSize must: be large enough to contain the result of each query, as described <<queries-operation-memorylayout,here>>
|
||
|
|
* If the pname:queryType used to create pname:queryPool was ename:VK_QUERY_TYPE_TIMESTAMP, pname:flags mustnot: contain ename:VK_QUERY_RESULT_PARTIAL_BIT
|
||
|
|
ifndef::doctype-manpage[]
|
||
|
|
********************************************************************************
|
||
|
|
endif::doctype-manpage[]
|
||
|
|
|
||
|
|
ifndef::doctype-manpage[]
|
||
|
|
.Return Codes
|
||
|
|
********************************************************************************
|
||
|
|
endif::doctype-manpage[]
|
||
|
|
ifdef::doctype-manpage[]
|
||
|
|
Return Codes
|
||
|
|
------------
|
||
|
|
endif::doctype-manpage[]
|
||
|
|
ifndef::doctype-manpage[]
|
||
|
|
<<fundamentals-successcodes,Success>>::
|
||
|
|
endif::doctype-manpage[]
|
||
|
|
ifdef::doctype-manpage[]
|
||
|
|
On success, this command returns::
|
||
|
|
endif::doctype-manpage[]
|
||
|
|
* ename:VK_SUCCESS
|
||
|
|
* ename:VK_NOT_READY
|
||
|
|
ifndef::doctype-manpage[]
|
||
|
|
<<fundamentals-errorcodes,Failure>>::
|
||
|
|
endif::doctype-manpage[]
|
||
|
|
ifdef::doctype-manpage[]
|
||
|
|
On failure, this command returns::
|
||
|
|
endif::doctype-manpage[]
|
||
|
|
* ename:VK_ERROR_OUT_OF_HOST_MEMORY
|
||
|
|
* ename:VK_ERROR_OUT_OF_DEVICE_MEMORY
|
||
|
|
* ename:VK_ERROR_DEVICE_LOST
|
||
|
|
ifndef::doctype-manpage[]
|
||
|
|
********************************************************************************
|
||
|
|
endif::doctype-manpage[]
|
||
|
|
|