Skip to content

Commit dd48c3a

Browse files
Minor update in documentation. Regenerated Doxygen documentation.
1 parent d5d8e92 commit dd48c3a

File tree

3 files changed

+134
-133
lines changed

3 files changed

+134
-133
lines changed

docs/html/general_considerations.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ <h1><a class="anchor" id="general_considerations_features_not_supported"></a>
116116
<li>Recreation of buffers and images. Although the library has functions for buffer and image creation (<a class="el" href="vk__mem__alloc_8h.html#ac72ee55598617e8eecca384e746bab51">vmaCreateBuffer()</a>, <a class="el" href="vk__mem__alloc_8h.html#a02a94f25679275851a53e82eacbcfc73" title="Function similar to vmaCreateBuffer(). ">vmaCreateImage()</a>), you need to recreate these objects yourself after defragmentation. That's because the big structures <code>VkBufferCreateInfo</code>, <code>VkImageCreateInfo</code> are not stored in <a class="el" href="struct_vma_allocation.html" title="Represents single memory allocation. ">VmaAllocation</a> object.</li>
117117
<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>
118118
<li>Code free of any compiler warnings. Maintaining the library to compile and work correctly on so many different platforms is hard enough. Being free of any warnings, on any version of any compiler, is simply not feasible.</li>
119-
<li>Support for any programming languages other than C/C++. Bindings to other languages are welcomed as external projects. </li>
119+
<li>This is a C++ library with C interface. Bindings or ports to any other programming languages are welcomed as external projects and are not going to be included into this repository. </li>
120120
</ul>
121121
</div></div><!-- contents -->
122122
<!-- start footer part -->

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: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1471,8 +1471,9 @@ Features deliberately excluded from the scope of this library:
14711471
- Code free of any compiler warnings. Maintaining the library to compile and
14721472
work correctly on so many different platforms is hard enough. Being free of
14731473
any warnings, on any version of any compiler, is simply not feasible.
1474-
- Support for any programming languages other than C/C++.
1475-
Bindings to other languages are welcomed as external projects.
1474+
- This is a C++ library with C interface.
1475+
Bindings or ports to any other programming languages are welcomed as external projects and
1476+
are not going to be included into this repository.
14761477

14771478
*/
14781479

0 commit comments

Comments
 (0)