Vulkan-Docs/doc/specs/vulkan/man/vkInvalidateMappedMemoryRan...

63 lines
1.8 KiB
Plaintext

// 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/
vkInvalidateMappedMemoryRanges(3)
=================================
Name
----
vkInvalidateMappedMemoryRanges - Invalidate ranges of mapped memory objects.
C Specification
---------------
// refBegin vkInvalidateMappedMemoryRanges Invalidate ranges of mapped memory objects.
To invalidate ranges of non-coherent memory from the host caches, call:
include::../api/protos/vkInvalidateMappedMemoryRanges.txt[]
Parameters
----------
* pname:device is the logical device that owns the memory ranges.
* pname:memoryRangeCount is the length of the pname:pMemoryRanges array.
* pname:pMemoryRanges is a pointer to an array of
slink:VkMappedMemoryRange structures describing the memory ranges to
invalidate.
Description
-----------
fname:vkInvalidateMappedMemoryRanges must: be used to guarantee that device writes to
non-coherent memory are visible to the host. It must: be called after command buffers
that execute and flush (via memory barriers) the device writes have completed, and
before the host will read or write any of those locations. If a range of non-coherent
memory is written by the host and then invalidated without first being flushed, its
contents are undefined.
include::../validity/protos/vkInvalidateMappedMemoryRanges.txt[]
See Also
--------
slink:VkDevice, slink:VkMappedMemoryRange
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkInvalidateMappedMemoryRanges
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]