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

Small addition to the documentation.

Browse Source
This commit is contained in:
Adam Sawicki 2017-06-20 12:52:26 +02:00
parent a2c411cc49
commit 9137407734
3 changed files with 44 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/html/index.html
View File

@ -133,6 +133,8 @@ memReq.usage = VMA_MEMORY_USAGE_GPU_ONLY;
VkBuffer buffer; VkBuffer buffer;
vmaCreateBuffer(allocator, &bufferInfo, &memReq, &buffer, nullptr, nullptr); vmaCreateBuffer(allocator, &bufferInfo, &memReq, &buffer, nullptr, nullptr);
</pre><p>When no longer needed, destroy your buffer or image using <a class="el" href="group__layer3.html#ga967857c06b8232b2a54936daf36d1535">vmaDestroyBuffer()</a> / <a class="el" href="group__layer3.html#ga9377799736c4a1262b41ee441e5fc877">vmaDestroyImage()</a>. This function would also free memory bound to it.</p>
<pre class="fragment">vmaDestroyBuffer(allocator, buffer);
</pre><h1><a class="anchor" id="configuration"></a> </pre><h1><a class="anchor" id="configuration"></a>
Configuration</h1> Configuration</h1>
<p>Set VMA_STATS_STRING_ENABLED macro in <a class="el" href="vk__mem__alloc_8h.html">vk_mem_alloc.h</a> to 0 or 1 to disable/enable compilation of code for dumping internal allocator state to string in JSON format.</p> <p>Set VMA_STATS_STRING_ENABLED macro in <a class="el" href="vk__mem__alloc_8h.html">vk_mem_alloc.h</a> to 0 or 1 to disable/enable compilation of code for dumping internal allocator state to string in JSON format.</p>

72
docs/html/vk__mem__alloc_8h_source.html
View File

File diff suppressed because one or more lines are too long

6
src/vk_mem_alloc.h
View File

@ -122,6 +122,12 @@ When you want to create a buffer or image:
VkBuffer buffer; VkBuffer buffer;
vmaCreateBuffer(allocator, &bufferInfo, &memReq, &buffer, nullptr, nullptr); vmaCreateBuffer(allocator, &bufferInfo, &memReq, &buffer, nullptr, nullptr);
When no longer needed, destroy your buffer or image using vmaDestroyBuffer() / vmaDestroyImage().
This function would also free memory bound to it.
vmaDestroyBuffer(allocator, buffer);
\section configuration Configuration \section configuration Configuration
Set VMA_STATS_STRING_ENABLED macro in vk_mem_alloc.h to 0 or 1 to disable/enable Set VMA_STATS_STRING_ENABLED macro in vk_mem_alloc.h to 0 or 1 to disable/enable