Skip to content

Commit 1ea5f2f

Browse files
Rebuilt the documentation
1 parent fc2cea5 commit 1ea5f2f

12 files changed

+33
-33
lines changed

docs/html/choosing_memory_type.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ <h1><a class="anchor" id="choosing_memory_type_explicit_memory_types"></a>
163163
<div class="fragment"><div class="line">uint32_t memoryTypeIndex = 2;</div>
164164
<div class="line"> </div>
165165
<div class="line"><a class="code hl_struct" href="struct_vma_allocation_create_info.html">VmaAllocationCreateInfo</a> allocInfo = {};</div>
166-
<div class="line">allocInfo.<a class="code hl_variable" href="struct_vma_allocation_create_info.html#a3bf940c0271d85d6ba32a4d820075055">memoryTypeBits</a> = 1u &lt;&lt; memoryTypeIndex;</div>
166+
<div class="line">allocInfo.<a class="code hl_variable" href="struct_vma_allocation_create_info.html#a3bf940c0271d85d6ba32a4d820075055">memoryTypeBits</a> = 1U &lt;&lt; memoryTypeIndex;</div>
167167
<div class="line"> </div>
168168
<div class="line">VkBuffer buffer;</div>
169169
<div class="line"><a class="code hl_struct" href="struct_vma_allocation.html">VmaAllocation</a> allocation;</div>
@@ -174,7 +174,7 @@ <h1><a class="anchor" id="choosing_memory_type_explicit_memory_types"></a>
174174
<div class="line">uint32_t excludedMemoryTypeIndex = 2;</div>
175175
<div class="line"><a class="code hl_struct" href="struct_vma_allocation_create_info.html">VmaAllocationCreateInfo</a> allocInfo = {};</div>
176176
<div class="line">allocInfo.<a class="code hl_variable" href="struct_vma_allocation_create_info.html#accb8b06b1f677d858cb9af20705fa910">usage</a> = <a class="code hl_enumvalue" href="group__group__alloc.html#ggaa5846affa1e9da3800e3e78fae2305cca27cde9026a84d34d525777baa41fce6e">VMA_MEMORY_USAGE_AUTO</a>;</div>
177-
<div class="line">allocInfo.<a class="code hl_variable" href="struct_vma_allocation_create_info.html#a3bf940c0271d85d6ba32a4d820075055">memoryTypeBits</a> = ~(1u &lt;&lt; excludedMemoryTypeIndex);</div>
177+
<div class="line">allocInfo.<a class="code hl_variable" href="struct_vma_allocation_create_info.html#a3bf940c0271d85d6ba32a4d820075055">memoryTypeBits</a> = ~(1U &lt;&lt; excludedMemoryTypeIndex);</div>
178178
<div class="line"><span class="comment">// ...</span></div>
179179
</div><!-- fragment --><h1><a class="anchor" id="choosing_memory_type_custom_memory_pools"></a>
180180
Custom memory pools</h1>

