<p>API elements that query current status of the allocator, from memory usage, budget, to full dump of the internal state in JSON format. See documentation chapter: <aclass="el"href="statistics.html">Statistics</a>.
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Calculated statistics of memory usage e.g. in a specific memory type, heap, custom pool, or total. <ahref="struct_vma_statistics.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">More detailed statistics than <aclass="el"href="struct_vma_statistics.html"title="Calculated statistics of memory usage e.g. in a specific memory type, heap, custom pool,...">VmaStatistics</a>. <ahref="struct_vma_detailed_statistics.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">General statistics from current state of the Allocator - total memory usage across all memory heaps and types. <ahref="struct_vma_total_statistics.html#details">More...</a><br/></td></tr>
<trclass="memdesc:"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Statistics of current memory usage and available budget for a specific memory heap. <ahref="struct_vma_budget.html#details">More...</a><br/></td></tr>
<trclass="memdesc:gac94bd1a382a3922ddc8de3af4d3ddd06"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Calculated statistics of memory usage e.g. in a specific memory type, heap, custom pool, or total. <ahref="group__group__stats.html#gac94bd1a382a3922ddc8de3af4d3ddd06">More...</a><br/></td></tr>
<trclass="memdesc:ga9ab0c535a6ca655dc63b8609ab4b8394"><tdclass="mdescLeft"> </td><tdclass="mdescRight">More detailed statistics than <aclass="el"href="struct_vma_statistics.html"title="Calculated statistics of memory usage e.g. in a specific memory type, heap, custom pool,...">VmaStatistics</a>. <ahref="group__group__stats.html#ga9ab0c535a6ca655dc63b8609ab4b8394">More...</a><br/></td></tr>
<trclass="memdesc:ga68916e729e55d513f88ffafbadddb770"><tdclass="mdescLeft"> </td><tdclass="mdescRight">General statistics from current state of the Allocator - total memory usage across all memory heaps and types. <ahref="group__group__stats.html#ga68916e729e55d513f88ffafbadddb770">More...</a><br/></td></tr>
<trclass="memdesc:gaa078667e71b1ef24e87a6a30d128381d"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Statistics of current memory usage and available budget for a specific memory heap. <ahref="group__group__stats.html#gaa078667e71b1ef24e87a6a30d128381d">More...</a><br/></td></tr>
<trclass="memdesc:ga36f3484de7aa6cd6edc4de9edfa0ff59"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Retrieves statistics from current state of the Allocator. <ahref="group__group__stats.html#ga36f3484de7aa6cd6edc4de9edfa0ff59">More...</a><br/></td></tr>
<trclass="memdesc:ga9f88db9d46a432c0ad7278cecbc5eaa7"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Retrieves information about current memory usage and budget for all memory heaps. <ahref="group__group__stats.html#ga9f88db9d46a432c0ad7278cecbc5eaa7">More...</a><br/></td></tr>
<trclass="memdesc:ga52d810e1222c592e5d80556ad005f1e6"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Builds and returns a null-terminated string in JSON format with information about given <aclass="el"href="struct_vma_virtual_block.html"title="Handle to a virtual block object that allows to use core allocation algorithm without allocating any ...">VmaVirtualBlock</a>. <ahref="group__group__stats.html#ga52d810e1222c592e5d80556ad005f1e6">More...</a><br/></td></tr>
<trclass="memdesc:ga47fb8d8aa69df4a7c23a9719b4080623"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Frees a string returned by <aclass="el"href="group__group__stats.html#ga52d810e1222c592e5d80556ad005f1e6"title="Builds and returns a null-terminated string in JSON format with information about given VmaVirtualBlo...">vmaBuildVirtualBlockStatsString()</a>. <ahref="group__group__stats.html#ga47fb8d8aa69df4a7c23a9719b4080623">More...</a><br/></td></tr>
<trclass="memdesc:gaa4fee7eb5253377599ef4fd38c93c2a0"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Builds and returns statistics as a null-terminated string in JSON format. <ahref="group__group__stats.html#gaa4fee7eb5253377599ef4fd38c93c2a0">More...</a><br/></td></tr>
<p>API elements that query current status of the allocator, from memory usage, budget, to full dump of the internal state in JSON format. See documentation chapter: <aclass="el"href="statistics.html">Statistics</a>. </p>
<p>Statistics of current memory usage and available budget for a specific memory heap. </p>
<p>These are fast to calculate. See function <aclass="el"href="group__group__stats.html#ga9f88db9d46a432c0ad7278cecbc5eaa7"title="Retrieves information about current memory usage and budget for all memory heaps.">vmaGetHeapBudgets()</a>. </p>
<p>More detailed statistics than <aclass="el"href="struct_vma_statistics.html"title="Calculated statistics of memory usage e.g. in a specific memory type, heap, custom pool,...">VmaStatistics</a>. </p>
<p>These are slower to calculate. Use for debugging purposes. See functions: <aclass="el"href="group__group__stats.html#ga36f3484de7aa6cd6edc4de9edfa0ff59"title="Retrieves statistics from current state of the Allocator.">vmaCalculateStatistics()</a>, <aclass="el"href="group__group__stats.html#ga50ba0eb25d2b363b792be4645ca7a380"title="Retrieves detailed statistics of existing VmaPool object.">vmaCalculatePoolStatistics()</a>.</p>
<p>Previous version of the statistics API provided averages, but they have been removed because they can be easily calculated as:</p>
<p>Calculated statistics of memory usage e.g. in a specific memory type, heap, custom pool, or total. </p>
<p>These are fast to calculate. See functions: <aclass="el"href="group__group__stats.html#ga9f88db9d46a432c0ad7278cecbc5eaa7"title="Retrieves information about current memory usage and budget for all memory heaps.">vmaGetHeapBudgets()</a>, <aclass="el"href="group__group__stats.html#ga34d8e7d83774eed0caee5c5ae88e217d"title="Retrieves statistics of existing VmaPool object.">vmaGetPoolStatistics()</a>. </p>
<p>General statistics from current state of the Allocator - total memory usage across all memory heaps and types. </p>
<p>These are slower to calculate. Use for debugging purposes. See function <aclass="el"href="group__group__stats.html#ga36f3484de7aa6cd6edc4de9edfa0ff59"title="Retrieves statistics from current state of the Allocator.">vmaCalculateStatistics()</a>. </p>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">ppStatsString</td><td>Must be freed using <aclass="el"href="group__group__stats.html#ga3104eb30d8122c84dd8541063f145288">vmaFreeStatsString()</a> function. </td></tr>
<p>Builds and returns a null-terminated string in JSON format with information about given <aclass="el"href="struct_vma_virtual_block.html"title="Handle to a virtual block object that allows to use core allocation algorithm without allocating any ...">VmaVirtualBlock</a>. </p>
<tr><tdclass="paramdir"></td><tdclass="paramname">detailedMap</td><td>Pass <code>VK_FALSE</code> to only obtain statistics as returned by <aclass="el"href="group__group__virtual.html#ga93c5741bca44b43e5b849cacbd616098"title="Calculates and returns detailed statistics about virtual allocations and memory usage in given VmaVir...">vmaCalculateVirtualBlockStatistics()</a>. Pass <code>VK_TRUE</code> to also obtain full list of allocations and free spaces.</td></tr>
<p>Returned string must be freed using <aclass="el"href="group__group__stats.html#ga47fb8d8aa69df4a7c23a9719b4080623"title="Frees a string returned by vmaBuildVirtualBlockStatsString().">vmaFreeVirtualBlockStatsString()</a>. </p>
<p>This function is called "calculate" not "get" because it has to traverse all internal data structures, so it may be quite slow. Use it for debugging purposes. For faster but more brief statistics suitable to be called every frame or every allocation, use <aclass="el"href="group__group__stats.html#ga9f88db9d46a432c0ad7278cecbc5eaa7"title="Retrieves information about current memory usage and budget for all memory heaps.">vmaGetHeapBudgets()</a>.</p>
<p>Frees a string returned by <aclass="el"href="group__group__stats.html#ga52d810e1222c592e5d80556ad005f1e6"title="Builds and returns a null-terminated string in JSON format with information about given VmaVirtualBlo...">vmaBuildVirtualBlockStatsString()</a>. </p>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">pBudgets</td><td>Must point to array with number of elements at least equal to number of memory heaps in physical device used.</td></tr>
<p>This function is called "get" not "calculate" because it is very fast, suitable to be called every frame or every allocation. For more detailed statistics use <aclass="el"href="group__group__stats.html#ga36f3484de7aa6cd6edc4de9edfa0ff59"title="Retrieves statistics from current state of the Allocator.">vmaCalculateStatistics()</a>.</p>
