Version 3.1.0

Rebuilt the documentation and sample executable.

Author: adam-sawicki-a

.gitignore

@@ -1,5 +1,6 @@
 /bin/*
 /build/*
 !/bin/VmaSample_Release_vs2019.exe
+!/bin/VmaSample_Release_vs2022.exe
 !/bin/Shader*.spv
 .vscode/

CHANGELOG.md

@@ -1,4 +1,4 @@
-# 3.1.0 (TBD)
+# 3.1.0 (2024-05-27)
 
 This release gathers fixes and improvements made during many months of continuous development on the main branch, mostly based on issues and pull requests on GitHub.
 

README.md

@@ -146,7 +146,7 @@ The VulkanMemoryAllocator port in vcpkg is kept up to date by Microsoft team mem
 
 # Binaries
 
-The release comes with precompiled binary executable for "VulkanSample" application which contains test suite. It is compiled using Visual Studio 2019, so it requires appropriate libraries to work, including "MSVCP140.dll", "VCRUNTIME140.dll", "VCRUNTIME140_1.dll". If the launch fails with error message telling about those files missing, please download and install [Microsoft Visual C++ Redistributable for Visual Studio 2015, 2017 and 2019](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads), "x64" version.
+The release comes with precompiled binary executable for "VulkanSample" application which contains test suite. It is compiled using Visual Studio 2022, so it requires appropriate libraries to work, including "MSVCP140.dll", "VCRUNTIME140.dll", "VCRUNTIME140_1.dll". If the launch fails with error message telling about those files missing, please download and install [Microsoft Visual C++ Redistributable](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads), "X64" version.
 
 # Read more
 

bin/VmaSample_Release_vs2019.exe

@@ -182,7 +182,7 @@ <h1><a class="anchor" id="custom_memory_pools_when_not_use"></a>
 </ul>
 <p>Many of the common concerns can be addressed in a different way than using custom pools:</p>
 <ul>
-<li>If you want to keep your allocations of certain size (small versus large) or certain lifetime (transient versus long lived) separate, you likely don't need to. VMA uses a high quality allocation algorithm that manages memory well in various cases. Please mesure and check if using custom pools provides a benefit.</li>
+<li>If you want to keep your allocations of certain size (small versus large) or certain lifetime (transient versus long lived) separate, you likely don't need to. VMA uses a high quality allocation algorithm that manages memory well in various cases. Please measure and check if using custom pools provides a benefit.</li>
 <li>If you want to keep your images and buffers separate, you don't need to. VMA respects <code>bufferImageGranularity</code> limit automatically.</li>
 <li>If you want to keep your mapped and not mapped allocations separate, you don't need to. VMA respects <code>nonCoherentAtomSize</code> limit automatically. It also maps only those <code>VkDeviceMemory</code> blocks that need to map any allocation. It even tries to keep mappable and non-mappable allocations in separate blocks to minimize the amount of mapped memory.</li>
 <li>If you want to choose a custom size for the default memory block, you can set it globally instead using <a class="el" href="struct_vma_allocator_create_info.html#a8e4714298e3121cdd8b214a1ae7a637a" title="Preferred size of a single VkDeviceMemory block to be allocated from large heaps &gt; 1 GiB....">VmaAllocatorCreateInfo::preferredLargeHeapBlockSize</a>.</li>

bin/VmaSample_Release_vs2022.exe

@@ -2216,7 +2216,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac3dd00da721875ed99fa8a8
     <tr><td class="paramname">allocator</td><td></td></tr>
     <tr><td class="paramname">allocationCount</td><td></td></tr>
     <tr><td class="paramname">allocations</td><td></td></tr>
-    <tr><td class="paramname">offsets</td><td>If not null, it must point to an array of offsets of regions to flush, relative to the beginning of respective allocations. Null means all ofsets are zero. </td></tr>
+    <tr><td class="paramname">offsets</td><td>If not null, it must point to an array of offsets of regions to flush, relative to the beginning of respective allocations. Null means all offsets are zero. </td></tr>
     <tr><td class="paramname">sizes</td><td>If not null, it must point to an array of sizes of regions to flush in respective allocations. Null means <code>VK_WHOLE_SIZE</code> for all allocations.</td></tr>
   </table>
   </dd>
@@ -2481,7 +2481,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gab25b558d75f7378ec944a15
     <tr><td class="paramname">allocator</td><td></td></tr>
     <tr><td class="paramname">allocationCount</td><td></td></tr>
     <tr><td class="paramname">allocations</td><td></td></tr>
-    <tr><td class="paramname">offsets</td><td>If not null, it must point to an array of offsets of regions to flush, relative to the beginning of respective allocations. Null means all ofsets are zero. </td></tr>
+    <tr><td class="paramname">offsets</td><td>If not null, it must point to an array of offsets of regions to flush, relative to the beginning of respective allocations. Null means all offsets are zero. </td></tr>
     <tr><td class="paramname">sizes</td><td>If not null, it must point to an array of sizes of regions to flush in respective allocations. Null means <code>VK_WHOLE_SIZE</code> for all allocations.</td></tr>
   </table>
   </dd>

docs/html/custom_memory_pools.html

@@ -74,7 +74,7 @@
   <div class="headertitle"><div class="title">Vulkan Memory Allocator </div></div>
 </div><!--header-->
 <div class="contents">
-<div class="textblock"><p><b>Version 3.1.0-development</b></p>
+<div class="textblock"><p><b>Version 3.1.0</b></p>
 <p>Copyright (c) 2017-2024 Advanced Micro Devices, Inc. All rights reserved. <br  />
 License: MIT <br  />
 See also: <a href="https://gpuopen.com/gaming-product/vulkan-memory-allocator/">product page on GPUOpen</a>, <a href="https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator">repository on GitHub</a></p>

docs/html/globals_defs.html

@@ -133,7 +133,7 @@ <h2><a class="anchor" id="quick_start_initialization_importing_vulkan_functions"
 </ol>
 <h2><a class="anchor" id="quick_start_initialization_enabling_extensions"></a>
 Enabling extensions</h2>
-<p>VMA can automatically use following Vulkan extensions. If you found them availeble on the selected physical device and you enabled them while creating <code>VkInstance</code> / <code>VkDevice</code> object, inform VMA about their availability by setting appropriate flags in <a class="el" href="struct_vma_allocator_create_info.html#a392ea2ecbaff93f91a7c49f735ad4346" title="Flags for created allocator. Use VmaAllocatorCreateFlagBits enum.">VmaAllocatorCreateInfo::flags</a>.</p>
+<p>VMA can automatically use following Vulkan extensions. If you found them available on the selected physical device and you enabled them while creating <code>VkInstance</code> / <code>VkDevice</code> object, inform VMA about their availability by setting appropriate flags in <a class="el" href="struct_vma_allocator_create_info.html#a392ea2ecbaff93f91a7c49f735ad4346" title="Flags for created allocator. Use VmaAllocatorCreateFlagBits enum.">VmaAllocatorCreateInfo::flags</a>.</p>
 <table class="markdownTable">
 <tr class="markdownTableHead">
 <th class="markdownTableHeadNone">Vulkan extension   </th><th class="markdownTableHeadNone">VMA flag    </th></tr>

docs/html/group__group__alloc.html

@@ -128,7 +128,7 @@ <h1><a class="anchor" id="vk_ext_memory_priority_usage"></a>
 <div class="ttc" id="astruct_vma_allocation_html"><div class="ttname"><a href="struct_vma_allocation.html">VmaAllocation</a></div><div class="ttdoc">Represents single memory allocation.</div></div>
 </div><!-- fragment --><p><code>priority</code> member is ignored in the following situations:</p>
 <ul>
-<li>Allocations created in custom pools: They inherit the priority, along with all other allocation parameters from the parametrs passed in <a class="el" href="struct_vma_pool_create_info.html" title="Describes parameter of created VmaPool.">VmaPoolCreateInfo</a> when the pool was created.</li>
+<li>Allocations created in custom pools: They inherit the priority, along with all other allocation parameters from the parameters passed in <a class="el" href="struct_vma_pool_create_info.html" title="Describes parameter of created VmaPool.">VmaPoolCreateInfo</a> when the pool was created.</li>
 <li>Allocations created in default pools: They inherit the priority from the parameters VMA used when creating default pools, which means <code>priority == 0.5f</code>. </li>
 </ul>
 </div></div><!-- contents -->

docs/html/index.html

@@ -25,7 +25,7 @@
 
 /** \mainpage Vulkan Memory Allocator
 
-<b>Version 3.1.0-development</b>
+<b>Version 3.1.0</b>
 
 Copyright (c) 2017-2024 Advanced Micro Devices, Inc. All rights reserved. \n
 License: MIT \n

docs/html/quick_start.html

@@ -35,8 +35,8 @@ static const char* const SHADER_PATH1 = "./";
 static const char* const SHADER_PATH2 = "../bin/";
 static const wchar_t* const WINDOW_CLASS_NAME = L"VULKAN_MEMORY_ALLOCATOR_SAMPLE";
 static const char* const VALIDATION_LAYER_NAME = "VK_LAYER_KHRONOS_validation";
-static const char* const APP_TITLE_A =     "Vulkan Memory Allocator Sample 3.0.1";
-static const wchar_t* const APP_TITLE_W = L"Vulkan Memory Allocator Sample 3.0.1";
+static const char* const APP_TITLE_A =     "Vulkan Memory Allocator Sample 3.1.0";
+static const wchar_t* const APP_TITLE_W = L"Vulkan Memory Allocator Sample 3.1.0";
 
 static const bool VSYNC = true;
 static const uint32_t COMMAND_BUFFER_COUNT = 2;