From 76004205fd1c9313912e51fd476a0500ee92e3b2 Mon Sep 17 00:00:00 2001 From: Adam Sawicki Date: Fri, 7 Feb 2020 17:18:35 +0100 Subject: [PATCH] Add documentation chapter about VK_AMD_device_coherent_memory extension usage Regenerated Doxygen documentation. --- docs/html/allocation_annotation.html | 16 +- docs/html/annotated.html | 20 +- docs/html/choosing_memory_type.html | 16 +- docs/html/classes.html | 37 +- docs/html/custom_memory_pools.html | 16 +- docs/html/defragmentation.html | 20 +- docs/html/deprecated.html | 6 +- docs/html/functions.html | 13 + docs/html/functions_vars.html | 13 + docs/html/globals.html | 20 +- docs/html/globals_eval.html | 6 + docs/html/globals_func.html | 6 + docs/html/globals_type.html | 6 + docs/html/index.html | 1 + docs/html/lost_allocations.html | 12 +- docs/html/memory_mapping.html | 22 +- docs/html/pages.html | 5 +- docs/html/quick_start.html | 12 +- docs/html/search/all_0.js | 15 +- docs/html/search/all_1.js | 12 +- docs/html/search/all_10.js | 16 +- docs/html/search/all_11.js | 289 +- docs/html/search/all_12.html | 30 + docs/html/search/all_12.js | 150 + docs/html/search/all_2.js | 8 +- docs/html/search/all_3.js | 12 +- docs/html/search/all_4.js | 4 +- docs/html/search/all_5.js | 2 +- docs/html/search/all_6.js | 2 +- docs/html/search/all_7.js | 2 +- docs/html/search/all_8.js | 28 +- docs/html/search/all_9.js | 2 +- docs/html/search/all_a.js | 2 +- docs/html/search/all_b.js | 41 +- docs/html/search/all_c.js | 2 +- docs/html/search/all_d.js | 6 +- docs/html/search/all_e.js | 6 +- docs/html/search/all_f.js | 2 +- docs/html/search/classes_0.js | 38 +- docs/html/search/classes_1.html | 30 + docs/html/search/classes_1.js | 22 + docs/html/search/defines_0.js | 2 +- docs/html/search/defines_1.js | 12 +- docs/html/search/enums_0.js | 12 +- docs/html/search/enumvalues_0.js | 78 +- docs/html/search/files_0.js | 2 +- docs/html/search/functions_0.js | 96 +- docs/html/search/pages_0.js | 2 +- docs/html/search/pages_1.js | 6 +- docs/html/search/pages_2.js | 6 +- docs/html/search/pages_3.js | 2 +- docs/html/search/pages_4.js | 2 +- docs/html/search/pages_5.js | 2 +- docs/html/search/pages_6.js | 2 +- docs/html/search/pages_7.js | 4 +- docs/html/search/pages_8.js | 4 +- docs/html/search/pages_9.js | 5 +- docs/html/search/typedefs_0.js | 4 +- docs/html/search/typedefs_1.js | 52 +- docs/html/search/variables_0.js | 13 +- docs/html/search/variables_1.js | 12 +- docs/html/search/variables_2.js | 2 +- docs/html/search/variables_3.js | 6 +- docs/html/search/variables_4.js | 4 +- docs/html/search/variables_5.js | 2 +- docs/html/search/variables_6.js | 26 +- docs/html/search/variables_7.js | 2 +- docs/html/search/variables_8.js | 37 +- docs/html/search/variables_9.js | 2 +- docs/html/search/variables_a.js | 2 +- docs/html/search/variables_b.js | 2 +- docs/html/search/variables_c.js | 16 +- docs/html/search/variables_d.js | 36 +- docs/html/struct__-members.html | 86 + docs/html/struct__.html | 232 + .../html/struct_vma_defragmentation_info.html | 2 +- ...vma_defragmentation_pass_info-members.html | 81 + .../struct_vma_defragmentation_pass_info.html | 127 + ...efragmentation_pass_move_info-members.html | 82 + ...ct_vma_defragmentation_pass_move_info.html | 137 + docs/html/vk__mem__alloc_8h.html | 132 +- docs/html/vk__mem__alloc_8h_source.html | 29780 ++++++++-------- docs/html/vk_amd_device_coherent_memory.html | 98 + docs/html/vk_khr_dedicated_allocation.html | 6 +- src/vk_mem_alloc.h | 60 +- 85 files changed, 17011 insertions(+), 15235 deletions(-) create mode 100644 docs/html/search/all_12.html create mode 100644 docs/html/search/all_12.js create mode 100644 docs/html/search/classes_1.html create mode 100644 docs/html/search/classes_1.js create mode 100644 docs/html/struct__-members.html create mode 100644 docs/html/struct__.html create mode 100644 docs/html/struct_vma_defragmentation_pass_info-members.html create mode 100644 docs/html/struct_vma_defragmentation_pass_info.html create mode 100644 docs/html/struct_vma_defragmentation_pass_move_info-members.html create mode 100644 docs/html/struct_vma_defragmentation_pass_move_info.html create mode 100644 docs/html/vk_amd_device_coherent_memory.html diff --git a/docs/html/allocation_annotation.html b/docs/html/allocation_annotation.html index 9c0cca1..c4f42ab 100644 --- a/docs/html/allocation_annotation.html +++ b/docs/html/allocation_annotation.html @@ -112,18 +112,18 @@ Allocation names
Note
Passing string name to VMA allocation doesn't automatically set it to the Vulkan buffer or image created with it. You must do it manually using an extension like VK_EXT_debug_utils, which is independent of this library.
-
Definition: vk_mem_alloc.h:2388
-
void * pUserData
Custom general-purpose pointer that will be stored in VmaAllocation, can be read as VmaAllocationInfo...
Definition: vk_mem_alloc.h:2482
+
Definition: vk_mem_alloc.h:2464
+
void * pUserData
Custom general-purpose pointer that will be stored in VmaAllocation, can be read as VmaAllocationInfo...
Definition: vk_mem_alloc.h:2558
void vmaGetAllocationInfo(VmaAllocator allocator, VmaAllocation allocation, VmaAllocationInfo *pAllocationInfo)
Returns current information about specified allocation and atomically marks it as used in current fra...
Represents single memory allocation.
-
Definition: vk_mem_alloc.h:2285
+
Definition: vk_mem_alloc.h:2361
VkResult vmaCreateImage(VmaAllocator allocator, const VkImageCreateInfo *pImageCreateInfo, const VmaAllocationCreateInfo *pAllocationCreateInfo, VkImage *pImage, VmaAllocation *pAllocation, VmaAllocationInfo *pAllocationInfo)
Function similar to vmaCreateBuffer().
-
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:2451
-
void * pUserData
Custom general-purpose pointer that was passed as VmaAllocationCreateInfo::pUserData or set using vma...
Definition: vk_mem_alloc.h:2818
+
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:2527
+
void * pUserData
Custom general-purpose pointer that was passed as VmaAllocationCreateInfo::pUserData or set using vma...
Definition: vk_mem_alloc.h:2894
VkResult vmaCreateBuffer(VmaAllocator allocator, const VkBufferCreateInfo *pBufferCreateInfo, const VmaAllocationCreateInfo *pAllocationCreateInfo, VkBuffer *pBuffer, VmaAllocation *pAllocation, VmaAllocationInfo *pAllocationInfo)
-
VmaAllocationCreateFlags flags
Use VmaAllocationCreateFlagBits enum.
Definition: vk_mem_alloc.h:2445
-
Definition: vk_mem_alloc.h:2442
-
Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo().
Definition: vk_mem_alloc.h:2780
+
VmaAllocationCreateFlags flags
Use VmaAllocationCreateFlagBits enum.
Definition: vk_mem_alloc.h:2521
+
Definition: vk_mem_alloc.h:2518
+
Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo().
Definition: vk_mem_alloc.h:2856