Renamed members of VmaStatInfo structure to start with lower case, to make it consistent with overall style. Compatibility breaking!

This commit is contained in:
Adam Sawicki 2017-09-25 15:46:47 +02:00
parent 067f9082a8
commit 42af34a3b2
13 changed files with 201 additions and 213 deletions

View file

@ -73,45 +73,45 @@ $(function() {
<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>
<tr class="memitem:abc4bb7cd611900778464c56e50c970a4"><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#abc4bb7cd611900778464c56e50c970a4">blockCount</a></td></tr>
<tr class="memdesc:abc4bb7cd611900778464c56e50c970a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of <code>VkDeviceMemory</code> Vulkan memory blocks allocated. <a href="#abc4bb7cd611900778464c56e50c970a4">More...</a><br /></td></tr>
<tr class="separator:abc4bb7cd611900778464c56e50c970a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a537741e4d5cdddc1c0ab95ec650afaff"><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#a537741e4d5cdddc1c0ab95ec650afaff">allocationCount</a></td></tr>
<tr class="memdesc:a537741e4d5cdddc1c0ab95ec650afaff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of <code>VmaAllocation</code> allocation objects allocated. <a href="#a537741e4d5cdddc1c0ab95ec650afaff">More...</a><br /></td></tr>
<tr class="separator:a537741e4d5cdddc1c0ab95ec650afaff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae06129c771bfebfd6468a7f4276502a9"><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#ae06129c771bfebfd6468a7f4276502a9">unusedRangeCount</a></td></tr>
<tr class="memdesc:ae06129c771bfebfd6468a7f4276502a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of free ranges of memory between allocations. <a href="#ae06129c771bfebfd6468a7f4276502a9">More...</a><br /></td></tr>
<tr class="separator:ae06129c771bfebfd6468a7f4276502a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0c6c73837e5a70c749fbd4f6064895a"><td class="memItemLeft" align="right" valign="top">VkDeviceSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_stat_info.html#ab0c6c73837e5a70c749fbd4f6064895a">usedBytes</a></td></tr>
<tr class="memdesc:ab0c6c73837e5a70c749fbd4f6064895a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total number of bytes occupied by all allocations. <a href="#ab0c6c73837e5a70c749fbd4f6064895a">More...</a><br /></td></tr>
<tr class="separator:ab0c6c73837e5a70c749fbd4f6064895a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1859d290aca2cd582d8dc25922092669"><td class="memItemLeft" align="right" valign="top">VkDeviceSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_stat_info.html#a1859d290aca2cd582d8dc25922092669">unusedBytes</a></td></tr>
<tr class="memdesc:a1859d290aca2cd582d8dc25922092669"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total number of bytes occupied by unused ranges. <a href="#a1859d290aca2cd582d8dc25922092669">More...</a><br /></td></tr>
<tr class="separator:a1859d290aca2cd582d8dc25922092669"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade8b40bd3139c04aabd2fc538a356fea"><td class="memItemLeft" align="right" valign="top">VkDeviceSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_stat_info.html#ade8b40bd3139c04aabd2fc538a356fea">allocationSizeMin</a></td></tr>
<tr class="separator:ade8b40bd3139c04aabd2fc538a356fea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1081a039964e566c672e7a2347f9e599"><td class="memItemLeft" align="right" valign="top">VkDeviceSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_stat_info.html#a1081a039964e566c672e7a2347f9e599">allocationSizeAvg</a></td></tr>
<tr class="separator:a1081a039964e566c672e7a2347f9e599"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17e9733a5ecd76287d4db6e66f71f50c"><td class="memItemLeft" align="right" valign="top">VkDeviceSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_stat_info.html#a17e9733a5ecd76287d4db6e66f71f50c">allocationSizeMax</a></td></tr>
<tr class="separator:a17e9733a5ecd76287d4db6e66f71f50c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aedeba931324f16589cd2416c0d2dd0d4"><td class="memItemLeft" align="right" valign="top">VkDeviceSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_stat_info.html#aedeba931324f16589cd2416c0d2dd0d4">unusedRangeSizeMin</a></td></tr>
<tr class="separator:aedeba931324f16589cd2416c0d2dd0d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f9b3452af90c9768a30b7fb6ae194fc"><td class="memItemLeft" align="right" valign="top">VkDeviceSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_stat_info.html#a2f9b3452af90c9768a30b7fb6ae194fc">unusedRangeSizeAvg</a></td></tr>
<tr class="separator:a2f9b3452af90c9768a30b7fb6ae194fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ba1a2476c4d39b10f7e2f7ebbb72ac4"><td class="memItemLeft" align="right" valign="top">VkDeviceSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_stat_info.html#a5ba1a2476c4d39b10f7e2f7ebbb72ac4">unusedRangeSizeMax</a></td></tr>
<tr class="separator:a5ba1a2476c4d39b10f7e2f7ebbb72ac4"><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>
<a id="a537741e4d5cdddc1c0ab95ec650afaff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a537741e4d5cdddc1c0ab95ec650afaff">&#9670;&nbsp;</a></span>allocationCount</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t VmaStatInfo::AllocationCount</td>
<td class="memname">uint32_t VmaStatInfo::allocationCount</td>
</tr>
</table>
</div><div class="memdoc">
@ -120,56 +120,56 @@ Public Attributes</h2></td></tr>
</div>
</div>
<a id="a0019702e4f4ea4ed824aebf250841f21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0019702e4f4ea4ed824aebf250841f21">&#9670;&nbsp;</a></span>AllocationSizeAvg</h2>
<a id="a1081a039964e566c672e7a2347f9e599"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1081a039964e566c672e7a2347f9e599">&#9670;&nbsp;</a></span>allocationSizeAvg</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceSize VmaStatInfo::AllocationSizeAvg</td>
<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>
<a id="a17e9733a5ecd76287d4db6e66f71f50c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17e9733a5ecd76287d4db6e66f71f50c">&#9670;&nbsp;</a></span>allocationSizeMax</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceSize VmaStatInfo::AllocationSizeMax</td>
<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>
<a id="ade8b40bd3139c04aabd2fc538a356fea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade8b40bd3139c04aabd2fc538a356fea">&#9670;&nbsp;</a></span>allocationSizeMin</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceSize VmaStatInfo::AllocationSizeMin</td>
<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>
<a id="abc4bb7cd611900778464c56e50c970a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc4bb7cd611900778464c56e50c970a4">&#9670;&nbsp;</a></span>blockCount</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t VmaStatInfo::BlockCount</td>
<td class="memname">uint32_t VmaStatInfo::blockCount</td>
</tr>
</table>
</div><div class="memdoc">
@ -178,14 +178,14 @@ Public Attributes</h2></td></tr>
</div>
</div>
<a id="a394d2aef4348cb58abf73764804b4f2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a394d2aef4348cb58abf73764804b4f2d">&#9670;&nbsp;</a></span>UnusedBytes</h2>
<a id="a1859d290aca2cd582d8dc25922092669"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1859d290aca2cd582d8dc25922092669">&#9670;&nbsp;</a></span>unusedBytes</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceSize VmaStatInfo::UnusedBytes</td>
<td class="memname">VkDeviceSize VmaStatInfo::unusedBytes</td>
</tr>
</table>
</div><div class="memdoc">
@ -194,14 +194,14 @@ Public Attributes</h2></td></tr>
</div>
</div>
<a id="a56c4fb4dba646479180b601854cde2a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56c4fb4dba646479180b601854cde2a6">&#9670;&nbsp;</a></span>UnusedRangeCount</h2>
<a id="ae06129c771bfebfd6468a7f4276502a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae06129c771bfebfd6468a7f4276502a9">&#9670;&nbsp;</a></span>unusedRangeCount</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t VmaStatInfo::UnusedRangeCount</td>
<td class="memname">uint32_t VmaStatInfo::unusedRangeCount</td>
</tr>
</table>
</div><div class="memdoc">
@ -210,56 +210,56 @@ Public Attributes</h2></td></tr>
</div>
</div>
<a id="a88ad9bdc2b3a98964a4d0c338c0c9060"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88ad9bdc2b3a98964a4d0c338c0c9060">&#9670;&nbsp;</a></span>UnusedRangeSizeAvg</h2>
<a id="a2f9b3452af90c9768a30b7fb6ae194fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f9b3452af90c9768a30b7fb6ae194fc">&#9670;&nbsp;</a></span>unusedRangeSizeAvg</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceSize VmaStatInfo::UnusedRangeSizeAvg</td>
<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>
<a id="a5ba1a2476c4d39b10f7e2f7ebbb72ac4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ba1a2476c4d39b10f7e2f7ebbb72ac4">&#9670;&nbsp;</a></span>unusedRangeSizeMax</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceSize VmaStatInfo::UnusedRangeSizeMax</td>
<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>
<a id="aedeba931324f16589cd2416c0d2dd0d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aedeba931324f16589cd2416c0d2dd0d4">&#9670;&nbsp;</a></span>unusedRangeSizeMin</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceSize VmaStatInfo::UnusedRangeSizeMin</td>
<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>
<a id="ab0c6c73837e5a70c749fbd4f6064895a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0c6c73837e5a70c749fbd4f6064895a">&#9670;&nbsp;</a></span>usedBytes</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceSize VmaStatInfo::UsedBytes</td>
<td class="memname">VkDeviceSize VmaStatInfo::usedBytes</td>
</tr>
</table>
</div><div class="memdoc">