docs/html/custom_memory_pools.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@
124124
<div class="line"><span class="comment">// Create a pool that can have at most 2 blocks, 128 MiB each.</span></div>
125125
<div class="line"><a class="code hl_struct" href="struct_vma_pool_create_info.html">VmaPoolCreateInfo</a> poolCreateInfo = {};</div>
126126
<div class="line">poolCreateInfo.<a class="code hl_variable" href="struct_vma_pool_create_info.html#a596fa76b685d3f1f688f84a709a5b319">memoryTypeIndex</a> = memTypeIndex;</div>
127-
<div class="line">poolCreateInfo.<a class="code hl_variable" href="struct_vma_pool_create_info.html#aa4265160536cdb9be821b7686c16c676">blockSize</a> = 128ull * 1024 * 1024;</div>
127+
<div class="line">poolCreateInfo.<a class="code hl_variable" href="struct_vma_pool_create_info.html#aa4265160536cdb9be821b7686c16c676">blockSize</a> = 128ULL * 1024 * 1024;</div>
128128
<div class="line">poolCreateInfo.<a class="code hl_variable" href="struct_vma_pool_create_info.html#ae41142f2834fcdc82baa4883c187b75c">maxBlockCount</a> = 2;</div>
129129
<div class="line"> </div>
130130
<div class="line"><a class="code hl_struct" href="struct_vma_pool.html">VmaPool</a> pool;</div>
@@ -199,7 +199,7 @@ <h1><a class="anchor" id="custom_memory_pools_when_not_use"></a>
199199
<li>If you want to keep your images and buffers separate, you don't need to. VMA respects <code>bufferImageGranularity</code> limit automatically.</li>
200200
<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>
201201
<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>
202-
<li>If you want to select specific memory type for your allocation, you can set <a class="el" href="struct_vma_allocation_create_info.html#a3bf940c0271d85d6ba32a4d820075055" title="Bitmask containing one bit set for every memory type acceptable for this allocation.">VmaAllocationCreateInfo::memoryTypeBits</a> to <code>(1u &lt;&lt; myMemoryTypeIndex)</code> instead.</li>
202+
<li>If you want to select specific memory type for your allocation, you can set <a class="el" href="struct_vma_allocation_create_info.html#a3bf940c0271d85d6ba32a4d820075055" title="Bitmask containing one bit set for every memory type acceptable for this allocation.">VmaAllocationCreateInfo::memoryTypeBits</a> to <code>(1U &lt;&lt; myMemoryTypeIndex)</code> instead.</li>
203203
<li>If you need to create a buffer with certain minimum alignment, you can still do it using default pools with dedicated function <a class="el" href="group__group__alloc.html#gaa06a690013a0d01e60894ac378083834" title="Creates a buffer with additional minimum alignment.">vmaCreateBufferWithAlignment()</a>.</li>
204204
</ul>
205205
<h1><a class="anchor" id="linear_algorithm"></a>
@@ -211,7 +211,7 @@ <h1><a class="anchor" id="linear_algorithm"></a>
211211
<p>With this one flag, you can create a custom pool that can be used in many ways: free-at-once, stack, double stack, and ring buffer. See below for details. You don't need to specify explicitly which of these options you are going to use - it is detected automatically.</p>
212212
<h2><a class="anchor" id="linear_algorithm_free_at_once"></a>
213213
Free-at-once</h2>
214-
<p>In a pool that uses linear algorithm, you still need to free all the allocations individually, e.g. by using <a class="el" href="group__group__alloc.html#ga5fea5518972ae9094b1526cbcb19b05f" title="Frees memory previously allocated using vmaAllocateMemory(), vmaAllocateMemoryForBuffer(),...">vmaFreeMemory()</a> or <a class="el" href="group__group__alloc.html#ga0d9f4e4ba5bf9aab1f1c746387753d77" title="Destroys Vulkan buffer and frees allocated memory.">vmaDestroyBuffer()</a>. You can free them in any order. New allocations are always made after last one - free space in the middle is not reused. However, when you release all the allocation and the pool becomes empty, allocation starts from the beginning again. This way you can use linear algorithm to speed up creation of allocations that you are going to release all at once.</p>
214+
<p>In a pool that uses linear algorithm, you still need to free all the allocations individually, e.g. by using <a class="el" href="group__group__alloc.html#ga11f0fbc034fa81a4efedd73d61ce7568" title="Frees memory previously allocated using vmaAllocateMemory(), vmaAllocateMemoryForBuffer(),...">vmaFreeMemory()</a> or <a class="el" href="group__group__alloc.html#ga0d9f4e4ba5bf9aab1f1c746387753d77" title="Destroys Vulkan buffer and frees allocated memory.">vmaDestroyBuffer()</a>. You can free them in any order. New allocations are always made after last one - free space in the middle is not reused. However, when you release all the allocation and the pool becomes empty, allocation starts from the beginning again. This way you can use linear algorithm to speed up creation of allocations that you are going to release all at once.</p>
215215
<p><img src="../gfx/Linear_allocator_3_free_at_once.png" alt="Free-at-once" class="inline"/></p>
216216
<p>This mode is also available for pools created with <a class="el" href="struct_vma_pool_create_info.html#ae41142f2834fcdc82baa4883c187b75c" title="Maximum number of blocks that can be allocated in this pool. Optional.">VmaPoolCreateInfo::maxBlockCount</a> value that allows multiple memory blocks.</p>
217217
<h2><a class="anchor" id="linear_algorithm_stack"></a>

