mirror/VulkanMemoryAllocator
1
0
Fork 0
mirror of https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator.git synced 2024-11-10 02:31:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Small addition to documentation.

Browse Source
This commit is contained in:
Adam Sawicki 2018-10-15 18:15:11 +02:00
parent ad0989bfb4
commit fa87ae34a6
3 changed files with 135 additions and 130 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/html/general_considerations.html
View File

@ -113,6 +113,7 @@ Features not supported</h1>
<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> <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>
<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> <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>
<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> <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>
<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>
<li>Support for any programming languages other than C/C++. Bindings to other languages are welcomed as external projects. </li> <li>Support for any programming languages other than C/C++. Bindings to other languages are welcomed as external projects. </li>
</ul> </ul>
</div></div><!-- contents --> </div></div><!-- contents -->

260
docs/html/vk__mem__alloc_8h_source.html
View File

File diff suppressed because one or more lines are too long

4
src/vk_mem_alloc.h
View File

@ -1452,6 +1452,10 @@ Features deliberately excluded from the scope of this library:
explicit memory type index and dedicated allocation anyway, so they don't explicit memory type index and dedicated allocation anyway, so they don't
interact with main features of this library. Such special purpose allocations interact with main features of this library. Such special purpose allocations
should be made manually, using `vkCreateBuffer()` and `vkAllocateMemory()`. should be made manually, using `vkCreateBuffer()` and `vkAllocateMemory()`.
- 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.
- Support for any programming languages other than C/C++. - Support for any programming languages other than C/C++.
Bindings to other languages are welcomed as external projects. Bindings to other languages are welcomed as external projects.