From cd7bc20429a0c5e19453d5c37bd27c6c9e9025c8 Mon Sep 17 00:00:00 2001 From: Adam Sawicki Date: Mon, 2 Dec 2019 13:42:25 +0100 Subject: [PATCH] Clarify documentation in regards to cache flush/invalidate in few places See #91, thanks @ROTARTSI82 ! --- docs/html/allocation_annotation.html | 16 +- docs/html/choosing_memory_type.html | 16 +- docs/html/custom_memory_pools.html | 16 +- docs/html/defragmentation.html | 20 +- docs/html/index.html | 2 +- docs/html/lost_allocations.html | 12 +- docs/html/memory_mapping.html | 28 +- docs/html/quick_start.html | 12 +- docs/html/vk__mem__alloc_8h.html | 10 +- docs/html/vk__mem__alloc_8h_source.html | 29208 +++++++++---------- docs/html/vk_khr_dedicated_allocation.html | 4 +- src/vk_mem_alloc.h | 23 +- 12 files changed, 14691 insertions(+), 14676 deletions(-) diff --git a/docs/html/allocation_annotation.html b/docs/html/allocation_annotation.html index 2a6736c..2b3e561 100644 --- a/docs/html/allocation_annotation.html +++ b/docs/html/allocation_annotation.html @@ -111,18 +111,18 @@ Allocation names

That string is also printed in JSON report created by vmaBuildStatsString().

-
Definition: vk_mem_alloc.h:2384
-
void * pUserData
Custom general-purpose pointer that will be stored in VmaAllocation, can be read as VmaAllocationInfo...
Definition: vk_mem_alloc.h:2478
+
Definition: vk_mem_alloc.h:2385
+
void * pUserData
Custom general-purpose pointer that will be stored in VmaAllocation, can be read as VmaAllocationInfo...
Definition: vk_mem_alloc.h:2479
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:2281
+
Definition: vk_mem_alloc.h:2282
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:2447
-
void * pUserData
Custom general-purpose pointer that was passed as VmaAllocationCreateInfo::pUserData or set using vma...
Definition: vk_mem_alloc.h:2814
+
VmaMemoryUsage usage
Intended usage of memory.
Definition: vk_mem_alloc.h:2448
+
void * pUserData
Custom general-purpose pointer that was passed as VmaAllocationCreateInfo::pUserData or set using vma...
Definition: vk_mem_alloc.h:2815
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:2441
-
Definition: vk_mem_alloc.h:2438
-
Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo().
Definition: vk_mem_alloc.h:2776
+
VmaAllocationCreateFlags flags
Use VmaAllocationCreateFlagBits enum.
Definition: vk_mem_alloc.h:2442
+
Definition: vk_mem_alloc.h:2439
+
Parameters of VmaAllocation objects, that can be retrieved using function vmaGetAllocationInfo().
Definition: vk_mem_alloc.h:2777