docs/html/doxygen_crawl.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@
6666
<a href="group__group__alloc.html#ga0faa3f9e5fb233d29d1e00390650febb"/>
6767
<a href="group__group__alloc.html#ga1017aa83489c0eee8d2163d2bf253f67"/>
6868
<a href="group__group__alloc.html#ga11731ec58a3a43a22bb925e0780ef405"/>
69+
<a href="group__group__alloc.html#ga11f0fbc034fa81a4efedd73d61ce7568"/>
6970
<a href="group__group__alloc.html#ga13415cc0b443353a7b5abda300b833fc"/>
7071
<a href="group__group__alloc.html#ga1405cf3eae2fd1305d645879173031a0"/>
7172
<a href="group__group__alloc.html#ga1cf7774606721026a68aabe3af2e5b50"/>
@@ -86,7 +87,6 @@
8687
<a href="group__group__alloc.html#ga59f01ca3d53d50b7cca9b442b77a3e87"/>
8788
<a href="group__group__alloc.html#ga5c8770ded7c59c8caac6de0c2cb00b50"/>
8889
<a href="group__group__alloc.html#ga5f3502dd7d38b53fb1533ea3921d038d"/>
89-
<a href="group__group__alloc.html#ga5fea5518972ae9094b1526cbcb19b05f"/>
9090
<a href="group__group__alloc.html#ga60d5d4803e3c82505a2bfddb929adb03"/>
9191
<a href="group__group__alloc.html#ga6552a65b71d16f378c6994b3ceaef50c"/>
9292
<a href="group__group__alloc.html#ga69ac829f5bb0737449fa92c2d971f1bb"/>

docs/html/globals.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ <h3><a id="index_v" name="index_v"></a>- v -</h3><ul>
217217
<li>vmaFindMemoryTypeIndexForImageInfo()&#160;:&#160;<a class="el" href="group__group__alloc.html#ga088da83d8eaf3ce9056d9ea0b981d472">vk_mem_alloc.h</a></li>
218218
<li>vmaFlushAllocation()&#160;:&#160;<a class="el" href="group__group__alloc.html#ga30c37c1eec6025f397be41644f48490f">vk_mem_alloc.h</a></li>
219219
<li>vmaFlushAllocations()&#160;:&#160;<a class="el" href="group__group__alloc.html#gac3dd00da721875ed99fa8a881922bdfc">vk_mem_alloc.h</a></li>
220-
<li>vmaFreeMemory()&#160;:&#160;<a class="el" href="group__group__alloc.html#ga5fea5518972ae9094b1526cbcb19b05f">vk_mem_alloc.h</a></li>
220+
<li>vmaFreeMemory()&#160;:&#160;<a class="el" href="group__group__alloc.html#ga11f0fbc034fa81a4efedd73d61ce7568">vk_mem_alloc.h</a></li>
221221
<li>vmaFreeMemoryPages()&#160;:&#160;<a class="el" href="group__group__alloc.html#ga834b1e4aef395c0a1d56a28e69a4a17e">vk_mem_alloc.h</a></li>
222222
<li>vmaFreeStatsString()&#160;:&#160;<a class="el" href="group__group__stats.html#ga3104eb30d8122c84dd8541063f145288">vk_mem_alloc.h</a></li>
223223
<li>vmaFreeVirtualBlockStatsString()&#160;:&#160;<a class="el" href="group__group__stats.html#ga47fb8d8aa69df4a7c23a9719b4080623">vk_mem_alloc.h</a></li>

docs/html/globals_func.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ <h3><a id="index_v" name="index_v"></a>- v -</h3><ul>
129129
<li>vmaFindMemoryTypeIndexForImageInfo()&#160;:&#160;<a class="el" href="group__group__alloc.html#ga088da83d8eaf3ce9056d9ea0b981d472">vk_mem_alloc.h</a></li>
130130
<li>vmaFlushAllocation()&#160;:&#160;<a class="el" href="group__group__alloc.html#ga30c37c1eec6025f397be41644f48490f">vk_mem_alloc.h</a></li>
131131
<li>vmaFlushAllocations()&#160;:&#160;<a class="el" href="group__group__alloc.html#gac3dd00da721875ed99fa8a881922bdfc">vk_mem_alloc.h</a></li>
132-
<li>vmaFreeMemory()&#160;:&#160;<a class="el" href="group__group__alloc.html#ga5fea5518972ae9094b1526cbcb19b05f">vk_mem_alloc.h</a></li>
132+
<li>vmaFreeMemory()&#160;:&#160;<a class="el" href="group__group__alloc.html#ga11f0fbc034fa81a4efedd73d61ce7568">vk_mem_alloc.h</a></li>
133133
<li>vmaFreeMemoryPages()&#160;:&#160;<a class="el" href="group__group__alloc.html#ga834b1e4aef395c0a1d56a28e69a4a17e">vk_mem_alloc.h</a></li>
134134
<li>vmaFreeStatsString()&#160;:&#160;<a class="el" href="group__group__stats.html#ga3104eb30d8122c84dd8541063f145288">vk_mem_alloc.h</a></li>
135135
<li>vmaFreeVirtualBlockStatsString()&#160;:&#160;<a class="el" href="group__group__stats.html#ga47fb8d8aa69df4a7c23a9719b4080623">vk_mem_alloc.h</a></li>

0 commit comments

Comments
 (0)