blob: 0c5ea99cf209ab0677558ee9243f47d1d2fe5cd8 [file] [log] [blame]
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Direct3D 12 Memory Allocator: D3D12MA::StatInfo Struct Reference</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>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Direct3D 12 Memory Allocator
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_d3_d12_m_a.html">D3D12MA</a></li><li class="navelem"><a class="el" href="struct_d3_d12_m_a_1_1_stat_info.html">StatInfo</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="struct_d3_d12_m_a_1_1_stat_info-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">D3D12MA::StatInfo Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Calculated statistics of memory usage in entire allocator.
<a href="struct_d3_d12_m_a_1_1_stat_info.html#details">More...</a></p>
<p><code>#include &lt;D3D12MemAlloc.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a8284ef3310c9de1600071285448b62c9"><td class="memItemLeft" align="right" valign="top">UINT&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_d3_d12_m_a_1_1_stat_info.html#a8284ef3310c9de1600071285448b62c9">BlockCount</a></td></tr>
<tr class="memdesc:a8284ef3310c9de1600071285448b62c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of memory blocks (heaps) allocated. <a href="struct_d3_d12_m_a_1_1_stat_info.html#a8284ef3310c9de1600071285448b62c9">More...</a><br /></td></tr>
<tr class="separator:a8284ef3310c9de1600071285448b62c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f50de812e296b71594174ff67bbac6e"><td class="memItemLeft" align="right" valign="top">UINT&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_d3_d12_m_a_1_1_stat_info.html#a2f50de812e296b71594174ff67bbac6e">AllocationCount</a></td></tr>
<tr class="memdesc:a2f50de812e296b71594174ff67bbac6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of <a class="el" href="class_d3_d12_m_a_1_1_allocation.html" title="Represents single memory allocation.">D3D12MA::Allocation</a> objects allocated. <a href="struct_d3_d12_m_a_1_1_stat_info.html#a2f50de812e296b71594174ff67bbac6e">More...</a><br /></td></tr>
<tr class="separator:a2f50de812e296b71594174ff67bbac6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfc245a84fb8fba7936b67bd879ffefb"><td class="memItemLeft" align="right" valign="top">UINT&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_d3_d12_m_a_1_1_stat_info.html#adfc245a84fb8fba7936b67bd879ffefb">UnusedRangeCount</a></td></tr>
<tr class="memdesc:adfc245a84fb8fba7936b67bd879ffefb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of free ranges of memory between allocations. <a href="struct_d3_d12_m_a_1_1_stat_info.html#adfc245a84fb8fba7936b67bd879ffefb">More...</a><br /></td></tr>
<tr class="separator:adfc245a84fb8fba7936b67bd879ffefb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4f3379ea88025e4ccf5880fab2699f7"><td class="memItemLeft" align="right" valign="top">UINT64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_d3_d12_m_a_1_1_stat_info.html#ac4f3379ea88025e4ccf5880fab2699f7">UsedBytes</a></td></tr>
<tr class="memdesc:ac4f3379ea88025e4ccf5880fab2699f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total number of bytes occupied by all allocations. <a href="struct_d3_d12_m_a_1_1_stat_info.html#ac4f3379ea88025e4ccf5880fab2699f7">More...</a><br /></td></tr>
<tr class="separator:ac4f3379ea88025e4ccf5880fab2699f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1df359c2e9ad4c7763122d1ccd86b168"><td class="memItemLeft" align="right" valign="top">UINT64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_d3_d12_m_a_1_1_stat_info.html#a1df359c2e9ad4c7763122d1ccd86b168">UnusedBytes</a></td></tr>
<tr class="memdesc:a1df359c2e9ad4c7763122d1ccd86b168"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total number of bytes occupied by unused ranges. <a href="struct_d3_d12_m_a_1_1_stat_info.html#a1df359c2e9ad4c7763122d1ccd86b168">More...</a><br /></td></tr>
<tr class="separator:a1df359c2e9ad4c7763122d1ccd86b168"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d9e69e9cad231fea3a41b06e7eeee35"><td class="memItemLeft" align="right" valign="top">UINT64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_d3_d12_m_a_1_1_stat_info.html#a9d9e69e9cad231fea3a41b06e7eeee35">AllocationSizeMin</a></td></tr>
<tr class="separator:a9d9e69e9cad231fea3a41b06e7eeee35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf3339540ff01d93b6a6f5dc68d83f60"><td class="memItemLeft" align="right" valign="top">UINT64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_d3_d12_m_a_1_1_stat_info.html#acf3339540ff01d93b6a6f5dc68d83f60">AllocationSizeAvg</a></td></tr>
<tr class="separator:acf3339540ff01d93b6a6f5dc68d83f60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd3c6f72ffb61a8d39b65a3dab317eb6"><td class="memItemLeft" align="right" valign="top">UINT64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_d3_d12_m_a_1_1_stat_info.html#acd3c6f72ffb61a8d39b65a3dab317eb6">AllocationSizeMax</a></td></tr>
<tr class="separator:acd3c6f72ffb61a8d39b65a3dab317eb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a180be027720ca98ff3a7470e18a79622"><td class="memItemLeft" align="right" valign="top">UINT64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_d3_d12_m_a_1_1_stat_info.html#a180be027720ca98ff3a7470e18a79622">UnusedRangeSizeMin</a></td></tr>
<tr class="separator:a180be027720ca98ff3a7470e18a79622"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a249d7969bf3f836c13a0f111d6ed886d"><td class="memItemLeft" align="right" valign="top">UINT64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_d3_d12_m_a_1_1_stat_info.html#a249d7969bf3f836c13a0f111d6ed886d">UnusedRangeSizeAvg</a></td></tr>
<tr class="separator:a249d7969bf3f836c13a0f111d6ed886d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1337269f8777b6b5176c72ca410fbe36"><td class="memItemLeft" align="right" valign="top">UINT64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_d3_d12_m_a_1_1_stat_info.html#a1337269f8777b6b5176c72ca410fbe36">UnusedRangeSizeMax</a></td></tr>
<tr class="separator:a1337269f8777b6b5176c72ca410fbe36"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Calculated statistics of memory usage in entire allocator. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a2f50de812e296b71594174ff67bbac6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f50de812e296b71594174ff67bbac6e">&#9670;&nbsp;</a></span>AllocationCount</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UINT D3D12MA::StatInfo::AllocationCount</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of <a class="el" href="class_d3_d12_m_a_1_1_allocation.html" title="Represents single memory allocation.">D3D12MA::Allocation</a> objects allocated. </p>
</div>
</div>
<a id="acf3339540ff01d93b6a6f5dc68d83f60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf3339540ff01d93b6a6f5dc68d83f60">&#9670;&nbsp;</a></span>AllocationSizeAvg</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UINT64 D3D12MA::StatInfo::AllocationSizeAvg</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="acd3c6f72ffb61a8d39b65a3dab317eb6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd3c6f72ffb61a8d39b65a3dab317eb6">&#9670;&nbsp;</a></span>AllocationSizeMax</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UINT64 D3D12MA::StatInfo::AllocationSizeMax</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a9d9e69e9cad231fea3a41b06e7eeee35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d9e69e9cad231fea3a41b06e7eeee35">&#9670;&nbsp;</a></span>AllocationSizeMin</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UINT64 D3D12MA::StatInfo::AllocationSizeMin</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a8284ef3310c9de1600071285448b62c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8284ef3310c9de1600071285448b62c9">&#9670;&nbsp;</a></span>BlockCount</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UINT D3D12MA::StatInfo::BlockCount</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of memory blocks (heaps) allocated. </p>
</div>
</div>
<a id="a1df359c2e9ad4c7763122d1ccd86b168"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1df359c2e9ad4c7763122d1ccd86b168">&#9670;&nbsp;</a></span>UnusedBytes</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UINT64 D3D12MA::StatInfo::UnusedBytes</td>
</tr>
</table>
</div><div class="memdoc">
<p>Total number of bytes occupied by unused ranges. </p>
</div>
</div>
<a id="adfc245a84fb8fba7936b67bd879ffefb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfc245a84fb8fba7936b67bd879ffefb">&#9670;&nbsp;</a></span>UnusedRangeCount</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UINT D3D12MA::StatInfo::UnusedRangeCount</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of free ranges of memory between allocations. </p>
</div>
</div>
<a id="a249d7969bf3f836c13a0f111d6ed886d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a249d7969bf3f836c13a0f111d6ed886d">&#9670;&nbsp;</a></span>UnusedRangeSizeAvg</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UINT64 D3D12MA::StatInfo::UnusedRangeSizeAvg</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a1337269f8777b6b5176c72ca410fbe36"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1337269f8777b6b5176c72ca410fbe36">&#9670;&nbsp;</a></span>UnusedRangeSizeMax</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UINT64 D3D12MA::StatInfo::UnusedRangeSizeMax</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a180be027720ca98ff3a7470e18a79622"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a180be027720ca98ff3a7470e18a79622">&#9670;&nbsp;</a></span>UnusedRangeSizeMin</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UINT64 D3D12MA::StatInfo::UnusedRangeSizeMin</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ac4f3379ea88025e4ccf5880fab2699f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4f3379ea88025e4ccf5880fab2699f7">&#9670;&nbsp;</a></span>UsedBytes</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UINT64 D3D12MA::StatInfo::UsedBytes</td>
</tr>
</table>
</div><div class="memdoc">
<p>Total number of bytes occupied by all allocations. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="_d3_d12_mem_alloc_8h.html">D3D12MemAlloc.h</a></li>
</ul>
</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.1
</small></address>
</body>
</html>