65 lines
2.8 KiB
Plaintext
65 lines
2.8 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:descriptorPool must: be a valid sname:VkDescriptorPool handle
|
|
* pname:descriptorSetCount must: be greater than `0`
|
|
* pname:descriptorPool must: have been created, allocated or retrieved from pname:device
|
|
* Each element of pname:pDescriptorSets that is a valid handle must: have been created, allocated or retrieved from pname:descriptorPool
|
|
* Each of pname:device, pname:descriptorPool and the elements of pname:pDescriptorSets that are valid handles must: have been created, allocated or retrieved from the same sname:VkPhysicalDevice
|
|
* All submitted commands that refer to any element of pname:pDescriptorSets must: have completed execution
|
|
* pname:pDescriptorSets must: be a pointer to an array of pname:descriptorSetCount sname:VkDescriptorSet handles, each element of which must: either be a valid handle or dlink:VK_NULL_HANDLE
|
|
* Each valid handle in pname:pDescriptorSets must: have been allocated from pname:descriptorPool
|
|
* pname:descriptorPool must: have been created with the ename:VK_DESCRIPTOR_POOL_CREATE_FREE_DESCRIPTOR_SET_BIT flag
|
|
ifndef::doctype-manpage[]
|
|
********************************************************************************
|
|
endif::doctype-manpage[]
|
|
|
|
ifndef::doctype-manpage[]
|
|
.Host Synchronization
|
|
********************************************************************************
|
|
endif::doctype-manpage[]
|
|
ifdef::doctype-manpage[]
|
|
Host Synchronization
|
|
--------------------
|
|
endif::doctype-manpage[]
|
|
* Host access to pname:descriptorPool must: be externally synchronized
|
|
* Host access to each member of pname:pDescriptorSets must: be externally synchronized
|
|
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
|
|
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
|
|
ifndef::doctype-manpage[]
|
|
********************************************************************************
|
|
endif::doctype-manpage[]
|
|
|