From 938b19a8c14dc0b72576de2f5da6988274d3fe52 Mon Sep 17 00:00:00 2001 From: Adam Sawicki Date: Mon, 1 Jul 2019 12:12:51 +0200 Subject: [PATCH] =?UTF-8?q?Minor=20addition=20in=20documentation,=20"Confi?= =?UTF-8?q?guration=E2=80=9D=20section?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See #67 --- docs/html/configuration.html | 3 +- docs/html/general_considerations.html | 2 +- docs/html/vk__mem__alloc_8h_source.html | 294 ++++++++++++------------ src/vk_mem_alloc.h | 5 + 4 files changed, 155 insertions(+), 149 deletions(-) diff --git a/docs/html/configuration.html b/docs/html/configuration.html index 1a81bca..e051d07 100644 --- a/docs/html/configuration.html +++ b/docs/html/configuration.html @@ -70,6 +70,7 @@ $(function() {

Please check "CONFIGURATION SECTION" in the code to find macros that you can define before each include of this file or change directly in this file to provide your own implementation of basic facilities like assert, min() and max() functions, mutex, atomic etc. The library uses its own implementation of containers by default, but you can switch to using STL containers instead.

+

For example, define VMA_ASSERT(expr) before including the library to provide custom implementation of the assertion, compatible with your project. By default it is defined to standard C assert(expr) in _DEBUG configuration and empty otherwise.

Pointers to Vulkan functions

The library uses Vulkan functions straight from the vulkan.h header by default. If you want to provide your own pointers to these functions, e.g. fetched using vkGetInstanceProcAddr() and vkGetDeviceProcAddr():

@@ -86,7 +87,7 @@ Device memory allocation callbacks

Device heap memory limit

When device memory of certain heap runs out of free space, new allocations may fail (returning error code) or they may succeed, silently pushing some existing memory blocks from GPU VRAM to system RAM (which degrades performance). This behavior is implementation-dependant - it depends on GPU vendor and graphics driver.

-

On AMD cards it can be controlled while creating Vulkan device object by using VK_AMD_memory_allocation_behavior extension, if available.

+

On AMD cards it can be controlled while creating Vulkan device object by using VK_AMD_memory_overallocation_behavior extension, if available.

Alternatively, if you want to test how your program behaves with limited amount of Vulkan device memory available without switching your graphics card to one that really has smaller VRAM, you can use a feature of this library intended for this purpose. To do it, fill optional member VmaAllocatorCreateInfo::pHeapSizeLimit.

diff --git a/docs/html/general_considerations.html b/docs/html/general_considerations.html index 560a6ea..c3d4e24 100644 --- a/docs/html/general_considerations.html +++ b/docs/html/general_considerations.html @@ -111,7 +111,7 @@ Allocation algorithm Features not supported

Features deliberately excluded from the scope of this library: