commit b0e97e5859cf2fb8caced58d88e7cb63cb3d2101
author Adam Sawicki <adam.sawicki@amd.com> Tue Jul 28 10:15:04 2020 +0200
committer GitHub <noreply@github.com> Tue Jul 28 10:15:04 2020 +0200
tree 2424e25c1acf0a2dae2194513a5c682f28a2a422
parent db4c1639bf30c51bbddcd813c6521b3473afa1a1
parent 67bf13cd085e6eaee0d5a0167b9ed30ea3194443

Merge pull request #141 from dkorkmazturk/master

Fix a typo in the explanation of VMA_ALLOCATION_CREATE_MAPPED_BIT

docs/html/vk__mem__alloc_8h.html

diff --git a/docs/html/vk__mem__alloc_8h.html b/docs/html/vk__mem__alloc_8h.html
index f0a0d00..ef09f0f 100644
--- a/docs/html/vk__mem__alloc_8h.html
+++ b/docs/html/vk__mem__alloc_8h.html
@@ -1069,7 +1069,7 @@
 </td></tr>
 <tr><td class="fieldname"><a id="ad9889c10c798b040d59c92f257cae597a11da372cc3a82931c5e5d6146cd9dd1f"></a>VMA_ALLOCATION_CREATE_MAPPED_BIT&#160;</td><td class="fielddoc"><p>Set this flag to use a memory that will be persistently mapped and retrieve pointer to it. </p>
 <p>Pointer to mapped memory will be returned through <a class="el" href="struct_vma_allocation_info.html#a5eeffbe2d2f30f53370ff14aefbadbe2" title="Pointer to the beginning of this allocation as mapped data.">VmaAllocationInfo::pMappedData</a>.</p>
-<p>Is it valid to use this flag for allocation made from memory type that is not <code>HOST_VISIBLE</code>. This flag is then ignored and memory is not mapped. This is useful if you need an allocation that is efficient to use on GPU (<code>DEVICE_LOCAL</code>) and still want to map it directly if possible on platforms that support it (e.g. Intel GPU).</p>
+<p>It is valid to use this flag for allocation made from memory type that is not <code>HOST_VISIBLE</code>. This flag is then ignored and memory is not mapped. This is useful if you need an allocation that is efficient to use on GPU (<code>DEVICE_LOCAL</code>) and still want to map it directly if possible on platforms that support it (e.g. Intel GPU).</p>
 <p>You should not use this flag together with <a class="el" href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a5f436af6c8fe8540573a6d22627a6fd2">VMA_ALLOCATION_CREATE_CAN_BECOME_LOST_BIT</a>. </p>
 </td></tr>
 <tr><td class="fieldname"><a id="ad9889c10c798b040d59c92f257cae597a5f436af6c8fe8540573a6d22627a6fd2"></a>VMA_ALLOCATION_CREATE_CAN_BECOME_LOST_BIT&#160;</td><td class="fielddoc"><p>Allocation created with this flag can become lost as a result of another allocation with <a class="el" href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a68686d0ce9beb0d4d1b9f2b8b1389a7e">VMA_ALLOCATION_CREATE_CAN_MAKE_OTHER_LOST_BIT</a> flag, so you must check it before use.</p>

src/vk_mem_alloc.h

diff --git a/src/vk_mem_alloc.h b/src/vk_mem_alloc.h
index 5a1f2da..33b6db4 100644
--- a/src/vk_mem_alloc.h
+++ b/src/vk_mem_alloc.h
@@ -2644,7 +2644,7 @@
     

     Pointer to mapped memory will be returned through VmaAllocationInfo::pMappedData.

 

-    Is it valid to use this flag for allocation made from memory type that is not

+    It is valid to use this flag for allocation made from memory type that is not

     `HOST_VISIBLE`. This flag is then ignored and memory is not mapped. This is

     useful if you need an allocation that is efficient to use on GPU

     (`DEVICE_LOCAL`) and still want to map it directly if possible on platforms that