mirror/VulkanMemoryAllocator
1
0
Fork 0
mirror of https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator.git synced 2024-11-25 16:14:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
7924e27f81
VulkanMemoryAllocator/docs/html/struct_vma_allocation_info2.html
Adam Sawicki b5456bb4e5 Added functions vmaCopyMemoryToAllocation, vmaCopyAllocationToMemory 
Few other minor fixes and improvements.
Regenerated documentation.
2024-01-21 13:30:23 +01:00

160 lines
8.8 KiB
HTML
Raw Blame History

<!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.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Vulkan Memory Allocator: VmaAllocationInfo2 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>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.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.10.0 -->
<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');
$(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_allocation_info2-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">VmaAllocationInfo2 Struct Reference<div class="ingroups"><a class="el" href="group__group__alloc.html">Memory allocation</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Extended parameters of a <a class="el" href="struct_vma_allocation.html" title="Represents single memory allocation.">VmaAllocation</a> object that can be retrieved using function <a class="el" href="group__group__alloc.html#ga1405cf3eae2fd1305d645879173031a0" title="Returns extended information about specified allocation.">vmaGetAllocationInfo2()</a>.
<a href="#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:a315218ac1206a05026c95e06a8bbd6d5" id="r_a315218ac1206a05026c95e06a8bbd6d5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_vma_allocation_info.html">VmaAllocationInfo</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a315218ac1206a05026c95e06a8bbd6d5">allocationInfo</a></td></tr>
<tr class="memdesc:a315218ac1206a05026c95e06a8bbd6d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Basic parameters of the allocation. <br /></td></tr>
<tr class="separator:a315218ac1206a05026c95e06a8bbd6d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae839de16b3a62cc42c69df378e8e3a2" id="r_aae839de16b3a62cc42c69df378e8e3a2"><td class="memItemLeft" align="right" valign="top">VkDeviceSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aae839de16b3a62cc42c69df378e8e3a2">blockSize</a></td></tr>
<tr class="memdesc:aae839de16b3a62cc42c69df378e8e3a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of the <code>VkDeviceMemory</code> block that the allocation belongs to. <br /></td></tr>
<tr class="separator:aae839de16b3a62cc42c69df378e8e3a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7cf87251bd155d00ac6c6aaf4fc10448" id="r_a7cf87251bd155d00ac6c6aaf4fc10448"><td class="memItemLeft" align="right" valign="top">VkBool32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7cf87251bd155d00ac6c6aaf4fc10448">dedicatedMemory</a></td></tr>
<tr class="memdesc:a7cf87251bd155d00ac6c6aaf4fc10448"><td class="mdescLeft">&#160;</td><td class="mdescRight"><code>VK_TRUE</code> if the allocation has dedicated memory, <code>VK_FALSE</code> if it was placed as part of a larger memory block. <br /></td></tr>
<tr class="separator:a7cf87251bd155d00ac6c6aaf4fc10448"><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>Extended parameters of a <a class="el" href="struct_vma_allocation.html" title="Represents single memory allocation.">VmaAllocation</a> object that can be retrieved using function <a class="el" href="group__group__alloc.html#ga1405cf3eae2fd1305d645879173031a0" title="Returns extended information about specified allocation.">vmaGetAllocationInfo2()</a>. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a315218ac1206a05026c95e06a8bbd6d5" name="a315218ac1206a05026c95e06a8bbd6d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a315218ac1206a05026c95e06a8bbd6d5">&#9670;&#160;</a></span>allocationInfo</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_vma_allocation_info.html">VmaAllocationInfo</a> VmaAllocationInfo2::allocationInfo</td>
</tr>
</table>
</div><div class="memdoc">
<p>Basic parameters of the allocation. </p>
<p>If you need only these, you can use function <a class="el" href="group__group__alloc.html#ga86dd08aba8633bfa4ad0df2e76481d8b" title="Returns current information about specified allocation.">vmaGetAllocationInfo()</a> and structure <a class="el" href="struct_vma_allocation_info.html">VmaAllocationInfo</a> instead. </p>
</div>
</div>
<a id="aae839de16b3a62cc42c69df378e8e3a2" name="aae839de16b3a62cc42c69df378e8e3a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae839de16b3a62cc42c69df378e8e3a2">&#9670;&#160;</a></span>blockSize</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceSize VmaAllocationInfo2::blockSize</td>
</tr>
</table>
</div><div class="memdoc">
<p>Size of the <code>VkDeviceMemory</code> block that the allocation belongs to. </p>
<p>In case of an allocation with dedicated memory, it will be equal to <code>allocationInfo.size</code>. </p>
</div>
</div>
<a id="a7cf87251bd155d00ac6c6aaf4fc10448" name="a7cf87251bd155d00ac6c6aaf4fc10448"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7cf87251bd155d00ac6c6aaf4fc10448">&#9670;&#160;</a></span>dedicatedMemory</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkBool32 VmaAllocationInfo2::dedicatedMemory</td>
</tr>
</table>
</div><div class="memdoc">
<p><code>VK_TRUE</code> if the allocation has dedicated memory, <code>VK_FALSE</code> if it was placed as part of a larger memory block. </p>
<p>When <code>VK_TRUE</code>, it also means <code>VkMemoryDedicatedAllocateInfo</code> was used when creating the allocation (if VK_KHR_dedicated_allocation extension or Vulkan version &gt;= 1.1 is enabled). </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.10.0
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink