eden-emu/VulkanMemoryAllocator
14
0
Fork 0
mirror of https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator.git synced 2025-05-16 17:58:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added documentation chapter: Frequenty asked questions
Some checks failed
Build code on Linux / linux (Debug, clang++-15, -stdlib=libc++, sudo apt install clang-15 libc++-15-dev libc++abi-15-dev) (push) Has been cancelled
Details
Build code on Linux / linux (Debug, g++-12, sudo apt install g++-12) (push) Has been cancelled
Details
Build code on Linux / linux (Release, clang++-15, -stdlib=libc++, sudo apt install clang-15 libc++-15-dev libc++abi-15-dev) (push) Has been cancelled
Details
Build code on Linux / linux (Release, g++-12, sudo apt install g++-12) (push) Has been cancelled
Details
Static code analysis (clang-tidy) / clang-tidy (push) Has been cancelled
Details
Build code / Windows MSVC (Debug) (push) Has been cancelled
Details
Build code / Windows MSVC (Release) (push) Has been cancelled
Details

Browse source
This commit is contained in:
Adam Sawicki 2025-04-14 18:09:25 +02:00
parent f378e7b3f1
commit 539c0a8d8e
29 changed files with 527 additions and 89 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/html/search/all_0.js
View file

@ -31,5 +31,6 @@ var searchData=
['and_20units_28',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]],
['and_20user_20data_29',['Allocation names and user data',['../allocation_annotation.html',1,'index']]],
['apis_30',['Interop with other graphics APIs',['../other_api_interop.html',1,'index']]],
['at_20once_31',['Free-at-once',['../custom_memory_pools.html#linear_algorithm_free_at_once',1,'']]]
['asked_20questions_31',['Frequenty asked questions',['../faq.html',1,'index']]],
['at_20once_32',['Free-at-once',['../custom_memory_pools.html#linear_algorithm_free_at_once',1,'']]]
];

2
docs/html/search/all_12.js
View file

@ -4,7 +4,7 @@ var searchData=
['to_20use_20custom_20pools_1',['When not to use custom pools',['../custom_memory_pools.html#custom_memory_pools_when_not_use',1,'']]],
['to_20vulkan_20functions_2',['Pointers to Vulkan functions',['../configuration.html#config_Vulkan_functions',1,'']]],
['total_3',['total',['../struct_vma_total_statistics.html#a76f1935f7101883f5bb2a03b6c5649d2',1,'VmaTotalStatistics']]],
['type_4',['Choosing memory type',['../choosing_memory_type.html',1,'index']]],
['type_4',['Choosing memory type',['../choosing_memory_type.html',1,'faq']]],
['type_20index_5',['Choosing memory type index',['../custom_memory_pools.html#custom_memory_pools_MemTypeIndex',1,'']]],
['types_6',['Explicit memory types',['../choosing_memory_type.html#choosing_memory_type_explicit_memory_types',1,'']]]
];

2
docs/html/search/all_2.js
View file

@ -3,7 +3,7 @@ var searchData=
['cache_20flush_20and_20invalidate_0',['Cache flush and invalidate',['../memory_mapping.html#memory_mapping_cache_control',1,'']]],
['callbacks_1',['Device memory allocation callbacks',['../configuration.html#allocation_callbacks',1,'']]],
['cases_2',['Other use cases',['../usage_patterns.html#usage_patterns_other_use_cases',1,'']]],
['choosing_20memory_20type_3',['Choosing memory type',['../choosing_memory_type.html',1,'index']]],
['choosing_20memory_20type_3',['Choosing memory type',['../choosing_memory_type.html',1,'faq']]],
['choosing_20memory_20type_20index_4',['Choosing memory type index',['../custom_memory_pools.html#custom_memory_pools_MemTypeIndex',1,'']]],
['compatibility_5',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]],
['configuration_6',['Configuration',['../configuration.html',1,'index']]],

3
docs/html/search/all_5.js
View file

