| <!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=11"/> |
| <meta name="generator" content="Doxygen 1.9.3"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Direct3D 12 Memory Allocator: D3D12MA::TotalStatistics 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 id="projectrow"> |
| <td id="projectalign"> |
| <div id="projectname">Direct3D 12 Memory Allocator |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.3 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| var searchBox = new SearchBox("searchBox", "search",'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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(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_total_statistics.html">TotalStatistics</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="struct_d3_d12_m_a_1_1_total_statistics-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">D3D12MA::TotalStatistics Struct Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>General statistics from current state of the allocator - total memory usage across all memory heaps and segments. |
| <a href="struct_d3_d12_m_a_1_1_total_statistics.html#details">More...</a></p> |
| |
| <p><code>#include <D3D12MemAlloc.h></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:a07247152fc70a8ee5605cab0fe220ea5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_d3_d12_m_a_1_1_detailed_statistics.html">DetailedStatistics</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_d3_d12_m_a_1_1_total_statistics.html#a07247152fc70a8ee5605cab0fe220ea5">HeapType</a> [4]</td></tr> |
| <tr class="memdesc:a07247152fc70a8ee5605cab0fe220ea5"><td class="mdescLeft"> </td><td class="mdescRight">One element for each type of heap located at the following indices: <a href="struct_d3_d12_m_a_1_1_total_statistics.html#a07247152fc70a8ee5605cab0fe220ea5">More...</a><br /></td></tr> |
| <tr class="separator:a07247152fc70a8ee5605cab0fe220ea5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aed7d22d5cd773aa896bc4c786c7f3650"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_d3_d12_m_a_1_1_detailed_statistics.html">DetailedStatistics</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_d3_d12_m_a_1_1_total_statistics.html#aed7d22d5cd773aa896bc4c786c7f3650">MemorySegmentGroup</a> [2]</td></tr> |
| <tr class="memdesc:aed7d22d5cd773aa896bc4c786c7f3650"><td class="mdescLeft"> </td><td class="mdescRight">One element for each memory segment group located at the following indices: <a href="struct_d3_d12_m_a_1_1_total_statistics.html#aed7d22d5cd773aa896bc4c786c7f3650">More...</a><br /></td></tr> |
| <tr class="separator:aed7d22d5cd773aa896bc4c786c7f3650"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac0bb53579457ddec2872c547ae8922a6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_d3_d12_m_a_1_1_detailed_statistics.html">DetailedStatistics</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_d3_d12_m_a_1_1_total_statistics.html#ac0bb53579457ddec2872c547ae8922a6">Total</a></td></tr> |
| <tr class="memdesc:ac0bb53579457ddec2872c547ae8922a6"><td class="mdescLeft"> </td><td class="mdescRight">Total statistics from all memory allocated from D3D12. <a href="struct_d3_d12_m_a_1_1_total_statistics.html#ac0bb53579457ddec2872c547ae8922a6">More...</a><br /></td></tr> |
| <tr class="separator:ac0bb53579457ddec2872c547ae8922a6"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p >General statistics from current state of the allocator - total memory usage across all memory heaps and segments. </p> |
| <p >These are slower to calculate. Use for debugging purposes. See function <a class="el" href="class_d3_d12_m_a_1_1_allocator.html#a99db00df909963573a976c203b107d22" title="Retrieves statistics from current state of the allocator.">D3D12MA::Allocator::CalculateStatistics()</a>. </p> |
| </div><h2 class="groupheader">Member Data Documentation</h2> |
| <a id="a07247152fc70a8ee5605cab0fe220ea5" name="a07247152fc70a8ee5605cab0fe220ea5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a07247152fc70a8ee5605cab0fe220ea5">◆ </a></span>HeapType</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="struct_d3_d12_m_a_1_1_detailed_statistics.html">DetailedStatistics</a> D3D12MA::TotalStatistics::HeapType[4]</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>One element for each type of heap located at the following indices: </p> |
| <ul> |
| <li>0 = <code>D3D12_HEAP_TYPE_DEFAULT</code></li> |
| <li>1 = <code>D3D12_HEAP_TYPE_UPLOAD</code></li> |
| <li>2 = <code>D3D12_HEAP_TYPE_READBACK</code></li> |
| <li>3 = <code>D3D12_HEAP_TYPE_CUSTOM</code> </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a id="aed7d22d5cd773aa896bc4c786c7f3650" name="aed7d22d5cd773aa896bc4c786c7f3650"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aed7d22d5cd773aa896bc4c786c7f3650">◆ </a></span>MemorySegmentGroup</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="struct_d3_d12_m_a_1_1_detailed_statistics.html">DetailedStatistics</a> D3D12MA::TotalStatistics::MemorySegmentGroup[2]</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>One element for each memory segment group located at the following indices: </p> |
| <ul> |
| <li>0 = <code>DXGI_MEMORY_SEGMENT_GROUP_LOCAL</code></li> |
| <li>1 = <code>DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL</code></li> |
| </ul> |
| <p >Meaning of these segment groups is:</p> |
| <ul> |
| <li>When <code>IsUMA() == FALSE</code> (discrete graphics card):<ul> |
| <li><code>DXGI_MEMORY_SEGMENT_GROUP_LOCAL</code> (index 0) represents GPU memory (resources allocated in <code>D3D12_HEAP_TYPE_DEFAULT</code> or <code>D3D12_MEMORY_POOL_L1</code>).</li> |
| <li><code>DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL</code> (index 1) represents system memory (resources allocated in <code>D3D12_HEAP_TYPE_UPLOAD</code>, <code>D3D12_HEAP_TYPE_READBACK</code>, or <code>D3D12_MEMORY_POOL_L0</code>).</li> |
| </ul> |
| </li> |
| <li>When <code>IsUMA() == TRUE</code> (integrated graphics chip):<ul> |
| <li><code>DXGI_MEMORY_SEGMENT_GROUP_LOCAL</code> = (index 0) represents memory shared for all the resources.</li> |
| <li><code>DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL</code> = (index 1) is unused and always 0. </li> |
| </ul> |
| </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a id="ac0bb53579457ddec2872c547ae8922a6" name="ac0bb53579457ddec2872c547ae8922a6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac0bb53579457ddec2872c547ae8922a6">◆ </a></span>Total</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="struct_d3_d12_m_a_1_1_detailed_statistics.html">DetailedStatistics</a> D3D12MA::TotalStatistics::Total</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Total statistics from all memory allocated from D3D12. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this struct was generated from the following file:<ul> |
| <li>D:/PROJECTS/D3D12 Memory Allocator/REPO/include/<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 <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3 |
| </small></address> |
| </body> |
| </html> |