1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xmlns="http://www.w3.org/1999/xhtml"> 3<head> 4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5<meta http-equiv="X-UA-Compatible" content="IE=9"/> 6<meta name="generator" content="Doxygen 1.8.17"/> 7<meta name="viewport" content="width=device-width, initial-scale=1"/> 8<title>Vulkan Memory Allocator: VmaPoolCreateInfo Struct Reference</title> 9<link href="tabs.css" rel="stylesheet" type="text/css"/> 10<script type="text/javascript" src="jquery.js"></script> 11<script type="text/javascript" src="dynsections.js"></script> 12<link href="search/search.css" rel="stylesheet" type="text/css"/> 13<script type="text/javascript" src="search/searchdata.js"></script> 14<script type="text/javascript" src="search/search.js"></script> 15<link href="doxygen.css" rel="stylesheet" type="text/css" /> 16</head> 17<body> 18<div id="top"><!-- do not remove this div, it is closed by doxygen! --> 19<div id="titlearea"> 20<table cellspacing="0" cellpadding="0"> 21 <tbody> 22 <tr style="height: 56px;"> 23 <td id="projectalign" style="padding-left: 0.5em;"> 24 <div id="projectname">Vulkan Memory Allocator 25 </div> 26 </td> 27 </tr> 28 </tbody> 29</table> 30</div> 31<!-- end header part --> 32<!-- Generated by Doxygen 1.8.17 --> 33<script type="text/javascript"> 34/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 35var searchBox = new SearchBox("searchBox", "search",false,'Search'); 36/* @license-end */ 37</script> 38<script type="text/javascript" src="menudata.js"></script> 39<script type="text/javascript" src="menu.js"></script> 40<script type="text/javascript"> 41/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 42$(function() { 43 initMenu('',true,false,'search.php','Search'); 44 $(document).ready(function() { init_search(); }); 45}); 46/* @license-end */</script> 47<div id="main-nav"></div> 48<!-- window showing the filter options --> 49<div id="MSearchSelectWindow" 50 onmouseover="return searchBox.OnSearchSelectShow()" 51 onmouseout="return searchBox.OnSearchSelectHide()" 52 onkeydown="return searchBox.OnSearchSelectKey(event)"> 53</div> 54 55<!-- iframe showing the search results (closed by default) --> 56<div id="MSearchResultsWindow"> 57<iframe src="javascript:void(0)" frameborder="0" 58 name="MSearchResults" id="MSearchResults"> 59</iframe> 60</div> 61 62</div><!-- top --> 63<div class="header"> 64 <div class="summary"> 65<a href="#pub-attribs">Public Attributes</a> | 66<a href="struct_vma_pool_create_info-members.html">List of all members</a> </div> 67 <div class="headertitle"> 68<div class="title">VmaPoolCreateInfo Struct Reference</div> </div> 69</div><!--header--> 70<div class="contents"> 71 72<p>Describes parameter of created <a class="el" href="struct_vma_pool.html" title="Represents custom memory pool.">VmaPool</a>. 73 <a href="struct_vma_pool_create_info.html#details">More...</a></p> 74 75<p><code>#include <<a class="el" href="vk__mem__alloc_8h_source.html">vk_mem_alloc.h</a>></code></p> 76<table class="memberdecls"> 77<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> 78Public Attributes</h2></td></tr> 79<tr class="memitem:a596fa76b685d3f1f688f84a709a5b319"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_pool_create_info.html#a596fa76b685d3f1f688f84a709a5b319">memoryTypeIndex</a></td></tr> 80<tr class="memdesc:a596fa76b685d3f1f688f84a709a5b319"><td class="mdescLeft"> </td><td class="mdescRight">Vulkan memory type index to allocate this pool from. <a href="struct_vma_pool_create_info.html#a596fa76b685d3f1f688f84a709a5b319">More...</a><br /></td></tr> 81<tr class="separator:a596fa76b685d3f1f688f84a709a5b319"><td class="memSeparator" colspan="2"> </td></tr> 82<tr class="memitem:a8405139f63d078340ae74513a59f5446"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vk__mem__alloc_8h.html#a2770e325ea42e087c1b91fdf46d0292a">VmaPoolCreateFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_pool_create_info.html#a8405139f63d078340ae74513a59f5446">flags</a></td></tr> 83<tr class="memdesc:a8405139f63d078340ae74513a59f5446"><td class="mdescLeft"> </td><td class="mdescRight">Use combination of <a class="el" href="vk__mem__alloc_8h.html#a4d4f2efc2509157a9e4ecd4fd7942303" title="Flags to be passed as VmaPoolCreateInfo::flags.">VmaPoolCreateFlagBits</a>. <a href="struct_vma_pool_create_info.html#a8405139f63d078340ae74513a59f5446">More...</a><br /></td></tr> 84<tr class="separator:a8405139f63d078340ae74513a59f5446"><td class="memSeparator" colspan="2"> </td></tr> 85<tr class="memitem:aa4265160536cdb9be821b7686c16c676"><td class="memItemLeft" align="right" valign="top">VkDeviceSize </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_pool_create_info.html#aa4265160536cdb9be821b7686c16c676">blockSize</a></td></tr> 86<tr class="memdesc:aa4265160536cdb9be821b7686c16c676"><td class="mdescLeft"> </td><td class="mdescRight">Size of a single <code>VkDeviceMemory</code> block to be allocated as part of this pool, in bytes. Optional. <a href="struct_vma_pool_create_info.html#aa4265160536cdb9be821b7686c16c676">More...</a><br /></td></tr> 87<tr class="separator:aa4265160536cdb9be821b7686c16c676"><td class="memSeparator" colspan="2"> </td></tr> 88<tr class="memitem:ad8006fb803185c0a699d30f3e9a865ae"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_pool_create_info.html#ad8006fb803185c0a699d30f3e9a865ae">minBlockCount</a></td></tr> 89<tr class="memdesc:ad8006fb803185c0a699d30f3e9a865ae"><td class="mdescLeft"> </td><td class="mdescRight">Minimum number of blocks to be always allocated in this pool, even if they stay empty. <a href="struct_vma_pool_create_info.html#ad8006fb803185c0a699d30f3e9a865ae">More...</a><br /></td></tr> 90<tr class="separator:ad8006fb803185c0a699d30f3e9a865ae"><td class="memSeparator" colspan="2"> </td></tr> 91<tr class="memitem:ae41142f2834fcdc82baa4883c187b75c"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_pool_create_info.html#ae41142f2834fcdc82baa4883c187b75c">maxBlockCount</a></td></tr> 92<tr class="memdesc:ae41142f2834fcdc82baa4883c187b75c"><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of blocks that can be allocated in this pool. Optional. <a href="struct_vma_pool_create_info.html#ae41142f2834fcdc82baa4883c187b75c">More...</a><br /></td></tr> 93<tr class="separator:ae41142f2834fcdc82baa4883c187b75c"><td class="memSeparator" colspan="2"> </td></tr> 94<tr class="memitem:a9437e43ffbb644dbbf7fc4e50cfad6aa"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_pool_create_info.html#a9437e43ffbb644dbbf7fc4e50cfad6aa">frameInUseCount</a></td></tr> 95<tr class="memdesc:a9437e43ffbb644dbbf7fc4e50cfad6aa"><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of additional frames that are in use at the same time as current frame. <a href="struct_vma_pool_create_info.html#a9437e43ffbb644dbbf7fc4e50cfad6aa">More...</a><br /></td></tr> 96<tr class="separator:a9437e43ffbb644dbbf7fc4e50cfad6aa"><td class="memSeparator" colspan="2"> </td></tr> 97</table> 98<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 99<div class="textblock"><p>Describes parameter of created <a class="el" href="struct_vma_pool.html" title="Represents custom memory pool.">VmaPool</a>. </p> 100</div><h2 class="groupheader">Member Data Documentation</h2> 101<a id="aa4265160536cdb9be821b7686c16c676"></a> 102<h2 class="memtitle"><span class="permalink"><a href="#aa4265160536cdb9be821b7686c16c676">◆ </a></span>blockSize</h2> 103 104<div class="memitem"> 105<div class="memproto"> 106 <table class="memname"> 107 <tr> 108 <td class="memname">VkDeviceSize VmaPoolCreateInfo::blockSize</td> 109 </tr> 110 </table> 111</div><div class="memdoc"> 112 113<p>Size of a single <code>VkDeviceMemory</code> block to be allocated as part of this pool, in bytes. Optional. </p> 114<p>Specify nonzero to set explicit, constant size of memory blocks used by this pool.</p> 115<p>Leave 0 to use default and let the library manage block sizes automatically. Sizes of particular blocks may vary. </p> 116 117</div> 118</div> 119<a id="a8405139f63d078340ae74513a59f5446"></a> 120<h2 class="memtitle"><span class="permalink"><a href="#a8405139f63d078340ae74513a59f5446">◆ </a></span>flags</h2> 121 122<div class="memitem"> 123<div class="memproto"> 124 <table class="memname"> 125 <tr> 126 <td class="memname"><a class="el" href="vk__mem__alloc_8h.html#a2770e325ea42e087c1b91fdf46d0292a">VmaPoolCreateFlags</a> VmaPoolCreateInfo::flags</td> 127 </tr> 128 </table> 129</div><div class="memdoc"> 130 131<p>Use combination of <a class="el" href="vk__mem__alloc_8h.html#a4d4f2efc2509157a9e4ecd4fd7942303" title="Flags to be passed as VmaPoolCreateInfo::flags.">VmaPoolCreateFlagBits</a>. </p> 132 133</div> 134</div> 135<a id="a9437e43ffbb644dbbf7fc4e50cfad6aa"></a> 136<h2 class="memtitle"><span class="permalink"><a href="#a9437e43ffbb644dbbf7fc4e50cfad6aa">◆ </a></span>frameInUseCount</h2> 137 138<div class="memitem"> 139<div class="memproto"> 140 <table class="memname"> 141 <tr> 142 <td class="memname">uint32_t VmaPoolCreateInfo::frameInUseCount</td> 143 </tr> 144 </table> 145</div><div class="memdoc"> 146 147<p>Maximum number of additional frames that are in use at the same time as current frame. </p> 148<p>This value is used only when you make allocations with <a class="el" href="vk__mem__alloc_8h.html#ad9889c10c798b040d59c92f257cae597a5f436af6c8fe8540573a6d22627a6fd2">VMA_ALLOCATION_CREATE_CAN_BECOME_LOST_BIT</a> flag. Such allocation cannot become lost if allocation.lastUseFrameIndex >= allocator.currentFrameIndex - frameInUseCount.</p> 149<p>For example, if you double-buffer your command buffers, so resources used for rendering in previous frame may still be in use by the GPU at the moment you allocate resources needed for the current frame, set this value to 1.</p> 150<p>If you want to allow any allocations other than used in the current frame to become lost, set this value to 0. </p> 151 152</div> 153</div> 154<a id="ae41142f2834fcdc82baa4883c187b75c"></a> 155<h2 class="memtitle"><span class="permalink"><a href="#ae41142f2834fcdc82baa4883c187b75c">◆ </a></span>maxBlockCount</h2> 156 157<div class="memitem"> 158<div class="memproto"> 159 <table class="memname"> 160 <tr> 161 <td class="memname">size_t VmaPoolCreateInfo::maxBlockCount</td> 162 </tr> 163 </table> 164</div><div class="memdoc"> 165 166<p>Maximum number of blocks that can be allocated in this pool. Optional. </p> 167<p>Set to 0 to use default, which is <code>SIZE_MAX</code>, which means no limit.</p> 168<p>Set to same value as <a class="el" href="struct_vma_pool_create_info.html#ad8006fb803185c0a699d30f3e9a865ae" title="Minimum number of blocks to be always allocated in this pool, even if they stay empty.">VmaPoolCreateInfo::minBlockCount</a> to have fixed amount of memory allocated throughout whole lifetime of this pool. </p> 169 170</div> 171</div> 172<a id="a596fa76b685d3f1f688f84a709a5b319"></a> 173<h2 class="memtitle"><span class="permalink"><a href="#a596fa76b685d3f1f688f84a709a5b319">◆ </a></span>memoryTypeIndex</h2> 174 175<div class="memitem"> 176<div class="memproto"> 177 <table class="memname"> 178 <tr> 179 <td class="memname">uint32_t VmaPoolCreateInfo::memoryTypeIndex</td> 180 </tr> 181 </table> 182</div><div class="memdoc"> 183 184<p>Vulkan memory type index to allocate this pool from. </p> 185 186</div> 187</div> 188<a id="ad8006fb803185c0a699d30f3e9a865ae"></a> 189<h2 class="memtitle"><span class="permalink"><a href="#ad8006fb803185c0a699d30f3e9a865ae">◆ </a></span>minBlockCount</h2> 190 191<div class="memitem"> 192<div class="memproto"> 193 <table class="memname"> 194 <tr> 195 <td class="memname">size_t VmaPoolCreateInfo::minBlockCount</td> 196 </tr> 197 </table> 198</div><div class="memdoc"> 199 200<p>Minimum number of blocks to be always allocated in this pool, even if they stay empty. </p> 201<p>Set to 0 to have no preallocated blocks and allow the pool be completely empty. </p> 202 203</div> 204</div> 205<hr/>The documentation for this struct was generated from the following file:<ul> 206<li><a class="el" href="vk__mem__alloc_8h_source.html">vk_mem_alloc.h</a></li> 207</ul> 208</div><!-- contents --> 209<!-- start footer part --> 210<hr class="footer"/><address class="footer"><small> 211Generated by  <a href="http://www.doxygen.org/index.html"> 212<img class="footer" src="doxygen.png" alt="doxygen"/> 213</a> 1.8.17 214</small></address> 215</body> 216</html> 217