@ -7,5 +7,6 @@ var searchData=
['for_20budget_4',['Querying for budget',['../staying_within_budget.html#staying_within_budget_querying_for_budget',1,'']]],
['for_20upload_5',['Staging copy for upload',['../usage_patterns.html#usage_patterns_staging_copy_upload',1,'']]],
['free_20at_20once_6',['Free-at-once',['../custom_memory_pools.html#linear_algorithm_free_at_once',1,'']]],
['functions_7',['functions',['../memory_mapping.html#memory_mapping_copy_functions',1,'Copy functions'],['../quick_start.html#quick_start_initialization_importing_vulkan_functions',1,'Importing Vulkan functions'],['../memory_mapping.html#memory_mapping_mapping_functions',1,'Mapping functions'],['../configuration.html#config_Vulkan_functions',1,'Pointers to Vulkan functions']]]
['frequenty_20asked_20questions_7',['Frequenty asked questions',['../faq.html',1,'index']]],
['functions_8',['functions',['../memory_mapping.html#memory_mapping_copy_functions',1,'Copy functions'],['../quick_start.html#quick_start_initialization_importing_vulkan_functions',1,'Importing Vulkan functions'],['../memory_mapping.html#memory_mapping_mapping_functions',1,'Mapping functions'],['../configuration.html#config_Vulkan_functions',1,'Pointers to Vulkan functions']]]
];

2
docs/html/search/all_b.js
View file

@ -17,7 +17,7 @@ var searchData=
['memory_20limit_14',['Device heap memory limit',['../configuration.html#heap_memory_limit',1,'']]],
['memory_20mapping_15',['Memory mapping',['../memory_mapping.html',1,'index']]],
['memory_20pools_16',['memory pools',['../custom_memory_pools.html',1,'Custom memory pools'],['../choosing_memory_type.html#choosing_memory_type_custom_memory_pools',1,'Custom memory pools']]],
['memory_20type_17',['Choosing memory type',['../choosing_memory_type.html',1,'index']]],
['memory_20type_17',['Choosing memory type',['../choosing_memory_type.html',1,'faq']]],
['memory_20type_20index_18',['Choosing memory type index',['../custom_memory_pools.html#custom_memory_pools_MemTypeIndex',1,'']]],
['memory_20types_19',['Explicit memory types',['../choosing_memory_type.html#choosing_memory_type_explicit_memory_types',1,'']]],
['memory_20usage_20',['memory usage',['../staying_within_budget.html#staying_within_budget_controlling_memory_usage',1,'Controlling memory usage'],['../debugging_memory_usage.html',1,'Debugging incorrect memory usage']]],

3
docs/html/search/all_f.js
View file

@ -1,5 +1,6 @@
var searchData=
[
['querying_20for_20budget_0',['Querying for budget',['../staying_within_budget.html#staying_within_budget_querying_for_budget',1,'']]],
['quick_20start_1',['Quick start',['../quick_start.html',1,'index']]]
['questions_1',['Frequenty asked questions',['../faq.html',1,'index']]],
['quick_20start_2',['Quick start',['../quick_start.html',1,'index']]]
];

3
docs/html/search/pages_0.js
View file

@ -6,5 +6,6 @@ var searchData=
['allocator_3',['Vulkan Memory Allocator',['../index.html',1,'']]],
['allocator_4',['Virtual allocator',['../virtual_allocator.html',1,'index']]],
['and_20user_20data_5',['Allocation names and user data',['../allocation_annotation.html',1,'index']]],
['apis_6',['Interop with other graphics APIs',['../other_api_interop.html',1,'index']]]
['apis_6',['Interop with other graphics APIs',['../other_api_interop.html',1,'index']]],
['asked_20questions_7',['Frequenty asked questions',['../faq.html',1,'index']]]
];

4
docs/html/search/pages_10.js
View file

@ -1,6 +1,4 @@
var searchData=
[
['usage_0',['Debugging incorrect memory usage',['../debugging_memory_usage.html',1,'index']]],
['usage_20patterns_1',['Recommended usage patterns',['../usage_patterns.html',1,'index']]],
['user_20data_2',['Allocation names and user data',['../allocation_annotation.html',1,'index']]]
['type_0',['Choosing memory type',['../choosing_memory_type.html',1,'faq']]]
];

9
docs/html/search/pages_11.js
View file

