mirror/VulkanMemoryAllocator
1
0
Fork 0
mirror of https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator.git synced 2024-11-26 08:34:34 +00:00
Code Issues Packages Projects Releases Wiki Activity
85a49729c3
VulkanMemoryAllocator/docs/html/index.html

179 lines
9.5 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">
Generated Doxygen documentation into docs/ directory.
2017-06-20 09:17:23 +00:00
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Fixes in comments Regenerated documentation.
2021-10-18 15:32:40 +00:00
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.2"/>
Generated Doxygen documentation into docs/ directory.
2017-06-20 09:17:23 +00:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Vulkan Memory Allocator: Vulkan Memory Allocator</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 -->
Fixes in comments Regenerated documentation.
2021-10-18 15:32:40 +00:00
<!-- Generated by Doxygen 1.9.2 -->
Generated Doxygen documentation into docs/ directory.
2017-06-20 09:17:23 +00:00
<script type="text/javascript">
Fixes in comments Regenerated documentation.
2021-10-18 15:32:40 +00:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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 */
Generated Doxygen documentation into docs/ directory.
2017-06-20 09:17:23 +00:00
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
Fixes in comments Regenerated documentation.
2021-10-18 15:32:40 +00:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
Generated Doxygen documentation into docs/ directory.
2017-06-20 09:17:23 +00:00
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
Fixes in comments Regenerated documentation.
2021-10-18 15:32:40 +00:00
/* @license-end */
</script>
Generated Doxygen documentation into docs/ directory.
2017-06-20 09:17:23 +00:00
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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>
Fixes in comments Regenerated documentation.
2021-10-18 15:32:40 +00:00
<div><div class="header">
<div class="headertitle"><div class="title">Vulkan Memory Allocator </div></div>
Generated Doxygen documentation into docs/ directory.
2017-06-20 09:17:23 +00:00
</div><!--header-->
<div class="contents">
Improvements in documentation
2021-12-03 17:04:34 +00:00
<div class="textblock"><p ><b>Version 3.0.0-development</b></p>
Changes in ALLOCATION_CREATE_STRATEGY flags. COMPATIBILITY BREAKING! Removed flags: VMA_ALLOCATION_CREATE_STRATEGY_MIN_FRAGMENTATION_BIT, VMA_ALLOCATION_CREATE_STRATEGY_WORST_FIT_BIT, VMA_VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_FRAGMENTATION_BIT. Regenerated documentation.
2022-01-26 16:47:11 +00:00
<p >Copyright (c) 2017-2022 Advanced Micro Devices, Inc. All rights reserved. <br />
Reorganized Doxygen documentation into more separate pages.
2017-10-17 09:27:14 +00:00
License: MIT</p>
Refactored virtual allocator. (COMPATIBILITY BREAKING!) Added TLSF algoritym. Refactored virtual allocator: Added type VmaVirtualAllocation, member VmaVirtualAllocationInfo::offset, changed parameters of vmaVirtualAllocate, vmaVirtualFree, vmaSetVirtualAllocationUserData, vmaGetVirtualAllocationInfo. Added TLSF algorithm: Added VMA_POOL_CREATE_TLSF_ALGORITHM_BIT, VMA_VIRTUAL_BLOCK_CREATE_TLSF_ALGORITHM_BIT. Some internal refactoring. Improved documentation: Grouped API elements into Doxygen modules. Code mostly by @medranSolus.
2022-01-20 16:00:33 +00:00
<p ><b>API documentation divided into groups:</b> <a href="modules.html">Modules</a></p>
More documentation. Refactored table of contents.
2018-03-12 14:34:32 +00:00
<h1><a class="anchor" id="main_table_of_contents"></a>
Table of contents</h1>
Reorganized Doxygen documentation into more separate pages.
2017-10-17 09:27:14 +00:00
<ul>
More documentation. Refactored table of contents.
2018-03-12 14:34:32 +00:00
<li><b>User guide</b><ul>
<li><a class="el" href="quick_start.html">Quick start</a><ul>
<li><a class="el" href="quick_start.html#quick_start_project_setup">Project setup</a></li>
<li><a class="el" href="quick_start.html#quick_start_initialization">Initialization</a></li>
<li><a class="el" href="quick_start.html#quick_start_resource_allocation">Resource allocation</a></li>
</ul>
</li>
<li><a class="el" href="choosing_memory_type.html">Choosing memory type</a><ul>
<li><a class="el" href="choosing_memory_type.html#choosing_memory_type_usage">Usage</a></li>
<li><a class="el" href="choosing_memory_type.html#choosing_memory_type_required_preferred_flags">Required and preferred flags</a></li>
<li><a class="el" href="choosing_memory_type.html#choosing_memory_type_explicit_memory_types">Explicit memory types</a></li>
<li><a class="el" href="choosing_memory_type.html#choosing_memory_type_custom_memory_pools">Custom memory pools</a></li>
Fixed major bug, made few smaller fixes and additions in documentation.
2018-12-14 10:37:02 +00:00
<li><a class="el" href="choosing_memory_type.html#choosing_memory_type_dedicated_allocations">Dedicated allocations</a></li>
More documentation. Refactored table of contents.
2018-03-12 14:34:32 +00:00
</ul>
</li>
<li><a class="el" href="memory_mapping.html">Memory mapping</a><ul>
<li><a class="el" href="memory_mapping.html#memory_mapping_mapping_functions">Mapping functions</a></li>
<li><a class="el" href="memory_mapping.html#memory_mapping_persistently_mapped_memory">Persistently mapped memory</a></li>
Clarify documentation in regards to cache flush/invalidate in few places See #91, thanks @ROTARTSI82 !
2019-12-02 12:42:25 +00:00
<li><a class="el" href="memory_mapping.html#memory_mapping_cache_control">Cache flush and invalidate</a></li>
More documentation. Refactored table of contents.
2018-03-12 14:34:32 +00:00
</ul>
</li>
Fixes and adjustments for budget, regenerate documentation
2019-11-02 14:24:33 +00:00
<li><a class="el" href="staying_within_budget.html">Staying within budget</a><ul>
<li><a class="el" href="staying_within_budget.html#staying_within_budget_querying_for_budget">Querying for budget</a></li>
<li><a class="el" href="staying_within_budget.html#staying_within_budget_controlling_memory_usage">Controlling memory usage</a></li>
</ul>
</li>
Add test and documentation for resource aliasing (overlap).
2020-08-18 14:43:44 +00:00
<li><a class="el" href="resource_aliasing.html">Resource aliasing (overlap)</a></li>
More documentation. Refactored table of contents.
2018-03-12 14:34:32 +00:00
<li><a class="el" href="custom_memory_pools.html">Custom memory pools</a><ul>
<li><a class="el" href="custom_memory_pools.html#custom_memory_pools_MemTypeIndex">Choosing memory type index</a></li>
Documented linear allocation algorithm. Added "Linear allocation algorithm" documentation chapter.
2018-08-23 13:00:58 +00:00
<li><a class="el" href="custom_memory_pools.html#linear_algorithm">Linear allocation algorithm</a><ul>
<li><a class="el" href="custom_memory_pools.html#linear_algorithm_free_at_once">Free-at-once</a></li>
<li><a class="el" href="custom_memory_pools.html#linear_algorithm_stack">Stack</a></li>
<li><a class="el" href="custom_memory_pools.html#linear_algorithm_double_stack">Double stack</a></li>
<li><a class="el" href="custom_memory_pools.html#linear_algorithm_ring_buffer">Ring buffer</a></li>
</ul>
</li>
Rewritten documentation chapter about defragmentation.
2018-12-07 14:24:28 +00:00
</ul>
</li>
New API for defragmentation. COMPATIBILITY BREAKING! See structure VmaDefragmentationInfo, VmaDefragmentationMove, VmaDefragmentationPassMoveInfo, VmaDefragmentationStats, function vmaBeginDefragmentation, vmaEndDefragmentation, vmaBeginDefragmentationPass, vmaEndDefragmentationPass. Switched to TLSF as the default algorithm - in default pools, custom pools, virtual blocks. Removed generic and buddy algorithm. Removed flags: VMA_POOL_CREATE_BUDDY_ALGORITHM_BIT, VMA_POOL_CREATE_TLSF_ALGORITHM_BIT, VMA_VIRTUAL_BLOCK_CREATE_BUDDY_ALGORITHM_BIT, VMA_VIRTUAL_BLOCK_CREATE_TLSF_ALGORITHM_BIT. Updated and regenerated documentation.
2022-02-22 22:38:19 +00:00
<li><a class="el" href="defragmentation.html">Defragmentation</a></li>
Documentation: Written "Statistics" chapter.
2018-03-12 14:58:23 +00:00
<li><a class="el" href="statistics.html">Statistics</a><ul>
<li><a class="el" href="statistics.html#statistics_numeric_statistics">Numeric statistics</a></li>
<li><a class="el" href="statistics.html#statistics_json_dump">JSON dump</a></li>
</ul>
</li>
More documentation. Refactored table of contents.
2018-03-12 14:34:32 +00:00
<li><a class="el" href="allocation_annotation.html">Allocation names and user data</a><ul>
<li><a class="el" href="allocation_annotation.html#allocation_user_data">Allocation user data</a></li>
<li><a class="el" href="allocation_annotation.html#allocation_names">Allocation names</a></li>
</ul>
</li>
Added documentation chapter "Virtual allocator" Regenerated the documentation.
2021-10-28 16:25:57 +00:00
<li><a class="el" href="virtual_allocator.html">Virtual allocator</a></li>
Added debug macro VMA_DEBUG_INITIALIZE_ALLOCATIONS to initialize contents of allocations with a bit pattern. Documented it. Added test for it. Fixed some indentation.
2018-06-15 12:30:39 +00:00
<li><a class="el" href="debugging_memory_usage.html">Debugging incorrect memory usage</a><ul>
<li><a class="el" href="debugging_memory_usage.html#debugging_memory_usage_initialization">Memory initialization</a></li>
<li><a class="el" href="debugging_memory_usage.html#debugging_memory_usage_margins">Margins</a></li>
<li><a class="el" href="debugging_memory_usage.html#debugging_memory_usage_corruption_detection">Corruption detection</a></li>
Added new feature: corruption detection. Added debug macro VMA_DEBUG_DETECT_CORRUPTION, functions vmaCheckCorruption, vmaCheckPoolCorruption
2018-06-14 13:44:45 +00:00
</ul>
</li>
Added documentation chapter about OpenGL interop Rebuilt the docs.
2021-07-28 13:25:52 +00:00
<li><a class="el" href="opengl_interop.html">OpenGL Interop</a></li>
Version 2.0.0-alpha.3 - major update.
2017-09-12 18:45:14 +00:00
</ul>
</li>
Documentation: Added "Recommended usage patterns" chapter.
2018-03-12 16:46:49 +00:00
<li><a class="el" href="usage_patterns.html">Recommended usage patterns</a><ul>
Rebuilt the docs
2022-02-17 13:44:48 +00:00
<li><a class="el" href="usage_patterns.html#usage_patterns_gpu_only">GPU-only resource</a></li>
<li><a class="el" href="usage_patterns.html#usage_patterns_staging_copy_upload">Staging copy for upload</a></li>
<li><a class="el" href="usage_patterns.html#usage_patterns_readback">Readback</a></li>
<li><a class="el" href="usage_patterns.html#usage_patterns_advanced_data_uploading">Advanced data uploading</a></li>
<li><a class="el" href="usage_patterns.html#usage_patterns_other_use_cases">Other use cases</a></li>
Documentation: Added "Recommended usage patterns" chapter.
2018-03-12 16:46:49 +00:00
</ul>
</li>
Added documentation for VK_KHR_dedicated_allocation extension.
2017-10-17 09:57:56 +00:00
<li><a class="el" href="configuration.html">Configuration</a><ul>
Further changes in importing pointers to Vulkan functions Reverted change removing configuration macro VMA_STATIC_VULKAN_FUNCTIONS. Added configuration macro VMA_DYNAMIC_VULKAN_FUNCTIONS. Fixes for Android. Closes #111, also refers to #56.
2020-03-31 17:11:41 +00:00
<li><a class="el" href="configuration.html#config_Vulkan_functions">Pointers to Vulkan functions</a></li>
More documentation. Refactored table of contents.
2018-03-12 14:34:32 +00:00
<li><a class="el" href="configuration.html#custom_memory_allocator">Custom host memory allocator</a></li>
<li><a class="el" href="configuration.html#allocation_callbacks">Device memory allocation callbacks</a></li>
<li><a class="el" href="configuration.html#heap_memory_limit">Device heap memory limit</a></li>
Rebuilt the docs
2022-02-17 13:44:48 +00:00
</ul>
</li>
Added documentation chapter "VK_EXT_memory_priority" Other fixes in documentation
2022-02-28 11:10:18 +00:00
<li><b>Extension support</b><ul>
Documentation: changed page identifier to lowercase to (hopefully) fix 404 error on GitHub.
2017-10-17 13:13:48 +00:00
<li><a class="el" href="vk_khr_dedicated_allocation.html">VK_KHR_dedicated_allocation</a></li>
Add support for buffer device address, together with documentation and tests Added VMA_ALLOCATOR_CREATE_BUFFER_DEVICE_ADDRESS_BIT.
2020-03-20 17:05:42 +00:00
<li><a class="el" href="enabling_buffer_device_address.html">Enabling buffer device address</a></li>
Added documentation chapter "VK_EXT_memory_priority" Other fixes in documentation
2022-02-28 11:10:18 +00:00
<li><a class="el" href="vk_ext_memory_priority.html">VK_EXT_memory_priority</a></li>
Add documentation chapter about VK_AMD_device_coherent_memory extension usage Regenerated Doxygen documentation.
2020-02-07 16:18:35 +00:00
<li><a class="el" href="vk_amd_device_coherent_memory.html">VK_AMD_device_coherent_memory</a></li>
Added documentation chapter "VK_EXT_memory_priority" Other fixes in documentation
2022-02-28 11:10:18 +00:00
</ul>
</li>
More documentation. Refactored table of contents.
2018-03-12 14:34:32 +00:00
<li><a class="el" href="general_considerations.html">General considerations</a><ul>
<li><a class="el" href="general_considerations.html#general_considerations_thread_safety">Thread safety</a></li>
Added documentation chapter "Versioning and compatibility" Many improvements in documentation and README.
2022-02-26 12:26:20 +00:00
<li><a class="el" href="general_considerations.html#general_considerations_versioning_and_compatibility">Versioning and compatibility</a></li>
Described version 2.1.0-beta.1 in CHANGELOG.md. Minor fixes in documentation.
2018-08-24 10:13:37 +00:00
<li><a class="el" href="general_considerations.html#general_considerations_validation_layer_warnings">Validation layer warnings</a></li>
More documentation. Refactored table of contents.
2018-03-12 14:34:32 +00:00
<li><a class="el" href="general_considerations.html#general_considerations_allocation_algorithm">Allocation algorithm</a></li>
<li><a class="el" href="general_considerations.html#general_considerations_features_not_supported">Features not supported</a></li>
</ul>
</li>
Version 2.0.0-alpha.3 - major update.
2017-09-12 18:45:14 +00:00
</ul>
More documentation. Refactored table of contents.
2018-03-12 14:34:32 +00:00
<h1><a class="anchor" id="main_see_also"></a>
See also</h1>
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +00:00
<ul>
Rebuilt the docs
2022-02-17 13:44:48 +00:00
<li><a href="https://gpuopen.com/gaming-product/vulkan-memory-allocator/"><b>Product page on GPUOpen</b></a></li>
<li><a href="https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator"><b>Source repository on GitHub</b></a> </li>
Updated version number to 2.0.0-alpha.2. Regenerated Doxygen documentation.
2017-07-11 13:22:12 +00:00
</ul>
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></div><!-- PageDoc -->
</div><!-- contents -->
Generated Doxygen documentation into docs/ directory.
2017-06-20 09:17:23 +00:00
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Fixes in comments Regenerated documentation.
2021-10-18 15:32:40 +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.2
Generated Doxygen documentation into docs/ directory.
2017-06-20 09:17:23 +00:00
</small></address>
</body>
</html>
Reference in New Issue Copy Permalink