66 lines
2.9 KiB
Plaintext
66 lines
2.9 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:image must: be a valid sname:VkImage handle
|
||
|
|
* pname:memory must: be a valid sname:VkDeviceMemory handle
|
||
|
|
* pname:image must: have been created, allocated or retrieved from pname:device
|
||
|
|
* pname:memory must: have been created, allocated or retrieved from pname:device
|
||
|
|
* Each of pname:device, pname:image and pname:memory must: have been created, allocated or retrieved from the same sname:VkPhysicalDevice
|
||
|
|
* pname:image mustnot: already be backed by a memory object
|
||
|
|
* pname:image mustnot: have been created with any sparse memory binding flags
|
||
|
|
* pname:memoryOffset must: be less than the size of pname:memory
|
||
|
|
* pname:memory must: have been allocated using one of the memory types allowed in the pname:memoryTypeBits member of the sname:VkMemoryRequirements structure returned from a call to fname:vkGetImageMemoryRequirements with pname:image
|
||
|
|
* pname:memoryOffset must: be an integer multiple of the pname:alignment member of the sname:VkMemoryRequirements structure returned from a call to fname:vkGetImageMemoryRequirements with pname:image
|
||
|
|
* pname:memory must: have storage from pname:memoryOffset onwards equal to or greater than the pname:size member of the sname:VkMemoryRequirements structure returned from a call to fname:vkGetImageMemoryRequirements with pname:image
|
||
|
|
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:image 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[]
|
||
|
|
|