Google Git
Sign in
skia / external / github.com / GPUOpen-LibrariesAndSDKs / VulkanMemoryAllocator / refs/heads/feature-buffer-suballocation / . / docs / html / struct_vma_buffer_suballocation_info.html
blob: 783c0fbd1d39286c347c17a608f51c112c8ce07f [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: VmaBufferSuballocationInfo 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_suballocation_info-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">VmaBufferSuballocationInfo 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 an existing buffer suballocation, returned by <a class="el" href="group__group__buffer__suballocation.html#ga40f2d170f68291d7b9dc32c130b60c39" title="TODO implement! TODO document!">vmaBufferAllocatorAllocate()</a> or <a class="el" href="group__group__buffer__suballocation.html#ga8fd69c9c2dc254b99875604d6a08cea6" title="TODO implement! TODO document!">vmaGetBufferSuballocationInfo()</a>.
<a href="struct_vma_buffer_suballocation_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:ad2e94e2bb0d15b9f48bce1213965e4a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_vma_allocation.html">VmaAllocation</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_buffer_suballocation_info.html#ad2e94e2bb0d15b9f48bce1213965e4a4">allocation</a></td></tr>
<tr class="memdesc:ad2e94e2bb0d15b9f48bce1213965e4a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">TODO document! TODO implement! <a href="struct_vma_buffer_suballocation_info.html#ad2e94e2bb0d15b9f48bce1213965e4a4">More...</a><br /></td></tr>
<tr class="separator:ad2e94e2bb0d15b9f48bce1213965e4a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bf2f2ef9af1719f63a8a84030c5438a"><td class="memItemLeft" align="right" valign="top">VkBuffer&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_buffer_suballocation_info.html#a4bf2f2ef9af1719f63a8a84030c5438a">buffer</a></td></tr>
<tr class="memdesc:a4bf2f2ef9af1719f63a8a84030c5438a"><td class="mdescLeft">&#160;</td><td class="mdescRight">TODO document! TODO implement! <a href="struct_vma_buffer_suballocation_info.html#a4bf2f2ef9af1719f63a8a84030c5438a">More...</a><br /></td></tr>
<tr class="separator:a4bf2f2ef9af1719f63a8a84030c5438a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c8d9b066d13022ef7591a70ab9c2864"><td class="memItemLeft" align="right" valign="top">VkDeviceSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_buffer_suballocation_info.html#a2c8d9b066d13022ef7591a70ab9c2864">bufferLocalOffset</a></td></tr>
<tr class="memdesc:a2c8d9b066d13022ef7591a70ab9c2864"><td class="mdescLeft">&#160;</td><td class="mdescRight">TODO document! TODO implement! <a href="struct_vma_buffer_suballocation_info.html#a2c8d9b066d13022ef7591a70ab9c2864">More...</a><br /></td></tr>
<tr class="separator:a2c8d9b066d13022ef7591a70ab9c2864"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4dcc347c1ab1c7066b98e593a378d57"><td class="memItemLeft" align="right" valign="top">VkDeviceSize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_buffer_suballocation_info.html#ab4dcc347c1ab1c7066b98e593a378d57">size</a></td></tr>
<tr class="memdesc:ab4dcc347c1ab1c7066b98e593a378d57"><td class="mdescLeft">&#160;</td><td class="mdescRight">TODO document! TODO implement! <a href="struct_vma_buffer_suballocation_info.html#ab4dcc347c1ab1c7066b98e593a378d57">More...</a><br /></td></tr>
<tr class="separator:ab4dcc347c1ab1c7066b98e593a378d57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58fa80ec0bba96e1e0a44c85fd0d1283"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_buffer_suballocation_info.html#a58fa80ec0bba96e1e0a44c85fd0d1283">pMappedData</a></td></tr>
<tr class="memdesc:a58fa80ec0bba96e1e0a44c85fd0d1283"><td class="mdescLeft">&#160;</td><td class="mdescRight">TODO document! TODO implement! <a href="struct_vma_buffer_suballocation_info.html#a58fa80ec0bba96e1e0a44c85fd0d1283">More...</a><br /></td></tr>
<tr class="separator:a58fa80ec0bba96e1e0a44c85fd0d1283"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aafb0ff200f8fae41e383dec078e3eb47"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_vma_buffer_suballocation_info.html#aafb0ff200f8fae41e383dec078e3eb47">pUserData</a></td></tr>
<tr class="memdesc:aafb0ff200f8fae41e383dec078e3eb47"><td class="mdescLeft">&#160;</td><td class="mdescRight">Custom pointer associated with the suballocation. <a href="struct_vma_buffer_suballocation_info.html#aafb0ff200f8fae41e383dec078e3eb47">More...</a><br /></td></tr>
<tr class="separator:aafb0ff200f8fae41e383dec078e3eb47"><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 an existing buffer suballocation, returned by <a class="el" href="group__group__buffer__suballocation.html#ga40f2d170f68291d7b9dc32c130b60c39" title="TODO implement! TODO document!">vmaBufferAllocatorAllocate()</a> or <a class="el" href="group__group__buffer__suballocation.html#ga8fd69c9c2dc254b99875604d6a08cea6" title="TODO implement! TODO document!">vmaGetBufferSuballocationInfo()</a>. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="ad2e94e2bb0d15b9f48bce1213965e4a4" name="ad2e94e2bb0d15b9f48bce1213965e4a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2e94e2bb0d15b9f48bce1213965e4a4">&#9670;&#160;</a></span>allocation</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_vma_allocation.html">VmaAllocation</a> VmaBufferSuballocationInfo::allocation</td>
</tr>
</table>
</div><div class="memdoc">
<p>TODO document! TODO implement! </p>
</div>
</div>
<a id="a4bf2f2ef9af1719f63a8a84030c5438a" name="a4bf2f2ef9af1719f63a8a84030c5438a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bf2f2ef9af1719f63a8a84030c5438a">&#9670;&#160;</a></span>buffer</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkBuffer VmaBufferSuballocationInfo::buffer</td>
</tr>
</table>
</div><div class="memdoc">
<p>TODO document! TODO implement! </p>
</div>
</div>
<a id="a2c8d9b066d13022ef7591a70ab9c2864" name="a2c8d9b066d13022ef7591a70ab9c2864"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c8d9b066d13022ef7591a70ab9c2864">&#9670;&#160;</a></span>bufferLocalOffset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceSize VmaBufferSuballocationInfo::bufferLocalOffset</td>
</tr>
</table>
</div><div class="memdoc">
<p>TODO document! TODO implement! </p>
</div>
</div>
<a id="a58fa80ec0bba96e1e0a44c85fd0d1283" name="a58fa80ec0bba96e1e0a44c85fd0d1283"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58fa80ec0bba96e1e0a44c85fd0d1283">&#9670;&#160;</a></span>pMappedData</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* VmaBufferSuballocationInfo::pMappedData</td>
</tr>
</table>
</div><div class="memdoc">
<p>TODO document! TODO implement! </p>
</div>
</div>
<a id="aafb0ff200f8fae41e383dec078e3eb47" name="aafb0ff200f8fae41e383dec078e3eb47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aafb0ff200f8fae41e383dec078e3eb47">&#9670;&#160;</a></span>pUserData</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* VmaBufferSuballocationInfo::pUserData</td>
</tr>
</table>
</div><div class="memdoc">
<p>Custom pointer associated with the suballocation. </p>
<p >Same value as passed in <a class="el" href="struct_vma_buffer_suballocation_create_info.html#a2c4a9a3a240e093c4679a9c72f084966" title="Custom pointer to be associated with the suballocation. Optional.">VmaBufferSuballocationCreateInfo::pUserData</a> or to <a class="el" href="group__group__buffer__suballocation.html#ga859ffc45110bced385384044572b227c" title="TODO implement! TODO document!">vmaSetBufferSuballocationUserData()</a>. </p>
</div>
</div>
<a id="ab4dcc347c1ab1c7066b98e593a378d57" name="ab4dcc347c1ab1c7066b98e593a378d57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4dcc347c1ab1c7066b98e593a378d57">&#9670;&#160;</a></span>size</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VkDeviceSize VmaBufferSuballocationInfo::size</td>
</tr>
</table>
</div><div class="memdoc">
<p>TODO document! TODO implement! </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>