Minor fix in documentation

Regenerated the documentation using Doxygen 1.9.5.
This commit is contained in:
Adam Sawicki 2022-11-04 17:02:24 +01:00
parent d2767622a6
commit cb5bf6452c
104 changed files with 2474 additions and 1758 deletions

View file

@ -1,9 +1,9 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<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.9.4"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<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"/>
@ -29,10 +29,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
@ -56,9 +56,16 @@ $(function() {
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
@ -162,7 +169,7 @@ Functions</h2></td></tr>
<p >API elements related to the initialization and management of the entire library, especially <a class="el" href="struct_vma_allocator.html" title="Represents main object of this library initialized.">VmaAllocator</a> object. </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga7e1ed85f7799600b03ad51a77acc21f3" name="ga7e1ed85f7799600b03ad51a77acc21f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7e1ed85f7799600b03ad51a77acc21f3">&#9670;&nbsp;</a></span>PFN_vmaAllocateDeviceMemoryFunction</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ga7e1ed85f7799600b03ad51a77acc21f3">&#9670;&#160;</a></span>PFN_vmaAllocateDeviceMemoryFunction</h2>
<div class="memitem">
<div class="memproto">
@ -178,7 +185,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="ga154ccaaf53dc2c36378f80f0c4f3679b" name="ga154ccaaf53dc2c36378f80f0c4f3679b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga154ccaaf53dc2c36378f80f0c4f3679b">&#9670;&nbsp;</a></span>PFN_vmaFreeDeviceMemoryFunction</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ga154ccaaf53dc2c36378f80f0c4f3679b">&#9670;&#160;</a></span>PFN_vmaFreeDeviceMemoryFunction</h2>
<div class="memitem">
<div class="memproto">
@ -194,7 +201,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="gafd73b95e737ee7e76f827cb5472f559f" name="gafd73b95e737ee7e76f827cb5472f559f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafd73b95e737ee7e76f827cb5472f559f">&#9670;&nbsp;</a></span>VmaAllocatorCreateFlagBits</h2>
<h2 class="memtitle"><span class="permalink"><a href="#gafd73b95e737ee7e76f827cb5472f559f">&#9670;&#160;</a></span>VmaAllocatorCreateFlagBits</h2>
<div class="memitem">
<div class="memproto">
@ -210,7 +217,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="gacfe6863e160722c2c1bbcf7573fddc4d" name="gacfe6863e160722c2c1bbcf7573fddc4d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacfe6863e160722c2c1bbcf7573fddc4d">&#9670;&nbsp;</a></span>VmaAllocatorCreateFlags</h2>
<h2 class="memtitle"><span class="permalink"><a href="#gacfe6863e160722c2c1bbcf7573fddc4d">&#9670;&#160;</a></span>VmaAllocatorCreateFlags</h2>
<div class="memitem">
<div class="memproto">
@ -226,7 +233,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="gaad9652301d33759b83e52d4f3605a14a" name="gaad9652301d33759b83e52d4f3605a14a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaad9652301d33759b83e52d4f3605a14a">&#9670;&nbsp;</a></span>VmaAllocatorCreateInfo</h2>
<h2 class="memtitle"><span class="permalink"><a href="#gaad9652301d33759b83e52d4f3605a14a">&#9670;&#160;</a></span>VmaAllocatorCreateInfo</h2>
<div class="memitem">
<div class="memproto">
@ -242,7 +249,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="ga1988031b0223fdbd564250fa1edd942c" name="ga1988031b0223fdbd564250fa1edd942c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1988031b0223fdbd564250fa1edd942c">&#9670;&nbsp;</a></span>VmaAllocatorInfo</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ga1988031b0223fdbd564250fa1edd942c">&#9670;&#160;</a></span>VmaAllocatorInfo</h2>
<div class="memitem">
<div class="memproto">
@ -258,7 +265,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="ga77692d3c8770ea8882d573206bd27b2b" name="ga77692d3c8770ea8882d573206bd27b2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga77692d3c8770ea8882d573206bd27b2b">&#9670;&nbsp;</a></span>VmaDeviceMemoryCallbacks</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ga77692d3c8770ea8882d573206bd27b2b">&#9670;&#160;</a></span>VmaDeviceMemoryCallbacks</h2>
<div class="memitem">
<div class="memproto">
@ -276,7 +283,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="gabb0a8e3b5040d847571cca6c7f9a8074" name="gabb0a8e3b5040d847571cca6c7f9a8074"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabb0a8e3b5040d847571cca6c7f9a8074">&#9670;&nbsp;</a></span>VmaVulkanFunctions</h2>
<h2 class="memtitle"><span class="permalink"><a href="#gabb0a8e3b5040d847571cca6c7f9a8074">&#9670;&#160;</a></span>VmaVulkanFunctions</h2>
<div class="memitem">
<div class="memproto">
@ -294,7 +301,7 @@ Functions</h2></td></tr>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga4f87c9100d154a65a4ad495f7763cf7c" name="ga4f87c9100d154a65a4ad495f7763cf7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4f87c9100d154a65a4ad495f7763cf7c">&#9670;&nbsp;</a></span>VmaAllocatorCreateFlagBits</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ga4f87c9100d154a65a4ad495f7763cf7c">&#9670;&#160;</a></span>VmaAllocatorCreateFlagBits</h2>
<div class="memitem">
<div class="memproto">
@ -363,7 +370,7 @@ Functions</h2></td></tr>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga200692051ddb34240248234f5f4c17bb" name="ga200692051ddb34240248234f5f4c17bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga200692051ddb34240248234f5f4c17bb">&#9670;&nbsp;</a></span>vmaCreateAllocator()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ga200692051ddb34240248234f5f4c17bb">&#9670;&#160;</a></span>vmaCreateAllocator()</h2>
<div class="memitem">
<div class="memproto">
@ -393,7 +400,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="gaa8d164061c88f22fb1fd3c8f3534bc1d" name="gaa8d164061c88f22fb1fd3c8f3534bc1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa8d164061c88f22fb1fd3c8f3534bc1d">&#9670;&nbsp;</a></span>vmaDestroyAllocator()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#gaa8d164061c88f22fb1fd3c8f3534bc1d">&#9670;&#160;</a></span>vmaDestroyAllocator()</h2>
<div class="memitem">
<div class="memproto">
@ -413,7 +420,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="gafa02231a791b37255720d566a52683e7" name="gafa02231a791b37255720d566a52683e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafa02231a791b37255720d566a52683e7">&#9670;&nbsp;</a></span>vmaGetAllocatorInfo()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#gafa02231a791b37255720d566a52683e7">&#9670;&#160;</a></span>vmaGetAllocatorInfo()</h2>
<div class="memitem">
<div class="memproto">
@ -444,7 +451,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="gab88db292a17974f911182543fda52d19" name="gab88db292a17974f911182543fda52d19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab88db292a17974f911182543fda52d19">&#9670;&nbsp;</a></span>vmaGetMemoryProperties()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#gab88db292a17974f911182543fda52d19">&#9670;&#160;</a></span>vmaGetMemoryProperties()</h2>
<div class="memitem">
<div class="memproto">
@ -473,7 +480,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="ga8701444752eb5de4464adb5a2b514bca" name="ga8701444752eb5de4464adb5a2b514bca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8701444752eb5de4464adb5a2b514bca">&#9670;&nbsp;</a></span>vmaGetMemoryTypeProperties()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ga8701444752eb5de4464adb5a2b514bca">&#9670;&#160;</a></span>vmaGetMemoryTypeProperties()</h2>
<div class="memitem">
<div class="memproto">
@ -510,7 +517,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="gaecabf7b6e91ea87d0316fa0a9e014fe0" name="gaecabf7b6e91ea87d0316fa0a9e014fe0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaecabf7b6e91ea87d0316fa0a9e014fe0">&#9670;&nbsp;</a></span>vmaGetPhysicalDeviceProperties()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#gaecabf7b6e91ea87d0316fa0a9e014fe0">&#9670;&#160;</a></span>vmaGetPhysicalDeviceProperties()</h2>
<div class="memitem">
<div class="memproto">
@ -539,7 +546,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="gade56bf8dc9f5a5eaddf5f119ed525236" name="gade56bf8dc9f5a5eaddf5f119ed525236"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gade56bf8dc9f5a5eaddf5f119ed525236">&#9670;&nbsp;</a></span>vmaSetCurrentFrameIndex()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#gade56bf8dc9f5a5eaddf5f119ed525236">&#9670;&#160;</a></span>vmaSetCurrentFrameIndex()</h2>
<div class="memitem">
<div class="memproto">
@ -571,7 +578,7 @@ 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.9.4
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.9.5
</small></address>
</body>
</html>