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: Virtual allocator</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">
@ -176,7 +183,7 @@ Functions</h2></td></tr>
<p >API elements related to the mechanism of <a class="el" href="virtual_allocator.html">Virtual allocator</a> - using the core allocation algorithm for user-defined purpose without allocating any real GPU memory. </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga936815e64946a6b6d812d08d10184c23" name="ga936815e64946a6b6d812d08d10184c23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga936815e64946a6b6d812d08d10184c23">&#9670;&nbsp;</a></span>VmaVirtualAllocationCreateFlagBits</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ga936815e64946a6b6d812d08d10184c23">&#9670;&#160;</a></span>VmaVirtualAllocationCreateFlagBits</h2>
<div class="memitem">
<div class="memproto">
@ -192,7 +199,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="gae96ffc099bf898257fb19e9410ed08a7" name="gae96ffc099bf898257fb19e9410ed08a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae96ffc099bf898257fb19e9410ed08a7">&#9670;&nbsp;</a></span>VmaVirtualAllocationCreateFlags</h2>
<h2 class="memtitle"><span class="permalink"><a href="#gae96ffc099bf898257fb19e9410ed08a7">&#9670;&#160;</a></span>VmaVirtualAllocationCreateFlags</h2>
<div class="memitem">
<div class="memproto">
@ -208,7 +215,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="gac3c90d80bedc6847a41b82d0e2158c9e" name="gac3c90d80bedc6847a41b82d0e2158c9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac3c90d80bedc6847a41b82d0e2158c9e">&#9670;&nbsp;</a></span>VmaVirtualAllocationCreateInfo</h2>
<h2 class="memtitle"><span class="permalink"><a href="#gac3c90d80bedc6847a41b82d0e2158c9e">&#9670;&#160;</a></span>VmaVirtualAllocationCreateInfo</h2>
<div class="memitem">
<div class="memproto">
@ -224,7 +231,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="ga75bc33ff7cf18c98e101f570dc2a5ebc" name="ga75bc33ff7cf18c98e101f570dc2a5ebc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga75bc33ff7cf18c98e101f570dc2a5ebc">&#9670;&nbsp;</a></span>VmaVirtualAllocationInfo</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ga75bc33ff7cf18c98e101f570dc2a5ebc">&#9670;&#160;</a></span>VmaVirtualAllocationInfo</h2>
<div class="memitem">
<div class="memproto">
@ -240,7 +247,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="ga0860ba1c0a67178fae4aecb63a78573e" name="ga0860ba1c0a67178fae4aecb63a78573e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0860ba1c0a67178fae4aecb63a78573e">&#9670;&nbsp;</a></span>VmaVirtualBlockCreateFlagBits</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ga0860ba1c0a67178fae4aecb63a78573e">&#9670;&#160;</a></span>VmaVirtualBlockCreateFlagBits</h2>
<div class="memitem">
<div class="memproto">
@ -256,7 +263,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="ga4e49c2f0ab7f6b4868833e5bac78d91e" name="ga4e49c2f0ab7f6b4868833e5bac78d91e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4e49c2f0ab7f6b4868833e5bac78d91e">&#9670;&nbsp;</a></span>VmaVirtualBlockCreateFlags</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ga4e49c2f0ab7f6b4868833e5bac78d91e">&#9670;&#160;</a></span>VmaVirtualBlockCreateFlags</h2>
<div class="memitem">
<div class="memproto">
@ -272,7 +279,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="ga4753d42d40217a3a652a3cdf253ad773" name="ga4753d42d40217a3a652a3cdf253ad773"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4753d42d40217a3a652a3cdf253ad773">&#9670;&nbsp;</a></span>VmaVirtualBlockCreateInfo</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ga4753d42d40217a3a652a3cdf253ad773">&#9670;&#160;</a></span>VmaVirtualBlockCreateInfo</h2>
<div class="memitem">
<div class="memproto">
@ -289,7 +296,7 @@ Functions</h2></td></tr>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga2e9c64d405b14156fea7e10c4ad06cb6" name="ga2e9c64d405b14156fea7e10c4ad06cb6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2e9c64d405b14156fea7e10c4ad06cb6">&#9670;&nbsp;</a></span>VmaVirtualAllocationCreateFlagBits</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ga2e9c64d405b14156fea7e10c4ad06cb6">&#9670;&#160;</a></span>VmaVirtualAllocationCreateFlagBits</h2>
<div class="memitem">
<div class="memproto">
@ -320,7 +327,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="ga88bcf8c1cd3bb1610ff7343811c65bca" name="ga88bcf8c1cd3bb1610ff7343811c65bca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga88bcf8c1cd3bb1610ff7343811c65bca">&#9670;&nbsp;</a></span>VmaVirtualBlockCreateFlagBits</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ga88bcf8c1cd3bb1610ff7343811c65bca">&#9670;&#160;</a></span>VmaVirtualBlockCreateFlagBits</h2>
<div class="memitem">
<div class="memproto">
@ -346,7 +353,7 @@ Functions</h2></td></tr>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga565936f8d98d225b536a2d9703bc7676" name="ga565936f8d98d225b536a2d9703bc7676"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga565936f8d98d225b536a2d9703bc7676">&#9670;&nbsp;</a></span>VK_DEFINE_NON_DISPATCHABLE_HANDLE()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ga565936f8d98d225b536a2d9703bc7676">&#9670;&#160;</a></span>VK_DEFINE_NON_DISPATCHABLE_HANDLE()</h2>
<div class="memitem">
<div class="memproto">
@ -364,7 +371,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="ga93c5741bca44b43e5b849cacbd616098" name="ga93c5741bca44b43e5b849cacbd616098"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga93c5741bca44b43e5b849cacbd616098">&#9670;&nbsp;</a></span>vmaCalculateVirtualBlockStatistics()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ga93c5741bca44b43e5b849cacbd616098">&#9670;&#160;</a></span>vmaCalculateVirtualBlockStatistics()</h2>
<div class="memitem">
<div class="memproto">
@ -395,7 +402,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="ga5eda6f55919fb05bd2f56a112590c571" name="ga5eda6f55919fb05bd2f56a112590c571"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5eda6f55919fb05bd2f56a112590c571">&#9670;&nbsp;</a></span>vmaClearVirtualBlock()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ga5eda6f55919fb05bd2f56a112590c571">&#9670;&#160;</a></span>vmaClearVirtualBlock()</h2>
<div class="memitem">
<div class="memproto">
@ -417,7 +424,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="gab585754076877265fdae33e5c40ef13b" name="gab585754076877265fdae33e5c40ef13b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab585754076877265fdae33e5c40ef13b">&#9670;&nbsp;</a></span>vmaCreateVirtualBlock()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#gab585754076877265fdae33e5c40ef13b">&#9670;&#160;</a></span>vmaCreateVirtualBlock()</h2>
<div class="memitem">
<div class="memproto">
@ -454,7 +461,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="ga3795f7783ae2c182cede067d656f66a5" name="ga3795f7783ae2c182cede067d656f66a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3795f7783ae2c182cede067d656f66a5">&#9670;&nbsp;</a></span>vmaDestroyVirtualBlock()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ga3795f7783ae2c182cede067d656f66a5">&#9670;&#160;</a></span>vmaDestroyVirtualBlock()</h2>
<div class="memitem">
<div class="memproto">
@ -476,7 +483,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="ga8ee14ceb1fe033ec84d8aa29e1f75afa" name="ga8ee14ceb1fe033ec84d8aa29e1f75afa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8ee14ceb1fe033ec84d8aa29e1f75afa">&#9670;&nbsp;</a></span>vmaGetVirtualAllocationInfo()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ga8ee14ceb1fe033ec84d8aa29e1f75afa">&#9670;&#160;</a></span>vmaGetVirtualAllocationInfo()</h2>
<div class="memitem">
<div class="memproto">
@ -512,7 +519,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="ga2902aa3130866afcc64bb5f984113db3" name="ga2902aa3130866afcc64bb5f984113db3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2902aa3130866afcc64bb5f984113db3">&#9670;&nbsp;</a></span>vmaGetVirtualBlockStatistics()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ga2902aa3130866afcc64bb5f984113db3">&#9670;&#160;</a></span>vmaGetVirtualBlockStatistics()</h2>
<div class="memitem">
<div class="memproto">
@ -543,7 +550,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="gacd53b5b1d23f8fcbad692ccfdc1811f1" name="gacd53b5b1d23f8fcbad692ccfdc1811f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacd53b5b1d23f8fcbad692ccfdc1811f1">&#9670;&nbsp;</a></span>vmaIsVirtualBlockEmpty()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#gacd53b5b1d23f8fcbad692ccfdc1811f1">&#9670;&#160;</a></span>vmaIsVirtualBlockEmpty()</h2>
<div class="memitem">
<div class="memproto">
@ -563,7 +570,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="ga001ea1850458a4062b829e09c303fca2" name="ga001ea1850458a4062b829e09c303fca2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga001ea1850458a4062b829e09c303fca2">&#9670;&nbsp;</a></span>vmaSetVirtualAllocationUserData()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ga001ea1850458a4062b829e09c303fca2">&#9670;&#160;</a></span>vmaSetVirtualAllocationUserData()</h2>
<div class="memitem">
<div class="memproto">
@ -599,7 +606,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="ga6b7cdcc1c3e5103c323fedc4e1319e01" name="ga6b7cdcc1c3e5103c323fedc4e1319e01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6b7cdcc1c3e5103c323fedc4e1319e01">&#9670;&nbsp;</a></span>vmaVirtualAllocate()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ga6b7cdcc1c3e5103c323fedc4e1319e01">&#9670;&#160;</a></span>vmaVirtualAllocate()</h2>
<div class="memitem">
<div class="memproto">
@ -651,7 +658,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="ga09fc688c0c3653ff23723b037e5d5033" name="ga09fc688c0c3653ff23723b037e5d5033"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga09fc688c0c3653ff23723b037e5d5033">&#9670;&nbsp;</a></span>vmaVirtualFree()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ga09fc688c0c3653ff23723b037e5d5033">&#9670;&#160;</a></span>vmaVirtualFree()</h2>
<div class="memitem">
<div class="memproto">
@ -684,7 +691,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>