mirror of
https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator.git
synced 2024-11-27 00:44:35 +00:00
177 lines
9.4 KiB
HTML
177 lines
9.4 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
|
|
<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>
|
|
<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.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(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">
|
|
<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> |
|
|
<a href="struct_vma_budget-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">VmaBudget Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Statistics of current memory usage and available budget, in bytes, for specific memory heap.
|
|
<a href="struct_vma_budget.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="vk__mem__alloc_8h_source.html">vk_mem_alloc.h</a>></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:a58b492901baab685f466199124e514a0"><td class="memItemLeft" align="right" valign="top">VkDeviceSize </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_budget.html#a58b492901baab685f466199124e514a0">blockBytes</a></td></tr>
|
|
<tr class="memdesc:a58b492901baab685f466199124e514a0"><td class="mdescLeft"> </td><td class="mdescRight">Sum size of all <code>VkDeviceMemory</code> blocks allocated from particular heap, in bytes. <a href="struct_vma_budget.html#a58b492901baab685f466199124e514a0">More...</a><br /></td></tr>
|
|
<tr class="separator:a58b492901baab685f466199124e514a0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7e2a6583ebd63e194951c542563804d8"><td class="memItemLeft" align="right" valign="top">VkDeviceSize </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_budget.html#a7e2a6583ebd63e194951c542563804d8">allocationBytes</a></td></tr>
|
|
<tr class="memdesc:a7e2a6583ebd63e194951c542563804d8"><td class="mdescLeft"> </td><td class="mdescRight">Sum size of all allocations created in particular heap, in bytes. <a href="struct_vma_budget.html#a7e2a6583ebd63e194951c542563804d8">More...</a><br /></td></tr>
|
|
<tr class="separator:a7e2a6583ebd63e194951c542563804d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a84dd1ecca8b0110259eb206dbadb11f6"><td class="memItemLeft" align="right" valign="top">VkDeviceSize </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_budget.html#a84dd1ecca8b0110259eb206dbadb11f6">usage</a></td></tr>
|
|
<tr class="memdesc:a84dd1ecca8b0110259eb206dbadb11f6"><td class="mdescLeft"> </td><td class="mdescRight">Estimated current memory usage of the program, in bytes. <a href="struct_vma_budget.html#a84dd1ecca8b0110259eb206dbadb11f6">More...</a><br /></td></tr>
|
|
<tr class="separator:a84dd1ecca8b0110259eb206dbadb11f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab82e1d1754c2d210d0bdf90220bc6cdd"><td class="memItemLeft" align="right" valign="top">VkDeviceSize </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_budget.html#ab82e1d1754c2d210d0bdf90220bc6cdd">budget</a></td></tr>
|
|
<tr class="memdesc:ab82e1d1754c2d210d0bdf90220bc6cdd"><td class="mdescLeft"> </td><td class="mdescRight">Estimated amount of memory available to the program, in bytes. <a href="struct_vma_budget.html#ab82e1d1754c2d210d0bdf90220bc6cdd">More...</a><br /></td></tr>
|
|
<tr class="separator:ab82e1d1754c2d210d0bdf90220bc6cdd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Statistics of current memory usage and available budget, in bytes, for specific memory heap. </p>
|
|
</div><h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a7e2a6583ebd63e194951c542563804d8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7e2a6583ebd63e194951c542563804d8">◆ </a></span>allocationBytes</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">VkDeviceSize VmaBudget::allocationBytes</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sum size of all allocations created in particular heap, in bytes. </p>
|
|
<p>Usually less or equal than <code>blockBytes</code>. Difference <code>blockBytes - allocationBytes</code> is the amount of memory allocated but unused - available for new allocations or wasted due to fragmentation.</p>
|
|
<p>It might be greater than <code>blockBytes</code> if there are some allocations in lost state, as they account to this value as well. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a58b492901baab685f466199124e514a0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a58b492901baab685f466199124e514a0">◆ </a></span>blockBytes</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">VkDeviceSize VmaBudget::blockBytes</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sum size of all <code>VkDeviceMemory</code> blocks allocated from particular heap, in bytes. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab82e1d1754c2d210d0bdf90220bc6cdd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab82e1d1754c2d210d0bdf90220bc6cdd">◆ </a></span>budget</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">VkDeviceSize VmaBudget::budget</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Estimated amount of memory available to the program, in bytes. </p>
|
|
<p>Fetched from system using <code>VK_EXT_memory_budget</code> 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, like other programs also consuming system resources. 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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a84dd1ecca8b0110259eb206dbadb11f6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a84dd1ecca8b0110259eb206dbadb11f6">◆ </a></span>usage</h2>
|
|
|
|
<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>
|
|
<p>Fetched from system using <code>VK_EXT_memory_budget</code> extension if enabled.</p>
|
|
<p>It might be different than <code>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>
|
|
|
|
</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  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|