blob: 2aaefe3f0478df7fda047f887f8416651b3be031 [file] [log] [blame]
<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Vulkan Memory Allocator: VmaBufferAllocatorCreateInfo 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 id="projectrow">
<td id="projectalign">
<div id="projectname">Vulkan Memory Allocator
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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&amp;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">
<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>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="struct_vma_buffer_allocator_create_info-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">VmaBufferAllocatorCreateInfo Struct Reference<div class="ingroups"><a class="el" href="group__group__buffer__suballocation.html">Buffer suballocation</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Parameters of created <a class="el" href="struct_vma_buffer_allocator.html" title="Represent main object that can allocate parts of larger Vulkan buffers.">VmaBufferAllocator</a> object to be passed to <a class="el" href="group__group__buffer__suballocation.html#ga03c157c99d4505b0c753c68e636dca66" title="TODO implement! TODO document!">vmaCreateBufferAllocator()</a>.
<a href="struct_vma_buffer_allocator_create_info.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>
<tr class="memitem:ad6ea3d17d437bea0a131f40233b3f296"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__buffer__suballocation.html#ga524fc82795862079781317e33be657e1">VmaBufferAllocatorCreateFlags</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_buffer_allocator_create_info.html#ad6ea3d17d437bea0a131f40233b3f296">flags</a></td></tr>
<tr class="memdesc:ad6ea3d17d437bea0a131f40233b3f296"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flags - use <a class="el" href="group__group__buffer__suballocation.html#ga57862e1ba87f2baa7e4b9d2af2cc1c08" title="Flags to be passed as VmaBufferAllocatorCreateInfo::flags.">VmaBufferAllocatorCreateFlagBits</a>. <a href="struct_vma_buffer_allocator_create_info.html#ad6ea3d17d437bea0a131f40233b3f296">More...</a><br /></td></tr>
<tr class="separator:ad6ea3d17d437bea0a131f40233b3f296"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae968d15a5e1c3bbb765f0d185c8e21a6"><td class="memItemLeft" align="right" valign="top">VkBufferCreateInfo&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_buffer_allocator_create_info.html#ae968d15a5e1c3bbb765f0d185c8e21a6">bufferCreateInfo</a></td></tr>
<tr class="memdesc:ae968d15a5e1c3bbb765f0d185c8e21a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parameters of Vulkan buffers to be created internally by the created <a class="el" href="struct_vma_buffer_allocator.html" title="Represent main object that can allocate parts of larger Vulkan buffers.">VmaBufferAllocator</a>. <a href="struct_vma_buffer_allocator_create_info.html#ae968d15a5e1c3bbb765f0d185c8e21a6">More...</a><br /></td></tr>
<tr class="separator:ae968d15a5e1c3bbb765f0d185c8e21a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5f946a3e8523ca7d2f1f9d3b435fced"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_vma_allocation_create_info.html">VmaAllocationCreateInfo</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_buffer_allocator_create_info.html#ac5f946a3e8523ca7d2f1f9d3b435fced">allocationCreateInfo</a></td></tr>
<tr class="memdesc:ac5f946a3e8523ca7d2f1f9d3b435fced"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parameters of allocations to be created internally for buffers. <a href="struct_vma_buffer_allocator_create_info.html#ac5f946a3e8523ca7d2f1f9d3b435fced">More...</a><br /></td></tr>
<tr class="separator:ac5f946a3e8523ca7d2f1f9d3b435fced"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af17c4cad7c00d0df00959461dbbfb40f"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_buffer_allocator_create_info.html#af17c4cad7c00d0df00959461dbbfb40f">minBufferCount</a></td></tr>
<tr class="memdesc:af17c4cad7c00d0df00959461dbbfb40f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum number of buffers to be created and always exist during lifetime of the created allocator. Default: 0. <a href="struct_vma_buffer_allocator_create_info.html#af17c4cad7c00d0df00959461dbbfb40f">More...</a><br /></td></tr>
<tr class="separator:af17c4cad7c00d0df00959461dbbfb40f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5ce312e46795d927685deb752c17ad1"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_buffer_allocator_create_info.html#aa5ce312e46795d927685deb752c17ad1">maxBufferCount</a></td></tr>
<tr class="memdesc:aa5ce312e46795d927685deb752c17ad1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum number of buffers that can be created by the allocator. 0 means no limit. <a href="struct_vma_buffer_allocator_create_info.html#aa5ce312e46795d927685deb752c17ad1">More...</a><br /></td></tr>
<tr class="separator:aa5ce312e46795d927685deb752c17ad1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7abb079b970fd8e777a7f6961e4ce7c9"><td class="memItemLeft" align="right" valign="top">VkDeviceSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_buffer_allocator_create_info.html#a7abb079b970fd8e777a7f6961e4ce7c9">preferredBufferSize</a></td></tr>
<tr class="memdesc:a7abb079b970fd8e777a7f6961e4ce7c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Preferred size of a single <code>VkBuffer</code> to be created by the allocator. 0 means default, which is currently 64 MB. <a href="struct_vma_buffer_allocator_create_info.html#a7abb079b970fd8e777a7f6961e4ce7c9">More...</a><br /></td></tr>
<tr class="separator:a7abb079b970fd8e777a7f6961e4ce7c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60338f1d9b57b1bb3446e1c899ee7294"><td class="memItemLeft" align="right" valign="top">VkDeviceSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_buffer_allocator_create_info.html#a60338f1d9b57b1bb3446e1c899ee7294">minSuballocationAlignment</a></td></tr>
<tr class="memdesc:a60338f1d9b57b1bb3446e1c899ee7294"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum alignment to be used for all suballocations created from this allocator. 0 or 1 means no minimum alignment is specified. <a href="struct_vma_buffer_allocator_create_info.html#a60338f1d9b57b1bb3446e1c899ee7294">More...</a><br /></td></tr>
<tr class="separator:a60338f1d9b57b1bb3446e1c899ee7294"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Parameters of created <a class="el" href="struct_vma_buffer_allocator.html" title="Represent main object that can allocate parts of larger Vulkan buffers.">VmaBufferAllocator</a> object to be passed to <a class="el" href="group__group__buffer__suballocation.html#ga03c157c99d4505b0c753c68e636dca66" title="TODO implement! TODO document!">vmaCreateBufferAllocator()</a>. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="ac5f946a3e8523ca7d2f1f9d3b435fced" name="ac5f946a3e8523ca7d2f1f9d3b435fced"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5f946a3e8523ca7d2f1f9d3b435fced">&#9670;&#160;</a></span>allocationCreateInfo</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_vma_allocation_create_info.html">VmaAllocationCreateInfo</a> VmaBufferAllocatorCreateInfo::allocationCreateInfo</td>
</tr>
</table>
</div><div class="memdoc">
<p>Parameters of allocations to be created internally for buffers. </p>
<p >The structure is copied, so you can free the memory of if together with the entire <a class="el" href="struct_vma_buffer_allocator_create_info.html" title="Parameters of created VmaBufferAllocator object to be passed to vmaCreateBufferAllocator().">VmaBufferAllocatorCreateInfo</a> after the creation call, but it has non-null <a class="el" href="struct_vma_allocation_create_info.html#a6272c0555cfd1fe28bff1afeb6190150" title="Pool that this allocation should be created in.">VmaAllocationCreateInfo::pool</a>, this pool must remain alive for the whole lifetime of the created allocator. </p>
</div>
</div>
<a id="ae968d15a5e1c3bbb765f0d185c8e21a6" name="ae968d15a5e1c3bbb765f0d185c8e21a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae968d15a5e1c3bbb765f0d185c8e21a6">&#9670;&#160;</a></span>bufferCreateInfo</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkBufferCreateInfo VmaBufferAllocatorCreateInfo::bufferCreateInfo</td>
</tr>
</table>
</div><div class="memdoc">
<p>Parameters of Vulkan buffers to be created internally by the created <a class="el" href="struct_vma_buffer_allocator.html" title="Represent main object that can allocate parts of larger Vulkan buffers.">VmaBufferAllocator</a>. </p>
<p ><code>size</code> parameter has special meaning. Set it to 0 to allow the allocator to managed buffer sizes automatically. This also allows buffer sizes to vary and allows to use <a class="el" href="group__group__buffer__suballocation.html#gga79ecf879da8900036ea0ea5b2e7adceba682790a9dabe6b13811f9128f0fe5c6a">VMA_BUFFER_SUBALLOCATION_CREATE_DEDICATED_BUFFER_BIT</a>. Set it to some other value to enforce that all buffers created by the allocator must have this specific size. This will also disallow to use <a class="el" href="group__group__buffer__suballocation.html#gga79ecf879da8900036ea0ea5b2e7adceba682790a9dabe6b13811f9128f0fe5c6a">VMA_BUFFER_SUBALLOCATION_CREATE_DEDICATED_BUFFER_BIT</a>. Note this is different than <a class="el" href="struct_vma_buffer_allocator_create_info.html#a7abb079b970fd8e777a7f6961e4ce7c9" title="Preferred size of a single VkBuffer to be created by the allocator. 0 means default,...">VmaBufferAllocatorCreateInfo::preferredBufferSize</a>.</p>
<p >The structure is copied, so you can free the memory of if together with the entire <a class="el" href="struct_vma_buffer_allocator_create_info.html" title="Parameters of created VmaBufferAllocator object to be passed to vmaCreateBufferAllocator().">VmaBufferAllocatorCreateInfo</a> after the creation call, but if points to additional memory, e.g. using <code>pNext</code> chain or <code>pQueueFamilyIndices</code>, this memory must remain alive and unchanged for the whole lifetime of the created allocator. </p>
</div>
</div>
<a id="ad6ea3d17d437bea0a131f40233b3f296" name="ad6ea3d17d437bea0a131f40233b3f296"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6ea3d17d437bea0a131f40233b3f296">&#9670;&#160;</a></span>flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__group__buffer__suballocation.html#ga524fc82795862079781317e33be657e1">VmaBufferAllocatorCreateFlags</a> VmaBufferAllocatorCreateInfo::flags</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flags - use <a class="el" href="group__group__buffer__suballocation.html#ga57862e1ba87f2baa7e4b9d2af2cc1c08" title="Flags to be passed as VmaBufferAllocatorCreateInfo::flags.">VmaBufferAllocatorCreateFlagBits</a>. </p>
</div>
</div>
<a id="aa5ce312e46795d927685deb752c17ad1" name="aa5ce312e46795d927685deb752c17ad1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5ce312e46795d927685deb752c17ad1">&#9670;&#160;</a></span>maxBufferCount</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t VmaBufferAllocatorCreateInfo::maxBufferCount</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum number of buffers that can be created by the allocator. 0 means no limit. </p>
</div>
</div>
<a id="af17c4cad7c00d0df00959461dbbfb40f" name="af17c4cad7c00d0df00959461dbbfb40f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af17c4cad7c00d0df00959461dbbfb40f">&#9670;&#160;</a></span>minBufferCount</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t VmaBufferAllocatorCreateInfo::minBufferCount</td>
</tr>
</table>
</div><div class="memdoc">
<p>Minimum number of buffers to be created and always exist during lifetime of the created allocator. Default: 0. </p>
<p >Set it to 0 if you don't want to reserve a minimum number of buffers, so that no buffers are created before first suballocation is made. </p>
</div>
</div>
<a id="a60338f1d9b57b1bb3446e1c899ee7294" name="a60338f1d9b57b1bb3446e1c899ee7294"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60338f1d9b57b1bb3446e1c899ee7294">&#9670;&#160;</a></span>minSuballocationAlignment</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceSize VmaBufferAllocatorCreateInfo::minSuballocationAlignment</td>
</tr>
</table>
</div><div class="memdoc">
<p>Minimum alignment to be used for all suballocations created from this allocator. 0 or 1 means no minimum alignment is specified. </p>
<p >As aligment for a new suballocation, maximum of this parameter and <a class="el" href="struct_vma_buffer_suballocation_create_info.html#ac95493e115314b775a8da4601269edef" title="TODO document! TODO implement!">VmaBufferSuballocationCreateInfo::alignment</a> will be taken. </p>
</div>
</div>
<a id="a7abb079b970fd8e777a7f6961e4ce7c9" name="a7abb079b970fd8e777a7f6961e4ce7c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7abb079b970fd8e777a7f6961e4ce7c9">&#9670;&#160;</a></span>preferredBufferSize</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceSize VmaBufferAllocatorCreateInfo::preferredBufferSize</td>
</tr>
</table>
</div><div class="memdoc">
<p>Preferred size of a single <code>VkBuffer</code> to be created by the allocator. 0 means default, which is currently 64 MB. </p>
<p >Note this is different than <a class="el" href="struct_vma_buffer_allocator_create_info.html#ae968d15a5e1c3bbb765f0d185c8e21a6" title="Parameters of Vulkan buffers to be created internally by the created VmaBufferAllocator.">VmaBufferAllocatorCreateInfo::bufferCreateInfo</a> size parameter. By setting non-zero <code>preferredBufferSize</code>, you still allow the allocator to create buffers of different sizes, smaller and larger than this number. This also doesn't disallow to use <a class="el" href="group__group__buffer__suballocation.html#gga79ecf879da8900036ea0ea5b2e7adceba682790a9dabe6b13811f9128f0fe5c6a">VMA_BUFFER_SUBALLOCATION_CREATE_DEDICATED_BUFFER_BIT</a>. </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>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
</small></address>
</body>
</html>