diff --git a/docs/html/general_considerations.html b/docs/html/general_considerations.html new file mode 100644 index 0000000..2353a62 --- /dev/null +++ b/docs/html/general_considerations.html @@ -0,0 +1,104 @@ + + + + + + + +Vulkan Memory Allocator: General considerations + + + + + + + + + +
+
+ + + + + + +
+
Vulkan Memory Allocator +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
General considerations
+
+
+

+Thread safety

+ +

+Allocation algorithm

+

The library uses following algorithm for allocation, in order:

+
    +
  1. Try to find free range of memory in existing blocks.
  2. +
  3. If failed, try to create a new block of VkDeviceMemory, with preferred block size.
  4. +
  5. If failed, try to create such block with size/2, size/4, size/8.
  6. +
  7. If failed and VMA_ALLOCATION_CREATE_CAN_MAKE_OTHER_LOST_BIT flag was specified, try to find space in existing blocks, possilby making some other allocations lost.
  8. +
  9. If failed, try to allocate separate VkDeviceMemory for this allocation, just like when you use VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT.
  10. +
  11. If failed, choose other memory type that meets the requirements specified in VmaAllocationCreateInfo and go to point 1.
  12. +
  13. If failed, return VK_ERROR_OUT_OF_DEVICE_MEMORY.
  14. +
+

+Features not supported

+

Features deliberately excluded from the scope of this library:

+ +
+ + + + diff --git a/docs/html/index.html b/docs/html/index.html index fc99c02..80749f3 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -66,29 +66,63 @@ $(function() {

Copyright (c) 2017-2018 Advanced Micro Devices, Inc. All rights reserved.
License: MIT

Documentation of all members: vk_mem_alloc.h

-

Table of contents:

+

+Table of contents