66 lines
2.4 KiB
Plaintext
66 lines
2.4 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:memory must: be a valid sname:VkDeviceMemory handle
|
|
* pname:flags must: be `0`
|
|
* pname:ppData must: be a pointer to a pointer
|
|
* pname:memory must: have been created, allocated or retrieved from pname:device
|
|
* Each of pname:device and pname:memory must: have been created, allocated or retrieved from the same sname:VkPhysicalDevice
|
|
* pname:memory mustnot: currently be mapped
|
|
* pname:offset must: be less than the size of pname:memory
|
|
* pname:size must: be greater than `0`
|
|
* If pname:size is not equal to ename:VK_WHOLE_SIZE, pname:size must: be less than or equal to the size of the pname:memory minus pname:offset
|
|
* pname:memory must: have been created with a memory type that reports ename:VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT
|
|
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:memory 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
|
|
* ename:VK_ERROR_MEMORY_MAP_FAILED
|
|
ifndef::doctype-manpage[]
|
|
********************************************************************************
|
|
endif::doctype-manpage[]
|
|
|