2022-02-22 14:19:35 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2022-11-04 16:02:24 +00:00
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "en-US" >
2022-02-22 14:19:35 +00:00
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=11" / >
2023-11-08 17:01:19 +00:00
< meta name = "generator" content = "Doxygen 1.9.8" / >
2022-02-22 14:19:35 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > Vulkan Memory Allocator: VmaDetailedStatistics 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 >
2022-03-14 17:05:55 +00:00
< tr id = "projectrow" >
< td id = "projectalign" >
2022-02-22 14:19:35 +00:00
< div id = "projectname" > Vulkan Memory Allocator
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2023-11-08 17:01:19 +00:00
<!-- Generated by Doxygen 1.9.8 -->
2022-02-22 14:19:35 +00:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
2022-11-04 16:02:24 +00:00
var searchBox = new SearchBox("searchBox", "search/",'.html');
2022-02-22 14:19:35 +00:00
/* @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" >
2022-11-04 16:02:24 +00:00
< div id = "MSearchResults" >
< div class = "SRPage" >
< div id = "SRIndex" >
< div id = "SRResults" > < / div >
< div class = "SRStatus" id = "Loading" > Loading...< / div >
< div class = "SRStatus" id = "Searching" > Searching...< / div >
< div class = "SRStatus" id = "NoMatches" > No Matches< / div >
< / div >
< / div >
< / div >
2022-02-22 14:19:35 +00:00
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "summary" >
< a href = "#pub-attribs" > Public Attributes< / a > |
< a href = "struct_vma_detailed_statistics-members.html" > List of all members< / a > < / div >
< div class = "headertitle" > < div class = "title" > VmaDetailedStatistics Struct Reference< div class = "ingroups" > < a class = "el" href = "group__group__stats.html" > Statistics< / a > < / div > < / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< p > More detailed statistics than < a class = "el" href = "struct_vma_statistics.html" title = "Calculated statistics of memory usage e.g. in a specific memory type, heap, custom pool,..." > VmaStatistics< / a > .
< a href = "struct_vma_detailed_statistics.html#details" > More...< / a > < / 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 >
2023-11-08 17:01:19 +00:00
< tr class = "memitem:a13efbdb35bd1291191d275f43e96d360" id = "r_a13efbdb35bd1291191d275f43e96d360" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "struct_vma_statistics.html" > VmaStatistics< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "struct_vma_detailed_statistics.html#a13efbdb35bd1291191d275f43e96d360" > statistics< / a > < / td > < / tr >
2023-05-02 10:44:06 +00:00
< tr class = "memdesc:a13efbdb35bd1291191d275f43e96d360" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Basic statistics. < br / > < / td > < / tr >
2022-02-22 14:19:35 +00:00
< tr class = "separator:a13efbdb35bd1291191d275f43e96d360" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2023-11-08 17:01:19 +00:00
< tr class = "memitem:ab721bf04892e8b67802d4ddb7734638a" id = "r_ab721bf04892e8b67802d4ddb7734638a" > < td class = "memItemLeft" align = "right" valign = "top" > uint32_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "struct_vma_detailed_statistics.html#ab721bf04892e8b67802d4ddb7734638a" > unusedRangeCount< / a > < / td > < / tr >
2023-05-02 10:44:06 +00:00
< tr class = "memdesc:ab721bf04892e8b67802d4ddb7734638a" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Number of free ranges of memory between allocations. < br / > < / td > < / tr >
2022-02-22 14:19:35 +00:00
< tr class = "separator:ab721bf04892e8b67802d4ddb7734638a" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2023-11-08 17:01:19 +00:00
< tr class = "memitem:a6fb397e7487e10f2a52e241577d2a2b8" id = "r_a6fb397e7487e10f2a52e241577d2a2b8" > < td class = "memItemLeft" align = "right" valign = "top" > VkDeviceSize  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "struct_vma_detailed_statistics.html#a6fb397e7487e10f2a52e241577d2a2b8" > allocationSizeMin< / a > < / td > < / tr >
2023-05-02 10:44:06 +00:00
< tr class = "memdesc:a6fb397e7487e10f2a52e241577d2a2b8" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Smallest allocation size. < code > VK_WHOLE_SIZE< / code > if there are 0 allocations. < br / > < / td > < / tr >
2022-02-22 14:19:35 +00:00
< tr class = "separator:a6fb397e7487e10f2a52e241577d2a2b8" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2023-11-08 17:01:19 +00:00
< tr class = "memitem:a06b2add24eed3449a66ff151979a0201" id = "r_a06b2add24eed3449a66ff151979a0201" > < td class = "memItemLeft" align = "right" valign = "top" > VkDeviceSize  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "struct_vma_detailed_statistics.html#a06b2add24eed3449a66ff151979a0201" > allocationSizeMax< / a > < / td > < / tr >
2023-05-02 10:44:06 +00:00
< tr class = "memdesc:a06b2add24eed3449a66ff151979a0201" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Largest allocation size. 0 if there are 0 allocations. < br / > < / td > < / tr >
2022-02-22 14:19:35 +00:00
< tr class = "separator:a06b2add24eed3449a66ff151979a0201" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2023-11-08 17:01:19 +00:00
< tr class = "memitem:a830eda847ed735d0e91da25cfcf797a4" id = "r_a830eda847ed735d0e91da25cfcf797a4" > < td class = "memItemLeft" align = "right" valign = "top" > VkDeviceSize  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "struct_vma_detailed_statistics.html#a830eda847ed735d0e91da25cfcf797a4" > unusedRangeSizeMin< / a > < / td > < / tr >
2023-05-02 10:44:06 +00:00
< tr class = "memdesc:a830eda847ed735d0e91da25cfcf797a4" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Smallest empty range size. < code > VK_WHOLE_SIZE< / code > if there are 0 empty ranges. < br / > < / td > < / tr >
2022-02-22 14:19:35 +00:00
< tr class = "separator:a830eda847ed735d0e91da25cfcf797a4" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2023-11-08 17:01:19 +00:00
< tr class = "memitem:af98943b5da98cf441ffa04b67914c78c" id = "r_af98943b5da98cf441ffa04b67914c78c" > < td class = "memItemLeft" align = "right" valign = "top" > VkDeviceSize  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "struct_vma_detailed_statistics.html#af98943b5da98cf441ffa04b67914c78c" > unusedRangeSizeMax< / a > < / td > < / tr >
2023-05-02 10:44:06 +00:00
< tr class = "memdesc:af98943b5da98cf441ffa04b67914c78c" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Largest empty range size. 0 if there are 0 empty ranges. < br / > < / td > < / tr >
2022-02-22 14:19:35 +00:00
< tr class = "separator:af98943b5da98cf441ffa04b67914c78c" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
2023-05-02 10:44:06 +00:00
< div class = "textblock" > < p > More detailed statistics than < a class = "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: < a class = "el" href = "group__group__stats.html#ga36f3484de7aa6cd6edc4de9edfa0ff59" title = "Retrieves statistics from current state of the Allocator." > vmaCalculateStatistics()< / a > , < a class = "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 >
2022-02-22 14:19:35 +00:00
< div class = "fragment" > < div class = "line" > VkDeviceSize allocationSizeAvg = detailedStats.statistics.allocationBytes / detailedStats.statistics.allocationCount;< / div >
< div class = "line" > VkDeviceSize unusedBytes = detailedStats.statistics.blockBytes - detailedStats.statistics.allocationBytes;< / div >
< div class = "line" > VkDeviceSize unusedRangeSizeAvg = unusedBytes / detailedStats.unusedRangeCount;< / div >
< / div > <!-- fragment --> < / div > < h2 class = "groupheader" > Member Data Documentation< / h2 >
< a id = "a06b2add24eed3449a66ff151979a0201" name = "a06b2add24eed3449a66ff151979a0201" > < / a >
2022-11-04 16:02:24 +00:00
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a06b2add24eed3449a66ff151979a0201" > ◆   < / a > < / span > allocationSizeMax< / h2 >
2022-02-22 14:19:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > VkDeviceSize VmaDetailedStatistics::allocationSizeMax< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Largest allocation size. 0 if there are 0 allocations. < / p >
< / div >
< / div >
< a id = "a6fb397e7487e10f2a52e241577d2a2b8" name = "a6fb397e7487e10f2a52e241577d2a2b8" > < / a >
2022-11-04 16:02:24 +00:00
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a6fb397e7487e10f2a52e241577d2a2b8" > ◆   < / a > < / span > allocationSizeMin< / h2 >
2022-02-22 14:19:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > VkDeviceSize VmaDetailedStatistics::allocationSizeMin< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Smallest allocation size. < code > VK_WHOLE_SIZE< / code > if there are 0 allocations. < / p >
< / div >
< / div >
< a id = "a13efbdb35bd1291191d275f43e96d360" name = "a13efbdb35bd1291191d275f43e96d360" > < / a >
2022-11-04 16:02:24 +00:00
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a13efbdb35bd1291191d275f43e96d360" > ◆   < / a > < / span > statistics< / h2 >
2022-02-22 14:19:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > < a class = "el" href = "struct_vma_statistics.html" > VmaStatistics< / a > VmaDetailedStatistics::statistics< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Basic statistics. < / p >
< / div >
< / div >
< a id = "ab721bf04892e8b67802d4ddb7734638a" name = "ab721bf04892e8b67802d4ddb7734638a" > < / a >
2022-11-04 16:02:24 +00:00
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ab721bf04892e8b67802d4ddb7734638a" > ◆   < / a > < / span > unusedRangeCount< / h2 >
2022-02-22 14:19:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > uint32_t VmaDetailedStatistics::unusedRangeCount< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Number of free ranges of memory between allocations. < / p >
< / div >
< / div >
< a id = "af98943b5da98cf441ffa04b67914c78c" name = "af98943b5da98cf441ffa04b67914c78c" > < / a >
2022-11-04 16:02:24 +00:00
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#af98943b5da98cf441ffa04b67914c78c" > ◆   < / a > < / span > unusedRangeSizeMax< / h2 >
2022-02-22 14:19:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > VkDeviceSize VmaDetailedStatistics::unusedRangeSizeMax< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Largest empty range size. 0 if there are 0 empty ranges. < / p >
< / div >
< / div >
< a id = "a830eda847ed735d0e91da25cfcf797a4" name = "a830eda847ed735d0e91da25cfcf797a4" > < / a >
2022-11-04 16:02:24 +00:00
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a830eda847ed735d0e91da25cfcf797a4" > ◆   < / a > < / span > unusedRangeSizeMin< / h2 >
2022-02-22 14:19:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > VkDeviceSize VmaDetailedStatistics::unusedRangeSizeMin< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Smallest empty range size. < code > VK_WHOLE_SIZE< / code > if there are 0 empty ranges. < / p >
< / div >
< / div >
< hr / > The documentation for this struct was generated from the following file:< ul >
< li > D:/PROJECTS/Vulkan Memory Allocator/REPO/include/< a class = "el" href = "vk__mem__alloc_8h.html" > vk_mem_alloc.h< / a > < / li >
< / ul >
< / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
2023-11-08 17:01:19 +00:00
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.8
2022-02-22 14:19:35 +00:00
< / small > < / address >
< / body >
< / html >