@ -1,9 +1,6 @@
var searchData=
[
['virtual_20allocator_0',['Virtual allocator',['../virtual_allocator.html',1,'index']]],
['vk_5famd_5fdevice_5fcoherent_5fmemory_1',['VK_AMD_device_coherent_memory',['../vk_amd_device_coherent_memory.html',1,'index']]],
['vk_5fext_5fmemory_5fpriority_2',['VK_EXT_memory_priority',['../vk_ext_memory_priority.html',1,'index']]],
['vk_5fkhr_5fdedicated_5fallocation_3',['VK_KHR_dedicated_allocation',['../vk_khr_dedicated_allocation.html',1,'index']]],
['vk_5fkhr_5fexternal_5fmemory_5fwin32_4',['VK_KHR_external_memory_win32',['../vk_khr_external_memory_win32.html',1,'index']]],
['vulkan_20memory_20allocator_5',['Vulkan Memory Allocator',['../index.html',1,'']]]
['usage_0',['Debugging incorrect memory usage',['../debugging_memory_usage.html',1,'index']]],
['usage_20patterns_1',['Recommended usage patterns',['../usage_patterns.html',1,'index']]],
['user_20data_2',['Allocation names and user data',['../allocation_annotation.html',1,'index']]]
];

8
docs/html/search/pages_12.js
View file

@ -1,5 +1,9 @@
var searchData=
[
['with_20other_20graphics_20apis_0',['Interop with other graphics APIs',['../other_api_interop.html',1,'index']]],
['within_20budget_1',['Staying within budget',['../staying_within_budget.html',1,'index']]]
['virtual_20allocator_0',['Virtual allocator',['../virtual_allocator.html',1,'index']]],
['vk_5famd_5fdevice_5fcoherent_5fmemory_1',['VK_AMD_device_coherent_memory',['../vk_amd_device_coherent_memory.html',1,'index']]],
['vk_5fext_5fmemory_5fpriority_2',['VK_EXT_memory_priority',['../vk_ext_memory_priority.html',1,'index']]],
['vk_5fkhr_5fdedicated_5fallocation_3',['VK_KHR_dedicated_allocation',['../vk_khr_dedicated_allocation.html',1,'index']]],
['vk_5fkhr_5fexternal_5fmemory_5fwin32_4',['VK_KHR_external_memory_win32',['../vk_khr_external_memory_win32.html',1,'index']]],
['vulkan_20memory_20allocator_5',['Vulkan Memory Allocator',['../index.html',1,'']]]
];

5
docs/html/search/pages_13.js Normal file
View file

@ -0,0 +1,5 @@
var searchData=
[
['with_20other_20graphics_20apis_0',['Interop with other graphics APIs',['../other_api_interop.html',1,'index']]],
['within_20budget_1',['Staying within budget',['../staying_within_budget.html',1,'index']]]
];

2
docs/html/search/pages_2.js
View file

@ -1,6 +1,6 @@
var searchData=
[
['choosing_20memory_20type_0',['Choosing memory type',['../choosing_memory_type.html',1,'index']]],
['choosing_20memory_20type_0',['Choosing memory type',['../choosing_memory_type.html',1,'faq']]],
['configuration_1',['Configuration',['../configuration.html',1,'index']]],
['considerations_2',['General considerations',['../general_considerations.html',1,'index']]],
['custom_20memory_20pools_3',['Custom memory pools',['../custom_memory_pools.html',1,'index']]]

3
docs/html/search/pages_5.js
View file

@ -1,5 +1,4 @@
var searchData=
[
['general_20considerations_0',['General considerations',['../general_considerations.html',1,'index']]],
['graphics_20apis_1',['Interop with other graphics APIs',['../other_api_interop.html',1,'index']]]
['frequenty_20asked_20questions_0',['Frequenty asked questions',['../faq.html',1,'index']]]
];

4
docs/html/search/pages_6.js
View file

@ -1,5 +1,5 @@
var searchData=
[
['incorrect_20memory_20usage_0',['Debugging incorrect memory usage',['../debugging_memory_usage.html',1,'index']]],
['interop_20with_20other_20graphics_20apis_1',['Interop with other graphics APIs',['../other_api_interop.html',1,'index']]]
['general_20considerations_0',['General considerations',['../general_considerations.html',1,'index']]],
['graphics_20apis_1',['Interop with other graphics APIs',['../other_api_interop.html',1,'index']]]
];

3
docs/html/search/pages_7.js
View file

@ -1,4 +1,5 @@
var searchData=
[
['list_0',['Deprecated List',['../deprecated.html',1,'']]]
['incorrect_20memory_20usage_0',['Debugging incorrect memory usage',['../debugging_memory_usage.html',1,'index']]],
['interop_20with_20other_20graphics_20apis_1',['Interop with other graphics APIs',['../other_api_interop.html',1,'index']]]
];

7
docs/html/search/pages_8.js
View file

@ -1,9 +1,4 @@
var searchData=
[
['mapping_0',['Memory mapping',['../memory_mapping.html',1,'index']]],
['memory_20allocator_1',['Vulkan Memory Allocator',['../index.html',1,'']]],
['memory_20mapping_2',['Memory mapping',['../memory_mapping.html',1,'index']]],
['memory_20pools_3',['Custom memory pools',['../custom_memory_pools.html',1,'index']]],
['memory_20type_4',['Choosing memory type',['../choosing_memory_type.html',1,'index']]],
['memory_20usage_5',['Debugging incorrect memory usage',['../debugging_memory_usage.html',1,'index']]]
['list_0',['Deprecated List',['../deprecated.html',1,'']]]
];

7
docs/html/search/pages_9.js
View file

@ -1,4 +1,9 @@
var searchData=
[
['names_20and_20user_20data_0',['Allocation names and user data',['../allocation_annotation.html',1,'index']]]
['mapping_0',['Memory mapping',['../memory_mapping.html',1,'index']]],
['memory_20allocator_1',['Vulkan Memory Allocator',['../index.html',1,'']]],
['memory_20mapping_2',['Memory mapping',['../memory_mapping.html',1,'index']]],
['memory_20pools_3',['Custom memory pools',['../custom_memory_pools.html',1,'index']]],
['memory_20type_4',['Choosing memory type',['../choosing_memory_type.html',1,'faq']]],
['memory_20usage_5',['Debugging incorrect memory usage',['../debugging_memory_usage.html',1,'index']]]
];

3
docs/html/search/pages_a.js
View file

@ -1,5 +1,4 @@
var searchData=
[
['other_20graphics_20apis_0',['Interop with other graphics APIs',['../other_api_interop.html',1,'index']]],
['overlap_1',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'index']]]
['names_20and_20user_20data_0',['Allocation names and user data',['../allocation_annotation.html',1,'index']]]
];

