Added documentation for VK_KHR_external_memory_win32

Rebuilt the documentation.
This commit is contained in:
Adam Sawicki 2024-08-28 13:20:19 +02:00
parent ca17831d74
commit eb46f62376
112 changed files with 3340 additions and 990 deletions

View file

@ -3,13 +3,15 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="generator" content="Doxygen 1.11.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Vulkan Memory Allocator: Library initialization</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
@ -31,24 +33,35 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<!-- Generated by Doxygen 1.11.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="doc-content">
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
@ -142,6 +155,7 @@ Enumerations</h2></td></tr>
, <a class="el" href="#gga4f87c9100d154a65a4ad495f7763cf7caa2566e7f75e19ae7ec9c4fa509fea5fb">VMA_ALLOCATOR_CREATE_KHR_MAINTENANCE4_BIT</a> = 0x00000080
, <br />
&#160;&#160;<a class="el" href="#gga4f87c9100d154a65a4ad495f7763cf7caca82d4ce40bdb59d3da52a539c21d6b8">VMA_ALLOCATOR_CREATE_KHR_MAINTENANCE5_BIT</a> = 0x00000100
, <a class="el" href="#gga4f87c9100d154a65a4ad495f7763cf7ca4897d1181a186e327f4dadd680ad00ac">VMA_ALLOCATOR_CREATE_KHR_EXTERNAL_MEMORY_WIN32_BIT</a> = 0x00000200
, <a class="el" href="#gga4f87c9100d154a65a4ad495f7763cf7cae4d5ad929caba5f23eb502b13bd5286c">VMA_ALLOCATOR_CREATE_FLAG_BITS_MAX_ENUM</a> = 0x7FFFFFFF
<br />
}</td></tr>
@ -374,6 +388,9 @@ Functions</h2></td></tr>
<tr><td class="fieldname"><a id="gga4f87c9100d154a65a4ad495f7763cf7caca82d4ce40bdb59d3da52a539c21d6b8" name="gga4f87c9100d154a65a4ad495f7763cf7caca82d4ce40bdb59d3da52a539c21d6b8"></a>VMA_ALLOCATOR_CREATE_KHR_MAINTENANCE5_BIT&#160;</td><td class="fielddoc"><p>Enables usage of VK_KHR_maintenance5 extension in the library.</p>
<p>You should set this flag if you found available and enabled this device extension, while creating Vulkan device passed as <a class="el" href="struct_vma_allocator_create_info.html#ad924ddd77b04039c88d0c09b0ffcd500" title="Vulkan device.">VmaAllocatorCreateInfo::device</a>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga4f87c9100d154a65a4ad495f7763cf7ca4897d1181a186e327f4dadd680ad00ac" name="gga4f87c9100d154a65a4ad495f7763cf7ca4897d1181a186e327f4dadd680ad00ac"></a>VMA_ALLOCATOR_CREATE_KHR_EXTERNAL_MEMORY_WIN32_BIT&#160;</td><td class="fielddoc"><p>Enables usage of VK_KHR_external_memory_win32 extension in the library.</p>
<p>You should set this flag if you found available and enabled this device extension, while creating Vulkan device passed as <a class="el" href="struct_vma_allocator_create_info.html#ad924ddd77b04039c88d0c09b0ffcd500" title="Vulkan device.">VmaAllocatorCreateInfo::device</a>. For more information, see <a class="el" href="vk_khr_external_memory_win32.html">VK_KHR_external_memory_win32</a>. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga4f87c9100d154a65a4ad495f7763cf7cae4d5ad929caba5f23eb502b13bd5286c" name="gga4f87c9100d154a65a4ad495f7763cf7cae4d5ad929caba5f23eb502b13bd5286c"></a>VMA_ALLOCATOR_CREATE_FLAG_BITS_MAX_ENUM&#160;</td><td class="fielddoc"></td></tr>
</table>
@ -389,7 +406,7 @@ Functions</h2></td></tr>
<tr>
<td class="memname">VkResult vmaCreateAllocator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="struct_vma_allocator_create_info.html">VmaAllocatorCreateInfo</a> *</td> <td class="paramname"><span class="paramname"><em>pCreateInfo</em>, </span></td>
<td class="paramtype">const <a class="el" href="struct_vma_allocator_create_info.html">VmaAllocatorCreateInfo</a> *</td> <td class="paramname"><span class="paramname"><em>pCreateInfo</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
@ -431,7 +448,7 @@ Functions</h2></td></tr>
<tr>
<td class="memname">void vmaGetAllocatorInfo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_vma_allocator.html">VmaAllocator</a></td> <td class="paramname"><span class="paramname"><em>allocator</em>, </span></td>
<td class="paramtype"><a class="el" href="struct_vma_allocator.html">VmaAllocator</a></td> <td class="paramname"><span class="paramname"><em>allocator</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
@ -455,7 +472,7 @@ Functions</h2></td></tr>
<tr>
<td class="memname">void vmaGetMemoryProperties </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_vma_allocator.html">VmaAllocator</a></td> <td class="paramname"><span class="paramname"><em>allocator</em>, </span></td>
<td class="paramtype"><a class="el" href="struct_vma_allocator.html">VmaAllocator</a></td> <td class="paramname"><span class="paramname"><em>allocator</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
@ -477,12 +494,12 @@ Functions</h2></td></tr>
<tr>
<td class="memname">void vmaGetMemoryTypeProperties </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_vma_allocator.html">VmaAllocator</a></td> <td class="paramname"><span class="paramname"><em>allocator</em>, </span></td>
<td class="paramtype"><a class="el" href="struct_vma_allocator.html">VmaAllocator</a></td> <td class="paramname"><span class="paramname"><em>allocator</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>memoryTypeIndex</em>, </span></td>
<td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>memoryTypeIndex</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
@ -506,7 +523,7 @@ Functions</h2></td></tr>
<tr>
<td class="memname">void vmaGetPhysicalDeviceProperties </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_vma_allocator.html">VmaAllocator</a></td> <td class="paramname"><span class="paramname"><em>allocator</em>, </span></td>
<td class="paramtype"><a class="el" href="struct_vma_allocator.html">VmaAllocator</a></td> <td class="paramname"><span class="paramname"><em>allocator</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
@ -528,7 +545,7 @@ Functions</h2></td></tr>
<tr>
<td class="memname">void vmaSetCurrentFrameIndex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_vma_allocator.html">VmaAllocator</a></td> <td class="paramname"><span class="paramname"><em>allocator</em>, </span></td>
<td class="paramtype"><a class="el" href="struct_vma_allocator.html">VmaAllocator</a></td> <td class="paramname"><span class="paramname"><em>allocator</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
@ -545,7 +562,8 @@ Functions</h2></td></tr>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.11.0
</small></address>
</div><!-- doc-content -->
</body>
</html>