mirror/VulkanMemoryAllocator
1
0
Fork 0
mirror of https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator.git synced 2024-11-14 04:11:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
aa18374368
VulkanMemoryAllocator/docs/html/vk_khr_dedicated_allocation.html

102 lines
6.9 KiB
HTML
Raw Normal View History

Updated documentation - added information about VK_AMD_memory_allocation_behavior extension. Regenerated documentation, using new Doxygen version.
2019-01-15 10:45:58 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Documentation: changed page identifier to lowercase to (hopefully) fix 404 error on GitHub.
2017-10-17 13:13:48 +00:00
<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"/>
Updated copyright header to year 2021. Rebuilt binaries, regenerated documentation.
2021-02-16 16:28:49 +00:00
<meta name="generator" content="Doxygen 1.9.1"/>
Documentation: changed page identifier to lowercase to (hopefully) fix 404 error on GitHub.
2017-10-17 13:13:48 +00:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Vulkan Memory Allocator: VK_KHR_dedicated_allocation</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 -->
Updated copyright header to year 2021. Rebuilt binaries, regenerated documentation.
2021-02-16 16:28:49 +00:00
<!-- Generated by Doxygen 1.9.1 -->
Documentation: changed page identifier to lowercase to (hopefully) fix 404 error on GitHub.
2017-10-17 13:13:48 +00:00
<script type="text/javascript">
Prepared version 2.1.0 final. Rebuilt binaries. Updated CHANGELOG.md. Rebuilt Doxygen dovcumentation (with new Doxygen version).
2018-09-10 09:14:05 +00:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Updated copyright header to year 2021. Rebuilt binaries, regenerated documentation.
2021-02-16 16:28:49 +00:00
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
Prepared version 2.1.0 final. Rebuilt binaries. Updated CHANGELOG.md. Rebuilt Doxygen dovcumentation (with new Doxygen version).
2018-09-10 09:14:05 +00:00
/* @license-end */
Documentation: changed page identifier to lowercase to (hopefully) fix 404 error on GitHub.
2017-10-17 13:13:48 +00:00
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
Prepared version 2.1.0 final. Rebuilt binaries. Updated CHANGELOG.md. Rebuilt Doxygen dovcumentation (with new Doxygen version).
2018-09-10 09:14:05 +00:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Documentation: changed page identifier to lowercase to (hopefully) fix 404 error on GitHub.
2017-10-17 13:13:48 +00:00
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
Prepared version 2.1.0 final. Rebuilt binaries. Updated CHANGELOG.md. Rebuilt Doxygen dovcumentation (with new Doxygen version).
2018-09-10 09:14:05 +00:00
/* @license-end */</script>
Documentation: changed page identifier to lowercase to (hopefully) fix 404 error on GitHub.
2017-10-17 13:13:48 +00:00
<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>
Add function vmaGetAllocatorInfo, structure VmaAllocatorInfo Closes #99 Also rebuilt Doxygen documentation.
2020-03-02 14:32:10 +00:00
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="index.html">Vulkan Memory Allocator</a></li> </ul>
</div>
Documentation: changed page identifier to lowercase to (hopefully) fix 404 error on GitHub.
2017-10-17 13:13:48 +00:00
</div><!-- top -->
Updated documentation - added information about VK_AMD_memory_allocation_behavior extension. Regenerated documentation, using new Doxygen version.
2019-01-15 10:45:58 +00:00
<div class="PageDoc"><div class="header">
Documentation: changed page identifier to lowercase to (hopefully) fix 404 error on GitHub.
2017-10-17 13:13:48 +00:00
<div class="headertitle">
<div class="title">VK_KHR_dedicated_allocation </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>VK_KHR_dedicated_allocation is a Vulkan extension which can be used to improve performance on some GPUs. It augments Vulkan API with possibility to query driver whether it prefers particular buffer or image to have its own, dedicated allocation (separate <code>VkDeviceMemory</code> block) for better efficiency - to be able to do some internal optimizations.</p>
<p>The extension is supported by this library. It will be used automatically when enabled. To enable it:</p>
<p>1 . When creating Vulkan device, check if following 2 device extensions are supported (call <code>vkEnumerateDeviceExtensionProperties()</code>). If yes, enable them (fill <code>VkDeviceCreateInfo::ppEnabledExtensionNames</code>).</p>
<ul>
<li>VK_KHR_get_memory_requirements2</li>
<li>VK_KHR_dedicated_allocation</li>
</ul>
<p>If you enabled these extensions:</p>
Updated documentation - added information about VK_AMD_memory_allocation_behavior extension. Regenerated documentation, using new Doxygen version.
2019-01-15 10:45:58 +00:00
<p>2 . Use <a class="el" href="vk__mem__alloc_8h.html#a4f87c9100d154a65a4ad495f7763cf7cace7da7cc6e71a625dfa763c55a597878" title="Enables usage of VK_KHR_dedicated_allocation extension.">VMA_ALLOCATOR_CREATE_KHR_DEDICATED_ALLOCATION_BIT</a> flag when creating your <a class="el" href="struct_vma_allocator.html" title="Represents main object of this library initialized.">VmaAllocator</a>`to inform the library that you enabled required extensions and you want the library to use them.</p>
Updated copyright header to year 2021. Rebuilt binaries, regenerated documentation.
2021-02-16 16:28:49 +00:00
<div class="fragment"><div class="line">allocatorInfo.flags |= <a class="code" href="vk__mem__alloc_8h.html#a4f87c9100d154a65a4ad495f7763cf7cace7da7cc6e71a625dfa763c55a597878">VMA_ALLOCATOR_CREATE_KHR_DEDICATED_ALLOCATION_BIT</a>;</div>
Fixes and adjustments for budget, regenerate documentation
2019-11-02 14:24:33 +00:00
<div class="line"> </div>
Regenerate documentation, rebuild binaries Switched binaries from vs2017 to vs2019.
2019-11-18 14:03:59 +00:00
<div class="line"><a class="code" href="vk__mem__alloc_8h.html#a200692051ddb34240248234f5f4c17bb">vmaCreateAllocator</a>(&amp;allocatorInfo, &amp;allocator);</div>
Updated copyright header to year 2021. Rebuilt binaries, regenerated documentation.
2021-02-16 16:28:49 +00:00
<div class="ttc" id="avk__mem__alloc_8h_html_a200692051ddb34240248234f5f4c17bb"><div class="ttname"><a href="vk__mem__alloc_8h.html#a200692051ddb34240248234f5f4c17bb">vmaCreateAllocator</a></div><div class="ttdeci">VkResult vmaCreateAllocator(const VmaAllocatorCreateInfo *pCreateInfo, VmaAllocator *pAllocator)</div><div class="ttdoc">Creates Allocator object.</div></div>
<div class="ttc" id="avk__mem__alloc_8h_html_a4f87c9100d154a65a4ad495f7763cf7cace7da7cc6e71a625dfa763c55a597878"><div class="ttname"><a href="vk__mem__alloc_8h.html#a4f87c9100d154a65a4ad495f7763cf7cace7da7cc6e71a625dfa763c55a597878">VMA_ALLOCATOR_CREATE_KHR_DEDICATED_ALLOCATION_BIT</a></div><div class="ttdeci">@ VMA_ALLOCATOR_CREATE_KHR_DEDICATED_ALLOCATION_BIT</div><div class="ttdoc">Enables usage of VK_KHR_dedicated_allocation extension.</div><div class="ttdef"><b>Definition:</b> vk_mem_alloc.h:2264</div></div>
Regenerate documentation, rebuild binaries Switched binaries from vs2017 to vs2019.
2019-11-18 14:03:59 +00:00
</div><!-- fragment --><p>That's all. The extension will be automatically used whenever you create a buffer using <a class="el" href="vk__mem__alloc_8h.html#ac72ee55598617e8eecca384e746bab51">vmaCreateBuffer()</a> or image using <a class="el" href="vk__mem__alloc_8h.html#a02a94f25679275851a53e82eacbcfc73" title="Function similar to vmaCreateBuffer().">vmaCreateImage()</a>.</p>
Documentation: changed page identifier to lowercase to (hopefully) fix 404 error on GitHub.
2017-10-17 13:13:48 +00:00
<p>When using the extension together with Vulkan Validation Layer, you will receive warnings like this: </p><pre class="fragment">vkBindBufferMemory(): Binding memory to buffer 0x33 but vkGetBufferMemoryRequirements() has not been called on that buffer.
Updated copyright header to year 2021. Rebuilt binaries, regenerated documentation.
2021-02-16 16:28:49 +00:00
</pre><p> It is OK, you should just ignore it. It happens because you use function <code>vkGetBufferMemoryRequirements2KHR()</code> instead of standard <code>vkGetBufferMemoryRequirements()</code>, while the validation layer seems to be unaware of it.</p>
Documentation: changed page identifier to lowercase to (hopefully) fix 404 error on GitHub.
2017-10-17 13:13:48 +00:00
<p>To learn more about this extension, see:</p>
<ul>
Add documentation chapter about VK_AMD_device_coherent_memory extension usage Regenerated Doxygen documentation.
2020-02-07 16:18:35 +00:00
<li><a href="https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/chap44.html#VK_KHR_dedicated_allocation">VK_KHR_dedicated_allocation in Vulkan specification</a></li>
Documentation: changed page identifier to lowercase to (hopefully) fix 404 error on GitHub.
2017-10-17 13:13:48 +00:00
<li><a href="http://asawicki.info/articles/VK_KHR_dedicated_allocation.php5">VK_KHR_dedicated_allocation unofficial manual</a> </li>
</ul>
Fixes and adjustments for budget, regenerate documentation
2019-11-02 14:24:33 +00:00
</div></div><!-- contents -->
</div><!-- PageDoc -->
Documentation: changed page identifier to lowercase to (hopefully) fix 404 error on GitHub.
2017-10-17 13:13:48 +00:00
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Updated copyright header to year 2021. Rebuilt binaries, regenerated documentation.
2021-02-16 16:28:49 +00:00
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.1
Documentation: changed page identifier to lowercase to (hopefully) fix 404 error on GitHub.
2017-10-17 13:13:48 +00:00
</small></address>
</body>
</html>
Reference in New Issue Copy Permalink