4
docs/html/search/pages_b.js
View file

@ -1,5 +1,5 @@
var searchData=
[
['patterns_0',['Recommended usage patterns',['../usage_patterns.html',1,'index']]],
['pools_1',['Custom memory pools',['../custom_memory_pools.html',1,'index']]]
['other_20graphics_20apis_0',['Interop with other graphics APIs',['../other_api_interop.html',1,'index']]],
['overlap_1',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'index']]]
];

3
docs/html/search/pages_c.js
View file

@ -1,4 +1,5 @@
var searchData=
[
['quick_20start_0',['Quick start',['../quick_start.html',1,'index']]]
['patterns_0',['Recommended usage patterns',['../usage_patterns.html',1,'index']]],
['pools_1',['Custom memory pools',['../custom_memory_pools.html',1,'index']]]
];

4
docs/html/search/pages_d.js
View file

@ -1,5 +1,5 @@
var searchData=
[
['recommended_20usage_20patterns_0',['Recommended usage patterns',['../usage_patterns.html',1,'index']]],
['resource_20aliasing_20overlap_1',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'index']]]
['questions_0',['Frequenty asked questions',['../faq.html',1,'index']]],
['quick_20start_1',['Quick start',['../quick_start.html',1,'index']]]
];

5
docs/html/search/pages_e.js
View file

@ -1,6 +1,5 @@
var searchData=
[
['start_0',['Quick start',['../quick_start.html',1,'index']]],
['statistics_1',['Statistics',['../statistics.html',1,'index']]],
['staying_20within_20budget_2',['Staying within budget',['../staying_within_budget.html',1,'index']]]
['recommended_20usage_20patterns_0',['Recommended usage patterns',['../usage_patterns.html',1,'index']]],
['resource_20aliasing_20overlap_1',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'index']]]
];

4
docs/html/search/pages_f.js
View file

@ -1,4 +1,6 @@
var searchData=
[
['type_0',['Choosing memory type',['../choosing_memory_type.html',1,'index']]]
['start_0',['Quick start',['../quick_start.html',1,'index']]],
['statistics_1',['Statistics',['../statistics.html',1,'index']]],
['staying_20within_20budget_2',['Staying within budget',['../staying_within_budget.html',1,'index']]]
];

2
docs/html/search/searchdata.js
View file

@ -9,7 +9,7 @@ var indexSectionsWithContent =
6: "v",
7: "v",
8: "ailmsv",
9: "abcdegilmnopqrstuvw"
9: "abcdefgilmnopqrstuvw"
};
var indexSectionNames =