Added documentation chapter: Frequenty asked questions

adam-sawicki-a · adam-sawicki-a · commit 539c0a8d8e37 · 2025-04-14T18:09:25.000+02:00
diff --git a/docs/html/choosing_memory_type.html b/docs/html/choosing_memory_type.html
@@ -83,7 +83,7 @@
 
 <div id="nav-path" class="navpath">
   <ul>
-<li class="navelem"><a class="el" href="index.html">Vulkan Memory Allocator</a></li>  </ul>
+<li class="navelem"><a class="el" href="index.html">Vulkan Memory Allocator</a></li><li class="navelem"><a class="el" href="faq.html">Frequenty asked questions</a></li>  </ul>
 </div>
 </div><!-- top -->
 <div id="doc-content">
diff --git a/docs/html/doxygen_crawl.html b/docs/html/doxygen_crawl.html
@@ -45,6 +45,7 @@
 <a href="enabling_buffer_device_address.html#enabling_buffer_device_address_initialization"/>
 <a href="enabling_buffer_device_address.html#enabling_buffer_device_address_more_information"/>
 <a href="enabling_buffer_device_address.html#enabling_buffer_device_address_usage"/>
+<a href="faq.html"/>
 <a href="files.html"/>
 <a href="functions.html"/>
 <a href="functions_vars.html"/>
diff --git a/docs/html/faq.html b/docs/html/faq.html
diff --git a/docs/html/index.html b/docs/html/index.html
@@ -94,7 +94,7 @@
 <p><b>API documentation divided into groups:</b> <a href="topics.html">Topics</a></p>
 <p><b>General documentation chapters:</b></p>
 <ul>
-<li><b>User guide</b><ul>
+<li><a class="el" href="faq.html">Frequenty asked questions</a></li>
 <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>
@@ -154,8 +154,6 @@
 </ul>
 </li>
 <li><a class="el" href="other_api_interop.html">Interop with other graphics APIs</a></li>
-</ul>
-</li>
 <li><a class="el" href="usage_patterns.html">Recommended usage patterns</a><ul>
 <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>
diff --git a/docs/html/search/all_0.js b/docs/html/search/all_0.js
diff --git a/docs/html/search/all_12.js b/docs/html/search/all_12.js
@@ -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,'']]]
 ];
diff --git a/docs/html/search/all_2.js b/docs/html/search/all_2.js
@@ -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']]],
diff --git a/docs/html/search/all_5.js b/docs/html/search/all_5.js
diff --git a/docs/html/search/all_b.js b/docs/html/search/all_b.js
diff --git a/docs/html/search/all_f.js b/docs/html/search/all_f.js
@@ -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']]]
 ];
diff --git a/docs/html/search/pages_0.js b/docs/html/search/pages_0.js
@@ -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']]]
 ];
diff --git a/docs/html/search/pages_10.js b/docs/html/search/pages_10.js
@@ -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']]]
 ];
diff --git a/docs/html/search/pages_11.js b/docs/html/search/pages_11.js
@@ -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']]]
 ];
diff --git a/docs/html/search/pages_12.js b/docs/html/search/pages_12.js
@@ -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,'']]]
 ];
diff --git a/docs/html/search/pages_13.js b/docs/html/search/pages_13.js
@@ -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']]]
+];
diff --git a/docs/html/search/pages_2.js b/docs/html/search/pages_2.js
@@ -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']]]
diff --git a/docs/html/search/pages_5.js b/docs/html/search/pages_5.js
@@ -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']]]
 ];
diff --git a/docs/html/search/pages_6.js b/docs/html/search/pages_6.js
@@ -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']]]
 ];
diff --git a/docs/html/search/pages_7.js b/docs/html/search/pages_7.js
@@ -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']]]
 ];
diff --git a/docs/html/search/pages_8.js b/docs/html/search/pages_8.js
@@ -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,'']]]
 ];
diff --git a/docs/html/search/pages_9.js b/docs/html/search/pages_9.js
@@ -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']]]
 ];
diff --git a/docs/html/search/pages_a.js b/docs/html/search/pages_a.js
@@ -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']]]
 ];
diff --git a/docs/html/search/pages_b.js b/docs/html/search/pages_b.js
@@ -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']]]
 ];
diff --git a/docs/html/search/pages_c.js b/docs/html/search/pages_c.js
@@ -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']]]
 ];
diff --git a/docs/html/search/pages_d.js b/docs/html/search/pages_d.js
@@ -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']]]
 ];
diff --git a/docs/html/search/pages_e.js b/docs/html/search/pages_e.js
@@ -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']]]
 ];
diff --git a/docs/html/search/pages_f.js b/docs/html/search/pages_f.js
@@ -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']]]
 ];
diff --git a/docs/html/search/searchdata.js b/docs/html/search/searchdata.js
@@ -9,7 +9,7 @@ var indexSectionsWithContent =
   6: "v",
   7: "v",
   8: "ailmsv",
-  9: "abcdegilmnopqrstuvw"
+  9: "abcdefgilmnopqrstuvw"
 };
 
 var indexSectionNames =
diff --git a/include/vk_mem_alloc.h b/include/vk_mem_alloc.h

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`var searchData=`
`2`	`2`	`[`
`3`	`3`	`['querying_20for_20budget_0',['Querying for budget',['../staying_within_budget.html#staying_within_budget_querying_for_budget',1,'']]],`
`4`		`- ['quick_20start_1',['Quick start',['../quick_start.html',1,'index']]]`
	`4`	`+ ['questions_1',['Frequenty asked questions',['../faq.html',1,'index']]],`
	`5`	`+ ['quick_20start_2',['Quick start',['../quick_start.html',1,'index']]]`
`5`	`6`	`];`