Skip to content

Commit fa87ae3

Browse files
Small addition to documentation.
1 parent ad0989b commit fa87ae3

3 files changed

Lines changed: 135 additions & 130 deletions

File tree

docs/html/general_considerations.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@ <h1><a class="anchor" id="general_considerations_features_not_supported"></a>
113113
<li>Support for sparse binding and sparse residency. You can still use these features (when supported by the device) with VMA. You just need to do it yourself. Any explicit support for sparse binding/residency would rather require another, higher-level library on top of VMA.</li>
114114
<li>Data transfer - issuing commands that transfer data between buffers or images, any usage of <code>VkCommandList</code> or <code>VkQueue</code> and related synchronization is responsibility of the user.</li>
115115
<li>Allocations for imported/exported external memory. They tend to require explicit memory type index and dedicated allocation anyway, so they don't interact with main features of this library. Such special purpose allocations should be made manually, using <code>vkCreateBuffer()</code> and <code>vkAllocateMemory()</code>.</li>
116+
<li>Handling CPU memory allocation failures. When dynamically creating small C++ objects in CPU memory (not Vulkan memory), allocation failures are not checked and handled gracefully, because that would complicate code significantly and is usually not needed in desktop PC applications anyway.</li>
116117
<li>Support for any programming languages other than C/C++. Bindings to other languages are welcomed as external projects. </li>
117118
</ul>
118119
</div></div><!-- contents -->

docs/html/vk__mem__alloc_8h_source.html

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

src/vk_mem_alloc.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1452,6 +1452,10 @@ Features deliberately excluded from the scope of this library:
14521452
explicit memory type index and dedicated allocation anyway, so they don't
14531453
interact with main features of this library. Such special purpose allocations
14541454
should be made manually, using `vkCreateBuffer()` and `vkAllocateMemory()`.
1455+
- Handling CPU memory allocation failures. When dynamically creating small C++
1456+
objects in CPU memory (not Vulkan memory), allocation failures are not checked
1457+
and handled gracefully, because that would complicate code significantly and
1458+
is usually not needed in desktop PC applications anyway.
14551459
- Support for any programming languages other than C/C++.
14561460
Bindings to other languages are welcomed as external projects.
14571461

0 commit comments

Comments
 (0)