blob: a537bd5fdb65ad14930e5ae55cafd8fde4e15508 [file] [log] [blame]
// WARNING: DO NOT MODIFY! This file is automatically generated from the vk.xml registry
.Valid Usage (Implicit)
****
* [[VUID-vkMapMemory-device-parameter]] pname:device must: be a valid sname:VkDevice handle
* [[VUID-vkMapMemory-memory-parameter]] pname:memory must: be a valid sname:VkDeviceMemory handle
* [[VUID-vkMapMemory-flags-zerobitmask]] pname:flags must: be `0`
* [[VUID-vkMapMemory-ppData-parameter]] pname:ppData must: be a valid pointer to a pointer value
* [[VUID-vkMapMemory-memory-parent]] pname:memory must: have been created, allocated, or retrieved from pname:device
****
.Host Synchronization
****
* Host access to pname:memory must: be externally synchronized
****
.Return Codes
****
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
****