diff --git a/docs/html/general_considerations.html b/docs/html/general_considerations.html index b1ef2be..da746e1 100644 --- a/docs/html/general_considerations.html +++ b/docs/html/general_considerations.html @@ -73,9 +73,10 @@ $(function() { Thread safety

Validation layer warnings

diff --git a/docs/html/index.html b/docs/html/index.html index e7681ce..d453eb4 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -65,7 +65,7 @@ $(function() {
Vulkan Memory Allocator
-

Version 3.0.0-development (2021-06-21)

+

Version 3.0.0-development

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

Documentation of all members: vk_mem_alloc.h

diff --git a/docs/html/struct_vma_virtual_block.html b/docs/html/struct_vma_virtual_block.html index b7bf83a..043c20c 100644 --- a/docs/html/struct_vma_virtual_block.html +++ b/docs/html/struct_vma_virtual_block.html @@ -72,7 +72,8 @@ $(function() {

#include <vk_mem_alloc.h>

Detailed Description

Handle to a virtual block object that allows to use core allocation algorithm without allocating any real GPU memory.

-

Fill in VmaVirtualBlockCreateInfo structure and Use vmaCreateVirtualBlock() to create it. Use vmaDestroyVirtualBlock() to destroy it. For more information, see documentation chapter Virtual allocator.

+

Fill in VmaVirtualBlockCreateInfo structure and use vmaCreateVirtualBlock() to create it. Use vmaDestroyVirtualBlock() to destroy it. For more information, see documentation chapter Virtual allocator.

+

This object is not thread-safe - should not be used from multiple threads simultaneously, must be synchronized externally.


The documentation for this struct was generated from the following file: diff --git a/include/vk_mem_alloc.h b/include/vk_mem_alloc.h index 68f3667..8678532 100644 --- a/include/vk_mem_alloc.h +++ b/include/vk_mem_alloc.h @@ -25,7 +25,7 @@ /** \mainpage Vulkan Memory Allocator -Version 3.0.0-development (2021-06-21) +Version 3.0.0-development Copyright (c) 2017-2021 Advanced Micro Devices, Inc. All rights reserved. \n License: MIT @@ -2297,8 +2297,10 @@ typedef struct VmaVirtualAllocationInfo /** \struct VmaVirtualBlock \brief Handle to a virtual block object that allows to use core allocation algorithm without allocating any real GPU memory. -Fill in #VmaVirtualBlockCreateInfo structure and Use vmaCreateVirtualBlock() to create it. Use vmaDestroyVirtualBlock() to destroy it. +Fill in #VmaVirtualBlockCreateInfo structure and use vmaCreateVirtualBlock() to create it. Use vmaDestroyVirtualBlock() to destroy it. For more information, see documentation chapter \ref virtual_allocator. + +This object is not thread-safe - should not be used from multiple threads simultaneously, must be synchronized externally. */ VK_DEFINE_HANDLE(VmaVirtualBlock); @@ -20620,6 +20622,7 @@ accompanying this library. - By default, all calls to functions that take #VmaAllocator as first parameter are safe to call from multiple threads simultaneously because they are synchronized internally when needed. + This includes allocation and deallocation from default memory pool, as well as custom #VmaPool. - When the allocator is created with #VMA_ALLOCATOR_CREATE_EXTERNALLY_SYNCHRONIZED_BIT flag, calls to functions that take such #VmaAllocator object must be synchronized externally. @@ -20627,6 +20630,7 @@ accompanying this library. you must not call vmaGetAllocationInfo() and vmaMapMemory() from different threads at the same time if you pass the same #VmaAllocation object to these functions. +- #VmaVirtualBlock is also not safe to be used from multiple threads simultaneously. \section general_considerations_validation_layer_warnings Validation layer warnings