Skip to content

Commit 3b39225

Browse files
Documentation: Added mention of VK_AMD_memory_overallocation_behavior extension.
1 parent df2404b commit 3b39225

File tree

3 files changed

+91
-90
lines changed

3 files changed

+91
-90
lines changed

docs/html/struct_vma_allocator_create_info.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a31c192aa6cbffa33279f6d9f
216216
<li>If user tries to allocate more memory from that heap using this allocator, the allocation fails with <code>VK_ERROR_OUT_OF_DEVICE_MEMORY</code>.</li>
217217
<li>If the limit is smaller than heap size reported in <code>VkMemoryHeap::size</code>, the value of this limit will be reported instead when using <a class="el" href="vk__mem__alloc_8h.html#ab88db292a17974f911182543fda52d19">vmaGetMemoryProperties()</a>.</li>
218218
</ul>
219-
<p>Warning! Using this feature may not be equivalent to installing a GPU with smaller amount of memory, because graphics driver doesn't necessary fail new allocations with <code>VK_ERROR_OUT_OF_DEVICE_MEMORY</code> result when memory capacity is exceeded. It may return success and just silently migrate some device memory blocks to system RAM. </p>
219+
<p>Warning! Using this feature may not be equivalent to installing a GPU with smaller amount of memory, because graphics driver doesn't necessary fail new allocations with <code>VK_ERROR_OUT_OF_DEVICE_MEMORY</code> result when memory capacity is exceeded. It may return success and just silently migrate some device memory blocks to system RAM. This driver behavior can also be controlled using VK_AMD_memory_overallocation_behavior extension. </p>
220220

221221
</div>
222222
</div>

docs/html/vk__mem__alloc_8h_source.html

Lines changed: 88 additions & 88 deletions
Large diffs are not rendered by default.

src/vk_mem_alloc.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1688,7 +1688,8 @@ typedef struct VmaAllocatorCreateInfo
16881688
smaller amount of memory, because graphics driver doesn't necessary fail new
16891689
allocations with `VK_ERROR_OUT_OF_DEVICE_MEMORY` result when memory capacity is
16901690
exceeded. It may return success and just silently migrate some device memory
1691-
blocks to system RAM.
1691+
blocks to system RAM. This driver behavior can also be controlled using
1692+
VK_AMD_memory_overallocation_behavior extension.
16921693
*/
16931694
const VkDeviceSize* pHeapSizeLimit;
16941695
/** \brief Pointers to Vulkan functions. Can be null if you leave define `VMA_STATIC_VULKAN_FUNCTIONS 1`.

0 commit comments

Comments
 (0)