eden-emu/VulkanMemoryAllocator
17
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.

Browse source
This commit is contained in:
Adam Sawicki 2017-07-11 15:22:12 +02:00
parent 31341608f4
commit 988ac4c05d
65 changed files with 2469 additions and 349 deletions
Download patch file Download diff file Expand all files Collapse all files

76
docs/html/group__layer3.html
View file

@ -67,20 +67,20 @@ $(function() {
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga6cafa3a644324a1e0c9165494db11648"><td class="memItemLeft" align="right" valign="top">VkResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__layer3.html#ga6cafa3a644324a1e0c9165494db11648">vmaCreateBuffer</a> (VmaAllocator allocator, const VkBufferCreateInfo *pCreateInfo, const <a class="el" href="struct_vma_memory_requirements.html">VmaMemoryRequirements</a> *pMemoryRequirements, VkBuffer *pBuffer, VkMappedMemoryRange *pMemory, uint32_t *pMemoryTypeIndex)</td></tr>
<tr class="separator:ga6cafa3a644324a1e0c9165494db11648"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga967857c06b8232b2a54936daf36d1535"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__layer3.html#ga967857c06b8232b2a54936daf36d1535">vmaDestroyBuffer</a> (VmaAllocator allocator, VkBuffer buffer)</td></tr>
<tr class="separator:ga967857c06b8232b2a54936daf36d1535"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9646281a3d9abc9f4d0bc5632db117de"><td class="memItemLeft" align="right" valign="top">VkResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__layer3.html#ga9646281a3d9abc9f4d0bc5632db117de">vmaCreateImage</a> (VmaAllocator allocator, const VkImageCreateInfo *pCreateInfo, const <a class="el" href="struct_vma_memory_requirements.html">VmaMemoryRequirements</a> *pMemoryRequirements, VkImage *pImage, VkMappedMemoryRange *pMemory, uint32_t *pMemoryTypeIndex)</td></tr>
<tr class="memdesc:ga9646281a3d9abc9f4d0bc5632db117de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function similar to <a class="el" href="group__layer3.html#ga6cafa3a644324a1e0c9165494db11648">vmaCreateBuffer()</a>. <a href="#ga9646281a3d9abc9f4d0bc5632db117de">More...</a><br /></td></tr>
<tr class="separator:ga9646281a3d9abc9f4d0bc5632db117de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9377799736c4a1262b41ee441e5fc877"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__layer3.html#ga9377799736c4a1262b41ee441e5fc877">vmaDestroyImage</a> (VmaAllocator allocator, VkImage image)</td></tr>
<tr class="separator:ga9377799736c4a1262b41ee441e5fc877"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2f711e32e95cf9bf8dff4917230c2e9b"><td class="memItemLeft" align="right" valign="top">VkResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__layer3.html#ga2f711e32e95cf9bf8dff4917230c2e9b">vmaCreateBuffer</a> (VmaAllocator allocator, const VkBufferCreateInfo *pCreateInfo, const <a class="el" href="struct_vma_memory_requirements.html">VmaMemoryRequirements</a> *pMemoryRequirements, VkBuffer *pBuffer, VmaAllocation *pAllocation, <a class="el" href="struct_vma_allocation_info.html">VmaAllocationInfo</a> *pAllocationInfo)</td></tr>
<tr class="separator:ga2f711e32e95cf9bf8dff4917230c2e9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0d9f4e4ba5bf9aab1f1c746387753d77"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__layer3.html#ga0d9f4e4ba5bf9aab1f1c746387753d77">vmaDestroyBuffer</a> (VmaAllocator allocator, VkBuffer buffer, VmaAllocation allocation)</td></tr>
<tr class="separator:ga0d9f4e4ba5bf9aab1f1c746387753d77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9e34bc318ff4b25d1958e79b9db3f1aa"><td class="memItemLeft" align="right" valign="top">VkResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__layer3.html#ga9e34bc318ff4b25d1958e79b9db3f1aa">vmaCreateImage</a> (VmaAllocator allocator, const VkImageCreateInfo *pCreateInfo, const <a class="el" href="struct_vma_memory_requirements.html">VmaMemoryRequirements</a> *pMemoryRequirements, VkImage *pImage, VmaAllocation *pAllocation, <a class="el" href="struct_vma_allocation_info.html">VmaAllocationInfo</a> *pAllocationInfo)</td></tr>
<tr class="memdesc:ga9e34bc318ff4b25d1958e79b9db3f1aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function similar to <a class="el" href="group__layer3.html#ga2f711e32e95cf9bf8dff4917230c2e9b">vmaCreateBuffer()</a>. <a href="#ga9e34bc318ff4b25d1958e79b9db3f1aa">More...</a><br /></td></tr>
<tr class="separator:ga9e34bc318ff4b25d1958e79b9db3f1aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae50d2cb3b4a3bfd4dd40987234e50e7e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__layer3.html#gae50d2cb3b4a3bfd4dd40987234e50e7e">vmaDestroyImage</a> (VmaAllocator allocator, VkImage image, VmaAllocation allocation)</td></tr>
<tr class="separator:gae50d2cb3b4a3bfd4dd40987234e50e7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga6cafa3a644324a1e0c9165494db11648"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6cafa3a644324a1e0c9165494db11648">&#9670;&nbsp;</a></span>vmaCreateBuffer()</h2>
<a id="ga2f711e32e95cf9bf8dff4917230c2e9b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2f711e32e95cf9bf8dff4917230c2e9b">&#9670;&nbsp;</a></span>vmaCreateBuffer()</h2>
<div class="memitem">
<div class="memproto">
@ -112,14 +112,14 @@ Functions</h2></td></tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">VkMappedMemoryRange *&#160;</td>
<td class="paramname"><em>pMemory</em>, </td>
<td class="paramtype">VmaAllocation *&#160;</td>
<td class="paramname"><em>pAllocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>pMemoryTypeIndex</em>&#160;</td>
<td class="paramtype"><a class="el" href="struct_vma_allocation_info.html">VmaAllocationInfo</a> *&#160;</td>
<td class="paramname"><em>pAllocationInfo</em>&#160;</td>
</tr>
<tr>
<td></td>
@ -130,8 +130,9 @@ Functions</h2></td></tr>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">pMemory</td><td>Optional. Pass null if you don't need this information. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">pMemoryTypeIndex</td><td>Optional. Pass null if you don't need this information.</td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">pBuffer</td><td>Buffer that was created. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">pAllocation</td><td>Allocation that was created. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">pAllocationInfo</td><td>Optional. Information about allocated memory. It can be later fetched using function VmaGetAllocationInfo().</td></tr>
</table>
</dd>
</dl>
@ -141,13 +142,12 @@ Functions</h2></td></tr>
<li>Allocates appropriate memory for it.</li>
<li>Binds the buffer/image with the memory.</li>
</ol>
<p>You do not (and should not) pass returned pMemory to vmaFreeMemory. Only calling <a class="el" href="group__layer3.html#ga967857c06b8232b2a54936daf36d1535">vmaDestroyBuffer()</a> / <a class="el" href="group__layer3.html#ga9377799736c4a1262b41ee441e5fc877">vmaDestroyImage()</a> is required for objects created using <a class="el" href="group__layer3.html#ga6cafa3a644324a1e0c9165494db11648">vmaCreateBuffer()</a> / <a class="el" href="group__layer3.html#ga9646281a3d9abc9f4d0bc5632db117de" title="Function similar to vmaCreateBuffer(). ">vmaCreateImage()</a>.</p>
<p>All allocated buffers and images are also automatically destroyed in <a class="el" href="group__general.html#gaa8d164061c88f22fb1fd3c8f3534bc1d" title="Destroys allocator object. ">vmaDestroyAllocator()</a>, along with their memory allocations. </p>
<p>You do not (and should not) pass returned pMemory to vmaFreeMemory. Only calling <a class="el" href="group__layer3.html#ga0d9f4e4ba5bf9aab1f1c746387753d77">vmaDestroyBuffer()</a> / <a class="el" href="group__layer3.html#gae50d2cb3b4a3bfd4dd40987234e50e7e">vmaDestroyImage()</a> is required for objects created using <a class="el" href="group__layer3.html#ga2f711e32e95cf9bf8dff4917230c2e9b">vmaCreateBuffer()</a> / <a class="el" href="group__layer3.html#ga9e34bc318ff4b25d1958e79b9db3f1aa" title="Function similar to vmaCreateBuffer(). ">vmaCreateImage()</a>. </p>
</div>
</div>
<a id="ga9646281a3d9abc9f4d0bc5632db117de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9646281a3d9abc9f4d0bc5632db117de">&#9670;&nbsp;</a></span>vmaCreateImage()</h2>
<a id="ga9e34bc318ff4b25d1958e79b9db3f1aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9e34bc318ff4b25d1958e79b9db3f1aa">&#9670;&nbsp;</a></span>vmaCreateImage()</h2>
<div class="memitem">
<div class="memproto">
@ -179,14 +179,14 @@ Functions</h2></td></tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">VkMappedMemoryRange *&#160;</td>
<td class="paramname"><em>pMemory</em>, </td>
<td class="paramtype">VmaAllocation *&#160;</td>
<td class="paramname"><em>pAllocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>pMemoryTypeIndex</em>&#160;</td>
<td class="paramtype"><a class="el" href="struct_vma_allocation_info.html">VmaAllocationInfo</a> *&#160;</td>
<td class="paramname"><em>pAllocationInfo</em>&#160;</td>
</tr>
<tr>
<td></td>
@ -196,12 +196,12 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Function similar to <a class="el" href="group__layer3.html#ga6cafa3a644324a1e0c9165494db11648">vmaCreateBuffer()</a>. </p>
<p>Function similar to <a class="el" href="group__layer3.html#ga2f711e32e95cf9bf8dff4917230c2e9b">vmaCreateBuffer()</a>. </p>
</div>
</div>
<a id="ga967857c06b8232b2a54936daf36d1535"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga967857c06b8232b2a54936daf36d1535">&#9670;&nbsp;</a></span>vmaDestroyBuffer()</h2>
<a id="ga0d9f4e4ba5bf9aab1f1c746387753d77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0d9f4e4ba5bf9aab1f1c746387753d77">&#9670;&nbsp;</a></span>vmaDestroyBuffer()</h2>
<div class="memitem">
<div class="memproto">
@ -216,7 +216,13 @@ Functions</h2></td></tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">VkBuffer&#160;</td>
<td class="paramname"><em>buffer</em>&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">VmaAllocation&#160;</td>
<td class="paramname"><em>allocation</em>&#160;</td>
</tr>
<tr>
<td></td>
@ -228,8 +234,8 @@ Functions</h2></td></tr>
</div>
</div>
<a id="ga9377799736c4a1262b41ee441e5fc877"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9377799736c4a1262b41ee441e5fc877">&#9670;&nbsp;</a></span>vmaDestroyImage()</h2>
<a id="gae50d2cb3b4a3bfd4dd40987234e50e7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae50d2cb3b4a3bfd4dd40987234e50e7e">&#9670;&nbsp;</a></span>vmaDestroyImage()</h2>
<div class="memitem">
<div class="memproto">
@ -244,7 +250,13 @@ Functions</h2></td></tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">VkImage&#160;</td>
<td class="paramname"><em>image</em>&#160;</td>
<td class="paramname"><em>image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">VmaAllocation&#160;</td>
<td class="paramname"><em>allocation</em>&#160;</td>
</tr>
<tr>
<td></td>