mirror/VulkanMemoryAllocator
1
0
Fork 0
mirror of https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator.git synced 2024-11-10 10:41:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
067f9082a8
VulkanMemoryAllocator/docs/html/struct_vma_stat_info.html
Adam Sawicki 067f9082a8 Some improvements in documentation.
2017-09-25 15:29:34 +02:00

283 lines
14 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Vulkan Memory Allocator: VmaStatInfo 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">Vulkan Memory Allocator
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="struct_vma_stat_info-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">VmaStatInfo Struct Reference<div class="ingroups"><a class="el" href="group__general.html">General</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Calculated statistics of memory usage in entire allocator.
<a href="struct_vma_stat_info.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="vk__mem__alloc_8h_source.html">vk_mem_alloc.h</a>&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:a9af0d9809007cf4a0009d324b2b8bbc9"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_stat_info.html#a9af0d9809007cf4a0009d324b2b8bbc9">BlockCount</a></td></tr>
<tr class="memdesc:a9af0d9809007cf4a0009d324b2b8bbc9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of <code>VkDeviceMemory</code> Vulkan memory blocks allocated. <a href="#a9af0d9809007cf4a0009d324b2b8bbc9">More...</a><br /></td></tr>
<tr class="separator:a9af0d9809007cf4a0009d324b2b8bbc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a240402222ac6777e4079653c5d542cb0"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_stat_info.html#a240402222ac6777e4079653c5d542cb0">AllocationCount</a></td></tr>
<tr class="memdesc:a240402222ac6777e4079653c5d542cb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of <code>VmaAllocation</code> allocation objects allocated. <a href="#a240402222ac6777e4079653c5d542cb0">More...</a><br /></td></tr>
<tr class="separator:a240402222ac6777e4079653c5d542cb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56c4fb4dba646479180b601854cde2a6"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_stat_info.html#a56c4fb4dba646479180b601854cde2a6">UnusedRangeCount</a></td></tr>
<tr class="memdesc:a56c4fb4dba646479180b601854cde2a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of free ranges of memory between allocations. <a href="#a56c4fb4dba646479180b601854cde2a6">More...</a><br /></td></tr>
<tr class="separator:a56c4fb4dba646479180b601854cde2a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86f82cb9cffd456b9da63eaf26c9ff04"><td class="memItemLeft" align="right" valign="top">VkDeviceSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_stat_info.html#a86f82cb9cffd456b9da63eaf26c9ff04">UsedBytes</a></td></tr>
<tr class="memdesc:a86f82cb9cffd456b9da63eaf26c9ff04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total number of bytes occupied by all allocations. <a href="#a86f82cb9cffd456b9da63eaf26c9ff04">More...</a><br /></td></tr>
<tr class="separator:a86f82cb9cffd456b9da63eaf26c9ff04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a394d2aef4348cb58abf73764804b4f2d"><td class="memItemLeft" align="right" valign="top">VkDeviceSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_stat_info.html#a394d2aef4348cb58abf73764804b4f2d">UnusedBytes</a></td></tr>
<tr class="memdesc:a394d2aef4348cb58abf73764804b4f2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total number of bytes occupied by unused ranges. <a href="#a394d2aef4348cb58abf73764804b4f2d">More...</a><br /></td></tr>
<tr class="separator:a394d2aef4348cb58abf73764804b4f2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61a834fa78bcf41fb5a53b286b2e1580"><td class="memItemLeft" align="right" valign="top">VkDeviceSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_stat_info.html#a61a834fa78bcf41fb5a53b286b2e1580">AllocationSizeMin</a></td></tr>
<tr class="separator:a61a834fa78bcf41fb5a53b286b2e1580"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0019702e4f4ea4ed824aebf250841f21"><td class="memItemLeft" align="right" valign="top">VkDeviceSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_stat_info.html#a0019702e4f4ea4ed824aebf250841f21">AllocationSizeAvg</a></td></tr>
<tr class="separator:a0019702e4f4ea4ed824aebf250841f21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba2ef16e2ac09b97305c58a168a3805c"><td class="memItemLeft" align="right" valign="top">VkDeviceSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_stat_info.html#aba2ef16e2ac09b97305c58a168a3805c">AllocationSizeMax</a></td></tr>
<tr class="separator:aba2ef16e2ac09b97305c58a168a3805c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07c508f42a4d3424bd0c259784a7f2d6"><td class="memItemLeft" align="right" valign="top">VkDeviceSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_stat_info.html#a07c508f42a4d3424bd0c259784a7f2d6">UnusedRangeSizeMin</a></td></tr>
<tr class="separator:a07c508f42a4d3424bd0c259784a7f2d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88ad9bdc2b3a98964a4d0c338c0c9060"><td class="memItemLeft" align="right" valign="top">VkDeviceSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_stat_info.html#a88ad9bdc2b3a98964a4d0c338c0c9060">UnusedRangeSizeAvg</a></td></tr>
<tr class="separator:a88ad9bdc2b3a98964a4d0c338c0c9060"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10c52c0841f01ca704e8ddb1ea6a635d"><td class="memItemLeft" align="right" valign="top">VkDeviceSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_stat_info.html#a10c52c0841f01ca704e8ddb1ea6a635d">UnusedRangeSizeMax</a></td></tr>
<tr class="separator:a10c52c0841f01ca704e8ddb1ea6a635d"><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="a240402222ac6777e4079653c5d542cb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a240402222ac6777e4079653c5d542cb0">&#9670;&nbsp;</a></span>AllocationCount</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t VmaStatInfo::AllocationCount</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of <code>VmaAllocation</code> allocation objects allocated. </p>
</div>
</div>
<a id="a0019702e4f4ea4ed824aebf250841f21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0019702e4f4ea4ed824aebf250841f21">&#9670;&nbsp;</a></span>AllocationSizeAvg</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceSize VmaStatInfo::AllocationSizeAvg</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aba2ef16e2ac09b97305c58a168a3805c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba2ef16e2ac09b97305c58a168a3805c">&#9670;&nbsp;</a></span>AllocationSizeMax</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceSize VmaStatInfo::AllocationSizeMax</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a61a834fa78bcf41fb5a53b286b2e1580"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61a834fa78bcf41fb5a53b286b2e1580">&#9670;&nbsp;</a></span>AllocationSizeMin</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceSize VmaStatInfo::AllocationSizeMin</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a9af0d9809007cf4a0009d324b2b8bbc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9af0d9809007cf4a0009d324b2b8bbc9">&#9670;&nbsp;</a></span>BlockCount</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t VmaStatInfo::BlockCount</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of <code>VkDeviceMemory</code> Vulkan memory blocks allocated. </p>
</div>
</div>
<a id="a394d2aef4348cb58abf73764804b4f2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a394d2aef4348cb58abf73764804b4f2d">&#9670;&nbsp;</a></span>UnusedBytes</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceSize VmaStatInfo::UnusedBytes</td>
</tr>
</table>
</div><div class="memdoc">
<p>Total number of bytes occupied by unused ranges. </p>
</div>
</div>
<a id="a56c4fb4dba646479180b601854cde2a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56c4fb4dba646479180b601854cde2a6">&#9670;&nbsp;</a></span>UnusedRangeCount</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t VmaStatInfo::UnusedRangeCount</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of free ranges of memory between allocations. </p>
</div>
</div>
<a id="a88ad9bdc2b3a98964a4d0c338c0c9060"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88ad9bdc2b3a98964a4d0c338c0c9060">&#9670;&nbsp;</a></span>UnusedRangeSizeAvg</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceSize VmaStatInfo::UnusedRangeSizeAvg</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a10c52c0841f01ca704e8ddb1ea6a635d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10c52c0841f01ca704e8ddb1ea6a635d">&#9670;&nbsp;</a></span>UnusedRangeSizeMax</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceSize VmaStatInfo::UnusedRangeSizeMax</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a07c508f42a4d3424bd0c259784a7f2d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07c508f42a4d3424bd0c259784a7f2d6">&#9670;&nbsp;</a></span>UnusedRangeSizeMin</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceSize VmaStatInfo::UnusedRangeSizeMin</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a86f82cb9cffd456b9da63eaf26c9ff04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a86f82cb9cffd456b9da63eaf26c9ff04">&#9670;&nbsp;</a></span>UsedBytes</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceSize VmaStatInfo::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="vk__mem__alloc_8h_source.html">vk_mem_alloc.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink