Vulkan-Docs/doc/specs/vulkan/man/vkMapMemory.txt

50 lines
1.1 KiB
Plaintext

vkMapMemory(3)
===============
Name
----
vkMapMemory - Map a memory object into application address space.
C Specification
---------------
include::../protos/vkMapMemory.txt[]
Parameters
----------
pname:device::
Logical device which owns the memory object.
pname:memory::
A handle to the memory object to map.
pname:offset::
Start offset of the memory region to map.
pname:size::
Size of the memory region to map.
pname:flags::
This parameter is reserved and must be zero.
pname:ppData::
The pointer to a variable to receive the resulting application-visible address.
Description
-----------
fname:vkMapMemory maps a region of the memory object specified in `mem` into application
address space and returns the resulting pointer in the variable pointed to by `ppData`.
The mapped memory region starts at offset pname:offset and has a size of pname:size.
The `flags` parameter is reserved and should be set to zero.
include::../validity/protos/vkMapMemory.txt[]
See Also
--------
flink:vkUnmapMemory, flink:vkFlushMappedMemoryRanges, flink:vkInvalidateMappedMemoryRanges
include::footer.txt[]