2016-07-11 01:13:41 +00:00
|
|
|
// Copyright (c) 2014-2016 Khronos Group. This work is licensed under a
|
|
|
|
|
// Creative Commons Attribution 4.0 International License; see
|
|
|
|
|
// http://creativecommons.org/licenses/by/4.0/
|
|
|
|
|
|
2016-02-16 09:53:44 +00:00
|
|
|
vkMapMemory(3)
|
2016-07-11 01:13:41 +00:00
|
|
|
==============
|
2016-02-16 09:53:44 +00:00
|
|
|
|
|
|
|
|
Name
|
|
|
|
|
----
|
|
|
|
|
vkMapMemory - Map a memory object into application address space.
|
|
|
|
|
|
|
|
|
|
C Specification
|
|
|
|
|
---------------
|
|
|
|
|
|
2016-07-11 01:13:41 +00:00
|
|
|
// refBegin vkMapMemory Map a memory object into application address space.
|
2016-02-16 09:53:44 +00:00
|
|
|
|
2016-07-11 01:13:41 +00:00
|
|
|
To retrieve a host virtual address pointer to a region of a mappable memory
|
|
|
|
|
object, call:
|
2016-02-16 09:53:44 +00:00
|
|
|
|
2016-07-11 01:13:41 +00:00
|
|
|
include::../protos/vkMapMemory.txt[]
|
2016-02-16 09:53:44 +00:00
|
|
|
|
|
|
|
|
|
2016-07-11 01:13:41 +00:00
|
|
|
Parameters
|
|
|
|
|
----------
|
2016-02-16 09:53:44 +00:00
|
|
|
|
2016-07-11 01:13:41 +00:00
|
|
|
* pname:device is the logical device that owns the memory.
|
|
|
|
|
* pname:memory is the sname:VkDeviceMemory object to be mapped.
|
|
|
|
|
* pname:offset is a zero-based byte offset from the beginning of the
|
|
|
|
|
memory object.
|
|
|
|
|
* pname:size is the size of the memory range to map, or
|
|
|
|
|
ename:VK_WHOLE_SIZE to map from pname:offset to the end of the
|
|
|
|
|
allocation.
|
|
|
|
|
* pname:flags is reserved for future use.
|
|
|
|
|
* pname:ppData points to a pointer in which is returned a host-accessible
|
|
|
|
|
pointer to the beginning of the mapped range. This pointer minus
|
|
|
|
|
pname:offset must: be aligned to at least
|
|
|
|
|
sname:VkPhysicalDeviceLimits::pname:minMemoryMapAlignment.
|
2016-02-16 09:53:44 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Description
|
|
|
|
|
-----------
|
|
|
|
|
|
2016-07-11 01:13:41 +00:00
|
|
|
It is an application error to call fname:vkMapMemory on a memory object that
|
|
|
|
|
is already mapped.
|
|
|
|
|
|
|
|
|
|
[[memory-device-hostaccess-hazards]]
|
|
|
|
|
fname:vkMapMemory does not check whether the device memory is currently in
|
|
|
|
|
use before returning the host-accessible pointer. The application
|
|
|
|
|
must: guarantee that any previously submitted command that writes to this
|
|
|
|
|
range has completed before the host reads from or writes to that
|
|
|
|
|
range, and that any previously submitted command that reads from that
|
|
|
|
|
range has completed before the host writes to that region (see
|
|
|
|
|
<<synchronization-fences-devicewrites, here>>
|
|
|
|
|
for details on fulfilling such a guarantee). If the device memory was
|
|
|
|
|
allocated without the ename:VK_MEMORY_PROPERTY_HOST_COHERENT_BIT set,
|
|
|
|
|
these guarantees must: be made for an extended range: the application
|
|
|
|
|
must: round down the start of the range to the nearest multiple of
|
|
|
|
|
sname:VkPhysicalDeviceLimits::pname:nonCoherentAtomSize, and round the end
|
|
|
|
|
of the range up to the nearest multiple of
|
|
|
|
|
sname:VkPhysicalDeviceLimits::pname:nonCoherentAtomSize.
|
|
|
|
|
|
|
|
|
|
While a range of device memory is mapped for host access, the application
|
|
|
|
|
is responsible for synchronizing both device and host access to that memory
|
|
|
|
|
range.
|
|
|
|
|
|
|
|
|
|
[NOTE]
|
|
|
|
|
.Note
|
|
|
|
|
====
|
|
|
|
|
It is important for the application developer to become meticulously
|
|
|
|
|
familiar with all of the mechanisms described in the chapter on
|
|
|
|
|
<<synchronization, Synchronization and Cache Control>> as they are crucial
|
|
|
|
|
to maintaining memory access ordering.
|
|
|
|
|
====
|
2016-02-16 09:53:44 +00:00
|
|
|
|
|
|
|
|
include::../validity/protos/vkMapMemory.txt[]
|
|
|
|
|
|
2016-07-11 01:13:41 +00:00
|
|
|
|
2016-02-16 09:53:44 +00:00
|
|
|
See Also
|
|
|
|
|
--------
|
|
|
|
|
|
Change log for July 15, 2016 Vulkan 1.0.21 spec update:
* Bump API patch number and header version number to 21 for this update.
Github Issues:
* Clarify how <<features-supported-sample-counts,sample count queries>>
relate to the limits in slink:VkPhysicalDeviceLimits. (public issue
185).
* Clarify in the <<interfaces-iointerfaces,Shader Input and Output
Interfaces>> section that shader output variables have undefined values
until the shader writes to them (public issue 240).
* Specify the implicit value of image parameters that cannot be set in
slink:VkSwapchainCreateInfo::pname:flags, pname:imageType,
pname:mipLevels, pname:samples, pname:tiling, and pname:initialLayout
(public issue 243).
* Make use of code:NULL and code:VK_NULL_HANDLE consistent in the
VK_KHR_swapchain extension (public issue 276).
Internal Issues:
* Clarify that presenting an image to a display surface swapchain applies
the display surface's mode, and that destroying a display surface
swapchain may reset the display's mode, in the VK_KHR_display_swapchain
extension (internal issue 247).
* Better describe what a slink:VkSurfaceKHR is, and that creating one does
not set a mode, in the VK_KHR_display extension. This is a round-about
way of pointing out that mode setting is not covered by the extension,
but rather is performed as a side effect of presentation (internal issue
247).
* Add more valid usage statements to flink:vkQueuePresentKHR command when
the VK_KHR_display_swapchain extension is present (internal issue
247).
* Add more includes to the VK_KHR_swapchain extension to better document
interactions with VK_KHR_display_swapchain (internal issue 247).
* Clarify restrictions on location aliasing in the
<<fxvertex,Fixed-Function Vertex Processing>> section (internal issue
370).
* Add mathematical description of blitting to flink:vkCmdBlitImage, and
link it to the <<textures,Image Operations>> chapter. Use mathematical
notation for ranges of texel coordinates in the <<textures,Image
Operations>> chapter. Fixed miscellaneous validity statements for
flink:vkCmdBlit and slink:VkImageBlit (internal issue 382).
Other Commits:
* Added a valid usage rule to flink:VkGraphicsPipelineCreateInfo that the
ename:VK_PRIMITIVE_TOPOLOGY_PATCH_LIST topology must only be used when
tessellation shaders are used.
* Expand the style guide into a formal "Procedures and Conventions"
document. Add a API Naming Conventions section, move most of the API
Specification Appendix C (Layers and Extensions) content into the new
document, and define the resulting procedures as mandatory (where
relevant). This more clearly separates use vs. specification of Vulkan
APIs.
* Update vk_platform.h to handle 32-bit ARMv8 binaries.
* Various minor cleanups to the Makefile and build process.
2016-07-16 02:05:43 +00:00
|
|
|
slink:VkDevice, slink:VkDeviceMemory, basetype:VkDeviceSize, elink:VkMemoryMapFlags
|
2016-07-11 01:13:41 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Document Notes
|
|
|
|
|
--------------
|
|
|
|
|
|
|
|
|
|
For more information, see the Vulkan Specification at URL
|
|
|
|
|
|
|
|
|
|
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkMapMemory
|
|
|
|
|
|
|
|
|
|
This page is extracted from the Vulkan Specification.
|
|
|
|
|
Fixes and changes should be made to the Specification,not directly.
|
2016-02-16 09:53:44 +00:00
|
|
|
|
|
|
|
|
include::footer.txt[]
|
2016-07-11 01:13:41 +00:00
|
|
|
|