2019-11-02 14:24:33 +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" >
2019-11-02 14:24:33 +00:00
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
2021-10-18 15:32:40 +00:00
< meta http-equiv = "X-UA-Compatible" content = "IE=11" / >
2024-01-21 12:30:23 +00:00
< meta name = "generator" content = "Doxygen 1.10.0" / >
2019-11-02 14:24:33 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > Vulkan Memory Allocator: VmaBudget 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 >
2024-01-21 12:30:23 +00:00
< script type = "text/javascript" src = "clipboard.js" > < / script >
< script type = "text/javascript" src = "cookie.js" > < / script >
2019-11-02 14:24:33 +00:00
< 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" >
2019-11-02 14:24:33 +00:00
< div id = "projectname" > Vulkan Memory Allocator
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2024-01-21 12:30:23 +00:00
<!-- Generated by Doxygen 1.10.0 -->
2019-11-02 14:24:33 +00:00
< script type = "text/javascript" >
2021-10-18 15:32:40 +00:00
/* @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');
2019-11-02 14:24:33 +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" >
2021-10-18 15:32:40 +00:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
2019-11-02 14:24:33 +00:00
$(function() {
initMenu('',true,false,'search.php','Search');
2024-01-21 12:30:23 +00:00
$(function() { init_search(); });
2019-11-02 14:24:33 +00:00
});
2021-10-18 15:32:40 +00:00
/* @license-end */
< / script >
2019-11-02 14:24:33 +00:00
< 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 >
2019-11-02 14:24:33 +00:00
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "summary" >
< a href = "#pub-attribs" > Public Attributes< / a > |
< a href = "struct_vma_budget-members.html" > List of all members< / a > < / div >
2022-01-20 16:00:33 +00:00
< div class = "headertitle" > < div class = "title" > VmaBudget Struct Reference< div class = "ingroups" > < a class = "el" href = "group__group__stats.html" > Statistics< / a > < / div > < / div > < / div >
2019-11-02 14:24:33 +00:00
< / div > <!-- header -->
< div class = "contents" >
2022-02-22 14:19:35 +00:00
< p > Statistics of current memory usage and available budget for a specific memory heap.
2024-01-21 12:30:23 +00:00
< a href = "#details" > More...< / a > < / p >
2019-11-02 14:24:33 +00:00
< table class = "memberdecls" >
2021-10-18 15:32:40 +00:00
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "pub-attribs" name = "pub-attribs" > < / a >
2019-11-02 14:24:33 +00:00
Public Attributes< / h2 > < / td > < / tr >
2024-01-21 12:30:23 +00:00
< tr class = "memitem:a6d15ab3a798fd62d9efa3a1e1f83bf54" id = "r_a6d15ab3a798fd62d9efa3a1e1f83bf54" > < 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 = "#a6d15ab3a798fd62d9efa3a1e1f83bf54" > statistics< / a > < / td > < / tr >
2023-05-02 10:44:06 +00:00
< tr class = "memdesc:a6d15ab3a798fd62d9efa3a1e1f83bf54" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Statistics fetched from the library. < br / > < / td > < / tr >
2022-02-22 14:19:35 +00:00
< tr class = "separator:a6d15ab3a798fd62d9efa3a1e1f83bf54" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-01-21 12:30:23 +00:00
< tr class = "memitem:a84dd1ecca8b0110259eb206dbadb11f6" id = "r_a84dd1ecca8b0110259eb206dbadb11f6" > < td class = "memItemLeft" align = "right" valign = "top" > VkDeviceSize  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a84dd1ecca8b0110259eb206dbadb11f6" > usage< / a > < / td > < / tr >
2023-05-02 10:44:06 +00:00
< tr class = "memdesc:a84dd1ecca8b0110259eb206dbadb11f6" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Estimated current memory usage of the program, in bytes. < br / > < / td > < / tr >
2019-11-02 14:24:33 +00:00
< tr class = "separator:a84dd1ecca8b0110259eb206dbadb11f6" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-01-21 12:30:23 +00:00
< tr class = "memitem:ab82e1d1754c2d210d0bdf90220bc6cdd" id = "r_ab82e1d1754c2d210d0bdf90220bc6cdd" > < td class = "memItemLeft" align = "right" valign = "top" > VkDeviceSize  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#ab82e1d1754c2d210d0bdf90220bc6cdd" > budget< / a > < / td > < / tr >
2023-05-02 10:44:06 +00:00
< tr class = "memdesc:ab82e1d1754c2d210d0bdf90220bc6cdd" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Estimated amount of memory available to the program, in bytes. < br / > < / td > < / tr >
2019-11-02 14:24:33 +00:00
< tr class = "separator:ab82e1d1754c2d210d0bdf90220bc6cdd" > < 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 > Statistics of current memory usage and available budget for a specific memory heap. < / p >
< p > These are fast to calculate. See function < a class = "el" href = "group__group__stats.html#ga9f88db9d46a432c0ad7278cecbc5eaa7" title = "Retrieves information about current memory usage and budget for all memory heaps." > vmaGetHeapBudgets()< / a > . < / p >
2019-11-02 14:24:33 +00:00
< / div > < h2 class = "groupheader" > Member Data Documentation< / h2 >
2022-02-22 14:19:35 +00:00
< a id = "ab82e1d1754c2d210d0bdf90220bc6cdd" name = "ab82e1d1754c2d210d0bdf90220bc6cdd" > < / a >
2022-11-04 16:02:24 +00:00
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ab82e1d1754c2d210d0bdf90220bc6cdd" > ◆   < / a > < / span > budget< / h2 >
2019-11-02 14:24:33 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2022-02-22 14:19:35 +00:00
< td class = "memname" > VkDeviceSize VmaBudget::budget< / td >
2019-11-02 14:24:33 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2022-02-22 14:19:35 +00:00
< p > Estimated amount of memory available to the program, in bytes. < / p >
2023-05-02 10:44:06 +00:00
< p > Fetched from system using VK_EXT_memory_budget extension if enabled.< / p >
< p > It might be different (most probably smaller) than < code > VkMemoryHeap::size[heapIndex]< / code > due to factors external to the program, decided by the operating system. Difference < code > budget - usage< / code > is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems. < / p >
2019-11-02 14:24:33 +00:00
< / div >
< / div >
2022-02-22 14:19:35 +00:00
< a id = "a6d15ab3a798fd62d9efa3a1e1f83bf54" name = "a6d15ab3a798fd62d9efa3a1e1f83bf54" > < / a >
2022-11-04 16:02:24 +00:00
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a6d15ab3a798fd62d9efa3a1e1f83bf54" > ◆   < / a > < / span > statistics< / h2 >
2019-11-02 14:24:33 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2022-02-22 14:19:35 +00:00
< td class = "memname" > < a class = "el" href = "struct_vma_statistics.html" > VmaStatistics< / a > VmaBudget::statistics< / td >
2019-11-02 14:24:33 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2022-02-22 14:19:35 +00:00
< p > Statistics fetched from the library. < / p >
2019-11-02 14:24:33 +00:00
< / div >
< / div >
2021-10-18 15:32:40 +00:00
< a id = "a84dd1ecca8b0110259eb206dbadb11f6" name = "a84dd1ecca8b0110259eb206dbadb11f6" > < / a >
2022-11-04 16:02:24 +00:00
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a84dd1ecca8b0110259eb206dbadb11f6" > ◆   < / a > < / span > usage< / h2 >
2019-11-02 14:24:33 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > VkDeviceSize VmaBudget::usage< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Estimated current memory usage of the program, in bytes. < / p >
2023-05-02 10:44:06 +00:00
< p > Fetched from system using VK_EXT_memory_budget extension if enabled.< / p >
< p > It might be different than < code > statistics.blockBytes< / code > (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipelines, descriptor heaps, command buffers, or < code > VkDeviceMemory< / code > blocks allocated outside of this library, if any. < / p >
2019-11-02 14:24:33 +00:00
< / div >
< / div >
< hr / > The documentation for this struct was generated from the following file:< ul >
2021-10-18 15:32:40 +00:00
< li > D:/PROJECTS/Vulkan Memory Allocator/REPO/include/< a class = "el" href = "vk__mem__alloc_8h.html" > vk_mem_alloc.h< / a > < / li >
2019-11-02 14:24:33 +00:00
< / ul >
< / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
2024-01-21 12:30:23 +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.10.0
2019-11-02 14:24:33 +00:00
< / small > < / address >
< / body >
< / html >
