diff --git a/docs/html/allocation_annotation.html b/docs/html/allocation_annotation.html index 971a8c8..0d3a44b 100644 --- a/docs/html/allocation_annotation.html +++ b/docs/html/allocation_annotation.html @@ -116,18 +116,18 @@ Allocation names
pool
is not null, this member is ignored.
Set to 0 if no additional flags are preferred.
If pool
is not null, this member is ignored.
float VmaAllocationCreateInfo::priority | +
A floating-point value between 0 and 1, indicating the priority of the allocation relative to other memory allocations.
+It is used only when VMA_ALLOCATOR_CREATE_EXT_MEMORY_PRIORITY_BIT flag was used during creation of the VmaAllocator object and this allocation ends up as dedicated or is explicitly forced as dedicated using VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT. Otherwise, it has the priority of a memory block where it is placed and this variable is ignored.
+Describes parameter of created VmaPool.
@@ -200,6 +203,23 @@ Public AttributesMinimum number of blocks to be always allocated in this pool, even if they stay empty.
Set to 0 to have no preallocated blocks and allow the pool be completely empty.
+float VmaPoolCreateInfo::priority | +
A floating-point value between 0 and 1, indicating the priority of the allocations in this pool relative to other memory allocations.
+It is used only when VMA_ALLOCATOR_CREATE_EXT_MEMORY_PRIORITY_BIT flag was used during creation of the VmaAllocator object. Otherwise, this variable is ignored.
+#define VMA_MEMORY_PRIORITY 0 | +
When this flag is set, you can create buffers with VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT
using VMA. The library automatically adds VK_MEMORY_ALLOCATE_DEVICE_ADDRESS_BIT
to allocated memory blocks wherever it might be needed.
For more information, see documentation chapter Enabling buffer device address.
+Enables usage of VK_EXT_memory_priority extension in the library.
+You may set this flag only if you found available and enabled this device extension, along with VkPhysicalDeviceMemoryPriorityFeaturesEXT::memoryPriority == VK_TRUE
, while creating Vulkan device passed as VmaAllocatorCreateInfo::device.
When this flag is used, VmaAllocationCreateInfo::priority and VmaPoolCreateInfo::priority are used to set priorities of allocated Vulkan memory. Without it, these variables are ignored.
+A priority must be a floating-point value between 0 and 1, indicating the priority of the allocation relative to other memory allocations. Larger values are higher priority. The granularity of the priorities is implementation-dependent. It is automatically passed to every call to vkAllocateMemory
done by the library using structure VkMemoryPriorityAllocateInfoEXT
. The value to be used for default priority is 0.5. For more details, see the documentation of the VK_EXT_memory_priority extension.