Skip to content

Commit 9ecb59e

Browse files
Version 2.0.0-alpha.8. Added functions: vmaTouchAllocation, vmaFindMemoryTypeIndexForBufferInfo, vmaFindMemoryTypeIndexForImageInfo.
1 parent aed6315 commit 9ecb59e

File tree

10 files changed

+368
-40
lines changed

10 files changed

+368
-40
lines changed

docs/html/choosing_memory_type.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
<div class="contents">
6969
<div class="textblock"><p>Physical devices in Vulkan support various combinations of memory heaps and types. Help with choosing correct and optimal memory type for your specific resource is one of the key features of this library. You can use it by filling appropriate members of <a class="el" href="struct_vma_allocation_create_info.html">VmaAllocationCreateInfo</a> structure, as described below. You can also combine multiple methods.</p>
7070
<ol type="1">
71-
<li>If you just want to find memory type index that meets your requirements, you can use function <a class="el" href="vk__mem__alloc_8h.html#aef15a94b58fbcb0fe706d5720e84a74a">vmaFindMemoryTypeIndex()</a>.</li>
71+
<li>If you just want to find memory type index that meets your requirements, you can use function <a class="el" href="vk__mem__alloc_8h.html#aef15a94b58fbcb0fe706d5720e84a74a" title="Helps to find memoryTypeIndex, given memoryTypeBits and VmaAllocationCreateInfo. ">vmaFindMemoryTypeIndex()</a>.</li>
7272
<li>If you want to allocate a region of device memory without association with any specific image or buffer, you can use function <a class="el" href="vk__mem__alloc_8h.html#abf28077dbf82d0908b8acbe8ee8dd9b8" title="General purpose memory allocation. ">vmaAllocateMemory()</a>. Usage of this function is not recommended and usually not needed.</li>
7373
<li>If you already have a buffer or an image created, you want to allocate memory for it and then you will bind it yourself, you can use function <a class="el" href="vk__mem__alloc_8h.html#a7fdf64415b6c3d83c454f28d2c53df7b">vmaAllocateMemoryForBuffer()</a>, <a class="el" href="vk__mem__alloc_8h.html#a0faa3f9e5fb233d29d1e00390650febb" title="Function similar to vmaAllocateMemoryForBuffer(). ">vmaAllocateMemoryForImage()</a>.</li>
7474
<li>If you want to create a buffer or an image, allocate memory for it and bind them together, all in one call, you can use function <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>. This is the recommended way to use this library.</li>

docs/html/globals.html

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,12 @@ <h3><a id="index_v"></a>- v -</h3><ul>
206206
<li>vmaFindMemoryTypeIndex()
207207
: <a class="el" href="vk__mem__alloc_8h.html#aef15a94b58fbcb0fe706d5720e84a74a">vk_mem_alloc.h</a>
208208
</li>
209+
<li>vmaFindMemoryTypeIndexForBufferInfo()
210+
: <a class="el" href="vk__mem__alloc_8h.html#ae790ab9ffaf7667fb8f62523e6897888">vk_mem_alloc.h</a>
211+
</li>
212+
<li>vmaFindMemoryTypeIndexForImageInfo()
213+
: <a class="el" href="vk__mem__alloc_8h.html#a088da83d8eaf3ce9056d9ea0b981d472">vk_mem_alloc.h</a>
214+
</li>
209215
<li>vmaFreeMemory()
210216
: <a class="el" href="vk__mem__alloc_8h.html#a11f0fbc034fa81a4efedd73d61ce7568">vk_mem_alloc.h</a>
211217
</li>
@@ -260,6 +266,9 @@ <h3><a id="index_v"></a>- v -</h3><ul>
260266
<li>VmaStats
261267
: <a class="el" href="vk__mem__alloc_8h.html#a732be855fb4a7c248e6853d928a729af">vk_mem_alloc.h</a>
262268
</li>
269+
<li>vmaTouchAllocation()
270+
: <a class="el" href="vk__mem__alloc_8h.html#a108cb6dcb9ad32b81f0d61c08d1b4323">vk_mem_alloc.h</a>
271+
</li>
263272
<li>vmaUnmapMemory()
264273
: <a class="el" href="vk__mem__alloc_8h.html#a9bc268595cb33f6ec4d519cfce81ff45">vk_mem_alloc.h</a>
265274
</li>

