From 20b9bc533418b2e57bd4f0c5dea968621d57e654 Mon Sep 17 00:00:00 2001
From: Adam Sawicki <adam.sawicki@amd.com>
Date: Wed, 23 Feb 2022 16:21:16 +0100
Subject: [PATCH] Minor fixes in documentation of defragmentation

---
 docs/html/defragmentation.html | 8 ++++++--
 include/vk_mem_alloc.h         | 8 ++++++--
 2 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/docs/html/defragmentation.html b/docs/html/defragmentation.html
index 5c9a878..e63de25 100644
--- a/docs/html/defragmentation.html
+++ b/docs/html/defragmentation.html
@@ -70,7 +70,7 @@ $(function() {
 </div><!--header-->
 <div class="contents">
 <div class="textblock"><p >Interleaved allocations and deallocations of many objects of varying size can cause fragmentation over time, which can lead to a situation where the library is unable to find a continuous range of free memory for a new allocation despite there is enough free space, just scattered across many small free ranges between existing allocations.</p>
-<p >To mitigate this problem, you can use defragmentation feature. It doesn't happen automatically thought and needs your cooperation, because VMA is a low level library that only allocates memory. It cannot recreate buffers and images in a new place as it doesn't remember the contents of <code>VkBufferCreateInfo</code> / <code>VkImageCreateInfo</code> structures. It cannot copy their contents as it doesn't record any commands to a command buffer.</p>
+<p >To mitigate this problem, you can use defragmentation feature. It doesn't happen automatically though and needs your cooperation, because VMA is a low level library that only allocates memory. It cannot recreate buffers and images in a new place as it doesn't remember the contents of <code>VkBufferCreateInfo</code> / <code>VkImageCreateInfo</code> structures. It cannot copy their contents as it doesn't record any commands to a command buffer.</p>
 <p >Example:</p>
 <div class="fragment"><div class="line"><a class="code hl_struct" href="struct_vma_defragmentation_info.html">VmaDefragmentationInfo</a> defragInfo = {};</div>
 <div class="line">defragInfo.<a class="code hl_variable" href="struct_vma_defragmentation_info.html#a18dd2097d8ab2976cdc7dd3e7b978bd4">pool</a> = myPool;</div>
@@ -96,7 +96,11 @@ $(function() {
 <div class="line">        }</div>
 <div class="line">        <span class="comment">//- Make sure the copy commands finished executing.</span></div>
 <div class="line">        <span class="comment">//- Update appropriate descriptors to point to the new places.</span></div>
-<div class="line">        <a class="code hl_function" href="group__group__alloc.html#gaded05a445742a00718ee766144c5c226">vmaEndDefragmentationPass</a>(allocator, defragCtx, &amp;pass);</div>
+<div class="line">        res = <a class="code hl_function" href="group__group__alloc.html#gaded05a445742a00718ee766144c5c226">vmaEndDefragmentationPass</a>(allocator, defragCtx, &amp;pass);</div>
+<div class="line">        <span class="keywordflow">if</span>(res == VK_SUCCESS)</div>
+<div class="line">            <span class="keywordflow">break</span>;</div>
+<div class="line">        <span class="keywordflow">else</span> <span class="keywordflow">if</span>(res != VK_INCOMPLETE)</div>
+<div class="line">            <span class="comment">// Handle error...</span></div>
 <div class="line">    }</div>
 <div class="line">    <span class="keywordflow">else</span></div>
 <div class="line">        <span class="comment">// Handle error...</span></div>
diff --git a/include/vk_mem_alloc.h b/include/vk_mem_alloc.h
index af82f3b..48e61d3 100644
--- a/include/vk_mem_alloc.h
+++ b/include/vk_mem_alloc.h
@@ -17939,7 +17939,7 @@ enough free space, just scattered across many small free ranges between existing
 allocations.
 
 To mitigate this problem, you can use defragmentation feature.
-It doesn't happen automatically thought and needs your cooperation,
+It doesn't happen automatically though and needs your cooperation,
 because VMA is a low level library that only allocates memory.
 It cannot recreate buffers and images in a new place as it doesn't remember the contents of `VkBufferCreateInfo` / `VkImageCreateInfo` structures.
 It cannot copy their contents as it doesn't record any commands to a command buffer.
@@ -17971,7 +17971,11 @@ for(;;)
         }
         //- Make sure the copy commands finished executing.
         //- Update appropriate descriptors to point to the new places.
-        vmaEndDefragmentationPass(allocator, defragCtx, &pass);
+        res = vmaEndDefragmentationPass(allocator, defragCtx, &pass);
+        if(res == VK_SUCCESS)
+            break;
+        else if(res != VK_INCOMPLETE)
+            // Handle error...
     }
     else
         // Handle error...