docs/html/globals_func.html

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,9 @@
5858
</div>
5959

6060
<div class="contents">
61-
&#160;<ul>
61+
&#160;
62+
63+
<h3><a id="index_v"></a>- v -</h3><ul>
6264
<li>vmaAllocateMemory()
6365
: <a class="el" href="vk__mem__alloc_8h.html#abf28077dbf82d0908b8acbe8ee8dd9b8">vk_mem_alloc.h</a>
6466
</li>
@@ -107,6 +109,12 @@
107109
<li>vmaFindMemoryTypeIndex()
108110
: <a class="el" href="vk__mem__alloc_8h.html#aef15a94b58fbcb0fe706d5720e84a74a">vk_mem_alloc.h</a>
109111
</li>
112+
<li>vmaFindMemoryTypeIndexForBufferInfo()
113+
: <a class="el" href="vk__mem__alloc_8h.html#ae790ab9ffaf7667fb8f62523e6897888">vk_mem_alloc.h</a>
114+
</li>
115+
<li>vmaFindMemoryTypeIndexForImageInfo()
116+
: <a class="el" href="vk__mem__alloc_8h.html#a088da83d8eaf3ce9056d9ea0b981d472">vk_mem_alloc.h</a>
117+
</li>
110118
<li>vmaFreeMemory()
111119
: <a class="el" href="vk__mem__alloc_8h.html#a11f0fbc034fa81a4efedd73d61ce7568">vk_mem_alloc.h</a>
112120
</li>
@@ -140,6 +148,9 @@
140148
<li>vmaSetCurrentFrameIndex()
141149
: <a class="el" href="vk__mem__alloc_8h.html#ade56bf8dc9f5a5eaddf5f119ed525236">vk_mem_alloc.h</a>
142150
</li>
151+
<li>vmaTouchAllocation()
152+
: <a class="el" href="vk__mem__alloc_8h.html#a108cb6dcb9ad32b81f0d61c08d1b4323">vk_mem_alloc.h</a>
153+
</li>
143154
<li>vmaUnmapMemory()
144155
: <a class="el" href="vk__mem__alloc_8h.html#a9bc268595cb33f6ec4d519cfce81ff45">vk_mem_alloc.h</a>
145156
</li>

docs/html/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
<div class="title">Vulkan Memory Allocator </div> </div>
6363
</div><!--header-->
6464
<div class="contents">
65-
<div class="textblock"><p><b>Version 2.0.0-alpha.7</b> (2018-02-09)</p>
65+
<div class="textblock"><p><b>Version 2.0.0-alpha.8</b> (2018-03-05)</p>
6666
<p>Copyright (c) 2017-2018 Advanced Micro Devices, Inc. All rights reserved. <br />
6767
License: MIT</p>
6868
<p>Documentation of all members: <a class="el" href="vk__mem__alloc_8h.html">vk_mem_alloc.h</a></p>

docs/html/menudata.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ var menudata={children:[
3737
{text:"All",url:"globals.html",children:[
3838
{text:"p",url:"globals.html#index_p"},
3939
{text:"v",url:"globals.html#index_v"}]},
40-
{text:"Functions",url:"globals_func.html"},
40+
{text:"Functions",url:"globals_func.html",children:[
41+
{text:"v",url:"globals_func.html#index_v"}]},
4142
{text:"Typedefs",url:"globals_type.html"},
4243
{text:"Enumerations",url:"globals_enum.html"},
4344
{text:"Enumerator",url:"globals_eval.html"},

docs/html/search/all_e.js

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/html/search/functions_0.js

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)