Define this macro to 0 to disable usage of DXGI 1.4 (which is used for IDXGIAdapter3 and query for memory budget).
Define this macro to 0 to disable usage of DXGI 1.4 (which is used for IDXGIAdapter3 and query for memory budget).
@@ -395,11 +338,11 @@
-When defined to value other than 0, the library will try to use D3D12_SMALL_RESOURCE_PLACEMENT_ALIGNMENT or D3D12_SMALL_MSAA_RESOURCE_PLACEMENT_ALIGNMENT for created textures when possible, which can save memory because some small textures may get their alignment 4 KB and their size a multiply of 4 KB instead of 64 KB.
+When defined to value other than 0, the library will try to use D3D12_SMALL_RESOURCE_PLACEMENT_ALIGNMENT or D3D12_SMALL_MSAA_RESOURCE_PLACEMENT_ALIGNMENT for created textures when possible, which can save memory because some small textures may get their alignment 4 KB and their size a multiply of 4 KB instead of 64 KB.
-#define D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT 0 - Disables small texture alignment.#define D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT 1 (the default) - Enables conservative algorithm that will use small alignment only for some textures that are surely known to support it.#define D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT 2 - Enables query for small alignment to D3D12 (based on Microsoft sample) which will enable small alignment for more textures, but will also generate D3D Debug Layer error #721 on call to ID3D12Device::GetResourceAllocationInfo, which you should just ignore. - #define D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT 0 - Disables small texture alignment.
+- #define D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT 1 (the default) - Enables conservative algorithm that will use small alignment only for some textures that are surely known to support it.
+- #define D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT 2 - Enables query for small alignment to D3D12 (based on Microsoft sample) which will enable small alignment for more textures, but will also generate D3D Debug Layer error #721 on call to ID3D12Device::GetResourceAllocationInfo, which you should just ignore.
@@ -407,7 +350,7 @@
-Generated by 
1.13.2
+Generated by 1.14.0
diff --git a/docs/html/annotated.html b/docs/html/annotated.html
index 224e416..1566741 100644
--- a/docs/html/annotated.html
+++ b/docs/html/annotated.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class List
-
-
@@ -33,35 +31,24 @@
-
+
-
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12]
- ▼ND3D12MA ND3D12MA CAllocation Represents single memory allocation CALLOCATION_CALLBACKS Custom callbacks to CPU memory allocation functions CALLOCATION_DESC Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource CAllocator Represents main object of this library initialized for particular ID3D12Device CAllocator Represents main object of this library initialized for particular ID3D12Device CALLOCATOR_DESC Parameters of created Allocator object. To be used with CreateAllocator() CBudget Statistics of current memory usage and available budget for a specific memory segment group CCALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_allocation-members.html b/docs/html/class_d3_d12_m_a_1_1_allocation-members.html
index 8052406..288ed6d 100644
--- a/docs/html/class_d3_d12_m_a_1_1_allocation-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -117,7 +104,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_allocation.html b/docs/html/class_d3_d12_m_a_1_1_allocation.html
index 0abdf44..45634b9 100644
--- a/docs/html/class_d3_d12_m_a_1_1_allocation.html
+++ b/docs/html/class_d3_d12_m_a_1_1_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Allocation Class Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,46 +93,36 @@
-
+
Public Member Functions
UINT64 GetOffset () const Returns offset in bytes from the start of memory heap.
UINT64 GetAlignment () const Returns alignment that resource was created with.
UINT64 GetSize () const Returns size in bytes of the allocation.
ID3D12Resource * GetResource () const Returns D3D12 resource associated with this object.
void SetResource (ID3D12Resource *pResource) Releases the resource currently pointed by the allocation (if not null), sets it to new one, incrementing its reference counter (if not null).
ID3D12Heap * GetHeap () const Returns memory heap that the resource is created in.
void SetPrivateData (void *pPrivateData) Changes custom pointer for an allocation to a new value.
void * GetPrivateData () const Get custom pointer associated with the allocation.
void SetName (LPCWSTR Name) Associates a name with the allocation object. This name is for use in debug diagnostics and tools.
LPCWSTR GetName () const Returns the name associated with the allocation object.
-Detailed Description
+Detailed Description
Represents single memory allocation.
It may be either implicit memory heap dedicated to a single resource or a specific region of a bigger heap plus unique offset.
To create such object, fill structure D3D12MA::ALLOCATION_DESC and call function Allocator::CreateResource.
The object remembers size and some other information. To retrieve this information, use methods of this class.
-The object also remembers ID3D12Resource and "owns" a reference to it, so it calls Release() on the resource when destroyed.
-Member Function Documentation
+The object also remembers ID3D12Resource and "owns" a reference to it, so it calls Release() on the resource when destroyed.
+Member Function Documentation
◆ GetAlignment()
@@ -323,9 +300,9 @@ D3D12MA::Allocator::CreateResource, this is the size of the resource returned by ID3D12Device::GetResourceAllocationInfo.
+If you created a buffer or a texture together with the allocation using function D3D12MA::Allocator::CreateResource, this is the size of the resource returned by ID3D12Device::GetResourceAllocationInfo.
For allocations made out of bigger memory blocks, this also is the size of the memory region assigned exclusively to this allocation.
-For resources created as committed, this value may not be accurate. DirectX implementation may optimize memory usage internally so that you may even observe regions of ID3D12Resource::GetGPUVirtualAddress() + Allocation::GetSize() to overlap in memory and still work correctly.
+For resources created as committed, this value may not be accurate. DirectX implementation may optimize memory usage internally so that you may even observe regions of ID3D12Resource::GetGPUVirtualAddress() + Allocation::GetSize() to overlap in memory and still work correctly.
@@ -347,7 +324,7 @@ Name can be null.
@@ -398,7 +375,7 @@ Member Data Documentation
+Member Data Documentation
◆ allocHandle
@@ -531,7 +508,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_allocator-members.html b/docs/html/class_d3_d12_m_a_1_1_allocator-members.html
index 469eb2c..ca74e46 100644
--- a/docs/html/class_d3_d12_m_a_1_1_allocator-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_allocator-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -118,7 +105,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_allocator.html b/docs/html/class_d3_d12_m_a_1_1_allocator.html
index 2817820..08b73a0 100644
--- a/docs/html/class_d3_d12_m_a_1_1_allocator.html
+++ b/docs/html/class_d3_d12_m_a_1_1_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Allocator Class Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -95,7 +82,7 @@
-Represents main object of this library initialized for particular ID3D12Device.
+
Represents main object of this library initialized for particular ID3D12Device.
More...
#include <D3D12MemAlloc.h>
@@ -106,71 +93,52 @@
-
+
Public Member Functions
const D3D12_FEATURE_DATA_D3D12_OPTIONS & GetD3D12Options () const Returns cached options retrieved from D3D12 device.
BOOL IsUMA () const Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::UMA was found to be true.
Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::UMA was found to be true.
BOOL IsCacheCoherentUMA () const Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMA was found to be true.
Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMA was found to be true.
BOOL IsGPUUploadHeapSupported () const Returns true if GPU Upload Heaps are supported on the current system.
UINT64 GetMemoryCapacity (UINT memorySegmentGroup) const Returns total amount of memory of specific segment group, in bytes.
HRESULT CreateResource (const ALLOCATION_DESC *pAllocDesc, const D3D12_RESOURCE_DESC *pResourceDesc, D3D12_RESOURCE_STATES InitialResourceState, const D3D12_CLEAR_VALUE *pOptimizedClearValue, Allocation **ppAllocation, REFIID riidResource, void **ppvResource) Allocates memory and creates a D3D12 resource (buffer or texture). This is the main allocation function.
HRESULT CreateResource2 (const ALLOCATION_DESC *pAllocDesc, const D3D12_RESOURCE_DESC1 *pResourceDesc, D3D12_RESOURCE_STATES InitialResourceState, const D3D12_CLEAR_VALUE *pOptimizedClearValue, Allocation **ppAllocation, REFIID riidResource, void **ppvResource) Similar to Allocator::CreateResource, but supports new structure D3D12_RESOURCE_DESC1.
Similar to Allocator::CreateResource, but supports new structure D3D12_RESOURCE_DESC1.
HRESULT CreateResource3 (const ALLOCATION_DESC *pAllocDesc, const D3D12_RESOURCE_DESC1 *pResourceDesc, D3D12_BARRIER_LAYOUT InitialLayout, const D3D12_CLEAR_VALUE *pOptimizedClearValue, UINT32 NumCastableFormats, const DXGI_FORMAT *pCastableFormats, Allocation **ppAllocation, REFIID riidResource, void **ppvResource) Similar to Allocator::CreateResource2, but there are initial layout instead of state and castable formats list.
HRESULT AllocateMemory (const ALLOCATION_DESC *pAllocDesc, const D3D12_RESOURCE_ALLOCATION_INFO *pAllocInfo, Allocation **ppAllocation) Allocates memory without creating any resource placed in it.
HRESULT CreateAliasingResource (Allocation *pAllocation, UINT64 AllocationLocalOffset, const D3D12_RESOURCE_DESC *pResourceDesc, D3D12_RESOURCE_STATES InitialResourceState, const D3D12_CLEAR_VALUE *pOptimizedClearValue, REFIID riidResource, void **ppvResource) Creates a new resource in place of an existing allocation. This is useful for memory aliasing.
HRESULT CreateAliasingResource1 (Allocation *pAllocation, UINT64 AllocationLocalOffset, const D3D12_RESOURCE_DESC1 *pResourceDesc, D3D12_RESOURCE_STATES InitialResourceState, const D3D12_CLEAR_VALUE *pOptimizedClearValue, REFIID riidResource, void **ppvResource) Similar to Allocator::CreateAliasingResource, but supports new structure D3D12_RESOURCE_DESC1.
Similar to Allocator::CreateAliasingResource, but supports new structure D3D12_RESOURCE_DESC1.
HRESULT CreateAliasingResource2 (Allocation *pAllocation, UINT64 AllocationLocalOffset, const D3D12_RESOURCE_DESC1 *pResourceDesc, D3D12_BARRIER_LAYOUT InitialLayout, const D3D12_CLEAR_VALUE *pOptimizedClearValue, UINT32 NumCastableFormats, const DXGI_FORMAT *pCastableFormats, REFIID riidResource, void **ppvResource) Similar to Allocator::CreateAliasingResource1, but there are initial layout instead of state and castable formats list.
HRESULT CreatePool (const POOL_DESC *pPoolDesc, Pool **ppPool) Creates custom pool.
void SetCurrentFrameIndex (UINT frameIndex) Sets the index of the current frame.
void GetBudget (Budget *pLocalBudget, Budget *pNonLocalBudget) Retrieves information about current memory usage and budget.
void CalculateStatistics (TotalStatistics *pStats) Retrieves statistics from current state of the allocator.
void BuildStatsString (WCHAR **ppStatsString, BOOL DetailedMap) const Builds and returns statistics as a string in JSON format.
void FreeStatsString (WCHAR *pStatsString) const Frees memory of a string returned from Allocator::BuildStatsString.
void BeginDefragmentation (const DEFRAGMENTATION_DESC *pDesc, DefragmentationContext **ppContext) Begins defragmentation process of the default pools.
-Detailed Description
-Represents main object of this library initialized for particular ID3D12Device.
-Fill structure D3D12MA::ALLOCATOR_DESC and call function CreateAllocator() to create it. Call method Release() to destroy it.
-It is recommended to create just one object of this type per ID3D12Device object, right after Direct3D 12 is initialized and keep it alive until before Direct3D device is destroyed.
-Member Function Documentation
+Detailed Description
+Represents main object of this library initialized for particular ID3D12Device.
+Fill structure D3D12MA::ALLOCATOR_DESC and call function CreateAllocator() to create it. Call method Release() to destroy it.
+It is recommended to create just one object of this type per ID3D12Device object, right after Direct3D 12 is initialized and keep it alive until before Direct3D device is destroyed.
+Member Function Documentation
◆ AllocateMemory()
@@ -196,9 +164,9 @@
Allocates memory without creating any resource placed in it.
-This function is similar to ID3D12Device::CreateHeap, but it may really assign part of a larger, existing heap to the allocation.
-pAllocDesc->heapFlags should contain one of these values, depending on type of resources you are going to create in this memory: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if you validate that ResourceHeapTier = 2 - then heapFlags may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0. Additional flags in heapFlags are allowed as well.
-pAllocInfo->SizeInBytes must be multiply of 64KB. pAllocInfo->Alignment must be one of the legal values as described in documentation of D3D12_HEAP_DESC.
+This function is similar to ID3D12Device::CreateHeap, but it may really assign part of a larger, existing heap to the allocation.
+pAllocDesc->heapFlags should contain one of these values, depending on type of resources you are going to create in this memory: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if you validate that ResourceHeapTier = 2 - then heapFlags may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0. Additional flags in heapFlags are allowed as well.
+pAllocInfo->SizeInBytes must be multiply of 64KB. pAllocInfo->Alignment must be one of the legal values as described in documentation of D3D12_HEAP_DESC.
If you use D3D12MA::ALLOCATION_FLAG_COMMITTED you will get a separate memory block - a heap that always has offset 0.
@@ -257,7 +225,7 @@ Parameters
[out] ppStatsString Must be freed using Allocator::FreeStatsString. DetailedMap TRUE to include full list of allocations (can make the string quite long), FALSE to only return statistics. DetailedMap TRUE to include full list of allocations (can make the string quite long), FALSE to only return statistics.
@@ -332,17 +300,17 @@ Parameters
- pAllocation Existing allocation indicating the memory where the new resource should be created. It can be created using D3D12MA::Allocator::CreateResource and already have a resource bound to it, or can be a raw memory allocated with D3D12MA::Allocator::AllocateMemory. It must not be created as committed so that ID3D12Heap is available and not implicit. AllocationLocalOffset Additional offset in bytes to be applied when allocating the resource. Local from the start of pAllocation, not the beginning of the whole ID3D12Heap! If the new resource should start from the beginning of the pAllocation it should be 0. pAllocation Existing allocation indicating the memory where the new resource should be created. It can be created using D3D12MA::Allocator::CreateResource and already have a resource bound to it, or can be a raw memory allocated with D3D12MA::Allocator::AllocateMemory. It must not be created as committed so that ID3D12Heap is available and not implicit. AllocationLocalOffset Additional offset in bytes to be applied when allocating the resource. Local from the start of pAllocation, not the beginning of the whole ID3D12Heap! If the new resource should start from the beginning of the pAllocation it should be 0. pResourceDesc Description of the new resource to be created. InitialResourceState pOptimizedClearValue riidResource [out] ppvResource Returns pointer to the new resource. The resource is not bound with pAllocation. This pointer must not be null - you must get the resource pointer and Release it when no longer needed. [out] ppvResource Returns pointer to the new resource. The resource is not bound with pAllocation. This pointer must not be null - you must get the resource pointer and Release it when no longer needed.
-Memory requirements of the new resource are checked for validation. If its size exceeds the end of pAllocation or required alignment is not fulfilled considering pAllocation->GetOffset() + AllocationLocalOffset, the function returns E_INVALIDARG.
+Memory requirements of the new resource are checked for validation. If its size exceeds the end of pAllocation or required alignment is not fulfilled considering pAllocation->GetOffset() + AllocationLocalOffset, the function returns E_INVALIDARG.
@@ -390,9 +358,9 @@
-Similar to Allocator::CreateAliasingResource, but supports new structure D3D12_RESOURCE_DESC1.
-It internally uses ID3D12Device8::CreatePlacedResource1.
-To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
+Similar to Allocator::CreateAliasingResource, but supports new structure D3D12_RESOURCE_DESC1.
+It internally uses ID3D12Device8::CreatePlacedResource1.
+To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
@@ -451,8 +419,8 @@
Similar to Allocator::CreateAliasingResource1, but there are initial layout instead of state and castable formats list.
-It internally uses ID3D12Device10::CreatePlacedResource2.
-To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
+It internally uses ID3D12Device10::CreatePlacedResource2.
+To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
@@ -524,9 +492,9 @@
Allocates memory and creates a D3D12 resource (buffer or texture). This is the main allocation function.
-The function is similar to ID3D12Device::CreateCommittedResource, but it may really call ID3D12Device::CreatePlacedResource to assign part of a larger, existing memory heap to the new resource, which is the main purpose of this whole library.
-If ppvResource is null, you receive only ppAllocation object from this function. It holds pointer to ID3D12Resource that can be queried using function D3D12MA::Allocation::GetResource(). Reference count of the resource object is 1. It is automatically destroyed when you destroy the allocation object.
-If ppvResource is not null, you receive pointer to the resource next to allocation object. Reference count of the resource object is then increased by calling QueryInterface, so you need to manually Release it along with the allocation.
+The function is similar to ID3D12Device::CreateCommittedResource, but it may really call ID3D12Device::CreatePlacedResource to assign part of a larger, existing memory heap to the new resource, which is the main purpose of this whole library.
+If ppvResource is null, you receive only ppAllocation object from this function. It holds pointer to ID3D12Resource that can be queried using function D3D12MA::Allocation::GetResource(). Reference count of the resource object is 1. It is automatically destroyed when you destroy the allocation object.
+If ppvResource is not null, you receive pointer to the resource next to allocation object. Reference count of the resource object is then increased by calling QueryInterface, so you need to manually Release it along with the allocation.
- Parameters
-
@@ -587,9 +555,9 @@
-Similar to Allocator::CreateResource, but supports new structure D3D12_RESOURCE_DESC1.
-It internally uses ID3D12Device8::CreateCommittedResource2 or ID3D12Device8::CreatePlacedResource1.
-To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
+Similar to Allocator::CreateResource, but supports new structure D3D12_RESOURCE_DESC1.
+It internally uses ID3D12Device8::CreateCommittedResource2 or ID3D12Device8::CreatePlacedResource1.
+To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
@@ -648,8 +616,8 @@
Similar to Allocator::CreateResource2, but there are initial layout instead of state and castable formats list.
-It internally uses ID3D12Device10::CreateCommittedResource3 or ID3D12Device10::CreatePlacedResource2.
-To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
+It internally uses ID3D12Device10::CreateCommittedResource3 or ID3D12Device10::CreatePlacedResource2.
+To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
@@ -700,14 +668,14 @@ IsUMA() == FALSE (discrete graphics card):
-pLocalBudget returns the budget of the video memory.pNonLocalBudget returns the budget of the system memory available for D3D12 resources.- When IsUMA() == FALSE (discrete graphics card):
+- pLocalBudget returns the budget of the video memory.
+- pNonLocalBudget returns the budget of the system memory available for D3D12 resources.
-- When IsUMA()
== TRUE (integrated graphics chip):
-pLocalBudget returns the budget of the shared memory available for all D3D12 resources. All memory is considered "local".pNonLocalBudget is not applicable and returns zeros.- When IsUMA() == TRUE (integrated graphics chip):
+- pLocalBudget returns the budget of the shared memory available for all D3D12 resources. All memory is considered "local".
+- pNonLocalBudget is not applicable and returns zeros.
@@ -753,20 +721,20 @@ - Parameters
-
- memorySegmentGroup use DXGI_MEMORY_SEGMENT_GROUP_LOCAL or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL. memorySegmentGroup use DXGI_MEMORY_SEGMENT_GROUP_LOCAL or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL.
-This information is taken from DXGI_ADAPTER_DESC. It is not recommended to use this number. You should preferably call GetBudget() and limit memory usage to D3D12MA::Budget::BudgetBytes instead.
+This information is taken from DXGI_ADAPTER_DESC. It is not recommended to use this number. You should preferably call GetBudget() and limit memory usage to D3D12MA::Budget::BudgetBytes instead.
-- When IsUMA()
== FALSE (discrete graphics card):
-GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the video memory.GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) returns the size of the system memory available for D3D12 resources.- When IsUMA() == FALSE (discrete graphics card):
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the video memory.
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) returns the size of the system memory available for D3D12 resources.
-- When IsUMA()
== TRUE (integrated graphics chip):
-GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the shared memory available for all D3D12 resources. All memory is considered "local".GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) is not applicable and returns 0. - When IsUMA() == TRUE (integrated graphics chip):
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the shared memory available for all D3D12 resources. All memory is considered "local".
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) is not applicable and returns 0.
@@ -788,7 +756,7 @@
-Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMA was found to be true.
+Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMA was found to be true.
For more information about how to use it, see articles in Microsoft Docs articles:
- "UMA Optimizations: CPU Accessible Textures and Standard Swizzle"
@@ -814,8 +782,8 @@
Returns true if GPU Upload Heaps are supported on the current system.
-When true, you can use D3D12_HEAP_TYPE_GPU_UPLOAD.
-This flag is fetched from D3D12_FEATURE_D3D12_OPTIONS16::GPUUploadHeapSupported.
+When true, you can use D3D12_HEAP_TYPE_GPU_UPLOAD.
+This flag is fetched from D3D12_FEATURE_D3D12_OPTIONS16::GPUUploadHeapSupported.
@@ -834,7 +802,7 @@
-Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::UMA was found to be true.
+Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::UMA was found to be true.
For more information about how to use it, see articles in Microsoft Docs articles:
- "UMA Optimizations: CPU Accessible Textures and Standard Swizzle"
@@ -870,7 +838,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html
index 4049a20..6cfb1dd 100644
--- a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html
index 405cb9f..7ab0038 100644
--- a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html
+++ b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DefragmentationContext Class Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,22 +93,19 @@
-
+
Public Member Functions
HRESULT BeginPass (DEFRAGMENTATION_PASS_MOVE_INFO *pPassInfo) Starts single defragmentation pass.
HRESULT EndPass (DEFRAGMENTATION_PASS_MOVE_INFO *pPassInfo) Ends single defragmentation pass.
void GetStats (DEFRAGMENTATION_STATS *pStats) Returns statistics of the defragmentation performed so far.
-Detailed Description
+Detailed Description
Represents defragmentation process in progress.
You can create this object using Allocator::BeginDefragmentation (for default pools) or Pool::BeginDefragmentation (for a custom pool).
-Member Function Documentation
+Member Function Documentation
◆ BeginPass()
@@ -145,8 +129,8 @@ - Returns
-S_OK if no more moves are possible. Then you can omit call to DefragmentationContext::EndPass() and simply end whole defragmentation.S_FALSE if there are pending moves returned in pPassInfo. You need to perform them, call DefragmentationContext::EndPass(), and then preferably try another pass with DefragmentationContext::BeginPass(). - S_OK if no more moves are possible. Then you can omit call to DefragmentationContext::EndPass() and simply end whole defragmentation.
+- S_FALSE if there are pending moves returned in pPassInfo. You need to perform them, call DefragmentationContext::EndPass(), and then preferably try another pass with DefragmentationContext::BeginPass().
- Returns
- Returns
S_OK if no more moves are possible or S_FALSE if more defragmentations are possible.
-Ends incremental defragmentation pass and commits all defragmentation moves from pPassInfo. After this call:
+- Returns
- Returns S_OK if no more moves are possible or S_FALSE if more defragmentations are possible.
+Ends incremental defragmentation pass and commits all defragmentation moves from pPassInfo. After this call:
-- Allocation at
pPassInfo[i].pSrcAllocation that had pPassInfo[i].Operation == DEFRAGMENTATION_MOVE_OPERATION_COPY (which is the default) will be pointing to the new destination place.
-- Allocation at
pPassInfo[i].pSrcAllocation that had pPassInfo[i].operation == DEFRAGMENTATION_MOVE_OPERATION_DESTROY will be released.
+- Allocation at pPassInfo[i].pSrcAllocation that had pPassInfo[i].Operation == DEFRAGMENTATION_MOVE_OPERATION_COPY (which is the default) will be pointing to the new destination place.
+- Allocation at pPassInfo[i].pSrcAllocation that had pPassInfo[i].operation == DEFRAGMENTATION_MOVE_OPERATION_DESTROY will be released.
If no more moves are possible you can end whole defragmentation.
@@ -209,7 +193,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_pool-members.html b/docs/html/class_d3_d12_m_a_1_1_pool-members.html
index e500fb5..9acf601 100644
--- a/docs/html/class_d3_d12_m_a_1_1_pool-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_pool-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -104,7 +91,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_pool.html b/docs/html/class_d3_d12_m_a_1_1_pool.html
index 7aabe1c..07742d9 100644
--- a/docs/html/class_d3_d12_m_a_1_1_pool.html
+++ b/docs/html/class_d3_d12_m_a_1_1_pool.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Pool Class Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,32 +93,26 @@
-
+
Public Member Functions
POOL_DESC GetDesc () const Returns copy of parameters of the pool.
void GetStatistics (Statistics *pStats) Retrieves basic statistics of the custom pool that are fast to calculate.
void CalculateStatistics (DetailedStatistics *pStats) Retrieves detailed statistics of the custom pool that are slower to calculate.
void SetName (LPCWSTR Name) Associates a name with the pool. This name is for use in debug diagnostics and tools.
LPCWSTR GetName () const Returns the name associated with the pool object.
HRESULT BeginDefragmentation (const DEFRAGMENTATION_DESC *pDesc, DefragmentationContext **ppContext) Begins defragmentation process of the current pool.
-Detailed Description
+Detailed Description
Custom memory pool.
Represents a separate set of heaps (memory blocks) that can be used to create D3D12MA::Allocation-s and resources in it. Usually there is no need to create custom pools - creating resources in default pool is sufficient.
To create custom pool, fill D3D12MA::POOL_DESC and call D3D12MA::Allocator::CreatePool.
-Member Function Documentation
+Member Function Documentation
◆ BeginDefragmentation()
@@ -160,8 +141,8 @@ - Returns
-S_OK if defragmentation can begin.E_NOINTERFACE if defragmentation is not supported.- S_OK if defragmentation can begin.
+- E_NOINTERFACE if defragmentation is not supported.
For more information about defragmentation, see documentation chapter: Defragmentation.
@@ -276,7 +257,7 @@ Name can be NULL.
@@ -286,7 +267,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html b/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html
index 190326b..1e40ead 100644
--- a/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -109,7 +96,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_virtual_block.html b/docs/html/class_d3_d12_m_a_1_1_virtual_block.html
index 5f6a3f2..0cb9114 100644
--- a/docs/html/class_d3_d12_m_a_1_1_virtual_block.html
+++ b/docs/html/class_d3_d12_m_a_1_1_virtual_block.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualBlock Class Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,45 +93,35 @@
-
+
Public Member Functions
BOOL IsEmpty () const Returns true if the block is empty - contains 0 allocations.
void GetAllocationInfo (VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) const Returns information about an allocation - its offset, size and custom pointer.
HRESULT Allocate (const VIRTUAL_ALLOCATION_DESC *pDesc, VirtualAllocation *pAllocation, UINT64 *pOffset) Creates new allocation.
void FreeAllocation (VirtualAllocation allocation) Frees the allocation.
void Clear () Frees all the allocations.
void SetAllocationPrivateData (VirtualAllocation allocation, void *pPrivateData) Changes custom pointer for an allocation to a new value.
void GetStatistics (Statistics *pStats) const Retrieves basic statistics of the virtual block that are fast to calculate.
void CalculateStatistics (DetailedStatistics *pStats) const Retrieves detailed statistics of the virtual block that are slower to calculate.
void BuildStatsString (WCHAR **ppStatsString) const Builds and returns statistics as a string in JSON format, including the list of allocations with their parameters.
void FreeStatsString (WCHAR *pStatsString) const Frees memory of a string returned from VirtualBlock::BuildStatsString.
-Detailed Description
+Detailed Description
Represents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory.
This class allows to use the core algorithm of the library custom allocations e.g. CPU memory or sub-allocation regions inside a single GPU buffer.
-To create this object, fill in D3D12MA::VIRTUAL_BLOCK_DESC and call CreateVirtualBlock(). To destroy it, call its method VirtualBlock::Release(). You need to free all the allocations within this block or call Clear() before destroying it.
+To create this object, fill in D3D12MA::VIRTUAL_BLOCK_DESC and call CreateVirtualBlock(). To destroy it, call its method VirtualBlock::Release(). You need to free all the allocations within this block or call Clear() before destroying it.
This object is not thread-safe - should not be used from multiple threads simultaneously, must be synchronized externally.
-Member Function Documentation
+Member Function Documentation
◆ Allocate()
@@ -178,8 +155,8 @@ - Returns
S_OK if allocation succeeded, E_OUTOFMEMORY if it failed.If the allocation failed, pAllocation->AllocHandle is set to 0 and pOffset, if not null, is set to UINT64_MAX.
+- Returns
- S_OK if allocation succeeded, E_OUTOFMEMORY if it failed.
+If the allocation failed, pAllocation->AllocHandle is set to 0 and pOffset, if not null, is set to UINT64_MAX.
@@ -268,7 +245,7 @@
Frees the allocation.
-Calling this function with allocation.AllocHandle == 0 is correct and does nothing.
+Calling this function with allocation.AllocHandle == 0 is correct and does nothing.
@@ -387,7 +364,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/classes.html b/docs/html/classes.html
index 3b8ddf2..e85eb86 100644
--- a/docs/html/classes.html
+++ b/docs/html/classes.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Index
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/configuration.html b/docs/html/configuration.html
index 8eeaa50..65d7bdd 100644
--- a/docs/html/configuration.html
+++ b/docs/html/configuration.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Configuration
-
-
@@ -33,33 +31,22 @@
-
+
-
- Configuration
+ Configuration
-Please check file D3D12MemAlloc.cpp lines between "Configuration Begin" and "Configuration End" to find macros that you can define to change the behavior of the library, primarily for debugging purposes.
-
+Please check file D3D12MemAlloc.cpp lines between "Configuration Begin" and "Configuration End" to find macros that you can define to change the behavior of the library, primarily for debugging purposes.
+
Custom CPU memory allocator
-If you use custom allocator for CPU memory rather than default C++ operator new and delete or malloc and free functions, you can make this library using your allocator as well by filling structure D3D12MA::ALLOCATION_CALLBACKS and passing it as optional member D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks. Functions pointed there will be used by the library to make any CPU-side allocations. Example:
+If you use custom allocator for CPU memory rather than default C++ operator new and delete or malloc and free functions, you can make this library using your allocator as well by filling structure D3D12MA::ALLOCATION_CALLBACKS and passing it as optional member D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks. Functions pointed there will be used by the library to make any CPU-side allocations. Example:
#include <malloc.h>
void* CustomAllocate(size_t Size, size_t Alignment, void* pPrivateData)
@@ -133,11 +120,11 @@
ALLOCATOR_FLAGS FlagsFlags for the entire allocator.Definition D3D12MemAlloc.h:1126
-
+
Debug margins
-
By default, allocations are laid out in memory blocks next to each other if possible (considering required alignment returned by ID3D12Device::GetResourceAllocationInfo).
+By default, allocations are laid out in memory blocks next to each other if possible (considering required alignment returned by ID3D12Device::GetResourceAllocationInfo).
-Define macro D3D12MA_DEBUG_MARGIN to some non-zero value (e.g. 16) inside "D3D12MemAlloc.cpp" to enforce specified number of bytes as a margin after every allocation.
+Define macro D3D12MA_DEBUG_MARGIN to some non-zero value (e.g. 16) inside "D3D12MemAlloc.cpp" to enforce specified number of bytes as a margin after every allocation.
If your bug goes away after enabling margins, it means it may be caused by memory being overwritten outside of allocation boundaries. It is not 100% certain though. Change in application behavior may also be caused by different order and distribution of allocations across memory blocks after margins are applied.
Margins work with all memory heap types.
@@ -149,7 +136,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/custom_pools.html b/docs/html/custom_pools.html
index 9112b38..0bfd570 100644
--- a/docs/html/custom_pools.html
+++ b/docs/html/custom_pools.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Custom memory pools
-
-
@@ -33,33 +31,22 @@
-
+
-
- Custom memory pools
+ Custom memory pools
-A "pool" is a collection of memory blocks that share certain properties. Allocator creates 3 default pools: for D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK. A default pool automatically grows in size. Size of allocated blocks is also variable and managed automatically. Typical allocations are created in these pools. You can also create custom pools.
-
+A "pool" is a collection of memory blocks that share certain properties. Allocator creates 3 default pools: for D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK. A default pool automatically grows in size. Size of allocated blocks is also variable and managed automatically. Typical allocations are created in these pools. You can also create custom pools.
+
Usage
To create a custom pool, fill in structure D3D12MA::POOL_DESC and call function D3D12MA::Allocator::CreatePool to obtain object D3D12MA::Pool. Example:
All allocations must be released before releasing the pool. The pool must be released before relasing the allocator.
alloc->Release();
pool->Release();
-
+
Features and benefits
While it is recommended to use default pools whenever possible for simplicity and to give the allocator more opportunities for internal optimizations, custom pools may be useful in following cases:
- To keep some resources separate from others in memory.
- To keep track of memory usage of just a specific group of resources. Statistics can be queried using D3D12MA::Pool::CalculateStatistics.
-- To use specific size of a memory block (
ID3D12Heap). To set it, use member D3D12MA::POOL_DESC::BlockSize. When set to 0, the library uses automatically determined, variable block sizes.
+- To use specific size of a memory block (ID3D12Heap). To set it, use member D3D12MA::POOL_DESC::BlockSize. When set to 0, the library uses automatically determined, variable block sizes.
- To reserve some minimum amount of memory allocated. To use it, set member D3D12MA::POOL_DESC::MinBlockCount.
- To limit maximum amount of memory allocated. To use it, set member D3D12MA::POOL_DESC::MaxBlockCount.
-- To use extended parameters of the D3D12 memory allocation. While resources created from default pools can only specify
D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK, a custom pool may use non-standard D3D12_HEAP_PROPERTIES (member D3D12MA::POOL_DESC::HeapProperties) and D3D12_HEAP_FLAGS (D3D12MA::POOL_DESC::HeapFlags), which is useful e.g. for cross-adapter sharing or UMA (see also D3D12MA::Allocator::IsUMA).
+- To use extended parameters of the D3D12 memory allocation. While resources created from default pools can only specify D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK, a custom pool may use non-standard D3D12_HEAP_PROPERTIES (member D3D12MA::POOL_DESC::HeapProperties) and D3D12_HEAP_FLAGS (D3D12MA::POOL_DESC::HeapFlags), which is useful e.g. for cross-adapter sharing or UMA (see also D3D12MA::Allocator::IsUMA).
New versions of this library support creating committed allocations in custom pools. It is supported only when D3D12MA::POOL_DESC::BlockSize = 0. To use this feature, set D3D12MA::ALLOCATION_DESC::CustomPool to the pointer to your custom pool and D3D12MA::ALLOCATION_DESC::Flags to D3D12MA::ALLOCATION_FLAG_COMMITTED. Example:
ALLOCATION_DESC allocDesc = {};
@@ -136,12 +123,12 @@
ID3D12Resource* res;
hr = allocator->CreateResource(&allocDesc, &resDesc,
D3D12_RESOURCE_STATE_GENERIC_READ, NULL, &alloc, IID_PPV_ARGS(&res));
-
This feature may seem unnecessary, but creating committed allocations from custom pools may be useful in some cases, e.g. to have separate memory usage statistics for some group of resources or to use extended allocation parameters, like custom D3D12_HEAP_PROPERTIES, which are available only in custom pools.
+This feature may seem unnecessary, but creating committed allocations from custom pools may be useful in some cases, e.g. to have separate memory usage statistics for some group of resources or to use extended allocation parameters, like custom D3D12_HEAP_PROPERTIES, which are available only in custom pools.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/defragmentation.html b/docs/html/defragmentation.html
index d68a400..b82dbde 100644
--- a/docs/html/defragmentation.html
+++ b/docs/html/defragmentation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Defragmentation
-
-
@@ -33,33 +31,22 @@
-
+
-
- Defragmentation
+ Defragmentation
Interleaved allocations and deallocations of many objects of varying size can cause fragmentation over time, which can lead to a situation where the library is unable to find a continuous range of free memory for a new allocation despite there is enough free space, just scattered across many small free ranges between existing allocations.
-To mitigate this problem, you can use defragmentation feature. It doesn't happen automatically though and needs your cooperation, because D3D12MA is a low level library that only allocates memory. It cannot recreate buffers and textures in a new place as it doesn't remember the contents of D3D12_RESOURCE_DESC structure. It cannot copy their contents as it doesn't record any commands to a command list.
+To mitigate this problem, you can use defragmentation feature. It doesn't happen automatically though and needs your cooperation, because D3D12MA is a low level library that only allocates memory. It cannot recreate buffers and textures in a new place as it doesn't remember the contents of D3D12_RESOURCE_DESC structure. It cannot copy their contents as it doesn't record any commands to a command list.
Example:
D3D12MA::DEFRAGMENTATION_DESC defragDesc = {};
defragDesc.Flags = D3D12MA::DEFRAGMENTATION_FLAG_ALGORITHM_FAST;
@@ -162,11 +149,11 @@
Parameters for incremental defragmentation steps.Definition D3D12MemAlloc.h:768
DEFRAGMENTATION_MOVE * pMovesArray of moves to be performed by the user in the current defragmentation pass.Definition D3D12MemAlloc.h:792
UINT32 MoveCountNumber of elements in the pMoves array.Definition D3D12MemAlloc.h:770
-Although functions like D3D12MA::Allocator::CreateResource() create an allocation and a buffer/texture at once, these are just a shortcut for allocating memory and creating a placed resource. Defragmentation works on memory allocations only. You must handle the rest manually. Defragmentation is an iterative process that should repreat "passes" as long as related functions return S_FALSE not S_OK. In each pass:
+Although functions like D3D12MA::Allocator::CreateResource() create an allocation and a buffer/texture at once, these are just a shortcut for allocating memory and creating a placed resource. Defragmentation works on memory allocations only. You must handle the rest manually. Defragmentation is an iterative process that should repreat "passes" as long as related functions return S_FALSE not S_OK. In each pass:
- D3D12MA::DefragmentationContext::BeginPass() function call:
- Calculates and returns the list of allocations to be moved in this pass. Note this can be a time-consuming process.
-- Reserves destination memory for them by creating temporary destination allocations that you can query for their
ID3D12Heap + offset using methods like D3D12MA::Allocation::GetHeap().
+- Reserves destination memory for them by creating temporary destination allocations that you can query for their ID3D12Heap + offset using methods like D3D12MA::Allocation::GetHeap().
- Inside the pass, you should:
@@ -179,40 +166,40 @@
- D3D12MA::DefragmentationContext::EndPass() function call:
- Frees the source memory reserved for the allocations that are moved.
- Modifies source D3D12MA::Allocation objects that are moved to point to the destination reserved memory and destination resource, while source resource is released.
-- Frees
ID3D12Heap blocks that became empty.
+- Frees ID3D12Heap blocks that became empty.
-Defragmentation algorithm tries to move all suitable allocations. You can, however, refuse to move some of them inside a defragmentation pass, by setting pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This is not recommended and may result in suboptimal packing of the allocations after defragmentation. If you cannot ensure any allocation can be moved, it is better to keep movable allocations separate in a custom pool.
+Defragmentation algorithm tries to move all suitable allocations. You can, however, refuse to move some of them inside a defragmentation pass, by setting pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This is not recommended and may result in suboptimal packing of the allocations after defragmentation. If you cannot ensure any allocation can be moved, it is better to keep movable allocations separate in a custom pool.
Inside a pass, for each allocation that should be moved:
-- You should copy its data from the source to the destination place by calling e.g.
CopyResource().
+- You should copy its data from the source to the destination place by calling e.g. CopyResource().
- You need to make sure these commands finished executing before the source buffers/textures are released by D3D12MA::DefragmentationContext::EndPass().
- If a resource doesn't contain any meaningful data, e.g. it is a transient render-target texture to be cleared, filled, and used temporarily in each rendering frame, you can just recreate this texture without copying its data.
-- If the resource is in
D3D12_HEAP_TYPE_READBACK memory, you can copy its data on the CPU using memcpy().
-- If you cannot move the allocation, you can set
pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This will cancel the move.
+- If the resource is in D3D12_HEAP_TYPE_READBACK memory, you can copy its data on the CPU using memcpy().
+- If you cannot move the allocation, you can set pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This will cancel the move.
- D3D12MA::DefragmentationContext::EndPass() will then free the destination memory not the source memory of the allocation, leaving it unchanged.
-- If you decide the allocation is unimportant and can be destroyed instead of moved (e.g. it wasn't used for long time), you can set
pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY.
+- If you decide the allocation is unimportant and can be destroyed instead of moved (e.g. it wasn't used for long time), you can set pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY.
- D3D12MA::DefragmentationContext::EndPass() will then free both source and destination memory, and will destroy the source D3D12MA::Allocation object.
You can defragment a specific custom pool by calling D3D12MA::Pool::BeginDefragmentation or all the default pools by calling D3D12MA::Allocator::BeginDefragmentation (like in the example above).
-Defragmentation is always performed in each pool separately. Allocations are never moved between different heap types. The size of the destination memory reserved for a moved allocation is the same as the original one. Alignment of an allocation as it was determined using GetResourceAllocationInfo() is also respected after defragmentation. Buffers/textures should be recreated with the same D3D12_RESOURCE_DESC parameters as the original ones.
+Defragmentation is always performed in each pool separately. Allocations are never moved between different heap types. The size of the destination memory reserved for a moved allocation is the same as the original one. Alignment of an allocation as it was determined using GetResourceAllocationInfo() is also respected after defragmentation. Buffers/textures should be recreated with the same D3D12_RESOURCE_DESC parameters as the original ones.
You can perform the defragmentation incrementally to limit the number of allocations and bytes to be moved in each pass, e.g. to call it in sync with render frames and not to experience too big hitches. See members: D3D12MA::DEFRAGMENTATION_DESC::MaxBytesPerPass, D3D12MA::DEFRAGMENTATION_DESC::MaxAllocationsPerPass.
Thread safety: It is safe to perform the defragmentation asynchronously to render frames and other Direct3D 12 and D3D12MA usage, possibly from multiple threads, with the exception that allocations returned in D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO::pMoves shouldn't be released until the defragmentation pass is ended. During the call to D3D12MA::DefragmentationContext::BeginPass(), any operations on the memory pool affected by the defragmentation are blocked by a mutex.
-What it means in practice is that you shouldn't free any allocations from the defragmented pool since the moment a call to BeginPass begins. Otherwise, a thread performing the allocation->Release() would block for the time BeginPass executes and then free the allocation when it finishes, while the allocation could have ended up on the list of allocations to move. A solution to freeing allocations during defragmentation is to find such allocation on the list pass.pMoves[i] and set its operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY instead of calling allocation->Release(), or simply deferring the release to the time after defragmentation finished.
+What it means in practice is that you shouldn't free any allocations from the defragmented pool since the moment a call to BeginPass begins. Otherwise, a thread performing the allocation->Release() would block for the time BeginPass executes and then free the allocation when it finishes, while the allocation could have ended up on the list of allocations to move. A solution to freeing allocations during defragmentation is to find such allocation on the list pass.pMoves[i] and set its operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY instead of calling allocation->Release(), or simply deferring the release to the time after defragmentation finished.
Mapping is out of scope of this library and so it is not preserved after an allocation is moved during defragmentation. You need to map the new resource yourself if needed.
- Note
- Defragmentation is not supported in custom pools created with D3D12MA::POOL_FLAG_ALGORITHM_LINEAR.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html b/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
index fa88354..6e6d46e 100644
--- a/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
+++ b/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: C:/Code/D3D12MemoryAllocator/REPO/include Directory Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -92,15 +79,14 @@
-
+
Files
D3D12MemAlloc.h D3D12MemAlloc.h
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/doxygen.css b/docs/html/doxygen.css
index 4947e24..5d2eecd 100644
--- a/docs/html/doxygen.css
+++ b/docs/html/doxygen.css
@@ -1,11 +1,12 @@
-/* The standard CSS for doxygen 1.13.2*/
+/* The standard CSS for doxygen 1.14.0*/
html {
/* page base colors */
--page-background-color: white;
--page-foreground-color: black;
--page-link-color: #3D578C;
---page-visited-link-color: #4665A2;
+--page-visited-link-color: #3D578C;
+--page-external-link-color: #334975;
/* index */
--index-odd-item-bg-color: #F8F9FC;
@@ -16,46 +17,50 @@ html {
/* header */
--header-background-color: #F9FAFC;
--header-separator-color: #C4CFE5;
---header-gradient-image: url('nav_h.png');
---group-header-separator-color: #879ECB;
+--group-header-separator-color: #D9E0EE;
--group-header-color: #354C7B;
--inherit-header-color: gray;
--footer-foreground-color: #2A3D61;
---footer-logo-width: 104px;
+--footer-logo-width: 75px;
--citation-label-color: #334975;
--glow-color: cyan;
--title-background-color: white;
---title-separator-color: #5373B4;
+--title-separator-color: #C4CFE5;
--directory-separator-color: #9CAFD4;
--separator-color: #4A6AAA;
--blockquote-background-color: #F7F8FB;
--blockquote-border-color: #9CAFD4;
---scrollbar-thumb-color: #9CAFD4;
+--scrollbar-thumb-color: #C4CFE5;
--scrollbar-background-color: #F9FAFC;
--icon-background-color: #728DC1;
--icon-foreground-color: white;
+/*
--icon-doc-image: url('doc.svg');
--icon-folder-open-image: url('folderopen.svg');
---icon-folder-closed-image: url('folderclosed.svg');
+--icon-folder-closed-image: url('folderclosed.svg');*/
+--icon-folder-open-fill-color: #C4CFE5;
+--icon-folder-fill-color: #D8DFEE;
+--icon-folder-border-color: #4665A2;
+--icon-doc-fill-color: #D8DFEE;
+--icon-doc-border-color: #4665A2;
/* brief member declaration list */
--memdecl-background-color: #F9FAFC;
--memdecl-separator-color: #DEE4F0;
--memdecl-foreground-color: #555;
--memdecl-template-color: #4665A2;
+--memdecl-border-color: #D5DDEC;
/* detailed member list */
--memdef-border-color: #A8B8D9;
--memdef-title-background-color: #E2E8F2;
---memdef-title-gradient-image: url('nav_f.png');
---memdef-proto-background-color: #DFE5F1;
+--memdef-proto-background-color: #EEF1F7;
--memdef-proto-text-color: #253555;
---memdef-proto-text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
--memdef-doc-background-color: white;
--memdef-param-name-color: #602020;
--memdef-template-color: #4665A2;
@@ -74,29 +79,34 @@ html {
/** navigation bar/tree/menu */
--nav-background-color: #F9FAFC;
--nav-foreground-color: #364D7C;
---nav-gradient-image: url('tab_b.png');
---nav-gradient-hover-image: url('tab_h.png');
---nav-gradient-active-image: url('tab_a.png');
---nav-gradient-active-image-parent: url("../tab_a.png");
---nav-separator-image: url('tab_s.png');
---nav-breadcrumb-image: url('bc_s.png');
---nav-breadcrumb-border-color: #C2CDE4;
---nav-splitbar-image: url('splitbar.png');
+--nav-border-color: #C4CFE5;
+--nav-breadcrumb-separator-color: #C4CFE5;
+--nav-breadcrumb-active-bg: #EEF1F7;
+--nav-breadcrumb-color: #354C7B;
+--nav-breadcrumb-border-color: #E1E7F2;
+--nav-splitbar-bg-color: #DCE2EF;
+--nav-splitbar-handle-color: #9CAFD4;
--nav-font-size-level1: 13px;
--nav-font-size-level2: 10px;
--nav-font-size-level3: 9px;
--nav-text-normal-color: #283A5D;
--nav-text-hover-color: white;
--nav-text-active-color: white;
---nav-text-normal-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
---nav-text-hover-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
---nav-text-active-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
--nav-menu-button-color: #364D7C;
--nav-menu-background-color: white;
--nav-menu-foreground-color: #555555;
+--nav-menu-active-bg: #DCE2EF;
+--nav-menu-active-color: #9CAFD4;
--nav-menu-toggle-color: rgba(255, 255, 255, 0.5);
---nav-arrow-color: #9CAFD4;
---nav-arrow-selected-color: #9CAFD4;
+--nav-arrow-color: #B6C4DF;
+--nav-arrow-selected-color: #90A5CE;
+
+/* sync icon */
+--sync-icon-border-color: #C4CFE5;
+--sync-icon-background-color: #F9FAFC;
+--sync-icon-selected-background-color: #EEF1F7;
+--sync-icon-color: #C4CFE5;
+--sync-icon-selected-color: #6884BD;
/* table of contents */
--toc-background-color: #F4F6FA;
@@ -107,18 +117,20 @@ html {
/** search field */
--search-background-color: white;
--search-foreground-color: #909090;
---search-magnification-image: url('mag.svg');
---search-magnification-select-image: url('mag_sel.svg');
--search-active-color: black;
---search-filter-background-color: #F9FAFC;
+--search-filter-background-color: rgba(255,255,255,.7);
+--search-filter-backdrop-filter: blur(4px);
--search-filter-foreground-color: black;
---search-filter-border-color: #90A5CE;
+--search-filter-border-color: rgba(150,150,150,.4);
--search-filter-highlight-text-color: white;
--search-filter-highlight-bg-color: #3D578C;
--search-results-foreground-color: #425E97;
---search-results-background-color: #EEF1F7;
---search-results-border-color: black;
---search-box-shadow: inset 0.5px 0.5px 3px 0px #555;
+--search-results-background-color: rgba(255,255,255,.8);
+--search-results-backdrop-filter: blur(4px);
+--search-results-border-color: rgba(150,150,150,.4);
+--search-box-border-color: #B6C4DF;
+--search-close-icon-bg-color: #A0A0A0;
+--search-close-icon-fg-color: white;
/** code fragments */
--code-keyword-color: #008000;
@@ -147,23 +159,21 @@ html {
--fragment-lineno-link-hover-bg-color: #C8C8C8;
--fragment-copy-ok-color: #2EC82E;
--tooltip-foreground-color: black;
---tooltip-background-color: white;
---tooltip-border-color: gray;
+--tooltip-background-color: rgba(255,255,255,0.8);
+--tooltip-arrow-background-color: white;
+--tooltip-border-color: rgba(150,150,150,0.7);
+--tooltip-backdrop-filter: blur(3px);
--tooltip-doc-color: grey;
--tooltip-declaration-color: #006318;
--tooltip-link-color: #4665A2;
---tooltip-shadow: 1px 1px 7px gray;
+--tooltip-shadow: 0 4px 8px 0 rgba(0,0,0,.25);
--fold-line-color: #808080;
---fold-minus-image: url('minus.svg');
---fold-plus-image: url('plus.svg');
---fold-minus-image-relpath: url('../../minus.svg');
---fold-plus-image-relpath: url('../../plus.svg');
/** font-family */
---font-family-normal: Roboto,sans-serif;
+--font-family-normal: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-monospace: 'JetBrains Mono',Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace,fixed;
--font-family-nav: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
---font-family-title: Tahoma,Arial,sans-serif;
+--font-family-title: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-toc: Verdana,'DejaVu Sans',Geneva,sans-serif;
--font-family-search: Arial,Verdana,sans-serif;
--font-family-icon: Arial,Helvetica;
@@ -201,7 +211,8 @@ html {
--page-background-color: black;
--page-foreground-color: #C9D1D9;
--page-link-color: #90A5CE;
---page-visited-link-color: #A3B4D7;
+--page-visited-link-color: #90A5CE;
+--page-external-link-color: #A3B4D7;
/* index */
--index-odd-item-bg-color: #0B101A;
@@ -212,8 +223,7 @@ html {
/* header */
--header-background-color: #070B11;
--header-separator-color: #141C2E;
---header-gradient-image: url('nav_hd.png');
---group-header-separator-color: #283A5D;
+--group-header-separator-color: #1D2A43;
--group-header-color: #90A5CE;
--inherit-header-color: #A0A0A0;
@@ -223,35 +233,36 @@ html {
--glow-color: cyan;
--title-background-color: #090D16;
---title-separator-color: #354C79;
+--title-separator-color: #212F4B;
--directory-separator-color: #283A5D;
--separator-color: #283A5D;
--blockquote-background-color: #101826;
--blockquote-border-color: #283A5D;
---scrollbar-thumb-color: #283A5D;
+--scrollbar-thumb-color: #2C3F65;
--scrollbar-background-color: #070B11;
--icon-background-color: #334975;
--icon-foreground-color: #C4CFE5;
---icon-doc-image: url('docd.svg');
---icon-folder-open-image: url('folderopend.svg');
---icon-folder-closed-image: url('folderclosedd.svg');
+--icon-folder-open-fill-color: #4665A2;
+--icon-folder-fill-color: #5373B4;
+--icon-folder-border-color: #C4CFE5;
+--icon-doc-fill-color: #6884BD;
+--icon-doc-border-color: #C4CFE5;
/* brief member declaration list */
--memdecl-background-color: #0B101A;
--memdecl-separator-color: #2C3F65;
--memdecl-foreground-color: #BBB;
--memdecl-template-color: #7C95C6;
+--memdecl-border-color: #233250;
/* detailed member list */
--memdef-border-color: #233250;
--memdef-title-background-color: #1B2840;
---memdef-title-gradient-image: url('nav_fd.png');
--memdef-proto-background-color: #19243A;
--memdef-proto-text-color: #9DB0D4;
---memdef-proto-text-shadow: 0px 1px 1px rgba(0, 0, 0, 0.9);
--memdef-doc-background-color: black;
--memdef-param-name-color: #D28757;
--memdef-template-color: #7C95C6;
@@ -270,29 +281,34 @@ html {
/** navigation bar/tree/menu */
--nav-background-color: #101826;
--nav-foreground-color: #364D7C;
---nav-gradient-image: url('tab_bd.png');
---nav-gradient-hover-image: url('tab_hd.png');
---nav-gradient-active-image: url('tab_ad.png');
---nav-gradient-active-image-parent: url("../tab_ad.png");
---nav-separator-image: url('tab_sd.png');
---nav-breadcrumb-image: url('bc_sd.png');
+--nav-border-color: #212F4B;
+--nav-breadcrumb-separator-color: #212F4B;
+--nav-breadcrumb-active-bg: #1D2A43;
+--nav-breadcrumb-color: #90A5CE;
--nav-breadcrumb-border-color: #2A3D61;
---nav-splitbar-image: url('splitbard.png');
+--nav-splitbar-bg-color: #283A5D;
+--nav-splitbar-handle-color: #4665A2;
--nav-font-size-level1: 13px;
--nav-font-size-level2: 10px;
--nav-font-size-level3: 9px;
--nav-text-normal-color: #B6C4DF;
--nav-text-hover-color: #DCE2EF;
--nav-text-active-color: #DCE2EF;
---nav-text-normal-shadow: 0px 1px 1px black;
---nav-text-hover-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
---nav-text-active-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
--nav-menu-button-color: #B6C4DF;
--nav-menu-background-color: #05070C;
--nav-menu-foreground-color: #BBBBBB;
+--nav-menu-active-bg: #1D2A43;
+--nav-menu-active-color: #C9D3E7;
--nav-menu-toggle-color: rgba(255, 255, 255, 0.2);
---nav-arrow-color: #334975;
---nav-arrow-selected-color: #90A5CE;
+--nav-arrow-color: #4665A2;
+--nav-arrow-selected-color: #6884BD;
+
+/* sync icon */
+--sync-icon-border-color: #212F4B;
+--sync-icon-background-color: #101826;
+--sync-icon-selected-background-color: #1D2A43;
+--sync-icon-color: #4665A2;
+--sync-icon-selected-color: #5373B4;
/* table of contents */
--toc-background-color: #151E30;
@@ -303,18 +319,20 @@ html {
/** search field */
--search-background-color: black;
--search-foreground-color: #C5C5C5;
---search-magnification-image: url('mag_d.svg');
---search-magnification-select-image: url('mag_seld.svg');
---search-active-color: #C5C5C5;
+--search-active-color: #F5F5F5;
--search-filter-background-color: #101826;
--search-filter-foreground-color: #90A5CE;
+--search-filter-backdrop-filter: none;
--search-filter-border-color: #7C95C6;
--search-filter-highlight-text-color: #BCC9E2;
--search-filter-highlight-bg-color: #283A5D;
---search-results-background-color: #101826;
+--search-results-background-color: black;
--search-results-foreground-color: #90A5CE;
---search-results-border-color: #7C95C6;
---search-box-shadow: inset 0.5px 0.5px 3px 0px #2F436C;
+--search-results-backdrop-filter: none;
+--search-results-border-color: #334975;
+--search-box-border-color: #334975;
+--search-close-icon-bg-color: #909090;
+--search-close-icon-fg-color: black;
/** code fragments */
--code-keyword-color: #CC99CD;
@@ -344,22 +362,20 @@ html {
--fragment-copy-ok-color: #0EA80E;
--tooltip-foreground-color: #C9D1D9;
--tooltip-background-color: #202020;
+--tooltip-arrow-background-color: #202020;
+--tooltip-backdrop-filter: none;
--tooltip-border-color: #C9D1D9;
--tooltip-doc-color: #D9E1E9;
--tooltip-declaration-color: #20C348;
--tooltip-link-color: #79C0FF;
--tooltip-shadow: none;
--fold-line-color: #808080;
---fold-minus-image: url('minusd.svg');
---fold-plus-image: url('plusd.svg');
---fold-minus-image-relpath: url('../../minusd.svg');
---fold-plus-image-relpath: url('../../plusd.svg');
/** font-family */
---font-family-normal: Roboto,sans-serif;
+--font-family-normal: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-monospace: 'JetBrains Mono',Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace,fixed;
--font-family-nav: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
---font-family-title: Tahoma,Arial,sans-serif;
+--font-family-title: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-toc: Verdana,'DejaVu Sans',Geneva,sans-serif;
--font-family-search: Arial,Verdana,sans-serif;
--font-family-icon: Arial,Helvetica;
@@ -389,8 +405,8 @@ html {
--invariant-color-text: #cceed5;
}}
body {
- background-color: var(--page-background-color);
- color: var(--page-foreground-color);
+ background-color: var(--page-background-color);
+ color: var(--page-foreground-color);
}
body, table, div, p, dl {
@@ -400,13 +416,22 @@ body, table, div, p, dl {
line-height: 22px;
}
+body.resizing {
+ user-select: none;
+ -webkit-user-select: none;
+}
+
+#doc-content {
+ scrollbar-width: thin;
+}
+
/* @group Heading Levels */
.title {
font-family: var(--font-family-normal);
line-height: 28px;
- font-size: 150%;
- font-weight: bold;
+ font-size: 160%;
+ font-weight: 400;
margin: 10px 2px;
}
@@ -415,7 +440,10 @@ h1.groupheader {
}
h2.groupheader {
- border-bottom: 1px solid var(--group-header-separator-color);
+ box-shadow: 12px 0 var(--page-background-color),
+ -12px 0 var(--page-background-color),
+ 12px 1px var(--group-header-separator-color),
+ -12px 1px var(--group-header-separator-color);
color: var(--group-header-color);
font-size: 150%;
font-weight: normal;
@@ -425,6 +453,13 @@ h2.groupheader {
width: 100%;
}
+td h2.groupheader {
+ box-shadow: 13px 0 var(--page-background-color),
+ -13px 0 var(--page-background-color),
+ 13px 1px var(--group-header-separator-color),
+ -13px 1px var(--group-header-separator-color);
+}
+
h3.groupheader {
font-size: 100%;
}
@@ -451,8 +486,8 @@ p.startli, p.startdd {
}
th p.starttd, th p.intertd, th p.endtd {
- font-size: 100%;
- font-weight: 700;
+ font-size: 100%;
+ font-weight: 700;
}
p.starttd {
@@ -497,9 +532,11 @@ h3.version {
}
div.navtab {
- padding-right: 15px;
+ margin-right: 6px;
+ padding-right: 6px;
text-align: right;
line-height: 110%;
+ background-color: var(--nav-background-color);
}
div.navtab table {
@@ -512,19 +549,10 @@ td.navtab {
}
td.navtabHL {
- background-image: var(--nav-gradient-active-image);
- background-repeat:repeat-x;
padding-right: 6px;
padding-left: 6px;
-}
-
-td.navtabHL a, td.navtabHL a:visited {
- color: var(--nav-text-hover-color);
- text-shadow: var(--nav-text-hover-shadow);
-}
-
-a.navtab {
- font-weight: bold;
+ border-radius: 0 6px 6px 0;
+ background-color: var(--nav-menu-active-bg);
}
div.qindex{
@@ -599,16 +627,11 @@ a {
color: var(--page-visited-link-color);
}
-a:hover {
+span.label a:hover {
text-decoration: none;
background: linear-gradient(to bottom, transparent 0,transparent calc(100% - 1px), currentColor 100%);
}
-a:hover > span.arrow {
- text-decoration: none;
- background : var(--nav-background-color);
-}
-
a.el {
font-weight: bold;
}
@@ -616,12 +639,12 @@ a.el {
a.elRef {
}
-a.code, a.code:visited, a.line, a.line:visited {
- color: var(--code-link-color);
+a.el, a.el:visited, a.code, a.code:visited, a.line, a.line:visited {
+ color: var(--page-link-color);
}
a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited {
- color: var(--code-external-link-color);
+ color: var(--page-external-link-color);
}
a.code.hl_class { /* style for links to class names in code snippets */ }
@@ -658,118 +681,124 @@ dl.el {
}
ul.check {
- list-style:none;
- text-indent: -16px;
- padding-left: 38px;
+ list-style:none;
+ text-indent: -16px;
+ padding-left: 38px;
}
li.unchecked:before {
- content: "\2610\A0";
+ content: "\2610\A0";
}
li.checked:before {
- content: "\2611\A0";
+ content: "\2611\A0";
}
ol {
- text-indent: 0px;
+ text-indent: 0px;
}
ul {
- text-indent: 0px;
- overflow: visible;
+ text-indent: 0px;
+ overflow: visible;
}
ul.multicol {
- -moz-column-gap: 1em;
- -webkit-column-gap: 1em;
- column-gap: 1em;
- -moz-column-count: 3;
- -webkit-column-count: 3;
- column-count: 3;
- list-style-type: none;
+ -moz-column-gap: 1em;
+ -webkit-column-gap: 1em;
+ column-gap: 1em;
+ -moz-column-count: 3;
+ -webkit-column-count: 3;
+ column-count: 3;
+ list-style-type: none;
}
#side-nav ul {
- overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */
+ overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */
}
#main-nav ul {
- overflow: visible; /* reset ul rule for the navigation bar drop down lists */
+ overflow: visible; /* reset ul rule for the navigation bar drop down lists */
}
.fragment {
- text-align: left;
- direction: ltr;
- overflow-x: auto;
- overflow-y: hidden;
- position: relative;
- min-height: 12px;
- margin: 10px 0px;
- padding: 10px 10px;
- border: 1px solid var(--fragment-border-color);
- border-radius: 4px;
- background-color: var(--fragment-background-color);
- color: var(--fragment-foreground-color);
+ text-align: left;
+ direction: ltr;
+ overflow-x: auto;
+ overflow-y: hidden;
+ position: relative;
+ min-height: 12px;
+ margin: 10px 0px;
+ padding: 10px 10px;
+ border: 1px solid var(--fragment-border-color);
+ border-radius: 4px;
+ background-color: var(--fragment-background-color);
+ color: var(--fragment-foreground-color);
}
pre.fragment {
- word-wrap: break-word;
- font-size: 10pt;
- line-height: 125%;
- font-family: var(--font-family-monospace);
+ word-wrap: break-word;
+ font-size: 10pt;
+ line-height: 125%;
+ font-family: var(--font-family-monospace);
+}
+
+span.tt {
+ white-space: pre;
+ font-family: var(--font-family-monospace);
}
.clipboard {
- width: 24px;
- height: 24px;
- right: 5px;
- top: 5px;
- opacity: 0;
- position: absolute;
- display: inline;
- overflow: hidden;
- justify-content: center;
- align-items: center;
- cursor: pointer;
+ width: 24px;
+ height: 24px;
+ right: 5px;
+ top: 5px;
+ opacity: 0;
+ position: absolute;
+ display: inline;
+ overflow: hidden;
+ justify-content: center;
+ align-items: center;
+ cursor: pointer;
}
.clipboard.success {
- border: 1px solid var(--fragment-foreground-color);
- border-radius: 4px;
+ border: 1px solid var(--fragment-foreground-color);
+ border-radius: 4px;
}
.fragment:hover .clipboard, .clipboard.success {
- opacity: .4;
+ opacity: .4;
}
.clipboard:hover, .clipboard.success {
- opacity: 1 !important;
+ opacity: 1 !important;
}
.clipboard:active:not([class~=success]) svg {
- transform: scale(.91);
+ transform: scale(.91);
}
.clipboard.success svg {
- fill: var(--fragment-copy-ok-color);
+ fill: var(--fragment-copy-ok-color);
}
.clipboard.success {
- border-color: var(--fragment-copy-ok-color);
+ border-color: var(--fragment-copy-ok-color);
}
div.line {
font-family: var(--font-family-monospace);
- font-size: 13px;
+ font-size: 13px;
min-height: 13px;
line-height: 1.2;
- text-wrap: unrestricted;
+ text-wrap: wrap;
+ word-break: break-all;
white-space: -moz-pre-wrap; /* Moz */
white-space: -pre-wrap; /* Opera 4-6 */
white-space: -o-pre-wrap; /* Opera 7 */
white-space: pre-wrap; /* CSS3 */
word-wrap: break-word; /* IE 5.5+ */
- text-indent: -53px;
- padding-left: 53px;
+ text-indent: -62px;
+ padding-left: 62px;
padding-bottom: 0px;
margin: 0px;
-webkit-transition-property: background-color, box-shadow;
@@ -785,8 +814,8 @@ div.line {
}
div.line:after {
- content:"\000A";
- white-space: pre;
+ content:"\000A";
+ white-space: pre;
}
div.line.glow {
@@ -795,26 +824,67 @@ div.line.glow {
}
span.fold {
- margin-left: 5px;
- margin-right: 1px;
- margin-top: 0px;
- margin-bottom: 0px;
- padding: 0px;
display: inline-block;
width: 12px;
height: 12px;
- background-repeat:no-repeat;
- background-position:center;
+ margin-left: 4px;
+ margin-right: 1px;
+}
+
+span.foldnone {
+ display: inline-block;
+ position: relative;
+ cursor: pointer;
+ user-select: none;
+}
+
+span.fold.plus, span.fold.minus {
+ width: 10px;
+ height: 10px;
+ background-color: var(--fragment-background-color);
+ position: relative;
+ border: 1px solid var(--fold-line-color);
+ margin-right: 1px;
+}
+
+span.fold.plus::before, span.fold.minus::before {
+ content: '';
+ position: absolute;
+ background-color: var(--fold-line-color);
+}
+
+span.fold.plus::before {
+ width: 2px;
+ height: 6px;
+ top: 2px;
+ left: 4px;
+}
+
+span.fold.plus::after {
+ content: '';
+ position: absolute;
+ width: 6px;
+ height: 2px;
+ top: 4px;
+ left: 2px;
+ background-color: var(--fold-line-color);
+}
+
+span.fold.minus::before {
+ width: 6px;
+ height: 2px;
+ top: 4px;
+ left: 2px;
}
span.lineno {
padding-right: 4px;
- margin-right: 9px;
+ margin-right: 9px;
text-align: right;
border-right: 2px solid var(--fragment-lineno-border-color);
color: var(--fragment-lineno-foreground-color);
background-color: var(--fragment-lineno-background-color);
- white-space: pre;
+ white-space: pre;
}
span.lineno a, span.lineno a:visited {
color: var(--fragment-lineno-link-fg-color);
@@ -836,18 +906,27 @@ span.lineno a:hover {
}
div.classindex ul {
- list-style: none;
- padding-left: 0;
+ list-style: none;
+ padding-left: 0;
}
div.classindex span.ai {
- display: inline-block;
+ display: inline-block;
}
div.groupHeader {
- margin-left: 16px;
- margin-top: 12px;
- font-weight: bold;
+ box-shadow: 13px 0 var(--page-background-color),
+ -13px 0 var(--page-background-color),
+ 13px 1px var(--group-header-separator-color),
+ -13px 1px var(--group-header-separator-color);
+ color: var(--group-header-color);
+ font-size: 110%;
+ font-weight: 500;
+ margin-left: 0px;
+ margin-top: 0em;
+ margin-bottom: 6px;
+ padding-top: 8px;
+ padding-bottom: 4px;
}
div.groupText {
@@ -857,13 +936,13 @@ div.groupText {
body {
color: var(--page-foreground-color);
- margin: 0;
+ margin: 0;
}
div.contents {
margin-top: 10px;
margin-left: 12px;
- margin-right: 8px;
+ margin-right: 12px;
}
p.formulaDsp {
@@ -883,9 +962,9 @@ img.formulaInl, img.inline {
div.center {
text-align: center;
- margin-top: 0px;
- margin-bottom: 0px;
- padding: 0px;
+ margin-top: 0px;
+ margin-bottom: 0px;
+ padding: 0px;
}
div.center img {
@@ -960,10 +1039,10 @@ span.vhdllogic {
}
blockquote {
- background-color: var(--blockquote-background-color);
- border-left: 2px solid var(--blockquote-border-color);
- margin: 0 24px 0 4px;
- padding: 0 12px 0 16px;
+ background-color: var(--blockquote-background-color);
+ border-left: 2px solid var(--blockquote-border-color);
+ margin: 0 24px 0 4px;
+ padding: 0 12px 0 16px;
}
/* @end */
@@ -985,9 +1064,14 @@ th.dirtab {
}
hr {
- height: 0px;
border: none;
- border-top: 1px solid var(--separator-color);
+ margin-top: 16px;
+ margin-bottom: 16px;
+ height: 1px;
+ box-shadow: 13px 0 var(--page-background-color),
+ -13px 0 var(--page-background-color),
+ 13px 1px var(--group-header-separator-color),
+ -13px 1px var(--group-header-separator-color);
}
hr.footer {
@@ -1002,14 +1086,6 @@ table.memberdecls {
}
.memberdecls td, .fieldtable tr {
- -webkit-transition-property: background-color, box-shadow;
- -webkit-transition-duration: 0.5s;
- -moz-transition-property: background-color, box-shadow;
- -moz-transition-duration: 0.5s;
- -ms-transition-property: background-color, box-shadow;
- -ms-transition-duration: 0.5s;
- -o-transition-property: background-color, box-shadow;
- -o-transition-duration: 0.5s;
transition-property: background-color, box-shadow;
transition-duration: 0.5s;
}
@@ -1019,13 +1095,23 @@ table.memberdecls {
box-shadow: 0 0 15px var(--glow-color);
}
+.memberdecls tr[class^='memitem'] {
+ font-family: var(--font-family-monospace);
+}
+
.mdescLeft, .mdescRight,
-.memItemLeft, .memItemRight,
-.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
+.memItemLeft, .memItemRight {
+ padding-top: 2px;
+ padding-bottom: 2px;
+}
+
+.memTemplParams {
+ padding-left: 10px;
+ padding-top: 5px;
+}
+
+.memItemLeft, .memItemRight, .memTemplParams {
background-color: var(--memdecl-background-color);
- border: none;
- margin: 4px;
- padding: 1px 0 0 8px;
}
.mdescLeft, .mdescRight {
@@ -1033,27 +1119,104 @@ table.memberdecls {
color: var(--memdecl-foreground-color);
}
-.memSeparator {
- border-bottom: 1px solid var(--memdecl-separator-color);
- line-height: 1px;
- margin: 0px;
- padding: 0px;
+tr[class^='memdesc'] {
+ box-shadow: inset 0px 1px 3px 0px rgba(0,0,0,.075);
}
-.memItemLeft, .memTemplItemLeft {
- white-space: nowrap;
+.mdescLeft {
+ border-left: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
}
-.memItemRight, .memTemplItemRight {
- width: 100%;
+.mdescRight {
+ border-right: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
}
.memTemplParams {
color: var(--memdecl-template-color);
- white-space: nowrap;
+ white-space: nowrap;
font-size: 80%;
+ border-left: 1px solid var(--memdecl-border-color);
+ border-right: 1px solid var(--memdecl-border-color);
+}
+
+td.ititle {
+ border: 1px solid var(--memdecl-border-color);
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+ padding-left: 10px;
+}
+
+tr:not(:first-child) > td.ititle {
+ border-top: 0;
+ border-radius: 0;
}
+.memItemLeft {
+ white-space: nowrap;
+ border-left: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
+ padding-left: 10px;
+ transition: none;
+}
+
+.memItemRight {
+ width: 100%;
+ border-right: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
+ padding-right: 10px;
+ transition: none;
+}
+
+tr.heading + tr[class^='memitem'] td.memItemLeft,
+tr.groupHeader + tr[class^='memitem'] td.memItemLeft,
+tr.inherit_header + tr[class^='memitem'] td.memItemLeft {
+ border-top: 1px solid var(--memdecl-border-color);
+ border-top-left-radius: 4px;
+}
+
+tr.heading + tr[class^='memitem'] td.memItemRight,
+tr.groupHeader + tr[class^='memitem'] td.memItemRight,
+tr.inherit_header + tr[class^='memitem'] td.memItemRight {
+ border-top: 1px solid var(--memdecl-border-color);
+ border-top-right-radius: 4px;
+}
+
+tr.heading + tr[class^='memitem'] td.memTemplParams,
+tr.heading + tr td.ititle,
+tr.groupHeader + tr[class^='memitem'] td.memTemplParams,
+tr.groupHeader + tr td.ititle,
+tr.inherit_header + tr[class^='memitem'] td.memTemplParams {
+ border-top: 1px solid var(--memdecl-border-color);
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+}
+
+table.memberdecls tr:last-child td.memItemLeft,
+table.memberdecls tr:last-child td.mdescLeft,
+table.memberdecls tr[class^='memitem']:has(+ tr.groupHeader) td.memItemLeft,
+table.memberdecls tr[class^='memitem']:has(+ tr.inherit_header) td.memItemLeft,
+table.memberdecls tr[class^='memdesc']:has(+ tr.groupHeader) td.mdescLeft,
+table.memberdecls tr[class^='memdesc']:has(+ tr.inherit_header) td.mdescLeft {
+ border-bottom-left-radius: 4px;
+}
+
+table.memberdecls tr:last-child td.memItemRight,
+table.memberdecls tr:last-child td.mdescRight,
+table.memberdecls tr[class^='memitem']:has(+ tr.groupHeader) td.memItemRight,
+table.memberdecls tr[class^='memitem']:has(+ tr.inherit_header) td.memItemRight,
+table.memberdecls tr[class^='memdesc']:has(+ tr.groupHeader) td.mdescRight,
+table.memberdecls tr[class^='memdesc']:has(+ tr.inherit_header) td.mdescRight {
+ border-bottom-right-radius: 4px;
+}
+
+tr.template .memItemLeft, tr.template .memItemRight {
+ border-top: none;
+ padding-top: 0;
+}
+
+
/* @end */
/* @group Member Details */
@@ -1068,24 +1231,43 @@ table.memberdecls {
border-top-right-radius: 4px;
border-top-left-radius: 4px;
margin-bottom: -1px;
- background-image: var(--memdef-title-gradient-image);
- background-repeat: repeat-x;
- background-color: var(--memdef-title-background-color);
+ background-color: var(--memdef-proto-background-color);
line-height: 1.25;
- font-weight: 300;
+ font-family: var(--font-family-monospace);
+ font-weight: 500;
+ font-size: 16px;
float:left;
+ box-shadow: 0 10px 0 -1px var(--memdef-proto-background-color),
+ 0 2px 8px 0 rgba(0,0,0,.075);
+ position: relative;
+}
+
+.memtitle:after {
+ content: '';
+ display: block;
+ background: var(--memdef-proto-background-color);
+ height: 10px;
+ bottom: -10px;
+ left: 0px;
+ right: -14px;
+ position: absolute;
+ border-top-right-radius: 6px;
}
.permalink
{
- font-size: 65%;
- display: inline-block;
- vertical-align: middle;
+ font-family: var(--font-family-monospace);
+ font-weight: 500;
+ line-height: 1.25;
+ font-size: 16px;
+ display: inline-block;
+ vertical-align: middle;
}
.memtemplate {
font-size: 80%;
color: var(--memdef-template-color);
+ font-family: var(--font-family-monospace);
font-weight: normal;
margin-left: 9px;
}
@@ -1098,22 +1280,21 @@ table.memberdecls {
padding: 0;
margin-bottom: 10px;
margin-right: 5px;
- -webkit-transition: box-shadow 0.5s linear;
- -moz-transition: box-shadow 0.5s linear;
- -ms-transition: box-shadow 0.5s linear;
- -o-transition: box-shadow 0.5s linear;
- transition: box-shadow 0.5s linear;
- display: table !important;
- width: 100%;
+ display: table !important;
+ width: 100%;
+ box-shadow: 0 2px 8px 0 rgba(0,0,0,.075);
+ border-radius: 4px;
}
.memitem.glow {
- box-shadow: 0 0 15px var(--glow-color);
+ box-shadow: 0 0 15px var(--glow-color);
}
.memname {
- font-weight: 400;
- margin-left: 6px;
+ font-family: var(--font-family-monospace);
+ font-size: 13px;
+ font-weight: 400;
+ margin-left: 6px;
}
.memname td {
@@ -1121,53 +1302,39 @@ table.memberdecls {
}
.memproto, dl.reflist dt {
- border-top: 1px solid var(--memdef-border-color);
- border-left: 1px solid var(--memdef-border-color);
- border-right: 1px solid var(--memdef-border-color);
- padding: 6px 0px 6px 0px;
- color: var(--memdef-proto-text-color);
- font-weight: bold;
- text-shadow: var(--memdef-proto-text-shadow);
- background-color: var(--memdef-proto-background-color);
- box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
- border-top-right-radius: 4px;
+ border-top: 1px solid var(--memdef-border-color);
+ border-left: 1px solid var(--memdef-border-color);
+ border-right: 1px solid var(--memdef-border-color);
+ padding: 6px 0px 6px 0px;
+ color: var(--memdef-proto-text-color);
+ font-weight: bold;
+ background-color: var(--memdef-proto-background-color);
+ border-top-right-radius: 4px;
+ border-bottom: 1px solid var(--memdef-border-color);
}
.overload {
- font-family: var(--font-family-monospace);
+ font-family: var(--font-family-monospace);
font-size: 65%;
}
.memdoc, dl.reflist dd {
- border-bottom: 1px solid var(--memdef-border-color);
- border-left: 1px solid var(--memdef-border-color);
- border-right: 1px solid var(--memdef-border-color);
- padding: 6px 10px 2px 10px;
- border-top-width: 0;
- background-image:url('nav_g.png');
- background-repeat:repeat-x;
- background-color: var(--memdef-doc-background-color);
- /* opera specific markup */
- border-bottom-left-radius: 4px;
- border-bottom-right-radius: 4px;
- box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
- /* firefox specific markup */
- -moz-border-radius-bottomleft: 4px;
- -moz-border-radius-bottomright: 4px;
- -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
- /* webkit specific markup */
- -webkit-border-bottom-left-radius: 4px;
- -webkit-border-bottom-right-radius: 4px;
- -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ border-bottom: 1px solid var(--memdef-border-color);
+ border-left: 1px solid var(--memdef-border-color);
+ border-right: 1px solid var(--memdef-border-color);
+ padding: 6px 10px 2px 10px;
+ border-top-width: 0;
+ border-bottom-left-radius: 4px;
+ border-bottom-right-radius: 4px;
}
dl.reflist dt {
- padding: 5px;
+ padding: 5px;
}
dl.reflist dd {
- margin: 0px 0px 10px 0px;
- padding: 5px;
+ margin: 0px 0px 10px 0px;
+ padding: 5px;
}
.paramkey {
@@ -1182,9 +1349,9 @@ dl.reflist dd {
.paramname {
white-space: nowrap;
- padding: 0px;
- padding-bottom: 1px;
- margin-left: 2px;
+ padding: 0px;
+ padding-bottom: 1px;
+ margin-left: 2px;
}
.paramname em {
@@ -1198,23 +1365,23 @@ dl.reflist dd {
}
.params, .retval, .exception, .tparams {
- margin-left: 0px;
- padding-left: 0px;
+ margin-left: 0px;
+ padding-left: 0px;
}
.params .paramname, .retval .paramname, .tparams .paramname, .exception .paramname {
- font-weight: bold;
- vertical-align: top;
+ font-weight: bold;
+ vertical-align: top;
}
.params .paramtype, .tparams .paramtype {
- font-style: italic;
- vertical-align: top;
+ font-style: italic;
+ vertical-align: top;
}
.params .paramdir, .tparams .paramdir {
- font-family: var(--font-family-monospace);
- vertical-align: top;
+ font-family: var(--font-family-monospace);
+ vertical-align: top;
}
table.mlabels {
@@ -1233,15 +1400,15 @@ td.mlabels-right {
}
span.mlabels {
- margin-left: 8px;
+ margin-left: 8px;
}
span.mlabel {
- background-color: var(--label-background-color);
- border-top:1px solid var(--label-left-top-border-color);
- border-left:1px solid var(--label-left-top-border-color);
- border-right:1px solid var(--label-right-bottom-border-color);
- border-bottom:1px solid var(--label-right-bottom-border-color);
+ background-color: var(--label-background-color);
+ border-top:1px solid var(--label-left-top-border-color);
+ border-left:1px solid var(--label-left-top-border-color);
+ border-right:1px solid var(--label-right-bottom-border-color);
+ border-bottom:1px solid var(--label-right-bottom-border-color);
text-shadow: none;
color: var(--label-foreground-color);
margin-right: 4px;
@@ -1259,39 +1426,37 @@ span.mlabel {
/* these are for tree view inside a (index) page */
div.directory {
- margin: 10px 0px;
- border-top: 1px solid var(--directory-separator-color);
- border-bottom: 1px solid var(--directory-separator-color);
- width: 100%;
+ margin: 10px 0px;
+ width: 100%;
}
.directory table {
- border-collapse:collapse;
+ border-collapse:collapse;
}
.directory td {
- margin: 0px;
- padding: 0px;
+ margin: 0px;
+ padding: 0px;
vertical-align: top;
}
.directory td.entry {
- white-space: nowrap;
- padding-right: 6px;
+ white-space: nowrap;
+ padding-right: 6px;
padding-top: 3px;
}
.directory td.entry a {
- outline:none;
+ outline:none;
}
.directory td.entry a img {
- border: none;
+ border: none;
}
.directory td.desc {
- width: 100%;
- padding-left: 6px;
+ width: 100%;
+ padding-left: 6px;
padding-right: 6px;
padding-top: 3px;
border-left: 1px solid rgba(0,0,0,0.05);
@@ -1312,90 +1477,178 @@ div.directory {
}
.directory .levels {
- white-space: nowrap;
- width: 100%;
- text-align: right;
- font-size: 9pt;
+ white-space: nowrap;
+ width: 100%;
+ text-align: right;
+ font-size: 9pt;
}
.directory .levels span {
- cursor: pointer;
- padding-left: 2px;
- padding-right: 2px;
+ cursor: pointer;
+ padding-left: 2px;
+ padding-right: 2px;
color: var(--page-link-color);
}
.arrow {
- color: var(--nav-arrow-color);
- -webkit-user-select: none;
- -khtml-user-select: none;
- -moz-user-select: none;
- -ms-user-select: none;
- user-select: none;
- cursor: pointer;
- font-size: 80%;
- display: inline-block;
- width: 16px;
- height: 22px;
+ color: var(--nav-background-color);
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ cursor: pointer;
+ font-size: 80%;
+ display: inline-block;
+ width: 16px;
+ height: 14px;
+ transition: opacity 0.3s ease;
+}
+
+span.arrowhead {
+ position: relative;
+ padding: 0;
+ margin: 0 0 0 2px;
+ display: inline-block;
+ width: 5px;
+ height: 5px;
+ border-right: 2px solid var(--nav-arrow-color);
+ border-bottom: 2px solid var(--nav-arrow-color);
+ transform: rotate(-45deg);
+ transition: transform 0.3s ease;
+}
+
+span.arrowhead.opened {
+ transform: rotate(45deg);
+}
+
+.selected span.arrowhead {
+ border-right: 2px solid var(--nav-arrow-selected-color);
+ border-bottom: 2px solid var(--nav-arrow-selected-color);
}
.icon {
- font-family: var(--font-family-icon);
- line-height: normal;
- font-weight: bold;
- font-size: 12px;
- height: 14px;
- width: 16px;
- display: inline-block;
- background-color: var(--icon-background-color);
- color: var(--icon-foreground-color);
- text-align: center;
- border-radius: 4px;
- margin-left: 2px;
- margin-right: 2px;
+ font-family: var(--font-family-icon);
+ line-height: normal;
+ font-weight: bold;
+ font-size: 12px;
+ height: 14px;
+ width: 16px;
+ display: inline-block;
+ background-color: var(--icon-background-color);
+ color: var(--icon-foreground-color);
+ text-align: center;
+ border-radius: 4px;
+ margin-left: 2px;
+ margin-right: 2px;
}
.icona {
- width: 24px;
- height: 22px;
- display: inline-block;
+ width: 24px;
+ height: 22px;
+ display: inline-block;
}
-.iconfopen {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:var(--icon-folder-open-image);
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
+.iconfolder {
+ width: 24px;
+ height: 18px;
+ margin-top: 6px;
+ vertical-align:top;
+ display: inline-block;
+ position: relative;
}
-.iconfclosed {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:var(--icon-folder-closed-image);
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
+.icondoc {
+ width: 24px;
+ height: 18px;
+ margin-top: 3px;
+ vertical-align:top;
+ display: inline-block;
+ position: relative;
}
-.icondoc {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:var(--icon-doc-image);
- background-position: 0px -4px;
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
+.folder-icon {
+ width: 16px;
+ height: 11px;
+ background-color: var(--icon-folder-fill-color);
+ border: 1px solid var(--icon-folder-border-color);
+ border-radius: 0 2px 2px 2px;
+ position: relative;
+ box-sizing: content-box;
+}
+
+.folder-icon::after {
+ content: '';
+ position: absolute;
+ top: 2px;
+ left: -1px;
+ width: 16px;
+ height: 7px;
+ background-color: var(--icon-folder-open-fill-color);
+ border: 1px solid var(--icon-folder-border-color);
+ border-radius: 7px 7px 2px 2px;
+ transform-origin: top left;
+ opacity: 0;
+ transition: all 0.3s linear;
+}
+
+.folder-icon::before {
+ content: '';
+ position: absolute;
+ top: -3px;
+ left: -1px;
+ width: 6px;
+ height: 2px;
+ background-color: var(--icon-folder-fill-color);
+ border-top: 1px solid var(--icon-folder-border-color);
+ border-left: 1px solid var(--icon-folder-border-color);
+ border-right: 1px solid var(--icon-folder-border-color);
+ border-radius: 2px 2px 0 0;
+}
+
+.folder-icon.open::after {
+ top: 3px;
+ opacity: 1;
+}
+
+.doc-icon {
+ left: 6px;
+ width: 12px;
+ height: 16px;
+ background-color: var(--icon-doc-border-color);
+ clip-path: polygon(0 0, 66% 0, 100% 25%, 100% 100%, 0 100%);
+ position: relative;
+ display: inline-block;
+}
+.doc-icon::before {
+ content: "";
+ left: 1px;
+ top: 1px;
+ width: 10px;
+ height: 14px;
+ background-color: var(--icon-doc-fill-color);
+ clip-path: polygon(0 0, 66% 0, 100% 25%, 100% 100%, 0 100%);
+ position: absolute;
+ box-sizing: border-box;
+}
+.doc-icon::after {
+ content: "";
+ left: 7px;
+ top: 0px;
+ width: 3px;
+ height: 3px;
+ background-color: transparent;
+ position: absolute;
+ border: 1px solid var(--icon-doc-border-color);
}
+
+
+
/* @end */
div.dynheader {
- margin-top: 8px;
+ margin-top: 8px;
-webkit-touch-callout: none;
-webkit-user-select: none;
-khtml-user-select: none;
@@ -1404,6 +1657,13 @@ div.dynheader {
user-select: none;
}
+span.dynarrow {
+ position: relative;
+ display: inline-block;
+ width: 12px;
+ bottom: 1px;
+}
+
address {
font-style: normal;
color: var(--footer-foreground-color);
@@ -1415,8 +1675,8 @@ table.doxtable caption {
table.doxtable {
border-collapse:collapse;
- margin-top: 4px;
- margin-bottom: 4px;
+ margin-top: 4px;
+ margin-bottom: 4px;
}
table.doxtable td, table.doxtable th {
@@ -1433,133 +1693,145 @@ table.doxtable th {
}
table.fieldtable {
- margin-bottom: 10px;
- border: 1px solid var(--memdef-border-color);
- border-spacing: 0px;
- border-radius: 4px;
- box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
+ margin-bottom: 10px;
+ border: 1px solid var(--memdef-border-color);
+ border-spacing: 0px;
+ border-radius: 4px;
+ box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
}
.fieldtable td, .fieldtable th {
- padding: 3px 7px 2px;
+ padding: 3px 7px 2px;
}
.fieldtable td.fieldtype, .fieldtable td.fieldname, .fieldtable td.fieldinit {
- white-space: nowrap;
- border-right: 1px solid var(--memdef-border-color);
- border-bottom: 1px solid var(--memdef-border-color);
- vertical-align: top;
+ white-space: nowrap;
+ border-right: 1px solid var(--memdef-border-color);
+ border-bottom: 1px solid var(--memdef-border-color);
+ vertical-align: top;
}
.fieldtable td.fieldname {
- padding-top: 3px;
+ padding-top: 3px;
}
.fieldtable td.fieldinit {
- padding-top: 3px;
- text-align: right;
+ padding-top: 3px;
+ text-align: right;
}
.fieldtable td.fielddoc {
- border-bottom: 1px solid var(--memdef-border-color);
+ border-bottom: 1px solid var(--memdef-border-color);
}
.fieldtable td.fielddoc p:first-child {
- margin-top: 0px;
+ margin-top: 0px;
}
.fieldtable td.fielddoc p:last-child {
- margin-bottom: 2px;
+ margin-bottom: 2px;
}
.fieldtable tr:last-child td {
- border-bottom: none;
+ border-bottom: none;
}
.fieldtable th {
- background-image: var(--memdef-title-gradient-image);
- background-repeat:repeat-x;
- background-color: var(--memdef-title-background-color);
- font-size: 90%;
- color: var(--memdef-proto-text-color);
- padding-bottom: 4px;
- padding-top: 5px;
- text-align:left;
- font-weight: 400;
- border-top-left-radius: 4px;
- border-top-right-radius: 4px;
- border-bottom: 1px solid var(--memdef-border-color);
-}
-
-
-.tabsearch {
- top: 0px;
- left: 10px;
- height: 36px;
- background-image: var(--nav-gradient-image);
- z-index: 101;
+ background-color: var(--memdef-title-background-color);
+ font-size: 90%;
+ color: var(--memdef-proto-text-color);
+ padding-bottom: 4px;
+ padding-top: 5px;
+ text-align:left;
+ font-weight: 400;
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+ border-bottom: 1px solid var(--memdef-border-color);
+}
+
+/* ----------- navigation breadcrumb styling ----------- */
+
+#nav-path ul {
+ height: 30px;
+ line-height: 30px;
+ color: var(--nav-text-normal-color);
overflow: hidden;
- font-size: 13px;
+ margin: 0px;
+ padding-left: 4px;
+ background-image: none;
+ background: var(--page-background-color);
+ border-bottom: 1px solid var(--nav-breadcrumb-separator-color);
+ font-size: var(--nav-font-size-level1);
+ font-family: var(--font-family-nav);
+ position: relative;
+ z-index: 100;
}
-.navpath ul
-{
- font-size: 11px;
- background-image: var(--nav-gradient-image);
- background-repeat:repeat-x;
- background-position: 0 -5px;
- height:30px;
- line-height:30px;
- color:var(--nav-text-normal-color);
- border:solid 1px var(--nav-breadcrumb-border-color);
- overflow:hidden;
- margin:0px;
- padding:0px;
-}
-
-.navpath li
-{
+#main-nav {
+ border-bottom: 1px solid var(--nav-border-color);
+}
+
+.navpath li {
list-style-type:none;
float:left;
+ color: var(--nav-foreground-color);
+}
+
+.navpath li.footer {
+ list-style-type:none;
+ float:right;
padding-left:10px;
padding-right:15px;
- background-image:var(--nav-breadcrumb-image);
+ background-image:none;
background-repeat:no-repeat;
background-position:right;
- color: var(--nav-foreground-color);
+ font-size: 8pt;
+ color: var(--footer-foreground-color);
}
-.navpath li.navelem a
-{
- height:32px;
- display:block;
- outline: none;
- color: var(--nav-text-normal-color);
- font-family: var(--font-family-nav);
- text-shadow: var(--nav-text-normal-shadow);
- text-decoration: none;
+#nav-path li.navelem {
+ background-image: none;
+ display: flex;
+ align-items: center;
+ padding-left: 15px;
}
-.navpath li.navelem a:hover
-{
- color: var(--nav-text-hover-color);
- text-shadow: var(--nav-text-hover-shadow);
+.navpath li.navelem a {
+ text-shadow: none;
+ display: inline-block;
+ color: var(--nav-breadcrumb-color);
+ position: relative;
+ top: 0px;
+ height: 30px;
+ margin-right: -20px;
}
-.navpath li.footer
-{
- list-style-type:none;
- float:right;
- padding-left:10px;
- padding-right:15px;
- background-image:none;
- background-repeat:no-repeat;
- background-position:right;
- color: var(--footer-foreground-color);
- font-size: 8pt;
+#nav-path li.navelem:after {
+ content: '';
+ display: inline-block;
+ position: relative;
+ top: 0;
+ right: -15px;
+ width: 30px;
+ height: 30px;
+ transform: scaleX(0.5) scale(0.707) rotate(45deg);
+ z-index: 10;
+ background: var(--page-background-color);
+ box-shadow: 2px -2px 0 2px var(--nav-breadcrumb-separator-color);
+ border-radius: 0 5px 0 50px;
+}
+
+#nav-path li.navelem:first-child {
+ margin-left: -6px;
}
+#nav-path li.navelem:hover,
+#nav-path li.navelem:hover:after {
+ background-color: var(--nav-breadcrumb-active-bg);
+}
+
+/* ---------------------- */
div.summary
{
@@ -1577,14 +1849,14 @@ div.summary a
table.classindex
{
- margin: 10px;
- white-space: nowrap;
- margin-left: 3%;
- margin-right: 3%;
- width: 94%;
- border: 0;
- border-spacing: 0;
- padding: 0;
+ margin: 10px;
+ white-space: nowrap;
+ margin-left: 3%;
+ margin-right: 3%;
+ width: 94%;
+ border: 0;
+ border-spacing: 0;
+ padding: 0;
}
div.ingroups
@@ -1601,10 +1873,8 @@ div.ingroups a
div.header
{
- background-image: var(--header-gradient-image);
- background-repeat:repeat-x;
- background-color: var(--header-background-color);
margin: 0px;
+ background-color: var(--header-background-color);
border-bottom: 1px solid var(--header-separator-color);
}
@@ -1613,168 +1883,105 @@ div.headertitle
padding: 5px 5px 5px 10px;
}
-.PageDocRTL-title div.headertitle {
- text-align: right;
- direction: rtl;
-}
-
dl {
- padding: 0 0 0 0;
-}
-
-/*
-
-dl.section {
- margin-left: 0px;
- padding-left: 0px;
-}
-
-dl.note {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #D0C000;
-}
-
-dl.warning, dl.attention, dl.important {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #FF0000;
-}
-
-dl.pre, dl.post, dl.invariant {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #00D000;
-}
-
-dl.deprecated {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #505050;
-}
-
-dl.todo {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #00C0E0;
-}
-
-dl.test {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #3030E0;
-}
-
-dl.bug {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #C08050;
+ padding: 0 0 0 0;
}
-*/
-
dl.bug dt a, dl.deprecated dt a, dl.todo dt a, dl.test a {
- font-weight: bold !important;
+ font-weight: bold !important;
}
dl.warning, dl.attention, dl.important, dl.note, dl.deprecated, dl.bug,
dl.invariant, dl.pre, dl.post, dl.todo, dl.test, dl.remark {
- padding: 10px;
- margin: 10px 0px;
- overflow: hidden;
- margin-left: 0;
- border-radius: 4px;
+ padding: 10px;
+ margin: 10px 0px;
+ overflow: hidden;
+ margin-left: 0;
+ border-radius: 4px;
}
dl.section dd {
- margin-bottom: 2px;
+ margin-bottom: 2px;
}
dl.warning, dl.attention, dl.important {
- background: var(--warning-color-bg);
- border-left: 8px solid var(--warning-color-hl);
- color: var(--warning-color-text);
+ background: var(--warning-color-bg);
+ border-left: 8px solid var(--warning-color-hl);
+ color: var(--warning-color-text);
}
dl.warning dt, dl.attention dt, dl.important dt {
- color: var(--warning-color-hl);
+ color: var(--warning-color-hl);
}
dl.note, dl.remark {
- background: var(--note-color-bg);
- border-left: 8px solid var(--note-color-hl);
- color: var(--note-color-text);
+ background: var(--note-color-bg);
+ border-left: 8px solid var(--note-color-hl);
+ color: var(--note-color-text);
}
dl.note dt, dl.remark dt {
- color: var(--note-color-hl);
+ color: var(--note-color-hl);
}
dl.todo {
- background: var(--todo-color-bg);
- border-left: 8px solid var(--todo-color-hl);
- color: var(--todo-color-text);
+ background: var(--todo-color-bg);
+ border-left: 8px solid var(--todo-color-hl);
+ color: var(--todo-color-text);
}
dl.todo dt {
- color: var(--todo-color-hl);
+ color: var(--todo-color-hl);
}
dl.test {
- background: var(--test-color-bg);
- border-left: 8px solid var(--test-color-hl);
- color: var(--test-color-text);
+ background: var(--test-color-bg);
+ border-left: 8px solid var(--test-color-hl);
+ color: var(--test-color-text);
}
dl.test dt {
- color: var(--test-color-hl);
+ color: var(--test-color-hl);
}
dl.bug dt a {
- color: var(--bug-color-hl) !important;
+ color: var(--bug-color-hl) !important;
}
dl.bug {
- background: var(--bug-color-bg);
- border-left: 8px solid var(--bug-color-hl);
- color: var(--bug-color-text);
+ background: var(--bug-color-bg);
+ border-left: 8px solid var(--bug-color-hl);
+ color: var(--bug-color-text);
}
dl.bug dt a {
- color: var(--bug-color-hl) !important;
+ color: var(--bug-color-hl) !important;
}
dl.deprecated {
- background: var(--deprecated-color-bg);
- border-left: 8px solid var(--deprecated-color-hl);
- color: var(--deprecated-color-text);
+ background: var(--deprecated-color-bg);
+ border-left: 8px solid var(--deprecated-color-hl);
+ color: var(--deprecated-color-text);
}
dl.deprecated dt a {
- color: var(--deprecated-color-hl) !important;
+ color: var(--deprecated-color-hl) !important;
}
dl.note dd, dl.warning dd, dl.pre dd, dl.post dd,
dl.remark dd, dl.attention dd, dl.important dd, dl.invariant dd,
dl.bug dd, dl.deprecated dd, dl.todo dd, dl.test dd {
- margin-inline-start: 0px;
+ margin-inline-start: 0px;
}
dl.invariant, dl.pre, dl.post {
- background: var(--invariant-color-bg);
- border-left: 8px solid var(--invariant-color-hl);
- color: var(--invariant-color-text);
+ background: var(--invariant-color-bg);
+ border-left: 8px solid var(--invariant-color-hl);
+ color: var(--invariant-color-text);
}
dl.invariant dt, dl.pre dt, dl.post dt {
- color: var(--invariant-color-hl);
+ color: var(--invariant-color-hl);
}
@@ -1797,16 +2004,16 @@ dl.invariant dt, dl.pre dt, dl.post dt {
#projectalign
{
- vertical-align: middle;
- padding-left: 0.5em;
+ vertical-align: middle;
+ padding-left: 0.5em;
}
#projectname
{
font-size: 200%;
font-family: var(--font-family-title);
- margin: 0px;
- padding: 2px 0px;
+ margin: 0;
+ padding: 0;
}
#side-nav #projectname
@@ -1817,7 +2024,7 @@ dl.invariant dt, dl.pre dt, dl.post dt {
#projectbrief
{
font-size: 90%;
- font-family: var(--font-family-title);
+ font-family: var(--font-family-title);
margin: 0px;
padding: 0px;
}
@@ -1825,43 +2032,42 @@ dl.invariant dt, dl.pre dt, dl.post dt {
#projectnumber
{
font-size: 50%;
- font-family: 50% var(--font-family-title);
+ font-family: var(--font-family-title);
margin: 0px;
padding: 0px;
}
#titlearea
{
- padding: 0px;
+ padding: 0 0 0 5px;
margin: 0px;
- width: 100%;
border-bottom: 1px solid var(--title-separator-color);
background-color: var(--title-background-color);
}
.image
{
- text-align: center;
+ text-align: center;
}
.dotgraph
{
- text-align: center;
+ text-align: center;
}
.mscgraph
{
- text-align: center;
+ text-align: center;
}
.plantumlgraph
{
- text-align: center;
+ text-align: center;
}
.diagraph
{
- text-align: center;
+ text-align: center;
}
.caption
@@ -1870,67 +2076,67 @@ dl.invariant dt, dl.pre dt, dl.post dt {
}
dl.citelist {
- margin-bottom:50px;
+ margin-bottom:50px;
}
dl.citelist dt {
- color:var(--citation-label-color);
- float:left;
- font-weight:bold;
- margin-right:10px;
- padding:5px;
- text-align:right;
- width:52px;
+ color:var(--citation-label-color);
+ float:left;
+ font-weight:bold;
+ margin-right:10px;
+ padding:5px;
+ text-align:right;
+ width:52px;
}
dl.citelist dd {
- margin:2px 0 2px 72px;
- padding:5px 0;
+ margin:2px 0 2px 72px;
+ padding:5px 0;
}
div.toc {
- padding: 14px 25px;
- background-color: var(--toc-background-color);
- border: 1px solid var(--toc-border-color);
- border-radius: 7px 7px 7px 7px;
- float: right;
- height: auto;
- margin: 0 8px 10px 10px;
- width: 200px;
+ padding: 14px 25px;
+ background-color: var(--toc-background-color);
+ border: 1px solid var(--toc-border-color);
+ border-radius: 7px 7px 7px 7px;
+ float: right;
+ height: auto;
+ margin: 0 8px 10px 10px;
+ width: 200px;
}
div.toc li {
- background: var(--toc-down-arrow-image) no-repeat scroll 0 5px transparent;
- font: 10px/1.2 var(--font-family-toc);
- margin-top: 5px;
- padding-left: 10px;
- padding-top: 2px;
+ background: var(--toc-down-arrow-image) no-repeat scroll 0 5px transparent;
+ font: 10px/1.2 var(--font-family-toc);
+ margin-top: 5px;
+ padding-left: 10px;
+ padding-top: 2px;
}
div.toc h3 {
- font: bold 12px/1.2 var(--font-family-toc);
+ font: bold 12px/1.2 var(--font-family-toc);
color: var(--toc-header-color);
- border-bottom: 0 none;
- margin: 0;
+ border-bottom: 0 none;
+ margin: 0;
}
div.toc ul {
- list-style: none outside none;
- border: medium none;
- padding: 0px;
+ list-style: none outside none;
+ border: medium none;
+ padding: 0px;
}
div.toc li[class^='level'] {
- margin-left: 15px;
+ margin-left: 15px;
}
div.toc li.level1 {
- margin-left: 0px;
+ margin-left: 0px;
}
div.toc li.empty {
- background-image: none;
- margin-top: 0px;
+ background-image: none;
+ margin-top: 0px;
}
span.emoji {
@@ -1940,13 +2146,12 @@ span.emoji {
}
span.obfuscator {
- display: none;
+ display: none;
}
.inherit_header {
- font-weight: bold;
- color: var(--inherit-header-color);
- cursor: pointer;
+ font-weight: 400;
+ cursor: pointer;
-webkit-touch-callout: none;
-webkit-user-select: none;
-khtml-user-select: none;
@@ -1956,49 +2161,49 @@ span.obfuscator {
}
.inherit_header td {
- padding: 6px 0px 2px 5px;
+ padding: 6px 0 2px 0;
}
.inherit {
- display: none;
+ display: none;
}
tr.heading h2 {
- margin-top: 12px;
- margin-bottom: 4px;
+ margin-top: 12px;
+ margin-bottom: 12px;
}
/* tooltip related style info */
.ttc {
- position: absolute;
- display: none;
+ position: absolute;
+ display: none;
}
#powerTip {
cursor: default;
- /*white-space: nowrap;*/
- color: var(--tooltip-foreground-color);
+ color: var(--tooltip-foreground-color);
background-color: var(--tooltip-background-color);
+ backdrop-filter: var(--tooltip-backdrop-filter);
+ -webkit-backdrop-filter: var(--tooltip-backdrop-filter);
border: 1px solid var(--tooltip-border-color);
- border-radius: 4px 4px 4px 4px;
+ border-radius: 4px;
box-shadow: var(--tooltip-shadow);
display: none;
font-size: smaller;
max-width: 80%;
- opacity: 0.9;
padding: 1ex 1em 1em;
position: absolute;
z-index: 2147483647;
}
#powerTip div.ttdoc {
- color: var(--tooltip-doc-color);
+ color: var(--tooltip-doc-color);
font-style: italic;
}
#powerTip div.ttname a {
- font-weight: bold;
+ font-weight: bold;
}
#powerTip a {
@@ -2006,18 +2211,18 @@ tr.heading h2 {
}
#powerTip div.ttname {
- font-weight: bold;
+ font-weight: bold;
}
#powerTip div.ttdeci {
- color: var(--tooltip-declaration-color);
+ color: var(--tooltip-declaration-color);
}
#powerTip div {
- margin: 0px;
- padding: 0px;
- font-size: 12px;
- font-family: var(--font-family-tooltip);
+ margin: 0px;
+ padding: 0px;
+ font-size: 12px;
+ font-family: var(--font-family-tooltip);
line-height: 16px;
}
@@ -2063,7 +2268,7 @@ tr.heading h2 {
}
#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after {
- border-top-color: var(--tooltip-background-color);
+ border-top-color: var(--tooltip-arrow-background-color);
border-width: 10px;
margin: 0px -10px;
}
@@ -2091,7 +2296,7 @@ tr.heading h2 {
}
#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after {
- border-bottom-color: var(--tooltip-background-color);
+ border-bottom-color: var(--tooltip-arrow-background-color);
border-width: 10px;
margin: 0px -10px;
}
@@ -2148,29 +2353,29 @@ tr.heading h2 {
@media print
{
- #top { display: none; }
- #side-nav { display: none; }
- #nav-path { display: none; }
- body { overflow:visible; }
- h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
- .summary { display: none; }
- .memitem { page-break-inside: avoid; }
- #doc-content
- {
- margin-left:0 !important;
- height:auto !important;
- width:auto !important;
- overflow:inherit;
- display:inline;
- }
+ #top { display: none; }
+ #side-nav { display: none; }
+ #nav-path { display: none; }
+ body { overflow:visible; }
+ h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
+ .summary { display: none; }
+ .memitem { page-break-inside: avoid; }
+ #doc-content
+ {
+ margin-left:0 !important;
+ height:auto !important;
+ width:auto !important;
+ overflow:inherit;
+ display:inline;
+ }
}
/* @group Markdown */
table.markdownTable {
border-collapse:collapse;
- margin-top: 4px;
- margin-bottom: 4px;
+ margin-top: 4px;
+ margin-bottom: 4px;
}
table.markdownTable td, table.markdownTable th {
@@ -2203,11 +2408,11 @@ th.markdownTableHeadCenter, td.markdownTableBodyCenter {
tt, code, kbd
{
- display: inline-block;
+ display: inline-block;
}
tt, code, kbd
{
- vertical-align: top;
+ vertical-align: top;
}
/* @end */
@@ -2216,26 +2421,27 @@ u {
}
details>summary {
- list-style-type: none;
+ list-style-type: none;
}
details > summary::-webkit-details-marker {
- display: none;
+ display: none;
}
details>summary::before {
- content: "\25ba";
- padding-right:4px;
- font-size: 80%;
+ content: "\25ba";
+ padding-right:4px;
+ font-size: 80%;
}
details[open]>summary::before {
- content: "\25bc";
- padding-right:4px;
- font-size: 80%;
+ content: "\25bc";
+ padding-right:4px;
+ font-size: 80%;
}
-body {
+:root {
+ scrollbar-width: thin;
scrollbar-color: var(--scrollbar-thumb-color) var(--scrollbar-background-color);
}
diff --git a/docs/html/doxygen_crawl.html b/docs/html/doxygen_crawl.html
index 1a7784e..6b8ae0b 100644
--- a/docs/html/doxygen_crawl.html
+++ b/docs/html/doxygen_crawl.html
@@ -4,7 +4,7 @@
Validator / crawler helper
-
+
diff --git a/docs/html/dynsections.js b/docs/html/dynsections.js
index b05f4c8..0e15bd4 100644
--- a/docs/html/dynsections.js
+++ b/docs/html/dynsections.js
@@ -28,7 +28,6 @@ function toggleVisibility(linkObj) {
}
let dynsection = {
-
// helper function
updateStripes : function() {
$('table.directory tr').
@@ -44,15 +43,13 @@ let dynsection = {
const trigger = $('#'+base+'-trigger');
const src=$(trigger).attr('src');
if (content.is(':visible')===true) {
- content.hide();
+ content.slideUp('fast');
summary.show();
- $(linkObj).addClass('closed').removeClass('opened');
- $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png');
+ $(linkObj).find('.arrowhead').addClass('closed').removeClass('opened');
} else {
- content.show();
+ content.slideDown('fast');
summary.hide();
- $(linkObj).removeClass('closed').addClass('opened');
- $(trigger).attr('src',src.substring(0,src.length-10)+'open.png');
+ $(linkObj).find('.arrowhead').removeClass('closed').addClass('opened');
}
return false;
},
@@ -63,12 +60,12 @@ let dynsection = {
const i = $('#img'+this.id.substring(3));
const a = $('#arr'+this.id.substring(3));
if (lD3D12 Memory Allocator: Frequently asked questions
-
-
@@ -33,33 +31,22 @@
-
+
-
- Frequently asked questions
+ Frequently asked questions
What is D3D12MA?
@@ -96,18 +83,18 @@
What is the license of D3D12MA?
D3D12MA is licensed under MIT, which means it is open source and free software.
What is the purpose of D3D12MA?
-D3D12MA helps with handling one aspect of DX12 usage, which is GPU memory management - allocation of ID3D12Heap objects and creation of ID3D12Resource objects - buffers and textures.
+D3D12MA helps with handling one aspect of DX12 usage, which is GPU memory management - allocation of ID3D12Heap objects and creation of ID3D12Resource objects - buffers and textures.
Do I need to use D3D12MA?
You don't need to, but it may be beneficial in many cases. DX12 is a complex and low-level API, so libraries like this that abstract certain aspects of the API and bring them to a higher level are useful. When developing any non-trivial graphics application, you may benefit from using a memory allocator. Using D3D12MA can save time compared to implementing your own.
-In DX12 you can create each resource separately with its own implicit memory heap by calling CreateCommittedResource, but this may not be the optimal solution. For more information, see Committed versus placed resources.
+In DX12 you can create each resource separately with its own implicit memory heap by calling CreateCommittedResource, but this may not be the optimal solution. For more information, see Committed versus placed resources.
When should I not use D3D12MA?
While D3D12MA is useful for many applications that use the DX12 API, there are cases when it may be a better choice not to use it. For example, if the application is very simple, e.g. serving as a sample or a learning exercise to help you understand or teach others the basics of DX12, and it creates only a small number of buffers and textures, then including D3D12MA may be an overkill. Developing your own memory allocator may also be a good learning exercise.
What are the benefits of using D3D12MA?
-- D3D12MA allocates large blocks of
ID3D12Heap memory and sub-allocates parts of them to create your placed resources. Allocating a new block of GPU memory may be a time-consuming operation. Sub-allocating parts of a memory block requires implementing an allocation algorithm, which is a non-trivial task. D3D12MA does that, using an advanced and efficient algorithm that works well in various use cases.
+- D3D12MA allocates large blocks of ID3D12Heap memory and sub-allocates parts of them to create your placed resources. Allocating a new block of GPU memory may be a time-consuming operation. Sub-allocating parts of a memory block requires implementing an allocation algorithm, which is a non-trivial task. D3D12MA does that, using an advanced and efficient algorithm that works well in various use cases.
- D3D12MA offers a simple API that allows creating placed buffers and textures within one function call like D3D12MA::Allocator::CreateResource.
-The library is doing much more under the hood. For example, it keeps buffers separate from textures when needed, respecting D3D12_RESOURCE_HEAP_TIER. It also makes use of the "small texture alignment" automatically, so you don't need to think about it.
+The library is doing much more under the hood. For example, it keeps buffers separate from textures when needed, respecting D3D12_RESOURCE_HEAP_TIER. It also makes use of the "small texture alignment" automatically, so you don't need to think about it.
Which version should I pick?
You can just pick the latest version from the "master" branch. It is kept in a good shape most of the time, compiling and working correctly, with no compatibility-breaking changes and no unfinished code.
If you want an even more stable version, you can pick the latest official release. Current code from the master branch is occasionally tagged as a release, with CHANGELOG carefully curated to enumerate all important changes since the previous version.
@@ -119,10 +106,10 @@
I am not a fan of modern C++. Can I still use it?
Very likely yes. We acknowledge that many C++ developers, especially in the games industry, do not appreciate all the latest features that the language has to offer.
-- D3D12MA doesn't throw or catch any C++ exceptions. It reports errors by returning a
HRESULT value instead, just like DX12. If you don't use exceptions in your project, your code is not exception-safe, or even if you disable exception handling in the compiler options, you can still use D3D12MA.
-- D3D12MA doesn't use C++ run-time type information like
typeid or dynamic_cast, so if you disable RTTI in the compiler options, you can still use the library.
-- D3D12MA uses only a limited subset of standard C and C++ library. It doesn't use STL containers like
std::vector, map, or string, either in the public interface nor in the internal implementation. It implements its own containers instead.
-- If you don't use the default heap memory allocator through
malloc/free or new/delete but implement your own allocator instead, you can pass it to D3D12MA as D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks and the library will use your functions for every dynamic heap allocation made internally.
+- D3D12MA doesn't throw or catch any C++ exceptions. It reports errors by returning a HRESULT value instead, just like DX12. If you don't use exceptions in your project, your code is not exception-safe, or even if you disable exception handling in the compiler options, you can still use D3D12MA.
+- D3D12MA doesn't use C++ run-time type information like typeid or dynamic_cast, so if you disable RTTI in the compiler options, you can still use the library.
+- D3D12MA uses only a limited subset of standard C and C++ library. It doesn't use STL containers like std::vector, map, or string, either in the public interface nor in the internal implementation. It implements its own containers instead.
+- If you don't use the default heap memory allocator through malloc/free or new/delete but implement your own allocator instead, you can pass it to D3D12MA as D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks and the library will use your functions for every dynamic heap allocation made internally.
Is it available for other programming languages?
D3D12MA is a C++ library in similar style as DX12. Bindings to other programming languages are out of scope of this project, but they are welcome as external projects. Some of them are listed in README.md, "See also" section, including binding to C. Before using any of them, please check if they are still maintained and updated to use a recent version of D3D12MA.
@@ -132,7 +119,7 @@
No! While D3D12MA is published by AMD, it works on any GPU that supports DX12, whether a discrete PC graphics card or a processor integrated graphics. It doesn't give AMD GPUs any advantage over any other GPUs.
What DirectX 12 versions are supported?
D3D12MA is updated to support latest versions of DirectX 12, as available through recent retail versions of the DirectX 12 Agility SDK. Support for new features added in the preview version of the Agility SDK is developed on separate branches until they are included in the retail version.
-The library also supports older versions down to the base DX12 shipping with Windows SDK. Features added by later versions of the Agility SDK are automatically enabled conditionally using #ifdef preprocessor macros depending on the version of the SDK that you compile your project with.
+The library also supports older versions down to the base DX12 shipping with Windows SDK. Features added by later versions of the Agility SDK are automatically enabled conditionally using #ifdef preprocessor macros depending on the version of the SDK that you compile your project with.
Does it support other graphics APIs, like Vulkan(R)?
No, but we offer an equivalent library for Vulkan: Vulkan Memory Allocator. It uses the same core allocation algorithm. It also shares many features with D3D12MA, like the support for custom pools and virtual allocator. However, it is not identical in terms of the features supported. Its API also looks different, because while the interface of D3D12MA is similar in style to DX12, the interface of VMA is similar to Vulkan.
Is the library lightweight?
@@ -154,8 +141,8 @@
If you want to report a suspected bug, you can also create a ticket the same way. Before doing this, please put some effort into the investigation of whether the bug is really in the library and not in your code or in the DX12 implementation (the GPU driver) on your platform:
- Enable D3D Debug Layer and make sure it is free from any errors.
-- Make sure
D3D12MA_ASSERT is defined to an implementation that can report a failure and not ignore it.
-- Try making your allocation using pure DX12 functions like
CreateCommittedResource() rather than D3D12MA and see if the bug persists.
+- Make sure D3D12MA_ASSERT is defined to an implementation that can report a failure and not ignore it.
+- Try making your allocation using pure DX12 functions like CreateCommittedResource() rather than D3D12MA and see if the bug persists.
I found some compilation warnings. How can we fix them?
Seeing compiler warnings may be annoying to some developers, but it is a design decision to not fix all of them. Due to the nature of the C++ language, certain preprocessor macros can make some variables unused, function parameters unreferenced, or conditional expressions constant in some configurations. The code of this library should not be bigger or more complicated just to silence these warnings. It is recommended to disable such warnings instead. For more information, see Features not supported.
@@ -164,7 +151,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/files.html b/docs/html/files.html
index 0ccb6a5..5ce45bf 100644
--- a/docs/html/files.html
+++ b/docs/html/files.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: File List
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all files with brief descriptions:
[detail level 12]
- ▼ include D3D12MemAlloc.h include D3D12MemAlloc.h
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions.html b/docs/html/functions.html
index 0690bb7..e1beea4 100644
--- a/docs/html/functions.html
+++ b/docs/html/functions.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all class members with links to the classes they belong to:
-- a -
+- a -
- Alignment : D3D12MA::VIRTUAL_ALLOCATION_DESC
- Allocate() : D3D12MA::VirtualBlock
- AllocateMemory() : D3D12MA::Allocator
@@ -100,7 +87,7 @@ - a -
-- b -
+- b -
- BeginDefragmentation() : D3D12MA::Allocator, D3D12MA::Pool
- BeginPass() : D3D12MA::DefragmentationContext
- block : D3D12MA::Allocation
@@ -114,7 +101,7 @@ - b -
-- c -
+- c -
- CalculateStatistics() : D3D12MA::Allocator, D3D12MA::Pool, D3D12MA::VirtualBlock
- CALLOCATION_DESC() : D3D12MA::CALLOCATION_DESC
- Clear() : D3D12MA::VirtualBlock
@@ -134,25 +121,25 @@ - c -
-- d -
+- d -
- D3D12MA_DELETE : D3D12MA::Allocation, D3D12MA::Allocator, D3D12MA::DefragmentationContext, D3D12MA::Pool, D3D12MA::VirtualBlock
-- e -
+- e -
- EndPass() : D3D12MA::DefragmentationContext
- ExtraHeapFlags : D3D12MA::ALLOCATION_DESC
-- f -
+- f -
- Flags : D3D12MA::ALLOCATION_DESC, D3D12MA::ALLOCATOR_DESC, D3D12MA::DEFRAGMENTATION_DESC, D3D12MA::POOL_DESC, D3D12MA::VIRTUAL_ALLOCATION_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
- FreeAllocation() : D3D12MA::VirtualBlock
- FreeStatsString() : D3D12MA::Allocator, D3D12MA::VirtualBlock
-- g -
+- g -
- GetAlignment() : D3D12MA::Allocation
- GetAllocationInfo() : D3D12MA::VirtualBlock
- GetBudget() : D3D12MA::Allocator
@@ -170,7 +157,7 @@ - g -
-- h -
+- h -
- heap : D3D12MA::Allocation
- HeapFlags : D3D12MA::POOL_DESC
- HeapProperties : D3D12MA::POOL_DESC
@@ -179,7 +166,7 @@ - h -
-- i -
+- i -
- IsCacheCoherentUMA() : D3D12MA::Allocator
- IsEmpty() : D3D12MA::VirtualBlock
- IsGPUUploadHeapSupported() : D3D12MA::Allocator
@@ -187,12 +174,12 @@ - i -
-- l -
+- l -
- list : D3D12MA::Allocation
-- m -
+- m -
- m_Committed : D3D12MA::Allocation
- m_Heap : D3D12MA::Allocation
- m_Placed : D3D12MA::Allocation
@@ -206,18 +193,18 @@ - m -
-- n -
+- n -
- next : D3D12MA::Allocation
-- o -
+- o -
- Offset : D3D12MA::VIRTUAL_ALLOCATION_INFO
- Operation : D3D12MA::DEFRAGMENTATION_MOVE
-- p -
+- p -
- pAdapter : D3D12MA::ALLOCATOR_DESC
- pAllocate : D3D12MA::ALLOCATION_CALLBACKS
- pAllocationCallbacks : D3D12MA::ALLOCATOR_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
@@ -233,12 +220,12 @@ - p -
-- r -
+- r -
- ResidencyPriority : D3D12MA::POOL_DESC
-- s -
+- s -
- SetAllocationPrivateData() : D3D12MA::VirtualBlock
- SetCurrentFrameIndex() : D3D12MA::Allocator
- SetName() : D3D12MA::Allocation, D3D12MA::Pool
@@ -249,12 +236,12 @@ - s -
-- t -
+- t -
- Total : D3D12MA::TotalStatistics
-- u -
+- u -
- UnusedRangeCount : D3D12MA::DetailedStatistics
- UnusedRangeSizeMax : D3D12MA::DetailedStatistics
- UnusedRangeSizeMin : D3D12MA::DetailedStatistics
@@ -263,7 +250,7 @@ - u -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html
index 23515d8..8f38cf0 100644
--- a/docs/html/functions_func.html
+++ b/docs/html/functions_func.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members - Functions
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all functions with links to the classes they belong to:
-- a -
+- a -
- Allocate() : D3D12MA::VirtualBlock
- AllocateMemory() : D3D12MA::Allocator
-- b -
+- b -
- BeginDefragmentation() : D3D12MA::Allocator, D3D12MA::Pool
- BeginPass() : D3D12MA::DefragmentationContext
- BuildStatsString() : D3D12MA::Allocator, D3D12MA::VirtualBlock
-- c -
+- c -
- CalculateStatistics() : D3D12MA::Allocator, D3D12MA::Pool, D3D12MA::VirtualBlock
- CALLOCATION_DESC() : D3D12MA::CALLOCATION_DESC
- Clear() : D3D12MA::VirtualBlock
@@ -116,18 +103,18 @@ - c -
-- e -
+- e -
- EndPass() : D3D12MA::DefragmentationContext
-- f -
+- f -
- FreeAllocation() : D3D12MA::VirtualBlock
- FreeStatsString() : D3D12MA::Allocator, D3D12MA::VirtualBlock
-- g -
+- g -
- GetAlignment() : D3D12MA::Allocation
- GetAllocationInfo() : D3D12MA::VirtualBlock
- GetBudget() : D3D12MA::Allocator
@@ -145,7 +132,7 @@ - g -
-- i -
+- i -
- IsCacheCoherentUMA() : D3D12MA::Allocator
- IsEmpty() : D3D12MA::VirtualBlock
- IsGPUUploadHeapSupported() : D3D12MA::Allocator
@@ -153,7 +140,7 @@ - i -
-- s -
+- s -
- SetAllocationPrivateData() : D3D12MA::VirtualBlock
- SetCurrentFrameIndex() : D3D12MA::Allocator
- SetName() : D3D12MA::Allocation, D3D12MA::Pool
@@ -163,7 +150,7 @@ - s -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions_rela.html b/docs/html/functions_rela.html
index b9d0728..f21eddd 100644
--- a/docs/html/functions_rela.html
+++ b/docs/html/functions_rela.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members - Related Symbols
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions_vars.html b/docs/html/functions_vars.html
index f63ab83..fe4ed5f 100644
--- a/docs/html/functions_vars.html
+++ b/docs/html/functions_vars.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members - Variables
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all variables with links to the classes they belong to:
-- a -
+- a -
- Alignment : D3D12MA::VIRTUAL_ALLOCATION_DESC
- AllocationBytes : D3D12MA::Statistics
- AllocationCount : D3D12MA::Statistics
@@ -98,7 +85,7 @@ - a -
-- b -
+- b -
- block : D3D12MA::Allocation
- BlockBytes : D3D12MA::Statistics
- BlockCount : D3D12MA::Statistics
@@ -109,22 +96,22 @@ - b -
-- c -
+- c -
- CustomPool : D3D12MA::ALLOCATION_DESC
-- e -
+- e -
- ExtraHeapFlags : D3D12MA::ALLOCATION_DESC
-- f -
+- f -
- Flags : D3D12MA::ALLOCATION_DESC, D3D12MA::ALLOCATOR_DESC, D3D12MA::DEFRAGMENTATION_DESC, D3D12MA::POOL_DESC, D3D12MA::VIRTUAL_ALLOCATION_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
-- h -
+- h -
- heap : D3D12MA::Allocation
- HeapFlags : D3D12MA::POOL_DESC
- HeapProperties : D3D12MA::POOL_DESC
@@ -133,12 +120,12 @@ - h -
-- l -
+- l -
- list : D3D12MA::Allocation
-- m -
+- m -
- m_Committed : D3D12MA::Allocation
- m_Heap : D3D12MA::Allocation
- m_Placed : D3D12MA::Allocation
@@ -152,18 +139,18 @@ - m -
-- n -
+- n -
- next : D3D12MA::Allocation
-- o -
+- o -
- Offset : D3D12MA::VIRTUAL_ALLOCATION_INFO
- Operation : D3D12MA::DEFRAGMENTATION_MOVE
-- p -
+- p -
- pAdapter : D3D12MA::ALLOCATOR_DESC
- pAllocate : D3D12MA::ALLOCATION_CALLBACKS
- pAllocationCallbacks : D3D12MA::ALLOCATOR_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
@@ -179,23 +166,23 @@ - p -
-- r -
+- r -
- ResidencyPriority : D3D12MA::POOL_DESC
-- s -
+- s -
- Size : D3D12MA::VIRTUAL_ALLOCATION_DESC, D3D12MA::VIRTUAL_ALLOCATION_INFO, D3D12MA::VIRTUAL_BLOCK_DESC
- Stats : D3D12MA::Budget, D3D12MA::DetailedStatistics
-- t -
+- t -
- Total : D3D12MA::TotalStatistics
-- u -
+- u -
- UnusedRangeCount : D3D12MA::DetailedStatistics
- UnusedRangeSizeMax : D3D12MA::DetailedStatistics
- UnusedRangeSizeMin : D3D12MA::DetailedStatistics
@@ -204,7 +191,7 @@ - u -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/general_considerations.html b/docs/html/general_considerations.html
index ef3888a..05a30ff 100644
--- a/docs/html/general_considerations.html
+++ b/docs/html/general_considerations.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: General considerations
-
-
@@ -33,33 +31,22 @@
-
+
-
- General considerations
+ General considerations
-
+
Thread safety
-- The library has no global state, so separate D3D12MA::Allocator objects can be used independently. In typical applications there should be no need to create multiple such objects though - one per
ID3D12Device is enough.
+- The library has no global state, so separate D3D12MA::Allocator objects can be used independently. In typical applications there should be no need to create multiple such objects though - one per ID3D12Device is enough.
- All calls to methods of D3D12MA::Allocator class are safe to be made from multiple threads simultaneously because they are synchronized internally when needed.
- When the allocator is created with D3D12MA::ALLOCATOR_FLAG_SINGLETHREADED, calls to methods of D3D12MA::Allocator class must be made from a single thread or synchronized by the user. Using this flag may improve performance.
- D3D12MA::VirtualBlock is not safe to be used from multiple threads simultaneously.
-
+
Versioning and compatibility
The library uses Semantic Versioning, which means version numbers follow convention: Major.Minor.Patch (e.g. 2.3.0), where:
@@ -109,13 +96,13 @@ <
All changes between official releases are documented in file "CHANGELOG.md".
- Warning
- Backward compatiblity is considered on the level of C++ source code, not binary linkage. Adding new members to existing structures is treated as backward compatible if initializing the new members to binary zero results in the old behavior. You should always fully initialize all library structures to zeros and not rely on their exact binary size.
-
+
Features not supported
Features deliberately excluded from the scope of this library:
- Descriptor allocation. Although also called "heaps", objects that represent descriptors are separate part of the D3D12 API from buffers and textures. You can still use Virtual allocator to manage descriptors and their ranges inside a descriptor heap.
- Support for reserved (tiled) resources. We don't recommend using them. For more information, see [1].
-- Support for
ID3D12Device::Evict and MakeResident. We don't recommend using them. You can call them on the D3D12 objects manually. Plese keep in mind, however, that eviction happens on the level of entire ID3D12Heap memory blocks and not individual buffers or textures which may be placed inside them.
+- Support for ID3D12Device::Evict and MakeResident. We don't recommend using them. You can call them on the D3D12 objects manually. Plese keep in mind, however, that eviction happens on the level of entire ID3D12Heap memory blocks and not individual buffers or textures which may be placed inside them.
- Handling CPU memory allocation failures. When dynamically creating small C++ objects in CPU memory (not the GPU memory), allocation failures are not handled gracefully, because that would complicate code significantly and is usually not needed in desktop PC applications anyway. Success of an allocation is just checked with an assert.
- Code free of any compiler warnings. There are many preprocessor macros that make some variables unused, function parameters unreferenced, or conditional expressions constant in some configurations. The code of this library should not be bigger or more complicated just to silence these warnings. It is recommended to disable such warnings instead.
- This is a C++ library. Bindings or ports to any other programming languages are welcome as external projects but are not going to be included into this repository.
@@ -125,7 +112,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/globals.html b/docs/html/globals.html
index 00f8dbd..27989c1 100644
--- a/docs/html/globals.html
+++ b/docs/html/globals.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: File Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/globals_defs.html b/docs/html/globals_defs.html
index feb2e5c..00db10d 100644
--- a/docs/html/globals_defs.html
+++ b/docs/html/globals_defs.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: File Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html
index 292f556..5785855 100644
--- a/docs/html/hierarchy.html
+++ b/docs/html/hierarchy.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Hierarchy
-
-
@@ -33,35 +31,24 @@
-
+
-
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 12]
CD3D12MA::ALLOCATION_CALLBACKS Custom callbacks to CPU memory allocation functions ▼CD3D12MA::ALLOCATION_DESC Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource CD3D12MA::ALLOCATION_DESC Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource CD3D12MA::CALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure CD3D12MA::ALLOCATOR_DESC Parameters of created Allocator object. To be used with CreateAllocator() CD3D12MA::Budget Statistics of current memory usage and available budget for a specific memory segment group CD3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Parameters for incremental defragmentation steps CD3D12MA::DEFRAGMENTATION_STATS Statistics returned for defragmentation process by function DefragmentationContext::GetStats() CD3D12MA::DetailedStatistics More detailed statistics than D3D12MA::Statistics ▼CIUnknownImpl CIUnknownImpl CD3D12MA::Allocation Represents single memory allocation CD3D12MA::Allocator Represents main object of this library initialized for particular ID3D12Device CD3D12MA::Allocator Represents main object of this library initialized for particular ID3D12Device CD3D12MA::DefragmentationContext Represents defragmentation process in progress CD3D12MA::Pool Custom memory pool CD3D12MA::VirtualBlock Represents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory ▼CD3D12MA::POOL_DESC Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool CD3D12MA::POOL_DESC Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool CD3D12MA::CPOOL_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure CD3D12MA::Statistics Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total CD3D12MA::TotalStatistics General statistics from current state of the allocator - total memory usage across all memory heaps and segments ▼CD3D12MA::VIRTUAL_ALLOCATION_DESC Parameters of created virtual allocation to be passed to VirtualBlock::Allocate() CD3D12MA::VIRTUAL_ALLOCATION_DESC Parameters of created virtual allocation to be passed to VirtualBlock::Allocate() CD3D12MA::CVIRTUAL_ALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure CD3D12MA::VIRTUAL_ALLOCATION_INFO Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo() ▼CD3D12MA::VIRTUAL_BLOCK_DESC Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock() CD3D12MA::VIRTUAL_BLOCK_DESC Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock() CD3D12MA::CVIRTUAL_BLOCK_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure CD3D12MA::VirtualAllocation Represents single memory allocation done inside VirtualBlock
@@ -120,7 +107,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/index.html b/docs/html/index.html
index e005026..d7434ba 100644
--- a/docs/html/index.html
+++ b/docs/html/index.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12 Memory Allocator
-
-
@@ -33,35 +31,24 @@
-
+
-
D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved.
License: MIT
-Documentation of all members: D3D12MemAlloc.h
-
+
Documentation of all members: D3D12MemAlloc.h
+
Table of contents
- Frequently asked questions
@@ -131,10 +118,10 @@
-
+
Web links
-- Direct3D 12 Memory Allocator at GPUOpen.com - product page
+- Direct3D 12 Memory Allocator at GPUOpen.com - product page
- GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com - source code repository
@@ -142,7 +129,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/linear_algorithm.html b/docs/html/linear_algorithm.html
index 25d5301..0bc59b0 100644
--- a/docs/html/linear_algorithm.html
+++ b/docs/html/linear_algorithm.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Linear allocation algorithm
-
-
@@ -33,33 +31,22 @@
-
+
-
- Linear allocation algorithm
+ Linear allocation algorithm
Each D3D12 memory block managed by this library has accompanying metadata that keeps track of used and unused regions. By default, the metadata structure and algorithm tries to find best place for new allocations among free regions to optimize memory usage. This way you can allocate and free objects in any order.
@@ -96,17 +83,17 @@
Sometimes there is a need to use simpler, linear allocation algorithm. You can create custom pool that uses such algorithm by adding flag D3D12MA::POOL_FLAG_ALGORITHM_LINEAR to D3D12MA::POOL_DESC::Flags while creating D3D12MA::Pool object. Then an alternative metadata management is used. It always creates new allocations after last one and doesn't reuse free regions after allocations freed in the middle. It results in better allocation performance and less memory consumed by metadata.
With this one flag, you can create a custom pool that can be used in many ways: free-at-once, stack, double stack, and ring buffer. See below for details. You don't need to specify explicitly which of these options you are going to use - it is detected automatically.
-
+
Free-at-once
-
In a pool that uses linear algorithm, you still need to free all the allocations individually by calling allocation->Release(). You can free them in any order. New allocations are always made after last one - free space in the middle is not reused. However, when you release all the allocation and the pool becomes empty, allocation starts from the beginning again. This way you can use linear algorithm to speed up creation of allocations that you are going to release all at once.
+In a pool that uses linear algorithm, you still need to free all the allocations individually by calling allocation->Release(). You can free them in any order. New allocations are always made after last one - free space in the middle is not reused. However, when you release all the allocation and the pool becomes empty, allocation starts from the beginning again. This way you can use linear algorithm to speed up creation of allocations that you are going to release all at once.
This mode is also available for pools created with D3D12MA::POOL_DESC::MaxBlockCount value that allows multiple memory blocks.
-
+
Stack
When you free an allocation that was created last, its space can be reused. Thanks to this, if you always release allocations in the order opposite to their creation (LIFO - Last In First Out), you can achieve behavior of a stack.
This mode is also available for pools created with D3D12MA::POOL_DESC::MaxBlockCount value that allows multiple memory blocks.
-
+
Double stack
The space reserved by a custom pool with linear algorithm may be used by two stacks:
@@ -116,20 +103,20 @@
To make allocation from the upper stack, add flag D3D12MA::ALLOCATION_FLAG_UPPER_ADDRESS to D3D12MA::ALLOCATION_DESC::Flags.
Double stack is available only in pools with one memory block - D3D12MA::POOL_DESC::MaxBlockCount must be 1. Otherwise behavior is undefined.
-When the two stacks' ends meet so there is not enough space between them for a new allocation, such allocation fails with usual E_OUTOFMEMORY error.
-
+
When the two stacks' ends meet so there is not enough space between them for a new allocation, such allocation fails with usual E_OUTOFMEMORY error.
+
Ring buffer
When you free some allocations from the beginning and there is not enough free space for a new one at the end of a pool, allocator's "cursor" wraps around to the beginning and starts allocation there. Thanks to this, if you always release allocations in the same order as you created them (FIFO - First In First Out), you can achieve behavior of a ring buffer / queue.
Ring buffer is available only in pools with one memory block - D3D12MA::POOL_DESC::MaxBlockCount must be 1. Otherwise behavior is undefined.
-
+
Additional considerations
Linear algorithm can also be used with Virtual allocator. See flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/menu.js b/docs/html/menu.js
index 0fd1e99..15f9c52 100644
--- a/docs/html/menu.js
+++ b/docs/html/menu.js
@@ -49,7 +49,7 @@ function initMenu(relPath,searchEnabled,serverSide,searchPage,search,treeview) {
searchBoxHtml=''+
''+
'');
$('#main-nav').append(makeTree(menudata,relPath));
$('#main-nav').children(':first').addClass('sm sm-dox').attr('id','main-menu');
- if (searchBoxHtml) {
- $('#main-menu').append('');
- }
+ $('#main-menu').append('');
const $mainMenuState = $('#main-menu-state');
let prevWidth = 0;
if ($mainMenuState.length) {
diff --git a/docs/html/namespace_d3_d12_m_a.html b/docs/html/namespace_d3_d12_m_a.html
index e770fdc..b4ae5de 100644
--- a/docs/html/namespace_d3_d12_m_a.html
+++ b/docs/html/namespace_d3_d12_m_a.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA Namespace Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
-
+
Classes
class Allocation class Allocation Represents single memory allocation. More...
struct ALLOCATION_CALLBACKS struct ALLOCATION_CALLBACKS Custom callbacks to CPU memory allocation functions. More...
struct ALLOCATION_DESC struct ALLOCATION_DESC Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource. More...
class Allocator Represents main object of this library initialized for particular ID3D12Device. More...
struct ALLOCATOR_DESC class Allocator Represents main object of this library initialized for particular ID3D12Device. More...
struct ALLOCATOR_DESC Parameters of created Allocator object. To be used with CreateAllocator(). More...
struct Budget struct Budget Statistics of current memory usage and available budget for a specific memory segment group. More...
struct CALLOCATION_DESC struct CALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure. More...
struct CPOOL_DESC struct CPOOL_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure. More...
struct CVIRTUAL_ALLOCATION_DESC struct CVIRTUAL_ALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure. More...
struct CVIRTUAL_BLOCK_DESC struct CVIRTUAL_BLOCK_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure. More...
struct DEFRAGMENTATION_DESC struct DEFRAGMENTATION_DESC Parameters for defragmentation. More...
struct DEFRAGMENTATION_MOVE struct DEFRAGMENTATION_MOVE Single move of an allocation to be done for defragmentation. More...
struct DEFRAGMENTATION_PASS_MOVE_INFO struct DEFRAGMENTATION_PASS_MOVE_INFO Parameters for incremental defragmentation steps. More...
struct DEFRAGMENTATION_STATS struct DEFRAGMENTATION_STATS Statistics returned for defragmentation process by function DefragmentationContext::GetStats(). More...
class DefragmentationContext class DefragmentationContext Represents defragmentation process in progress. More...
struct DetailedStatistics struct DetailedStatistics More detailed statistics than D3D12MA::Statistics. More...
class Pool class Pool Custom memory pool. More...
struct POOL_DESC struct POOL_DESC Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool. More...
struct Statistics struct Statistics Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total. More...
struct TotalStatistics struct TotalStatistics General statistics from current state of the allocator - total memory usage across all memory heaps and segments. More...
struct VIRTUAL_ALLOCATION_DESC struct VIRTUAL_ALLOCATION_DESC Parameters of created virtual allocation to be passed to VirtualBlock::Allocate(). More...
struct VIRTUAL_ALLOCATION_INFO struct VIRTUAL_ALLOCATION_INFO Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo(). More...
struct VIRTUAL_BLOCK_DESC struct VIRTUAL_BLOCK_DESC Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock(). More...
struct VirtualAllocation struct VirtualAllocation Represents single memory allocation done inside VirtualBlock. More...
class VirtualBlock class VirtualBlock Represents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory. More...
-
+
Typedefs
typedef UINT64 AllocHandle Unique identifier of single allocation done inside the memory heap.
using ALLOCATE_FUNC_PTR = void* (*)(size_t Size, size_t Alignment, void* pPrivateData) Pointer to custom callback function that allocates CPU memory.
using FREE_FUNC_PTR = void (*)(void* pMemory, void* pPrivateData) Pointer to custom callback function that deallocates CPU memory.
-
+
Enumerations
enum ALLOCATION_FLAGS {
ALLOCATION_FLAG_NONE = 0
@@ -203,20 +162,17 @@
} Bit flags to be used with ALLOCATION_DESC::Flags. More...
enum DEFRAGMENTATION_FLAGS { DEFRAGMENTATION_FLAG_ALGORITHM_FAST = 0x1
, DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED = 0x2
, DEFRAGMENTATION_FLAG_ALGORITHM_FULL = 0x4
, DEFRAGMENTATION_FLAG_ALGORITHM_MASK
} Flags to be passed as DEFRAGMENTATION_DESC::Flags. More...
enum DEFRAGMENTATION_MOVE_OPERATION { DEFRAGMENTATION_MOVE_OPERATION_COPY = 0
, DEFRAGMENTATION_MOVE_OPERATION_IGNORE = 1
, DEFRAGMENTATION_MOVE_OPERATION_DESTROY = 2
} Operation performed on single defragmentation move. More...
enum POOL_FLAGS {
POOL_FLAG_NONE = 0
, POOL_FLAG_ALGORITHM_LINEAR = 0x1
@@ -227,7 +183,6 @@
} Bit flags to be used with POOL_DESC::Flags. More...
enum ALLOCATOR_FLAGS {
ALLOCATOR_FLAG_NONE = 0
, ALLOCATOR_FLAG_SINGLETHREADED = 0x1
@@ -239,13 +194,11 @@
} Bit flags to be used with ALLOCATOR_DESC::Flags. More...
enum VIRTUAL_BLOCK_FLAGS { VIRTUAL_BLOCK_FLAG_NONE = 0
, VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR = POOL_FLAG_ALGORITHM_LINEAR
, VIRTUAL_BLOCK_FLAG_ALGORITHM_MASK = POOL_FLAG_ALGORITHM_MASK
} Bit flags to be used with VIRTUAL_BLOCK_DESC::Flags. More...
enum VIRTUAL_ALLOCATION_FLAGS {
VIRTUAL_ALLOCATION_FLAG_NONE = 0
, VIRTUAL_ALLOCATION_FLAG_UPPER_ADDRESS = ALLOCATION_FLAG_UPPER_ADDRESS
@@ -257,18 +210,15 @@
} Bit flags to be used with VIRTUAL_ALLOCATION_DESC::Flags. More...
-
+
Functions
D3D12MA_API HRESULT CreateAllocator (const ALLOCATOR_DESC *pDesc, Allocator **ppAllocator) Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
D3D12MA_API HRESULT CreateVirtualBlock (const VIRTUAL_BLOCK_DESC *pDesc, VirtualBlock **ppVirtualBlock) Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
-Typedef Documentation
+Typedef Documentation
◆ ALLOCATE_FUNC_PTR
@@ -314,11 +264,11 @@
Pointer to custom callback function that deallocates CPU memory.
-pMemory = null should be accepted and ignored.
+pMemory = null should be accepted and ignored.
-Enumeration Type Documentation
+Enumeration Type Documentation
◆ ALLOCATION_FLAGS
@@ -338,21 +288,21 @@ ALLOCATION_FLAG_COMMITTED Set this flag if the allocation should have its own dedicated memory allocation (committed resource with implicit heap).
Use it for special, big resources, like fullscreen textures used as render targets.
-- When used with functions like D3D12MA::Allocator::CreateResource, it will use
ID3D12Device::CreateCommittedResource, so the created allocation will contain a resource (D3D12MA::Allocation::GetResource() != NULL) but will not have a heap (D3D12MA::Allocation::GetHeap() == NULL), as the heap is implicit.
-- When used with raw memory allocation like D3D12MA::Allocator::AllocateMemory, it will use
ID3D12Device::CreateHeap, so the created allocation will contain a heap (D3D12MA::Allocation::GetHeap() != NULL) and its offset will always be 0.
+- When used with functions like D3D12MA::Allocator::CreateResource, it will use ID3D12Device::CreateCommittedResource, so the created allocation will contain a resource (D3D12MA::Allocation::GetResource() != NULL) but will not have a heap (D3D12MA::Allocation::GetHeap() == NULL), as the heap is implicit.
+- When used with raw memory allocation like D3D12MA::Allocator::AllocateMemory, it will use ID3D12Device::CreateHeap, so the created allocation will contain a heap (D3D12MA::Allocation::GetHeap() != NULL) and its offset will always be 0.
ALLOCATION_FLAG_NEVER_ALLOCATE Set this flag to only try to allocate from existing memory heaps and never create new such heap.
-If new allocation cannot be placed in any of the existing heaps, allocation fails with E_OUTOFMEMORY error.
+If new allocation cannot be placed in any of the existing heaps, allocation fails with E_OUTOFMEMORY error.
You should not use D3D12MA::ALLOCATION_FLAG_COMMITTED and D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE at the same time. It makes no sense.
ALLOCATION_FLAG_WITHIN_BUDGET Create allocation only if additional memory required for it, if any, won't exceed memory budget. Otherwise return E_OUTOFMEMORY.
+ALLOCATION_FLAG_WITHIN_BUDGET Create allocation only if additional memory required for it, if any, won't exceed memory budget. Otherwise return E_OUTOFMEMORY.
ALLOCATION_FLAG_UPPER_ADDRESS Allocation will be created from upper stack in a double stack pool.
This flag is only allowed for custom pools created with POOL_FLAG_ALGORITHM_LINEAR flag.
ALLOCATION_FLAG_CAN_ALIAS Set this flag if the allocated memory will have aliasing resources.
-Use this when calling D3D12MA::Allocator::CreateResource() and similar to guarantee creation of explicit heap for desired allocation and prevent it from using CreateCommittedResource, so that new allocation object will always have allocation->GetHeap() != NULL.
+Use this when calling D3D12MA::Allocator::CreateResource() and similar to guarantee creation of explicit heap for desired allocation and prevent it from using CreateCommittedResource, so that new allocation object will always have allocation->GetHeap() != NULL.
ALLOCATION_FLAG_STRATEGY_MIN_MEMORY Allocation strategy that chooses smallest possible free range for the allocation to minimize memory usage and fragmentation, possibly at the expense of allocation time.
ALLOCATION_FLAG_STRATEGY_FIRST_FIT Alias to ALLOCATION_FLAG_STRATEGY_MIN_TIME.
ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
+ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
ALLOCATOR_FLAG_ALWAYS_COMMITTED Every allocation will be created as a committed resource - will have its own memory block.
Affects both default pools and custom pools. To be used for debugging purposes only. There is also an equivalent flag for custom pools: D3D12MA::POOL_FLAG_ALWAYS_COMMITTED.
ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED Heaps created for the default pools will be created with flag D3D12_HEAP_FLAG_CREATE_NOT_ZEROED, allowing for their memory to be not zeroed by the system if possible, which can speed up allocation.
+ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED Heaps created for the default pools will be created with flag D3D12_HEAP_FLAG_CREATE_NOT_ZEROED, allowing for their memory to be not zeroed by the system if possible, which can speed up allocation.
Only affects default pools. To use the flag with Custom memory pools, you need to add it manually:
poolDesc.heapFlags |= D3D12_HEAP_FLAG_CREATE_NOT_ZEROED;
-Only avaiable if ID3D12Device8 is present. Otherwise, the flag is ignored.
+Only avaiable if ID3D12Device8 is present. Otherwise, the flag is ignored.
ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED Optimization, allocate MSAA textures as committed resources always.
Specify this flag to create MSAA textures with implicit heaps, as if they were created with flag D3D12MA::ALLOCATION_FLAG_COMMITTED. Usage of this flags enables all default pools to create its heaps on smaller alignment not suitable for MSAA textures.
@@ -424,11 +374,11 @@
Enumerator DEFRAGMENTATION_FLAG_ALGORITHM_FAST Use simple but fast algorithm for defragmentation. May not achieve best results but will require least time to compute and least allocations to copy.
DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED Default defragmentation algorithm, applied also when no ALGORITHM flag is specified. Offers a balance between defragmentation quality and the amount of allocations and bytes that need to be moved.
+DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED Default defragmentation algorithm, applied also when no ALGORITHM flag is specified. Offers a balance between defragmentation quality and the amount of allocations and bytes that need to be moved.
DEFRAGMENTATION_FLAG_ALGORITHM_FULL Perform full defragmentation of memory. Can result in notably more time to compute and allocations to copy, but will achieve best memory packing.
DEFRAGMENTATION_FLAG_ALGORITHM_MASK A bit mask to extract only ALGORITHM bits from entire set of flags.
+DEFRAGMENTATION_FLAG_ALGORITHM_MASK A bit mask to extract only ALGORITHM bits from entire set of flags.
-Enumerator DEFRAGMENTATION_MOVE_OPERATION_COPY Resource has been recreated at pDstTmpAllocation, data has been copied, old resource has been destroyed. pSrcAllocation will be changed to point to the new place. This is the default value set by DefragmentationContext::BeginPass().
+Enumerator DEFRAGMENTATION_MOVE_OPERATION_COPY Resource has been recreated at pDstTmpAllocation, data has been copied, old resource has been destroyed. pSrcAllocation will be changed to point to the new place. This is the default value set by DefragmentationContext::BeginPass().
DEFRAGMENTATION_MOVE_OPERATION_IGNORE Set this value if you cannot move the allocation. New place reserved at pDstTmpAllocation will be freed. pSrcAllocation will remain unchanged.
+DEFRAGMENTATION_MOVE_OPERATION_IGNORE Set this value if you cannot move the allocation. New place reserved at pDstTmpAllocation will be freed. pSrcAllocation will remain unchanged.
DEFRAGMENTATION_MOVE_OPERATION_DESTROY Set this value if you decide to abandon the allocation and you destroyed the resource. New place reserved pDstTmpAllocation will be freed, along with pSrcAllocation.
+DEFRAGMENTATION_MOVE_OPERATION_DESTROY Set this value if you decide to abandon the allocation and you destroyed the resource. New place reserved pDstTmpAllocation will be freed, along with pSrcAllocation.
VIRTUAL_ALLOCATION_FLAG_STRATEGY_MIN_OFFSET
Allocation strategy that chooses always the lowest offset in available space. This is not the most efficient strategy but achieves highly packed data.
VIRTUAL_ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
+VIRTUAL_ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
These strategy flags are binary compatible with equivalent flags in ALLOCATION_FLAGS.
Function Documentation
+Function Documentation
◆ CreateAllocator()
@@ -567,8 +517,8 @@
-Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
-You normally only need to call it once and keep a single Allocator object for your ID3D12Device.
+Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
+You normally only need to call it once and keep a single Allocator object for your ID3D12Device.
@@ -591,7 +541,7 @@
-Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
+Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
Note you don't need to create D3D12MA::Allocator to use virtual blocks.
@@ -599,7 +549,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers.html b/docs/html/namespacemembers.html
index 6881ab0..4cadc29 100644
--- a/docs/html/namespacemembers.html
+++ b/docs/html/namespacemembers.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all namespace members with links to the namespace documentation for each member:
-- a -
+- a -
- ALLOCATE_FUNC_PTR : D3D12MA
- ALLOCATION_FLAG_CAN_ALIAS : D3D12MA
- ALLOCATION_FLAG_COMMITTED : D3D12MA
@@ -112,13 +99,13 @@ - a -
-- c -
+- c -
-- d -
+- d -
- DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FAST : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FULL : D3D12MA
@@ -131,12 +118,12 @@ - d -
-- f -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_enum.html b/docs/html/namespacemembers_enum.html
index 5723a6b..90ffd55 100644
--- a/docs/html/namespacemembers_enum.html
+++ b/docs/html/namespacemembers_enum.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_eval.html b/docs/html/namespacemembers_eval.html
index 365527c..4a4922b 100644
--- a/docs/html/namespacemembers_eval.html
+++ b/docs/html/namespacemembers_eval.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all namespace enum values with links to the namespace documentation for each enum value:
-- a -
+- a -
- ALLOCATION_FLAG_CAN_ALIAS : D3D12MA
- ALLOCATION_FLAG_COMMITTED : D3D12MA
- ALLOCATION_FLAG_NEVER_ALLOCATE : D3D12MA
@@ -108,7 +95,7 @@ - a -
-- d -
+- d -
- DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FAST : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FULL : D3D12MA
@@ -119,7 +106,7 @@ - d -
-- p -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_func.html b/docs/html/namespacemembers_func.html
index 02a9cdd..c8a70c7 100644
--- a/docs/html/namespacemembers_func.html
+++ b/docs/html/namespacemembers_func.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_type.html b/docs/html/namespacemembers_type.html
index b56e9c4..e9561e2 100644
--- a/docs/html/namespacemembers_type.html
+++ b/docs/html/namespacemembers_type.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespaces.html b/docs/html/namespaces.html
index fe8ddce..acd9768 100644
--- a/docs/html/namespaces.html
+++ b/docs/html/namespaces.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace List
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/navtree.css b/docs/html/navtree.css
index 69211d4..0ea3a07 100644
--- a/docs/html/navtree.css
+++ b/docs/html/navtree.css
@@ -11,8 +11,8 @@
#nav-tree li {
white-space:nowrap;
- margin:0px;
- padding:0px;
+ margin:0;
+ padding:0;
}
#nav-tree .plus {
@@ -20,15 +20,10 @@
}
#nav-tree .selected {
- background-image: url('tab_a.png');
- background-repeat:repeat-x;
- color: var(--nav-text-active-color);
- text-shadow: var(--nav-text-active-shadow);
-}
-
-#nav-tree .selected .arrow {
- color: var(--nav-arrow-selected-color);
- text-shadow: none;
+ position: relative;
+ background-color: var(--nav-menu-active-bg);
+ border-radius: 0 6px 6px 0;
+ /*margin-right: 5px;*/
}
#nav-tree img {
@@ -48,6 +43,7 @@
margin:0px;
padding:0px;
font: 12px var(--font-family-nav);
+ line-height: 22px;
}
#nav-tree .label a {
@@ -56,7 +52,7 @@
#nav-tree .selected a {
text-decoration:none;
- color:var(--nav-text-active-color);
+ color:var(--page-link-color);
}
#nav-tree .children_ul {
@@ -65,8 +61,9 @@
}
#nav-tree .item {
- margin:0px;
- padding:0px;
+ margin: 0 6px 0 -5px;
+ padding: 0 0 0 5px;
+ height: 22px;
}
#nav-tree {
@@ -89,7 +86,6 @@
display:block;
position: absolute;
left: 0px;
- width: $width;
overflow : hidden;
}
@@ -98,15 +94,31 @@
}
.ui-resizable-e {
- background-image:var(--nav-splitbar-image);
- background-size:100%;
- background-repeat:repeat-y;
- background-attachment: scroll;
- cursor:ew-resize;
+ transition: opacity 0.5s ease;
+ background-color: var(--nav-splitbar-bg-color);
+ opacity:0;
+ cursor:col-resize;
height:100%;
right:0;
top:0;
width:6px;
+ position: relative;
+}
+
+.ui-resizable-e:after {
+ content: '';
+ display: block;
+ top: 50%;
+ left: 1px;
+ width: 2px;
+ height: 15px;
+ border-left: 1px solid var(--nav-splitbar-handle-color);
+ border-right: 1px solid var(--nav-splitbar-handle-color);
+ position: absolute;
+}
+
+.ui-resizable-e:hover {
+ opacity: 1;
}
.ui-resizable-handle {
@@ -121,24 +133,97 @@
}
#nav-tree {
- background-repeat:repeat-x;
background-color: var(--nav-background-color);
-webkit-overflow-scrolling : touch; /* iOS 5+ */
+ scrollbar-width: thin;
+ border-right: 1px solid var(--nav-border-color);
+ padding-left: 5px;
}
#nav-sync {
position:absolute;
- top:5px;
- right:24px;
- z-index:0;
+ top:0px;
+ right:0px;
+ z-index:1;
}
#nav-sync img {
opacity:0.3;
}
-#nav-sync img:hover {
- opacity:0.9;
+div.nav-sync-icon {
+ position: relative;
+ width: 24px;
+ height: 17px;
+ left: -6px;
+ top: -1px;
+ opacity: 0.7;
+ display: inline-block;
+ background-color: var(--sync-icon-background-color);
+ border: 1px solid var(--sync-icon-border-color);
+ box-sizing: content-box;
+}
+
+div.nav-sync-icon:hover {
+ background-color: var(--sync-icon-selected-background-color);
+ opacity: 1.0;
+}
+
+div.nav-sync-icon.active:after {
+ content: '';
+ background-color: var(--sync-icon-background-color);
+ border-top: 2px solid var(--sync-icon-color);
+ position: absolute;
+ width: 16px;
+ height: 0px;
+ top: 7px;
+ left: 4px;
+}
+
+div.nav-sync-icon.active:hover:after {
+ border-top: 2px solid var(--sync-icon-selected-color);
+}
+
+span.sync-icon-left {
+ position: absolute;
+ padding: 0;
+ margin: 0;
+ top: 3px;
+ left: 4px;
+ display: inline-block;
+ width: 8px;
+ height: 8px;
+ border-left: 2px solid var(--sync-icon-color);
+ border-top: 2px solid var(--sync-icon-color);
+ transform: rotate(-45deg);
+}
+
+span.sync-icon-right {
+ position: absolute;
+ padding: 0;
+ margin: 0;
+ top: 3px;
+ left: 10px;
+ display: inline-block;
+ width: 8px;
+ height: 8px;
+ border-right: 2px solid var(--sync-icon-color);
+ border-bottom: 2px solid var(--sync-icon-color);
+ transform: rotate(-45deg);
+}
+
+div.nav-sync-icon:hover span.sync-icon-left {
+ border-left: 2px solid var(--sync-icon-selected-color);
+ border-top: 2px solid var(--sync-icon-selected-color);
+}
+
+div.nav-sync-icon:hover span.sync-icon-right {
+ border-right: 2px solid var(--sync-icon-selected-color);
+ border-bottom: 2px solid var(--sync-icon-selected-color);
+}
+
+#nav-path ul {
+ border-top: 1px solid var(--nav-breadcrumb-separator-color);
}
@media print
@@ -147,3 +232,96 @@
div.ui-resizable-handle { display: none; position: relative; }
}
+/*---------------------------*/
+#container {
+ display: grid;
+ grid-template-columns: auto auto;
+ overflow: hidden;
+}
+
+#page-nav {
+ background: var(--nav-background-color);
+ display: block;
+ width: 250px;
+ box-sizing: content-box;
+ position: relative;
+ border-left: 1px solid var(--nav-border-color);
+}
+
+#page-nav-tree {
+ display: inline-block;
+}
+
+#page-nav-resize-handle {
+ transition: opacity 0.5s ease;
+ background-color: var(--nav-splitbar-bg-color);
+ opacity:0;
+ cursor:col-resize;
+ height:100%;
+ right:0;
+ top:0;
+ width:6px;
+ position: relative;
+ z-index: 1;
+ user-select: none;
+}
+
+#page-nav-resize-handle:after {
+ content: '';
+ display: block;
+ top: 50%;
+ left: 1px;
+ width: 2px;
+ height: 15px;
+ border-left: 1px solid var(--nav-splitbar-handle-color);
+ border-right: 1px solid var(--nav-splitbar-handle-color);
+ position: absolute;
+}
+
+#page-nav-resize-handle.dragging,
+#page-nav-resize-handle:hover {
+ opacity: 1;
+}
+
+#page-nav-contents {
+ padding: 0;
+ margin: 0;
+ display: block;
+ top: 0;
+ left: 0;
+ height: 100%;
+ width: 100%;
+ position: absolute;
+ overflow: auto;
+ scrollbar-width: thin;
+ -webkit-overflow-scrolling : touch; /* iOS 5+ */
+}
+
+ul.page-outline,
+ul.page-outline ul {
+ text-indent: 0;
+ list-style: none outside none;
+ padding: 0 0 0 4px;
+}
+
+ul.page-outline {
+ margin: 0 4px 4px 6px;
+}
+
+ul.page-outline div.item {
+ font: 12px var(--font-family-nav);
+ line-height: 22px;
+}
+
+ul.page-outline li {
+ white-space: nowrap;
+}
+
+ul.page-outline li.vis {
+ background-color: var(--nav-breadcrumb-active-bg);
+}
+
+#container.resizing {
+ cursor: col-resize;
+ user-select: none;
+}
diff --git a/docs/html/optimal_allocation.html b/docs/html/optimal_allocation.html
index 627471c..88f3e62 100644
--- a/docs/html/optimal_allocation.html
+++ b/docs/html/optimal_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Optimal resource allocation
-
-
@@ -33,33 +31,22 @@
-
+
-
- Optimal resource allocation
+ Optimal resource allocation
This library tries to automatically make optimal choices for the resources you create, so you don't need to care about them. There are some advanced features of Direct3D 12 that you may use to optimize your memory management. There are also some settings in D3D12MA that you may change to alter its default behavior. This page provides miscellaneous advice about features of D3D12 and D3D12MA that are non-essential, but may improve the stability or performance of your app.
-
+
Avoiding running out of memory
When trying to allocate more memory than available in the current heap (e.g., video memory on the graphics card, system memory), one of few bad things can happen:
-- The allocation (resource creation) function call can fail with
HRESULT value other than S_OK.
+- The allocation (resource creation) function call can fail with HRESULT value other than S_OK.
- The allocation may succeed, but take long time (even a significant fraction of a second).
- Some resources are automatically demoted from video memory to system memory, degrading the app performance.
- Even a crash of the entire graphics driver can happen, resulting in the D3D12 "device removal", which is usually catastrophic for the application.
@@ -113,34 +100,34 @@ Statistics of current memory usage and available budget for a specific memory segment group.Definition D3D12MemAlloc.h:474
UINT64 BudgetBytesEstimated amount of memory available to the program.Definition D3D12MemAlloc.h:497
UINT64 UsageBytesEstimated current memory usage of the program.Definition D3D12MemAlloc.h:486
-- Implementation detail
- DXGI interface offers function
IDXGIAdapter3::QueryVideoMemoryInfo that queries the current memory usage and budget. This library automatically makes use of it when available (when you use recent enough version of the DirectX SDK). If not, it falls back to estimating the usage and budget based on the total amount of the allocated memory and 80% of the full memory capacity, respectively.
+- Implementation detail
- DXGI interface offers function IDXGIAdapter3::QueryVideoMemoryInfo that queries the current memory usage and budget. This library automatically makes use of it when available (when you use recent enough version of the DirectX SDK). If not, it falls back to estimating the usage and budget based on the total amount of the allocated memory and 80% of the full memory capacity, respectively.
- Implementation detail
- Allocating large heaps and creating placed resources in them is one of the main features of this library. However, if allocating new such block would exceed the budget, it will automatically prefer creating the resource as committed to have exactly the right size, which can lower the chance of getting into trouble in case of over-commitment.
When creating non-essential resources, you can use D3D12MA::ALLOCATION_FLAG_WITHIN_BUDGET. Then, in case the allocation would exceed the budget, the library will return failure from the function without attempting to allocate the actual D3D12 memory.
-It may also be a good idea to support failed resource creation. For non-essential resources, when function D3D12MA::Allocator::CreateResource fails with a result other than S_OK, it is worth implementing some way of recovery instead of terminating or crashing the entire app.
-
+
It may also be a good idea to support failed resource creation. For non-essential resources, when function D3D12MA::Allocator::CreateResource fails with a result other than S_OK, it is worth implementing some way of recovery instead of terminating or crashing the entire app.
+
Allocation performance
Creating D3D12 resources (buffers and textures) can be a time-consuming operation. The duration can be unpredictable, spanning from a small fraction of a millisecond to a significant fraction of a second. Thus, it is recommended to allocate all the memory and create all the resources needed upfront rather than doing it during application runtime. For example, a video game can try to create its resources on startup or when loading a new level. Of course, is is not always possible. For example, open-world games may require loading and unloading some graphical assets in the background (often called "streaming").
-Creating and releasing D3D12 resources on a separate thread in the background may help. Both ID3D12Device and D3D12MA::Allocator objects are thread-safe, synchronized internally. However, cases were observed where resource creation calls like ID3D12Device::CreateCommittedResource were blocking other D3D12 calls like ExecuteCommandLists or Present somewhere inside the graphics driver, so hitches can happen even when using multithreading.
-The most expensive part is typically the allocation of a new D3D12 memory heap. This library tackles this problem by automatically allocating large heaps (64 MB by default) and creating resources as placed inside of them. When a new requested resource can be placed in a free space of an existing heap and doesn't require allocating a new heap, this operation is typically much faster, as it only requires creating a new ID3D12Resource object and not allocating new memory. This is the main benefit of using D3D12MA compared to the naive approach of using Direct3D 12 directly and creating each resource as committed with CreateCommittedResource, which would result in a separate allocation of an implicit heap every time.
-When a large number of small buffers needs to be created, the overhead of creating even just separate ID3D12Resource objects can be significant. It can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs. This library can also help with it. See section "Sub-allocating buffers" below.
+Creating and releasing D3D12 resources on a separate thread in the background may help. Both ID3D12Device and D3D12MA::Allocator objects are thread-safe, synchronized internally. However, cases were observed where resource creation calls like ID3D12Device::CreateCommittedResource were blocking other D3D12 calls like ExecuteCommandLists or Present somewhere inside the graphics driver, so hitches can happen even when using multithreading.
+The most expensive part is typically the allocation of a new D3D12 memory heap. This library tackles this problem by automatically allocating large heaps (64 MB by default) and creating resources as placed inside of them. When a new requested resource can be placed in a free space of an existing heap and doesn't require allocating a new heap, this operation is typically much faster, as it only requires creating a new ID3D12Resource object and not allocating new memory. This is the main benefit of using D3D12MA compared to the naive approach of using Direct3D 12 directly and creating each resource as committed with CreateCommittedResource, which would result in a separate allocation of an implicit heap every time.
+When a large number of small buffers needs to be created, the overhead of creating even just separate ID3D12Resource objects can be significant. It can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs. This library can also help with it. See section "Sub-allocating buffers" below.
- Implementation detail
- The CPU performance overhead of using this library is low. It uses a high-quality allocation algorithm called Two-Level Segregated Fit (TLSF), which in most cases can find a free place for a new allocation in few steps. The library also doesn't perform too many CPU heap allocations. In may cases, the allocation happens with 0 new CPU heap allocations performed by the library. Even the creation of a D3D12MA::Allocation object itself doesn't typically feature an CPU allocation, because these objects are returned out of a dedicated memory pool.
Another reason for the slowness of D3D12 memory allocation is the guarantee that the newly allocated memory is filled with zeros. When creating and destroying resources placed in an existing heap, this overhead is not present, and the memory is not zeroed - it may contain random data left by the resource previously allocated in that place. In recent versions of the DirectX 12 SDK, clearing the memory of the newly created D3D12 heaps can also be disabled for the improved performance. D3D12MA can use this feature when:
- D3D12MA::ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED is used during the creation of the main allocator object.
-D3D12_HEAP_FLAG_CREATE_NOT_ZEROED is passed to D3D12MA::POOL_DESC::HeapFlags during the creation of a custom pool.- D3D12_HEAP_FLAG_CREATE_NOT_ZEROED is passed to D3D12MA::POOL_DESC::HeapFlags during the creation of a custom pool.
It is recommended to always use these flags. The downside is that when the memory is not filled with zeros, while you don't properly clear it or otherwise initialize its content before use (which is required by D3D12), you may observe incorrect behavior. This problem mostly affects render-target and depth-stencil textures.
When an allocation needs to be made in a performance-critical code, you can use D3D12MA::ALLOCATION_FLAG_STRATEGY_MIN_TIME. In influences multiple heuristics inside the library to prefer faster allocation at the expense of possibly less optimal placement in the memory.
If the resource to be created is non-essential, while the performance is paramount, you can also use D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE. It will create the resource only if it can be placed inside and existing memory heap and return failure from the function if a new heap would need to be allocated, which should guarantee good performance of such function call.
-
+
Sub-allocating buffers
-
When a large number of small buffers needs to be created, the overhead of creating separate ID3D12Resource objects can be significant. It can also cause a significant waste of memory, as placed buffers need to be aligned to D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB by default. These problems can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs.
+When a large number of small buffers needs to be created, the overhead of creating separate ID3D12Resource objects can be significant. It can also cause a significant waste of memory, as placed buffers need to be aligned to D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB by default. These problems can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs.
It requires implementing a custom allocator for the data inside the buffer and using offsets to individual regions. When all the regions can be allocated linearly and freed all at once, implementing such allocator is trivial. When every region has the same size, implementing an allocator is also quite simple when using a "free list" algorithm. However, when regions can have different sizes and can be allocated and freed in random order, it requires a full allocation algorithm. D3D12MA can help with it by exposing its core allocation algorithm for custom usages. For more details and example code, see chapter: Virtual allocator. It can be used for all the cases mentioned above without too much performance overhead, because the D3D12MA::VirtualAllocation object is just a lightweight handle.
-When sub-allocating a buffer, you need to remember to explicitly request proper alignment required for each region. For example, data used as a constant buffer must be aligned to D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT = 256 B.
-
+
When sub-allocating a buffer, you need to remember to explicitly request proper alignment required for each region. For example, data used as a constant buffer must be aligned to D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT = 256 B.
+
Residency priority
When too much video memory is allocated, one of the things that can happen is the system demoting some heaps to the system memory. Moving data between memory pools or reaching out directly to the system memory through PCI Express bus can have large performance overhead, which can slow down the application, or even make the game unplayable any more. Unfortunately, it is not possible to fully control or prevent this demotion. Best thing to do is avoiding memory over-commitment. For more information, see section "Avoiding running out of memory" above.
-Recent versions of DirectX 12 SDK offer function ID3D12Device1::SetResidencyPriority that sets a hint about the priority of a resource - how important it is to stay resident in the video memory. Setting the priority happens at the level of an entire memory heap. D3D12MA offers an interface to set this priority in form of D3D12MA::POOL_DESC::ResidencyPriority parameter. It affects all allocations made out of the custom pool created with it, both placed inside large heaps and created as committed.
+Recent versions of DirectX 12 SDK offer function ID3D12Device1::SetResidencyPriority that sets a hint about the priority of a resource - how important it is to stay resident in the video memory. Setting the priority happens at the level of an entire memory heap. D3D12MA offers an interface to set this priority in form of D3D12MA::POOL_DESC::ResidencyPriority parameter. It affects all allocations made out of the custom pool created with it, both placed inside large heaps and created as committed.
It is recommended to create a custom pool for the purpose of using high residency priority of all resources that are critical for the performance, especially those that are written by the GPU, like render-target, depth-stencil textures, UAV textures and buffers. It is also worth creating them as committed, so that each one will have its own implicit heap. This can minimize the chance that an entire large heap is demoted to system memory, degrading performance of all the resources placed in it.
Example:
D3D12MA::CPOOL_DESC poolDesc = D3D12MA::CPOOL_DESC{
@@ -175,14 +162,14 @@
D3D12_RESIDENCY_PRIORITY priority = D3D12_RESIDENCY_PRIORITY_HIGH;
device1->SetResidencyPriority(1, &res, &priority);
ID3D12Resource * GetResource() constReturns D3D12 resource associated with this object.Definition D3D12MemAlloc.h:552
-
Note this is not the same as explicit eviction controlled using ID3D12Device::Evict and MakeResident functions. Resources evicted explicitly are illegal to access until they are made resident again, while the demotion described here happens automatically and only slows down the execution.
-
+
Note this is not the same as explicit eviction controlled using ID3D12Device::Evict and MakeResident functions. Resources evicted explicitly are illegal to access until they are made resident again, while the demotion described here happens automatically and only slows down the execution.
+
GPU upload heap
Direct3D 12 offers a fixed set of memory heap types:
-D3D12_HEAP_TYPE_DEFAULT: Represents the video memory. It is available and fast to access for the GPU. It should be used for all resources that are written by the GPU (like render-target and depth-stencil textures, UAV) and resources that are frequently read by the GPU (like textures intended for sampling, vertex, index, and constant buffers).D3D12_HEAP_TYPE_UPLOAD: Represents the system memory that is uncached and write-combined. It can be mapped and accessed by the CPU code using a pointer. It supports only buffers, not textures. It is intended for "staging buffers" that are filled by the CPU code and then used as a source of copy operations to the DEFAULT heap. It can also be accessed directly by the GPU - shaders can read from buffers created in this memory.D3D12_HEAP_TYPE_READBACK: Represents the system memory that is cached. It is intended for buffers used as a destination of copy operations from the DEFAULT heap.- D3D12_HEAP_TYPE_DEFAULT: Represents the video memory. It is available and fast to access for the GPU. It should be used for all resources that are written by the GPU (like render-target and depth-stencil textures, UAV) and resources that are frequently read by the GPU (like textures intended for sampling, vertex, index, and constant buffers).
+- D3D12_HEAP_TYPE_UPLOAD: Represents the system memory that is uncached and write-combined. It can be mapped and accessed by the CPU code using a pointer. It supports only buffers, not textures. It is intended for "staging buffers" that are filled by the CPU code and then used as a source of copy operations to the DEFAULT heap. It can also be accessed directly by the GPU - shaders can read from buffers created in this memory.
+- D3D12_HEAP_TYPE_READBACK: Represents the system memory that is cached. It is intended for buffers used as a destination of copy operations from the DEFAULT heap.
Note that in systems with a discrete graphics card, access to system memory is fast from the CPU code (like the C++ code mapping D3D12 buffers and accessing them through a pointer), while access to the video memory is fast from the GPU code (like shaders reading and writing buffers and textures). Any copy operation or direct access between these memory heap types happens through PCI Express bus, which can be relatively slow.
Modern systems offer a feature called Resizable BAR (ReBAR) that gives the CPU direct access to the full video memory. To be available, this feature needs to be supported by the whole hardware-software environment, including:
@@ -192,20 +179,20 @@
- Supporting operating system.
- The feature needs to be enabled in the UEFI settings. It is typically called "Above 4G Decoding" and "Resizable Bar".
-Recent versions of DirectX 12 SDK give access to this feature in form of a new, 4th memory pool: D3D12_HEAP_TYPE_GPU_UPLOAD. Resources created in it behave logically similar to the D3D12_HEAP_TYPE_UPLOAD heap:
+Recent versions of DirectX 12 SDK give access to this feature in form of a new, 4th memory pool: D3D12_HEAP_TYPE_GPU_UPLOAD. Resources created in it behave logically similar to the D3D12_HEAP_TYPE_UPLOAD heap:
- They support mapping and direct access from the CPU code through a pointer.
-- The mapped memory is uncached and write-combined, so it should be only written sequentially (e.g., number-by-number or using
memcpy). It shouldn't be accessed randomly or read, because it is extremely slow for uncached memory.
+- The mapped memory is uncached and write-combined, so it should be only written sequentially (e.g., number-by-number or using memcpy). It shouldn't be accessed randomly or read, because it is extremely slow for uncached memory.
- Only buffers are supported.
- Those buffers can be used as a source of copy operations or directly accessed by the GPU.
-The main difference is that resources created in the new D3D12_HEAP_TYPE_GPU_UPLOAD are placed in the video memory, while resources created in the old D3D12_HEAP_TYPE_UPLOAD are placed in the system memory. This implies which budgets are consumed by new resources allocated in those heaps. This also implies which operations involve transferring data through the PCI Express bus.
+The main difference is that resources created in the new D3D12_HEAP_TYPE_GPU_UPLOAD are placed in the video memory, while resources created in the old D3D12_HEAP_TYPE_UPLOAD are placed in the system memory. This implies which budgets are consumed by new resources allocated in those heaps. This also implies which operations involve transferring data through the PCI Express bus.
-- As
D3D12_HEAP_TYPE_UPLOAD uses the system memory, writes from the CPU code through a mapped pointer are faster, while copies or direct access from the GPU are slower because they need to go through PCIe.
-- As the new
D3D12_HEAP_TYPE_GPU_UPLOAD uses the video memory, copies or direct access from the GPU are faster, while writes from the CPU code through a mapped pointer can be slower, because they need to go through PCIe. For maximum performance of copy operations from this heap, a graphics or compute queue should be used, not a copy queue.
+- As D3D12_HEAP_TYPE_UPLOAD uses the system memory, writes from the CPU code through a mapped pointer are faster, while copies or direct access from the GPU are slower because they need to go through PCIe.
+- As the new D3D12_HEAP_TYPE_GPU_UPLOAD uses the video memory, copies or direct access from the GPU are faster, while writes from the CPU code through a mapped pointer can be slower, because they need to go through PCIe. For maximum performance of copy operations from this heap, a graphics or compute queue should be used, not a copy queue.
GPU Upload Heap can be used for performance optimization of some resources that need to be written by the CPU and read by the GPU. It can be beneficial especially for resources that need to change frequently (often called "dynamic").
-D3D12MA supports GPU upload heap when recent enough version of DirectX 12 SDK is used and when the current system supports it. The support can be queried using function D3D12MA::Allocator::IsGPUUploadHeapSupported(). When it returns TRUE, you can create resources using D3D12_HEAP_TYPE_GPU_UPLOAD. You can also just try creating such resource. Example:
+D3D12MA supports GPU upload heap when recent enough version of DirectX 12 SDK is used and when the current system supports it. The support can be queried using function D3D12MA::Allocator::IsGPUUploadHeapSupported(). When it returns TRUE, you can create resources using D3D12_HEAP_TYPE_GPU_UPLOAD. You can also just try creating such resource. Example:
D3D12MA::CALLOCATION_DESC allocDesc = D3D12MA::CALLOCATION_DESC{
D3D12_HEAP_TYPE_GPU_UPLOAD }; // !!!
@@ -240,13 +227,13 @@
else
// Some other error code e.g., out of memory...
D3D12_HEAP_TYPE HeapTypeThe type of memory heap where the new allocation should be placed.Definition D3D12MemAlloc.h:347
-
+
Committed versus placed resources
When using D3D12 API directly, there are 3 ways of creating resources:
-- Committed, using function
ID3D12Device::CreateCommittedResource. It creates the resource with its own memory heap, which is called an "implicit heap" and cannot be accessed directly.
-- Placed, using function
ID3D12Device::CreatePlacedResource. A ID3D12Heap needs to be created beforehand using ID3D12Device::CreateHeap. Then, the resource can be created as placed inside the heap at a specific offset.
-- Reserved, using function
ID3D12Device::CreateReservedResource. This library doesn't support them directly.
+- Committed, using function ID3D12Device::CreateCommittedResource. It creates the resource with its own memory heap, which is called an "implicit heap" and cannot be accessed directly.
+- Placed, using function ID3D12Device::CreatePlacedResource. A ID3D12Heap needs to be created beforehand using ID3D12Device::CreateHeap. Then, the resource can be created as placed inside the heap at a specific offset.
+- Reserved, using function ID3D12Device::CreateReservedResource. This library doesn't support them directly.
A naive solution would be to create all the resources as committed. It works, because in D3D12 there is no strict limit on the number of resources or heaps that can be created. However, there are certain advantages and disadvantages of using committed versus placed resources:
- The advantage of committed resources is that they are always created with a new heap, which is initialized with zeros. When a resource is created as placed, the memory may contain random data left by the resource previously allocated in that place. When the memory is not filled with zeros, while you don't properly clear it or otherwise initialize its content before use (which is required by D3D12), you may observe incorrect behavior. On the other hand, using committed resources and having every new resource filled with zeros can leave this kind of bugs undetected.
-- Manual eviction with
ID3D12Device::Evict and MakeResident functions work at the level of the entire heap, and so does ID3D12Device1::SetResidencyPriority, so creating resources as committed allows more fine-grained control over the eviction and residency priority of individual resources.
+- Manual eviction with ID3D12Device::Evict and MakeResident functions work at the level of the entire heap, and so does ID3D12Device1::SetResidencyPriority, so creating resources as committed allows more fine-grained control over the eviction and residency priority of individual resources.
- The advantage of placed resources is that they can be created in a region of a heap overlapping with some other resources. This approach is commonly called "aliasing". It can save memory, but it needs careful control over the resources that overlap in memory to make sure they are not used at the same time, there is an aliasing barrier issued between their usage, and the resource used after aliasing is correctly cleared every time. Committed resources don't offer this possibility, because every committed resource has its own exclusive memory heap. For more information, see chapter Resource aliasing (overlap).
When creating resources with the help of D3D12MA using function D3D12MA::Allocator::CreateResource, you typically don't need to care about all this. The library automatically makes the choice of creating the new resource as committed or placed. However, in cases when you need the information or the control over this choice between committed and placed, the library offers facilities to do that, described below.
@@ -303,18 +290,18 @@
UINT64 BlockSizeSize of a single heap (memory block) to be allocated as part of this pool, in bytes....Definition D3D12MemAlloc.h:933
You can request a new resource to be created as placed by using D3D12MA::ALLOCATION_FLAG_CAN_ALIAS. This is required especially if you plan to create another resource in the same region of memory, aliasing with your resource - hence the name of this flag.
Note D3D12MA::ALLOCATION_FLAG_CAN_ALIAS can be even combined with D3D12MA::ALLOCATION_FLAG_COMMITTED. In this case, the resource is not created as committed, but it is also not placed as part of a larger heap. What happens instead is that a new heap is created with the exact size required for the resource, and the resource is created in it, placed at offset 0.
-
+
Resource alignment
Certain types of resources require certain alignment in memory. An alignment is a requirement for the address or offset to the beginning of the resource to be a multiply of some value, which is always a power of 2. For committed resources, the problem is non-existent, because committed resources have their own implicit heaps where they are created at offset 0, which meets any alignment requirement. For placed resources, D3D12MA takes care of the alignment automatically.
-- Implementation detail
- Default alignment required MSAA textures is
D3D12_DEFAULT_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 4 MB. Default alignment required for buffers and other textures is D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB.
+- Implementation detail
- Default alignment required MSAA textures is D3D12_DEFAULT_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 4 MB. Default alignment required for buffers and other textures is D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB.
Because the alignment required for buffers is 64 KB, small buffers can waste a lot of memory in between when created as placed. When such small buffers are created as committed, some graphics drivers are able to pack them better. D3D12MA automatically takes advantage of this by preferring to create small buffers as committed. This heuristics is enabled by default. It is also a tradeoff - it can make the allocation of these buffers slower. It can be disabled for an individual resource by using D3D12MA::ALLOCATION_FLAG_STRATEGY_MIN_TIME and for the entire allocator by using D3D12MA::ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED.
-For certain textures that meet a complex set of requirements, special "small alignment" can be applied. Details can be found in Microsoft documentation of the D3D12_RESOURCE_DESC structure. For MSAA textures, the small alignment is D3D12_SMALL_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB. For other textures, the small alignment is D3D12_SMALL_RESOURCE_PLACEMENT_ALIGNMENT = 4 KB. D3D12MA uses this feature automatically. Detailed behavior can be disabled or controlled by predefining macro D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT.
-D3D12 also has a concept of alignment of the entire heap, passed through D3D12_HEAP_DESC::Alignment. This library automatically sets the alignment as small as possible. Unfortunately, any heap that has a chance of hosting an MSAA texture needs to have the alignment set to 4 MB. This problem can be overcome by passing D3D12MA::ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of the main allocator object and D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of any custom heap that supports textures, not only buffers. With those flags, the alignment of the heaps created by D3D12MA can be lower, but any MSAA textures are created as committed. You should always use these flags in your code unless you really need to create some MSAA textures as placed.
+For certain textures that meet a complex set of requirements, special "small alignment" can be applied. Details can be found in Microsoft documentation of the D3D12_RESOURCE_DESC structure. For MSAA textures, the small alignment is D3D12_SMALL_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB. For other textures, the small alignment is D3D12_SMALL_RESOURCE_PLACEMENT_ALIGNMENT = 4 KB. D3D12MA uses this feature automatically. Detailed behavior can be disabled or controlled by predefining macro D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT.
+D3D12 also has a concept of alignment of the entire heap, passed through D3D12_HEAP_DESC::Alignment. This library automatically sets the alignment as small as possible. Unfortunately, any heap that has a chance of hosting an MSAA texture needs to have the alignment set to 4 MB. This problem can be overcome by passing D3D12MA::ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of the main allocator object and D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of any custom heap that supports textures, not only buffers. With those flags, the alignment of the heaps created by D3D12MA can be lower, but any MSAA textures are created as committed. You should always use these flags in your code unless you really need to create some MSAA textures as placed.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/quick_start.html b/docs/html/quick_start.html
index f9219d2..4eba7e6 100644
--- a/docs/html/quick_start.html
+++ b/docs/html/quick_start.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Quick start
-
-
@@ -33,33 +31,22 @@
-
+
-
- Quick start
+ Quick start
-
+
Project setup and initialization
This is a small, standalone C++ library. It consists of 2 files: "D3D12MemAlloc.h" header file with public interface and "D3D12MemAlloc.cpp" with internal implementation. The only external dependencies are WinAPI, Direct3D 12, and parts of C/C++ standard library (but STL containers, exceptions, or RTTI are not used).
The library is developed and tested using Microsoft Visual Studio 2022, but it should work with other compilers as well. It is designed for 64-bit code.
To use the library in your project:
-(1.) Copy files D3D12MemAlloc.cpp, D3D12MemAlloc.h to your project.
-(2.) Make D3D12MemAlloc.cpp compiling as part of the project, as C++ code.
+(1.) Copy files D3D12MemAlloc.cpp, D3D12MemAlloc.h to your project.
+(2.) Make D3D12MemAlloc.cpp compiling as part of the project, as C++ code.
(3.) Include library header in each CPP file that needs to use the library.
#include "D3D12MemAlloc.h"
-(4.) Right after you created ID3D12Device, fill D3D12MA::ALLOCATOR_DESC structure and call function D3D12MA::CreateAllocator to create the main D3D12MA::Allocator object.
+
(4.) Right after you created ID3D12Device, fill D3D12MA::ALLOCATOR_DESC structure and call function D3D12MA::CreateAllocator to create the main D3D12MA::Allocator object.
Please note that all symbols of the library are declared inside D3D12MA namespace.
IDXGIAdapter* adapter = ...
ID3D12Device* device = ...
@@ -119,12 +106,12 @@
D3D12MA_API HRESULT CreateAllocator(const ALLOCATOR_DESC *pDesc, Allocator **ppAllocator)Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
(5.) Right before destroying the D3D12 device, destroy the allocator object.
allocator->Release();
-Objects of this library must be destroyed by calling Release method. They are somewhat compatible with COM: they implement IUnknown interface with its virtual methods: AddRef, Release, QueryInterface, and they are reference-counted internally. You can use smart pointers designed for COM with objects of this library - e.g. CComPtr or Microsoft::WRL::ComPtr. The reference counter is thread-safe. QueryInterface method supports only IUnknown, as classes of this library don't define their own GUIDs.
-
+
Objects of this library must be destroyed by calling Release method. They are somewhat compatible with COM: they implement IUnknown interface with its virtual methods: AddRef, Release, QueryInterface, and they are reference-counted internally. You can use smart pointers designed for COM with objects of this library - e.g. CComPtr or Microsoft::WRL::ComPtr. The reference counter is thread-safe. QueryInterface method supports only IUnknown, as classes of this library don't define their own GUIDs.
+
Creating resources
-To use the library for creating resources (textures and buffers), call method D3D12MA::Allocator::CreateResource in the place where you would previously call ID3D12Device::CreateCommittedResource.
-The function has similar syntax, but it expects structure D3D12MA::ALLOCATION_DESC to be passed along with D3D12_RESOURCE_DESC and other parameters for created resource. This structure describes parameters of the desired memory allocation, including choice of D3D12_HEAP_TYPE.
-The function returns a new object of type D3D12MA::Allocation. It represents allocated memory and can be queried for size, offset, ID3D12Heap. It also holds a reference to the ID3D12Resource, which can be accessed by calling D3D12MA::Allocation::GetResource().
+To use the library for creating resources (textures and buffers), call method D3D12MA::Allocator::CreateResource in the place where you would previously call ID3D12Device::CreateCommittedResource.
+The function has similar syntax, but it expects structure D3D12MA::ALLOCATION_DESC to be passed along with D3D12_RESOURCE_DESC and other parameters for created resource. This structure describes parameters of the desired memory allocation, including choice of D3D12_HEAP_TYPE.
+The function returns a new object of type D3D12MA::Allocation. It represents allocated memory and can be queried for size, offset, ID3D12Heap. It also holds a reference to the ID3D12Resource, which can be accessed by calling D3D12MA::Allocation::GetResource().
D3D12_RESOURCE_DESC resourceDesc = {};
resourceDesc.Dimension = D3D12_RESOURCE_DIMENSION_TEXTURE2D;
resourceDesc.Alignment = 0;
@@ -160,13 +147,13 @@
D3D12_HEAP_TYPE HeapTypeThe type of memory heap where the new allocation should be placed.Definition D3D12MemAlloc.h:347
You need to release the allocation object when no longer needed. This will also release the D3D12 resource.
allocation->Release();
-The advantage of using the allocator instead of creating committed resource, and the main purpose of this library, is that it can decide to allocate bigger memory heap internally using ID3D12Device::CreateHeap and place multiple resources in it, at different offsets, using ID3D12Device::CreatePlacedResource. The library manages its own collection of allocated memory blocks (heaps) and remembers which parts of them are occupied and which parts are free to be used for new resources.
-It is important to remember that resources created as placed don't have their memory initialized to zeros, but may contain garbage data, so they need to be fully initialized before usage, e.g. using Clear (ClearRenderTargetView), Discard (DiscardResource), or Copy (CopyResource).
-The library also automatically handles resource heap tier. When D3D12_FEATURE_DATA_D3D12_OPTIONS::ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1, resources of 3 types: buffers, textures that are render targets or depth-stencil, and other textures must be kept in separate heaps. When D3D12_RESOURCE_HEAP_TIER_2, they can be kept together. By using this library, you don't need to handle this manually.
-
+
The advantage of using the allocator instead of creating committed resource, and the main purpose of this library, is that it can decide to allocate bigger memory heap internally using ID3D12Device::CreateHeap and place multiple resources in it, at different offsets, using ID3D12Device::CreatePlacedResource. The library manages its own collection of allocated memory blocks (heaps) and remembers which parts of them are occupied and which parts are free to be used for new resources.
+It is important to remember that resources created as placed don't have their memory initialized to zeros, but may contain garbage data, so they need to be fully initialized before usage, e.g. using Clear (ClearRenderTargetView), Discard (DiscardResource), or Copy (CopyResource).
+The library also automatically handles resource heap tier. When D3D12_FEATURE_DATA_D3D12_OPTIONS::ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1, resources of 3 types: buffers, textures that are render targets or depth-stencil, and other textures must be kept in separate heaps. When D3D12_RESOURCE_HEAP_TIER_2, they can be kept together. By using this library, you don't need to handle this manually.
+
Resource reference counting
-ID3D12Resource and other interfaces of Direct3D 12 use COM, so they are reference-counted. Objects of this library are reference-counted as well. An object of type D3D12MA::Allocation remembers the resource (buffer or texture) that was created together with this memory allocation and holds a reference to the ID3D12Resource object. (Note this is a difference to Vulkan Memory Allocator, where a VmaAllocation object has no connection with the buffer or image that was created with it.) Thus, it is important to manage the resource reference counter properly.
-The simplest use case is shown in the code snippet above. When only D3D12MA::Allocation object is obtained from a function call like D3D12MA::Allocator::CreateResource, it remembers the ID3D12Resource that was created with it and holds a reference to it. The resource can be obtained by calling allocation->GetResource(), which doesn't increment the resource reference counter. Calling allocation->Release() will decrease the resource reference counter, which is 1 in this case, so the resource will be released.
+ID3D12Resource and other interfaces of Direct3D 12 use COM, so they are reference-counted. Objects of this library are reference-counted as well. An object of type D3D12MA::Allocation remembers the resource (buffer or texture) that was created together with this memory allocation and holds a reference to the ID3D12Resource object. (Note this is a difference to Vulkan Memory Allocator, where a VmaAllocation object has no connection with the buffer or image that was created with it.) Thus, it is important to manage the resource reference counter properly.
+The simplest use case is shown in the code snippet above. When only D3D12MA::Allocation object is obtained from a function call like D3D12MA::Allocator::CreateResource, it remembers the ID3D12Resource that was created with it and holds a reference to it. The resource can be obtained by calling allocation->GetResource(), which doesn't increment the resource reference counter. Calling allocation->Release() will decrease the resource reference counter, which is 1 in this case, so the resource will be released.
Second option is to retrieve a pointer to the resource along with D3D12MA::Allocation. Last parameters of the resource creation function can be used for this purpose.
D3D12MA::Allocation* allocation;
ID3D12Resource* resource;
@@ -179,15 +166,15 @@
IID_PPV_ARGS(&resource));
// Use resource...
-
In this case, returned pointer resource is equal to allocation->GetResource(), but the creation function additionally increases resource reference counter for the purpose of returning it from this call (it actually calls QueryInterface internally), so the resource will have the counter = 2. The resource then need to be released along with the allocation, in this particular order, to make sure the resource is destroyed before its memory heap can potentially be freed.
+In this case, returned pointer resource is equal to allocation->GetResource(), but the creation function additionally increases resource reference counter for the purpose of returning it from this call (it actually calls QueryInterface internally), so the resource will have the counter = 2. The resource then need to be released along with the allocation, in this particular order, to make sure the resource is destroyed before its memory heap can potentially be freed.
resource->Release();
allocation->Release();
-More advanced use cases are possible when we consider that an D3D12MA::Allocation object can just hold a reference to any resource. It can be changed by calling D3D12MA::Allocation::SetResource. This function releases the old resource and calls AddRef on the new one.
-Special care must be taken when performing defragmentation. The new resource created at the destination place should be set as pass.pMoves[i].pDstTmpAllocation->SetResource(newRes), but it is moved to the source allocation at end of the defragmentation pass, while the old resource accessible through pass.pMoves[i].pSrcAllocation->GetResource() is then released. For more information, see documentation chapter Defragmentation.
-
+
More advanced use cases are possible when we consider that an D3D12MA::Allocation object can just hold a reference to any resource. It can be changed by calling D3D12MA::Allocation::SetResource. This function releases the old resource and calls AddRef on the new one.
+Special care must be taken when performing defragmentation. The new resource created at the destination place should be set as pass.pMoves[i].pDstTmpAllocation->SetResource(newRes), but it is moved to the source allocation at end of the defragmentation pass, while the old resource accessible through pass.pMoves[i].pSrcAllocation->GetResource() is then released. For more information, see documentation chapter Defragmentation.
+
Mapping memory
-The process of getting regular CPU-side pointer to the memory of a resource in Direct3D is called "mapping". There are rules and restrictions to this process, as described in D3D12 documentation of ID3D12Resource::Map method.
-Mapping happens on the level of particular resources, not entire memory heaps, and so it is out of scope of this library. Just as the documentation of the Map function says:
+The process of getting regular CPU-side pointer to the memory of a resource in Direct3D is called "mapping". There are rules and restrictions to this process, as described in D3D12 documentation of ID3D12Resource::Map method.
+Mapping happens on the level of particular resources, not entire memory heaps, and so it is out of scope of this library. Just as the documentation of the Map function says:
- Returned pointer refers to data of particular subresource, not entire memory heap.
- You can map same resource multiple times. It is ref-counted internally.
@@ -196,7 +183,7 @@
- Unmapping may not be required before using written data - some heap types on some platforms support resources persistently mapped.
When using this library, you can map and use your resources normally without considering whether they are created as committed resources or placed resources in one large heap.
-Example for buffer created and filled in UPLOAD heap type:
+Example for buffer created and filled in UPLOAD heap type:
const UINT64 bufSize = 65536;
const float* bufData = ...;
@@ -233,17 +220,17 @@
memcpy(mappedPtr, bufData, bufSize);
resource->Unmap(0, NULL);
-
+
Helper structures
-
DirectX 12 Agility SDK offers a library of helpers in files "build\native\include\d3dx12\*.h". They include structures that help with complete and concise initialization of the core D3D12 *_DESC structures by using some basic C++ features (constructors, static methods, default parameters). They inherit from these structures, so they support implicit casting to them. For example, structure CD3DX12_RESOURCE_DESC can be used to conveniently fill in structure D3D12_RESOURCE_DESC.
-Similarly, this library provides a set of helper structures that aid in initialization of some of the *_DESC structures defined in the library. These are:
+DirectX 12 Agility SDK offers a library of helpers in files "build\native\include\d3dx12\*.h". They include structures that help with complete and concise initialization of the core D3D12 *_DESC structures by using some basic C++ features (constructors, static methods, default parameters). They inherit from these structures, so they support implicit casting to them. For example, structure CD3DX12_RESOURCE_DESC can be used to conveniently fill in structure D3D12_RESOURCE_DESC.
+Similarly, this library provides a set of helper structures that aid in initialization of some of the *_DESC structures defined in the library. These are:
- D3D12MA::CALLOCATION_DESC, which inherits from D3D12MA::ALLOCATION_DESC.
- D3D12MA::CPOOL_DESC, which inherits from D3D12MA::POOL_DESC.
- D3D12MA::CVIRTUAL_BLOCK_DESC, which inherits from D3D12MA::VIRTUAL_BLOCK_DESC.
- D3D12MA::CVIRTUAL_ALLOCATION_DESC, which inherits from D3D12MA::VIRTUAL_ALLOCATION_DESC.
-For example, when you want to create a buffer in the UPLAOD heap using minimal allocation time, you can use base structures:
+For example, when you want to create a buffer in the UPLAOD heap using minimal allocation time, you can use base structures:
D3D12MA::ALLOCATION_DESC allocDesc;
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_STRATEGY_MIN_TIME;
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
@@ -291,7 +278,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/resource_aliasing.html b/docs/html/resource_aliasing.html
index c89a007..1275544 100644
--- a/docs/html/resource_aliasing.html
+++ b/docs/html/resource_aliasing.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Resource aliasing (overlap)
-
-
@@ -33,33 +31,22 @@
-
+
-
- Resource aliasing (overlap)
+ Resource aliasing (overlap)
New explicit graphics APIs (Vulkan and Direct3D 12), thanks to manual memory management, give an opportunity to alias (overlap) multiple resources in the same region of memory - a feature not available in the old APIs (Direct3D 11, OpenGL). It can be useful to save video memory, but it must be used with caution.
@@ -171,18 +158,18 @@
Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.Definition D3D12MemAlloc.h:338
D3D12_HEAP_FLAGS ExtraHeapFlagsAdditional heap flags to be used when allocating memory.Definition D3D12MemAlloc.h:363
D3D12_HEAP_TYPE HeapTypeThe type of memory heap where the new allocation should be placed.Definition D3D12MemAlloc.h:347
-Remember that using resouces that alias in memory requires proper synchronization. You need to issue a special barrier of type D3D12_RESOURCE_BARRIER_TYPE_ALIASING. You also need to treat a resource after aliasing as uninitialized - containing garbage data. For example, if you use res1 and then want to use res2, you need to first initialize res2 using either Clear, Discard, or Copy to the entire resource.
+Remember that using resouces that alias in memory requires proper synchronization. You need to issue a special barrier of type D3D12_RESOURCE_BARRIER_TYPE_ALIASING. You also need to treat a resource after aliasing as uninitialized - containing garbage data. For example, if you use res1 and then want to use res2, you need to first initialize res2 using either Clear, Discard, or Copy to the entire resource.
Additional considerations:
- D3D12 also allows to interpret contents of memory between aliasing resources consistently in some cases, which is called "data inheritance". For details, see Microsoft documentation chapter "Memory Aliasing and Data Inheritance".
-- You can create more complex layout where different textures and buffers are bound at different offsets inside one large allocation. For example, one can imagine a big texture used in some render passes, aliasing with a set of many small buffers used in some further passes. To bind a resource at non-zero offset of an allocation, call D3D12MA::Allocator::CreateAliasingResource with appropriate value of
AllocationLocalOffset parameter.
-- Resources of the three categories: buffers, textures with
RENDER_TARGET or DEPTH_STENCIL flags, and all other textures, can be placed in the same memory only when allocator->GetD3D12Options().ResourceHeapTier >= D3D12_RESOURCE_HEAP_TIER_2. Otherwise they must be placed in different memory heap types, and thus aliasing them is not possible.
+- You can create more complex layout where different textures and buffers are bound at different offsets inside one large allocation. For example, one can imagine a big texture used in some render passes, aliasing with a set of many small buffers used in some further passes. To bind a resource at non-zero offset of an allocation, call D3D12MA::Allocator::CreateAliasingResource with appropriate value of AllocationLocalOffset parameter.
+- Resources of the three categories: buffers, textures with RENDER_TARGET or DEPTH_STENCIL flags, and all other textures, can be placed in the same memory only when allocator->GetD3D12Options().ResourceHeapTier >= D3D12_RESOURCE_HEAP_TIER_2. Otherwise they must be placed in different memory heap types, and thus aliasing them is not possible.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/search/pages_0.js b/docs/html/search/pages_0.js
index 6c4bc1e..4e13aaf 100644
--- a/docs/html/search/pages_0.js
+++ b/docs/html/search/pages_0.js
@@ -1,10 +1,23 @@
var searchData=
[
- ['algorithm_0',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
- ['aliasing_20overlap_1',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
- ['allocation_2',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
- ['allocation_20algorithm_3',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
- ['allocator_4',['D3D12 Memory Allocator',['../index.html',1,'']]],
- ['allocator_5',['Virtual allocator',['../virtual_allocator.html',1,'optimal_allocation']]],
- ['asked_20questions_6',['Frequently asked questions',['../faq.html',1,'index']]]
+ ['additional_20considerations_0',['Additional considerations',['../linear_algorithm.html#linear_algorithm_additional_considerations',1,'Additional considerations'],['../virtual_allocator.html#virtual_allocator_additional_considerations',1,'Additional considerations']]],
+ ['algorithm_1',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
+ ['aliasing_20overlap_2',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
+ ['alignment_3',['Resource alignment',['../optimal_allocation.html#optimal_allocation_resource_alignment',1,'']]],
+ ['alignment_20and_20units_4',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]],
+ ['allocating_20buffers_5',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]],
+ ['allocation_6',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
+ ['allocation_20algorithm_7',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
+ ['allocation_20parameters_8',['Allocation parameters',['../virtual_allocator.html#virtual_allocator_allocation_parameters',1,'']]],
+ ['allocation_20performance_9',['Allocation performance',['../optimal_allocation.html#optimal_allocation_allocation_Performance',1,'']]],
+ ['allocations_10',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]],
+ ['allocator_11',['D3D12 Memory Allocator',['../index.html',1,'']]],
+ ['allocator_12',['allocator',['../configuration.html#custom_memory_allocator',1,'Custom CPU memory allocator'],['../virtual_allocator.html',1,'Virtual allocator']]],
+ ['and_20benefits_13',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]],
+ ['and_20compatibility_14',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]],
+ ['and_20initialization_15',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]],
+ ['and_20units_16',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]],
+ ['asked_20questions_17',['Frequently asked questions',['../faq.html',1,'index']]],
+ ['at_20once_18',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]],
+ ['avoiding_20running_20out_20of_20memory_19',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]]
];
diff --git a/docs/html/search/pages_1.js b/docs/html/search/pages_1.js
index 91cb574..d34b057 100644
--- a/docs/html/search/pages_1.js
+++ b/docs/html/search/pages_1.js
@@ -1,6 +1,7 @@
var searchData=
[
- ['configuration_0',['Configuration',['../configuration.html',1,'index']]],
- ['considerations_1',['General considerations',['../general_considerations.html',1,'index']]],
- ['custom_20memory_20pools_2',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
+ ['benefits_0',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]],
+ ['block_1',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]],
+ ['buffer_2',['Ring buffer',['../linear_algorithm.html#linear_algorithm_ring_buffer',1,'']]],
+ ['buffers_3',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]]
];
diff --git a/docs/html/search/pages_10.js b/docs/html/search/pages_10.js
new file mode 100644
index 0000000..af3b029
--- /dev/null
+++ b/docs/html/search/pages_10.js
@@ -0,0 +1,13 @@
+var searchData=
+[
+ ['safety_0',['Thread safety',['../general_considerations.html#general_considerations_thread_safety',1,'']]],
+ ['setup_20and_20initialization_1',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]],
+ ['stack_2',['Stack',['../linear_algorithm.html#linear_algorithm_stack',1,'']]],
+ ['stack_3',['Double stack',['../linear_algorithm.html#linear_algorithm_double_stack',1,'']]],
+ ['start_4',['Quick start',['../quick_start.html',1,'index']]],
+ ['statistics_5',['Statistics',['../statistics.html',1,'Statistics'],['../virtual_allocator.html#virtual_allocator_statistics',1,'Statistics']]],
+ ['statistics_6',['Numeric statistics',['../statistics.html#statistics_numeric_statistics',1,'']]],
+ ['structures_7',['Helper structures',['../quick_start.html#quick_start_helper_structures',1,'']]],
+ ['sub_20allocating_20buffers_8',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]],
+ ['supported_9',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]]
+];
diff --git a/docs/html/search/pages_11.js b/docs/html/search/pages_11.js
new file mode 100644
index 0000000..ce665b6
--- /dev/null
+++ b/docs/html/search/pages_11.js
@@ -0,0 +1,5 @@
+var searchData=
+[
+ ['table_20of_20contents_0',['Table of contents',['../index.html#main_table_of_contents',1,'']]],
+ ['thread_20safety_1',['Thread safety',['../general_considerations.html#general_considerations_thread_safety',1,'']]]
+];
diff --git a/docs/html/search/pages_12.js b/docs/html/search/pages_12.js
new file mode 100644
index 0000000..32f0ad5
--- /dev/null
+++ b/docs/html/search/pages_12.js
@@ -0,0 +1,6 @@
+var searchData=
+[
+ ['units_0',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]],
+ ['upload_20heap_1',['GPU upload heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'']]],
+ ['usage_2',['Usage',['../custom_pools.html#custom_pools_usage',1,'']]]
+];
diff --git a/docs/html/search/pages_13.js b/docs/html/search/pages_13.js
new file mode 100644
index 0000000..aa04e5d
--- /dev/null
+++ b/docs/html/search/pages_13.js
@@ -0,0 +1,8 @@
+var searchData=
+[
+ ['versioning_20and_20compatibility_0',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]],
+ ['versus_20placed_20resources_1',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]],
+ ['virtual_20allocations_2',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]],
+ ['virtual_20allocator_3',['Virtual allocator',['../virtual_allocator.html',1,'optimal_allocation']]],
+ ['virtual_20block_4',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]]
+];
diff --git a/docs/html/search/pages_14.js b/docs/html/search/pages_14.js
new file mode 100644
index 0000000..8225a92
--- /dev/null
+++ b/docs/html/search/pages_14.js
@@ -0,0 +1,4 @@
+var searchData=
+[
+ ['web_20links_0',['Web links',['../index.html#main_see_also',1,'']]]
+];
diff --git a/docs/html/search/pages_2.js b/docs/html/search/pages_2.js
index 8aa1a38..7553f75 100644
--- a/docs/html/search/pages_2.js
+++ b/docs/html/search/pages_2.js
@@ -1,5 +1,14 @@
var searchData=
[
- ['d3d12_20memory_20allocator_0',['D3D12 Memory Allocator',['../index.html',1,'']]],
- ['defragmentation_1',['Defragmentation',['../defragmentation.html',1,'optimal_allocation']]]
+ ['committed_20versus_20placed_20resources_0',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]],
+ ['compatibility_1',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]],
+ ['configuration_2',['Configuration',['../configuration.html',1,'index']]],
+ ['considerations_3',['considerations',['../linear_algorithm.html#linear_algorithm_additional_considerations',1,'Additional considerations'],['../virtual_allocator.html#virtual_allocator_additional_considerations',1,'Additional considerations'],['../general_considerations.html',1,'General considerations']]],
+ ['contents_4',['Table of contents',['../index.html#main_table_of_contents',1,'']]],
+ ['counting_5',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]],
+ ['cpu_20memory_20allocator_6',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]],
+ ['creating_20resources_7',['Creating resources',['../quick_start.html#quick_start_creating_resources',1,'']]],
+ ['creating_20virtual_20block_8',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]],
+ ['custom_20cpu_20memory_20allocator_9',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]],
+ ['custom_20memory_20pools_10',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
];
diff --git a/docs/html/search/pages_3.js b/docs/html/search/pages_3.js
index 842b2bb..89d174b 100644
--- a/docs/html/search/pages_3.js
+++ b/docs/html/search/pages_3.js
@@ -1,4 +1,9 @@
var searchData=
[
- ['frequently_20asked_20questions_0',['Frequently asked questions',['../faq.html',1,'index']]]
+ ['d3d12_20memory_20allocator_0',['D3D12 Memory Allocator',['../index.html',1,'']]],
+ ['deallocation_1',['Deallocation',['../virtual_allocator.html#virtual_allocator_deallocation',1,'']]],
+ ['debug_20margins_2',['Debug margins',['../configuration.html#debug_margins',1,'']]],
+ ['defragmentation_3',['Defragmentation',['../defragmentation.html',1,'optimal_allocation']]],
+ ['double_20stack_4',['Double stack',['../linear_algorithm.html#linear_algorithm_double_stack',1,'']]],
+ ['dump_5',['JSON dump',['../statistics.html#statistics_json_dump',1,'']]]
];
diff --git a/docs/html/search/pages_4.js b/docs/html/search/pages_4.js
index 1aed57d..6f9860c 100644
--- a/docs/html/search/pages_4.js
+++ b/docs/html/search/pages_4.js
@@ -1,4 +1,7 @@
var searchData=
[
- ['general_20considerations_0',['General considerations',['../general_considerations.html',1,'index']]]
+ ['features_20and_20benefits_0',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]],
+ ['features_20not_20supported_1',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]],
+ ['free_20at_20once_2',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]],
+ ['frequently_20asked_20questions_3',['Frequently asked questions',['../faq.html',1,'index']]]
];
diff --git a/docs/html/search/pages_5.js b/docs/html/search/pages_5.js
index b965ff9..b85c57f 100644
--- a/docs/html/search/pages_5.js
+++ b/docs/html/search/pages_5.js
@@ -1,4 +1,5 @@
var searchData=
[
- ['linear_20allocation_20algorithm_0',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]]
+ ['general_20considerations_0',['General considerations',['../general_considerations.html',1,'index']]],
+ ['gpu_20upload_20heap_1',['GPU upload heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'']]]
];
diff --git a/docs/html/search/pages_6.js b/docs/html/search/pages_6.js
index 2fa4310..6386d6c 100644
--- a/docs/html/search/pages_6.js
+++ b/docs/html/search/pages_6.js
@@ -1,5 +1,5 @@
var searchData=
[
- ['memory_20allocator_0',['D3D12 Memory Allocator',['../index.html',1,'']]],
- ['memory_20pools_1',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
+ ['heap_0',['GPU upload heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'']]],
+ ['helper_20structures_1',['Helper structures',['../quick_start.html#quick_start_helper_structures',1,'']]]
];
diff --git a/docs/html/search/pages_7.js b/docs/html/search/pages_7.js
index 0c3cb7f..75d0639 100644
--- a/docs/html/search/pages_7.js
+++ b/docs/html/search/pages_7.js
@@ -1,5 +1,4 @@
var searchData=
[
- ['optimal_20resource_20allocation_0',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
- ['overlap_1',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]]
+ ['initialization_0',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]]
];
diff --git a/docs/html/search/pages_8.js b/docs/html/search/pages_8.js
index f4128dd..2f270a2 100644
--- a/docs/html/search/pages_8.js
+++ b/docs/html/search/pages_8.js
@@ -1,4 +1,4 @@
var searchData=
[
- ['pools_0',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
+ ['json_20dump_0',['JSON dump',['../statistics.html#statistics_json_dump',1,'']]]
];
diff --git a/docs/html/search/pages_9.js b/docs/html/search/pages_9.js
index c9afe7b..9cdb234 100644
--- a/docs/html/search/pages_9.js
+++ b/docs/html/search/pages_9.js
@@ -1,5 +1,5 @@
var searchData=
[
- ['questions_0',['Frequently asked questions',['../faq.html',1,'index']]],
- ['quick_20start_1',['Quick start',['../quick_start.html',1,'index']]]
+ ['linear_20allocation_20algorithm_0',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
+ ['links_1',['Web links',['../index.html#main_see_also',1,'']]]
];
diff --git a/docs/html/search/pages_a.js b/docs/html/search/pages_a.js
index 53f0a34..0ce8dfd 100644
--- a/docs/html/search/pages_a.js
+++ b/docs/html/search/pages_a.js
@@ -1,5 +1,10 @@
var searchData=
[
- ['resource_20aliasing_20overlap_0',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
- ['resource_20allocation_1',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]]
+ ['making_20virtual_20allocations_0',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]],
+ ['mapping_20memory_1',['Mapping memory',['../quick_start.html#quick_start_mapping_memory',1,'']]],
+ ['margins_2',['Debug margins',['../configuration.html#debug_margins',1,'']]],
+ ['memory_3',['memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'Avoiding running out of memory'],['../quick_start.html#quick_start_mapping_memory',1,'Mapping memory']]],
+ ['memory_20allocator_4',['D3D12 Memory Allocator',['../index.html',1,'']]],
+ ['memory_20allocator_5',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]],
+ ['memory_20pools_6',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
];
diff --git a/docs/html/search/pages_b.js b/docs/html/search/pages_b.js
index d4b7ec0..a1fc386 100644
--- a/docs/html/search/pages_b.js
+++ b/docs/html/search/pages_b.js
@@ -1,5 +1,5 @@
var searchData=
[
- ['start_0',['Quick start',['../quick_start.html',1,'index']]],
- ['statistics_1',['Statistics',['../statistics.html',1,'optimal_allocation']]]
+ ['not_20supported_0',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]],
+ ['numeric_20statistics_1',['Numeric statistics',['../statistics.html#statistics_numeric_statistics',1,'']]]
];
diff --git a/docs/html/search/pages_c.js b/docs/html/search/pages_c.js
index 6f1ceb8..2036541 100644
--- a/docs/html/search/pages_c.js
+++ b/docs/html/search/pages_c.js
@@ -1,4 +1,9 @@
var searchData=
[
- ['virtual_20allocator_0',['Virtual allocator',['../virtual_allocator.html',1,'optimal_allocation']]]
+ ['of_20contents_0',['Table of contents',['../index.html#main_table_of_contents',1,'']]],
+ ['of_20memory_1',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]],
+ ['once_2',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]],
+ ['optimal_20resource_20allocation_3',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
+ ['out_20of_20memory_4',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]],
+ ['overlap_5',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]]
];
diff --git a/docs/html/search/pages_d.js b/docs/html/search/pages_d.js
new file mode 100644
index 0000000..61cd771
--- /dev/null
+++ b/docs/html/search/pages_d.js
@@ -0,0 +1,9 @@
+var searchData=
+[
+ ['parameters_0',['Allocation parameters',['../virtual_allocator.html#virtual_allocator_allocation_parameters',1,'']]],
+ ['performance_1',['Allocation performance',['../optimal_allocation.html#optimal_allocation_allocation_Performance',1,'']]],
+ ['placed_20resources_2',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]],
+ ['pools_3',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]],
+ ['priority_4',['Residency priority',['../optimal_allocation.html#optimal_allocation_residency_priority',1,'']]],
+ ['project_20setup_20and_20initialization_5',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]]
+];
diff --git a/docs/html/search/pages_e.js b/docs/html/search/pages_e.js
new file mode 100644
index 0000000..c9afe7b
--- /dev/null
+++ b/docs/html/search/pages_e.js
@@ -0,0 +1,5 @@
+var searchData=
+[
+ ['questions_0',['Frequently asked questions',['../faq.html',1,'index']]],
+ ['quick_20start_1',['Quick start',['../quick_start.html',1,'index']]]
+];
diff --git a/docs/html/search/pages_f.js b/docs/html/search/pages_f.js
new file mode 100644
index 0000000..97e8dbf
--- /dev/null
+++ b/docs/html/search/pages_f.js
@@ -0,0 +1,12 @@
+var searchData=
+[
+ ['reference_20counting_0',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]],
+ ['residency_20priority_1',['Residency priority',['../optimal_allocation.html#optimal_allocation_residency_priority',1,'']]],
+ ['resource_20aliasing_20overlap_2',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
+ ['resource_20alignment_3',['Resource alignment',['../optimal_allocation.html#optimal_allocation_resource_alignment',1,'']]],
+ ['resource_20allocation_4',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
+ ['resource_20reference_20counting_5',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]],
+ ['resources_6',['resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'Committed versus placed resources'],['../quick_start.html#quick_start_creating_resources',1,'Creating resources']]],
+ ['ring_20buffer_7',['Ring buffer',['../linear_algorithm.html#linear_algorithm_ring_buffer',1,'']]],
+ ['running_20out_20of_20memory_8',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]]
+];
diff --git a/docs/html/search/search.css b/docs/html/search/search.css
index 19f76f9..956f31f 100644
--- a/docs/html/search/search.css
+++ b/docs/html/search/search.css
@@ -5,8 +5,8 @@
display: flex;
justify-content: center;
align-items: center;
- height: 36px;
- margin-right: 1em;
+ height: 43px;
+ margin-right: 0;
}
/*---------------- Search box styling */
@@ -27,43 +27,23 @@ dark-mode-toggle {
white-space : nowrap;
background: var(--search-background-color);
border-radius: 0.65em;
- box-shadow: var(--search-box-shadow);
+ border: 1px solid var(--search-box-border-color);
z-index: 102;
+ margin-right: 4px;
}
#MSearchBox .left {
display: inline-block;
vertical-align: middle;
- height: 1.4em;
-}
-
-#MSearchSelect {
- display: inline-block;
- vertical-align: middle;
- width: 20px;
- height: 19px;
- background-image: var(--search-magnification-select-image);
- margin: 0 0 0 0.3em;
- padding: 0;
+ height: 1.6em;
}
-#MSearchSelectExt {
- display: inline-block;
- vertical-align: middle;
- width: 10px;
- height: 19px;
- background-image: var(--search-magnification-image);
- margin: 0 0 0 0.5em;
- padding: 0;
-}
-
-
#MSearchField {
display: inline-block;
- vertical-align: middle;
+ vertical-align: top;
width: 7.5em;
- height: 19px;
- margin: 0 0.15em;
+ height: 22px;
+ margin: 0 0 0 0.15em;
padding: 0;
line-height: 1em;
border:none;
@@ -86,7 +66,7 @@ dark-mode-toggle {
display: inline-block;
vertical-align: middle;
width: 1.4em;
- height: 1.4em;
+ height: 1.6em;
}
#MSearchClose {
@@ -101,14 +81,100 @@ dark-mode-toggle {
}
#MSearchCloseImg {
- padding: 0.3em;
- margin: 0;
+ margin: 6px 0 0 4px;
+}
+
+.close-icon {
+ width: 11px;
+ height: 11px;
+ background-color: var(--search-close-icon-bg-color);
+ border-radius: 50%;
+ position: relative;
+ display: flex;
+ justify-content: center;
+ align-items: center;
+ box-sizing: content-box;
+}
+
+.close-icon:before,
+.close-icon:after {
+ content: '';
+ position: absolute;
+ width: 7px;
+ height: 1px;
+ background-color: var(--search-close-icon-fg-color);
+}
+
+.close-icon:before {
+ transform: rotate(45deg);
}
+.close-icon:after {
+ transform: rotate(-45deg);
+}
+
+
.MSearchBoxActive #MSearchField {
color: var(--search-active-color);
}
+.search-icon {
+ width: 20px;
+ height: 20px;
+ display: inline-block;
+ position: relative;
+ margin-left: 3px;
+}
+
+#MSearchSelectExt.search-icon {
+ width: 10px;
+}
+
+#MSearchSelectExt + input {
+ margin-left: 5px;
+}
+
+.search-icon::before, .search-icon::after {
+ content: '';
+ position: absolute;
+ border: 1.5px solid var(--search-foreground-color);
+ box-sizing: content-box;
+}
+
+.search-icon::before {
+ width: 6px;
+ height: 6px;
+ border-radius: 50%;
+ top: 7px;
+ left: 2px;
+ background: var(--search-background-color);
+}
+
+.search-icon::after {
+ border: 1px solid var(--search-foreground-color);
+ width: 0px;
+ height: 3px;
+ border-radius: 2px;
+ top: 15px;
+ left: 8px;
+ transform: rotate(-45deg);
+ transform-origin: top left;
+}
+
+.search-icon-dropdown {
+ content: '';
+ width: 0;
+ height: 0;
+ border-left: 3px solid transparent;
+ border-right: 3px solid transparent;
+ border-top: 3px solid var(--search-foreground-color);
+ top: 8px;
+ left: 15px;
+ transform: translateX(-50%);
+ position: absolute;
+}
+
+
/*---------------- Search filter selection */
@@ -119,15 +185,12 @@ dark-mode-toggle {
left: 0; top: 0;
border: 1px solid var(--search-filter-border-color);
background-color: var(--search-filter-background-color);
+ backdrop-filter: var(--search-filter-backdrop-filter);
+ -webkit-backdrop-filter: var(--search-filter-backdrop-filter);
z-index: 10001;
padding-top: 4px;
padding-bottom: 4px;
- -moz-border-radius: 4px;
- -webkit-border-top-left-radius: 4px;
- -webkit-border-top-right-radius: 4px;
- -webkit-border-bottom-left-radius: 4px;
- -webkit-border-bottom-right-radius: 4px;
- -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ border-radius: 4px;
}
.SelectItem {
@@ -176,18 +239,39 @@ iframe#MSearchResults {
height: 15em;
}
+@keyframes slideInSearchResults {
+ from {
+ opacity: 0;
+ transform: translate(0, 15px);
+ }
+
+ to {
+ opacity: 1;
+ transform: translate(0, 20px);
+ }
+}
+
#MSearchResultsWindow {
display: none;
position: absolute;
- left: 0; top: 0;
+ left: auto;
+ right: 4px;
+ top: 0;
border: 1px solid var(--search-results-border-color);
background-color: var(--search-results-background-color);
+ backdrop-filter: var(--search-results-backdrop-filter);
+ -webkit-backdrop-filter: var(--search-results-backdrop-filter);
z-index:10000;
width: 300px;
height: 400px;
overflow: auto;
+ border-radius: 8px;
+ transform: translate(0, 20px);
+ animation: ease-out 280ms slideInSearchResults;
+ box-shadow: 0 2px 8px 0 rgba(0,0,0,.075);
}
+
/* ----------------------------------- */
@@ -201,13 +285,13 @@ iframe#MSearchResults {
}
.SRPage .SREntry {
- font-size: 8pt;
- padding: 1px 5px;
+ font-size: 10pt;
+ padding: 2px 5px;
}
div.SRPage {
margin: 5px 2px;
- background-color: var(--search-results-background-color);
+ /*background-color: var(--search-results-background-color);*/
}
.SRChildren {
@@ -261,14 +345,17 @@ div.searchresults {
margin-right: 10px;
}
+#searchBoxPos1 dark-mode-toggle {
+ margin-top: 4px;
+}
+
/*---------------- External search page results */
.pages b {
- color: white;
+ color: var(--nav-foreground-color);
padding: 5px 5px 3px 5px;
- background-image: var(--nav-gradient-active-image-parent);
- background-repeat: repeat-x;
- text-shadow: 0 1px 1px #000000;
+ background-color: var(--nav-menu-active-bg);
+ border-radius: 4px;
}
.pages {
diff --git a/docs/html/search/search.js b/docs/html/search/search.js
index 666af01..dc14410 100644
--- a/docs/html/search/search.js
+++ b/docs/html/search/search.js
@@ -607,6 +607,12 @@ function createResults(resultsPath) {
elem.setAttribute('className',attr);
}
+ const decodeHtml = (html) => {
+ const txt = document.createElement("textarea");
+ txt.innerHTML = html;
+ return txt.value;
+ };
+
const results = document.getElementById("SRResults");
results.innerHTML = '';
searchData.forEach((elem,index) => {
@@ -620,10 +626,14 @@ function createResults(resultsPath) {
srLink.setAttribute('id','Item'+index);
setKeyActions(srLink,'return searchResults.Nav(event,'+index+')');
setClassAttr(srLink,'SRSymbol');
- srLink.innerHTML = elem[1][0];
+ srLink.innerHTML = decodeHtml(elem[1][0]);
srEntry.appendChild(srLink);
if (elem[1].length==2) { // single result
- srLink.setAttribute('href',resultsPath+elem[1][1][0]);
+ if (elem[1][1][0].startsWith('http://') || elem[1][1][0].startsWith('https://')) { // absolute path
+ srLink.setAttribute('href',elem[1][1][0]);
+ } else { // relative path
+ srLink.setAttribute('href',resultsPath+elem[1][1][0]);
+ }
srLink.setAttribute('onclick','searchBox.CloseResultsWindow()');
if (elem[1][1][1]) {
srLink.setAttribute('target','_parent');
@@ -632,7 +642,7 @@ function createResults(resultsPath) {
}
const srScope = document.createElement('span');
setClassAttr(srScope,'SRScope');
- srScope.innerHTML = elem[1][1][2];
+ srScope.innerHTML = decodeHtml(elem[1][1][2]);
srEntry.appendChild(srScope);
} else { // multiple results
srLink.setAttribute('href','javascript:searchResults.Toggle("SR_'+id+'")');
@@ -643,14 +653,18 @@ function createResults(resultsPath) {
srChild.setAttribute('id','Item'+index+'_c'+c);
setKeyActions(srChild,'return searchResults.NavChild(event,'+index+','+c+')');
setClassAttr(srChild,'SRScope');
- srChild.setAttribute('href',resultsPath+elem[1][c+1][0]);
+ if (elem[1][c+1][0].startsWith('http://') || elem[1][c+1][0].startsWith('https://')) { // absolute path
+ srChild.setAttribute('href',elem[1][c+1][0]);
+ } else { // relative path
+ srChild.setAttribute('href',resultsPath+elem[1][c+1][0]);
+ }
srChild.setAttribute('onclick','searchBox.CloseResultsWindow()');
if (elem[1][c+1][1]) {
srChild.setAttribute('target','_parent');
} else {
srChild.setAttribute('target','_blank');
}
- srChild.innerHTML = elem[1][c+1][2];
+ srChild.innerHTML = decodeHtml(elem[1][c+1][2]);
srChildren.appendChild(srChild);
}
srEntry.appendChild(srChildren);
diff --git a/docs/html/search/searchdata.js b/docs/html/search/searchdata.js
index 1b7813a..2029dc1 100644
--- a/docs/html/search/searchdata.js
+++ b/docs/html/search/searchdata.js
@@ -11,7 +11,7 @@ var indexSectionsWithContent =
8: "adpv",
9: "cd",
10: "d",
- 11: "acdfglmopqrsv"
+ 11: "abcdfghijlmnopqrstuvw"
};
var indexSectionNames =
diff --git a/docs/html/statistics.html b/docs/html/statistics.html
index f261c65..b9b1e29 100644
--- a/docs/html/statistics.html
+++ b/docs/html/statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Statistics
-
-
@@ -33,33 +31,22 @@
-
+
-
- Statistics
+ Statistics
This library contains several functions that return information about its internal state, especially the amount of memory allocated from D3D12.
-
+
Numeric statistics
If you need to obtain basic statistics about memory usage per memory segment group, together with current budget, you can call function D3D12MA::Allocator::GetBudget() and inspect structure D3D12MA::Budget. This is useful to keep track of memory usage and stay withing budget. Example:
D3D12MA::Budget localBudget;
@@ -112,8 +99,8 @@
UINT64 UsageBytesEstimated current memory usage of the program.Definition D3D12MemAlloc.h:486
You can query for more detailed statistics per heap type, memory segment group, and totals, including minimum and maximum allocation size and unused range size, by calling function D3D12MA::Allocator::CalculateStatistics() and inspecting structure D3D12MA::TotalStatistics. This function is slower though, as it has to traverse all the internal data structures, so it should be used only for debugging purposes.
You can query for statistics of a custom pool using function D3D12MA::Pool::GetStatistics() or D3D12MA::Pool::CalculateStatistics().
-You can query for information about a specific allocation using functions of the D3D12MA::Allocation class, e.g. GetSize(), GetOffset(), GetHeap().
-
+
You can query for information about a specific allocation using functions of the D3D12MA::Allocation class, e.g. GetSize(), GetOffset(), GetHeap().
+
JSON dump
You can dump internal state of the allocator to a string in JSON format using function D3D12MA::Allocator::BuildStatsString(). The result is guaranteed to be correct JSON. It uses Windows Unicode (UTF-16) encoding. Any strings provided by user (see D3D12MA::Allocation::SetName()) are copied as-is and properly escaped for JSON. It must be freed using function D3D12MA::Allocator::FreeStatsString().
The format of this JSON string is not part of official documentation of the library, but it will not change in backward-incompatible way without increasing library major version number and appropriate mention in changelog.
@@ -122,7 +109,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html
index 223cc58..f967c0c 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html
index bb90eaa..495fe3f 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::ALLOCATION_CALLBACKS Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
ALLOCATE_FUNC_PTR pAllocate Allocation function.
FREE_FUNC_PTR pFree Dellocation function.
void * pPrivateData Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
-Detailed Description
+Detailed Description
Custom callbacks to CPU memory allocation functions.
-Member Data Documentation
+Member Data Documentation
◆ pAllocate
@@ -159,7 +143,7 @@
-Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
+Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
@@ -169,7 +153,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 0dd1a39..f398da5 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -102,7 +89,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 5363747..d914ec6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,33 +90,28 @@
Inheritance diagram for D3D12MA::ALLOCATION_DESC:
- 
-
-
+
Public Attributes
ALLOCATION_FLAGS Flags Flags for the allocation.
D3D12_HEAP_TYPE HeapType The type of memory heap where the new allocation should be placed.
D3D12_HEAP_FLAGS ExtraHeapFlags Additional heap flags to be used when allocating memory.
Pool * CustomPool Custom pool to place the new resource in. Optional.
void * pPrivateData Custom general-purpose pointer that will be stored in D3D12MA::Allocation.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.
-Member Data Documentation
+Member Data Documentation
◆ CustomPool
@@ -143,7 +125,7 @@
Custom pool to place the new resource in. Optional.
-When not null, the resource will be created inside specified custom pool. Members HeapType, ExtraHeapFlags are then ignored.
+When not null, the resource will be created inside specified custom pool. Members HeapType, ExtraHeapFlags are then ignored.
@@ -162,9 +144,9 @@ D3D12MA::Allocator::CreateResource(), you don't need to care. Necessary flag D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, or D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES is added automatically.
-- If you use D3D12MA::Allocator::AllocateMemory(), you should specify one of those
ALLOW_ONLY flags. Except when you validate that D3D12MA::Allocator::GetD3D12Options().ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1 - then you can leave it 0.
-- You can specify additional flags if needed. Then the memory will always be allocated as separate block using
D3D12Device::CreateCommittedResource or CreateHeap, not as part of an existing larget block.
+- If you use D3D12MA::Allocator::CreateResource(), you don't need to care. Necessary flag D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, or D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES is added automatically.
+- If you use D3D12MA::Allocator::AllocateMemory(), you should specify one of those ALLOW_ONLY flags. Except when you validate that D3D12MA::Allocator::GetD3D12Options().ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1 - then you can leave it 0.
+- You can specify additional flags if needed. Then the memory will always be allocated as separate block using D3D12Device::CreateCommittedResource or CreateHeap, not as part of an existing larget block.
When D3D12MA::ALLOCATION_DESC::CustomPool != NULL this member is ignored.
@@ -199,7 +181,7 @@
The type of memory heap where the new allocation should be placed.
-It must be one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK.
+It must be one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK.
When D3D12MA::ALLOCATION_DESC::CustomPool != NULL this member is ignored.
@@ -226,7 +208,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html
index ccc6e9d..cfc611c 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -102,7 +89,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html
index 8673896..33029a6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::ALLOCATOR_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
ALLOCATOR_FLAGS Flags Flags for the entire allocator.
ID3D12Device * pDevice UINT64 PreferredBlockSize Preferred size of a single ID3D12Heap block to be allocated.
Preferred size of a single ID3D12Heap block to be allocated.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
IDXGIAdapter * pAdapter
-Detailed Description
+Detailed Description
Parameters of created Allocator object. To be used with CreateAllocator().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -148,7 +130,7 @@
DXGI Adapter object that you use for D3D12 and this allocator.
-Allocator is doing AddRef/Release on this object.
+Allocator is doing AddRef/Release on this object.
@@ -181,7 +163,7 @@
Direct3D device object that the allocator should be attached to.
-Allocator is doing AddRef/Release on this object.
+Allocator is doing AddRef/Release on this object.
@@ -197,7 +179,7 @@
-Preferred size of a single ID3D12Heap block to be allocated.
+Preferred size of a single ID3D12Heap block to be allocated.
Set to 0 to use default, which is currently 64 MiB.
@@ -208,7 +190,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_budget-members.html b/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
index ddeda17..26e4bee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_budget.html b/docs/html/struct_d3_d12_m_a_1_1_budget.html
index 4798ab6..8e8f354 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_budget.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_budget.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Budget Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Statistics fetched from the library.
UINT64 UsageBytes Estimated current memory usage of the program.
UINT64 BudgetBytes Estimated amount of memory available to the program.
-Detailed Description
+Detailed Description
Statistics of current memory usage and available budget for a specific memory segment group.
These are fast to calculate. See function D3D12MA::Allocator::GetBudget().
-Member Data Documentation
+Member Data Documentation
◆ BudgetBytes
@@ -129,8 +113,8 @@
Estimated amount of memory available to the program.
-Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
-It might be different (most probably smaller) than memory capacity returned by D3D12MA::Allocator::GetMemoryCapacity() due to factors external to the program, decided by the operating system. Difference BudgetBytes - UsageBytes is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.
+Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
+It might be different (most probably smaller) than memory capacity returned by D3D12MA::Allocator::GetMemoryCapacity() due to factors external to the program, decided by the operating system. Difference BudgetBytes - UsageBytes is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.
@@ -163,8 +147,8 @@
Estimated current memory usage of the program.
-Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
-It might be different than BlockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipeline state objects, descriptor heaps, command lists, or heaps and resources allocated outside of this library, if any.
+Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
+It might be different than BlockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipeline state objects, descriptor heaps, command lists, or heaps and resources allocated outside of this library, if any.
@@ -174,7 +158,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 656581f..9423c7f 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 49c2950..cae7b08 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,49 +90,40 @@
Inheritance diagram for D3D12MA::CALLOCATION_DESC:
- 
-
-
+
Public Member Functions
CALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CALLOCATION_DESC (const ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::ALLOCATION_DESC structure.
CALLOCATION_DESC (Pool *customPool, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of an allocation to be created in a specific custom pool.
CALLOCATION_DESC (D3D12_HEAP_TYPE heapType, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL, D3D12_HEAP_FLAGS extraHeapFlags=D3D12MA_RECOMMENDED_HEAP_FLAGS) noexcept Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::ALLOCATION_DESCPublic Attributes inherited from D3D12MA::ALLOCATION_DESC ALLOCATION_FLAGS Flags Flags for the allocation.
D3D12_HEAP_TYPE HeapType The type of memory heap where the new allocation should be placed.
D3D12_HEAP_FLAGS ExtraHeapFlags Additional heap flags to be used when allocating memory.
Pool * CustomPool Custom pool to place the new resource in. Optional.
void * pPrivateData Custom general-purpose pointer that will be stored in D3D12MA::Allocation.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CALLOCATION_DESC() [1/4]
@@ -273,7 +251,7 @@
-Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
+Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
@@ -283,7 +261,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
index 1cb0dea..66262d0 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -110,7 +97,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
index fb6bf6f..37f7330 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CPOOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,61 +90,48 @@
Inheritance diagram for D3D12MA::CPOOL_DESC:
- 
-
-
+
Public Member Functions
CPOOL_DESC ()=default Default constructor. Leaves the structure uninitialized.
CPOOL_DESC (const POOL_DESC &o) noexcept Constructor initializing from the base D3D12MA::POOL_DESC structure.
CPOOL_DESC (D3D12_HEAP_TYPE heapType, D3D12_HEAP_FLAGS heapFlags, POOL_FLAGS flags=D3D12MA_RECOMMENDED_POOL_FLAGS, UINT64 blockSize=0, UINT minBlockCount=0, UINT maxBlockCount=UINT_MAX, D3D12_RESIDENCY_PRIORITY residencyPriority=D3D12_RESIDENCY_PRIORITY_NORMAL) noexcept Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
CPOOL_DESC (const D3D12_HEAP_PROPERTIES heapProperties, D3D12_HEAP_FLAGS heapFlags, POOL_FLAGS flags=D3D12MA_RECOMMENDED_POOL_FLAGS, UINT64 blockSize=0, UINT minBlockCount=0, UINT maxBlockCount=UINT_MAX, D3D12_RESIDENCY_PRIORITY residencyPriority=D3D12_RESIDENCY_PRIORITY_NORMAL) noexcept Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::POOL_DESC Public Attributes inherited from D3D12MA::POOL_DESC POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CPOOL_DESC() [1/4]
@@ -264,7 +238,7 @@
-Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
+Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
@@ -320,7 +294,7 @@
-Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
+Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
@@ -330,7 +304,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 8eb5d11..da976da 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -104,7 +91,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index cb1fe74..714062b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,43 +90,36 @@
Inheritance diagram for D3D12MA::CVIRTUAL_ALLOCATION_DESC:
- 
-
-
+
Public Member Functions
CVIRTUAL_ALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_ALLOCATION_DESC (const VIRTUAL_ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
CVIRTUAL_ALLOCATION_DESC (UINT64 size, UINT64 alignment, VIRTUAL_ALLOCATION_FLAGS flags=VIRTUAL_ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of a virtual allocation with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_ALLOCATION_DESC() [1/3]
@@ -241,7 +221,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index eeecc96..27af579 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index 78fbb71..e24e9a8 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,40 +90,34 @@
Inheritance diagram for D3D12MA::CVIRTUAL_BLOCK_DESC:
- 
-
-
+
Public Member Functions
CVIRTUAL_BLOCK_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_BLOCK_DESC (const VIRTUAL_BLOCK_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_BLOCK_DESC structure.
CVIRTUAL_BLOCK_DESC (UINT64 size, VIRTUAL_BLOCK_FLAGS flags=VIRTUAL_BLOCK_FLAG_NONE, const ALLOCATION_CALLBACKS *allocationCallbacks=NULL) noexcept Constructor initializing description of a virtual block with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_BLOCK_DESC() [1/3]
@@ -233,7 +214,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
index 698ab11..69adefa 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
index c65cd1a..242a2ed 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_FLAGS Flags Flags.
UINT64 MaxBytesPerPass Maximum numbers of bytes that can be copied during single pass, while moving allocations to different places.
UINT32 MaxAllocationsPerPass Maximum number of allocations that can be moved during single pass to a different place.
-Detailed Description
+Detailed Description
Parameters for defragmentation.
To be used with functions Allocator::BeginDefragmentation() and Pool::BeginDefragmentation().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -172,7 +156,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
index 4fed39a..f20848d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
index 8a8bf70..87c182e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_MOVE Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_MOVE_OPERATION Operation Operation to be performed on the allocation by DefragmentationContext::EndPass(). Default value is DEFRAGMENTATION_MOVE_OPERATION_COPY. You can modify it.
Allocation * pSrcAllocation Allocation that should be moved.
Allocation * pDstTmpAllocation Temporary allocation pointing to destination memory that will replace pSrcAllocation.
Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Detailed Description
+Detailed Description
Single move of an allocation to be done for defragmentation.
-Member Data Documentation
+Member Data Documentation
◆ Operation
@@ -143,9 +127,9 @@
-Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
-- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make
pSrcAllocation point to this memory.
+Temporary allocation pointing to destination memory that will replace pSrcAllocation.
+Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
+- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make pSrcAllocation point to this memory.
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
index 28aefc6..3e0a1e4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -99,7 +86,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
index 1212826..6e37ac2 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,19 +87,17 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT32 MoveCount Number of elements in the pMoves array.
Number of elements in the pMoves array.
DEFRAGMENTATION_MOVE * pMoves Array of moves to be performed by the user in the current defragmentation pass.
-Detailed Description
+Detailed Description
Parameters for incremental defragmentation steps.
To be used with function DefragmentationContext::BeginPass().
-Member Data Documentation
+Member Data Documentation
◆ MoveCount
@@ -125,7 +110,7 @@
-Number of elements in the pMoves array.
+Number of elements in the pMoves array.
@@ -142,12 +127,12 @@
Array of moves to be performed by the user in the current defragmentation pass.
-Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
+Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
For each element, you should:
-- Create a new resource in the place pointed by
pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
-- Store new resource in
pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
-- Copy data from the
pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
+- Create a new resource in the place pointed by pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
+- Store new resource in pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
+- Copy data from the pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
- Make sure these commands finished executing on the GPU.
Only then you can finish defragmentation pass by calling DefragmentationContext::EndPass(). After this call, the allocation will point to the new place in memory.
@@ -162,7 +147,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
index 6723fa3..be2d910 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
index b7f806d..220d0bd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_STATS Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,24 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 BytesMoved Total number of bytes that have been copied while moving allocations to different places.
UINT64 BytesFreed Total number of bytes that have been released to the system by freeing empty heaps.
UINT32 AllocationsMoved Number of allocations that have been moved to different places.
UINT32 HeapsFreed Number of empty ID3D12Heap objects that have been released to the system.
Number of empty ID3D12Heap objects that have been released to the system.
-Detailed Description
+Detailed Description
Statistics returned for defragmentation process by function DefragmentationContext::GetStats().
-Member Data Documentation
+Member Data Documentation
◆ AllocationsMoved
@@ -178,7 +161,7 @@
-Number of empty ID3D12Heap objects that have been released to the system.
+Number of empty ID3D12Heap objects that have been released to the system.
@@ -188,7 +171,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
index 9167002..13c5446 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
index f4f534a..88fa33d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DetailedStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,35 +87,29 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Basic statistics.
UINT UnusedRangeCount Number of free ranges of memory between allocations.
UINT64 AllocationSizeMin Smallest allocation size. UINT64_MAX if there are 0 allocations.
Smallest allocation size. UINT64_MAX if there are 0 allocations.
UINT64 AllocationSizeMax Largest allocation size. 0 if there are 0 allocations.
UINT64 UnusedRangeSizeMin Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
UINT64 UnusedRangeSizeMax Largest empty range size. 0 if there are 0 empty ranges.
-Detailed Description
+Detailed Description
More detailed statistics than D3D12MA::Statistics.
These are slower to calculate. Use for debugging purposes. See functions: D3D12MA::Allocator::CalculateStatistics(), D3D12MA::Pool::CalculateStatistics().
Averages are not provided because they can be easily calculated as:
UINT64 AllocationSizeAvg = DetailedStats.Statistics.AllocationBytes / detailedStats.Statistics.AllocationCount;
UINT64 UnusedBytes = DetailedStats.Statistics.BlockBytes - DetailedStats.Statistics.AllocationBytes;
UINT64 UnusedRangeSizeAvg = UnusedBytes / DetailedStats.UnusedRangeCount;
- Member Data Documentation
+ Member Data Documentation
◆ AllocationSizeMax
@@ -157,7 +138,7 @@
-Smallest allocation size. UINT64_MAX if there are 0 allocations.
+Smallest allocation size. UINT64_MAX if there are 0 allocations.
@@ -221,7 +202,7 @@
-Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
+Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
@@ -231,7 +212,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
index 2ae0d33..654ade6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
index fcb0f64..d812aff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::POOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,45 +90,36 @@
Inheritance diagram for D3D12MA::POOL_DESC:
- 
-
-
+
Public Attributes
POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool.
-Member Data Documentation
+Member Data Documentation
◆ BlockSize
@@ -189,7 +167,7 @@
Heap flags to be used when allocating heaps of this pool.
-It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
+It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
It is recommended to also add D3D12MA_RECOMMENDED_POOL_FLAGS. You can specify additional flags if needed.
@@ -207,7 +185,7 @@
The parameters of memory heap where allocations of this pool should be placed.
-In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
+In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
@@ -224,7 +202,7 @@
Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
-Set to 0 to use default, which is UINT64_MAX, which means no limit.
+Set to 0 to use default, which is UINT64_MAX, which means no limit.
Set to same value as D3D12MA::POOL_DESC::MinBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.
@@ -293,10 +271,10 @@
Residency priority to be set for all allocations made in this pool. Optional.
-Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
-Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
-This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
-There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
+Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
+Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
+This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
+There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
@@ -306,7 +284,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
index a970156..67b61fe 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
index b7e7c30..853c2ff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Statistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,21 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT BlockCount Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
UINT AllocationCount Number of D3D12MA::Allocation objects allocated.
UINT64 BlockBytes Number of bytes allocated in memory blocks.
UINT64 AllocationBytes Total number of bytes occupied by all D3D12MA::Allocation objects.
-Detailed Description
+Detailed Description
Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total.
These are fast to calculate. See functions: D3D12MA::Allocator::GetBudget(), D3D12MA::Pool::GetStatistics().
-Member Data Documentation
+Member Data Documentation
◆ AllocationBytes
@@ -132,7 +115,7 @@
Total number of bytes occupied by all D3D12MA::Allocation objects.
-Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
+Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
@@ -149,7 +132,7 @@
Number of D3D12MA::Allocation objects allocated.
-Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
+Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
@@ -181,7 +164,7 @@
-Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
+Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
- 
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
- 
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
D3D12_SMALL_RESOURCE_PLACEMENT_ALIGNMENT or D3D12_SMALL_MSAA_RESOURCE_PLACEMENT_ALIGNMENT for created textures when possible, which can save memory because some small textures may get their alignment 4 KB and their size a multiply of 4 KB instead of 64 KB. #define D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT 0 - Disables small texture alignment.#define D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT 1 (the default) - Enables conservative algorithm that will use small alignment only for some textures that are surely known to support it.#define D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT 2 - Enables query for small alignment to D3D12 (based on Microsoft sample) which will enable small alignment for more textures, but will also generate D3D Debug Layer error #721 on call to ID3D12Device::GetResourceAllocationInfo, which you should just ignore. 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/annotated.html b/docs/html/annotated.html
index 224e416..1566741 100644
--- a/docs/html/annotated.html
+++ b/docs/html/annotated.html
@@ -3,15 +3,13 @@
-
+
| ▼ND3D12MA | |
| ND3D12MA | |
| CAllocation | Represents single memory allocation |
| CALLOCATION_CALLBACKS | Custom callbacks to CPU memory allocation functions |
| CALLOCATION_DESC | Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource |
| CAllocator | Represents main object of this library initialized for particular ID3D12Device |
| CAllocator | Represents main object of this library initialized for particular ID3D12Device |
| CALLOCATOR_DESC | Parameters of created Allocator object. To be used with CreateAllocator() |
| CBudget | Statistics of current memory usage and available budget for a specific memory segment group |
| CCALLOCATION_DESC | Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure |
-Generated by
1.13.2
+Generated by 1.14.0
+Public Member FunctionsUINT64 | GetOffset () const | | UINT64 | GetAlignment () const | | UINT64 | GetSize () const | | ID3D12Resource * | GetResource () const | | void | SetResource (ID3D12Resource *pResource) | | ID3D12Heap * | GetHeap () const | | void | SetPrivateData (void *pPrivateData) | | void * | GetPrivateData () const | | void | SetName (LPCWSTR Name) | | LPCWSTR | GetName () const | | | |||||||||||||||||||||||||||||||||
Detailed Description
+Detailed Description
Represents single memory allocation.
It may be either implicit memory heap dedicated to a single resource or a specific region of a bigger heap plus unique offset.
To create such object, fill structure D3D12MA::ALLOCATION_DESC and call function Allocator::CreateResource.
The object remembers size and some other information. To retrieve this information, use methods of this class.
-The object also remembers ID3D12Resource and "owns" a reference to it, so it calls Release() on the resource when destroyed.
Member Function Documentation
+The object also remembers ID3D12Resource and "owns" a reference to it, so it calls Release() on the resource when destroyed.
+Member Function Documentation
◆ GetAlignment()
@@ -323,9 +300,9 @@D3D12MA::Allocator::CreateResource, this is the size of the resource returned by ID3D12Device::GetResourceAllocationInfo.
+If you created a buffer or a texture together with the allocation using function D3D12MA::Allocator::CreateResource, this is the size of the resource returned by ID3D12Device::GetResourceAllocationInfo.
For allocations made out of bigger memory blocks, this also is the size of the memory region assigned exclusively to this allocation.
-For resources created as committed, this value may not be accurate. DirectX implementation may optimize memory usage internally so that you may even observe regions of ID3D12Resource::GetGPUVirtualAddress() + Allocation::GetSize() to overlap in memory and still work correctly.
+For resources created as committed, this value may not be accurate. DirectX implementation may optimize memory usage internally so that you may even observe regions of ID3D12Resource::GetGPUVirtualAddress() + Allocation::GetSize() to overlap in memory and still work correctly.
@@ -347,7 +324,7 @@ Name can be null.
@@ -398,7 +375,7 @@ Member Data Documentation
+Member Data Documentation
◆ allocHandle
@@ -531,7 +508,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_allocator-members.html b/docs/html/class_d3_d12_m_a_1_1_allocator-members.html
index 469eb2c..ca74e46 100644
--- a/docs/html/class_d3_d12_m_a_1_1_allocator-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_allocator-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -118,7 +105,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_allocator.html b/docs/html/class_d3_d12_m_a_1_1_allocator.html
index 2817820..08b73a0 100644
--- a/docs/html/class_d3_d12_m_a_1_1_allocator.html
+++ b/docs/html/class_d3_d12_m_a_1_1_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Allocator Class Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -95,7 +82,7 @@
-Represents main object of this library initialized for particular ID3D12Device.
+
Represents main object of this library initialized for particular ID3D12Device.
More...
#include <D3D12MemAlloc.h>
@@ -106,71 +93,52 @@
-
+
Public Member Functions
const D3D12_FEATURE_DATA_D3D12_OPTIONS & GetD3D12Options () const Returns cached options retrieved from D3D12 device.
BOOL IsUMA () const Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::UMA was found to be true.
Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::UMA was found to be true.
BOOL IsCacheCoherentUMA () const Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMA was found to be true.
Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMA was found to be true.
BOOL IsGPUUploadHeapSupported () const Returns true if GPU Upload Heaps are supported on the current system.
UINT64 GetMemoryCapacity (UINT memorySegmentGroup) const Returns total amount of memory of specific segment group, in bytes.
HRESULT CreateResource (const ALLOCATION_DESC *pAllocDesc, const D3D12_RESOURCE_DESC *pResourceDesc, D3D12_RESOURCE_STATES InitialResourceState, const D3D12_CLEAR_VALUE *pOptimizedClearValue, Allocation **ppAllocation, REFIID riidResource, void **ppvResource) Allocates memory and creates a D3D12 resource (buffer or texture). This is the main allocation function.
HRESULT CreateResource2 (const ALLOCATION_DESC *pAllocDesc, const D3D12_RESOURCE_DESC1 *pResourceDesc, D3D12_RESOURCE_STATES InitialResourceState, const D3D12_CLEAR_VALUE *pOptimizedClearValue, Allocation **ppAllocation, REFIID riidResource, void **ppvResource) Similar to Allocator::CreateResource, but supports new structure D3D12_RESOURCE_DESC1.
Similar to Allocator::CreateResource, but supports new structure D3D12_RESOURCE_DESC1.
HRESULT CreateResource3 (const ALLOCATION_DESC *pAllocDesc, const D3D12_RESOURCE_DESC1 *pResourceDesc, D3D12_BARRIER_LAYOUT InitialLayout, const D3D12_CLEAR_VALUE *pOptimizedClearValue, UINT32 NumCastableFormats, const DXGI_FORMAT *pCastableFormats, Allocation **ppAllocation, REFIID riidResource, void **ppvResource) Similar to Allocator::CreateResource2, but there are initial layout instead of state and castable formats list.
HRESULT AllocateMemory (const ALLOCATION_DESC *pAllocDesc, const D3D12_RESOURCE_ALLOCATION_INFO *pAllocInfo, Allocation **ppAllocation) Allocates memory without creating any resource placed in it.
HRESULT CreateAliasingResource (Allocation *pAllocation, UINT64 AllocationLocalOffset, const D3D12_RESOURCE_DESC *pResourceDesc, D3D12_RESOURCE_STATES InitialResourceState, const D3D12_CLEAR_VALUE *pOptimizedClearValue, REFIID riidResource, void **ppvResource) Creates a new resource in place of an existing allocation. This is useful for memory aliasing.
HRESULT CreateAliasingResource1 (Allocation *pAllocation, UINT64 AllocationLocalOffset, const D3D12_RESOURCE_DESC1 *pResourceDesc, D3D12_RESOURCE_STATES InitialResourceState, const D3D12_CLEAR_VALUE *pOptimizedClearValue, REFIID riidResource, void **ppvResource) Similar to Allocator::CreateAliasingResource, but supports new structure D3D12_RESOURCE_DESC1.
Similar to Allocator::CreateAliasingResource, but supports new structure D3D12_RESOURCE_DESC1.
HRESULT CreateAliasingResource2 (Allocation *pAllocation, UINT64 AllocationLocalOffset, const D3D12_RESOURCE_DESC1 *pResourceDesc, D3D12_BARRIER_LAYOUT InitialLayout, const D3D12_CLEAR_VALUE *pOptimizedClearValue, UINT32 NumCastableFormats, const DXGI_FORMAT *pCastableFormats, REFIID riidResource, void **ppvResource) Similar to Allocator::CreateAliasingResource1, but there are initial layout instead of state and castable formats list.
HRESULT CreatePool (const POOL_DESC *pPoolDesc, Pool **ppPool) Creates custom pool.
void SetCurrentFrameIndex (UINT frameIndex) Sets the index of the current frame.
void GetBudget (Budget *pLocalBudget, Budget *pNonLocalBudget) Retrieves information about current memory usage and budget.
void CalculateStatistics (TotalStatistics *pStats) Retrieves statistics from current state of the allocator.
void BuildStatsString (WCHAR **ppStatsString, BOOL DetailedMap) const Builds and returns statistics as a string in JSON format.
void FreeStatsString (WCHAR *pStatsString) const Frees memory of a string returned from Allocator::BuildStatsString.
void BeginDefragmentation (const DEFRAGMENTATION_DESC *pDesc, DefragmentationContext **ppContext) Begins defragmentation process of the default pools.
-Detailed Description
-Represents main object of this library initialized for particular ID3D12Device.
-Fill structure D3D12MA::ALLOCATOR_DESC and call function CreateAllocator() to create it. Call method Release() to destroy it.
-It is recommended to create just one object of this type per ID3D12Device object, right after Direct3D 12 is initialized and keep it alive until before Direct3D device is destroyed.
-Member Function Documentation
+Detailed Description
+Represents main object of this library initialized for particular ID3D12Device.
+Fill structure D3D12MA::ALLOCATOR_DESC and call function CreateAllocator() to create it. Call method Release() to destroy it.
+It is recommended to create just one object of this type per ID3D12Device object, right after Direct3D 12 is initialized and keep it alive until before Direct3D device is destroyed.
+Member Function Documentation
◆ AllocateMemory()
@@ -196,9 +164,9 @@
Allocates memory without creating any resource placed in it.
-This function is similar to ID3D12Device::CreateHeap, but it may really assign part of a larger, existing heap to the allocation.
-pAllocDesc->heapFlags should contain one of these values, depending on type of resources you are going to create in this memory: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if you validate that ResourceHeapTier = 2 - then heapFlags may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0. Additional flags in heapFlags are allowed as well.
-pAllocInfo->SizeInBytes must be multiply of 64KB. pAllocInfo->Alignment must be one of the legal values as described in documentation of D3D12_HEAP_DESC.
+This function is similar to ID3D12Device::CreateHeap, but it may really assign part of a larger, existing heap to the allocation.
+pAllocDesc->heapFlags should contain one of these values, depending on type of resources you are going to create in this memory: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if you validate that ResourceHeapTier = 2 - then heapFlags may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0. Additional flags in heapFlags are allowed as well.
+pAllocInfo->SizeInBytes must be multiply of 64KB. pAllocInfo->Alignment must be one of the legal values as described in documentation of D3D12_HEAP_DESC.
If you use D3D12MA::ALLOCATION_FLAG_COMMITTED you will get a separate memory block - a heap that always has offset 0.
@@ -257,7 +225,7 @@ Parameters
[out] ppStatsString Must be freed using Allocator::FreeStatsString. DetailedMap TRUE to include full list of allocations (can make the string quite long), FALSE to only return statistics. DetailedMap TRUE to include full list of allocations (can make the string quite long), FALSE to only return statistics.
@@ -332,17 +300,17 @@ Parameters
- pAllocation Existing allocation indicating the memory where the new resource should be created. It can be created using D3D12MA::Allocator::CreateResource and already have a resource bound to it, or can be a raw memory allocated with D3D12MA::Allocator::AllocateMemory. It must not be created as committed so that ID3D12Heap is available and not implicit. AllocationLocalOffset Additional offset in bytes to be applied when allocating the resource. Local from the start of pAllocation, not the beginning of the whole ID3D12Heap! If the new resource should start from the beginning of the pAllocation it should be 0. pAllocation Existing allocation indicating the memory where the new resource should be created. It can be created using D3D12MA::Allocator::CreateResource and already have a resource bound to it, or can be a raw memory allocated with D3D12MA::Allocator::AllocateMemory. It must not be created as committed so that ID3D12Heap is available and not implicit. AllocationLocalOffset Additional offset in bytes to be applied when allocating the resource. Local from the start of pAllocation, not the beginning of the whole ID3D12Heap! If the new resource should start from the beginning of the pAllocation it should be 0. pResourceDesc Description of the new resource to be created. InitialResourceState pOptimizedClearValue riidResource [out] ppvResource Returns pointer to the new resource. The resource is not bound with pAllocation. This pointer must not be null - you must get the resource pointer and Release it when no longer needed. [out] ppvResource Returns pointer to the new resource. The resource is not bound with pAllocation. This pointer must not be null - you must get the resource pointer and Release it when no longer needed.
-Memory requirements of the new resource are checked for validation. If its size exceeds the end of pAllocation or required alignment is not fulfilled considering pAllocation->GetOffset() + AllocationLocalOffset, the function returns E_INVALIDARG.
+Memory requirements of the new resource are checked for validation. If its size exceeds the end of pAllocation or required alignment is not fulfilled considering pAllocation->GetOffset() + AllocationLocalOffset, the function returns E_INVALIDARG.
@@ -390,9 +358,9 @@
-Similar to Allocator::CreateAliasingResource, but supports new structure D3D12_RESOURCE_DESC1.
-It internally uses ID3D12Device8::CreatePlacedResource1.
-To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
+Similar to Allocator::CreateAliasingResource, but supports new structure D3D12_RESOURCE_DESC1.
+It internally uses ID3D12Device8::CreatePlacedResource1.
+To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
@@ -451,8 +419,8 @@
Similar to Allocator::CreateAliasingResource1, but there are initial layout instead of state and castable formats list.
-It internally uses ID3D12Device10::CreatePlacedResource2.
-To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
+It internally uses ID3D12Device10::CreatePlacedResource2.
+To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
@@ -524,9 +492,9 @@
Allocates memory and creates a D3D12 resource (buffer or texture). This is the main allocation function.
-The function is similar to ID3D12Device::CreateCommittedResource, but it may really call ID3D12Device::CreatePlacedResource to assign part of a larger, existing memory heap to the new resource, which is the main purpose of this whole library.
-If ppvResource is null, you receive only ppAllocation object from this function. It holds pointer to ID3D12Resource that can be queried using function D3D12MA::Allocation::GetResource(). Reference count of the resource object is 1. It is automatically destroyed when you destroy the allocation object.
-If ppvResource is not null, you receive pointer to the resource next to allocation object. Reference count of the resource object is then increased by calling QueryInterface, so you need to manually Release it along with the allocation.
+The function is similar to ID3D12Device::CreateCommittedResource, but it may really call ID3D12Device::CreatePlacedResource to assign part of a larger, existing memory heap to the new resource, which is the main purpose of this whole library.
+If ppvResource is null, you receive only ppAllocation object from this function. It holds pointer to ID3D12Resource that can be queried using function D3D12MA::Allocation::GetResource(). Reference count of the resource object is 1. It is automatically destroyed when you destroy the allocation object.
+If ppvResource is not null, you receive pointer to the resource next to allocation object. Reference count of the resource object is then increased by calling QueryInterface, so you need to manually Release it along with the allocation.
- Parameters
-
@@ -587,9 +555,9 @@
-Similar to Allocator::CreateResource, but supports new structure D3D12_RESOURCE_DESC1.
-It internally uses ID3D12Device8::CreateCommittedResource2 or ID3D12Device8::CreatePlacedResource1.
-To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
+Similar to Allocator::CreateResource, but supports new structure D3D12_RESOURCE_DESC1.
+It internally uses ID3D12Device8::CreateCommittedResource2 or ID3D12Device8::CreatePlacedResource1.
+To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
@@ -648,8 +616,8 @@
Similar to Allocator::CreateResource2, but there are initial layout instead of state and castable formats list.
-It internally uses ID3D12Device10::CreateCommittedResource3 or ID3D12Device10::CreatePlacedResource2.
-To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
+It internally uses ID3D12Device10::CreateCommittedResource3 or ID3D12Device10::CreatePlacedResource2.
+To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
@@ -700,14 +668,14 @@ IsUMA() == FALSE (discrete graphics card):
-pLocalBudget returns the budget of the video memory.pNonLocalBudget returns the budget of the system memory available for D3D12 resources.- When IsUMA() == FALSE (discrete graphics card):
+- pLocalBudget returns the budget of the video memory.
+- pNonLocalBudget returns the budget of the system memory available for D3D12 resources.
-- When IsUMA()
== TRUE (integrated graphics chip):
-pLocalBudget returns the budget of the shared memory available for all D3D12 resources. All memory is considered "local".pNonLocalBudget is not applicable and returns zeros.- When IsUMA() == TRUE (integrated graphics chip):
+- pLocalBudget returns the budget of the shared memory available for all D3D12 resources. All memory is considered "local".
+- pNonLocalBudget is not applicable and returns zeros.
@@ -753,20 +721,20 @@ - Parameters
-
- memorySegmentGroup use DXGI_MEMORY_SEGMENT_GROUP_LOCAL or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL. memorySegmentGroup use DXGI_MEMORY_SEGMENT_GROUP_LOCAL or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL.
-This information is taken from DXGI_ADAPTER_DESC. It is not recommended to use this number. You should preferably call GetBudget() and limit memory usage to D3D12MA::Budget::BudgetBytes instead.
+This information is taken from DXGI_ADAPTER_DESC. It is not recommended to use this number. You should preferably call GetBudget() and limit memory usage to D3D12MA::Budget::BudgetBytes instead.
-- When IsUMA()
== FALSE (discrete graphics card):
-GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the video memory.GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) returns the size of the system memory available for D3D12 resources.- When IsUMA() == FALSE (discrete graphics card):
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the video memory.
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) returns the size of the system memory available for D3D12 resources.
-- When IsUMA()
== TRUE (integrated graphics chip):
-GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the shared memory available for all D3D12 resources. All memory is considered "local".GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) is not applicable and returns 0. - When IsUMA() == TRUE (integrated graphics chip):
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the shared memory available for all D3D12 resources. All memory is considered "local".
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) is not applicable and returns 0.
@@ -788,7 +756,7 @@
-Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMA was found to be true.
+Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMA was found to be true.
For more information about how to use it, see articles in Microsoft Docs articles:
- "UMA Optimizations: CPU Accessible Textures and Standard Swizzle"
@@ -814,8 +782,8 @@
Returns true if GPU Upload Heaps are supported on the current system.
-When true, you can use D3D12_HEAP_TYPE_GPU_UPLOAD.
-This flag is fetched from D3D12_FEATURE_D3D12_OPTIONS16::GPUUploadHeapSupported.
+When true, you can use D3D12_HEAP_TYPE_GPU_UPLOAD.
+This flag is fetched from D3D12_FEATURE_D3D12_OPTIONS16::GPUUploadHeapSupported.
@@ -834,7 +802,7 @@
-Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::UMA was found to be true.
+Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::UMA was found to be true.
For more information about how to use it, see articles in Microsoft Docs articles:
- "UMA Optimizations: CPU Accessible Textures and Standard Swizzle"
@@ -870,7 +838,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html
index 4049a20..6cfb1dd 100644
--- a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html
index 405cb9f..7ab0038 100644
--- a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html
+++ b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DefragmentationContext Class Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,22 +93,19 @@
-
+
Public Member Functions
HRESULT BeginPass (DEFRAGMENTATION_PASS_MOVE_INFO *pPassInfo) Starts single defragmentation pass.
HRESULT EndPass (DEFRAGMENTATION_PASS_MOVE_INFO *pPassInfo) Ends single defragmentation pass.
void GetStats (DEFRAGMENTATION_STATS *pStats) Returns statistics of the defragmentation performed so far.
-Detailed Description
+Detailed Description
Represents defragmentation process in progress.
You can create this object using Allocator::BeginDefragmentation (for default pools) or Pool::BeginDefragmentation (for a custom pool).
-Member Function Documentation
+Member Function Documentation
◆ BeginPass()
@@ -145,8 +129,8 @@ - Returns
-S_OK if no more moves are possible. Then you can omit call to DefragmentationContext::EndPass() and simply end whole defragmentation.S_FALSE if there are pending moves returned in pPassInfo. You need to perform them, call DefragmentationContext::EndPass(), and then preferably try another pass with DefragmentationContext::BeginPass(). - S_OK if no more moves are possible. Then you can omit call to DefragmentationContext::EndPass() and simply end whole defragmentation.
+- S_FALSE if there are pending moves returned in pPassInfo. You need to perform them, call DefragmentationContext::EndPass(), and then preferably try another pass with DefragmentationContext::BeginPass().
- Returns
- Returns
S_OK if no more moves are possible or S_FALSE if more defragmentations are possible.
-Ends incremental defragmentation pass and commits all defragmentation moves from pPassInfo. After this call:
+- Returns
- Returns S_OK if no more moves are possible or S_FALSE if more defragmentations are possible.
+Ends incremental defragmentation pass and commits all defragmentation moves from pPassInfo. After this call:
-- Allocation at
pPassInfo[i].pSrcAllocation that had pPassInfo[i].Operation == DEFRAGMENTATION_MOVE_OPERATION_COPY (which is the default) will be pointing to the new destination place.
-- Allocation at
pPassInfo[i].pSrcAllocation that had pPassInfo[i].operation == DEFRAGMENTATION_MOVE_OPERATION_DESTROY will be released.
+- Allocation at pPassInfo[i].pSrcAllocation that had pPassInfo[i].Operation == DEFRAGMENTATION_MOVE_OPERATION_COPY (which is the default) will be pointing to the new destination place.
+- Allocation at pPassInfo[i].pSrcAllocation that had pPassInfo[i].operation == DEFRAGMENTATION_MOVE_OPERATION_DESTROY will be released.
If no more moves are possible you can end whole defragmentation.
@@ -209,7 +193,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_pool-members.html b/docs/html/class_d3_d12_m_a_1_1_pool-members.html
index e500fb5..9acf601 100644
--- a/docs/html/class_d3_d12_m_a_1_1_pool-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_pool-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -104,7 +91,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_pool.html b/docs/html/class_d3_d12_m_a_1_1_pool.html
index 7aabe1c..07742d9 100644
--- a/docs/html/class_d3_d12_m_a_1_1_pool.html
+++ b/docs/html/class_d3_d12_m_a_1_1_pool.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Pool Class Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,32 +93,26 @@
-
+
Public Member Functions
POOL_DESC GetDesc () const Returns copy of parameters of the pool.
void GetStatistics (Statistics *pStats) Retrieves basic statistics of the custom pool that are fast to calculate.
void CalculateStatistics (DetailedStatistics *pStats) Retrieves detailed statistics of the custom pool that are slower to calculate.
void SetName (LPCWSTR Name) Associates a name with the pool. This name is for use in debug diagnostics and tools.
LPCWSTR GetName () const Returns the name associated with the pool object.
HRESULT BeginDefragmentation (const DEFRAGMENTATION_DESC *pDesc, DefragmentationContext **ppContext) Begins defragmentation process of the current pool.
-Detailed Description
+Detailed Description
Custom memory pool.
Represents a separate set of heaps (memory blocks) that can be used to create D3D12MA::Allocation-s and resources in it. Usually there is no need to create custom pools - creating resources in default pool is sufficient.
To create custom pool, fill D3D12MA::POOL_DESC and call D3D12MA::Allocator::CreatePool.
-Member Function Documentation
+Member Function Documentation
◆ BeginDefragmentation()
@@ -160,8 +141,8 @@ - Returns
-S_OK if defragmentation can begin.E_NOINTERFACE if defragmentation is not supported.- S_OK if defragmentation can begin.
+- E_NOINTERFACE if defragmentation is not supported.
For more information about defragmentation, see documentation chapter: Defragmentation.
@@ -276,7 +257,7 @@ Name can be NULL.
@@ -286,7 +267,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html b/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html
index 190326b..1e40ead 100644
--- a/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -109,7 +96,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_virtual_block.html b/docs/html/class_d3_d12_m_a_1_1_virtual_block.html
index 5f6a3f2..0cb9114 100644
--- a/docs/html/class_d3_d12_m_a_1_1_virtual_block.html
+++ b/docs/html/class_d3_d12_m_a_1_1_virtual_block.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualBlock Class Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,45 +93,35 @@
-
+
Public Member Functions
BOOL IsEmpty () const Returns true if the block is empty - contains 0 allocations.
void GetAllocationInfo (VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) const Returns information about an allocation - its offset, size and custom pointer.
HRESULT Allocate (const VIRTUAL_ALLOCATION_DESC *pDesc, VirtualAllocation *pAllocation, UINT64 *pOffset) Creates new allocation.
void FreeAllocation (VirtualAllocation allocation) Frees the allocation.
void Clear () Frees all the allocations.
void SetAllocationPrivateData (VirtualAllocation allocation, void *pPrivateData) Changes custom pointer for an allocation to a new value.
void GetStatistics (Statistics *pStats) const Retrieves basic statistics of the virtual block that are fast to calculate.
void CalculateStatistics (DetailedStatistics *pStats) const Retrieves detailed statistics of the virtual block that are slower to calculate.
void BuildStatsString (WCHAR **ppStatsString) const Builds and returns statistics as a string in JSON format, including the list of allocations with their parameters.
void FreeStatsString (WCHAR *pStatsString) const Frees memory of a string returned from VirtualBlock::BuildStatsString.
-Detailed Description
+Detailed Description
Represents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory.
This class allows to use the core algorithm of the library custom allocations e.g. CPU memory or sub-allocation regions inside a single GPU buffer.
-To create this object, fill in D3D12MA::VIRTUAL_BLOCK_DESC and call CreateVirtualBlock(). To destroy it, call its method VirtualBlock::Release(). You need to free all the allocations within this block or call Clear() before destroying it.
+To create this object, fill in D3D12MA::VIRTUAL_BLOCK_DESC and call CreateVirtualBlock(). To destroy it, call its method VirtualBlock::Release(). You need to free all the allocations within this block or call Clear() before destroying it.
This object is not thread-safe - should not be used from multiple threads simultaneously, must be synchronized externally.
-Member Function Documentation
+Member Function Documentation
◆ Allocate()
@@ -178,8 +155,8 @@ - Returns
S_OK if allocation succeeded, E_OUTOFMEMORY if it failed.If the allocation failed, pAllocation->AllocHandle is set to 0 and pOffset, if not null, is set to UINT64_MAX.
+- Returns
- S_OK if allocation succeeded, E_OUTOFMEMORY if it failed.
+If the allocation failed, pAllocation->AllocHandle is set to 0 and pOffset, if not null, is set to UINT64_MAX.
@@ -268,7 +245,7 @@
Frees the allocation.
-Calling this function with allocation.AllocHandle == 0 is correct and does nothing.
+Calling this function with allocation.AllocHandle == 0 is correct and does nothing.
@@ -387,7 +364,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/classes.html b/docs/html/classes.html
index 3b8ddf2..e85eb86 100644
--- a/docs/html/classes.html
+++ b/docs/html/classes.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Index
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/configuration.html b/docs/html/configuration.html
index 8eeaa50..65d7bdd 100644
--- a/docs/html/configuration.html
+++ b/docs/html/configuration.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Configuration
-
-
@@ -33,33 +31,22 @@
-
+
-
- Configuration
+ Configuration
-Please check file D3D12MemAlloc.cpp lines between "Configuration Begin" and "Configuration End" to find macros that you can define to change the behavior of the library, primarily for debugging purposes.
-
+Please check file D3D12MemAlloc.cpp lines between "Configuration Begin" and "Configuration End" to find macros that you can define to change the behavior of the library, primarily for debugging purposes.
+
Custom CPU memory allocator
-If you use custom allocator for CPU memory rather than default C++ operator new and delete or malloc and free functions, you can make this library using your allocator as well by filling structure D3D12MA::ALLOCATION_CALLBACKS and passing it as optional member D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks. Functions pointed there will be used by the library to make any CPU-side allocations. Example:
+If you use custom allocator for CPU memory rather than default C++ operator new and delete or malloc and free functions, you can make this library using your allocator as well by filling structure D3D12MA::ALLOCATION_CALLBACKS and passing it as optional member D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks. Functions pointed there will be used by the library to make any CPU-side allocations. Example:
#include <malloc.h>
void* CustomAllocate(size_t Size, size_t Alignment, void* pPrivateData)
@@ -133,11 +120,11 @@
ALLOCATOR_FLAGS FlagsFlags for the entire allocator.Definition D3D12MemAlloc.h:1126
-
+
Debug margins
-
By default, allocations are laid out in memory blocks next to each other if possible (considering required alignment returned by ID3D12Device::GetResourceAllocationInfo).
+By default, allocations are laid out in memory blocks next to each other if possible (considering required alignment returned by ID3D12Device::GetResourceAllocationInfo).
-Define macro D3D12MA_DEBUG_MARGIN to some non-zero value (e.g. 16) inside "D3D12MemAlloc.cpp" to enforce specified number of bytes as a margin after every allocation.
+Define macro D3D12MA_DEBUG_MARGIN to some non-zero value (e.g. 16) inside "D3D12MemAlloc.cpp" to enforce specified number of bytes as a margin after every allocation.
If your bug goes away after enabling margins, it means it may be caused by memory being overwritten outside of allocation boundaries. It is not 100% certain though. Change in application behavior may also be caused by different order and distribution of allocations across memory blocks after margins are applied.
Margins work with all memory heap types.
@@ -149,7 +136,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/custom_pools.html b/docs/html/custom_pools.html
index 9112b38..0bfd570 100644
--- a/docs/html/custom_pools.html
+++ b/docs/html/custom_pools.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Custom memory pools
-
-
@@ -33,33 +31,22 @@
-
+
-
- Custom memory pools
+ Custom memory pools
-A "pool" is a collection of memory blocks that share certain properties. Allocator creates 3 default pools: for D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK. A default pool automatically grows in size. Size of allocated blocks is also variable and managed automatically. Typical allocations are created in these pools. You can also create custom pools.
-
+A "pool" is a collection of memory blocks that share certain properties. Allocator creates 3 default pools: for D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK. A default pool automatically grows in size. Size of allocated blocks is also variable and managed automatically. Typical allocations are created in these pools. You can also create custom pools.
+
Usage
To create a custom pool, fill in structure D3D12MA::POOL_DESC and call function D3D12MA::Allocator::CreatePool to obtain object D3D12MA::Pool. Example:
All allocations must be released before releasing the pool. The pool must be released before relasing the allocator.
alloc->Release();
pool->Release();
-
+
Features and benefits
While it is recommended to use default pools whenever possible for simplicity and to give the allocator more opportunities for internal optimizations, custom pools may be useful in following cases:
- To keep some resources separate from others in memory.
- To keep track of memory usage of just a specific group of resources. Statistics can be queried using D3D12MA::Pool::CalculateStatistics.
-- To use specific size of a memory block (
ID3D12Heap). To set it, use member D3D12MA::POOL_DESC::BlockSize. When set to 0, the library uses automatically determined, variable block sizes.
+- To use specific size of a memory block (ID3D12Heap). To set it, use member D3D12MA::POOL_DESC::BlockSize. When set to 0, the library uses automatically determined, variable block sizes.
- To reserve some minimum amount of memory allocated. To use it, set member D3D12MA::POOL_DESC::MinBlockCount.
- To limit maximum amount of memory allocated. To use it, set member D3D12MA::POOL_DESC::MaxBlockCount.
-- To use extended parameters of the D3D12 memory allocation. While resources created from default pools can only specify
D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK, a custom pool may use non-standard D3D12_HEAP_PROPERTIES (member D3D12MA::POOL_DESC::HeapProperties) and D3D12_HEAP_FLAGS (D3D12MA::POOL_DESC::HeapFlags), which is useful e.g. for cross-adapter sharing or UMA (see also D3D12MA::Allocator::IsUMA).
+- To use extended parameters of the D3D12 memory allocation. While resources created from default pools can only specify D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK, a custom pool may use non-standard D3D12_HEAP_PROPERTIES (member D3D12MA::POOL_DESC::HeapProperties) and D3D12_HEAP_FLAGS (D3D12MA::POOL_DESC::HeapFlags), which is useful e.g. for cross-adapter sharing or UMA (see also D3D12MA::Allocator::IsUMA).
New versions of this library support creating committed allocations in custom pools. It is supported only when D3D12MA::POOL_DESC::BlockSize = 0. To use this feature, set D3D12MA::ALLOCATION_DESC::CustomPool to the pointer to your custom pool and D3D12MA::ALLOCATION_DESC::Flags to D3D12MA::ALLOCATION_FLAG_COMMITTED. Example:
ALLOCATION_DESC allocDesc = {};
@@ -136,12 +123,12 @@
ID3D12Resource* res;
hr = allocator->CreateResource(&allocDesc, &resDesc,
D3D12_RESOURCE_STATE_GENERIC_READ, NULL, &alloc, IID_PPV_ARGS(&res));
-
This feature may seem unnecessary, but creating committed allocations from custom pools may be useful in some cases, e.g. to have separate memory usage statistics for some group of resources or to use extended allocation parameters, like custom D3D12_HEAP_PROPERTIES, which are available only in custom pools.
+This feature may seem unnecessary, but creating committed allocations from custom pools may be useful in some cases, e.g. to have separate memory usage statistics for some group of resources or to use extended allocation parameters, like custom D3D12_HEAP_PROPERTIES, which are available only in custom pools.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/defragmentation.html b/docs/html/defragmentation.html
index d68a400..b82dbde 100644
--- a/docs/html/defragmentation.html
+++ b/docs/html/defragmentation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Defragmentation
-
-
@@ -33,33 +31,22 @@
-
+
-
- Defragmentation
+ Defragmentation
Interleaved allocations and deallocations of many objects of varying size can cause fragmentation over time, which can lead to a situation where the library is unable to find a continuous range of free memory for a new allocation despite there is enough free space, just scattered across many small free ranges between existing allocations.
-To mitigate this problem, you can use defragmentation feature. It doesn't happen automatically though and needs your cooperation, because D3D12MA is a low level library that only allocates memory. It cannot recreate buffers and textures in a new place as it doesn't remember the contents of D3D12_RESOURCE_DESC structure. It cannot copy their contents as it doesn't record any commands to a command list.
+To mitigate this problem, you can use defragmentation feature. It doesn't happen automatically though and needs your cooperation, because D3D12MA is a low level library that only allocates memory. It cannot recreate buffers and textures in a new place as it doesn't remember the contents of D3D12_RESOURCE_DESC structure. It cannot copy their contents as it doesn't record any commands to a command list.
Example:
D3D12MA::DEFRAGMENTATION_DESC defragDesc = {};
defragDesc.Flags = D3D12MA::DEFRAGMENTATION_FLAG_ALGORITHM_FAST;
@@ -162,11 +149,11 @@
Parameters for incremental defragmentation steps.Definition D3D12MemAlloc.h:768
DEFRAGMENTATION_MOVE * pMovesArray of moves to be performed by the user in the current defragmentation pass.Definition D3D12MemAlloc.h:792
UINT32 MoveCountNumber of elements in the pMoves array.Definition D3D12MemAlloc.h:770
-Although functions like D3D12MA::Allocator::CreateResource() create an allocation and a buffer/texture at once, these are just a shortcut for allocating memory and creating a placed resource. Defragmentation works on memory allocations only. You must handle the rest manually. Defragmentation is an iterative process that should repreat "passes" as long as related functions return S_FALSE not S_OK. In each pass:
+Although functions like D3D12MA::Allocator::CreateResource() create an allocation and a buffer/texture at once, these are just a shortcut for allocating memory and creating a placed resource. Defragmentation works on memory allocations only. You must handle the rest manually. Defragmentation is an iterative process that should repreat "passes" as long as related functions return S_FALSE not S_OK. In each pass:
- D3D12MA::DefragmentationContext::BeginPass() function call:
- Calculates and returns the list of allocations to be moved in this pass. Note this can be a time-consuming process.
-- Reserves destination memory for them by creating temporary destination allocations that you can query for their
ID3D12Heap + offset using methods like D3D12MA::Allocation::GetHeap().
+- Reserves destination memory for them by creating temporary destination allocations that you can query for their ID3D12Heap + offset using methods like D3D12MA::Allocation::GetHeap().
- Inside the pass, you should:
@@ -179,40 +166,40 @@
- D3D12MA::DefragmentationContext::EndPass() function call:
- Frees the source memory reserved for the allocations that are moved.
- Modifies source D3D12MA::Allocation objects that are moved to point to the destination reserved memory and destination resource, while source resource is released.
-- Frees
ID3D12Heap blocks that became empty.
+- Frees ID3D12Heap blocks that became empty.
-Defragmentation algorithm tries to move all suitable allocations. You can, however, refuse to move some of them inside a defragmentation pass, by setting pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This is not recommended and may result in suboptimal packing of the allocations after defragmentation. If you cannot ensure any allocation can be moved, it is better to keep movable allocations separate in a custom pool.
+Defragmentation algorithm tries to move all suitable allocations. You can, however, refuse to move some of them inside a defragmentation pass, by setting pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This is not recommended and may result in suboptimal packing of the allocations after defragmentation. If you cannot ensure any allocation can be moved, it is better to keep movable allocations separate in a custom pool.
Inside a pass, for each allocation that should be moved:
-- You should copy its data from the source to the destination place by calling e.g.
CopyResource().
+- You should copy its data from the source to the destination place by calling e.g. CopyResource().
- You need to make sure these commands finished executing before the source buffers/textures are released by D3D12MA::DefragmentationContext::EndPass().
- If a resource doesn't contain any meaningful data, e.g. it is a transient render-target texture to be cleared, filled, and used temporarily in each rendering frame, you can just recreate this texture without copying its data.
-- If the resource is in
D3D12_HEAP_TYPE_READBACK memory, you can copy its data on the CPU using memcpy().
-- If you cannot move the allocation, you can set
pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This will cancel the move.
+- If the resource is in D3D12_HEAP_TYPE_READBACK memory, you can copy its data on the CPU using memcpy().
+- If you cannot move the allocation, you can set pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This will cancel the move.
- D3D12MA::DefragmentationContext::EndPass() will then free the destination memory not the source memory of the allocation, leaving it unchanged.
-- If you decide the allocation is unimportant and can be destroyed instead of moved (e.g. it wasn't used for long time), you can set
pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY.
+- If you decide the allocation is unimportant and can be destroyed instead of moved (e.g. it wasn't used for long time), you can set pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY.
- D3D12MA::DefragmentationContext::EndPass() will then free both source and destination memory, and will destroy the source D3D12MA::Allocation object.
You can defragment a specific custom pool by calling D3D12MA::Pool::BeginDefragmentation or all the default pools by calling D3D12MA::Allocator::BeginDefragmentation (like in the example above).
-Defragmentation is always performed in each pool separately. Allocations are never moved between different heap types. The size of the destination memory reserved for a moved allocation is the same as the original one. Alignment of an allocation as it was determined using GetResourceAllocationInfo() is also respected after defragmentation. Buffers/textures should be recreated with the same D3D12_RESOURCE_DESC parameters as the original ones.
+Defragmentation is always performed in each pool separately. Allocations are never moved between different heap types. The size of the destination memory reserved for a moved allocation is the same as the original one. Alignment of an allocation as it was determined using GetResourceAllocationInfo() is also respected after defragmentation. Buffers/textures should be recreated with the same D3D12_RESOURCE_DESC parameters as the original ones.
You can perform the defragmentation incrementally to limit the number of allocations and bytes to be moved in each pass, e.g. to call it in sync with render frames and not to experience too big hitches. See members: D3D12MA::DEFRAGMENTATION_DESC::MaxBytesPerPass, D3D12MA::DEFRAGMENTATION_DESC::MaxAllocationsPerPass.
Thread safety: It is safe to perform the defragmentation asynchronously to render frames and other Direct3D 12 and D3D12MA usage, possibly from multiple threads, with the exception that allocations returned in D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO::pMoves shouldn't be released until the defragmentation pass is ended. During the call to D3D12MA::DefragmentationContext::BeginPass(), any operations on the memory pool affected by the defragmentation are blocked by a mutex.
-What it means in practice is that you shouldn't free any allocations from the defragmented pool since the moment a call to BeginPass begins. Otherwise, a thread performing the allocation->Release() would block for the time BeginPass executes and then free the allocation when it finishes, while the allocation could have ended up on the list of allocations to move. A solution to freeing allocations during defragmentation is to find such allocation on the list pass.pMoves[i] and set its operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY instead of calling allocation->Release(), or simply deferring the release to the time after defragmentation finished.
+What it means in practice is that you shouldn't free any allocations from the defragmented pool since the moment a call to BeginPass begins. Otherwise, a thread performing the allocation->Release() would block for the time BeginPass executes and then free the allocation when it finishes, while the allocation could have ended up on the list of allocations to move. A solution to freeing allocations during defragmentation is to find such allocation on the list pass.pMoves[i] and set its operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY instead of calling allocation->Release(), or simply deferring the release to the time after defragmentation finished.
Mapping is out of scope of this library and so it is not preserved after an allocation is moved during defragmentation. You need to map the new resource yourself if needed.
- Note
- Defragmentation is not supported in custom pools created with D3D12MA::POOL_FLAG_ALGORITHM_LINEAR.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html b/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
index fa88354..6e6d46e 100644
--- a/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
+++ b/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: C:/Code/D3D12MemoryAllocator/REPO/include Directory Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -92,15 +79,14 @@
-
+
Files
D3D12MemAlloc.h D3D12MemAlloc.h
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/doxygen.css b/docs/html/doxygen.css
index 4947e24..5d2eecd 100644
--- a/docs/html/doxygen.css
+++ b/docs/html/doxygen.css
@@ -1,11 +1,12 @@
-/* The standard CSS for doxygen 1.13.2*/
+/* The standard CSS for doxygen 1.14.0*/
html {
/* page base colors */
--page-background-color: white;
--page-foreground-color: black;
--page-link-color: #3D578C;
---page-visited-link-color: #4665A2;
+--page-visited-link-color: #3D578C;
+--page-external-link-color: #334975;
/* index */
--index-odd-item-bg-color: #F8F9FC;
@@ -16,46 +17,50 @@ html {
/* header */
--header-background-color: #F9FAFC;
--header-separator-color: #C4CFE5;
---header-gradient-image: url('nav_h.png');
---group-header-separator-color: #879ECB;
+--group-header-separator-color: #D9E0EE;
--group-header-color: #354C7B;
--inherit-header-color: gray;
--footer-foreground-color: #2A3D61;
---footer-logo-width: 104px;
+--footer-logo-width: 75px;
--citation-label-color: #334975;
--glow-color: cyan;
--title-background-color: white;
---title-separator-color: #5373B4;
+--title-separator-color: #C4CFE5;
--directory-separator-color: #9CAFD4;
--separator-color: #4A6AAA;
--blockquote-background-color: #F7F8FB;
--blockquote-border-color: #9CAFD4;
---scrollbar-thumb-color: #9CAFD4;
+--scrollbar-thumb-color: #C4CFE5;
--scrollbar-background-color: #F9FAFC;
--icon-background-color: #728DC1;
--icon-foreground-color: white;
+/*
--icon-doc-image: url('doc.svg');
--icon-folder-open-image: url('folderopen.svg');
---icon-folder-closed-image: url('folderclosed.svg');
+--icon-folder-closed-image: url('folderclosed.svg');*/
+--icon-folder-open-fill-color: #C4CFE5;
+--icon-folder-fill-color: #D8DFEE;
+--icon-folder-border-color: #4665A2;
+--icon-doc-fill-color: #D8DFEE;
+--icon-doc-border-color: #4665A2;
/* brief member declaration list */
--memdecl-background-color: #F9FAFC;
--memdecl-separator-color: #DEE4F0;
--memdecl-foreground-color: #555;
--memdecl-template-color: #4665A2;
+--memdecl-border-color: #D5DDEC;
/* detailed member list */
--memdef-border-color: #A8B8D9;
--memdef-title-background-color: #E2E8F2;
---memdef-title-gradient-image: url('nav_f.png');
---memdef-proto-background-color: #DFE5F1;
+--memdef-proto-background-color: #EEF1F7;
--memdef-proto-text-color: #253555;
---memdef-proto-text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
--memdef-doc-background-color: white;
--memdef-param-name-color: #602020;
--memdef-template-color: #4665A2;
@@ -74,29 +79,34 @@ html {
/** navigation bar/tree/menu */
--nav-background-color: #F9FAFC;
--nav-foreground-color: #364D7C;
---nav-gradient-image: url('tab_b.png');
---nav-gradient-hover-image: url('tab_h.png');
---nav-gradient-active-image: url('tab_a.png');
---nav-gradient-active-image-parent: url("../tab_a.png");
---nav-separator-image: url('tab_s.png');
---nav-breadcrumb-image: url('bc_s.png');
---nav-breadcrumb-border-color: #C2CDE4;
---nav-splitbar-image: url('splitbar.png');
+--nav-border-color: #C4CFE5;
+--nav-breadcrumb-separator-color: #C4CFE5;
+--nav-breadcrumb-active-bg: #EEF1F7;
+--nav-breadcrumb-color: #354C7B;
+--nav-breadcrumb-border-color: #E1E7F2;
+--nav-splitbar-bg-color: #DCE2EF;
+--nav-splitbar-handle-color: #9CAFD4;
--nav-font-size-level1: 13px;
--nav-font-size-level2: 10px;
--nav-font-size-level3: 9px;
--nav-text-normal-color: #283A5D;
--nav-text-hover-color: white;
--nav-text-active-color: white;
---nav-text-normal-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
---nav-text-hover-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
---nav-text-active-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
--nav-menu-button-color: #364D7C;
--nav-menu-background-color: white;
--nav-menu-foreground-color: #555555;
+--nav-menu-active-bg: #DCE2EF;
+--nav-menu-active-color: #9CAFD4;
--nav-menu-toggle-color: rgba(255, 255, 255, 0.5);
---nav-arrow-color: #9CAFD4;
---nav-arrow-selected-color: #9CAFD4;
+--nav-arrow-color: #B6C4DF;
+--nav-arrow-selected-color: #90A5CE;
+
+/* sync icon */
+--sync-icon-border-color: #C4CFE5;
+--sync-icon-background-color: #F9FAFC;
+--sync-icon-selected-background-color: #EEF1F7;
+--sync-icon-color: #C4CFE5;
+--sync-icon-selected-color: #6884BD;
/* table of contents */
--toc-background-color: #F4F6FA;
@@ -107,18 +117,20 @@ html {
/** search field */
--search-background-color: white;
--search-foreground-color: #909090;
---search-magnification-image: url('mag.svg');
---search-magnification-select-image: url('mag_sel.svg');
--search-active-color: black;
---search-filter-background-color: #F9FAFC;
+--search-filter-background-color: rgba(255,255,255,.7);
+--search-filter-backdrop-filter: blur(4px);
--search-filter-foreground-color: black;
---search-filter-border-color: #90A5CE;
+--search-filter-border-color: rgba(150,150,150,.4);
--search-filter-highlight-text-color: white;
--search-filter-highlight-bg-color: #3D578C;
--search-results-foreground-color: #425E97;
---search-results-background-color: #EEF1F7;
---search-results-border-color: black;
---search-box-shadow: inset 0.5px 0.5px 3px 0px #555;
+--search-results-background-color: rgba(255,255,255,.8);
+--search-results-backdrop-filter: blur(4px);
+--search-results-border-color: rgba(150,150,150,.4);
+--search-box-border-color: #B6C4DF;
+--search-close-icon-bg-color: #A0A0A0;
+--search-close-icon-fg-color: white;
/** code fragments */
--code-keyword-color: #008000;
@@ -147,23 +159,21 @@ html {
--fragment-lineno-link-hover-bg-color: #C8C8C8;
--fragment-copy-ok-color: #2EC82E;
--tooltip-foreground-color: black;
---tooltip-background-color: white;
---tooltip-border-color: gray;
+--tooltip-background-color: rgba(255,255,255,0.8);
+--tooltip-arrow-background-color: white;
+--tooltip-border-color: rgba(150,150,150,0.7);
+--tooltip-backdrop-filter: blur(3px);
--tooltip-doc-color: grey;
--tooltip-declaration-color: #006318;
--tooltip-link-color: #4665A2;
---tooltip-shadow: 1px 1px 7px gray;
+--tooltip-shadow: 0 4px 8px 0 rgba(0,0,0,.25);
--fold-line-color: #808080;
---fold-minus-image: url('minus.svg');
---fold-plus-image: url('plus.svg');
---fold-minus-image-relpath: url('../../minus.svg');
---fold-plus-image-relpath: url('../../plus.svg');
/** font-family */
---font-family-normal: Roboto,sans-serif;
+--font-family-normal: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-monospace: 'JetBrains Mono',Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace,fixed;
--font-family-nav: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
---font-family-title: Tahoma,Arial,sans-serif;
+--font-family-title: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-toc: Verdana,'DejaVu Sans',Geneva,sans-serif;
--font-family-search: Arial,Verdana,sans-serif;
--font-family-icon: Arial,Helvetica;
@@ -201,7 +211,8 @@ html {
--page-background-color: black;
--page-foreground-color: #C9D1D9;
--page-link-color: #90A5CE;
---page-visited-link-color: #A3B4D7;
+--page-visited-link-color: #90A5CE;
+--page-external-link-color: #A3B4D7;
/* index */
--index-odd-item-bg-color: #0B101A;
@@ -212,8 +223,7 @@ html {
/* header */
--header-background-color: #070B11;
--header-separator-color: #141C2E;
---header-gradient-image: url('nav_hd.png');
---group-header-separator-color: #283A5D;
+--group-header-separator-color: #1D2A43;
--group-header-color: #90A5CE;
--inherit-header-color: #A0A0A0;
@@ -223,35 +233,36 @@ html {
--glow-color: cyan;
--title-background-color: #090D16;
---title-separator-color: #354C79;
+--title-separator-color: #212F4B;
--directory-separator-color: #283A5D;
--separator-color: #283A5D;
--blockquote-background-color: #101826;
--blockquote-border-color: #283A5D;
---scrollbar-thumb-color: #283A5D;
+--scrollbar-thumb-color: #2C3F65;
--scrollbar-background-color: #070B11;
--icon-background-color: #334975;
--icon-foreground-color: #C4CFE5;
---icon-doc-image: url('docd.svg');
---icon-folder-open-image: url('folderopend.svg');
---icon-folder-closed-image: url('folderclosedd.svg');
+--icon-folder-open-fill-color: #4665A2;
+--icon-folder-fill-color: #5373B4;
+--icon-folder-border-color: #C4CFE5;
+--icon-doc-fill-color: #6884BD;
+--icon-doc-border-color: #C4CFE5;
/* brief member declaration list */
--memdecl-background-color: #0B101A;
--memdecl-separator-color: #2C3F65;
--memdecl-foreground-color: #BBB;
--memdecl-template-color: #7C95C6;
+--memdecl-border-color: #233250;
/* detailed member list */
--memdef-border-color: #233250;
--memdef-title-background-color: #1B2840;
---memdef-title-gradient-image: url('nav_fd.png');
--memdef-proto-background-color: #19243A;
--memdef-proto-text-color: #9DB0D4;
---memdef-proto-text-shadow: 0px 1px 1px rgba(0, 0, 0, 0.9);
--memdef-doc-background-color: black;
--memdef-param-name-color: #D28757;
--memdef-template-color: #7C95C6;
@@ -270,29 +281,34 @@ html {
/** navigation bar/tree/menu */
--nav-background-color: #101826;
--nav-foreground-color: #364D7C;
---nav-gradient-image: url('tab_bd.png');
---nav-gradient-hover-image: url('tab_hd.png');
---nav-gradient-active-image: url('tab_ad.png');
---nav-gradient-active-image-parent: url("../tab_ad.png");
---nav-separator-image: url('tab_sd.png');
---nav-breadcrumb-image: url('bc_sd.png');
+--nav-border-color: #212F4B;
+--nav-breadcrumb-separator-color: #212F4B;
+--nav-breadcrumb-active-bg: #1D2A43;
+--nav-breadcrumb-color: #90A5CE;
--nav-breadcrumb-border-color: #2A3D61;
---nav-splitbar-image: url('splitbard.png');
+--nav-splitbar-bg-color: #283A5D;
+--nav-splitbar-handle-color: #4665A2;
--nav-font-size-level1: 13px;
--nav-font-size-level2: 10px;
--nav-font-size-level3: 9px;
--nav-text-normal-color: #B6C4DF;
--nav-text-hover-color: #DCE2EF;
--nav-text-active-color: #DCE2EF;
---nav-text-normal-shadow: 0px 1px 1px black;
---nav-text-hover-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
---nav-text-active-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
--nav-menu-button-color: #B6C4DF;
--nav-menu-background-color: #05070C;
--nav-menu-foreground-color: #BBBBBB;
+--nav-menu-active-bg: #1D2A43;
+--nav-menu-active-color: #C9D3E7;
--nav-menu-toggle-color: rgba(255, 255, 255, 0.2);
---nav-arrow-color: #334975;
---nav-arrow-selected-color: #90A5CE;
+--nav-arrow-color: #4665A2;
+--nav-arrow-selected-color: #6884BD;
+
+/* sync icon */
+--sync-icon-border-color: #212F4B;
+--sync-icon-background-color: #101826;
+--sync-icon-selected-background-color: #1D2A43;
+--sync-icon-color: #4665A2;
+--sync-icon-selected-color: #5373B4;
/* table of contents */
--toc-background-color: #151E30;
@@ -303,18 +319,20 @@ html {
/** search field */
--search-background-color: black;
--search-foreground-color: #C5C5C5;
---search-magnification-image: url('mag_d.svg');
---search-magnification-select-image: url('mag_seld.svg');
---search-active-color: #C5C5C5;
+--search-active-color: #F5F5F5;
--search-filter-background-color: #101826;
--search-filter-foreground-color: #90A5CE;
+--search-filter-backdrop-filter: none;
--search-filter-border-color: #7C95C6;
--search-filter-highlight-text-color: #BCC9E2;
--search-filter-highlight-bg-color: #283A5D;
---search-results-background-color: #101826;
+--search-results-background-color: black;
--search-results-foreground-color: #90A5CE;
---search-results-border-color: #7C95C6;
---search-box-shadow: inset 0.5px 0.5px 3px 0px #2F436C;
+--search-results-backdrop-filter: none;
+--search-results-border-color: #334975;
+--search-box-border-color: #334975;
+--search-close-icon-bg-color: #909090;
+--search-close-icon-fg-color: black;
/** code fragments */
--code-keyword-color: #CC99CD;
@@ -344,22 +362,20 @@ html {
--fragment-copy-ok-color: #0EA80E;
--tooltip-foreground-color: #C9D1D9;
--tooltip-background-color: #202020;
+--tooltip-arrow-background-color: #202020;
+--tooltip-backdrop-filter: none;
--tooltip-border-color: #C9D1D9;
--tooltip-doc-color: #D9E1E9;
--tooltip-declaration-color: #20C348;
--tooltip-link-color: #79C0FF;
--tooltip-shadow: none;
--fold-line-color: #808080;
---fold-minus-image: url('minusd.svg');
---fold-plus-image: url('plusd.svg');
---fold-minus-image-relpath: url('../../minusd.svg');
---fold-plus-image-relpath: url('../../plusd.svg');
/** font-family */
---font-family-normal: Roboto,sans-serif;
+--font-family-normal: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-monospace: 'JetBrains Mono',Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace,fixed;
--font-family-nav: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
---font-family-title: Tahoma,Arial,sans-serif;
+--font-family-title: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-toc: Verdana,'DejaVu Sans',Geneva,sans-serif;
--font-family-search: Arial,Verdana,sans-serif;
--font-family-icon: Arial,Helvetica;
@@ -389,8 +405,8 @@ html {
--invariant-color-text: #cceed5;
}}
body {
- background-color: var(--page-background-color);
- color: var(--page-foreground-color);
+ background-color: var(--page-background-color);
+ color: var(--page-foreground-color);
}
body, table, div, p, dl {
@@ -400,13 +416,22 @@ body, table, div, p, dl {
line-height: 22px;
}
+body.resizing {
+ user-select: none;
+ -webkit-user-select: none;
+}
+
+#doc-content {
+ scrollbar-width: thin;
+}
+
/* @group Heading Levels */
.title {
font-family: var(--font-family-normal);
line-height: 28px;
- font-size: 150%;
- font-weight: bold;
+ font-size: 160%;
+ font-weight: 400;
margin: 10px 2px;
}
@@ -415,7 +440,10 @@ h1.groupheader {
}
h2.groupheader {
- border-bottom: 1px solid var(--group-header-separator-color);
+ box-shadow: 12px 0 var(--page-background-color),
+ -12px 0 var(--page-background-color),
+ 12px 1px var(--group-header-separator-color),
+ -12px 1px var(--group-header-separator-color);
color: var(--group-header-color);
font-size: 150%;
font-weight: normal;
@@ -425,6 +453,13 @@ h2.groupheader {
width: 100%;
}
+td h2.groupheader {
+ box-shadow: 13px 0 var(--page-background-color),
+ -13px 0 var(--page-background-color),
+ 13px 1px var(--group-header-separator-color),
+ -13px 1px var(--group-header-separator-color);
+}
+
h3.groupheader {
font-size: 100%;
}
@@ -451,8 +486,8 @@ p.startli, p.startdd {
}
th p.starttd, th p.intertd, th p.endtd {
- font-size: 100%;
- font-weight: 700;
+ font-size: 100%;
+ font-weight: 700;
}
p.starttd {
@@ -497,9 +532,11 @@ h3.version {
}
div.navtab {
- padding-right: 15px;
+ margin-right: 6px;
+ padding-right: 6px;
text-align: right;
line-height: 110%;
+ background-color: var(--nav-background-color);
}
div.navtab table {
@@ -512,19 +549,10 @@ td.navtab {
}
td.navtabHL {
- background-image: var(--nav-gradient-active-image);
- background-repeat:repeat-x;
padding-right: 6px;
padding-left: 6px;
-}
-
-td.navtabHL a, td.navtabHL a:visited {
- color: var(--nav-text-hover-color);
- text-shadow: var(--nav-text-hover-shadow);
-}
-
-a.navtab {
- font-weight: bold;
+ border-radius: 0 6px 6px 0;
+ background-color: var(--nav-menu-active-bg);
}
div.qindex{
@@ -599,16 +627,11 @@ a {
color: var(--page-visited-link-color);
}
-a:hover {
+span.label a:hover {
text-decoration: none;
background: linear-gradient(to bottom, transparent 0,transparent calc(100% - 1px), currentColor 100%);
}
-a:hover > span.arrow {
- text-decoration: none;
- background : var(--nav-background-color);
-}
-
a.el {
font-weight: bold;
}
@@ -616,12 +639,12 @@ a.el {
a.elRef {
}
-a.code, a.code:visited, a.line, a.line:visited {
- color: var(--code-link-color);
+a.el, a.el:visited, a.code, a.code:visited, a.line, a.line:visited {
+ color: var(--page-link-color);
}
a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited {
- color: var(--code-external-link-color);
+ color: var(--page-external-link-color);
}
a.code.hl_class { /* style for links to class names in code snippets */ }
@@ -658,118 +681,124 @@ dl.el {
}
ul.check {
- list-style:none;
- text-indent: -16px;
- padding-left: 38px;
+ list-style:none;
+ text-indent: -16px;
+ padding-left: 38px;
}
li.unchecked:before {
- content: "\2610\A0";
+ content: "\2610\A0";
}
li.checked:before {
- content: "\2611\A0";
+ content: "\2611\A0";
}
ol {
- text-indent: 0px;
+ text-indent: 0px;
}
ul {
- text-indent: 0px;
- overflow: visible;
+ text-indent: 0px;
+ overflow: visible;
}
ul.multicol {
- -moz-column-gap: 1em;
- -webkit-column-gap: 1em;
- column-gap: 1em;
- -moz-column-count: 3;
- -webkit-column-count: 3;
- column-count: 3;
- list-style-type: none;
+ -moz-column-gap: 1em;
+ -webkit-column-gap: 1em;
+ column-gap: 1em;
+ -moz-column-count: 3;
+ -webkit-column-count: 3;
+ column-count: 3;
+ list-style-type: none;
}
#side-nav ul {
- overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */
+ overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */
}
#main-nav ul {
- overflow: visible; /* reset ul rule for the navigation bar drop down lists */
+ overflow: visible; /* reset ul rule for the navigation bar drop down lists */
}
.fragment {
- text-align: left;
- direction: ltr;
- overflow-x: auto;
- overflow-y: hidden;
- position: relative;
- min-height: 12px;
- margin: 10px 0px;
- padding: 10px 10px;
- border: 1px solid var(--fragment-border-color);
- border-radius: 4px;
- background-color: var(--fragment-background-color);
- color: var(--fragment-foreground-color);
+ text-align: left;
+ direction: ltr;
+ overflow-x: auto;
+ overflow-y: hidden;
+ position: relative;
+ min-height: 12px;
+ margin: 10px 0px;
+ padding: 10px 10px;
+ border: 1px solid var(--fragment-border-color);
+ border-radius: 4px;
+ background-color: var(--fragment-background-color);
+ color: var(--fragment-foreground-color);
}
pre.fragment {
- word-wrap: break-word;
- font-size: 10pt;
- line-height: 125%;
- font-family: var(--font-family-monospace);
+ word-wrap: break-word;
+ font-size: 10pt;
+ line-height: 125%;
+ font-family: var(--font-family-monospace);
+}
+
+span.tt {
+ white-space: pre;
+ font-family: var(--font-family-monospace);
}
.clipboard {
- width: 24px;
- height: 24px;
- right: 5px;
- top: 5px;
- opacity: 0;
- position: absolute;
- display: inline;
- overflow: hidden;
- justify-content: center;
- align-items: center;
- cursor: pointer;
+ width: 24px;
+ height: 24px;
+ right: 5px;
+ top: 5px;
+ opacity: 0;
+ position: absolute;
+ display: inline;
+ overflow: hidden;
+ justify-content: center;
+ align-items: center;
+ cursor: pointer;
}
.clipboard.success {
- border: 1px solid var(--fragment-foreground-color);
- border-radius: 4px;
+ border: 1px solid var(--fragment-foreground-color);
+ border-radius: 4px;
}
.fragment:hover .clipboard, .clipboard.success {
- opacity: .4;
+ opacity: .4;
}
.clipboard:hover, .clipboard.success {
- opacity: 1 !important;
+ opacity: 1 !important;
}
.clipboard:active:not([class~=success]) svg {
- transform: scale(.91);
+ transform: scale(.91);
}
.clipboard.success svg {
- fill: var(--fragment-copy-ok-color);
+ fill: var(--fragment-copy-ok-color);
}
.clipboard.success {
- border-color: var(--fragment-copy-ok-color);
+ border-color: var(--fragment-copy-ok-color);
}
div.line {
font-family: var(--font-family-monospace);
- font-size: 13px;
+ font-size: 13px;
min-height: 13px;
line-height: 1.2;
- text-wrap: unrestricted;
+ text-wrap: wrap;
+ word-break: break-all;
white-space: -moz-pre-wrap; /* Moz */
white-space: -pre-wrap; /* Opera 4-6 */
white-space: -o-pre-wrap; /* Opera 7 */
white-space: pre-wrap; /* CSS3 */
word-wrap: break-word; /* IE 5.5+ */
- text-indent: -53px;
- padding-left: 53px;
+ text-indent: -62px;
+ padding-left: 62px;
padding-bottom: 0px;
margin: 0px;
-webkit-transition-property: background-color, box-shadow;
@@ -785,8 +814,8 @@ div.line {
}
div.line:after {
- content:"\000A";
- white-space: pre;
+ content:"\000A";
+ white-space: pre;
}
div.line.glow {
@@ -795,26 +824,67 @@ div.line.glow {
}
span.fold {
- margin-left: 5px;
- margin-right: 1px;
- margin-top: 0px;
- margin-bottom: 0px;
- padding: 0px;
display: inline-block;
width: 12px;
height: 12px;
- background-repeat:no-repeat;
- background-position:center;
+ margin-left: 4px;
+ margin-right: 1px;
+}
+
+span.foldnone {
+ display: inline-block;
+ position: relative;
+ cursor: pointer;
+ user-select: none;
+}
+
+span.fold.plus, span.fold.minus {
+ width: 10px;
+ height: 10px;
+ background-color: var(--fragment-background-color);
+ position: relative;
+ border: 1px solid var(--fold-line-color);
+ margin-right: 1px;
+}
+
+span.fold.plus::before, span.fold.minus::before {
+ content: '';
+ position: absolute;
+ background-color: var(--fold-line-color);
+}
+
+span.fold.plus::before {
+ width: 2px;
+ height: 6px;
+ top: 2px;
+ left: 4px;
+}
+
+span.fold.plus::after {
+ content: '';
+ position: absolute;
+ width: 6px;
+ height: 2px;
+ top: 4px;
+ left: 2px;
+ background-color: var(--fold-line-color);
+}
+
+span.fold.minus::before {
+ width: 6px;
+ height: 2px;
+ top: 4px;
+ left: 2px;
}
span.lineno {
padding-right: 4px;
- margin-right: 9px;
+ margin-right: 9px;
text-align: right;
border-right: 2px solid var(--fragment-lineno-border-color);
color: var(--fragment-lineno-foreground-color);
background-color: var(--fragment-lineno-background-color);
- white-space: pre;
+ white-space: pre;
}
span.lineno a, span.lineno a:visited {
color: var(--fragment-lineno-link-fg-color);
@@ -836,18 +906,27 @@ span.lineno a:hover {
}
div.classindex ul {
- list-style: none;
- padding-left: 0;
+ list-style: none;
+ padding-left: 0;
}
div.classindex span.ai {
- display: inline-block;
+ display: inline-block;
}
div.groupHeader {
- margin-left: 16px;
- margin-top: 12px;
- font-weight: bold;
+ box-shadow: 13px 0 var(--page-background-color),
+ -13px 0 var(--page-background-color),
+ 13px 1px var(--group-header-separator-color),
+ -13px 1px var(--group-header-separator-color);
+ color: var(--group-header-color);
+ font-size: 110%;
+ font-weight: 500;
+ margin-left: 0px;
+ margin-top: 0em;
+ margin-bottom: 6px;
+ padding-top: 8px;
+ padding-bottom: 4px;
}
div.groupText {
@@ -857,13 +936,13 @@ div.groupText {
body {
color: var(--page-foreground-color);
- margin: 0;
+ margin: 0;
}
div.contents {
margin-top: 10px;
margin-left: 12px;
- margin-right: 8px;
+ margin-right: 12px;
}
p.formulaDsp {
@@ -883,9 +962,9 @@ img.formulaInl, img.inline {
div.center {
text-align: center;
- margin-top: 0px;
- margin-bottom: 0px;
- padding: 0px;
+ margin-top: 0px;
+ margin-bottom: 0px;
+ padding: 0px;
}
div.center img {
@@ -960,10 +1039,10 @@ span.vhdllogic {
}
blockquote {
- background-color: var(--blockquote-background-color);
- border-left: 2px solid var(--blockquote-border-color);
- margin: 0 24px 0 4px;
- padding: 0 12px 0 16px;
+ background-color: var(--blockquote-background-color);
+ border-left: 2px solid var(--blockquote-border-color);
+ margin: 0 24px 0 4px;
+ padding: 0 12px 0 16px;
}
/* @end */
@@ -985,9 +1064,14 @@ th.dirtab {
}
hr {
- height: 0px;
border: none;
- border-top: 1px solid var(--separator-color);
+ margin-top: 16px;
+ margin-bottom: 16px;
+ height: 1px;
+ box-shadow: 13px 0 var(--page-background-color),
+ -13px 0 var(--page-background-color),
+ 13px 1px var(--group-header-separator-color),
+ -13px 1px var(--group-header-separator-color);
}
hr.footer {
@@ -1002,14 +1086,6 @@ table.memberdecls {
}
.memberdecls td, .fieldtable tr {
- -webkit-transition-property: background-color, box-shadow;
- -webkit-transition-duration: 0.5s;
- -moz-transition-property: background-color, box-shadow;
- -moz-transition-duration: 0.5s;
- -ms-transition-property: background-color, box-shadow;
- -ms-transition-duration: 0.5s;
- -o-transition-property: background-color, box-shadow;
- -o-transition-duration: 0.5s;
transition-property: background-color, box-shadow;
transition-duration: 0.5s;
}
@@ -1019,13 +1095,23 @@ table.memberdecls {
box-shadow: 0 0 15px var(--glow-color);
}
+.memberdecls tr[class^='memitem'] {
+ font-family: var(--font-family-monospace);
+}
+
.mdescLeft, .mdescRight,
-.memItemLeft, .memItemRight,
-.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
+.memItemLeft, .memItemRight {
+ padding-top: 2px;
+ padding-bottom: 2px;
+}
+
+.memTemplParams {
+ padding-left: 10px;
+ padding-top: 5px;
+}
+
+.memItemLeft, .memItemRight, .memTemplParams {
background-color: var(--memdecl-background-color);
- border: none;
- margin: 4px;
- padding: 1px 0 0 8px;
}
.mdescLeft, .mdescRight {
@@ -1033,27 +1119,104 @@ table.memberdecls {
color: var(--memdecl-foreground-color);
}
-.memSeparator {
- border-bottom: 1px solid var(--memdecl-separator-color);
- line-height: 1px;
- margin: 0px;
- padding: 0px;
+tr[class^='memdesc'] {
+ box-shadow: inset 0px 1px 3px 0px rgba(0,0,0,.075);
}
-.memItemLeft, .memTemplItemLeft {
- white-space: nowrap;
+.mdescLeft {
+ border-left: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
}
-.memItemRight, .memTemplItemRight {
- width: 100%;
+.mdescRight {
+ border-right: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
}
.memTemplParams {
color: var(--memdecl-template-color);
- white-space: nowrap;
+ white-space: nowrap;
font-size: 80%;
+ border-left: 1px solid var(--memdecl-border-color);
+ border-right: 1px solid var(--memdecl-border-color);
+}
+
+td.ititle {
+ border: 1px solid var(--memdecl-border-color);
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+ padding-left: 10px;
+}
+
+tr:not(:first-child) > td.ititle {
+ border-top: 0;
+ border-radius: 0;
}
+.memItemLeft {
+ white-space: nowrap;
+ border-left: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
+ padding-left: 10px;
+ transition: none;
+}
+
+.memItemRight {
+ width: 100%;
+ border-right: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
+ padding-right: 10px;
+ transition: none;
+}
+
+tr.heading + tr[class^='memitem'] td.memItemLeft,
+tr.groupHeader + tr[class^='memitem'] td.memItemLeft,
+tr.inherit_header + tr[class^='memitem'] td.memItemLeft {
+ border-top: 1px solid var(--memdecl-border-color);
+ border-top-left-radius: 4px;
+}
+
+tr.heading + tr[class^='memitem'] td.memItemRight,
+tr.groupHeader + tr[class^='memitem'] td.memItemRight,
+tr.inherit_header + tr[class^='memitem'] td.memItemRight {
+ border-top: 1px solid var(--memdecl-border-color);
+ border-top-right-radius: 4px;
+}
+
+tr.heading + tr[class^='memitem'] td.memTemplParams,
+tr.heading + tr td.ititle,
+tr.groupHeader + tr[class^='memitem'] td.memTemplParams,
+tr.groupHeader + tr td.ititle,
+tr.inherit_header + tr[class^='memitem'] td.memTemplParams {
+ border-top: 1px solid var(--memdecl-border-color);
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+}
+
+table.memberdecls tr:last-child td.memItemLeft,
+table.memberdecls tr:last-child td.mdescLeft,
+table.memberdecls tr[class^='memitem']:has(+ tr.groupHeader) td.memItemLeft,
+table.memberdecls tr[class^='memitem']:has(+ tr.inherit_header) td.memItemLeft,
+table.memberdecls tr[class^='memdesc']:has(+ tr.groupHeader) td.mdescLeft,
+table.memberdecls tr[class^='memdesc']:has(+ tr.inherit_header) td.mdescLeft {
+ border-bottom-left-radius: 4px;
+}
+
+table.memberdecls tr:last-child td.memItemRight,
+table.memberdecls tr:last-child td.mdescRight,
+table.memberdecls tr[class^='memitem']:has(+ tr.groupHeader) td.memItemRight,
+table.memberdecls tr[class^='memitem']:has(+ tr.inherit_header) td.memItemRight,
+table.memberdecls tr[class^='memdesc']:has(+ tr.groupHeader) td.mdescRight,
+table.memberdecls tr[class^='memdesc']:has(+ tr.inherit_header) td.mdescRight {
+ border-bottom-right-radius: 4px;
+}
+
+tr.template .memItemLeft, tr.template .memItemRight {
+ border-top: none;
+ padding-top: 0;
+}
+
+
/* @end */
/* @group Member Details */
@@ -1068,24 +1231,43 @@ table.memberdecls {
border-top-right-radius: 4px;
border-top-left-radius: 4px;
margin-bottom: -1px;
- background-image: var(--memdef-title-gradient-image);
- background-repeat: repeat-x;
- background-color: var(--memdef-title-background-color);
+ background-color: var(--memdef-proto-background-color);
line-height: 1.25;
- font-weight: 300;
+ font-family: var(--font-family-monospace);
+ font-weight: 500;
+ font-size: 16px;
float:left;
+ box-shadow: 0 10px 0 -1px var(--memdef-proto-background-color),
+ 0 2px 8px 0 rgba(0,0,0,.075);
+ position: relative;
+}
+
+.memtitle:after {
+ content: '';
+ display: block;
+ background: var(--memdef-proto-background-color);
+ height: 10px;
+ bottom: -10px;
+ left: 0px;
+ right: -14px;
+ position: absolute;
+ border-top-right-radius: 6px;
}
.permalink
{
- font-size: 65%;
- display: inline-block;
- vertical-align: middle;
+ font-family: var(--font-family-monospace);
+ font-weight: 500;
+ line-height: 1.25;
+ font-size: 16px;
+ display: inline-block;
+ vertical-align: middle;
}
.memtemplate {
font-size: 80%;
color: var(--memdef-template-color);
+ font-family: var(--font-family-monospace);
font-weight: normal;
margin-left: 9px;
}
@@ -1098,22 +1280,21 @@ table.memberdecls {
padding: 0;
margin-bottom: 10px;
margin-right: 5px;
- -webkit-transition: box-shadow 0.5s linear;
- -moz-transition: box-shadow 0.5s linear;
- -ms-transition: box-shadow 0.5s linear;
- -o-transition: box-shadow 0.5s linear;
- transition: box-shadow 0.5s linear;
- display: table !important;
- width: 100%;
+ display: table !important;
+ width: 100%;
+ box-shadow: 0 2px 8px 0 rgba(0,0,0,.075);
+ border-radius: 4px;
}
.memitem.glow {
- box-shadow: 0 0 15px var(--glow-color);
+ box-shadow: 0 0 15px var(--glow-color);
}
.memname {
- font-weight: 400;
- margin-left: 6px;
+ font-family: var(--font-family-monospace);
+ font-size: 13px;
+ font-weight: 400;
+ margin-left: 6px;
}
.memname td {
@@ -1121,53 +1302,39 @@ table.memberdecls {
}
.memproto, dl.reflist dt {
- border-top: 1px solid var(--memdef-border-color);
- border-left: 1px solid var(--memdef-border-color);
- border-right: 1px solid var(--memdef-border-color);
- padding: 6px 0px 6px 0px;
- color: var(--memdef-proto-text-color);
- font-weight: bold;
- text-shadow: var(--memdef-proto-text-shadow);
- background-color: var(--memdef-proto-background-color);
- box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
- border-top-right-radius: 4px;
+ border-top: 1px solid var(--memdef-border-color);
+ border-left: 1px solid var(--memdef-border-color);
+ border-right: 1px solid var(--memdef-border-color);
+ padding: 6px 0px 6px 0px;
+ color: var(--memdef-proto-text-color);
+ font-weight: bold;
+ background-color: var(--memdef-proto-background-color);
+ border-top-right-radius: 4px;
+ border-bottom: 1px solid var(--memdef-border-color);
}
.overload {
- font-family: var(--font-family-monospace);
+ font-family: var(--font-family-monospace);
font-size: 65%;
}
.memdoc, dl.reflist dd {
- border-bottom: 1px solid var(--memdef-border-color);
- border-left: 1px solid var(--memdef-border-color);
- border-right: 1px solid var(--memdef-border-color);
- padding: 6px 10px 2px 10px;
- border-top-width: 0;
- background-image:url('nav_g.png');
- background-repeat:repeat-x;
- background-color: var(--memdef-doc-background-color);
- /* opera specific markup */
- border-bottom-left-radius: 4px;
- border-bottom-right-radius: 4px;
- box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
- /* firefox specific markup */
- -moz-border-radius-bottomleft: 4px;
- -moz-border-radius-bottomright: 4px;
- -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
- /* webkit specific markup */
- -webkit-border-bottom-left-radius: 4px;
- -webkit-border-bottom-right-radius: 4px;
- -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ border-bottom: 1px solid var(--memdef-border-color);
+ border-left: 1px solid var(--memdef-border-color);
+ border-right: 1px solid var(--memdef-border-color);
+ padding: 6px 10px 2px 10px;
+ border-top-width: 0;
+ border-bottom-left-radius: 4px;
+ border-bottom-right-radius: 4px;
}
dl.reflist dt {
- padding: 5px;
+ padding: 5px;
}
dl.reflist dd {
- margin: 0px 0px 10px 0px;
- padding: 5px;
+ margin: 0px 0px 10px 0px;
+ padding: 5px;
}
.paramkey {
@@ -1182,9 +1349,9 @@ dl.reflist dd {
.paramname {
white-space: nowrap;
- padding: 0px;
- padding-bottom: 1px;
- margin-left: 2px;
+ padding: 0px;
+ padding-bottom: 1px;
+ margin-left: 2px;
}
.paramname em {
@@ -1198,23 +1365,23 @@ dl.reflist dd {
}
.params, .retval, .exception, .tparams {
- margin-left: 0px;
- padding-left: 0px;
+ margin-left: 0px;
+ padding-left: 0px;
}
.params .paramname, .retval .paramname, .tparams .paramname, .exception .paramname {
- font-weight: bold;
- vertical-align: top;
+ font-weight: bold;
+ vertical-align: top;
}
.params .paramtype, .tparams .paramtype {
- font-style: italic;
- vertical-align: top;
+ font-style: italic;
+ vertical-align: top;
}
.params .paramdir, .tparams .paramdir {
- font-family: var(--font-family-monospace);
- vertical-align: top;
+ font-family: var(--font-family-monospace);
+ vertical-align: top;
}
table.mlabels {
@@ -1233,15 +1400,15 @@ td.mlabels-right {
}
span.mlabels {
- margin-left: 8px;
+ margin-left: 8px;
}
span.mlabel {
- background-color: var(--label-background-color);
- border-top:1px solid var(--label-left-top-border-color);
- border-left:1px solid var(--label-left-top-border-color);
- border-right:1px solid var(--label-right-bottom-border-color);
- border-bottom:1px solid var(--label-right-bottom-border-color);
+ background-color: var(--label-background-color);
+ border-top:1px solid var(--label-left-top-border-color);
+ border-left:1px solid var(--label-left-top-border-color);
+ border-right:1px solid var(--label-right-bottom-border-color);
+ border-bottom:1px solid var(--label-right-bottom-border-color);
text-shadow: none;
color: var(--label-foreground-color);
margin-right: 4px;
@@ -1259,39 +1426,37 @@ span.mlabel {
/* these are for tree view inside a (index) page */
div.directory {
- margin: 10px 0px;
- border-top: 1px solid var(--directory-separator-color);
- border-bottom: 1px solid var(--directory-separator-color);
- width: 100%;
+ margin: 10px 0px;
+ width: 100%;
}
.directory table {
- border-collapse:collapse;
+ border-collapse:collapse;
}
.directory td {
- margin: 0px;
- padding: 0px;
+ margin: 0px;
+ padding: 0px;
vertical-align: top;
}
.directory td.entry {
- white-space: nowrap;
- padding-right: 6px;
+ white-space: nowrap;
+ padding-right: 6px;
padding-top: 3px;
}
.directory td.entry a {
- outline:none;
+ outline:none;
}
.directory td.entry a img {
- border: none;
+ border: none;
}
.directory td.desc {
- width: 100%;
- padding-left: 6px;
+ width: 100%;
+ padding-left: 6px;
padding-right: 6px;
padding-top: 3px;
border-left: 1px solid rgba(0,0,0,0.05);
@@ -1312,90 +1477,178 @@ div.directory {
}
.directory .levels {
- white-space: nowrap;
- width: 100%;
- text-align: right;
- font-size: 9pt;
+ white-space: nowrap;
+ width: 100%;
+ text-align: right;
+ font-size: 9pt;
}
.directory .levels span {
- cursor: pointer;
- padding-left: 2px;
- padding-right: 2px;
+ cursor: pointer;
+ padding-left: 2px;
+ padding-right: 2px;
color: var(--page-link-color);
}
.arrow {
- color: var(--nav-arrow-color);
- -webkit-user-select: none;
- -khtml-user-select: none;
- -moz-user-select: none;
- -ms-user-select: none;
- user-select: none;
- cursor: pointer;
- font-size: 80%;
- display: inline-block;
- width: 16px;
- height: 22px;
+ color: var(--nav-background-color);
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ cursor: pointer;
+ font-size: 80%;
+ display: inline-block;
+ width: 16px;
+ height: 14px;
+ transition: opacity 0.3s ease;
+}
+
+span.arrowhead {
+ position: relative;
+ padding: 0;
+ margin: 0 0 0 2px;
+ display: inline-block;
+ width: 5px;
+ height: 5px;
+ border-right: 2px solid var(--nav-arrow-color);
+ border-bottom: 2px solid var(--nav-arrow-color);
+ transform: rotate(-45deg);
+ transition: transform 0.3s ease;
+}
+
+span.arrowhead.opened {
+ transform: rotate(45deg);
+}
+
+.selected span.arrowhead {
+ border-right: 2px solid var(--nav-arrow-selected-color);
+ border-bottom: 2px solid var(--nav-arrow-selected-color);
}
.icon {
- font-family: var(--font-family-icon);
- line-height: normal;
- font-weight: bold;
- font-size: 12px;
- height: 14px;
- width: 16px;
- display: inline-block;
- background-color: var(--icon-background-color);
- color: var(--icon-foreground-color);
- text-align: center;
- border-radius: 4px;
- margin-left: 2px;
- margin-right: 2px;
+ font-family: var(--font-family-icon);
+ line-height: normal;
+ font-weight: bold;
+ font-size: 12px;
+ height: 14px;
+ width: 16px;
+ display: inline-block;
+ background-color: var(--icon-background-color);
+ color: var(--icon-foreground-color);
+ text-align: center;
+ border-radius: 4px;
+ margin-left: 2px;
+ margin-right: 2px;
}
.icona {
- width: 24px;
- height: 22px;
- display: inline-block;
+ width: 24px;
+ height: 22px;
+ display: inline-block;
}
-.iconfopen {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:var(--icon-folder-open-image);
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
+.iconfolder {
+ width: 24px;
+ height: 18px;
+ margin-top: 6px;
+ vertical-align:top;
+ display: inline-block;
+ position: relative;
}
-.iconfclosed {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:var(--icon-folder-closed-image);
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
+.icondoc {
+ width: 24px;
+ height: 18px;
+ margin-top: 3px;
+ vertical-align:top;
+ display: inline-block;
+ position: relative;
}
-.icondoc {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:var(--icon-doc-image);
- background-position: 0px -4px;
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
+.folder-icon {
+ width: 16px;
+ height: 11px;
+ background-color: var(--icon-folder-fill-color);
+ border: 1px solid var(--icon-folder-border-color);
+ border-radius: 0 2px 2px 2px;
+ position: relative;
+ box-sizing: content-box;
+}
+
+.folder-icon::after {
+ content: '';
+ position: absolute;
+ top: 2px;
+ left: -1px;
+ width: 16px;
+ height: 7px;
+ background-color: var(--icon-folder-open-fill-color);
+ border: 1px solid var(--icon-folder-border-color);
+ border-radius: 7px 7px 2px 2px;
+ transform-origin: top left;
+ opacity: 0;
+ transition: all 0.3s linear;
+}
+
+.folder-icon::before {
+ content: '';
+ position: absolute;
+ top: -3px;
+ left: -1px;
+ width: 6px;
+ height: 2px;
+ background-color: var(--icon-folder-fill-color);
+ border-top: 1px solid var(--icon-folder-border-color);
+ border-left: 1px solid var(--icon-folder-border-color);
+ border-right: 1px solid var(--icon-folder-border-color);
+ border-radius: 2px 2px 0 0;
+}
+
+.folder-icon.open::after {
+ top: 3px;
+ opacity: 1;
+}
+
+.doc-icon {
+ left: 6px;
+ width: 12px;
+ height: 16px;
+ background-color: var(--icon-doc-border-color);
+ clip-path: polygon(0 0, 66% 0, 100% 25%, 100% 100%, 0 100%);
+ position: relative;
+ display: inline-block;
+}
+.doc-icon::before {
+ content: "";
+ left: 1px;
+ top: 1px;
+ width: 10px;
+ height: 14px;
+ background-color: var(--icon-doc-fill-color);
+ clip-path: polygon(0 0, 66% 0, 100% 25%, 100% 100%, 0 100%);
+ position: absolute;
+ box-sizing: border-box;
+}
+.doc-icon::after {
+ content: "";
+ left: 7px;
+ top: 0px;
+ width: 3px;
+ height: 3px;
+ background-color: transparent;
+ position: absolute;
+ border: 1px solid var(--icon-doc-border-color);
}
+
+
+
/* @end */
div.dynheader {
- margin-top: 8px;
+ margin-top: 8px;
-webkit-touch-callout: none;
-webkit-user-select: none;
-khtml-user-select: none;
@@ -1404,6 +1657,13 @@ div.dynheader {
user-select: none;
}
+span.dynarrow {
+ position: relative;
+ display: inline-block;
+ width: 12px;
+ bottom: 1px;
+}
+
address {
font-style: normal;
color: var(--footer-foreground-color);
@@ -1415,8 +1675,8 @@ table.doxtable caption {
table.doxtable {
border-collapse:collapse;
- margin-top: 4px;
- margin-bottom: 4px;
+ margin-top: 4px;
+ margin-bottom: 4px;
}
table.doxtable td, table.doxtable th {
@@ -1433,133 +1693,145 @@ table.doxtable th {
}
table.fieldtable {
- margin-bottom: 10px;
- border: 1px solid var(--memdef-border-color);
- border-spacing: 0px;
- border-radius: 4px;
- box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
+ margin-bottom: 10px;
+ border: 1px solid var(--memdef-border-color);
+ border-spacing: 0px;
+ border-radius: 4px;
+ box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
}
.fieldtable td, .fieldtable th {
- padding: 3px 7px 2px;
+ padding: 3px 7px 2px;
}
.fieldtable td.fieldtype, .fieldtable td.fieldname, .fieldtable td.fieldinit {
- white-space: nowrap;
- border-right: 1px solid var(--memdef-border-color);
- border-bottom: 1px solid var(--memdef-border-color);
- vertical-align: top;
+ white-space: nowrap;
+ border-right: 1px solid var(--memdef-border-color);
+ border-bottom: 1px solid var(--memdef-border-color);
+ vertical-align: top;
}
.fieldtable td.fieldname {
- padding-top: 3px;
+ padding-top: 3px;
}
.fieldtable td.fieldinit {
- padding-top: 3px;
- text-align: right;
+ padding-top: 3px;
+ text-align: right;
}
.fieldtable td.fielddoc {
- border-bottom: 1px solid var(--memdef-border-color);
+ border-bottom: 1px solid var(--memdef-border-color);
}
.fieldtable td.fielddoc p:first-child {
- margin-top: 0px;
+ margin-top: 0px;
}
.fieldtable td.fielddoc p:last-child {
- margin-bottom: 2px;
+ margin-bottom: 2px;
}
.fieldtable tr:last-child td {
- border-bottom: none;
+ border-bottom: none;
}
.fieldtable th {
- background-image: var(--memdef-title-gradient-image);
- background-repeat:repeat-x;
- background-color: var(--memdef-title-background-color);
- font-size: 90%;
- color: var(--memdef-proto-text-color);
- padding-bottom: 4px;
- padding-top: 5px;
- text-align:left;
- font-weight: 400;
- border-top-left-radius: 4px;
- border-top-right-radius: 4px;
- border-bottom: 1px solid var(--memdef-border-color);
-}
-
-
-.tabsearch {
- top: 0px;
- left: 10px;
- height: 36px;
- background-image: var(--nav-gradient-image);
- z-index: 101;
+ background-color: var(--memdef-title-background-color);
+ font-size: 90%;
+ color: var(--memdef-proto-text-color);
+ padding-bottom: 4px;
+ padding-top: 5px;
+ text-align:left;
+ font-weight: 400;
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+ border-bottom: 1px solid var(--memdef-border-color);
+}
+
+/* ----------- navigation breadcrumb styling ----------- */
+
+#nav-path ul {
+ height: 30px;
+ line-height: 30px;
+ color: var(--nav-text-normal-color);
overflow: hidden;
- font-size: 13px;
+ margin: 0px;
+ padding-left: 4px;
+ background-image: none;
+ background: var(--page-background-color);
+ border-bottom: 1px solid var(--nav-breadcrumb-separator-color);
+ font-size: var(--nav-font-size-level1);
+ font-family: var(--font-family-nav);
+ position: relative;
+ z-index: 100;
}
-.navpath ul
-{
- font-size: 11px;
- background-image: var(--nav-gradient-image);
- background-repeat:repeat-x;
- background-position: 0 -5px;
- height:30px;
- line-height:30px;
- color:var(--nav-text-normal-color);
- border:solid 1px var(--nav-breadcrumb-border-color);
- overflow:hidden;
- margin:0px;
- padding:0px;
-}
-
-.navpath li
-{
+#main-nav {
+ border-bottom: 1px solid var(--nav-border-color);
+}
+
+.navpath li {
list-style-type:none;
float:left;
+ color: var(--nav-foreground-color);
+}
+
+.navpath li.footer {
+ list-style-type:none;
+ float:right;
padding-left:10px;
padding-right:15px;
- background-image:var(--nav-breadcrumb-image);
+ background-image:none;
background-repeat:no-repeat;
background-position:right;
- color: var(--nav-foreground-color);
+ font-size: 8pt;
+ color: var(--footer-foreground-color);
}
-.navpath li.navelem a
-{
- height:32px;
- display:block;
- outline: none;
- color: var(--nav-text-normal-color);
- font-family: var(--font-family-nav);
- text-shadow: var(--nav-text-normal-shadow);
- text-decoration: none;
+#nav-path li.navelem {
+ background-image: none;
+ display: flex;
+ align-items: center;
+ padding-left: 15px;
}
-.navpath li.navelem a:hover
-{
- color: var(--nav-text-hover-color);
- text-shadow: var(--nav-text-hover-shadow);
+.navpath li.navelem a {
+ text-shadow: none;
+ display: inline-block;
+ color: var(--nav-breadcrumb-color);
+ position: relative;
+ top: 0px;
+ height: 30px;
+ margin-right: -20px;
}
-.navpath li.footer
-{
- list-style-type:none;
- float:right;
- padding-left:10px;
- padding-right:15px;
- background-image:none;
- background-repeat:no-repeat;
- background-position:right;
- color: var(--footer-foreground-color);
- font-size: 8pt;
+#nav-path li.navelem:after {
+ content: '';
+ display: inline-block;
+ position: relative;
+ top: 0;
+ right: -15px;
+ width: 30px;
+ height: 30px;
+ transform: scaleX(0.5) scale(0.707) rotate(45deg);
+ z-index: 10;
+ background: var(--page-background-color);
+ box-shadow: 2px -2px 0 2px var(--nav-breadcrumb-separator-color);
+ border-radius: 0 5px 0 50px;
+}
+
+#nav-path li.navelem:first-child {
+ margin-left: -6px;
}
+#nav-path li.navelem:hover,
+#nav-path li.navelem:hover:after {
+ background-color: var(--nav-breadcrumb-active-bg);
+}
+
+/* ---------------------- */
div.summary
{
@@ -1577,14 +1849,14 @@ div.summary a
table.classindex
{
- margin: 10px;
- white-space: nowrap;
- margin-left: 3%;
- margin-right: 3%;
- width: 94%;
- border: 0;
- border-spacing: 0;
- padding: 0;
+ margin: 10px;
+ white-space: nowrap;
+ margin-left: 3%;
+ margin-right: 3%;
+ width: 94%;
+ border: 0;
+ border-spacing: 0;
+ padding: 0;
}
div.ingroups
@@ -1601,10 +1873,8 @@ div.ingroups a
div.header
{
- background-image: var(--header-gradient-image);
- background-repeat:repeat-x;
- background-color: var(--header-background-color);
margin: 0px;
+ background-color: var(--header-background-color);
border-bottom: 1px solid var(--header-separator-color);
}
@@ -1613,168 +1883,105 @@ div.headertitle
padding: 5px 5px 5px 10px;
}
-.PageDocRTL-title div.headertitle {
- text-align: right;
- direction: rtl;
-}
-
dl {
- padding: 0 0 0 0;
-}
-
-/*
-
-dl.section {
- margin-left: 0px;
- padding-left: 0px;
-}
-
-dl.note {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #D0C000;
-}
-
-dl.warning, dl.attention, dl.important {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #FF0000;
-}
-
-dl.pre, dl.post, dl.invariant {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #00D000;
-}
-
-dl.deprecated {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #505050;
-}
-
-dl.todo {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #00C0E0;
-}
-
-dl.test {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #3030E0;
-}
-
-dl.bug {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #C08050;
+ padding: 0 0 0 0;
}
-*/
-
dl.bug dt a, dl.deprecated dt a, dl.todo dt a, dl.test a {
- font-weight: bold !important;
+ font-weight: bold !important;
}
dl.warning, dl.attention, dl.important, dl.note, dl.deprecated, dl.bug,
dl.invariant, dl.pre, dl.post, dl.todo, dl.test, dl.remark {
- padding: 10px;
- margin: 10px 0px;
- overflow: hidden;
- margin-left: 0;
- border-radius: 4px;
+ padding: 10px;
+ margin: 10px 0px;
+ overflow: hidden;
+ margin-left: 0;
+ border-radius: 4px;
}
dl.section dd {
- margin-bottom: 2px;
+ margin-bottom: 2px;
}
dl.warning, dl.attention, dl.important {
- background: var(--warning-color-bg);
- border-left: 8px solid var(--warning-color-hl);
- color: var(--warning-color-text);
+ background: var(--warning-color-bg);
+ border-left: 8px solid var(--warning-color-hl);
+ color: var(--warning-color-text);
}
dl.warning dt, dl.attention dt, dl.important dt {
- color: var(--warning-color-hl);
+ color: var(--warning-color-hl);
}
dl.note, dl.remark {
- background: var(--note-color-bg);
- border-left: 8px solid var(--note-color-hl);
- color: var(--note-color-text);
+ background: var(--note-color-bg);
+ border-left: 8px solid var(--note-color-hl);
+ color: var(--note-color-text);
}
dl.note dt, dl.remark dt {
- color: var(--note-color-hl);
+ color: var(--note-color-hl);
}
dl.todo {
- background: var(--todo-color-bg);
- border-left: 8px solid var(--todo-color-hl);
- color: var(--todo-color-text);
+ background: var(--todo-color-bg);
+ border-left: 8px solid var(--todo-color-hl);
+ color: var(--todo-color-text);
}
dl.todo dt {
- color: var(--todo-color-hl);
+ color: var(--todo-color-hl);
}
dl.test {
- background: var(--test-color-bg);
- border-left: 8px solid var(--test-color-hl);
- color: var(--test-color-text);
+ background: var(--test-color-bg);
+ border-left: 8px solid var(--test-color-hl);
+ color: var(--test-color-text);
}
dl.test dt {
- color: var(--test-color-hl);
+ color: var(--test-color-hl);
}
dl.bug dt a {
- color: var(--bug-color-hl) !important;
+ color: var(--bug-color-hl) !important;
}
dl.bug {
- background: var(--bug-color-bg);
- border-left: 8px solid var(--bug-color-hl);
- color: var(--bug-color-text);
+ background: var(--bug-color-bg);
+ border-left: 8px solid var(--bug-color-hl);
+ color: var(--bug-color-text);
}
dl.bug dt a {
- color: var(--bug-color-hl) !important;
+ color: var(--bug-color-hl) !important;
}
dl.deprecated {
- background: var(--deprecated-color-bg);
- border-left: 8px solid var(--deprecated-color-hl);
- color: var(--deprecated-color-text);
+ background: var(--deprecated-color-bg);
+ border-left: 8px solid var(--deprecated-color-hl);
+ color: var(--deprecated-color-text);
}
dl.deprecated dt a {
- color: var(--deprecated-color-hl) !important;
+ color: var(--deprecated-color-hl) !important;
}
dl.note dd, dl.warning dd, dl.pre dd, dl.post dd,
dl.remark dd, dl.attention dd, dl.important dd, dl.invariant dd,
dl.bug dd, dl.deprecated dd, dl.todo dd, dl.test dd {
- margin-inline-start: 0px;
+ margin-inline-start: 0px;
}
dl.invariant, dl.pre, dl.post {
- background: var(--invariant-color-bg);
- border-left: 8px solid var(--invariant-color-hl);
- color: var(--invariant-color-text);
+ background: var(--invariant-color-bg);
+ border-left: 8px solid var(--invariant-color-hl);
+ color: var(--invariant-color-text);
}
dl.invariant dt, dl.pre dt, dl.post dt {
- color: var(--invariant-color-hl);
+ color: var(--invariant-color-hl);
}
@@ -1797,16 +2004,16 @@ dl.invariant dt, dl.pre dt, dl.post dt {
#projectalign
{
- vertical-align: middle;
- padding-left: 0.5em;
+ vertical-align: middle;
+ padding-left: 0.5em;
}
#projectname
{
font-size: 200%;
font-family: var(--font-family-title);
- margin: 0px;
- padding: 2px 0px;
+ margin: 0;
+ padding: 0;
}
#side-nav #projectname
@@ -1817,7 +2024,7 @@ dl.invariant dt, dl.pre dt, dl.post dt {
#projectbrief
{
font-size: 90%;
- font-family: var(--font-family-title);
+ font-family: var(--font-family-title);
margin: 0px;
padding: 0px;
}
@@ -1825,43 +2032,42 @@ dl.invariant dt, dl.pre dt, dl.post dt {
#projectnumber
{
font-size: 50%;
- font-family: 50% var(--font-family-title);
+ font-family: var(--font-family-title);
margin: 0px;
padding: 0px;
}
#titlearea
{
- padding: 0px;
+ padding: 0 0 0 5px;
margin: 0px;
- width: 100%;
border-bottom: 1px solid var(--title-separator-color);
background-color: var(--title-background-color);
}
.image
{
- text-align: center;
+ text-align: center;
}
.dotgraph
{
- text-align: center;
+ text-align: center;
}
.mscgraph
{
- text-align: center;
+ text-align: center;
}
.plantumlgraph
{
- text-align: center;
+ text-align: center;
}
.diagraph
{
- text-align: center;
+ text-align: center;
}
.caption
@@ -1870,67 +2076,67 @@ dl.invariant dt, dl.pre dt, dl.post dt {
}
dl.citelist {
- margin-bottom:50px;
+ margin-bottom:50px;
}
dl.citelist dt {
- color:var(--citation-label-color);
- float:left;
- font-weight:bold;
- margin-right:10px;
- padding:5px;
- text-align:right;
- width:52px;
+ color:var(--citation-label-color);
+ float:left;
+ font-weight:bold;
+ margin-right:10px;
+ padding:5px;
+ text-align:right;
+ width:52px;
}
dl.citelist dd {
- margin:2px 0 2px 72px;
- padding:5px 0;
+ margin:2px 0 2px 72px;
+ padding:5px 0;
}
div.toc {
- padding: 14px 25px;
- background-color: var(--toc-background-color);
- border: 1px solid var(--toc-border-color);
- border-radius: 7px 7px 7px 7px;
- float: right;
- height: auto;
- margin: 0 8px 10px 10px;
- width: 200px;
+ padding: 14px 25px;
+ background-color: var(--toc-background-color);
+ border: 1px solid var(--toc-border-color);
+ border-radius: 7px 7px 7px 7px;
+ float: right;
+ height: auto;
+ margin: 0 8px 10px 10px;
+ width: 200px;
}
div.toc li {
- background: var(--toc-down-arrow-image) no-repeat scroll 0 5px transparent;
- font: 10px/1.2 var(--font-family-toc);
- margin-top: 5px;
- padding-left: 10px;
- padding-top: 2px;
+ background: var(--toc-down-arrow-image) no-repeat scroll 0 5px transparent;
+ font: 10px/1.2 var(--font-family-toc);
+ margin-top: 5px;
+ padding-left: 10px;
+ padding-top: 2px;
}
div.toc h3 {
- font: bold 12px/1.2 var(--font-family-toc);
+ font: bold 12px/1.2 var(--font-family-toc);
color: var(--toc-header-color);
- border-bottom: 0 none;
- margin: 0;
+ border-bottom: 0 none;
+ margin: 0;
}
div.toc ul {
- list-style: none outside none;
- border: medium none;
- padding: 0px;
+ list-style: none outside none;
+ border: medium none;
+ padding: 0px;
}
div.toc li[class^='level'] {
- margin-left: 15px;
+ margin-left: 15px;
}
div.toc li.level1 {
- margin-left: 0px;
+ margin-left: 0px;
}
div.toc li.empty {
- background-image: none;
- margin-top: 0px;
+ background-image: none;
+ margin-top: 0px;
}
span.emoji {
@@ -1940,13 +2146,12 @@ span.emoji {
}
span.obfuscator {
- display: none;
+ display: none;
}
.inherit_header {
- font-weight: bold;
- color: var(--inherit-header-color);
- cursor: pointer;
+ font-weight: 400;
+ cursor: pointer;
-webkit-touch-callout: none;
-webkit-user-select: none;
-khtml-user-select: none;
@@ -1956,49 +2161,49 @@ span.obfuscator {
}
.inherit_header td {
- padding: 6px 0px 2px 5px;
+ padding: 6px 0 2px 0;
}
.inherit {
- display: none;
+ display: none;
}
tr.heading h2 {
- margin-top: 12px;
- margin-bottom: 4px;
+ margin-top: 12px;
+ margin-bottom: 12px;
}
/* tooltip related style info */
.ttc {
- position: absolute;
- display: none;
+ position: absolute;
+ display: none;
}
#powerTip {
cursor: default;
- /*white-space: nowrap;*/
- color: var(--tooltip-foreground-color);
+ color: var(--tooltip-foreground-color);
background-color: var(--tooltip-background-color);
+ backdrop-filter: var(--tooltip-backdrop-filter);
+ -webkit-backdrop-filter: var(--tooltip-backdrop-filter);
border: 1px solid var(--tooltip-border-color);
- border-radius: 4px 4px 4px 4px;
+ border-radius: 4px;
box-shadow: var(--tooltip-shadow);
display: none;
font-size: smaller;
max-width: 80%;
- opacity: 0.9;
padding: 1ex 1em 1em;
position: absolute;
z-index: 2147483647;
}
#powerTip div.ttdoc {
- color: var(--tooltip-doc-color);
+ color: var(--tooltip-doc-color);
font-style: italic;
}
#powerTip div.ttname a {
- font-weight: bold;
+ font-weight: bold;
}
#powerTip a {
@@ -2006,18 +2211,18 @@ tr.heading h2 {
}
#powerTip div.ttname {
- font-weight: bold;
+ font-weight: bold;
}
#powerTip div.ttdeci {
- color: var(--tooltip-declaration-color);
+ color: var(--tooltip-declaration-color);
}
#powerTip div {
- margin: 0px;
- padding: 0px;
- font-size: 12px;
- font-family: var(--font-family-tooltip);
+ margin: 0px;
+ padding: 0px;
+ font-size: 12px;
+ font-family: var(--font-family-tooltip);
line-height: 16px;
}
@@ -2063,7 +2268,7 @@ tr.heading h2 {
}
#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after {
- border-top-color: var(--tooltip-background-color);
+ border-top-color: var(--tooltip-arrow-background-color);
border-width: 10px;
margin: 0px -10px;
}
@@ -2091,7 +2296,7 @@ tr.heading h2 {
}
#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after {
- border-bottom-color: var(--tooltip-background-color);
+ border-bottom-color: var(--tooltip-arrow-background-color);
border-width: 10px;
margin: 0px -10px;
}
@@ -2148,29 +2353,29 @@ tr.heading h2 {
@media print
{
- #top { display: none; }
- #side-nav { display: none; }
- #nav-path { display: none; }
- body { overflow:visible; }
- h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
- .summary { display: none; }
- .memitem { page-break-inside: avoid; }
- #doc-content
- {
- margin-left:0 !important;
- height:auto !important;
- width:auto !important;
- overflow:inherit;
- display:inline;
- }
+ #top { display: none; }
+ #side-nav { display: none; }
+ #nav-path { display: none; }
+ body { overflow:visible; }
+ h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
+ .summary { display: none; }
+ .memitem { page-break-inside: avoid; }
+ #doc-content
+ {
+ margin-left:0 !important;
+ height:auto !important;
+ width:auto !important;
+ overflow:inherit;
+ display:inline;
+ }
}
/* @group Markdown */
table.markdownTable {
border-collapse:collapse;
- margin-top: 4px;
- margin-bottom: 4px;
+ margin-top: 4px;
+ margin-bottom: 4px;
}
table.markdownTable td, table.markdownTable th {
@@ -2203,11 +2408,11 @@ th.markdownTableHeadCenter, td.markdownTableBodyCenter {
tt, code, kbd
{
- display: inline-block;
+ display: inline-block;
}
tt, code, kbd
{
- vertical-align: top;
+ vertical-align: top;
}
/* @end */
@@ -2216,26 +2421,27 @@ u {
}
details>summary {
- list-style-type: none;
+ list-style-type: none;
}
details > summary::-webkit-details-marker {
- display: none;
+ display: none;
}
details>summary::before {
- content: "\25ba";
- padding-right:4px;
- font-size: 80%;
+ content: "\25ba";
+ padding-right:4px;
+ font-size: 80%;
}
details[open]>summary::before {
- content: "\25bc";
- padding-right:4px;
- font-size: 80%;
+ content: "\25bc";
+ padding-right:4px;
+ font-size: 80%;
}
-body {
+:root {
+ scrollbar-width: thin;
scrollbar-color: var(--scrollbar-thumb-color) var(--scrollbar-background-color);
}
diff --git a/docs/html/doxygen_crawl.html b/docs/html/doxygen_crawl.html
index 1a7784e..6b8ae0b 100644
--- a/docs/html/doxygen_crawl.html
+++ b/docs/html/doxygen_crawl.html
@@ -4,7 +4,7 @@
Validator / crawler helper
-
+
diff --git a/docs/html/dynsections.js b/docs/html/dynsections.js
index b05f4c8..0e15bd4 100644
--- a/docs/html/dynsections.js
+++ b/docs/html/dynsections.js
@@ -28,7 +28,6 @@ function toggleVisibility(linkObj) {
}
let dynsection = {
-
// helper function
updateStripes : function() {
$('table.directory tr').
@@ -44,15 +43,13 @@ let dynsection = {
const trigger = $('#'+base+'-trigger');
const src=$(trigger).attr('src');
if (content.is(':visible')===true) {
- content.hide();
+ content.slideUp('fast');
summary.show();
- $(linkObj).addClass('closed').removeClass('opened');
- $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png');
+ $(linkObj).find('.arrowhead').addClass('closed').removeClass('opened');
} else {
- content.show();
+ content.slideDown('fast');
summary.hide();
- $(linkObj).removeClass('closed').addClass('opened');
- $(trigger).attr('src',src.substring(0,src.length-10)+'open.png');
+ $(linkObj).find('.arrowhead').removeClass('closed').addClass('opened');
}
return false;
},
@@ -63,12 +60,12 @@ let dynsection = {
const i = $('#img'+this.id.substring(3));
const a = $('#arr'+this.id.substring(3));
if (lD3D12 Memory Allocator: Frequently asked questions
-
-
@@ -33,33 +31,22 @@
-
+
-
- Frequently asked questions
+ Frequently asked questions
What is D3D12MA?
@@ -96,18 +83,18 @@
What is the license of D3D12MA?
D3D12MA is licensed under MIT, which means it is open source and free software.
What is the purpose of D3D12MA?
-D3D12MA helps with handling one aspect of DX12 usage, which is GPU memory management - allocation of ID3D12Heap objects and creation of ID3D12Resource objects - buffers and textures.
+D3D12MA helps with handling one aspect of DX12 usage, which is GPU memory management - allocation of ID3D12Heap objects and creation of ID3D12Resource objects - buffers and textures.
Do I need to use D3D12MA?
You don't need to, but it may be beneficial in many cases. DX12 is a complex and low-level API, so libraries like this that abstract certain aspects of the API and bring them to a higher level are useful. When developing any non-trivial graphics application, you may benefit from using a memory allocator. Using D3D12MA can save time compared to implementing your own.
-In DX12 you can create each resource separately with its own implicit memory heap by calling CreateCommittedResource, but this may not be the optimal solution. For more information, see Committed versus placed resources.
+In DX12 you can create each resource separately with its own implicit memory heap by calling CreateCommittedResource, but this may not be the optimal solution. For more information, see Committed versus placed resources.
When should I not use D3D12MA?
While D3D12MA is useful for many applications that use the DX12 API, there are cases when it may be a better choice not to use it. For example, if the application is very simple, e.g. serving as a sample or a learning exercise to help you understand or teach others the basics of DX12, and it creates only a small number of buffers and textures, then including D3D12MA may be an overkill. Developing your own memory allocator may also be a good learning exercise.
What are the benefits of using D3D12MA?
-- D3D12MA allocates large blocks of
ID3D12Heap memory and sub-allocates parts of them to create your placed resources. Allocating a new block of GPU memory may be a time-consuming operation. Sub-allocating parts of a memory block requires implementing an allocation algorithm, which is a non-trivial task. D3D12MA does that, using an advanced and efficient algorithm that works well in various use cases.
+- D3D12MA allocates large blocks of ID3D12Heap memory and sub-allocates parts of them to create your placed resources. Allocating a new block of GPU memory may be a time-consuming operation. Sub-allocating parts of a memory block requires implementing an allocation algorithm, which is a non-trivial task. D3D12MA does that, using an advanced and efficient algorithm that works well in various use cases.
- D3D12MA offers a simple API that allows creating placed buffers and textures within one function call like D3D12MA::Allocator::CreateResource.
-The library is doing much more under the hood. For example, it keeps buffers separate from textures when needed, respecting D3D12_RESOURCE_HEAP_TIER. It also makes use of the "small texture alignment" automatically, so you don't need to think about it.
+The library is doing much more under the hood. For example, it keeps buffers separate from textures when needed, respecting D3D12_RESOURCE_HEAP_TIER. It also makes use of the "small texture alignment" automatically, so you don't need to think about it.
Which version should I pick?
You can just pick the latest version from the "master" branch. It is kept in a good shape most of the time, compiling and working correctly, with no compatibility-breaking changes and no unfinished code.
If you want an even more stable version, you can pick the latest official release. Current code from the master branch is occasionally tagged as a release, with CHANGELOG carefully curated to enumerate all important changes since the previous version.
@@ -119,10 +106,10 @@
I am not a fan of modern C++. Can I still use it?
Very likely yes. We acknowledge that many C++ developers, especially in the games industry, do not appreciate all the latest features that the language has to offer.
-- D3D12MA doesn't throw or catch any C++ exceptions. It reports errors by returning a
HRESULT value instead, just like DX12. If you don't use exceptions in your project, your code is not exception-safe, or even if you disable exception handling in the compiler options, you can still use D3D12MA.
-- D3D12MA doesn't use C++ run-time type information like
typeid or dynamic_cast, so if you disable RTTI in the compiler options, you can still use the library.
-- D3D12MA uses only a limited subset of standard C and C++ library. It doesn't use STL containers like
std::vector, map, or string, either in the public interface nor in the internal implementation. It implements its own containers instead.
-- If you don't use the default heap memory allocator through
malloc/free or new/delete but implement your own allocator instead, you can pass it to D3D12MA as D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks and the library will use your functions for every dynamic heap allocation made internally.
+- D3D12MA doesn't throw or catch any C++ exceptions. It reports errors by returning a HRESULT value instead, just like DX12. If you don't use exceptions in your project, your code is not exception-safe, or even if you disable exception handling in the compiler options, you can still use D3D12MA.
+- D3D12MA doesn't use C++ run-time type information like typeid or dynamic_cast, so if you disable RTTI in the compiler options, you can still use the library.
+- D3D12MA uses only a limited subset of standard C and C++ library. It doesn't use STL containers like std::vector, map, or string, either in the public interface nor in the internal implementation. It implements its own containers instead.
+- If you don't use the default heap memory allocator through malloc/free or new/delete but implement your own allocator instead, you can pass it to D3D12MA as D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks and the library will use your functions for every dynamic heap allocation made internally.
Is it available for other programming languages?
D3D12MA is a C++ library in similar style as DX12. Bindings to other programming languages are out of scope of this project, but they are welcome as external projects. Some of them are listed in README.md, "See also" section, including binding to C. Before using any of them, please check if they are still maintained and updated to use a recent version of D3D12MA.
@@ -132,7 +119,7 @@
No! While D3D12MA is published by AMD, it works on any GPU that supports DX12, whether a discrete PC graphics card or a processor integrated graphics. It doesn't give AMD GPUs any advantage over any other GPUs.
What DirectX 12 versions are supported?
D3D12MA is updated to support latest versions of DirectX 12, as available through recent retail versions of the DirectX 12 Agility SDK. Support for new features added in the preview version of the Agility SDK is developed on separate branches until they are included in the retail version.
-The library also supports older versions down to the base DX12 shipping with Windows SDK. Features added by later versions of the Agility SDK are automatically enabled conditionally using #ifdef preprocessor macros depending on the version of the SDK that you compile your project with.
+The library also supports older versions down to the base DX12 shipping with Windows SDK. Features added by later versions of the Agility SDK are automatically enabled conditionally using #ifdef preprocessor macros depending on the version of the SDK that you compile your project with.
Does it support other graphics APIs, like Vulkan(R)?
No, but we offer an equivalent library for Vulkan: Vulkan Memory Allocator. It uses the same core allocation algorithm. It also shares many features with D3D12MA, like the support for custom pools and virtual allocator. However, it is not identical in terms of the features supported. Its API also looks different, because while the interface of D3D12MA is similar in style to DX12, the interface of VMA is similar to Vulkan.
Is the library lightweight?
@@ -154,8 +141,8 @@
If you want to report a suspected bug, you can also create a ticket the same way. Before doing this, please put some effort into the investigation of whether the bug is really in the library and not in your code or in the DX12 implementation (the GPU driver) on your platform:
- Enable D3D Debug Layer and make sure it is free from any errors.
-- Make sure
D3D12MA_ASSERT is defined to an implementation that can report a failure and not ignore it.
-- Try making your allocation using pure DX12 functions like
CreateCommittedResource() rather than D3D12MA and see if the bug persists.
+- Make sure D3D12MA_ASSERT is defined to an implementation that can report a failure and not ignore it.
+- Try making your allocation using pure DX12 functions like CreateCommittedResource() rather than D3D12MA and see if the bug persists.
I found some compilation warnings. How can we fix them?
Seeing compiler warnings may be annoying to some developers, but it is a design decision to not fix all of them. Due to the nature of the C++ language, certain preprocessor macros can make some variables unused, function parameters unreferenced, or conditional expressions constant in some configurations. The code of this library should not be bigger or more complicated just to silence these warnings. It is recommended to disable such warnings instead. For more information, see Features not supported.
@@ -164,7 +151,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/files.html b/docs/html/files.html
index 0ccb6a5..5ce45bf 100644
--- a/docs/html/files.html
+++ b/docs/html/files.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: File List
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all files with brief descriptions:
[detail level 12]
- ▼ include D3D12MemAlloc.h include D3D12MemAlloc.h
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions.html b/docs/html/functions.html
index 0690bb7..e1beea4 100644
--- a/docs/html/functions.html
+++ b/docs/html/functions.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all class members with links to the classes they belong to:
-- a -
+- a -
- Alignment : D3D12MA::VIRTUAL_ALLOCATION_DESC
- Allocate() : D3D12MA::VirtualBlock
- AllocateMemory() : D3D12MA::Allocator
@@ -100,7 +87,7 @@ - a -
-- b -
+- b -
- BeginDefragmentation() : D3D12MA::Allocator, D3D12MA::Pool
- BeginPass() : D3D12MA::DefragmentationContext
- block : D3D12MA::Allocation
@@ -114,7 +101,7 @@ - b -
-- c -
+- c -
- CalculateStatistics() : D3D12MA::Allocator, D3D12MA::Pool, D3D12MA::VirtualBlock
- CALLOCATION_DESC() : D3D12MA::CALLOCATION_DESC
- Clear() : D3D12MA::VirtualBlock
@@ -134,25 +121,25 @@ - c -
-- d -
+- d -
- D3D12MA_DELETE : D3D12MA::Allocation, D3D12MA::Allocator, D3D12MA::DefragmentationContext, D3D12MA::Pool, D3D12MA::VirtualBlock
-- e -
+- e -
- EndPass() : D3D12MA::DefragmentationContext
- ExtraHeapFlags : D3D12MA::ALLOCATION_DESC
-- f -
+- f -
- Flags : D3D12MA::ALLOCATION_DESC, D3D12MA::ALLOCATOR_DESC, D3D12MA::DEFRAGMENTATION_DESC, D3D12MA::POOL_DESC, D3D12MA::VIRTUAL_ALLOCATION_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
- FreeAllocation() : D3D12MA::VirtualBlock
- FreeStatsString() : D3D12MA::Allocator, D3D12MA::VirtualBlock
-- g -
+- g -
- GetAlignment() : D3D12MA::Allocation
- GetAllocationInfo() : D3D12MA::VirtualBlock
- GetBudget() : D3D12MA::Allocator
@@ -170,7 +157,7 @@ - g -
-- h -
+- h -
- heap : D3D12MA::Allocation
- HeapFlags : D3D12MA::POOL_DESC
- HeapProperties : D3D12MA::POOL_DESC
@@ -179,7 +166,7 @@ - h -
-- i -
+- i -
- IsCacheCoherentUMA() : D3D12MA::Allocator
- IsEmpty() : D3D12MA::VirtualBlock
- IsGPUUploadHeapSupported() : D3D12MA::Allocator
@@ -187,12 +174,12 @@ - i -
-- l -
+- l -
- list : D3D12MA::Allocation
-- m -
+- m -
- m_Committed : D3D12MA::Allocation
- m_Heap : D3D12MA::Allocation
- m_Placed : D3D12MA::Allocation
@@ -206,18 +193,18 @@ - m -
-- n -
+- n -
- next : D3D12MA::Allocation
-- o -
+- o -
- Offset : D3D12MA::VIRTUAL_ALLOCATION_INFO
- Operation : D3D12MA::DEFRAGMENTATION_MOVE
-- p -
+- p -
- pAdapter : D3D12MA::ALLOCATOR_DESC
- pAllocate : D3D12MA::ALLOCATION_CALLBACKS
- pAllocationCallbacks : D3D12MA::ALLOCATOR_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
@@ -233,12 +220,12 @@ - p -
-- r -
+- r -
- ResidencyPriority : D3D12MA::POOL_DESC
-- s -
+- s -
- SetAllocationPrivateData() : D3D12MA::VirtualBlock
- SetCurrentFrameIndex() : D3D12MA::Allocator
- SetName() : D3D12MA::Allocation, D3D12MA::Pool
@@ -249,12 +236,12 @@ - s -
-- t -
+- t -
- Total : D3D12MA::TotalStatistics
-- u -
+- u -
- UnusedRangeCount : D3D12MA::DetailedStatistics
- UnusedRangeSizeMax : D3D12MA::DetailedStatistics
- UnusedRangeSizeMin : D3D12MA::DetailedStatistics
@@ -263,7 +250,7 @@ - u -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html
index 23515d8..8f38cf0 100644
--- a/docs/html/functions_func.html
+++ b/docs/html/functions_func.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members - Functions
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all functions with links to the classes they belong to:
-- a -
+- a -
- Allocate() : D3D12MA::VirtualBlock
- AllocateMemory() : D3D12MA::Allocator
-- b -
+- b -
- BeginDefragmentation() : D3D12MA::Allocator, D3D12MA::Pool
- BeginPass() : D3D12MA::DefragmentationContext
- BuildStatsString() : D3D12MA::Allocator, D3D12MA::VirtualBlock
-- c -
+- c -
- CalculateStatistics() : D3D12MA::Allocator, D3D12MA::Pool, D3D12MA::VirtualBlock
- CALLOCATION_DESC() : D3D12MA::CALLOCATION_DESC
- Clear() : D3D12MA::VirtualBlock
@@ -116,18 +103,18 @@ - c -
-- e -
+- e -
- EndPass() : D3D12MA::DefragmentationContext
-- f -
+- f -
- FreeAllocation() : D3D12MA::VirtualBlock
- FreeStatsString() : D3D12MA::Allocator, D3D12MA::VirtualBlock
-- g -
+- g -
- GetAlignment() : D3D12MA::Allocation
- GetAllocationInfo() : D3D12MA::VirtualBlock
- GetBudget() : D3D12MA::Allocator
@@ -145,7 +132,7 @@ - g -
-- i -
+- i -
- IsCacheCoherentUMA() : D3D12MA::Allocator
- IsEmpty() : D3D12MA::VirtualBlock
- IsGPUUploadHeapSupported() : D3D12MA::Allocator
@@ -153,7 +140,7 @@ - i -
-- s -
+- s -
- SetAllocationPrivateData() : D3D12MA::VirtualBlock
- SetCurrentFrameIndex() : D3D12MA::Allocator
- SetName() : D3D12MA::Allocation, D3D12MA::Pool
@@ -163,7 +150,7 @@ - s -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions_rela.html b/docs/html/functions_rela.html
index b9d0728..f21eddd 100644
--- a/docs/html/functions_rela.html
+++ b/docs/html/functions_rela.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members - Related Symbols
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions_vars.html b/docs/html/functions_vars.html
index f63ab83..fe4ed5f 100644
--- a/docs/html/functions_vars.html
+++ b/docs/html/functions_vars.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members - Variables
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all variables with links to the classes they belong to:
-- a -
+- a -
- Alignment : D3D12MA::VIRTUAL_ALLOCATION_DESC
- AllocationBytes : D3D12MA::Statistics
- AllocationCount : D3D12MA::Statistics
@@ -98,7 +85,7 @@ - a -
-- b -
+- b -
- block : D3D12MA::Allocation
- BlockBytes : D3D12MA::Statistics
- BlockCount : D3D12MA::Statistics
@@ -109,22 +96,22 @@ - b -
-- c -
+- c -
- CustomPool : D3D12MA::ALLOCATION_DESC
-- e -
+- e -
- ExtraHeapFlags : D3D12MA::ALLOCATION_DESC
-- f -
+- f -
- Flags : D3D12MA::ALLOCATION_DESC, D3D12MA::ALLOCATOR_DESC, D3D12MA::DEFRAGMENTATION_DESC, D3D12MA::POOL_DESC, D3D12MA::VIRTUAL_ALLOCATION_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
-- h -
+- h -
- heap : D3D12MA::Allocation
- HeapFlags : D3D12MA::POOL_DESC
- HeapProperties : D3D12MA::POOL_DESC
@@ -133,12 +120,12 @@ - h -
-- l -
+- l -
- list : D3D12MA::Allocation
-- m -
+- m -
- m_Committed : D3D12MA::Allocation
- m_Heap : D3D12MA::Allocation
- m_Placed : D3D12MA::Allocation
@@ -152,18 +139,18 @@ - m -
-- n -
+- n -
- next : D3D12MA::Allocation
-- o -
+- o -
- Offset : D3D12MA::VIRTUAL_ALLOCATION_INFO
- Operation : D3D12MA::DEFRAGMENTATION_MOVE
-- p -
+- p -
- pAdapter : D3D12MA::ALLOCATOR_DESC
- pAllocate : D3D12MA::ALLOCATION_CALLBACKS
- pAllocationCallbacks : D3D12MA::ALLOCATOR_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
@@ -179,23 +166,23 @@ - p -
-- r -
+- r -
- ResidencyPriority : D3D12MA::POOL_DESC
-- s -
+- s -
- Size : D3D12MA::VIRTUAL_ALLOCATION_DESC, D3D12MA::VIRTUAL_ALLOCATION_INFO, D3D12MA::VIRTUAL_BLOCK_DESC
- Stats : D3D12MA::Budget, D3D12MA::DetailedStatistics
-- t -
+- t -
- Total : D3D12MA::TotalStatistics
-- u -
+- u -
- UnusedRangeCount : D3D12MA::DetailedStatistics
- UnusedRangeSizeMax : D3D12MA::DetailedStatistics
- UnusedRangeSizeMin : D3D12MA::DetailedStatistics
@@ -204,7 +191,7 @@ - u -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/general_considerations.html b/docs/html/general_considerations.html
index ef3888a..05a30ff 100644
--- a/docs/html/general_considerations.html
+++ b/docs/html/general_considerations.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: General considerations
-
-
@@ -33,33 +31,22 @@
-
+
-
- General considerations
+ General considerations
-
+
Thread safety
-- The library has no global state, so separate D3D12MA::Allocator objects can be used independently. In typical applications there should be no need to create multiple such objects though - one per
ID3D12Device is enough.
+- The library has no global state, so separate D3D12MA::Allocator objects can be used independently. In typical applications there should be no need to create multiple such objects though - one per ID3D12Device is enough.
- All calls to methods of D3D12MA::Allocator class are safe to be made from multiple threads simultaneously because they are synchronized internally when needed.
- When the allocator is created with D3D12MA::ALLOCATOR_FLAG_SINGLETHREADED, calls to methods of D3D12MA::Allocator class must be made from a single thread or synchronized by the user. Using this flag may improve performance.
- D3D12MA::VirtualBlock is not safe to be used from multiple threads simultaneously.
-
+
Versioning and compatibility
The library uses Semantic Versioning, which means version numbers follow convention: Major.Minor.Patch (e.g. 2.3.0), where:
@@ -109,13 +96,13 @@ <
All changes between official releases are documented in file "CHANGELOG.md".
- Warning
- Backward compatiblity is considered on the level of C++ source code, not binary linkage. Adding new members to existing structures is treated as backward compatible if initializing the new members to binary zero results in the old behavior. You should always fully initialize all library structures to zeros and not rely on their exact binary size.
-
+
Features not supported
Features deliberately excluded from the scope of this library:
- Descriptor allocation. Although also called "heaps", objects that represent descriptors are separate part of the D3D12 API from buffers and textures. You can still use Virtual allocator to manage descriptors and their ranges inside a descriptor heap.
- Support for reserved (tiled) resources. We don't recommend using them. For more information, see [1].
-- Support for
ID3D12Device::Evict and MakeResident. We don't recommend using them. You can call them on the D3D12 objects manually. Plese keep in mind, however, that eviction happens on the level of entire ID3D12Heap memory blocks and not individual buffers or textures which may be placed inside them.
+- Support for ID3D12Device::Evict and MakeResident. We don't recommend using them. You can call them on the D3D12 objects manually. Plese keep in mind, however, that eviction happens on the level of entire ID3D12Heap memory blocks and not individual buffers or textures which may be placed inside them.
- Handling CPU memory allocation failures. When dynamically creating small C++ objects in CPU memory (not the GPU memory), allocation failures are not handled gracefully, because that would complicate code significantly and is usually not needed in desktop PC applications anyway. Success of an allocation is just checked with an assert.
- Code free of any compiler warnings. There are many preprocessor macros that make some variables unused, function parameters unreferenced, or conditional expressions constant in some configurations. The code of this library should not be bigger or more complicated just to silence these warnings. It is recommended to disable such warnings instead.
- This is a C++ library. Bindings or ports to any other programming languages are welcome as external projects but are not going to be included into this repository.
@@ -125,7 +112,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/globals.html b/docs/html/globals.html
index 00f8dbd..27989c1 100644
--- a/docs/html/globals.html
+++ b/docs/html/globals.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: File Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/globals_defs.html b/docs/html/globals_defs.html
index feb2e5c..00db10d 100644
--- a/docs/html/globals_defs.html
+++ b/docs/html/globals_defs.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: File Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html
index 292f556..5785855 100644
--- a/docs/html/hierarchy.html
+++ b/docs/html/hierarchy.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Hierarchy
-
-
@@ -33,35 +31,24 @@
-
+
-
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 12]
CD3D12MA::ALLOCATION_CALLBACKS Custom callbacks to CPU memory allocation functions ▼CD3D12MA::ALLOCATION_DESC Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource CD3D12MA::ALLOCATION_DESC Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource CD3D12MA::CALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure CD3D12MA::ALLOCATOR_DESC Parameters of created Allocator object. To be used with CreateAllocator() CD3D12MA::Budget Statistics of current memory usage and available budget for a specific memory segment group CD3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Parameters for incremental defragmentation steps CD3D12MA::DEFRAGMENTATION_STATS Statistics returned for defragmentation process by function DefragmentationContext::GetStats() CD3D12MA::DetailedStatistics More detailed statistics than D3D12MA::Statistics ▼CIUnknownImpl CIUnknownImpl CD3D12MA::Allocation Represents single memory allocation CD3D12MA::Allocator Represents main object of this library initialized for particular ID3D12Device CD3D12MA::Allocator Represents main object of this library initialized for particular ID3D12Device CD3D12MA::DefragmentationContext Represents defragmentation process in progress CD3D12MA::Pool Custom memory pool CD3D12MA::VirtualBlock Represents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory ▼CD3D12MA::POOL_DESC Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool CD3D12MA::POOL_DESC Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool CD3D12MA::CPOOL_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure CD3D12MA::Statistics Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total CD3D12MA::TotalStatistics General statistics from current state of the allocator - total memory usage across all memory heaps and segments ▼CD3D12MA::VIRTUAL_ALLOCATION_DESC Parameters of created virtual allocation to be passed to VirtualBlock::Allocate() CD3D12MA::VIRTUAL_ALLOCATION_DESC Parameters of created virtual allocation to be passed to VirtualBlock::Allocate() CD3D12MA::CVIRTUAL_ALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure CD3D12MA::VIRTUAL_ALLOCATION_INFO Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo() ▼CD3D12MA::VIRTUAL_BLOCK_DESC Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock() CD3D12MA::VIRTUAL_BLOCK_DESC Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock() CD3D12MA::CVIRTUAL_BLOCK_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure CD3D12MA::VirtualAllocation Represents single memory allocation done inside VirtualBlock
@@ -120,7 +107,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/index.html b/docs/html/index.html
index e005026..d7434ba 100644
--- a/docs/html/index.html
+++ b/docs/html/index.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12 Memory Allocator
-
-
@@ -33,35 +31,24 @@
-
+
-
D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved.
License: MIT
-Documentation of all members: D3D12MemAlloc.h
-
+
Documentation of all members: D3D12MemAlloc.h
+
Table of contents
- Frequently asked questions
@@ -131,10 +118,10 @@
-
+
Web links
-- Direct3D 12 Memory Allocator at GPUOpen.com - product page
+- Direct3D 12 Memory Allocator at GPUOpen.com - product page
- GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com - source code repository
@@ -142,7 +129,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/linear_algorithm.html b/docs/html/linear_algorithm.html
index 25d5301..0bc59b0 100644
--- a/docs/html/linear_algorithm.html
+++ b/docs/html/linear_algorithm.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Linear allocation algorithm
-
-
@@ -33,33 +31,22 @@
-
+
-
- Linear allocation algorithm
+ Linear allocation algorithm
Each D3D12 memory block managed by this library has accompanying metadata that keeps track of used and unused regions. By default, the metadata structure and algorithm tries to find best place for new allocations among free regions to optimize memory usage. This way you can allocate and free objects in any order.
@@ -96,17 +83,17 @@
Sometimes there is a need to use simpler, linear allocation algorithm. You can create custom pool that uses such algorithm by adding flag D3D12MA::POOL_FLAG_ALGORITHM_LINEAR to D3D12MA::POOL_DESC::Flags while creating D3D12MA::Pool object. Then an alternative metadata management is used. It always creates new allocations after last one and doesn't reuse free regions after allocations freed in the middle. It results in better allocation performance and less memory consumed by metadata.
With this one flag, you can create a custom pool that can be used in many ways: free-at-once, stack, double stack, and ring buffer. See below for details. You don't need to specify explicitly which of these options you are going to use - it is detected automatically.
-
+
Free-at-once
-
In a pool that uses linear algorithm, you still need to free all the allocations individually by calling allocation->Release(). You can free them in any order. New allocations are always made after last one - free space in the middle is not reused. However, when you release all the allocation and the pool becomes empty, allocation starts from the beginning again. This way you can use linear algorithm to speed up creation of allocations that you are going to release all at once.
+In a pool that uses linear algorithm, you still need to free all the allocations individually by calling allocation->Release(). You can free them in any order. New allocations are always made after last one - free space in the middle is not reused. However, when you release all the allocation and the pool becomes empty, allocation starts from the beginning again. This way you can use linear algorithm to speed up creation of allocations that you are going to release all at once.
This mode is also available for pools created with D3D12MA::POOL_DESC::MaxBlockCount value that allows multiple memory blocks.
-
+
Stack
When you free an allocation that was created last, its space can be reused. Thanks to this, if you always release allocations in the order opposite to their creation (LIFO - Last In First Out), you can achieve behavior of a stack.
This mode is also available for pools created with D3D12MA::POOL_DESC::MaxBlockCount value that allows multiple memory blocks.
-
+
Double stack
The space reserved by a custom pool with linear algorithm may be used by two stacks:
@@ -116,20 +103,20 @@
To make allocation from the upper stack, add flag D3D12MA::ALLOCATION_FLAG_UPPER_ADDRESS to D3D12MA::ALLOCATION_DESC::Flags.
Double stack is available only in pools with one memory block - D3D12MA::POOL_DESC::MaxBlockCount must be 1. Otherwise behavior is undefined.
-When the two stacks' ends meet so there is not enough space between them for a new allocation, such allocation fails with usual E_OUTOFMEMORY error.
-
+
When the two stacks' ends meet so there is not enough space between them for a new allocation, such allocation fails with usual E_OUTOFMEMORY error.
+
Ring buffer
When you free some allocations from the beginning and there is not enough free space for a new one at the end of a pool, allocator's "cursor" wraps around to the beginning and starts allocation there. Thanks to this, if you always release allocations in the same order as you created them (FIFO - First In First Out), you can achieve behavior of a ring buffer / queue.
Ring buffer is available only in pools with one memory block - D3D12MA::POOL_DESC::MaxBlockCount must be 1. Otherwise behavior is undefined.
-
+
Additional considerations
Linear algorithm can also be used with Virtual allocator. See flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/menu.js b/docs/html/menu.js
index 0fd1e99..15f9c52 100644
--- a/docs/html/menu.js
+++ b/docs/html/menu.js
@@ -49,7 +49,7 @@ function initMenu(relPath,searchEnabled,serverSide,searchPage,search,treeview) {
searchBoxHtml=''+
''+
'');
$('#main-nav').append(makeTree(menudata,relPath));
$('#main-nav').children(':first').addClass('sm sm-dox').attr('id','main-menu');
- if (searchBoxHtml) {
- $('#main-menu').append('');
- }
+ $('#main-menu').append('');
const $mainMenuState = $('#main-menu-state');
let prevWidth = 0;
if ($mainMenuState.length) {
diff --git a/docs/html/namespace_d3_d12_m_a.html b/docs/html/namespace_d3_d12_m_a.html
index e770fdc..b4ae5de 100644
--- a/docs/html/namespace_d3_d12_m_a.html
+++ b/docs/html/namespace_d3_d12_m_a.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA Namespace Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
-
+
Classes
class Allocation class Allocation Represents single memory allocation. More...
struct ALLOCATION_CALLBACKS struct ALLOCATION_CALLBACKS Custom callbacks to CPU memory allocation functions. More...
struct ALLOCATION_DESC struct ALLOCATION_DESC Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource. More...
class Allocator Represents main object of this library initialized for particular ID3D12Device. More...
struct ALLOCATOR_DESC class Allocator Represents main object of this library initialized for particular ID3D12Device. More...
struct ALLOCATOR_DESC Parameters of created Allocator object. To be used with CreateAllocator(). More...
struct Budget struct Budget Statistics of current memory usage and available budget for a specific memory segment group. More...
struct CALLOCATION_DESC struct CALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure. More...
struct CPOOL_DESC struct CPOOL_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure. More...
struct CVIRTUAL_ALLOCATION_DESC struct CVIRTUAL_ALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure. More...
struct CVIRTUAL_BLOCK_DESC struct CVIRTUAL_BLOCK_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure. More...
struct DEFRAGMENTATION_DESC struct DEFRAGMENTATION_DESC Parameters for defragmentation. More...
struct DEFRAGMENTATION_MOVE struct DEFRAGMENTATION_MOVE Single move of an allocation to be done for defragmentation. More...
struct DEFRAGMENTATION_PASS_MOVE_INFO struct DEFRAGMENTATION_PASS_MOVE_INFO Parameters for incremental defragmentation steps. More...
struct DEFRAGMENTATION_STATS struct DEFRAGMENTATION_STATS Statistics returned for defragmentation process by function DefragmentationContext::GetStats(). More...
class DefragmentationContext class DefragmentationContext Represents defragmentation process in progress. More...
struct DetailedStatistics struct DetailedStatistics More detailed statistics than D3D12MA::Statistics. More...
class Pool class Pool Custom memory pool. More...
struct POOL_DESC struct POOL_DESC Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool. More...
struct Statistics struct Statistics Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total. More...
struct TotalStatistics struct TotalStatistics General statistics from current state of the allocator - total memory usage across all memory heaps and segments. More...
struct VIRTUAL_ALLOCATION_DESC struct VIRTUAL_ALLOCATION_DESC Parameters of created virtual allocation to be passed to VirtualBlock::Allocate(). More...
struct VIRTUAL_ALLOCATION_INFO struct VIRTUAL_ALLOCATION_INFO Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo(). More...
struct VIRTUAL_BLOCK_DESC struct VIRTUAL_BLOCK_DESC Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock(). More...
struct VirtualAllocation struct VirtualAllocation Represents single memory allocation done inside VirtualBlock. More...
class VirtualBlock class VirtualBlock Represents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory. More...
-
+
Typedefs
typedef UINT64 AllocHandle Unique identifier of single allocation done inside the memory heap.
using ALLOCATE_FUNC_PTR = void* (*)(size_t Size, size_t Alignment, void* pPrivateData) Pointer to custom callback function that allocates CPU memory.
using FREE_FUNC_PTR = void (*)(void* pMemory, void* pPrivateData) Pointer to custom callback function that deallocates CPU memory.
-
+
Enumerations
enum ALLOCATION_FLAGS {
ALLOCATION_FLAG_NONE = 0
@@ -203,20 +162,17 @@
} Bit flags to be used with ALLOCATION_DESC::Flags. More...
enum DEFRAGMENTATION_FLAGS { DEFRAGMENTATION_FLAG_ALGORITHM_FAST = 0x1
, DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED = 0x2
, DEFRAGMENTATION_FLAG_ALGORITHM_FULL = 0x4
, DEFRAGMENTATION_FLAG_ALGORITHM_MASK
} Flags to be passed as DEFRAGMENTATION_DESC::Flags. More...
enum DEFRAGMENTATION_MOVE_OPERATION { DEFRAGMENTATION_MOVE_OPERATION_COPY = 0
, DEFRAGMENTATION_MOVE_OPERATION_IGNORE = 1
, DEFRAGMENTATION_MOVE_OPERATION_DESTROY = 2
} Operation performed on single defragmentation move. More...
enum POOL_FLAGS {
POOL_FLAG_NONE = 0
, POOL_FLAG_ALGORITHM_LINEAR = 0x1
@@ -227,7 +183,6 @@
} Bit flags to be used with POOL_DESC::Flags. More...
enum ALLOCATOR_FLAGS {
ALLOCATOR_FLAG_NONE = 0
, ALLOCATOR_FLAG_SINGLETHREADED = 0x1
@@ -239,13 +194,11 @@
} Bit flags to be used with ALLOCATOR_DESC::Flags. More...
enum VIRTUAL_BLOCK_FLAGS { VIRTUAL_BLOCK_FLAG_NONE = 0
, VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR = POOL_FLAG_ALGORITHM_LINEAR
, VIRTUAL_BLOCK_FLAG_ALGORITHM_MASK = POOL_FLAG_ALGORITHM_MASK
} Bit flags to be used with VIRTUAL_BLOCK_DESC::Flags. More...
enum VIRTUAL_ALLOCATION_FLAGS {
VIRTUAL_ALLOCATION_FLAG_NONE = 0
, VIRTUAL_ALLOCATION_FLAG_UPPER_ADDRESS = ALLOCATION_FLAG_UPPER_ADDRESS
@@ -257,18 +210,15 @@
} Bit flags to be used with VIRTUAL_ALLOCATION_DESC::Flags. More...
-
+
Functions
D3D12MA_API HRESULT CreateAllocator (const ALLOCATOR_DESC *pDesc, Allocator **ppAllocator) Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
D3D12MA_API HRESULT CreateVirtualBlock (const VIRTUAL_BLOCK_DESC *pDesc, VirtualBlock **ppVirtualBlock) Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
-Typedef Documentation
+Typedef Documentation
◆ ALLOCATE_FUNC_PTR
@@ -314,11 +264,11 @@
Pointer to custom callback function that deallocates CPU memory.
-pMemory = null should be accepted and ignored.
+pMemory = null should be accepted and ignored.
-Enumeration Type Documentation
+Enumeration Type Documentation
◆ ALLOCATION_FLAGS
@@ -338,21 +288,21 @@ ALLOCATION_FLAG_COMMITTED Set this flag if the allocation should have its own dedicated memory allocation (committed resource with implicit heap).
Use it for special, big resources, like fullscreen textures used as render targets.
-- When used with functions like D3D12MA::Allocator::CreateResource, it will use
ID3D12Device::CreateCommittedResource, so the created allocation will contain a resource (D3D12MA::Allocation::GetResource() != NULL) but will not have a heap (D3D12MA::Allocation::GetHeap() == NULL), as the heap is implicit.
-- When used with raw memory allocation like D3D12MA::Allocator::AllocateMemory, it will use
ID3D12Device::CreateHeap, so the created allocation will contain a heap (D3D12MA::Allocation::GetHeap() != NULL) and its offset will always be 0.
+- When used with functions like D3D12MA::Allocator::CreateResource, it will use ID3D12Device::CreateCommittedResource, so the created allocation will contain a resource (D3D12MA::Allocation::GetResource() != NULL) but will not have a heap (D3D12MA::Allocation::GetHeap() == NULL), as the heap is implicit.
+- When used with raw memory allocation like D3D12MA::Allocator::AllocateMemory, it will use ID3D12Device::CreateHeap, so the created allocation will contain a heap (D3D12MA::Allocation::GetHeap() != NULL) and its offset will always be 0.
ALLOCATION_FLAG_NEVER_ALLOCATE Set this flag to only try to allocate from existing memory heaps and never create new such heap.
-If new allocation cannot be placed in any of the existing heaps, allocation fails with E_OUTOFMEMORY error.
+If new allocation cannot be placed in any of the existing heaps, allocation fails with E_OUTOFMEMORY error.
You should not use D3D12MA::ALLOCATION_FLAG_COMMITTED and D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE at the same time. It makes no sense.
ALLOCATION_FLAG_WITHIN_BUDGET Create allocation only if additional memory required for it, if any, won't exceed memory budget. Otherwise return E_OUTOFMEMORY.
+ALLOCATION_FLAG_WITHIN_BUDGET Create allocation only if additional memory required for it, if any, won't exceed memory budget. Otherwise return E_OUTOFMEMORY.
ALLOCATION_FLAG_UPPER_ADDRESS Allocation will be created from upper stack in a double stack pool.
This flag is only allowed for custom pools created with POOL_FLAG_ALGORITHM_LINEAR flag.
ALLOCATION_FLAG_CAN_ALIAS Set this flag if the allocated memory will have aliasing resources.
-Use this when calling D3D12MA::Allocator::CreateResource() and similar to guarantee creation of explicit heap for desired allocation and prevent it from using CreateCommittedResource, so that new allocation object will always have allocation->GetHeap() != NULL.
+Use this when calling D3D12MA::Allocator::CreateResource() and similar to guarantee creation of explicit heap for desired allocation and prevent it from using CreateCommittedResource, so that new allocation object will always have allocation->GetHeap() != NULL.
ALLOCATION_FLAG_STRATEGY_MIN_MEMORY Allocation strategy that chooses smallest possible free range for the allocation to minimize memory usage and fragmentation, possibly at the expense of allocation time.
ALLOCATION_FLAG_STRATEGY_FIRST_FIT Alias to ALLOCATION_FLAG_STRATEGY_MIN_TIME.
ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
+ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
ALLOCATOR_FLAG_ALWAYS_COMMITTED Every allocation will be created as a committed resource - will have its own memory block.
Affects both default pools and custom pools. To be used for debugging purposes only. There is also an equivalent flag for custom pools: D3D12MA::POOL_FLAG_ALWAYS_COMMITTED.
ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED Heaps created for the default pools will be created with flag D3D12_HEAP_FLAG_CREATE_NOT_ZEROED, allowing for their memory to be not zeroed by the system if possible, which can speed up allocation.
+ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED Heaps created for the default pools will be created with flag D3D12_HEAP_FLAG_CREATE_NOT_ZEROED, allowing for their memory to be not zeroed by the system if possible, which can speed up allocation.
Only affects default pools. To use the flag with Custom memory pools, you need to add it manually:
poolDesc.heapFlags |= D3D12_HEAP_FLAG_CREATE_NOT_ZEROED;
-Only avaiable if ID3D12Device8 is present. Otherwise, the flag is ignored.
+Only avaiable if ID3D12Device8 is present. Otherwise, the flag is ignored.
ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED Optimization, allocate MSAA textures as committed resources always.
Specify this flag to create MSAA textures with implicit heaps, as if they were created with flag D3D12MA::ALLOCATION_FLAG_COMMITTED. Usage of this flags enables all default pools to create its heaps on smaller alignment not suitable for MSAA textures.
@@ -424,11 +374,11 @@
Enumerator DEFRAGMENTATION_FLAG_ALGORITHM_FAST Use simple but fast algorithm for defragmentation. May not achieve best results but will require least time to compute and least allocations to copy.
DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED Default defragmentation algorithm, applied also when no ALGORITHM flag is specified. Offers a balance between defragmentation quality and the amount of allocations and bytes that need to be moved.
+DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED Default defragmentation algorithm, applied also when no ALGORITHM flag is specified. Offers a balance between defragmentation quality and the amount of allocations and bytes that need to be moved.
DEFRAGMENTATION_FLAG_ALGORITHM_FULL Perform full defragmentation of memory. Can result in notably more time to compute and allocations to copy, but will achieve best memory packing.
DEFRAGMENTATION_FLAG_ALGORITHM_MASK A bit mask to extract only ALGORITHM bits from entire set of flags.
+DEFRAGMENTATION_FLAG_ALGORITHM_MASK A bit mask to extract only ALGORITHM bits from entire set of flags.
-Enumerator DEFRAGMENTATION_MOVE_OPERATION_COPY Resource has been recreated at pDstTmpAllocation, data has been copied, old resource has been destroyed. pSrcAllocation will be changed to point to the new place. This is the default value set by DefragmentationContext::BeginPass().
+Enumerator DEFRAGMENTATION_MOVE_OPERATION_COPY Resource has been recreated at pDstTmpAllocation, data has been copied, old resource has been destroyed. pSrcAllocation will be changed to point to the new place. This is the default value set by DefragmentationContext::BeginPass().
DEFRAGMENTATION_MOVE_OPERATION_IGNORE Set this value if you cannot move the allocation. New place reserved at pDstTmpAllocation will be freed. pSrcAllocation will remain unchanged.
+DEFRAGMENTATION_MOVE_OPERATION_IGNORE Set this value if you cannot move the allocation. New place reserved at pDstTmpAllocation will be freed. pSrcAllocation will remain unchanged.
DEFRAGMENTATION_MOVE_OPERATION_DESTROY Set this value if you decide to abandon the allocation and you destroyed the resource. New place reserved pDstTmpAllocation will be freed, along with pSrcAllocation.
+DEFRAGMENTATION_MOVE_OPERATION_DESTROY Set this value if you decide to abandon the allocation and you destroyed the resource. New place reserved pDstTmpAllocation will be freed, along with pSrcAllocation.
VIRTUAL_ALLOCATION_FLAG_STRATEGY_MIN_OFFSET
Allocation strategy that chooses always the lowest offset in available space. This is not the most efficient strategy but achieves highly packed data.
VIRTUAL_ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
+VIRTUAL_ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
These strategy flags are binary compatible with equivalent flags in ALLOCATION_FLAGS.
Function Documentation
+Function Documentation
◆ CreateAllocator()
@@ -567,8 +517,8 @@
-Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
-You normally only need to call it once and keep a single Allocator object for your ID3D12Device.
+Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
+You normally only need to call it once and keep a single Allocator object for your ID3D12Device.
@@ -591,7 +541,7 @@
-Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
+Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
Note you don't need to create D3D12MA::Allocator to use virtual blocks.
@@ -599,7 +549,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers.html b/docs/html/namespacemembers.html
index 6881ab0..4cadc29 100644
--- a/docs/html/namespacemembers.html
+++ b/docs/html/namespacemembers.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all namespace members with links to the namespace documentation for each member:
-- a -
+- a -
- ALLOCATE_FUNC_PTR : D3D12MA
- ALLOCATION_FLAG_CAN_ALIAS : D3D12MA
- ALLOCATION_FLAG_COMMITTED : D3D12MA
@@ -112,13 +99,13 @@ - a -
-- c -
+- c -
-- d -
+- d -
- DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FAST : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FULL : D3D12MA
@@ -131,12 +118,12 @@ - d -
-- f -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_enum.html b/docs/html/namespacemembers_enum.html
index 5723a6b..90ffd55 100644
--- a/docs/html/namespacemembers_enum.html
+++ b/docs/html/namespacemembers_enum.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_eval.html b/docs/html/namespacemembers_eval.html
index 365527c..4a4922b 100644
--- a/docs/html/namespacemembers_eval.html
+++ b/docs/html/namespacemembers_eval.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all namespace enum values with links to the namespace documentation for each enum value:
-- a -
+- a -
- ALLOCATION_FLAG_CAN_ALIAS : D3D12MA
- ALLOCATION_FLAG_COMMITTED : D3D12MA
- ALLOCATION_FLAG_NEVER_ALLOCATE : D3D12MA
@@ -108,7 +95,7 @@ - a -
-- d -
+- d -
- DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FAST : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FULL : D3D12MA
@@ -119,7 +106,7 @@ - d -
-- p -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_func.html b/docs/html/namespacemembers_func.html
index 02a9cdd..c8a70c7 100644
--- a/docs/html/namespacemembers_func.html
+++ b/docs/html/namespacemembers_func.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_type.html b/docs/html/namespacemembers_type.html
index b56e9c4..e9561e2 100644
--- a/docs/html/namespacemembers_type.html
+++ b/docs/html/namespacemembers_type.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespaces.html b/docs/html/namespaces.html
index fe8ddce..acd9768 100644
--- a/docs/html/namespaces.html
+++ b/docs/html/namespaces.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace List
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/navtree.css b/docs/html/navtree.css
index 69211d4..0ea3a07 100644
--- a/docs/html/navtree.css
+++ b/docs/html/navtree.css
@@ -11,8 +11,8 @@
#nav-tree li {
white-space:nowrap;
- margin:0px;
- padding:0px;
+ margin:0;
+ padding:0;
}
#nav-tree .plus {
@@ -20,15 +20,10 @@
}
#nav-tree .selected {
- background-image: url('tab_a.png');
- background-repeat:repeat-x;
- color: var(--nav-text-active-color);
- text-shadow: var(--nav-text-active-shadow);
-}
-
-#nav-tree .selected .arrow {
- color: var(--nav-arrow-selected-color);
- text-shadow: none;
+ position: relative;
+ background-color: var(--nav-menu-active-bg);
+ border-radius: 0 6px 6px 0;
+ /*margin-right: 5px;*/
}
#nav-tree img {
@@ -48,6 +43,7 @@
margin:0px;
padding:0px;
font: 12px var(--font-family-nav);
+ line-height: 22px;
}
#nav-tree .label a {
@@ -56,7 +52,7 @@
#nav-tree .selected a {
text-decoration:none;
- color:var(--nav-text-active-color);
+ color:var(--page-link-color);
}
#nav-tree .children_ul {
@@ -65,8 +61,9 @@
}
#nav-tree .item {
- margin:0px;
- padding:0px;
+ margin: 0 6px 0 -5px;
+ padding: 0 0 0 5px;
+ height: 22px;
}
#nav-tree {
@@ -89,7 +86,6 @@
display:block;
position: absolute;
left: 0px;
- width: $width;
overflow : hidden;
}
@@ -98,15 +94,31 @@
}
.ui-resizable-e {
- background-image:var(--nav-splitbar-image);
- background-size:100%;
- background-repeat:repeat-y;
- background-attachment: scroll;
- cursor:ew-resize;
+ transition: opacity 0.5s ease;
+ background-color: var(--nav-splitbar-bg-color);
+ opacity:0;
+ cursor:col-resize;
height:100%;
right:0;
top:0;
width:6px;
+ position: relative;
+}
+
+.ui-resizable-e:after {
+ content: '';
+ display: block;
+ top: 50%;
+ left: 1px;
+ width: 2px;
+ height: 15px;
+ border-left: 1px solid var(--nav-splitbar-handle-color);
+ border-right: 1px solid var(--nav-splitbar-handle-color);
+ position: absolute;
+}
+
+.ui-resizable-e:hover {
+ opacity: 1;
}
.ui-resizable-handle {
@@ -121,24 +133,97 @@
}
#nav-tree {
- background-repeat:repeat-x;
background-color: var(--nav-background-color);
-webkit-overflow-scrolling : touch; /* iOS 5+ */
+ scrollbar-width: thin;
+ border-right: 1px solid var(--nav-border-color);
+ padding-left: 5px;
}
#nav-sync {
position:absolute;
- top:5px;
- right:24px;
- z-index:0;
+ top:0px;
+ right:0px;
+ z-index:1;
}
#nav-sync img {
opacity:0.3;
}
-#nav-sync img:hover {
- opacity:0.9;
+div.nav-sync-icon {
+ position: relative;
+ width: 24px;
+ height: 17px;
+ left: -6px;
+ top: -1px;
+ opacity: 0.7;
+ display: inline-block;
+ background-color: var(--sync-icon-background-color);
+ border: 1px solid var(--sync-icon-border-color);
+ box-sizing: content-box;
+}
+
+div.nav-sync-icon:hover {
+ background-color: var(--sync-icon-selected-background-color);
+ opacity: 1.0;
+}
+
+div.nav-sync-icon.active:after {
+ content: '';
+ background-color: var(--sync-icon-background-color);
+ border-top: 2px solid var(--sync-icon-color);
+ position: absolute;
+ width: 16px;
+ height: 0px;
+ top: 7px;
+ left: 4px;
+}
+
+div.nav-sync-icon.active:hover:after {
+ border-top: 2px solid var(--sync-icon-selected-color);
+}
+
+span.sync-icon-left {
+ position: absolute;
+ padding: 0;
+ margin: 0;
+ top: 3px;
+ left: 4px;
+ display: inline-block;
+ width: 8px;
+ height: 8px;
+ border-left: 2px solid var(--sync-icon-color);
+ border-top: 2px solid var(--sync-icon-color);
+ transform: rotate(-45deg);
+}
+
+span.sync-icon-right {
+ position: absolute;
+ padding: 0;
+ margin: 0;
+ top: 3px;
+ left: 10px;
+ display: inline-block;
+ width: 8px;
+ height: 8px;
+ border-right: 2px solid var(--sync-icon-color);
+ border-bottom: 2px solid var(--sync-icon-color);
+ transform: rotate(-45deg);
+}
+
+div.nav-sync-icon:hover span.sync-icon-left {
+ border-left: 2px solid var(--sync-icon-selected-color);
+ border-top: 2px solid var(--sync-icon-selected-color);
+}
+
+div.nav-sync-icon:hover span.sync-icon-right {
+ border-right: 2px solid var(--sync-icon-selected-color);
+ border-bottom: 2px solid var(--sync-icon-selected-color);
+}
+
+#nav-path ul {
+ border-top: 1px solid var(--nav-breadcrumb-separator-color);
}
@media print
@@ -147,3 +232,96 @@
div.ui-resizable-handle { display: none; position: relative; }
}
+/*---------------------------*/
+#container {
+ display: grid;
+ grid-template-columns: auto auto;
+ overflow: hidden;
+}
+
+#page-nav {
+ background: var(--nav-background-color);
+ display: block;
+ width: 250px;
+ box-sizing: content-box;
+ position: relative;
+ border-left: 1px solid var(--nav-border-color);
+}
+
+#page-nav-tree {
+ display: inline-block;
+}
+
+#page-nav-resize-handle {
+ transition: opacity 0.5s ease;
+ background-color: var(--nav-splitbar-bg-color);
+ opacity:0;
+ cursor:col-resize;
+ height:100%;
+ right:0;
+ top:0;
+ width:6px;
+ position: relative;
+ z-index: 1;
+ user-select: none;
+}
+
+#page-nav-resize-handle:after {
+ content: '';
+ display: block;
+ top: 50%;
+ left: 1px;
+ width: 2px;
+ height: 15px;
+ border-left: 1px solid var(--nav-splitbar-handle-color);
+ border-right: 1px solid var(--nav-splitbar-handle-color);
+ position: absolute;
+}
+
+#page-nav-resize-handle.dragging,
+#page-nav-resize-handle:hover {
+ opacity: 1;
+}
+
+#page-nav-contents {
+ padding: 0;
+ margin: 0;
+ display: block;
+ top: 0;
+ left: 0;
+ height: 100%;
+ width: 100%;
+ position: absolute;
+ overflow: auto;
+ scrollbar-width: thin;
+ -webkit-overflow-scrolling : touch; /* iOS 5+ */
+}
+
+ul.page-outline,
+ul.page-outline ul {
+ text-indent: 0;
+ list-style: none outside none;
+ padding: 0 0 0 4px;
+}
+
+ul.page-outline {
+ margin: 0 4px 4px 6px;
+}
+
+ul.page-outline div.item {
+ font: 12px var(--font-family-nav);
+ line-height: 22px;
+}
+
+ul.page-outline li {
+ white-space: nowrap;
+}
+
+ul.page-outline li.vis {
+ background-color: var(--nav-breadcrumb-active-bg);
+}
+
+#container.resizing {
+ cursor: col-resize;
+ user-select: none;
+}
diff --git a/docs/html/optimal_allocation.html b/docs/html/optimal_allocation.html
index 627471c..88f3e62 100644
--- a/docs/html/optimal_allocation.html
+++ b/docs/html/optimal_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Optimal resource allocation
-
-
@@ -33,33 +31,22 @@
-
+
-
- Optimal resource allocation
+ Optimal resource allocation
This library tries to automatically make optimal choices for the resources you create, so you don't need to care about them. There are some advanced features of Direct3D 12 that you may use to optimize your memory management. There are also some settings in D3D12MA that you may change to alter its default behavior. This page provides miscellaneous advice about features of D3D12 and D3D12MA that are non-essential, but may improve the stability or performance of your app.
-
+
Avoiding running out of memory
When trying to allocate more memory than available in the current heap (e.g., video memory on the graphics card, system memory), one of few bad things can happen:
-- The allocation (resource creation) function call can fail with
HRESULT value other than S_OK.
+- The allocation (resource creation) function call can fail with HRESULT value other than S_OK.
- The allocation may succeed, but take long time (even a significant fraction of a second).
- Some resources are automatically demoted from video memory to system memory, degrading the app performance.
- Even a crash of the entire graphics driver can happen, resulting in the D3D12 "device removal", which is usually catastrophic for the application.
@@ -113,34 +100,34 @@ Statistics of current memory usage and available budget for a specific memory segment group.Definition D3D12MemAlloc.h:474
UINT64 BudgetBytesEstimated amount of memory available to the program.Definition D3D12MemAlloc.h:497
UINT64 UsageBytesEstimated current memory usage of the program.Definition D3D12MemAlloc.h:486
-- Implementation detail
- DXGI interface offers function
IDXGIAdapter3::QueryVideoMemoryInfo that queries the current memory usage and budget. This library automatically makes use of it when available (when you use recent enough version of the DirectX SDK). If not, it falls back to estimating the usage and budget based on the total amount of the allocated memory and 80% of the full memory capacity, respectively.
+- Implementation detail
- DXGI interface offers function IDXGIAdapter3::QueryVideoMemoryInfo that queries the current memory usage and budget. This library automatically makes use of it when available (when you use recent enough version of the DirectX SDK). If not, it falls back to estimating the usage and budget based on the total amount of the allocated memory and 80% of the full memory capacity, respectively.
- Implementation detail
- Allocating large heaps and creating placed resources in them is one of the main features of this library. However, if allocating new such block would exceed the budget, it will automatically prefer creating the resource as committed to have exactly the right size, which can lower the chance of getting into trouble in case of over-commitment.
When creating non-essential resources, you can use D3D12MA::ALLOCATION_FLAG_WITHIN_BUDGET. Then, in case the allocation would exceed the budget, the library will return failure from the function without attempting to allocate the actual D3D12 memory.
-It may also be a good idea to support failed resource creation. For non-essential resources, when function D3D12MA::Allocator::CreateResource fails with a result other than S_OK, it is worth implementing some way of recovery instead of terminating or crashing the entire app.
-
+
It may also be a good idea to support failed resource creation. For non-essential resources, when function D3D12MA::Allocator::CreateResource fails with a result other than S_OK, it is worth implementing some way of recovery instead of terminating or crashing the entire app.
+
Allocation performance
Creating D3D12 resources (buffers and textures) can be a time-consuming operation. The duration can be unpredictable, spanning from a small fraction of a millisecond to a significant fraction of a second. Thus, it is recommended to allocate all the memory and create all the resources needed upfront rather than doing it during application runtime. For example, a video game can try to create its resources on startup or when loading a new level. Of course, is is not always possible. For example, open-world games may require loading and unloading some graphical assets in the background (often called "streaming").
-Creating and releasing D3D12 resources on a separate thread in the background may help. Both ID3D12Device and D3D12MA::Allocator objects are thread-safe, synchronized internally. However, cases were observed where resource creation calls like ID3D12Device::CreateCommittedResource were blocking other D3D12 calls like ExecuteCommandLists or Present somewhere inside the graphics driver, so hitches can happen even when using multithreading.
-The most expensive part is typically the allocation of a new D3D12 memory heap. This library tackles this problem by automatically allocating large heaps (64 MB by default) and creating resources as placed inside of them. When a new requested resource can be placed in a free space of an existing heap and doesn't require allocating a new heap, this operation is typically much faster, as it only requires creating a new ID3D12Resource object and not allocating new memory. This is the main benefit of using D3D12MA compared to the naive approach of using Direct3D 12 directly and creating each resource as committed with CreateCommittedResource, which would result in a separate allocation of an implicit heap every time.
-When a large number of small buffers needs to be created, the overhead of creating even just separate ID3D12Resource objects can be significant. It can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs. This library can also help with it. See section "Sub-allocating buffers" below.
+Creating and releasing D3D12 resources on a separate thread in the background may help. Both ID3D12Device and D3D12MA::Allocator objects are thread-safe, synchronized internally. However, cases were observed where resource creation calls like ID3D12Device::CreateCommittedResource were blocking other D3D12 calls like ExecuteCommandLists or Present somewhere inside the graphics driver, so hitches can happen even when using multithreading.
+The most expensive part is typically the allocation of a new D3D12 memory heap. This library tackles this problem by automatically allocating large heaps (64 MB by default) and creating resources as placed inside of them. When a new requested resource can be placed in a free space of an existing heap and doesn't require allocating a new heap, this operation is typically much faster, as it only requires creating a new ID3D12Resource object and not allocating new memory. This is the main benefit of using D3D12MA compared to the naive approach of using Direct3D 12 directly and creating each resource as committed with CreateCommittedResource, which would result in a separate allocation of an implicit heap every time.
+When a large number of small buffers needs to be created, the overhead of creating even just separate ID3D12Resource objects can be significant. It can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs. This library can also help with it. See section "Sub-allocating buffers" below.
- Implementation detail
- The CPU performance overhead of using this library is low. It uses a high-quality allocation algorithm called Two-Level Segregated Fit (TLSF), which in most cases can find a free place for a new allocation in few steps. The library also doesn't perform too many CPU heap allocations. In may cases, the allocation happens with 0 new CPU heap allocations performed by the library. Even the creation of a D3D12MA::Allocation object itself doesn't typically feature an CPU allocation, because these objects are returned out of a dedicated memory pool.
Another reason for the slowness of D3D12 memory allocation is the guarantee that the newly allocated memory is filled with zeros. When creating and destroying resources placed in an existing heap, this overhead is not present, and the memory is not zeroed - it may contain random data left by the resource previously allocated in that place. In recent versions of the DirectX 12 SDK, clearing the memory of the newly created D3D12 heaps can also be disabled for the improved performance. D3D12MA can use this feature when:
- D3D12MA::ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED is used during the creation of the main allocator object.
-D3D12_HEAP_FLAG_CREATE_NOT_ZEROED is passed to D3D12MA::POOL_DESC::HeapFlags during the creation of a custom pool.- D3D12_HEAP_FLAG_CREATE_NOT_ZEROED is passed to D3D12MA::POOL_DESC::HeapFlags during the creation of a custom pool.
It is recommended to always use these flags. The downside is that when the memory is not filled with zeros, while you don't properly clear it or otherwise initialize its content before use (which is required by D3D12), you may observe incorrect behavior. This problem mostly affects render-target and depth-stencil textures.
When an allocation needs to be made in a performance-critical code, you can use D3D12MA::ALLOCATION_FLAG_STRATEGY_MIN_TIME. In influences multiple heuristics inside the library to prefer faster allocation at the expense of possibly less optimal placement in the memory.
If the resource to be created is non-essential, while the performance is paramount, you can also use D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE. It will create the resource only if it can be placed inside and existing memory heap and return failure from the function if a new heap would need to be allocated, which should guarantee good performance of such function call.
-
+
Sub-allocating buffers
-
When a large number of small buffers needs to be created, the overhead of creating separate ID3D12Resource objects can be significant. It can also cause a significant waste of memory, as placed buffers need to be aligned to D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB by default. These problems can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs.
+When a large number of small buffers needs to be created, the overhead of creating separate ID3D12Resource objects can be significant. It can also cause a significant waste of memory, as placed buffers need to be aligned to D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB by default. These problems can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs.
It requires implementing a custom allocator for the data inside the buffer and using offsets to individual regions. When all the regions can be allocated linearly and freed all at once, implementing such allocator is trivial. When every region has the same size, implementing an allocator is also quite simple when using a "free list" algorithm. However, when regions can have different sizes and can be allocated and freed in random order, it requires a full allocation algorithm. D3D12MA can help with it by exposing its core allocation algorithm for custom usages. For more details and example code, see chapter: Virtual allocator. It can be used for all the cases mentioned above without too much performance overhead, because the D3D12MA::VirtualAllocation object is just a lightweight handle.
-When sub-allocating a buffer, you need to remember to explicitly request proper alignment required for each region. For example, data used as a constant buffer must be aligned to D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT = 256 B.
-
+
When sub-allocating a buffer, you need to remember to explicitly request proper alignment required for each region. For example, data used as a constant buffer must be aligned to D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT = 256 B.
+
Residency priority
When too much video memory is allocated, one of the things that can happen is the system demoting some heaps to the system memory. Moving data between memory pools or reaching out directly to the system memory through PCI Express bus can have large performance overhead, which can slow down the application, or even make the game unplayable any more. Unfortunately, it is not possible to fully control or prevent this demotion. Best thing to do is avoiding memory over-commitment. For more information, see section "Avoiding running out of memory" above.
-Recent versions of DirectX 12 SDK offer function ID3D12Device1::SetResidencyPriority that sets a hint about the priority of a resource - how important it is to stay resident in the video memory. Setting the priority happens at the level of an entire memory heap. D3D12MA offers an interface to set this priority in form of D3D12MA::POOL_DESC::ResidencyPriority parameter. It affects all allocations made out of the custom pool created with it, both placed inside large heaps and created as committed.
+Recent versions of DirectX 12 SDK offer function ID3D12Device1::SetResidencyPriority that sets a hint about the priority of a resource - how important it is to stay resident in the video memory. Setting the priority happens at the level of an entire memory heap. D3D12MA offers an interface to set this priority in form of D3D12MA::POOL_DESC::ResidencyPriority parameter. It affects all allocations made out of the custom pool created with it, both placed inside large heaps and created as committed.
It is recommended to create a custom pool for the purpose of using high residency priority of all resources that are critical for the performance, especially those that are written by the GPU, like render-target, depth-stencil textures, UAV textures and buffers. It is also worth creating them as committed, so that each one will have its own implicit heap. This can minimize the chance that an entire large heap is demoted to system memory, degrading performance of all the resources placed in it.
Example:
D3D12MA::CPOOL_DESC poolDesc = D3D12MA::CPOOL_DESC{
@@ -175,14 +162,14 @@
D3D12_RESIDENCY_PRIORITY priority = D3D12_RESIDENCY_PRIORITY_HIGH;
device1->SetResidencyPriority(1, &res, &priority);
ID3D12Resource * GetResource() constReturns D3D12 resource associated with this object.Definition D3D12MemAlloc.h:552
-
Note this is not the same as explicit eviction controlled using ID3D12Device::Evict and MakeResident functions. Resources evicted explicitly are illegal to access until they are made resident again, while the demotion described here happens automatically and only slows down the execution.
-
+
Note this is not the same as explicit eviction controlled using ID3D12Device::Evict and MakeResident functions. Resources evicted explicitly are illegal to access until they are made resident again, while the demotion described here happens automatically and only slows down the execution.
+
GPU upload heap
Direct3D 12 offers a fixed set of memory heap types:
-D3D12_HEAP_TYPE_DEFAULT: Represents the video memory. It is available and fast to access for the GPU. It should be used for all resources that are written by the GPU (like render-target and depth-stencil textures, UAV) and resources that are frequently read by the GPU (like textures intended for sampling, vertex, index, and constant buffers).D3D12_HEAP_TYPE_UPLOAD: Represents the system memory that is uncached and write-combined. It can be mapped and accessed by the CPU code using a pointer. It supports only buffers, not textures. It is intended for "staging buffers" that are filled by the CPU code and then used as a source of copy operations to the DEFAULT heap. It can also be accessed directly by the GPU - shaders can read from buffers created in this memory.D3D12_HEAP_TYPE_READBACK: Represents the system memory that is cached. It is intended for buffers used as a destination of copy operations from the DEFAULT heap.- D3D12_HEAP_TYPE_DEFAULT: Represents the video memory. It is available and fast to access for the GPU. It should be used for all resources that are written by the GPU (like render-target and depth-stencil textures, UAV) and resources that are frequently read by the GPU (like textures intended for sampling, vertex, index, and constant buffers).
+- D3D12_HEAP_TYPE_UPLOAD: Represents the system memory that is uncached and write-combined. It can be mapped and accessed by the CPU code using a pointer. It supports only buffers, not textures. It is intended for "staging buffers" that are filled by the CPU code and then used as a source of copy operations to the DEFAULT heap. It can also be accessed directly by the GPU - shaders can read from buffers created in this memory.
+- D3D12_HEAP_TYPE_READBACK: Represents the system memory that is cached. It is intended for buffers used as a destination of copy operations from the DEFAULT heap.
Note that in systems with a discrete graphics card, access to system memory is fast from the CPU code (like the C++ code mapping D3D12 buffers and accessing them through a pointer), while access to the video memory is fast from the GPU code (like shaders reading and writing buffers and textures). Any copy operation or direct access between these memory heap types happens through PCI Express bus, which can be relatively slow.
Modern systems offer a feature called Resizable BAR (ReBAR) that gives the CPU direct access to the full video memory. To be available, this feature needs to be supported by the whole hardware-software environment, including:
@@ -192,20 +179,20 @@
- Supporting operating system.
- The feature needs to be enabled in the UEFI settings. It is typically called "Above 4G Decoding" and "Resizable Bar".
-Recent versions of DirectX 12 SDK give access to this feature in form of a new, 4th memory pool: D3D12_HEAP_TYPE_GPU_UPLOAD. Resources created in it behave logically similar to the D3D12_HEAP_TYPE_UPLOAD heap:
+Recent versions of DirectX 12 SDK give access to this feature in form of a new, 4th memory pool: D3D12_HEAP_TYPE_GPU_UPLOAD. Resources created in it behave logically similar to the D3D12_HEAP_TYPE_UPLOAD heap:
- They support mapping and direct access from the CPU code through a pointer.
-- The mapped memory is uncached and write-combined, so it should be only written sequentially (e.g., number-by-number or using
memcpy). It shouldn't be accessed randomly or read, because it is extremely slow for uncached memory.
+- The mapped memory is uncached and write-combined, so it should be only written sequentially (e.g., number-by-number or using memcpy). It shouldn't be accessed randomly or read, because it is extremely slow for uncached memory.
- Only buffers are supported.
- Those buffers can be used as a source of copy operations or directly accessed by the GPU.
-The main difference is that resources created in the new D3D12_HEAP_TYPE_GPU_UPLOAD are placed in the video memory, while resources created in the old D3D12_HEAP_TYPE_UPLOAD are placed in the system memory. This implies which budgets are consumed by new resources allocated in those heaps. This also implies which operations involve transferring data through the PCI Express bus.
+The main difference is that resources created in the new D3D12_HEAP_TYPE_GPU_UPLOAD are placed in the video memory, while resources created in the old D3D12_HEAP_TYPE_UPLOAD are placed in the system memory. This implies which budgets are consumed by new resources allocated in those heaps. This also implies which operations involve transferring data through the PCI Express bus.
-- As
D3D12_HEAP_TYPE_UPLOAD uses the system memory, writes from the CPU code through a mapped pointer are faster, while copies or direct access from the GPU are slower because they need to go through PCIe.
-- As the new
D3D12_HEAP_TYPE_GPU_UPLOAD uses the video memory, copies or direct access from the GPU are faster, while writes from the CPU code through a mapped pointer can be slower, because they need to go through PCIe. For maximum performance of copy operations from this heap, a graphics or compute queue should be used, not a copy queue.
+- As D3D12_HEAP_TYPE_UPLOAD uses the system memory, writes from the CPU code through a mapped pointer are faster, while copies or direct access from the GPU are slower because they need to go through PCIe.
+- As the new D3D12_HEAP_TYPE_GPU_UPLOAD uses the video memory, copies or direct access from the GPU are faster, while writes from the CPU code through a mapped pointer can be slower, because they need to go through PCIe. For maximum performance of copy operations from this heap, a graphics or compute queue should be used, not a copy queue.
GPU Upload Heap can be used for performance optimization of some resources that need to be written by the CPU and read by the GPU. It can be beneficial especially for resources that need to change frequently (often called "dynamic").
-D3D12MA supports GPU upload heap when recent enough version of DirectX 12 SDK is used and when the current system supports it. The support can be queried using function D3D12MA::Allocator::IsGPUUploadHeapSupported(). When it returns TRUE, you can create resources using D3D12_HEAP_TYPE_GPU_UPLOAD. You can also just try creating such resource. Example:
+D3D12MA supports GPU upload heap when recent enough version of DirectX 12 SDK is used and when the current system supports it. The support can be queried using function D3D12MA::Allocator::IsGPUUploadHeapSupported(). When it returns TRUE, you can create resources using D3D12_HEAP_TYPE_GPU_UPLOAD. You can also just try creating such resource. Example:
D3D12MA::CALLOCATION_DESC allocDesc = D3D12MA::CALLOCATION_DESC{
D3D12_HEAP_TYPE_GPU_UPLOAD }; // !!!
@@ -240,13 +227,13 @@
else
// Some other error code e.g., out of memory...
D3D12_HEAP_TYPE HeapTypeThe type of memory heap where the new allocation should be placed.Definition D3D12MemAlloc.h:347
-
+
Committed versus placed resources
When using D3D12 API directly, there are 3 ways of creating resources:
-- Committed, using function
ID3D12Device::CreateCommittedResource. It creates the resource with its own memory heap, which is called an "implicit heap" and cannot be accessed directly.
-- Placed, using function
ID3D12Device::CreatePlacedResource. A ID3D12Heap needs to be created beforehand using ID3D12Device::CreateHeap. Then, the resource can be created as placed inside the heap at a specific offset.
-- Reserved, using function
ID3D12Device::CreateReservedResource. This library doesn't support them directly.
+- Committed, using function ID3D12Device::CreateCommittedResource. It creates the resource with its own memory heap, which is called an "implicit heap" and cannot be accessed directly.
+- Placed, using function ID3D12Device::CreatePlacedResource. A ID3D12Heap needs to be created beforehand using ID3D12Device::CreateHeap. Then, the resource can be created as placed inside the heap at a specific offset.
+- Reserved, using function ID3D12Device::CreateReservedResource. This library doesn't support them directly.
A naive solution would be to create all the resources as committed. It works, because in D3D12 there is no strict limit on the number of resources or heaps that can be created. However, there are certain advantages and disadvantages of using committed versus placed resources:
- The advantage of committed resources is that they are always created with a new heap, which is initialized with zeros. When a resource is created as placed, the memory may contain random data left by the resource previously allocated in that place. When the memory is not filled with zeros, while you don't properly clear it or otherwise initialize its content before use (which is required by D3D12), you may observe incorrect behavior. On the other hand, using committed resources and having every new resource filled with zeros can leave this kind of bugs undetected.
-- Manual eviction with
ID3D12Device::Evict and MakeResident functions work at the level of the entire heap, and so does ID3D12Device1::SetResidencyPriority, so creating resources as committed allows more fine-grained control over the eviction and residency priority of individual resources.
+- Manual eviction with ID3D12Device::Evict and MakeResident functions work at the level of the entire heap, and so does ID3D12Device1::SetResidencyPriority, so creating resources as committed allows more fine-grained control over the eviction and residency priority of individual resources.
- The advantage of placed resources is that they can be created in a region of a heap overlapping with some other resources. This approach is commonly called "aliasing". It can save memory, but it needs careful control over the resources that overlap in memory to make sure they are not used at the same time, there is an aliasing barrier issued between their usage, and the resource used after aliasing is correctly cleared every time. Committed resources don't offer this possibility, because every committed resource has its own exclusive memory heap. For more information, see chapter Resource aliasing (overlap).
When creating resources with the help of D3D12MA using function D3D12MA::Allocator::CreateResource, you typically don't need to care about all this. The library automatically makes the choice of creating the new resource as committed or placed. However, in cases when you need the information or the control over this choice between committed and placed, the library offers facilities to do that, described below.
@@ -303,18 +290,18 @@
UINT64 BlockSizeSize of a single heap (memory block) to be allocated as part of this pool, in bytes....Definition D3D12MemAlloc.h:933
You can request a new resource to be created as placed by using D3D12MA::ALLOCATION_FLAG_CAN_ALIAS. This is required especially if you plan to create another resource in the same region of memory, aliasing with your resource - hence the name of this flag.
Note D3D12MA::ALLOCATION_FLAG_CAN_ALIAS can be even combined with D3D12MA::ALLOCATION_FLAG_COMMITTED. In this case, the resource is not created as committed, but it is also not placed as part of a larger heap. What happens instead is that a new heap is created with the exact size required for the resource, and the resource is created in it, placed at offset 0.
-
+
Resource alignment
Certain types of resources require certain alignment in memory. An alignment is a requirement for the address or offset to the beginning of the resource to be a multiply of some value, which is always a power of 2. For committed resources, the problem is non-existent, because committed resources have their own implicit heaps where they are created at offset 0, which meets any alignment requirement. For placed resources, D3D12MA takes care of the alignment automatically.
-- Implementation detail
- Default alignment required MSAA textures is
D3D12_DEFAULT_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 4 MB. Default alignment required for buffers and other textures is D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB.
+- Implementation detail
- Default alignment required MSAA textures is D3D12_DEFAULT_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 4 MB. Default alignment required for buffers and other textures is D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB.
Because the alignment required for buffers is 64 KB, small buffers can waste a lot of memory in between when created as placed. When such small buffers are created as committed, some graphics drivers are able to pack them better. D3D12MA automatically takes advantage of this by preferring to create small buffers as committed. This heuristics is enabled by default. It is also a tradeoff - it can make the allocation of these buffers slower. It can be disabled for an individual resource by using D3D12MA::ALLOCATION_FLAG_STRATEGY_MIN_TIME and for the entire allocator by using D3D12MA::ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED.
-For certain textures that meet a complex set of requirements, special "small alignment" can be applied. Details can be found in Microsoft documentation of the D3D12_RESOURCE_DESC structure. For MSAA textures, the small alignment is D3D12_SMALL_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB. For other textures, the small alignment is D3D12_SMALL_RESOURCE_PLACEMENT_ALIGNMENT = 4 KB. D3D12MA uses this feature automatically. Detailed behavior can be disabled or controlled by predefining macro D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT.
-D3D12 also has a concept of alignment of the entire heap, passed through D3D12_HEAP_DESC::Alignment. This library automatically sets the alignment as small as possible. Unfortunately, any heap that has a chance of hosting an MSAA texture needs to have the alignment set to 4 MB. This problem can be overcome by passing D3D12MA::ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of the main allocator object and D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of any custom heap that supports textures, not only buffers. With those flags, the alignment of the heaps created by D3D12MA can be lower, but any MSAA textures are created as committed. You should always use these flags in your code unless you really need to create some MSAA textures as placed.
+For certain textures that meet a complex set of requirements, special "small alignment" can be applied. Details can be found in Microsoft documentation of the D3D12_RESOURCE_DESC structure. For MSAA textures, the small alignment is D3D12_SMALL_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB. For other textures, the small alignment is D3D12_SMALL_RESOURCE_PLACEMENT_ALIGNMENT = 4 KB. D3D12MA uses this feature automatically. Detailed behavior can be disabled or controlled by predefining macro D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT.
+D3D12 also has a concept of alignment of the entire heap, passed through D3D12_HEAP_DESC::Alignment. This library automatically sets the alignment as small as possible. Unfortunately, any heap that has a chance of hosting an MSAA texture needs to have the alignment set to 4 MB. This problem can be overcome by passing D3D12MA::ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of the main allocator object and D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of any custom heap that supports textures, not only buffers. With those flags, the alignment of the heaps created by D3D12MA can be lower, but any MSAA textures are created as committed. You should always use these flags in your code unless you really need to create some MSAA textures as placed.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/quick_start.html b/docs/html/quick_start.html
index f9219d2..4eba7e6 100644
--- a/docs/html/quick_start.html
+++ b/docs/html/quick_start.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Quick start
-
-
@@ -33,33 +31,22 @@
-
+
-
- Quick start
+ Quick start
-
+
Project setup and initialization
This is a small, standalone C++ library. It consists of 2 files: "D3D12MemAlloc.h" header file with public interface and "D3D12MemAlloc.cpp" with internal implementation. The only external dependencies are WinAPI, Direct3D 12, and parts of C/C++ standard library (but STL containers, exceptions, or RTTI are not used).
The library is developed and tested using Microsoft Visual Studio 2022, but it should work with other compilers as well. It is designed for 64-bit code.
To use the library in your project:
-(1.) Copy files D3D12MemAlloc.cpp, D3D12MemAlloc.h to your project.
-(2.) Make D3D12MemAlloc.cpp compiling as part of the project, as C++ code.
+(1.) Copy files D3D12MemAlloc.cpp, D3D12MemAlloc.h to your project.
+(2.) Make D3D12MemAlloc.cpp compiling as part of the project, as C++ code.
(3.) Include library header in each CPP file that needs to use the library.
#include "D3D12MemAlloc.h"
-(4.) Right after you created ID3D12Device, fill D3D12MA::ALLOCATOR_DESC structure and call function D3D12MA::CreateAllocator to create the main D3D12MA::Allocator object.
+
(4.) Right after you created ID3D12Device, fill D3D12MA::ALLOCATOR_DESC structure and call function D3D12MA::CreateAllocator to create the main D3D12MA::Allocator object.
Please note that all symbols of the library are declared inside D3D12MA namespace.
IDXGIAdapter* adapter = ...
ID3D12Device* device = ...
@@ -119,12 +106,12 @@
D3D12MA_API HRESULT CreateAllocator(const ALLOCATOR_DESC *pDesc, Allocator **ppAllocator)Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
(5.) Right before destroying the D3D12 device, destroy the allocator object.
allocator->Release();
-Objects of this library must be destroyed by calling Release method. They are somewhat compatible with COM: they implement IUnknown interface with its virtual methods: AddRef, Release, QueryInterface, and they are reference-counted internally. You can use smart pointers designed for COM with objects of this library - e.g. CComPtr or Microsoft::WRL::ComPtr. The reference counter is thread-safe. QueryInterface method supports only IUnknown, as classes of this library don't define their own GUIDs.
-
+
Objects of this library must be destroyed by calling Release method. They are somewhat compatible with COM: they implement IUnknown interface with its virtual methods: AddRef, Release, QueryInterface, and they are reference-counted internally. You can use smart pointers designed for COM with objects of this library - e.g. CComPtr or Microsoft::WRL::ComPtr. The reference counter is thread-safe. QueryInterface method supports only IUnknown, as classes of this library don't define their own GUIDs.
+
Creating resources
-To use the library for creating resources (textures and buffers), call method D3D12MA::Allocator::CreateResource in the place where you would previously call ID3D12Device::CreateCommittedResource.
-The function has similar syntax, but it expects structure D3D12MA::ALLOCATION_DESC to be passed along with D3D12_RESOURCE_DESC and other parameters for created resource. This structure describes parameters of the desired memory allocation, including choice of D3D12_HEAP_TYPE.
-The function returns a new object of type D3D12MA::Allocation. It represents allocated memory and can be queried for size, offset, ID3D12Heap. It also holds a reference to the ID3D12Resource, which can be accessed by calling D3D12MA::Allocation::GetResource().
+To use the library for creating resources (textures and buffers), call method D3D12MA::Allocator::CreateResource in the place where you would previously call ID3D12Device::CreateCommittedResource.
+The function has similar syntax, but it expects structure D3D12MA::ALLOCATION_DESC to be passed along with D3D12_RESOURCE_DESC and other parameters for created resource. This structure describes parameters of the desired memory allocation, including choice of D3D12_HEAP_TYPE.
+The function returns a new object of type D3D12MA::Allocation. It represents allocated memory and can be queried for size, offset, ID3D12Heap. It also holds a reference to the ID3D12Resource, which can be accessed by calling D3D12MA::Allocation::GetResource().
D3D12_RESOURCE_DESC resourceDesc = {};
resourceDesc.Dimension = D3D12_RESOURCE_DIMENSION_TEXTURE2D;
resourceDesc.Alignment = 0;
@@ -160,13 +147,13 @@
D3D12_HEAP_TYPE HeapTypeThe type of memory heap where the new allocation should be placed.Definition D3D12MemAlloc.h:347
You need to release the allocation object when no longer needed. This will also release the D3D12 resource.
allocation->Release();
-The advantage of using the allocator instead of creating committed resource, and the main purpose of this library, is that it can decide to allocate bigger memory heap internally using ID3D12Device::CreateHeap and place multiple resources in it, at different offsets, using ID3D12Device::CreatePlacedResource. The library manages its own collection of allocated memory blocks (heaps) and remembers which parts of them are occupied and which parts are free to be used for new resources.
-It is important to remember that resources created as placed don't have their memory initialized to zeros, but may contain garbage data, so they need to be fully initialized before usage, e.g. using Clear (ClearRenderTargetView), Discard (DiscardResource), or Copy (CopyResource).
-The library also automatically handles resource heap tier. When D3D12_FEATURE_DATA_D3D12_OPTIONS::ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1, resources of 3 types: buffers, textures that are render targets or depth-stencil, and other textures must be kept in separate heaps. When D3D12_RESOURCE_HEAP_TIER_2, they can be kept together. By using this library, you don't need to handle this manually.
-
+
The advantage of using the allocator instead of creating committed resource, and the main purpose of this library, is that it can decide to allocate bigger memory heap internally using ID3D12Device::CreateHeap and place multiple resources in it, at different offsets, using ID3D12Device::CreatePlacedResource. The library manages its own collection of allocated memory blocks (heaps) and remembers which parts of them are occupied and which parts are free to be used for new resources.
+It is important to remember that resources created as placed don't have their memory initialized to zeros, but may contain garbage data, so they need to be fully initialized before usage, e.g. using Clear (ClearRenderTargetView), Discard (DiscardResource), or Copy (CopyResource).
+The library also automatically handles resource heap tier. When D3D12_FEATURE_DATA_D3D12_OPTIONS::ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1, resources of 3 types: buffers, textures that are render targets or depth-stencil, and other textures must be kept in separate heaps. When D3D12_RESOURCE_HEAP_TIER_2, they can be kept together. By using this library, you don't need to handle this manually.
+
Resource reference counting
-ID3D12Resource and other interfaces of Direct3D 12 use COM, so they are reference-counted. Objects of this library are reference-counted as well. An object of type D3D12MA::Allocation remembers the resource (buffer or texture) that was created together with this memory allocation and holds a reference to the ID3D12Resource object. (Note this is a difference to Vulkan Memory Allocator, where a VmaAllocation object has no connection with the buffer or image that was created with it.) Thus, it is important to manage the resource reference counter properly.
-The simplest use case is shown in the code snippet above. When only D3D12MA::Allocation object is obtained from a function call like D3D12MA::Allocator::CreateResource, it remembers the ID3D12Resource that was created with it and holds a reference to it. The resource can be obtained by calling allocation->GetResource(), which doesn't increment the resource reference counter. Calling allocation->Release() will decrease the resource reference counter, which is 1 in this case, so the resource will be released.
+ID3D12Resource and other interfaces of Direct3D 12 use COM, so they are reference-counted. Objects of this library are reference-counted as well. An object of type D3D12MA::Allocation remembers the resource (buffer or texture) that was created together with this memory allocation and holds a reference to the ID3D12Resource object. (Note this is a difference to Vulkan Memory Allocator, where a VmaAllocation object has no connection with the buffer or image that was created with it.) Thus, it is important to manage the resource reference counter properly.
+The simplest use case is shown in the code snippet above. When only D3D12MA::Allocation object is obtained from a function call like D3D12MA::Allocator::CreateResource, it remembers the ID3D12Resource that was created with it and holds a reference to it. The resource can be obtained by calling allocation->GetResource(), which doesn't increment the resource reference counter. Calling allocation->Release() will decrease the resource reference counter, which is 1 in this case, so the resource will be released.
Second option is to retrieve a pointer to the resource along with D3D12MA::Allocation. Last parameters of the resource creation function can be used for this purpose.
D3D12MA::Allocation* allocation;
ID3D12Resource* resource;
@@ -179,15 +166,15 @@
IID_PPV_ARGS(&resource));
// Use resource...
-
In this case, returned pointer resource is equal to allocation->GetResource(), but the creation function additionally increases resource reference counter for the purpose of returning it from this call (it actually calls QueryInterface internally), so the resource will have the counter = 2. The resource then need to be released along with the allocation, in this particular order, to make sure the resource is destroyed before its memory heap can potentially be freed.
+In this case, returned pointer resource is equal to allocation->GetResource(), but the creation function additionally increases resource reference counter for the purpose of returning it from this call (it actually calls QueryInterface internally), so the resource will have the counter = 2. The resource then need to be released along with the allocation, in this particular order, to make sure the resource is destroyed before its memory heap can potentially be freed.
resource->Release();
allocation->Release();
-More advanced use cases are possible when we consider that an D3D12MA::Allocation object can just hold a reference to any resource. It can be changed by calling D3D12MA::Allocation::SetResource. This function releases the old resource and calls AddRef on the new one.
-Special care must be taken when performing defragmentation. The new resource created at the destination place should be set as pass.pMoves[i].pDstTmpAllocation->SetResource(newRes), but it is moved to the source allocation at end of the defragmentation pass, while the old resource accessible through pass.pMoves[i].pSrcAllocation->GetResource() is then released. For more information, see documentation chapter Defragmentation.
-
+
More advanced use cases are possible when we consider that an D3D12MA::Allocation object can just hold a reference to any resource. It can be changed by calling D3D12MA::Allocation::SetResource. This function releases the old resource and calls AddRef on the new one.
+Special care must be taken when performing defragmentation. The new resource created at the destination place should be set as pass.pMoves[i].pDstTmpAllocation->SetResource(newRes), but it is moved to the source allocation at end of the defragmentation pass, while the old resource accessible through pass.pMoves[i].pSrcAllocation->GetResource() is then released. For more information, see documentation chapter Defragmentation.
+
Mapping memory
-The process of getting regular CPU-side pointer to the memory of a resource in Direct3D is called "mapping". There are rules and restrictions to this process, as described in D3D12 documentation of ID3D12Resource::Map method.
-Mapping happens on the level of particular resources, not entire memory heaps, and so it is out of scope of this library. Just as the documentation of the Map function says:
+The process of getting regular CPU-side pointer to the memory of a resource in Direct3D is called "mapping". There are rules and restrictions to this process, as described in D3D12 documentation of ID3D12Resource::Map method.
+Mapping happens on the level of particular resources, not entire memory heaps, and so it is out of scope of this library. Just as the documentation of the Map function says:
- Returned pointer refers to data of particular subresource, not entire memory heap.
- You can map same resource multiple times. It is ref-counted internally.
@@ -196,7 +183,7 @@
- Unmapping may not be required before using written data - some heap types on some platforms support resources persistently mapped.
When using this library, you can map and use your resources normally without considering whether they are created as committed resources or placed resources in one large heap.
-Example for buffer created and filled in UPLOAD heap type:
+Example for buffer created and filled in UPLOAD heap type:
const UINT64 bufSize = 65536;
const float* bufData = ...;
@@ -233,17 +220,17 @@
memcpy(mappedPtr, bufData, bufSize);
resource->Unmap(0, NULL);
-
+
Helper structures
-
DirectX 12 Agility SDK offers a library of helpers in files "build\native\include\d3dx12\*.h". They include structures that help with complete and concise initialization of the core D3D12 *_DESC structures by using some basic C++ features (constructors, static methods, default parameters). They inherit from these structures, so they support implicit casting to them. For example, structure CD3DX12_RESOURCE_DESC can be used to conveniently fill in structure D3D12_RESOURCE_DESC.
-Similarly, this library provides a set of helper structures that aid in initialization of some of the *_DESC structures defined in the library. These are:
+DirectX 12 Agility SDK offers a library of helpers in files "build\native\include\d3dx12\*.h". They include structures that help with complete and concise initialization of the core D3D12 *_DESC structures by using some basic C++ features (constructors, static methods, default parameters). They inherit from these structures, so they support implicit casting to them. For example, structure CD3DX12_RESOURCE_DESC can be used to conveniently fill in structure D3D12_RESOURCE_DESC.
+Similarly, this library provides a set of helper structures that aid in initialization of some of the *_DESC structures defined in the library. These are:
- D3D12MA::CALLOCATION_DESC, which inherits from D3D12MA::ALLOCATION_DESC.
- D3D12MA::CPOOL_DESC, which inherits from D3D12MA::POOL_DESC.
- D3D12MA::CVIRTUAL_BLOCK_DESC, which inherits from D3D12MA::VIRTUAL_BLOCK_DESC.
- D3D12MA::CVIRTUAL_ALLOCATION_DESC, which inherits from D3D12MA::VIRTUAL_ALLOCATION_DESC.
-For example, when you want to create a buffer in the UPLAOD heap using minimal allocation time, you can use base structures:
+For example, when you want to create a buffer in the UPLAOD heap using minimal allocation time, you can use base structures:
D3D12MA::ALLOCATION_DESC allocDesc;
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_STRATEGY_MIN_TIME;
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
@@ -291,7 +278,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/resource_aliasing.html b/docs/html/resource_aliasing.html
index c89a007..1275544 100644
--- a/docs/html/resource_aliasing.html
+++ b/docs/html/resource_aliasing.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Resource aliasing (overlap)
-
-
@@ -33,33 +31,22 @@
-
+
-
- Resource aliasing (overlap)
+ Resource aliasing (overlap)
New explicit graphics APIs (Vulkan and Direct3D 12), thanks to manual memory management, give an opportunity to alias (overlap) multiple resources in the same region of memory - a feature not available in the old APIs (Direct3D 11, OpenGL). It can be useful to save video memory, but it must be used with caution.
@@ -171,18 +158,18 @@
Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.Definition D3D12MemAlloc.h:338
D3D12_HEAP_FLAGS ExtraHeapFlagsAdditional heap flags to be used when allocating memory.Definition D3D12MemAlloc.h:363
D3D12_HEAP_TYPE HeapTypeThe type of memory heap where the new allocation should be placed.Definition D3D12MemAlloc.h:347
-Remember that using resouces that alias in memory requires proper synchronization. You need to issue a special barrier of type D3D12_RESOURCE_BARRIER_TYPE_ALIASING. You also need to treat a resource after aliasing as uninitialized - containing garbage data. For example, if you use res1 and then want to use res2, you need to first initialize res2 using either Clear, Discard, or Copy to the entire resource.
+Remember that using resouces that alias in memory requires proper synchronization. You need to issue a special barrier of type D3D12_RESOURCE_BARRIER_TYPE_ALIASING. You also need to treat a resource after aliasing as uninitialized - containing garbage data. For example, if you use res1 and then want to use res2, you need to first initialize res2 using either Clear, Discard, or Copy to the entire resource.
Additional considerations:
- D3D12 also allows to interpret contents of memory between aliasing resources consistently in some cases, which is called "data inheritance". For details, see Microsoft documentation chapter "Memory Aliasing and Data Inheritance".
-- You can create more complex layout where different textures and buffers are bound at different offsets inside one large allocation. For example, one can imagine a big texture used in some render passes, aliasing with a set of many small buffers used in some further passes. To bind a resource at non-zero offset of an allocation, call D3D12MA::Allocator::CreateAliasingResource with appropriate value of
AllocationLocalOffset parameter.
-- Resources of the three categories: buffers, textures with
RENDER_TARGET or DEPTH_STENCIL flags, and all other textures, can be placed in the same memory only when allocator->GetD3D12Options().ResourceHeapTier >= D3D12_RESOURCE_HEAP_TIER_2. Otherwise they must be placed in different memory heap types, and thus aliasing them is not possible.
+- You can create more complex layout where different textures and buffers are bound at different offsets inside one large allocation. For example, one can imagine a big texture used in some render passes, aliasing with a set of many small buffers used in some further passes. To bind a resource at non-zero offset of an allocation, call D3D12MA::Allocator::CreateAliasingResource with appropriate value of AllocationLocalOffset parameter.
+- Resources of the three categories: buffers, textures with RENDER_TARGET or DEPTH_STENCIL flags, and all other textures, can be placed in the same memory only when allocator->GetD3D12Options().ResourceHeapTier >= D3D12_RESOURCE_HEAP_TIER_2. Otherwise they must be placed in different memory heap types, and thus aliasing them is not possible.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/search/pages_0.js b/docs/html/search/pages_0.js
index 6c4bc1e..4e13aaf 100644
--- a/docs/html/search/pages_0.js
+++ b/docs/html/search/pages_0.js
@@ -1,10 +1,23 @@
var searchData=
[
- ['algorithm_0',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
- ['aliasing_20overlap_1',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
- ['allocation_2',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
- ['allocation_20algorithm_3',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
- ['allocator_4',['D3D12 Memory Allocator',['../index.html',1,'']]],
- ['allocator_5',['Virtual allocator',['../virtual_allocator.html',1,'optimal_allocation']]],
- ['asked_20questions_6',['Frequently asked questions',['../faq.html',1,'index']]]
+ ['additional_20considerations_0',['Additional considerations',['../linear_algorithm.html#linear_algorithm_additional_considerations',1,'Additional considerations'],['../virtual_allocator.html#virtual_allocator_additional_considerations',1,'Additional considerations']]],
+ ['algorithm_1',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
+ ['aliasing_20overlap_2',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
+ ['alignment_3',['Resource alignment',['../optimal_allocation.html#optimal_allocation_resource_alignment',1,'']]],
+ ['alignment_20and_20units_4',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]],
+ ['allocating_20buffers_5',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]],
+ ['allocation_6',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
+ ['allocation_20algorithm_7',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
+ ['allocation_20parameters_8',['Allocation parameters',['../virtual_allocator.html#virtual_allocator_allocation_parameters',1,'']]],
+ ['allocation_20performance_9',['Allocation performance',['../optimal_allocation.html#optimal_allocation_allocation_Performance',1,'']]],
+ ['allocations_10',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]],
+ ['allocator_11',['D3D12 Memory Allocator',['../index.html',1,'']]],
+ ['allocator_12',['allocator',['../configuration.html#custom_memory_allocator',1,'Custom CPU memory allocator'],['../virtual_allocator.html',1,'Virtual allocator']]],
+ ['and_20benefits_13',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]],
+ ['and_20compatibility_14',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]],
+ ['and_20initialization_15',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]],
+ ['and_20units_16',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]],
+ ['asked_20questions_17',['Frequently asked questions',['../faq.html',1,'index']]],
+ ['at_20once_18',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]],
+ ['avoiding_20running_20out_20of_20memory_19',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]]
];
diff --git a/docs/html/search/pages_1.js b/docs/html/search/pages_1.js
index 91cb574..d34b057 100644
--- a/docs/html/search/pages_1.js
+++ b/docs/html/search/pages_1.js
@@ -1,6 +1,7 @@
var searchData=
[
- ['configuration_0',['Configuration',['../configuration.html',1,'index']]],
- ['considerations_1',['General considerations',['../general_considerations.html',1,'index']]],
- ['custom_20memory_20pools_2',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
+ ['benefits_0',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]],
+ ['block_1',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]],
+ ['buffer_2',['Ring buffer',['../linear_algorithm.html#linear_algorithm_ring_buffer',1,'']]],
+ ['buffers_3',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]]
];
diff --git a/docs/html/search/pages_10.js b/docs/html/search/pages_10.js
new file mode 100644
index 0000000..af3b029
--- /dev/null
+++ b/docs/html/search/pages_10.js
@@ -0,0 +1,13 @@
+var searchData=
+[
+ ['safety_0',['Thread safety',['../general_considerations.html#general_considerations_thread_safety',1,'']]],
+ ['setup_20and_20initialization_1',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]],
+ ['stack_2',['Stack',['../linear_algorithm.html#linear_algorithm_stack',1,'']]],
+ ['stack_3',['Double stack',['../linear_algorithm.html#linear_algorithm_double_stack',1,'']]],
+ ['start_4',['Quick start',['../quick_start.html',1,'index']]],
+ ['statistics_5',['Statistics',['../statistics.html',1,'Statistics'],['../virtual_allocator.html#virtual_allocator_statistics',1,'Statistics']]],
+ ['statistics_6',['Numeric statistics',['../statistics.html#statistics_numeric_statistics',1,'']]],
+ ['structures_7',['Helper structures',['../quick_start.html#quick_start_helper_structures',1,'']]],
+ ['sub_20allocating_20buffers_8',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]],
+ ['supported_9',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]]
+];
diff --git a/docs/html/search/pages_11.js b/docs/html/search/pages_11.js
new file mode 100644
index 0000000..ce665b6
--- /dev/null
+++ b/docs/html/search/pages_11.js
@@ -0,0 +1,5 @@
+var searchData=
+[
+ ['table_20of_20contents_0',['Table of contents',['../index.html#main_table_of_contents',1,'']]],
+ ['thread_20safety_1',['Thread safety',['../general_considerations.html#general_considerations_thread_safety',1,'']]]
+];
diff --git a/docs/html/search/pages_12.js b/docs/html/search/pages_12.js
new file mode 100644
index 0000000..32f0ad5
--- /dev/null
+++ b/docs/html/search/pages_12.js
@@ -0,0 +1,6 @@
+var searchData=
+[
+ ['units_0',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]],
+ ['upload_20heap_1',['GPU upload heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'']]],
+ ['usage_2',['Usage',['../custom_pools.html#custom_pools_usage',1,'']]]
+];
diff --git a/docs/html/search/pages_13.js b/docs/html/search/pages_13.js
new file mode 100644
index 0000000..aa04e5d
--- /dev/null
+++ b/docs/html/search/pages_13.js
@@ -0,0 +1,8 @@
+var searchData=
+[
+ ['versioning_20and_20compatibility_0',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]],
+ ['versus_20placed_20resources_1',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]],
+ ['virtual_20allocations_2',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]],
+ ['virtual_20allocator_3',['Virtual allocator',['../virtual_allocator.html',1,'optimal_allocation']]],
+ ['virtual_20block_4',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]]
+];
diff --git a/docs/html/search/pages_14.js b/docs/html/search/pages_14.js
new file mode 100644
index 0000000..8225a92
--- /dev/null
+++ b/docs/html/search/pages_14.js
@@ -0,0 +1,4 @@
+var searchData=
+[
+ ['web_20links_0',['Web links',['../index.html#main_see_also',1,'']]]
+];
diff --git a/docs/html/search/pages_2.js b/docs/html/search/pages_2.js
index 8aa1a38..7553f75 100644
--- a/docs/html/search/pages_2.js
+++ b/docs/html/search/pages_2.js
@@ -1,5 +1,14 @@
var searchData=
[
- ['d3d12_20memory_20allocator_0',['D3D12 Memory Allocator',['../index.html',1,'']]],
- ['defragmentation_1',['Defragmentation',['../defragmentation.html',1,'optimal_allocation']]]
+ ['committed_20versus_20placed_20resources_0',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]],
+ ['compatibility_1',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]],
+ ['configuration_2',['Configuration',['../configuration.html',1,'index']]],
+ ['considerations_3',['considerations',['../linear_algorithm.html#linear_algorithm_additional_considerations',1,'Additional considerations'],['../virtual_allocator.html#virtual_allocator_additional_considerations',1,'Additional considerations'],['../general_considerations.html',1,'General considerations']]],
+ ['contents_4',['Table of contents',['../index.html#main_table_of_contents',1,'']]],
+ ['counting_5',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]],
+ ['cpu_20memory_20allocator_6',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]],
+ ['creating_20resources_7',['Creating resources',['../quick_start.html#quick_start_creating_resources',1,'']]],
+ ['creating_20virtual_20block_8',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]],
+ ['custom_20cpu_20memory_20allocator_9',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]],
+ ['custom_20memory_20pools_10',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
];
diff --git a/docs/html/search/pages_3.js b/docs/html/search/pages_3.js
index 842b2bb..89d174b 100644
--- a/docs/html/search/pages_3.js
+++ b/docs/html/search/pages_3.js
@@ -1,4 +1,9 @@
var searchData=
[
- ['frequently_20asked_20questions_0',['Frequently asked questions',['../faq.html',1,'index']]]
+ ['d3d12_20memory_20allocator_0',['D3D12 Memory Allocator',['../index.html',1,'']]],
+ ['deallocation_1',['Deallocation',['../virtual_allocator.html#virtual_allocator_deallocation',1,'']]],
+ ['debug_20margins_2',['Debug margins',['../configuration.html#debug_margins',1,'']]],
+ ['defragmentation_3',['Defragmentation',['../defragmentation.html',1,'optimal_allocation']]],
+ ['double_20stack_4',['Double stack',['../linear_algorithm.html#linear_algorithm_double_stack',1,'']]],
+ ['dump_5',['JSON dump',['../statistics.html#statistics_json_dump',1,'']]]
];
diff --git a/docs/html/search/pages_4.js b/docs/html/search/pages_4.js
index 1aed57d..6f9860c 100644
--- a/docs/html/search/pages_4.js
+++ b/docs/html/search/pages_4.js
@@ -1,4 +1,7 @@
var searchData=
[
- ['general_20considerations_0',['General considerations',['../general_considerations.html',1,'index']]]
+ ['features_20and_20benefits_0',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]],
+ ['features_20not_20supported_1',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]],
+ ['free_20at_20once_2',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]],
+ ['frequently_20asked_20questions_3',['Frequently asked questions',['../faq.html',1,'index']]]
];
diff --git a/docs/html/search/pages_5.js b/docs/html/search/pages_5.js
index b965ff9..b85c57f 100644
--- a/docs/html/search/pages_5.js
+++ b/docs/html/search/pages_5.js
@@ -1,4 +1,5 @@
var searchData=
[
- ['linear_20allocation_20algorithm_0',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]]
+ ['general_20considerations_0',['General considerations',['../general_considerations.html',1,'index']]],
+ ['gpu_20upload_20heap_1',['GPU upload heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'']]]
];
diff --git a/docs/html/search/pages_6.js b/docs/html/search/pages_6.js
index 2fa4310..6386d6c 100644
--- a/docs/html/search/pages_6.js
+++ b/docs/html/search/pages_6.js
@@ -1,5 +1,5 @@
var searchData=
[
- ['memory_20allocator_0',['D3D12 Memory Allocator',['../index.html',1,'']]],
- ['memory_20pools_1',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
+ ['heap_0',['GPU upload heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'']]],
+ ['helper_20structures_1',['Helper structures',['../quick_start.html#quick_start_helper_structures',1,'']]]
];
diff --git a/docs/html/search/pages_7.js b/docs/html/search/pages_7.js
index 0c3cb7f..75d0639 100644
--- a/docs/html/search/pages_7.js
+++ b/docs/html/search/pages_7.js
@@ -1,5 +1,4 @@
var searchData=
[
- ['optimal_20resource_20allocation_0',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
- ['overlap_1',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]]
+ ['initialization_0',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]]
];
diff --git a/docs/html/search/pages_8.js b/docs/html/search/pages_8.js
index f4128dd..2f270a2 100644
--- a/docs/html/search/pages_8.js
+++ b/docs/html/search/pages_8.js
@@ -1,4 +1,4 @@
var searchData=
[
- ['pools_0',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
+ ['json_20dump_0',['JSON dump',['../statistics.html#statistics_json_dump',1,'']]]
];
diff --git a/docs/html/search/pages_9.js b/docs/html/search/pages_9.js
index c9afe7b..9cdb234 100644
--- a/docs/html/search/pages_9.js
+++ b/docs/html/search/pages_9.js
@@ -1,5 +1,5 @@
var searchData=
[
- ['questions_0',['Frequently asked questions',['../faq.html',1,'index']]],
- ['quick_20start_1',['Quick start',['../quick_start.html',1,'index']]]
+ ['linear_20allocation_20algorithm_0',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
+ ['links_1',['Web links',['../index.html#main_see_also',1,'']]]
];
diff --git a/docs/html/search/pages_a.js b/docs/html/search/pages_a.js
index 53f0a34..0ce8dfd 100644
--- a/docs/html/search/pages_a.js
+++ b/docs/html/search/pages_a.js
@@ -1,5 +1,10 @@
var searchData=
[
- ['resource_20aliasing_20overlap_0',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
- ['resource_20allocation_1',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]]
+ ['making_20virtual_20allocations_0',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]],
+ ['mapping_20memory_1',['Mapping memory',['../quick_start.html#quick_start_mapping_memory',1,'']]],
+ ['margins_2',['Debug margins',['../configuration.html#debug_margins',1,'']]],
+ ['memory_3',['memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'Avoiding running out of memory'],['../quick_start.html#quick_start_mapping_memory',1,'Mapping memory']]],
+ ['memory_20allocator_4',['D3D12 Memory Allocator',['../index.html',1,'']]],
+ ['memory_20allocator_5',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]],
+ ['memory_20pools_6',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
];
diff --git a/docs/html/search/pages_b.js b/docs/html/search/pages_b.js
index d4b7ec0..a1fc386 100644
--- a/docs/html/search/pages_b.js
+++ b/docs/html/search/pages_b.js
@@ -1,5 +1,5 @@
var searchData=
[
- ['start_0',['Quick start',['../quick_start.html',1,'index']]],
- ['statistics_1',['Statistics',['../statistics.html',1,'optimal_allocation']]]
+ ['not_20supported_0',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]],
+ ['numeric_20statistics_1',['Numeric statistics',['../statistics.html#statistics_numeric_statistics',1,'']]]
];
diff --git a/docs/html/search/pages_c.js b/docs/html/search/pages_c.js
index 6f1ceb8..2036541 100644
--- a/docs/html/search/pages_c.js
+++ b/docs/html/search/pages_c.js
@@ -1,4 +1,9 @@
var searchData=
[
- ['virtual_20allocator_0',['Virtual allocator',['../virtual_allocator.html',1,'optimal_allocation']]]
+ ['of_20contents_0',['Table of contents',['../index.html#main_table_of_contents',1,'']]],
+ ['of_20memory_1',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]],
+ ['once_2',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]],
+ ['optimal_20resource_20allocation_3',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
+ ['out_20of_20memory_4',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]],
+ ['overlap_5',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]]
];
diff --git a/docs/html/search/pages_d.js b/docs/html/search/pages_d.js
new file mode 100644
index 0000000..61cd771
--- /dev/null
+++ b/docs/html/search/pages_d.js
@@ -0,0 +1,9 @@
+var searchData=
+[
+ ['parameters_0',['Allocation parameters',['../virtual_allocator.html#virtual_allocator_allocation_parameters',1,'']]],
+ ['performance_1',['Allocation performance',['../optimal_allocation.html#optimal_allocation_allocation_Performance',1,'']]],
+ ['placed_20resources_2',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]],
+ ['pools_3',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]],
+ ['priority_4',['Residency priority',['../optimal_allocation.html#optimal_allocation_residency_priority',1,'']]],
+ ['project_20setup_20and_20initialization_5',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]]
+];
diff --git a/docs/html/search/pages_e.js b/docs/html/search/pages_e.js
new file mode 100644
index 0000000..c9afe7b
--- /dev/null
+++ b/docs/html/search/pages_e.js
@@ -0,0 +1,5 @@
+var searchData=
+[
+ ['questions_0',['Frequently asked questions',['../faq.html',1,'index']]],
+ ['quick_20start_1',['Quick start',['../quick_start.html',1,'index']]]
+];
diff --git a/docs/html/search/pages_f.js b/docs/html/search/pages_f.js
new file mode 100644
index 0000000..97e8dbf
--- /dev/null
+++ b/docs/html/search/pages_f.js
@@ -0,0 +1,12 @@
+var searchData=
+[
+ ['reference_20counting_0',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]],
+ ['residency_20priority_1',['Residency priority',['../optimal_allocation.html#optimal_allocation_residency_priority',1,'']]],
+ ['resource_20aliasing_20overlap_2',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
+ ['resource_20alignment_3',['Resource alignment',['../optimal_allocation.html#optimal_allocation_resource_alignment',1,'']]],
+ ['resource_20allocation_4',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
+ ['resource_20reference_20counting_5',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]],
+ ['resources_6',['resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'Committed versus placed resources'],['../quick_start.html#quick_start_creating_resources',1,'Creating resources']]],
+ ['ring_20buffer_7',['Ring buffer',['../linear_algorithm.html#linear_algorithm_ring_buffer',1,'']]],
+ ['running_20out_20of_20memory_8',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]]
+];
diff --git a/docs/html/search/search.css b/docs/html/search/search.css
index 19f76f9..956f31f 100644
--- a/docs/html/search/search.css
+++ b/docs/html/search/search.css
@@ -5,8 +5,8 @@
display: flex;
justify-content: center;
align-items: center;
- height: 36px;
- margin-right: 1em;
+ height: 43px;
+ margin-right: 0;
}
/*---------------- Search box styling */
@@ -27,43 +27,23 @@ dark-mode-toggle {
white-space : nowrap;
background: var(--search-background-color);
border-radius: 0.65em;
- box-shadow: var(--search-box-shadow);
+ border: 1px solid var(--search-box-border-color);
z-index: 102;
+ margin-right: 4px;
}
#MSearchBox .left {
display: inline-block;
vertical-align: middle;
- height: 1.4em;
-}
-
-#MSearchSelect {
- display: inline-block;
- vertical-align: middle;
- width: 20px;
- height: 19px;
- background-image: var(--search-magnification-select-image);
- margin: 0 0 0 0.3em;
- padding: 0;
+ height: 1.6em;
}
-#MSearchSelectExt {
- display: inline-block;
- vertical-align: middle;
- width: 10px;
- height: 19px;
- background-image: var(--search-magnification-image);
- margin: 0 0 0 0.5em;
- padding: 0;
-}
-
-
#MSearchField {
display: inline-block;
- vertical-align: middle;
+ vertical-align: top;
width: 7.5em;
- height: 19px;
- margin: 0 0.15em;
+ height: 22px;
+ margin: 0 0 0 0.15em;
padding: 0;
line-height: 1em;
border:none;
@@ -86,7 +66,7 @@ dark-mode-toggle {
display: inline-block;
vertical-align: middle;
width: 1.4em;
- height: 1.4em;
+ height: 1.6em;
}
#MSearchClose {
@@ -101,14 +81,100 @@ dark-mode-toggle {
}
#MSearchCloseImg {
- padding: 0.3em;
- margin: 0;
+ margin: 6px 0 0 4px;
+}
+
+.close-icon {
+ width: 11px;
+ height: 11px;
+ background-color: var(--search-close-icon-bg-color);
+ border-radius: 50%;
+ position: relative;
+ display: flex;
+ justify-content: center;
+ align-items: center;
+ box-sizing: content-box;
+}
+
+.close-icon:before,
+.close-icon:after {
+ content: '';
+ position: absolute;
+ width: 7px;
+ height: 1px;
+ background-color: var(--search-close-icon-fg-color);
+}
+
+.close-icon:before {
+ transform: rotate(45deg);
}
+.close-icon:after {
+ transform: rotate(-45deg);
+}
+
+
.MSearchBoxActive #MSearchField {
color: var(--search-active-color);
}
+.search-icon {
+ width: 20px;
+ height: 20px;
+ display: inline-block;
+ position: relative;
+ margin-left: 3px;
+}
+
+#MSearchSelectExt.search-icon {
+ width: 10px;
+}
+
+#MSearchSelectExt + input {
+ margin-left: 5px;
+}
+
+.search-icon::before, .search-icon::after {
+ content: '';
+ position: absolute;
+ border: 1.5px solid var(--search-foreground-color);
+ box-sizing: content-box;
+}
+
+.search-icon::before {
+ width: 6px;
+ height: 6px;
+ border-radius: 50%;
+ top: 7px;
+ left: 2px;
+ background: var(--search-background-color);
+}
+
+.search-icon::after {
+ border: 1px solid var(--search-foreground-color);
+ width: 0px;
+ height: 3px;
+ border-radius: 2px;
+ top: 15px;
+ left: 8px;
+ transform: rotate(-45deg);
+ transform-origin: top left;
+}
+
+.search-icon-dropdown {
+ content: '';
+ width: 0;
+ height: 0;
+ border-left: 3px solid transparent;
+ border-right: 3px solid transparent;
+ border-top: 3px solid var(--search-foreground-color);
+ top: 8px;
+ left: 15px;
+ transform: translateX(-50%);
+ position: absolute;
+}
+
+
/*---------------- Search filter selection */
@@ -119,15 +185,12 @@ dark-mode-toggle {
left: 0; top: 0;
border: 1px solid var(--search-filter-border-color);
background-color: var(--search-filter-background-color);
+ backdrop-filter: var(--search-filter-backdrop-filter);
+ -webkit-backdrop-filter: var(--search-filter-backdrop-filter);
z-index: 10001;
padding-top: 4px;
padding-bottom: 4px;
- -moz-border-radius: 4px;
- -webkit-border-top-left-radius: 4px;
- -webkit-border-top-right-radius: 4px;
- -webkit-border-bottom-left-radius: 4px;
- -webkit-border-bottom-right-radius: 4px;
- -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ border-radius: 4px;
}
.SelectItem {
@@ -176,18 +239,39 @@ iframe#MSearchResults {
height: 15em;
}
+@keyframes slideInSearchResults {
+ from {
+ opacity: 0;
+ transform: translate(0, 15px);
+ }
+
+ to {
+ opacity: 1;
+ transform: translate(0, 20px);
+ }
+}
+
#MSearchResultsWindow {
display: none;
position: absolute;
- left: 0; top: 0;
+ left: auto;
+ right: 4px;
+ top: 0;
border: 1px solid var(--search-results-border-color);
background-color: var(--search-results-background-color);
+ backdrop-filter: var(--search-results-backdrop-filter);
+ -webkit-backdrop-filter: var(--search-results-backdrop-filter);
z-index:10000;
width: 300px;
height: 400px;
overflow: auto;
+ border-radius: 8px;
+ transform: translate(0, 20px);
+ animation: ease-out 280ms slideInSearchResults;
+ box-shadow: 0 2px 8px 0 rgba(0,0,0,.075);
}
+
/* ----------------------------------- */
@@ -201,13 +285,13 @@ iframe#MSearchResults {
}
.SRPage .SREntry {
- font-size: 8pt;
- padding: 1px 5px;
+ font-size: 10pt;
+ padding: 2px 5px;
}
div.SRPage {
margin: 5px 2px;
- background-color: var(--search-results-background-color);
+ /*background-color: var(--search-results-background-color);*/
}
.SRChildren {
@@ -261,14 +345,17 @@ div.searchresults {
margin-right: 10px;
}
+#searchBoxPos1 dark-mode-toggle {
+ margin-top: 4px;
+}
+
/*---------------- External search page results */
.pages b {
- color: white;
+ color: var(--nav-foreground-color);
padding: 5px 5px 3px 5px;
- background-image: var(--nav-gradient-active-image-parent);
- background-repeat: repeat-x;
- text-shadow: 0 1px 1px #000000;
+ background-color: var(--nav-menu-active-bg);
+ border-radius: 4px;
}
.pages {
diff --git a/docs/html/search/search.js b/docs/html/search/search.js
index 666af01..dc14410 100644
--- a/docs/html/search/search.js
+++ b/docs/html/search/search.js
@@ -607,6 +607,12 @@ function createResults(resultsPath) {
elem.setAttribute('className',attr);
}
+ const decodeHtml = (html) => {
+ const txt = document.createElement("textarea");
+ txt.innerHTML = html;
+ return txt.value;
+ };
+
const results = document.getElementById("SRResults");
results.innerHTML = '';
searchData.forEach((elem,index) => {
@@ -620,10 +626,14 @@ function createResults(resultsPath) {
srLink.setAttribute('id','Item'+index);
setKeyActions(srLink,'return searchResults.Nav(event,'+index+')');
setClassAttr(srLink,'SRSymbol');
- srLink.innerHTML = elem[1][0];
+ srLink.innerHTML = decodeHtml(elem[1][0]);
srEntry.appendChild(srLink);
if (elem[1].length==2) { // single result
- srLink.setAttribute('href',resultsPath+elem[1][1][0]);
+ if (elem[1][1][0].startsWith('http://') || elem[1][1][0].startsWith('https://')) { // absolute path
+ srLink.setAttribute('href',elem[1][1][0]);
+ } else { // relative path
+ srLink.setAttribute('href',resultsPath+elem[1][1][0]);
+ }
srLink.setAttribute('onclick','searchBox.CloseResultsWindow()');
if (elem[1][1][1]) {
srLink.setAttribute('target','_parent');
@@ -632,7 +642,7 @@ function createResults(resultsPath) {
}
const srScope = document.createElement('span');
setClassAttr(srScope,'SRScope');
- srScope.innerHTML = elem[1][1][2];
+ srScope.innerHTML = decodeHtml(elem[1][1][2]);
srEntry.appendChild(srScope);
} else { // multiple results
srLink.setAttribute('href','javascript:searchResults.Toggle("SR_'+id+'")');
@@ -643,14 +653,18 @@ function createResults(resultsPath) {
srChild.setAttribute('id','Item'+index+'_c'+c);
setKeyActions(srChild,'return searchResults.NavChild(event,'+index+','+c+')');
setClassAttr(srChild,'SRScope');
- srChild.setAttribute('href',resultsPath+elem[1][c+1][0]);
+ if (elem[1][c+1][0].startsWith('http://') || elem[1][c+1][0].startsWith('https://')) { // absolute path
+ srChild.setAttribute('href',elem[1][c+1][0]);
+ } else { // relative path
+ srChild.setAttribute('href',resultsPath+elem[1][c+1][0]);
+ }
srChild.setAttribute('onclick','searchBox.CloseResultsWindow()');
if (elem[1][c+1][1]) {
srChild.setAttribute('target','_parent');
} else {
srChild.setAttribute('target','_blank');
}
- srChild.innerHTML = elem[1][c+1][2];
+ srChild.innerHTML = decodeHtml(elem[1][c+1][2]);
srChildren.appendChild(srChild);
}
srEntry.appendChild(srChildren);
diff --git a/docs/html/search/searchdata.js b/docs/html/search/searchdata.js
index 1b7813a..2029dc1 100644
--- a/docs/html/search/searchdata.js
+++ b/docs/html/search/searchdata.js
@@ -11,7 +11,7 @@ var indexSectionsWithContent =
8: "adpv",
9: "cd",
10: "d",
- 11: "acdfglmopqrsv"
+ 11: "abcdfghijlmnopqrstuvw"
};
var indexSectionNames =
diff --git a/docs/html/statistics.html b/docs/html/statistics.html
index f261c65..b9b1e29 100644
--- a/docs/html/statistics.html
+++ b/docs/html/statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Statistics
-
-
@@ -33,33 +31,22 @@
-
+
-
- Statistics
+ Statistics
This library contains several functions that return information about its internal state, especially the amount of memory allocated from D3D12.
-
+
Numeric statistics
If you need to obtain basic statistics about memory usage per memory segment group, together with current budget, you can call function D3D12MA::Allocator::GetBudget() and inspect structure D3D12MA::Budget. This is useful to keep track of memory usage and stay withing budget. Example:
D3D12MA::Budget localBudget;
@@ -112,8 +99,8 @@
UINT64 UsageBytesEstimated current memory usage of the program.Definition D3D12MemAlloc.h:486
You can query for more detailed statistics per heap type, memory segment group, and totals, including minimum and maximum allocation size and unused range size, by calling function D3D12MA::Allocator::CalculateStatistics() and inspecting structure D3D12MA::TotalStatistics. This function is slower though, as it has to traverse all the internal data structures, so it should be used only for debugging purposes.
You can query for statistics of a custom pool using function D3D12MA::Pool::GetStatistics() or D3D12MA::Pool::CalculateStatistics().
-You can query for information about a specific allocation using functions of the D3D12MA::Allocation class, e.g. GetSize(), GetOffset(), GetHeap().
-
+
You can query for information about a specific allocation using functions of the D3D12MA::Allocation class, e.g. GetSize(), GetOffset(), GetHeap().
+
JSON dump
You can dump internal state of the allocator to a string in JSON format using function D3D12MA::Allocator::BuildStatsString(). The result is guaranteed to be correct JSON. It uses Windows Unicode (UTF-16) encoding. Any strings provided by user (see D3D12MA::Allocation::SetName()) are copied as-is and properly escaped for JSON. It must be freed using function D3D12MA::Allocator::FreeStatsString().
The format of this JSON string is not part of official documentation of the library, but it will not change in backward-incompatible way without increasing library major version number and appropriate mention in changelog.
@@ -122,7 +109,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html
index 223cc58..f967c0c 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html
index bb90eaa..495fe3f 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::ALLOCATION_CALLBACKS Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
ALLOCATE_FUNC_PTR pAllocate Allocation function.
FREE_FUNC_PTR pFree Dellocation function.
void * pPrivateData Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
-Detailed Description
+Detailed Description
Custom callbacks to CPU memory allocation functions.
-Member Data Documentation
+Member Data Documentation
◆ pAllocate
@@ -159,7 +143,7 @@
-Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
+Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
@@ -169,7 +153,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 0dd1a39..f398da5 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -102,7 +89,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 5363747..d914ec6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,33 +90,28 @@
Inheritance diagram for D3D12MA::ALLOCATION_DESC:
-
-
-
+
Public Attributes
ALLOCATION_FLAGS Flags Flags for the allocation.
D3D12_HEAP_TYPE HeapType The type of memory heap where the new allocation should be placed.
D3D12_HEAP_FLAGS ExtraHeapFlags Additional heap flags to be used when allocating memory.
Pool * CustomPool Custom pool to place the new resource in. Optional.
void * pPrivateData Custom general-purpose pointer that will be stored in D3D12MA::Allocation.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.
-Member Data Documentation
+Member Data Documentation
◆ CustomPool
@@ -143,7 +125,7 @@
Custom pool to place the new resource in. Optional.
-When not null, the resource will be created inside specified custom pool. Members HeapType, ExtraHeapFlags are then ignored.
+When not null, the resource will be created inside specified custom pool. Members HeapType, ExtraHeapFlags are then ignored.
@@ -162,9 +144,9 @@ D3D12MA::Allocator::CreateResource(), you don't need to care. Necessary flag D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, or D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES is added automatically.
-- If you use D3D12MA::Allocator::AllocateMemory(), you should specify one of those
ALLOW_ONLY flags. Except when you validate that D3D12MA::Allocator::GetD3D12Options().ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1 - then you can leave it 0.
-- You can specify additional flags if needed. Then the memory will always be allocated as separate block using
D3D12Device::CreateCommittedResource or CreateHeap, not as part of an existing larget block.
+- If you use D3D12MA::Allocator::CreateResource(), you don't need to care. Necessary flag D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, or D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES is added automatically.
+- If you use D3D12MA::Allocator::AllocateMemory(), you should specify one of those ALLOW_ONLY flags. Except when you validate that D3D12MA::Allocator::GetD3D12Options().ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1 - then you can leave it 0.
+- You can specify additional flags if needed. Then the memory will always be allocated as separate block using D3D12Device::CreateCommittedResource or CreateHeap, not as part of an existing larget block.
When D3D12MA::ALLOCATION_DESC::CustomPool != NULL this member is ignored.
@@ -199,7 +181,7 @@
The type of memory heap where the new allocation should be placed.
-It must be one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK.
+It must be one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK.
When D3D12MA::ALLOCATION_DESC::CustomPool != NULL this member is ignored.
@@ -226,7 +208,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html
index ccc6e9d..cfc611c 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -102,7 +89,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html
index 8673896..33029a6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::ALLOCATOR_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
ALLOCATOR_FLAGS Flags Flags for the entire allocator.
ID3D12Device * pDevice UINT64 PreferredBlockSize Preferred size of a single ID3D12Heap block to be allocated.
Preferred size of a single ID3D12Heap block to be allocated.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
IDXGIAdapter * pAdapter
-Detailed Description
+Detailed Description
Parameters of created Allocator object. To be used with CreateAllocator().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -148,7 +130,7 @@
DXGI Adapter object that you use for D3D12 and this allocator.
-Allocator is doing AddRef/Release on this object.
+Allocator is doing AddRef/Release on this object.
@@ -181,7 +163,7 @@
Direct3D device object that the allocator should be attached to.
-Allocator is doing AddRef/Release on this object.
+Allocator is doing AddRef/Release on this object.
@@ -197,7 +179,7 @@
-Preferred size of a single ID3D12Heap block to be allocated.
+Preferred size of a single ID3D12Heap block to be allocated.
Set to 0 to use default, which is currently 64 MiB.
@@ -208,7 +190,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_budget-members.html b/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
index ddeda17..26e4bee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_budget.html b/docs/html/struct_d3_d12_m_a_1_1_budget.html
index 4798ab6..8e8f354 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_budget.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_budget.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Budget Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Statistics fetched from the library.
UINT64 UsageBytes Estimated current memory usage of the program.
UINT64 BudgetBytes Estimated amount of memory available to the program.
-Detailed Description
+Detailed Description
Statistics of current memory usage and available budget for a specific memory segment group.
These are fast to calculate. See function D3D12MA::Allocator::GetBudget().
-Member Data Documentation
+Member Data Documentation
◆ BudgetBytes
@@ -129,8 +113,8 @@
Estimated amount of memory available to the program.
-Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
-It might be different (most probably smaller) than memory capacity returned by D3D12MA::Allocator::GetMemoryCapacity() due to factors external to the program, decided by the operating system. Difference BudgetBytes - UsageBytes is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.
+Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
+It might be different (most probably smaller) than memory capacity returned by D3D12MA::Allocator::GetMemoryCapacity() due to factors external to the program, decided by the operating system. Difference BudgetBytes - UsageBytes is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.
@@ -163,8 +147,8 @@
Estimated current memory usage of the program.
-Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
-It might be different than BlockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipeline state objects, descriptor heaps, command lists, or heaps and resources allocated outside of this library, if any.
+Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
+It might be different than BlockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipeline state objects, descriptor heaps, command lists, or heaps and resources allocated outside of this library, if any.
@@ -174,7 +158,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 656581f..9423c7f 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 49c2950..cae7b08 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,49 +90,40 @@
Inheritance diagram for D3D12MA::CALLOCATION_DESC:
-
-
-
+
Public Member Functions
CALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CALLOCATION_DESC (const ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::ALLOCATION_DESC structure.
CALLOCATION_DESC (Pool *customPool, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of an allocation to be created in a specific custom pool.
CALLOCATION_DESC (D3D12_HEAP_TYPE heapType, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL, D3D12_HEAP_FLAGS extraHeapFlags=D3D12MA_RECOMMENDED_HEAP_FLAGS) noexcept Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::ALLOCATION_DESC Public Attributes inherited from D3D12MA::ALLOCATION_DESC ALLOCATION_FLAGS Flags Flags for the allocation.
D3D12_HEAP_TYPE HeapType The type of memory heap where the new allocation should be placed.
D3D12_HEAP_FLAGS ExtraHeapFlags Additional heap flags to be used when allocating memory.
Pool * CustomPool Custom pool to place the new resource in. Optional.
void * pPrivateData Custom general-purpose pointer that will be stored in D3D12MA::Allocation.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CALLOCATION_DESC() [1/4]
@@ -273,7 +251,7 @@
-Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
+Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
@@ -283,7 +261,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
index 1cb0dea..66262d0 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -110,7 +97,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
index fb6bf6f..37f7330 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CPOOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,61 +90,48 @@
Inheritance diagram for D3D12MA::CPOOL_DESC:
-
-
-
+
Public Member Functions
CPOOL_DESC ()=default Default constructor. Leaves the structure uninitialized.
CPOOL_DESC (const POOL_DESC &o) noexcept Constructor initializing from the base D3D12MA::POOL_DESC structure.
CPOOL_DESC (D3D12_HEAP_TYPE heapType, D3D12_HEAP_FLAGS heapFlags, POOL_FLAGS flags=D3D12MA_RECOMMENDED_POOL_FLAGS, UINT64 blockSize=0, UINT minBlockCount=0, UINT maxBlockCount=UINT_MAX, D3D12_RESIDENCY_PRIORITY residencyPriority=D3D12_RESIDENCY_PRIORITY_NORMAL) noexcept Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
CPOOL_DESC (const D3D12_HEAP_PROPERTIES heapProperties, D3D12_HEAP_FLAGS heapFlags, POOL_FLAGS flags=D3D12MA_RECOMMENDED_POOL_FLAGS, UINT64 blockSize=0, UINT minBlockCount=0, UINT maxBlockCount=UINT_MAX, D3D12_RESIDENCY_PRIORITY residencyPriority=D3D12_RESIDENCY_PRIORITY_NORMAL) noexcept Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::POOL_DESC Public Attributes inherited from D3D12MA::POOL_DESC POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CPOOL_DESC() [1/4]
@@ -264,7 +238,7 @@
-Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
+Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
@@ -320,7 +294,7 @@
-Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
+Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
@@ -330,7 +304,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 8eb5d11..da976da 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -104,7 +91,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index cb1fe74..714062b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,43 +90,36 @@
Inheritance diagram for D3D12MA::CVIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_ALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_ALLOCATION_DESC (const VIRTUAL_ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
CVIRTUAL_ALLOCATION_DESC (UINT64 size, UINT64 alignment, VIRTUAL_ALLOCATION_FLAGS flags=VIRTUAL_ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of a virtual allocation with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_ALLOCATION_DESC() [1/3]
@@ -241,7 +221,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index eeecc96..27af579 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index 78fbb71..e24e9a8 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,40 +90,34 @@
Inheritance diagram for D3D12MA::CVIRTUAL_BLOCK_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_BLOCK_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_BLOCK_DESC (const VIRTUAL_BLOCK_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_BLOCK_DESC structure.
CVIRTUAL_BLOCK_DESC (UINT64 size, VIRTUAL_BLOCK_FLAGS flags=VIRTUAL_BLOCK_FLAG_NONE, const ALLOCATION_CALLBACKS *allocationCallbacks=NULL) noexcept Constructor initializing description of a virtual block with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_BLOCK_DESC() [1/3]
@@ -233,7 +214,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
index 698ab11..69adefa 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
index c65cd1a..242a2ed 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_FLAGS Flags Flags.
UINT64 MaxBytesPerPass Maximum numbers of bytes that can be copied during single pass, while moving allocations to different places.
UINT32 MaxAllocationsPerPass Maximum number of allocations that can be moved during single pass to a different place.
-Detailed Description
+Detailed Description
Parameters for defragmentation.
To be used with functions Allocator::BeginDefragmentation() and Pool::BeginDefragmentation().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -172,7 +156,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
index 4fed39a..f20848d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
index 8a8bf70..87c182e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_MOVE Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_MOVE_OPERATION Operation Operation to be performed on the allocation by DefragmentationContext::EndPass(). Default value is DEFRAGMENTATION_MOVE_OPERATION_COPY. You can modify it.
Allocation * pSrcAllocation Allocation that should be moved.
Allocation * pDstTmpAllocation Temporary allocation pointing to destination memory that will replace pSrcAllocation.
Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Detailed Description
+Detailed Description
Single move of an allocation to be done for defragmentation.
-Member Data Documentation
+Member Data Documentation
◆ Operation
@@ -143,9 +127,9 @@
-Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
-- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make
pSrcAllocation point to this memory.
+Temporary allocation pointing to destination memory that will replace pSrcAllocation.
+Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
+- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make pSrcAllocation point to this memory.
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
index 28aefc6..3e0a1e4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -99,7 +86,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
index 1212826..6e37ac2 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,19 +87,17 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT32 MoveCount Number of elements in the pMoves array.
Number of elements in the pMoves array.
DEFRAGMENTATION_MOVE * pMoves Array of moves to be performed by the user in the current defragmentation pass.
-Detailed Description
+Detailed Description
Parameters for incremental defragmentation steps.
To be used with function DefragmentationContext::BeginPass().
-Member Data Documentation
+Member Data Documentation
◆ MoveCount
@@ -125,7 +110,7 @@
-Number of elements in the pMoves array.
+Number of elements in the pMoves array.
@@ -142,12 +127,12 @@
Array of moves to be performed by the user in the current defragmentation pass.
-Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
+Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
For each element, you should:
-- Create a new resource in the place pointed by
pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
-- Store new resource in
pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
-- Copy data from the
pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
+- Create a new resource in the place pointed by pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
+- Store new resource in pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
+- Copy data from the pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
- Make sure these commands finished executing on the GPU.
Only then you can finish defragmentation pass by calling DefragmentationContext::EndPass(). After this call, the allocation will point to the new place in memory.
@@ -162,7 +147,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
index 6723fa3..be2d910 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
index b7f806d..220d0bd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_STATS Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,24 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 BytesMoved Total number of bytes that have been copied while moving allocations to different places.
UINT64 BytesFreed Total number of bytes that have been released to the system by freeing empty heaps.
UINT32 AllocationsMoved Number of allocations that have been moved to different places.
UINT32 HeapsFreed Number of empty ID3D12Heap objects that have been released to the system.
Number of empty ID3D12Heap objects that have been released to the system.
-Detailed Description
+Detailed Description
Statistics returned for defragmentation process by function DefragmentationContext::GetStats().
-Member Data Documentation
+Member Data Documentation
◆ AllocationsMoved
@@ -178,7 +161,7 @@
-Number of empty ID3D12Heap objects that have been released to the system.
+Number of empty ID3D12Heap objects that have been released to the system.
@@ -188,7 +171,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
index 9167002..13c5446 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
index f4f534a..88fa33d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DetailedStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,35 +87,29 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Basic statistics.
UINT UnusedRangeCount Number of free ranges of memory between allocations.
UINT64 AllocationSizeMin Smallest allocation size. UINT64_MAX if there are 0 allocations.
Smallest allocation size. UINT64_MAX if there are 0 allocations.
UINT64 AllocationSizeMax Largest allocation size. 0 if there are 0 allocations.
UINT64 UnusedRangeSizeMin Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
UINT64 UnusedRangeSizeMax Largest empty range size. 0 if there are 0 empty ranges.
-Detailed Description
+Detailed Description
More detailed statistics than D3D12MA::Statistics.
These are slower to calculate. Use for debugging purposes. See functions: D3D12MA::Allocator::CalculateStatistics(), D3D12MA::Pool::CalculateStatistics().
Averages are not provided because they can be easily calculated as:
UINT64 AllocationSizeAvg = DetailedStats.Statistics.AllocationBytes / detailedStats.Statistics.AllocationCount;
UINT64 UnusedBytes = DetailedStats.Statistics.BlockBytes - DetailedStats.Statistics.AllocationBytes;
UINT64 UnusedRangeSizeAvg = UnusedBytes / DetailedStats.UnusedRangeCount;
- Member Data Documentation
+ Member Data Documentation
◆ AllocationSizeMax
@@ -157,7 +138,7 @@
-Smallest allocation size. UINT64_MAX if there are 0 allocations.
+Smallest allocation size. UINT64_MAX if there are 0 allocations.
@@ -221,7 +202,7 @@
-Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
+Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
@@ -231,7 +212,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
index 2ae0d33..654ade6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
index fcb0f64..d812aff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::POOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,45 +90,36 @@
Inheritance diagram for D3D12MA::POOL_DESC:
-
-
-
+
Public Attributes
POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool.
-Member Data Documentation
+Member Data Documentation
◆ BlockSize
@@ -189,7 +167,7 @@
Heap flags to be used when allocating heaps of this pool.
-It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
+It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
It is recommended to also add D3D12MA_RECOMMENDED_POOL_FLAGS. You can specify additional flags if needed.
@@ -207,7 +185,7 @@
The parameters of memory heap where allocations of this pool should be placed.
-In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
+In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
@@ -224,7 +202,7 @@
Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
-Set to 0 to use default, which is UINT64_MAX, which means no limit.
+Set to 0 to use default, which is UINT64_MAX, which means no limit.
Set to same value as D3D12MA::POOL_DESC::MinBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.
@@ -293,10 +271,10 @@
Residency priority to be set for all allocations made in this pool. Optional.
-Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
-Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
-This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
-There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
+Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
+Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
+This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
+There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
@@ -306,7 +284,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
index a970156..67b61fe 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
index b7e7c30..853c2ff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Statistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,21 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT BlockCount Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
UINT AllocationCount Number of D3D12MA::Allocation objects allocated.
UINT64 BlockBytes Number of bytes allocated in memory blocks.
UINT64 AllocationBytes Total number of bytes occupied by all D3D12MA::Allocation objects.
-Detailed Description
+Detailed Description
Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total.
These are fast to calculate. See functions: D3D12MA::Allocator::GetBudget(), D3D12MA::Pool::GetStatistics().
-Member Data Documentation
+Member Data Documentation
◆ AllocationBytes
@@ -132,7 +115,7 @@
Total number of bytes occupied by all D3D12MA::Allocation objects.
-Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
+Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
@@ -149,7 +132,7 @@
Number of D3D12MA::Allocation objects allocated.
-Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
+Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
@@ -181,7 +164,7 @@
-Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
+Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
-
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
ID3D12Resource::GetGPUVirtualAddress() + Allocation::GetSize() to overlap in memory and still work correctly. Member Data Documentation
+Member Data Documentation
◆ allocHandle
@@ -531,7 +508,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_allocator-members.html b/docs/html/class_d3_d12_m_a_1_1_allocator-members.html
index 469eb2c..ca74e46 100644
--- a/docs/html/class_d3_d12_m_a_1_1_allocator-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_allocator-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -118,7 +105,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_allocator.html b/docs/html/class_d3_d12_m_a_1_1_allocator.html
index 2817820..08b73a0 100644
--- a/docs/html/class_d3_d12_m_a_1_1_allocator.html
+++ b/docs/html/class_d3_d12_m_a_1_1_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Allocator Class Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -95,7 +82,7 @@
-Represents main object of this library initialized for particular ID3D12Device.
+
Represents main object of this library initialized for particular ID3D12Device.
More...
#include <D3D12MemAlloc.h>
@@ -106,71 +93,52 @@
-
+
Public Member Functions
const D3D12_FEATURE_DATA_D3D12_OPTIONS & GetD3D12Options () const Returns cached options retrieved from D3D12 device.
BOOL IsUMA () const Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::UMA was found to be true.
Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::UMA was found to be true.
BOOL IsCacheCoherentUMA () const Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMA was found to be true.
Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMA was found to be true.
BOOL IsGPUUploadHeapSupported () const Returns true if GPU Upload Heaps are supported on the current system.
UINT64 GetMemoryCapacity (UINT memorySegmentGroup) const Returns total amount of memory of specific segment group, in bytes.
HRESULT CreateResource (const ALLOCATION_DESC *pAllocDesc, const D3D12_RESOURCE_DESC *pResourceDesc, D3D12_RESOURCE_STATES InitialResourceState, const D3D12_CLEAR_VALUE *pOptimizedClearValue, Allocation **ppAllocation, REFIID riidResource, void **ppvResource) Allocates memory and creates a D3D12 resource (buffer or texture). This is the main allocation function.
HRESULT CreateResource2 (const ALLOCATION_DESC *pAllocDesc, const D3D12_RESOURCE_DESC1 *pResourceDesc, D3D12_RESOURCE_STATES InitialResourceState, const D3D12_CLEAR_VALUE *pOptimizedClearValue, Allocation **ppAllocation, REFIID riidResource, void **ppvResource) Similar to Allocator::CreateResource, but supports new structure D3D12_RESOURCE_DESC1.
Similar to Allocator::CreateResource, but supports new structure D3D12_RESOURCE_DESC1.
HRESULT CreateResource3 (const ALLOCATION_DESC *pAllocDesc, const D3D12_RESOURCE_DESC1 *pResourceDesc, D3D12_BARRIER_LAYOUT InitialLayout, const D3D12_CLEAR_VALUE *pOptimizedClearValue, UINT32 NumCastableFormats, const DXGI_FORMAT *pCastableFormats, Allocation **ppAllocation, REFIID riidResource, void **ppvResource) Similar to Allocator::CreateResource2, but there are initial layout instead of state and castable formats list.
HRESULT AllocateMemory (const ALLOCATION_DESC *pAllocDesc, const D3D12_RESOURCE_ALLOCATION_INFO *pAllocInfo, Allocation **ppAllocation) Allocates memory without creating any resource placed in it.
HRESULT CreateAliasingResource (Allocation *pAllocation, UINT64 AllocationLocalOffset, const D3D12_RESOURCE_DESC *pResourceDesc, D3D12_RESOURCE_STATES InitialResourceState, const D3D12_CLEAR_VALUE *pOptimizedClearValue, REFIID riidResource, void **ppvResource) Creates a new resource in place of an existing allocation. This is useful for memory aliasing.
HRESULT CreateAliasingResource1 (Allocation *pAllocation, UINT64 AllocationLocalOffset, const D3D12_RESOURCE_DESC1 *pResourceDesc, D3D12_RESOURCE_STATES InitialResourceState, const D3D12_CLEAR_VALUE *pOptimizedClearValue, REFIID riidResource, void **ppvResource) Similar to Allocator::CreateAliasingResource, but supports new structure D3D12_RESOURCE_DESC1.
Similar to Allocator::CreateAliasingResource, but supports new structure D3D12_RESOURCE_DESC1.
HRESULT CreateAliasingResource2 (Allocation *pAllocation, UINT64 AllocationLocalOffset, const D3D12_RESOURCE_DESC1 *pResourceDesc, D3D12_BARRIER_LAYOUT InitialLayout, const D3D12_CLEAR_VALUE *pOptimizedClearValue, UINT32 NumCastableFormats, const DXGI_FORMAT *pCastableFormats, REFIID riidResource, void **ppvResource) Similar to Allocator::CreateAliasingResource1, but there are initial layout instead of state and castable formats list.
HRESULT CreatePool (const POOL_DESC *pPoolDesc, Pool **ppPool) Creates custom pool.
void SetCurrentFrameIndex (UINT frameIndex) Sets the index of the current frame.
void GetBudget (Budget *pLocalBudget, Budget *pNonLocalBudget) Retrieves information about current memory usage and budget.
void CalculateStatistics (TotalStatistics *pStats) Retrieves statistics from current state of the allocator.
void BuildStatsString (WCHAR **ppStatsString, BOOL DetailedMap) const Builds and returns statistics as a string in JSON format.
void FreeStatsString (WCHAR *pStatsString) const Frees memory of a string returned from Allocator::BuildStatsString.
void BeginDefragmentation (const DEFRAGMENTATION_DESC *pDesc, DefragmentationContext **ppContext) Begins defragmentation process of the default pools.
-Detailed Description
-Represents main object of this library initialized for particular ID3D12Device.
-Fill structure D3D12MA::ALLOCATOR_DESC and call function CreateAllocator() to create it. Call method Release() to destroy it.
-It is recommended to create just one object of this type per ID3D12Device object, right after Direct3D 12 is initialized and keep it alive until before Direct3D device is destroyed.
-Member Function Documentation
+Detailed Description
+Represents main object of this library initialized for particular ID3D12Device.
+Fill structure D3D12MA::ALLOCATOR_DESC and call function CreateAllocator() to create it. Call method Release() to destroy it.
+It is recommended to create just one object of this type per ID3D12Device object, right after Direct3D 12 is initialized and keep it alive until before Direct3D device is destroyed.
+Member Function Documentation
◆ AllocateMemory()
@@ -196,9 +164,9 @@
Allocates memory without creating any resource placed in it.
-This function is similar to ID3D12Device::CreateHeap, but it may really assign part of a larger, existing heap to the allocation.
-pAllocDesc->heapFlags should contain one of these values, depending on type of resources you are going to create in this memory: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if you validate that ResourceHeapTier = 2 - then heapFlags may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0. Additional flags in heapFlags are allowed as well.
-pAllocInfo->SizeInBytes must be multiply of 64KB. pAllocInfo->Alignment must be one of the legal values as described in documentation of D3D12_HEAP_DESC.
+This function is similar to ID3D12Device::CreateHeap, but it may really assign part of a larger, existing heap to the allocation.
+pAllocDesc->heapFlags should contain one of these values, depending on type of resources you are going to create in this memory: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if you validate that ResourceHeapTier = 2 - then heapFlags may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0. Additional flags in heapFlags are allowed as well.
+pAllocInfo->SizeInBytes must be multiply of 64KB. pAllocInfo->Alignment must be one of the legal values as described in documentation of D3D12_HEAP_DESC.
If you use D3D12MA::ALLOCATION_FLAG_COMMITTED you will get a separate memory block - a heap that always has offset 0.
@@ -257,7 +225,7 @@ Parameters
[out] ppStatsString Must be freed using Allocator::FreeStatsString. DetailedMap TRUE to include full list of allocations (can make the string quite long), FALSE to only return statistics. DetailedMap TRUE to include full list of allocations (can make the string quite long), FALSE to only return statistics.
@@ -332,17 +300,17 @@ Parameters
- pAllocation Existing allocation indicating the memory where the new resource should be created. It can be created using D3D12MA::Allocator::CreateResource and already have a resource bound to it, or can be a raw memory allocated with D3D12MA::Allocator::AllocateMemory. It must not be created as committed so that ID3D12Heap is available and not implicit. AllocationLocalOffset Additional offset in bytes to be applied when allocating the resource. Local from the start of pAllocation, not the beginning of the whole ID3D12Heap! If the new resource should start from the beginning of the pAllocation it should be 0. pAllocation Existing allocation indicating the memory where the new resource should be created. It can be created using D3D12MA::Allocator::CreateResource and already have a resource bound to it, or can be a raw memory allocated with D3D12MA::Allocator::AllocateMemory. It must not be created as committed so that ID3D12Heap is available and not implicit. AllocationLocalOffset Additional offset in bytes to be applied when allocating the resource. Local from the start of pAllocation, not the beginning of the whole ID3D12Heap! If the new resource should start from the beginning of the pAllocation it should be 0. pResourceDesc Description of the new resource to be created. InitialResourceState pOptimizedClearValue riidResource [out] ppvResource Returns pointer to the new resource. The resource is not bound with pAllocation. This pointer must not be null - you must get the resource pointer and Release it when no longer needed. [out] ppvResource Returns pointer to the new resource. The resource is not bound with pAllocation. This pointer must not be null - you must get the resource pointer and Release it when no longer needed.
-Memory requirements of the new resource are checked for validation. If its size exceeds the end of pAllocation or required alignment is not fulfilled considering pAllocation->GetOffset() + AllocationLocalOffset, the function returns E_INVALIDARG.
+Memory requirements of the new resource are checked for validation. If its size exceeds the end of pAllocation or required alignment is not fulfilled considering pAllocation->GetOffset() + AllocationLocalOffset, the function returns E_INVALIDARG.
@@ -390,9 +358,9 @@
-Similar to Allocator::CreateAliasingResource, but supports new structure D3D12_RESOURCE_DESC1.
-It internally uses ID3D12Device8::CreatePlacedResource1.
-To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
+Similar to Allocator::CreateAliasingResource, but supports new structure D3D12_RESOURCE_DESC1.
+It internally uses ID3D12Device8::CreatePlacedResource1.
+To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
@@ -451,8 +419,8 @@
Similar to Allocator::CreateAliasingResource1, but there are initial layout instead of state and castable formats list.
-It internally uses ID3D12Device10::CreatePlacedResource2.
-To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
+It internally uses ID3D12Device10::CreatePlacedResource2.
+To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
@@ -524,9 +492,9 @@
Allocates memory and creates a D3D12 resource (buffer or texture). This is the main allocation function.
-The function is similar to ID3D12Device::CreateCommittedResource, but it may really call ID3D12Device::CreatePlacedResource to assign part of a larger, existing memory heap to the new resource, which is the main purpose of this whole library.
-If ppvResource is null, you receive only ppAllocation object from this function. It holds pointer to ID3D12Resource that can be queried using function D3D12MA::Allocation::GetResource(). Reference count of the resource object is 1. It is automatically destroyed when you destroy the allocation object.
-If ppvResource is not null, you receive pointer to the resource next to allocation object. Reference count of the resource object is then increased by calling QueryInterface, so you need to manually Release it along with the allocation.
+The function is similar to ID3D12Device::CreateCommittedResource, but it may really call ID3D12Device::CreatePlacedResource to assign part of a larger, existing memory heap to the new resource, which is the main purpose of this whole library.
+If ppvResource is null, you receive only ppAllocation object from this function. It holds pointer to ID3D12Resource that can be queried using function D3D12MA::Allocation::GetResource(). Reference count of the resource object is 1. It is automatically destroyed when you destroy the allocation object.
+If ppvResource is not null, you receive pointer to the resource next to allocation object. Reference count of the resource object is then increased by calling QueryInterface, so you need to manually Release it along with the allocation.
- Parameters
-
@@ -587,9 +555,9 @@
-Similar to Allocator::CreateResource, but supports new structure D3D12_RESOURCE_DESC1.
-It internally uses ID3D12Device8::CreateCommittedResource2 or ID3D12Device8::CreatePlacedResource1.
-To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
+Similar to Allocator::CreateResource, but supports new structure D3D12_RESOURCE_DESC1.
+It internally uses ID3D12Device8::CreateCommittedResource2 or ID3D12Device8::CreatePlacedResource1.
+To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
@@ -648,8 +616,8 @@
Similar to Allocator::CreateResource2, but there are initial layout instead of state and castable formats list.
-It internally uses ID3D12Device10::CreateCommittedResource3 or ID3D12Device10::CreatePlacedResource2.
-To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
+It internally uses ID3D12Device10::CreateCommittedResource3 or ID3D12Device10::CreatePlacedResource2.
+To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
@@ -700,14 +668,14 @@ IsUMA() == FALSE (discrete graphics card):
-pLocalBudget returns the budget of the video memory.pNonLocalBudget returns the budget of the system memory available for D3D12 resources.- When IsUMA() == FALSE (discrete graphics card):
+- pLocalBudget returns the budget of the video memory.
+- pNonLocalBudget returns the budget of the system memory available for D3D12 resources.
-- When IsUMA()
== TRUE (integrated graphics chip):
-pLocalBudget returns the budget of the shared memory available for all D3D12 resources. All memory is considered "local".pNonLocalBudget is not applicable and returns zeros.- When IsUMA() == TRUE (integrated graphics chip):
+- pLocalBudget returns the budget of the shared memory available for all D3D12 resources. All memory is considered "local".
+- pNonLocalBudget is not applicable and returns zeros.
@@ -753,20 +721,20 @@ - Parameters
-
- memorySegmentGroup use DXGI_MEMORY_SEGMENT_GROUP_LOCAL or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL. memorySegmentGroup use DXGI_MEMORY_SEGMENT_GROUP_LOCAL or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL.
-This information is taken from DXGI_ADAPTER_DESC. It is not recommended to use this number. You should preferably call GetBudget() and limit memory usage to D3D12MA::Budget::BudgetBytes instead.
+This information is taken from DXGI_ADAPTER_DESC. It is not recommended to use this number. You should preferably call GetBudget() and limit memory usage to D3D12MA::Budget::BudgetBytes instead.
-- When IsUMA()
== FALSE (discrete graphics card):
-GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the video memory.GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) returns the size of the system memory available for D3D12 resources.- When IsUMA() == FALSE (discrete graphics card):
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the video memory.
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) returns the size of the system memory available for D3D12 resources.
-- When IsUMA()
== TRUE (integrated graphics chip):
-GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the shared memory available for all D3D12 resources. All memory is considered "local".GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) is not applicable and returns 0. - When IsUMA() == TRUE (integrated graphics chip):
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the shared memory available for all D3D12 resources. All memory is considered "local".
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) is not applicable and returns 0.
@@ -788,7 +756,7 @@
-Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMA was found to be true.
+Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMA was found to be true.
For more information about how to use it, see articles in Microsoft Docs articles:
- "UMA Optimizations: CPU Accessible Textures and Standard Swizzle"
@@ -814,8 +782,8 @@
Returns true if GPU Upload Heaps are supported on the current system.
-When true, you can use D3D12_HEAP_TYPE_GPU_UPLOAD.
-This flag is fetched from D3D12_FEATURE_D3D12_OPTIONS16::GPUUploadHeapSupported.
+When true, you can use D3D12_HEAP_TYPE_GPU_UPLOAD.
+This flag is fetched from D3D12_FEATURE_D3D12_OPTIONS16::GPUUploadHeapSupported.
@@ -834,7 +802,7 @@
-Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::UMA was found to be true.
+Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::UMA was found to be true.
For more information about how to use it, see articles in Microsoft Docs articles:
- "UMA Optimizations: CPU Accessible Textures and Standard Swizzle"
@@ -870,7 +838,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html
index 4049a20..6cfb1dd 100644
--- a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html
index 405cb9f..7ab0038 100644
--- a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html
+++ b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DefragmentationContext Class Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,22 +93,19 @@
-
+
Public Member Functions
HRESULT BeginPass (DEFRAGMENTATION_PASS_MOVE_INFO *pPassInfo) Starts single defragmentation pass.
HRESULT EndPass (DEFRAGMENTATION_PASS_MOVE_INFO *pPassInfo) Ends single defragmentation pass.
void GetStats (DEFRAGMENTATION_STATS *pStats) Returns statistics of the defragmentation performed so far.
-Detailed Description
+Detailed Description
Represents defragmentation process in progress.
You can create this object using Allocator::BeginDefragmentation (for default pools) or Pool::BeginDefragmentation (for a custom pool).
-Member Function Documentation
+Member Function Documentation
◆ BeginPass()
@@ -145,8 +129,8 @@ - Returns
-S_OK if no more moves are possible. Then you can omit call to DefragmentationContext::EndPass() and simply end whole defragmentation.S_FALSE if there are pending moves returned in pPassInfo. You need to perform them, call DefragmentationContext::EndPass(), and then preferably try another pass with DefragmentationContext::BeginPass(). - S_OK if no more moves are possible. Then you can omit call to DefragmentationContext::EndPass() and simply end whole defragmentation.
+- S_FALSE if there are pending moves returned in pPassInfo. You need to perform them, call DefragmentationContext::EndPass(), and then preferably try another pass with DefragmentationContext::BeginPass().
- Returns
- Returns
S_OK if no more moves are possible or S_FALSE if more defragmentations are possible.
-Ends incremental defragmentation pass and commits all defragmentation moves from pPassInfo. After this call:
+- Returns
- Returns S_OK if no more moves are possible or S_FALSE if more defragmentations are possible.
+Ends incremental defragmentation pass and commits all defragmentation moves from pPassInfo. After this call:
-- Allocation at
pPassInfo[i].pSrcAllocation that had pPassInfo[i].Operation == DEFRAGMENTATION_MOVE_OPERATION_COPY (which is the default) will be pointing to the new destination place.
-- Allocation at
pPassInfo[i].pSrcAllocation that had pPassInfo[i].operation == DEFRAGMENTATION_MOVE_OPERATION_DESTROY will be released.
+- Allocation at pPassInfo[i].pSrcAllocation that had pPassInfo[i].Operation == DEFRAGMENTATION_MOVE_OPERATION_COPY (which is the default) will be pointing to the new destination place.
+- Allocation at pPassInfo[i].pSrcAllocation that had pPassInfo[i].operation == DEFRAGMENTATION_MOVE_OPERATION_DESTROY will be released.
If no more moves are possible you can end whole defragmentation.
@@ -209,7 +193,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_pool-members.html b/docs/html/class_d3_d12_m_a_1_1_pool-members.html
index e500fb5..9acf601 100644
--- a/docs/html/class_d3_d12_m_a_1_1_pool-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_pool-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -104,7 +91,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_pool.html b/docs/html/class_d3_d12_m_a_1_1_pool.html
index 7aabe1c..07742d9 100644
--- a/docs/html/class_d3_d12_m_a_1_1_pool.html
+++ b/docs/html/class_d3_d12_m_a_1_1_pool.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Pool Class Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,32 +93,26 @@
-
+
Public Member Functions
POOL_DESC GetDesc () const Returns copy of parameters of the pool.
void GetStatistics (Statistics *pStats) Retrieves basic statistics of the custom pool that are fast to calculate.
void CalculateStatistics (DetailedStatistics *pStats) Retrieves detailed statistics of the custom pool that are slower to calculate.
void SetName (LPCWSTR Name) Associates a name with the pool. This name is for use in debug diagnostics and tools.
LPCWSTR GetName () const Returns the name associated with the pool object.
HRESULT BeginDefragmentation (const DEFRAGMENTATION_DESC *pDesc, DefragmentationContext **ppContext) Begins defragmentation process of the current pool.
-Detailed Description
+Detailed Description
Custom memory pool.
Represents a separate set of heaps (memory blocks) that can be used to create D3D12MA::Allocation-s and resources in it. Usually there is no need to create custom pools - creating resources in default pool is sufficient.
To create custom pool, fill D3D12MA::POOL_DESC and call D3D12MA::Allocator::CreatePool.
-Member Function Documentation
+Member Function Documentation
◆ BeginDefragmentation()
@@ -160,8 +141,8 @@ - Returns
-S_OK if defragmentation can begin.E_NOINTERFACE if defragmentation is not supported.- S_OK if defragmentation can begin.
+- E_NOINTERFACE if defragmentation is not supported.
For more information about defragmentation, see documentation chapter: Defragmentation.
@@ -276,7 +257,7 @@ Name can be NULL.
@@ -286,7 +267,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html b/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html
index 190326b..1e40ead 100644
--- a/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -109,7 +96,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_virtual_block.html b/docs/html/class_d3_d12_m_a_1_1_virtual_block.html
index 5f6a3f2..0cb9114 100644
--- a/docs/html/class_d3_d12_m_a_1_1_virtual_block.html
+++ b/docs/html/class_d3_d12_m_a_1_1_virtual_block.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualBlock Class Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,45 +93,35 @@
-
+
Public Member Functions
BOOL IsEmpty () const Returns true if the block is empty - contains 0 allocations.
void GetAllocationInfo (VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) const Returns information about an allocation - its offset, size and custom pointer.
HRESULT Allocate (const VIRTUAL_ALLOCATION_DESC *pDesc, VirtualAllocation *pAllocation, UINT64 *pOffset) Creates new allocation.
void FreeAllocation (VirtualAllocation allocation) Frees the allocation.
void Clear () Frees all the allocations.
void SetAllocationPrivateData (VirtualAllocation allocation, void *pPrivateData) Changes custom pointer for an allocation to a new value.
void GetStatistics (Statistics *pStats) const Retrieves basic statistics of the virtual block that are fast to calculate.
void CalculateStatistics (DetailedStatistics *pStats) const Retrieves detailed statistics of the virtual block that are slower to calculate.
void BuildStatsString (WCHAR **ppStatsString) const Builds and returns statistics as a string in JSON format, including the list of allocations with their parameters.
void FreeStatsString (WCHAR *pStatsString) const Frees memory of a string returned from VirtualBlock::BuildStatsString.
-Detailed Description
+Detailed Description
Represents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory.
This class allows to use the core algorithm of the library custom allocations e.g. CPU memory or sub-allocation regions inside a single GPU buffer.
-To create this object, fill in D3D12MA::VIRTUAL_BLOCK_DESC and call CreateVirtualBlock(). To destroy it, call its method VirtualBlock::Release(). You need to free all the allocations within this block or call Clear() before destroying it.
+To create this object, fill in D3D12MA::VIRTUAL_BLOCK_DESC and call CreateVirtualBlock(). To destroy it, call its method VirtualBlock::Release(). You need to free all the allocations within this block or call Clear() before destroying it.
This object is not thread-safe - should not be used from multiple threads simultaneously, must be synchronized externally.
-Member Function Documentation
+Member Function Documentation
◆ Allocate()
@@ -178,8 +155,8 @@ - Returns
S_OK if allocation succeeded, E_OUTOFMEMORY if it failed.If the allocation failed, pAllocation->AllocHandle is set to 0 and pOffset, if not null, is set to UINT64_MAX.
+- Returns
- S_OK if allocation succeeded, E_OUTOFMEMORY if it failed.
+If the allocation failed, pAllocation->AllocHandle is set to 0 and pOffset, if not null, is set to UINT64_MAX.
@@ -268,7 +245,7 @@
Frees the allocation.
-Calling this function with allocation.AllocHandle == 0 is correct and does nothing.
+Calling this function with allocation.AllocHandle == 0 is correct and does nothing.
@@ -387,7 +364,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/classes.html b/docs/html/classes.html
index 3b8ddf2..e85eb86 100644
--- a/docs/html/classes.html
+++ b/docs/html/classes.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Index
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/configuration.html b/docs/html/configuration.html
index 8eeaa50..65d7bdd 100644
--- a/docs/html/configuration.html
+++ b/docs/html/configuration.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Configuration
-
-
@@ -33,33 +31,22 @@
-
+
-
- Configuration
+ Configuration
-Please check file D3D12MemAlloc.cpp lines between "Configuration Begin" and "Configuration End" to find macros that you can define to change the behavior of the library, primarily for debugging purposes.
-
+Please check file D3D12MemAlloc.cpp lines between "Configuration Begin" and "Configuration End" to find macros that you can define to change the behavior of the library, primarily for debugging purposes.
+
Custom CPU memory allocator
-If you use custom allocator for CPU memory rather than default C++ operator new and delete or malloc and free functions, you can make this library using your allocator as well by filling structure D3D12MA::ALLOCATION_CALLBACKS and passing it as optional member D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks. Functions pointed there will be used by the library to make any CPU-side allocations. Example:
+If you use custom allocator for CPU memory rather than default C++ operator new and delete or malloc and free functions, you can make this library using your allocator as well by filling structure D3D12MA::ALLOCATION_CALLBACKS and passing it as optional member D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks. Functions pointed there will be used by the library to make any CPU-side allocations. Example:
#include <malloc.h>
void* CustomAllocate(size_t Size, size_t Alignment, void* pPrivateData)
@@ -133,11 +120,11 @@
ALLOCATOR_FLAGS FlagsFlags for the entire allocator.Definition D3D12MemAlloc.h:1126
-
+
Debug margins
-
By default, allocations are laid out in memory blocks next to each other if possible (considering required alignment returned by ID3D12Device::GetResourceAllocationInfo).
+By default, allocations are laid out in memory blocks next to each other if possible (considering required alignment returned by ID3D12Device::GetResourceAllocationInfo).
-Define macro D3D12MA_DEBUG_MARGIN to some non-zero value (e.g. 16) inside "D3D12MemAlloc.cpp" to enforce specified number of bytes as a margin after every allocation.
+Define macro D3D12MA_DEBUG_MARGIN to some non-zero value (e.g. 16) inside "D3D12MemAlloc.cpp" to enforce specified number of bytes as a margin after every allocation.
If your bug goes away after enabling margins, it means it may be caused by memory being overwritten outside of allocation boundaries. It is not 100% certain though. Change in application behavior may also be caused by different order and distribution of allocations across memory blocks after margins are applied.
Margins work with all memory heap types.
@@ -149,7 +136,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/custom_pools.html b/docs/html/custom_pools.html
index 9112b38..0bfd570 100644
--- a/docs/html/custom_pools.html
+++ b/docs/html/custom_pools.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Custom memory pools
-
-
@@ -33,33 +31,22 @@
-
+
-
- Custom memory pools
+ Custom memory pools
-A "pool" is a collection of memory blocks that share certain properties. Allocator creates 3 default pools: for D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK. A default pool automatically grows in size. Size of allocated blocks is also variable and managed automatically. Typical allocations are created in these pools. You can also create custom pools.
-
+A "pool" is a collection of memory blocks that share certain properties. Allocator creates 3 default pools: for D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK. A default pool automatically grows in size. Size of allocated blocks is also variable and managed automatically. Typical allocations are created in these pools. You can also create custom pools.
+
Usage
To create a custom pool, fill in structure D3D12MA::POOL_DESC and call function D3D12MA::Allocator::CreatePool to obtain object D3D12MA::Pool. Example:
All allocations must be released before releasing the pool. The pool must be released before relasing the allocator.
alloc->Release();
pool->Release();
-
+
Features and benefits
While it is recommended to use default pools whenever possible for simplicity and to give the allocator more opportunities for internal optimizations, custom pools may be useful in following cases:
- To keep some resources separate from others in memory.
- To keep track of memory usage of just a specific group of resources. Statistics can be queried using D3D12MA::Pool::CalculateStatistics.
-- To use specific size of a memory block (
ID3D12Heap). To set it, use member D3D12MA::POOL_DESC::BlockSize. When set to 0, the library uses automatically determined, variable block sizes.
+- To use specific size of a memory block (ID3D12Heap). To set it, use member D3D12MA::POOL_DESC::BlockSize. When set to 0, the library uses automatically determined, variable block sizes.
- To reserve some minimum amount of memory allocated. To use it, set member D3D12MA::POOL_DESC::MinBlockCount.
- To limit maximum amount of memory allocated. To use it, set member D3D12MA::POOL_DESC::MaxBlockCount.
-- To use extended parameters of the D3D12 memory allocation. While resources created from default pools can only specify
D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK, a custom pool may use non-standard D3D12_HEAP_PROPERTIES (member D3D12MA::POOL_DESC::HeapProperties) and D3D12_HEAP_FLAGS (D3D12MA::POOL_DESC::HeapFlags), which is useful e.g. for cross-adapter sharing or UMA (see also D3D12MA::Allocator::IsUMA).
+- To use extended parameters of the D3D12 memory allocation. While resources created from default pools can only specify D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK, a custom pool may use non-standard D3D12_HEAP_PROPERTIES (member D3D12MA::POOL_DESC::HeapProperties) and D3D12_HEAP_FLAGS (D3D12MA::POOL_DESC::HeapFlags), which is useful e.g. for cross-adapter sharing or UMA (see also D3D12MA::Allocator::IsUMA).
New versions of this library support creating committed allocations in custom pools. It is supported only when D3D12MA::POOL_DESC::BlockSize = 0. To use this feature, set D3D12MA::ALLOCATION_DESC::CustomPool to the pointer to your custom pool and D3D12MA::ALLOCATION_DESC::Flags to D3D12MA::ALLOCATION_FLAG_COMMITTED. Example:
ALLOCATION_DESC allocDesc = {};
@@ -136,12 +123,12 @@
ID3D12Resource* res;
hr = allocator->CreateResource(&allocDesc, &resDesc,
D3D12_RESOURCE_STATE_GENERIC_READ, NULL, &alloc, IID_PPV_ARGS(&res));
-
This feature may seem unnecessary, but creating committed allocations from custom pools may be useful in some cases, e.g. to have separate memory usage statistics for some group of resources or to use extended allocation parameters, like custom D3D12_HEAP_PROPERTIES, which are available only in custom pools.
+This feature may seem unnecessary, but creating committed allocations from custom pools may be useful in some cases, e.g. to have separate memory usage statistics for some group of resources or to use extended allocation parameters, like custom D3D12_HEAP_PROPERTIES, which are available only in custom pools.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/defragmentation.html b/docs/html/defragmentation.html
index d68a400..b82dbde 100644
--- a/docs/html/defragmentation.html
+++ b/docs/html/defragmentation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Defragmentation
-
-
@@ -33,33 +31,22 @@
-
+
-
- Defragmentation
+ Defragmentation
Interleaved allocations and deallocations of many objects of varying size can cause fragmentation over time, which can lead to a situation where the library is unable to find a continuous range of free memory for a new allocation despite there is enough free space, just scattered across many small free ranges between existing allocations.
-To mitigate this problem, you can use defragmentation feature. It doesn't happen automatically though and needs your cooperation, because D3D12MA is a low level library that only allocates memory. It cannot recreate buffers and textures in a new place as it doesn't remember the contents of D3D12_RESOURCE_DESC structure. It cannot copy their contents as it doesn't record any commands to a command list.
+To mitigate this problem, you can use defragmentation feature. It doesn't happen automatically though and needs your cooperation, because D3D12MA is a low level library that only allocates memory. It cannot recreate buffers and textures in a new place as it doesn't remember the contents of D3D12_RESOURCE_DESC structure. It cannot copy their contents as it doesn't record any commands to a command list.
Example:
D3D12MA::DEFRAGMENTATION_DESC defragDesc = {};
defragDesc.Flags = D3D12MA::DEFRAGMENTATION_FLAG_ALGORITHM_FAST;
@@ -162,11 +149,11 @@
Parameters for incremental defragmentation steps.Definition D3D12MemAlloc.h:768
DEFRAGMENTATION_MOVE * pMovesArray of moves to be performed by the user in the current defragmentation pass.Definition D3D12MemAlloc.h:792
UINT32 MoveCountNumber of elements in the pMoves array.Definition D3D12MemAlloc.h:770
-Although functions like D3D12MA::Allocator::CreateResource() create an allocation and a buffer/texture at once, these are just a shortcut for allocating memory and creating a placed resource. Defragmentation works on memory allocations only. You must handle the rest manually. Defragmentation is an iterative process that should repreat "passes" as long as related functions return S_FALSE not S_OK. In each pass:
+Although functions like D3D12MA::Allocator::CreateResource() create an allocation and a buffer/texture at once, these are just a shortcut for allocating memory and creating a placed resource. Defragmentation works on memory allocations only. You must handle the rest manually. Defragmentation is an iterative process that should repreat "passes" as long as related functions return S_FALSE not S_OK. In each pass:
- D3D12MA::DefragmentationContext::BeginPass() function call:
- Calculates and returns the list of allocations to be moved in this pass. Note this can be a time-consuming process.
-- Reserves destination memory for them by creating temporary destination allocations that you can query for their
ID3D12Heap + offset using methods like D3D12MA::Allocation::GetHeap().
+- Reserves destination memory for them by creating temporary destination allocations that you can query for their ID3D12Heap + offset using methods like D3D12MA::Allocation::GetHeap().
- Inside the pass, you should:
@@ -179,40 +166,40 @@
- D3D12MA::DefragmentationContext::EndPass() function call:
- Frees the source memory reserved for the allocations that are moved.
- Modifies source D3D12MA::Allocation objects that are moved to point to the destination reserved memory and destination resource, while source resource is released.
-- Frees
ID3D12Heap blocks that became empty.
+- Frees ID3D12Heap blocks that became empty.
-Defragmentation algorithm tries to move all suitable allocations. You can, however, refuse to move some of them inside a defragmentation pass, by setting pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This is not recommended and may result in suboptimal packing of the allocations after defragmentation. If you cannot ensure any allocation can be moved, it is better to keep movable allocations separate in a custom pool.
+Defragmentation algorithm tries to move all suitable allocations. You can, however, refuse to move some of them inside a defragmentation pass, by setting pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This is not recommended and may result in suboptimal packing of the allocations after defragmentation. If you cannot ensure any allocation can be moved, it is better to keep movable allocations separate in a custom pool.
Inside a pass, for each allocation that should be moved:
-- You should copy its data from the source to the destination place by calling e.g.
CopyResource().
+- You should copy its data from the source to the destination place by calling e.g. CopyResource().
- You need to make sure these commands finished executing before the source buffers/textures are released by D3D12MA::DefragmentationContext::EndPass().
- If a resource doesn't contain any meaningful data, e.g. it is a transient render-target texture to be cleared, filled, and used temporarily in each rendering frame, you can just recreate this texture without copying its data.
-- If the resource is in
D3D12_HEAP_TYPE_READBACK memory, you can copy its data on the CPU using memcpy().
-- If you cannot move the allocation, you can set
pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This will cancel the move.
+- If the resource is in D3D12_HEAP_TYPE_READBACK memory, you can copy its data on the CPU using memcpy().
+- If you cannot move the allocation, you can set pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This will cancel the move.
- D3D12MA::DefragmentationContext::EndPass() will then free the destination memory not the source memory of the allocation, leaving it unchanged.
-- If you decide the allocation is unimportant and can be destroyed instead of moved (e.g. it wasn't used for long time), you can set
pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY.
+- If you decide the allocation is unimportant and can be destroyed instead of moved (e.g. it wasn't used for long time), you can set pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY.
- D3D12MA::DefragmentationContext::EndPass() will then free both source and destination memory, and will destroy the source D3D12MA::Allocation object.
You can defragment a specific custom pool by calling D3D12MA::Pool::BeginDefragmentation or all the default pools by calling D3D12MA::Allocator::BeginDefragmentation (like in the example above).
-Defragmentation is always performed in each pool separately. Allocations are never moved between different heap types. The size of the destination memory reserved for a moved allocation is the same as the original one. Alignment of an allocation as it was determined using GetResourceAllocationInfo() is also respected after defragmentation. Buffers/textures should be recreated with the same D3D12_RESOURCE_DESC parameters as the original ones.
+Defragmentation is always performed in each pool separately. Allocations are never moved between different heap types. The size of the destination memory reserved for a moved allocation is the same as the original one. Alignment of an allocation as it was determined using GetResourceAllocationInfo() is also respected after defragmentation. Buffers/textures should be recreated with the same D3D12_RESOURCE_DESC parameters as the original ones.
You can perform the defragmentation incrementally to limit the number of allocations and bytes to be moved in each pass, e.g. to call it in sync with render frames and not to experience too big hitches. See members: D3D12MA::DEFRAGMENTATION_DESC::MaxBytesPerPass, D3D12MA::DEFRAGMENTATION_DESC::MaxAllocationsPerPass.
Thread safety: It is safe to perform the defragmentation asynchronously to render frames and other Direct3D 12 and D3D12MA usage, possibly from multiple threads, with the exception that allocations returned in D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO::pMoves shouldn't be released until the defragmentation pass is ended. During the call to D3D12MA::DefragmentationContext::BeginPass(), any operations on the memory pool affected by the defragmentation are blocked by a mutex.
-What it means in practice is that you shouldn't free any allocations from the defragmented pool since the moment a call to BeginPass begins. Otherwise, a thread performing the allocation->Release() would block for the time BeginPass executes and then free the allocation when it finishes, while the allocation could have ended up on the list of allocations to move. A solution to freeing allocations during defragmentation is to find such allocation on the list pass.pMoves[i] and set its operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY instead of calling allocation->Release(), or simply deferring the release to the time after defragmentation finished.
+What it means in practice is that you shouldn't free any allocations from the defragmented pool since the moment a call to BeginPass begins. Otherwise, a thread performing the allocation->Release() would block for the time BeginPass executes and then free the allocation when it finishes, while the allocation could have ended up on the list of allocations to move. A solution to freeing allocations during defragmentation is to find such allocation on the list pass.pMoves[i] and set its operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY instead of calling allocation->Release(), or simply deferring the release to the time after defragmentation finished.
Mapping is out of scope of this library and so it is not preserved after an allocation is moved during defragmentation. You need to map the new resource yourself if needed.
- Note
- Defragmentation is not supported in custom pools created with D3D12MA::POOL_FLAG_ALGORITHM_LINEAR.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html b/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
index fa88354..6e6d46e 100644
--- a/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
+++ b/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: C:/Code/D3D12MemoryAllocator/REPO/include Directory Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -92,15 +79,14 @@
-
+
Files
D3D12MemAlloc.h D3D12MemAlloc.h
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/doxygen.css b/docs/html/doxygen.css
index 4947e24..5d2eecd 100644
--- a/docs/html/doxygen.css
+++ b/docs/html/doxygen.css
@@ -1,11 +1,12 @@
-/* The standard CSS for doxygen 1.13.2*/
+/* The standard CSS for doxygen 1.14.0*/
html {
/* page base colors */
--page-background-color: white;
--page-foreground-color: black;
--page-link-color: #3D578C;
---page-visited-link-color: #4665A2;
+--page-visited-link-color: #3D578C;
+--page-external-link-color: #334975;
/* index */
--index-odd-item-bg-color: #F8F9FC;
@@ -16,46 +17,50 @@ html {
/* header */
--header-background-color: #F9FAFC;
--header-separator-color: #C4CFE5;
---header-gradient-image: url('nav_h.png');
---group-header-separator-color: #879ECB;
+--group-header-separator-color: #D9E0EE;
--group-header-color: #354C7B;
--inherit-header-color: gray;
--footer-foreground-color: #2A3D61;
---footer-logo-width: 104px;
+--footer-logo-width: 75px;
--citation-label-color: #334975;
--glow-color: cyan;
--title-background-color: white;
---title-separator-color: #5373B4;
+--title-separator-color: #C4CFE5;
--directory-separator-color: #9CAFD4;
--separator-color: #4A6AAA;
--blockquote-background-color: #F7F8FB;
--blockquote-border-color: #9CAFD4;
---scrollbar-thumb-color: #9CAFD4;
+--scrollbar-thumb-color: #C4CFE5;
--scrollbar-background-color: #F9FAFC;
--icon-background-color: #728DC1;
--icon-foreground-color: white;
+/*
--icon-doc-image: url('doc.svg');
--icon-folder-open-image: url('folderopen.svg');
---icon-folder-closed-image: url('folderclosed.svg');
+--icon-folder-closed-image: url('folderclosed.svg');*/
+--icon-folder-open-fill-color: #C4CFE5;
+--icon-folder-fill-color: #D8DFEE;
+--icon-folder-border-color: #4665A2;
+--icon-doc-fill-color: #D8DFEE;
+--icon-doc-border-color: #4665A2;
/* brief member declaration list */
--memdecl-background-color: #F9FAFC;
--memdecl-separator-color: #DEE4F0;
--memdecl-foreground-color: #555;
--memdecl-template-color: #4665A2;
+--memdecl-border-color: #D5DDEC;
/* detailed member list */
--memdef-border-color: #A8B8D9;
--memdef-title-background-color: #E2E8F2;
---memdef-title-gradient-image: url('nav_f.png');
---memdef-proto-background-color: #DFE5F1;
+--memdef-proto-background-color: #EEF1F7;
--memdef-proto-text-color: #253555;
---memdef-proto-text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
--memdef-doc-background-color: white;
--memdef-param-name-color: #602020;
--memdef-template-color: #4665A2;
@@ -74,29 +79,34 @@ html {
/** navigation bar/tree/menu */
--nav-background-color: #F9FAFC;
--nav-foreground-color: #364D7C;
---nav-gradient-image: url('tab_b.png');
---nav-gradient-hover-image: url('tab_h.png');
---nav-gradient-active-image: url('tab_a.png');
---nav-gradient-active-image-parent: url("../tab_a.png");
---nav-separator-image: url('tab_s.png');
---nav-breadcrumb-image: url('bc_s.png');
---nav-breadcrumb-border-color: #C2CDE4;
---nav-splitbar-image: url('splitbar.png');
+--nav-border-color: #C4CFE5;
+--nav-breadcrumb-separator-color: #C4CFE5;
+--nav-breadcrumb-active-bg: #EEF1F7;
+--nav-breadcrumb-color: #354C7B;
+--nav-breadcrumb-border-color: #E1E7F2;
+--nav-splitbar-bg-color: #DCE2EF;
+--nav-splitbar-handle-color: #9CAFD4;
--nav-font-size-level1: 13px;
--nav-font-size-level2: 10px;
--nav-font-size-level3: 9px;
--nav-text-normal-color: #283A5D;
--nav-text-hover-color: white;
--nav-text-active-color: white;
---nav-text-normal-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
---nav-text-hover-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
---nav-text-active-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
--nav-menu-button-color: #364D7C;
--nav-menu-background-color: white;
--nav-menu-foreground-color: #555555;
+--nav-menu-active-bg: #DCE2EF;
+--nav-menu-active-color: #9CAFD4;
--nav-menu-toggle-color: rgba(255, 255, 255, 0.5);
---nav-arrow-color: #9CAFD4;
---nav-arrow-selected-color: #9CAFD4;
+--nav-arrow-color: #B6C4DF;
+--nav-arrow-selected-color: #90A5CE;
+
+/* sync icon */
+--sync-icon-border-color: #C4CFE5;
+--sync-icon-background-color: #F9FAFC;
+--sync-icon-selected-background-color: #EEF1F7;
+--sync-icon-color: #C4CFE5;
+--sync-icon-selected-color: #6884BD;
/* table of contents */
--toc-background-color: #F4F6FA;
@@ -107,18 +117,20 @@ html {
/** search field */
--search-background-color: white;
--search-foreground-color: #909090;
---search-magnification-image: url('mag.svg');
---search-magnification-select-image: url('mag_sel.svg');
--search-active-color: black;
---search-filter-background-color: #F9FAFC;
+--search-filter-background-color: rgba(255,255,255,.7);
+--search-filter-backdrop-filter: blur(4px);
--search-filter-foreground-color: black;
---search-filter-border-color: #90A5CE;
+--search-filter-border-color: rgba(150,150,150,.4);
--search-filter-highlight-text-color: white;
--search-filter-highlight-bg-color: #3D578C;
--search-results-foreground-color: #425E97;
---search-results-background-color: #EEF1F7;
---search-results-border-color: black;
---search-box-shadow: inset 0.5px 0.5px 3px 0px #555;
+--search-results-background-color: rgba(255,255,255,.8);
+--search-results-backdrop-filter: blur(4px);
+--search-results-border-color: rgba(150,150,150,.4);
+--search-box-border-color: #B6C4DF;
+--search-close-icon-bg-color: #A0A0A0;
+--search-close-icon-fg-color: white;
/** code fragments */
--code-keyword-color: #008000;
@@ -147,23 +159,21 @@ html {
--fragment-lineno-link-hover-bg-color: #C8C8C8;
--fragment-copy-ok-color: #2EC82E;
--tooltip-foreground-color: black;
---tooltip-background-color: white;
---tooltip-border-color: gray;
+--tooltip-background-color: rgba(255,255,255,0.8);
+--tooltip-arrow-background-color: white;
+--tooltip-border-color: rgba(150,150,150,0.7);
+--tooltip-backdrop-filter: blur(3px);
--tooltip-doc-color: grey;
--tooltip-declaration-color: #006318;
--tooltip-link-color: #4665A2;
---tooltip-shadow: 1px 1px 7px gray;
+--tooltip-shadow: 0 4px 8px 0 rgba(0,0,0,.25);
--fold-line-color: #808080;
---fold-minus-image: url('minus.svg');
---fold-plus-image: url('plus.svg');
---fold-minus-image-relpath: url('../../minus.svg');
---fold-plus-image-relpath: url('../../plus.svg');
/** font-family */
---font-family-normal: Roboto,sans-serif;
+--font-family-normal: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-monospace: 'JetBrains Mono',Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace,fixed;
--font-family-nav: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
---font-family-title: Tahoma,Arial,sans-serif;
+--font-family-title: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-toc: Verdana,'DejaVu Sans',Geneva,sans-serif;
--font-family-search: Arial,Verdana,sans-serif;
--font-family-icon: Arial,Helvetica;
@@ -201,7 +211,8 @@ html {
--page-background-color: black;
--page-foreground-color: #C9D1D9;
--page-link-color: #90A5CE;
---page-visited-link-color: #A3B4D7;
+--page-visited-link-color: #90A5CE;
+--page-external-link-color: #A3B4D7;
/* index */
--index-odd-item-bg-color: #0B101A;
@@ -212,8 +223,7 @@ html {
/* header */
--header-background-color: #070B11;
--header-separator-color: #141C2E;
---header-gradient-image: url('nav_hd.png');
---group-header-separator-color: #283A5D;
+--group-header-separator-color: #1D2A43;
--group-header-color: #90A5CE;
--inherit-header-color: #A0A0A0;
@@ -223,35 +233,36 @@ html {
--glow-color: cyan;
--title-background-color: #090D16;
---title-separator-color: #354C79;
+--title-separator-color: #212F4B;
--directory-separator-color: #283A5D;
--separator-color: #283A5D;
--blockquote-background-color: #101826;
--blockquote-border-color: #283A5D;
---scrollbar-thumb-color: #283A5D;
+--scrollbar-thumb-color: #2C3F65;
--scrollbar-background-color: #070B11;
--icon-background-color: #334975;
--icon-foreground-color: #C4CFE5;
---icon-doc-image: url('docd.svg');
---icon-folder-open-image: url('folderopend.svg');
---icon-folder-closed-image: url('folderclosedd.svg');
+--icon-folder-open-fill-color: #4665A2;
+--icon-folder-fill-color: #5373B4;
+--icon-folder-border-color: #C4CFE5;
+--icon-doc-fill-color: #6884BD;
+--icon-doc-border-color: #C4CFE5;
/* brief member declaration list */
--memdecl-background-color: #0B101A;
--memdecl-separator-color: #2C3F65;
--memdecl-foreground-color: #BBB;
--memdecl-template-color: #7C95C6;
+--memdecl-border-color: #233250;
/* detailed member list */
--memdef-border-color: #233250;
--memdef-title-background-color: #1B2840;
---memdef-title-gradient-image: url('nav_fd.png');
--memdef-proto-background-color: #19243A;
--memdef-proto-text-color: #9DB0D4;
---memdef-proto-text-shadow: 0px 1px 1px rgba(0, 0, 0, 0.9);
--memdef-doc-background-color: black;
--memdef-param-name-color: #D28757;
--memdef-template-color: #7C95C6;
@@ -270,29 +281,34 @@ html {
/** navigation bar/tree/menu */
--nav-background-color: #101826;
--nav-foreground-color: #364D7C;
---nav-gradient-image: url('tab_bd.png');
---nav-gradient-hover-image: url('tab_hd.png');
---nav-gradient-active-image: url('tab_ad.png');
---nav-gradient-active-image-parent: url("../tab_ad.png");
---nav-separator-image: url('tab_sd.png');
---nav-breadcrumb-image: url('bc_sd.png');
+--nav-border-color: #212F4B;
+--nav-breadcrumb-separator-color: #212F4B;
+--nav-breadcrumb-active-bg: #1D2A43;
+--nav-breadcrumb-color: #90A5CE;
--nav-breadcrumb-border-color: #2A3D61;
---nav-splitbar-image: url('splitbard.png');
+--nav-splitbar-bg-color: #283A5D;
+--nav-splitbar-handle-color: #4665A2;
--nav-font-size-level1: 13px;
--nav-font-size-level2: 10px;
--nav-font-size-level3: 9px;
--nav-text-normal-color: #B6C4DF;
--nav-text-hover-color: #DCE2EF;
--nav-text-active-color: #DCE2EF;
---nav-text-normal-shadow: 0px 1px 1px black;
---nav-text-hover-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
---nav-text-active-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
--nav-menu-button-color: #B6C4DF;
--nav-menu-background-color: #05070C;
--nav-menu-foreground-color: #BBBBBB;
+--nav-menu-active-bg: #1D2A43;
+--nav-menu-active-color: #C9D3E7;
--nav-menu-toggle-color: rgba(255, 255, 255, 0.2);
---nav-arrow-color: #334975;
---nav-arrow-selected-color: #90A5CE;
+--nav-arrow-color: #4665A2;
+--nav-arrow-selected-color: #6884BD;
+
+/* sync icon */
+--sync-icon-border-color: #212F4B;
+--sync-icon-background-color: #101826;
+--sync-icon-selected-background-color: #1D2A43;
+--sync-icon-color: #4665A2;
+--sync-icon-selected-color: #5373B4;
/* table of contents */
--toc-background-color: #151E30;
@@ -303,18 +319,20 @@ html {
/** search field */
--search-background-color: black;
--search-foreground-color: #C5C5C5;
---search-magnification-image: url('mag_d.svg');
---search-magnification-select-image: url('mag_seld.svg');
---search-active-color: #C5C5C5;
+--search-active-color: #F5F5F5;
--search-filter-background-color: #101826;
--search-filter-foreground-color: #90A5CE;
+--search-filter-backdrop-filter: none;
--search-filter-border-color: #7C95C6;
--search-filter-highlight-text-color: #BCC9E2;
--search-filter-highlight-bg-color: #283A5D;
---search-results-background-color: #101826;
+--search-results-background-color: black;
--search-results-foreground-color: #90A5CE;
---search-results-border-color: #7C95C6;
---search-box-shadow: inset 0.5px 0.5px 3px 0px #2F436C;
+--search-results-backdrop-filter: none;
+--search-results-border-color: #334975;
+--search-box-border-color: #334975;
+--search-close-icon-bg-color: #909090;
+--search-close-icon-fg-color: black;
/** code fragments */
--code-keyword-color: #CC99CD;
@@ -344,22 +362,20 @@ html {
--fragment-copy-ok-color: #0EA80E;
--tooltip-foreground-color: #C9D1D9;
--tooltip-background-color: #202020;
+--tooltip-arrow-background-color: #202020;
+--tooltip-backdrop-filter: none;
--tooltip-border-color: #C9D1D9;
--tooltip-doc-color: #D9E1E9;
--tooltip-declaration-color: #20C348;
--tooltip-link-color: #79C0FF;
--tooltip-shadow: none;
--fold-line-color: #808080;
---fold-minus-image: url('minusd.svg');
---fold-plus-image: url('plusd.svg');
---fold-minus-image-relpath: url('../../minusd.svg');
---fold-plus-image-relpath: url('../../plusd.svg');
/** font-family */
---font-family-normal: Roboto,sans-serif;
+--font-family-normal: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-monospace: 'JetBrains Mono',Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace,fixed;
--font-family-nav: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
---font-family-title: Tahoma,Arial,sans-serif;
+--font-family-title: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-toc: Verdana,'DejaVu Sans',Geneva,sans-serif;
--font-family-search: Arial,Verdana,sans-serif;
--font-family-icon: Arial,Helvetica;
@@ -389,8 +405,8 @@ html {
--invariant-color-text: #cceed5;
}}
body {
- background-color: var(--page-background-color);
- color: var(--page-foreground-color);
+ background-color: var(--page-background-color);
+ color: var(--page-foreground-color);
}
body, table, div, p, dl {
@@ -400,13 +416,22 @@ body, table, div, p, dl {
line-height: 22px;
}
+body.resizing {
+ user-select: none;
+ -webkit-user-select: none;
+}
+
+#doc-content {
+ scrollbar-width: thin;
+}
+
/* @group Heading Levels */
.title {
font-family: var(--font-family-normal);
line-height: 28px;
- font-size: 150%;
- font-weight: bold;
+ font-size: 160%;
+ font-weight: 400;
margin: 10px 2px;
}
@@ -415,7 +440,10 @@ h1.groupheader {
}
h2.groupheader {
- border-bottom: 1px solid var(--group-header-separator-color);
+ box-shadow: 12px 0 var(--page-background-color),
+ -12px 0 var(--page-background-color),
+ 12px 1px var(--group-header-separator-color),
+ -12px 1px var(--group-header-separator-color);
color: var(--group-header-color);
font-size: 150%;
font-weight: normal;
@@ -425,6 +453,13 @@ h2.groupheader {
width: 100%;
}
+td h2.groupheader {
+ box-shadow: 13px 0 var(--page-background-color),
+ -13px 0 var(--page-background-color),
+ 13px 1px var(--group-header-separator-color),
+ -13px 1px var(--group-header-separator-color);
+}
+
h3.groupheader {
font-size: 100%;
}
@@ -451,8 +486,8 @@ p.startli, p.startdd {
}
th p.starttd, th p.intertd, th p.endtd {
- font-size: 100%;
- font-weight: 700;
+ font-size: 100%;
+ font-weight: 700;
}
p.starttd {
@@ -497,9 +532,11 @@ h3.version {
}
div.navtab {
- padding-right: 15px;
+ margin-right: 6px;
+ padding-right: 6px;
text-align: right;
line-height: 110%;
+ background-color: var(--nav-background-color);
}
div.navtab table {
@@ -512,19 +549,10 @@ td.navtab {
}
td.navtabHL {
- background-image: var(--nav-gradient-active-image);
- background-repeat:repeat-x;
padding-right: 6px;
padding-left: 6px;
-}
-
-td.navtabHL a, td.navtabHL a:visited {
- color: var(--nav-text-hover-color);
- text-shadow: var(--nav-text-hover-shadow);
-}
-
-a.navtab {
- font-weight: bold;
+ border-radius: 0 6px 6px 0;
+ background-color: var(--nav-menu-active-bg);
}
div.qindex{
@@ -599,16 +627,11 @@ a {
color: var(--page-visited-link-color);
}
-a:hover {
+span.label a:hover {
text-decoration: none;
background: linear-gradient(to bottom, transparent 0,transparent calc(100% - 1px), currentColor 100%);
}
-a:hover > span.arrow {
- text-decoration: none;
- background : var(--nav-background-color);
-}
-
a.el {
font-weight: bold;
}
@@ -616,12 +639,12 @@ a.el {
a.elRef {
}
-a.code, a.code:visited, a.line, a.line:visited {
- color: var(--code-link-color);
+a.el, a.el:visited, a.code, a.code:visited, a.line, a.line:visited {
+ color: var(--page-link-color);
}
a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited {
- color: var(--code-external-link-color);
+ color: var(--page-external-link-color);
}
a.code.hl_class { /* style for links to class names in code snippets */ }
@@ -658,118 +681,124 @@ dl.el {
}
ul.check {
- list-style:none;
- text-indent: -16px;
- padding-left: 38px;
+ list-style:none;
+ text-indent: -16px;
+ padding-left: 38px;
}
li.unchecked:before {
- content: "\2610\A0";
+ content: "\2610\A0";
}
li.checked:before {
- content: "\2611\A0";
+ content: "\2611\A0";
}
ol {
- text-indent: 0px;
+ text-indent: 0px;
}
ul {
- text-indent: 0px;
- overflow: visible;
+ text-indent: 0px;
+ overflow: visible;
}
ul.multicol {
- -moz-column-gap: 1em;
- -webkit-column-gap: 1em;
- column-gap: 1em;
- -moz-column-count: 3;
- -webkit-column-count: 3;
- column-count: 3;
- list-style-type: none;
+ -moz-column-gap: 1em;
+ -webkit-column-gap: 1em;
+ column-gap: 1em;
+ -moz-column-count: 3;
+ -webkit-column-count: 3;
+ column-count: 3;
+ list-style-type: none;
}
#side-nav ul {
- overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */
+ overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */
}
#main-nav ul {
- overflow: visible; /* reset ul rule for the navigation bar drop down lists */
+ overflow: visible; /* reset ul rule for the navigation bar drop down lists */
}
.fragment {
- text-align: left;
- direction: ltr;
- overflow-x: auto;
- overflow-y: hidden;
- position: relative;
- min-height: 12px;
- margin: 10px 0px;
- padding: 10px 10px;
- border: 1px solid var(--fragment-border-color);
- border-radius: 4px;
- background-color: var(--fragment-background-color);
- color: var(--fragment-foreground-color);
+ text-align: left;
+ direction: ltr;
+ overflow-x: auto;
+ overflow-y: hidden;
+ position: relative;
+ min-height: 12px;
+ margin: 10px 0px;
+ padding: 10px 10px;
+ border: 1px solid var(--fragment-border-color);
+ border-radius: 4px;
+ background-color: var(--fragment-background-color);
+ color: var(--fragment-foreground-color);
}
pre.fragment {
- word-wrap: break-word;
- font-size: 10pt;
- line-height: 125%;
- font-family: var(--font-family-monospace);
+ word-wrap: break-word;
+ font-size: 10pt;
+ line-height: 125%;
+ font-family: var(--font-family-monospace);
+}
+
+span.tt {
+ white-space: pre;
+ font-family: var(--font-family-monospace);
}
.clipboard {
- width: 24px;
- height: 24px;
- right: 5px;
- top: 5px;
- opacity: 0;
- position: absolute;
- display: inline;
- overflow: hidden;
- justify-content: center;
- align-items: center;
- cursor: pointer;
+ width: 24px;
+ height: 24px;
+ right: 5px;
+ top: 5px;
+ opacity: 0;
+ position: absolute;
+ display: inline;
+ overflow: hidden;
+ justify-content: center;
+ align-items: center;
+ cursor: pointer;
}
.clipboard.success {
- border: 1px solid var(--fragment-foreground-color);
- border-radius: 4px;
+ border: 1px solid var(--fragment-foreground-color);
+ border-radius: 4px;
}
.fragment:hover .clipboard, .clipboard.success {
- opacity: .4;
+ opacity: .4;
}
.clipboard:hover, .clipboard.success {
- opacity: 1 !important;
+ opacity: 1 !important;
}
.clipboard:active:not([class~=success]) svg {
- transform: scale(.91);
+ transform: scale(.91);
}
.clipboard.success svg {
- fill: var(--fragment-copy-ok-color);
+ fill: var(--fragment-copy-ok-color);
}
.clipboard.success {
- border-color: var(--fragment-copy-ok-color);
+ border-color: var(--fragment-copy-ok-color);
}
div.line {
font-family: var(--font-family-monospace);
- font-size: 13px;
+ font-size: 13px;
min-height: 13px;
line-height: 1.2;
- text-wrap: unrestricted;
+ text-wrap: wrap;
+ word-break: break-all;
white-space: -moz-pre-wrap; /* Moz */
white-space: -pre-wrap; /* Opera 4-6 */
white-space: -o-pre-wrap; /* Opera 7 */
white-space: pre-wrap; /* CSS3 */
word-wrap: break-word; /* IE 5.5+ */
- text-indent: -53px;
- padding-left: 53px;
+ text-indent: -62px;
+ padding-left: 62px;
padding-bottom: 0px;
margin: 0px;
-webkit-transition-property: background-color, box-shadow;
@@ -785,8 +814,8 @@ div.line {
}
div.line:after {
- content:"\000A";
- white-space: pre;
+ content:"\000A";
+ white-space: pre;
}
div.line.glow {
@@ -795,26 +824,67 @@ div.line.glow {
}
span.fold {
- margin-left: 5px;
- margin-right: 1px;
- margin-top: 0px;
- margin-bottom: 0px;
- padding: 0px;
display: inline-block;
width: 12px;
height: 12px;
- background-repeat:no-repeat;
- background-position:center;
+ margin-left: 4px;
+ margin-right: 1px;
+}
+
+span.foldnone {
+ display: inline-block;
+ position: relative;
+ cursor: pointer;
+ user-select: none;
+}
+
+span.fold.plus, span.fold.minus {
+ width: 10px;
+ height: 10px;
+ background-color: var(--fragment-background-color);
+ position: relative;
+ border: 1px solid var(--fold-line-color);
+ margin-right: 1px;
+}
+
+span.fold.plus::before, span.fold.minus::before {
+ content: '';
+ position: absolute;
+ background-color: var(--fold-line-color);
+}
+
+span.fold.plus::before {
+ width: 2px;
+ height: 6px;
+ top: 2px;
+ left: 4px;
+}
+
+span.fold.plus::after {
+ content: '';
+ position: absolute;
+ width: 6px;
+ height: 2px;
+ top: 4px;
+ left: 2px;
+ background-color: var(--fold-line-color);
+}
+
+span.fold.minus::before {
+ width: 6px;
+ height: 2px;
+ top: 4px;
+ left: 2px;
}
span.lineno {
padding-right: 4px;
- margin-right: 9px;
+ margin-right: 9px;
text-align: right;
border-right: 2px solid var(--fragment-lineno-border-color);
color: var(--fragment-lineno-foreground-color);
background-color: var(--fragment-lineno-background-color);
- white-space: pre;
+ white-space: pre;
}
span.lineno a, span.lineno a:visited {
color: var(--fragment-lineno-link-fg-color);
@@ -836,18 +906,27 @@ span.lineno a:hover {
}
div.classindex ul {
- list-style: none;
- padding-left: 0;
+ list-style: none;
+ padding-left: 0;
}
div.classindex span.ai {
- display: inline-block;
+ display: inline-block;
}
div.groupHeader {
- margin-left: 16px;
- margin-top: 12px;
- font-weight: bold;
+ box-shadow: 13px 0 var(--page-background-color),
+ -13px 0 var(--page-background-color),
+ 13px 1px var(--group-header-separator-color),
+ -13px 1px var(--group-header-separator-color);
+ color: var(--group-header-color);
+ font-size: 110%;
+ font-weight: 500;
+ margin-left: 0px;
+ margin-top: 0em;
+ margin-bottom: 6px;
+ padding-top: 8px;
+ padding-bottom: 4px;
}
div.groupText {
@@ -857,13 +936,13 @@ div.groupText {
body {
color: var(--page-foreground-color);
- margin: 0;
+ margin: 0;
}
div.contents {
margin-top: 10px;
margin-left: 12px;
- margin-right: 8px;
+ margin-right: 12px;
}
p.formulaDsp {
@@ -883,9 +962,9 @@ img.formulaInl, img.inline {
div.center {
text-align: center;
- margin-top: 0px;
- margin-bottom: 0px;
- padding: 0px;
+ margin-top: 0px;
+ margin-bottom: 0px;
+ padding: 0px;
}
div.center img {
@@ -960,10 +1039,10 @@ span.vhdllogic {
}
blockquote {
- background-color: var(--blockquote-background-color);
- border-left: 2px solid var(--blockquote-border-color);
- margin: 0 24px 0 4px;
- padding: 0 12px 0 16px;
+ background-color: var(--blockquote-background-color);
+ border-left: 2px solid var(--blockquote-border-color);
+ margin: 0 24px 0 4px;
+ padding: 0 12px 0 16px;
}
/* @end */
@@ -985,9 +1064,14 @@ th.dirtab {
}
hr {
- height: 0px;
border: none;
- border-top: 1px solid var(--separator-color);
+ margin-top: 16px;
+ margin-bottom: 16px;
+ height: 1px;
+ box-shadow: 13px 0 var(--page-background-color),
+ -13px 0 var(--page-background-color),
+ 13px 1px var(--group-header-separator-color),
+ -13px 1px var(--group-header-separator-color);
}
hr.footer {
@@ -1002,14 +1086,6 @@ table.memberdecls {
}
.memberdecls td, .fieldtable tr {
- -webkit-transition-property: background-color, box-shadow;
- -webkit-transition-duration: 0.5s;
- -moz-transition-property: background-color, box-shadow;
- -moz-transition-duration: 0.5s;
- -ms-transition-property: background-color, box-shadow;
- -ms-transition-duration: 0.5s;
- -o-transition-property: background-color, box-shadow;
- -o-transition-duration: 0.5s;
transition-property: background-color, box-shadow;
transition-duration: 0.5s;
}
@@ -1019,13 +1095,23 @@ table.memberdecls {
box-shadow: 0 0 15px var(--glow-color);
}
+.memberdecls tr[class^='memitem'] {
+ font-family: var(--font-family-monospace);
+}
+
.mdescLeft, .mdescRight,
-.memItemLeft, .memItemRight,
-.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
+.memItemLeft, .memItemRight {
+ padding-top: 2px;
+ padding-bottom: 2px;
+}
+
+.memTemplParams {
+ padding-left: 10px;
+ padding-top: 5px;
+}
+
+.memItemLeft, .memItemRight, .memTemplParams {
background-color: var(--memdecl-background-color);
- border: none;
- margin: 4px;
- padding: 1px 0 0 8px;
}
.mdescLeft, .mdescRight {
@@ -1033,27 +1119,104 @@ table.memberdecls {
color: var(--memdecl-foreground-color);
}
-.memSeparator {
- border-bottom: 1px solid var(--memdecl-separator-color);
- line-height: 1px;
- margin: 0px;
- padding: 0px;
+tr[class^='memdesc'] {
+ box-shadow: inset 0px 1px 3px 0px rgba(0,0,0,.075);
}
-.memItemLeft, .memTemplItemLeft {
- white-space: nowrap;
+.mdescLeft {
+ border-left: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
}
-.memItemRight, .memTemplItemRight {
- width: 100%;
+.mdescRight {
+ border-right: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
}
.memTemplParams {
color: var(--memdecl-template-color);
- white-space: nowrap;
+ white-space: nowrap;
font-size: 80%;
+ border-left: 1px solid var(--memdecl-border-color);
+ border-right: 1px solid var(--memdecl-border-color);
+}
+
+td.ititle {
+ border: 1px solid var(--memdecl-border-color);
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+ padding-left: 10px;
+}
+
+tr:not(:first-child) > td.ititle {
+ border-top: 0;
+ border-radius: 0;
}
+.memItemLeft {
+ white-space: nowrap;
+ border-left: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
+ padding-left: 10px;
+ transition: none;
+}
+
+.memItemRight {
+ width: 100%;
+ border-right: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
+ padding-right: 10px;
+ transition: none;
+}
+
+tr.heading + tr[class^='memitem'] td.memItemLeft,
+tr.groupHeader + tr[class^='memitem'] td.memItemLeft,
+tr.inherit_header + tr[class^='memitem'] td.memItemLeft {
+ border-top: 1px solid var(--memdecl-border-color);
+ border-top-left-radius: 4px;
+}
+
+tr.heading + tr[class^='memitem'] td.memItemRight,
+tr.groupHeader + tr[class^='memitem'] td.memItemRight,
+tr.inherit_header + tr[class^='memitem'] td.memItemRight {
+ border-top: 1px solid var(--memdecl-border-color);
+ border-top-right-radius: 4px;
+}
+
+tr.heading + tr[class^='memitem'] td.memTemplParams,
+tr.heading + tr td.ititle,
+tr.groupHeader + tr[class^='memitem'] td.memTemplParams,
+tr.groupHeader + tr td.ititle,
+tr.inherit_header + tr[class^='memitem'] td.memTemplParams {
+ border-top: 1px solid var(--memdecl-border-color);
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+}
+
+table.memberdecls tr:last-child td.memItemLeft,
+table.memberdecls tr:last-child td.mdescLeft,
+table.memberdecls tr[class^='memitem']:has(+ tr.groupHeader) td.memItemLeft,
+table.memberdecls tr[class^='memitem']:has(+ tr.inherit_header) td.memItemLeft,
+table.memberdecls tr[class^='memdesc']:has(+ tr.groupHeader) td.mdescLeft,
+table.memberdecls tr[class^='memdesc']:has(+ tr.inherit_header) td.mdescLeft {
+ border-bottom-left-radius: 4px;
+}
+
+table.memberdecls tr:last-child td.memItemRight,
+table.memberdecls tr:last-child td.mdescRight,
+table.memberdecls tr[class^='memitem']:has(+ tr.groupHeader) td.memItemRight,
+table.memberdecls tr[class^='memitem']:has(+ tr.inherit_header) td.memItemRight,
+table.memberdecls tr[class^='memdesc']:has(+ tr.groupHeader) td.mdescRight,
+table.memberdecls tr[class^='memdesc']:has(+ tr.inherit_header) td.mdescRight {
+ border-bottom-right-radius: 4px;
+}
+
+tr.template .memItemLeft, tr.template .memItemRight {
+ border-top: none;
+ padding-top: 0;
+}
+
+
/* @end */
/* @group Member Details */
@@ -1068,24 +1231,43 @@ table.memberdecls {
border-top-right-radius: 4px;
border-top-left-radius: 4px;
margin-bottom: -1px;
- background-image: var(--memdef-title-gradient-image);
- background-repeat: repeat-x;
- background-color: var(--memdef-title-background-color);
+ background-color: var(--memdef-proto-background-color);
line-height: 1.25;
- font-weight: 300;
+ font-family: var(--font-family-monospace);
+ font-weight: 500;
+ font-size: 16px;
float:left;
+ box-shadow: 0 10px 0 -1px var(--memdef-proto-background-color),
+ 0 2px 8px 0 rgba(0,0,0,.075);
+ position: relative;
+}
+
+.memtitle:after {
+ content: '';
+ display: block;
+ background: var(--memdef-proto-background-color);
+ height: 10px;
+ bottom: -10px;
+ left: 0px;
+ right: -14px;
+ position: absolute;
+ border-top-right-radius: 6px;
}
.permalink
{
- font-size: 65%;
- display: inline-block;
- vertical-align: middle;
+ font-family: var(--font-family-monospace);
+ font-weight: 500;
+ line-height: 1.25;
+ font-size: 16px;
+ display: inline-block;
+ vertical-align: middle;
}
.memtemplate {
font-size: 80%;
color: var(--memdef-template-color);
+ font-family: var(--font-family-monospace);
font-weight: normal;
margin-left: 9px;
}
@@ -1098,22 +1280,21 @@ table.memberdecls {
padding: 0;
margin-bottom: 10px;
margin-right: 5px;
- -webkit-transition: box-shadow 0.5s linear;
- -moz-transition: box-shadow 0.5s linear;
- -ms-transition: box-shadow 0.5s linear;
- -o-transition: box-shadow 0.5s linear;
- transition: box-shadow 0.5s linear;
- display: table !important;
- width: 100%;
+ display: table !important;
+ width: 100%;
+ box-shadow: 0 2px 8px 0 rgba(0,0,0,.075);
+ border-radius: 4px;
}
.memitem.glow {
- box-shadow: 0 0 15px var(--glow-color);
+ box-shadow: 0 0 15px var(--glow-color);
}
.memname {
- font-weight: 400;
- margin-left: 6px;
+ font-family: var(--font-family-monospace);
+ font-size: 13px;
+ font-weight: 400;
+ margin-left: 6px;
}
.memname td {
@@ -1121,53 +1302,39 @@ table.memberdecls {
}
.memproto, dl.reflist dt {
- border-top: 1px solid var(--memdef-border-color);
- border-left: 1px solid var(--memdef-border-color);
- border-right: 1px solid var(--memdef-border-color);
- padding: 6px 0px 6px 0px;
- color: var(--memdef-proto-text-color);
- font-weight: bold;
- text-shadow: var(--memdef-proto-text-shadow);
- background-color: var(--memdef-proto-background-color);
- box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
- border-top-right-radius: 4px;
+ border-top: 1px solid var(--memdef-border-color);
+ border-left: 1px solid var(--memdef-border-color);
+ border-right: 1px solid var(--memdef-border-color);
+ padding: 6px 0px 6px 0px;
+ color: var(--memdef-proto-text-color);
+ font-weight: bold;
+ background-color: var(--memdef-proto-background-color);
+ border-top-right-radius: 4px;
+ border-bottom: 1px solid var(--memdef-border-color);
}
.overload {
- font-family: var(--font-family-monospace);
+ font-family: var(--font-family-monospace);
font-size: 65%;
}
.memdoc, dl.reflist dd {
- border-bottom: 1px solid var(--memdef-border-color);
- border-left: 1px solid var(--memdef-border-color);
- border-right: 1px solid var(--memdef-border-color);
- padding: 6px 10px 2px 10px;
- border-top-width: 0;
- background-image:url('nav_g.png');
- background-repeat:repeat-x;
- background-color: var(--memdef-doc-background-color);
- /* opera specific markup */
- border-bottom-left-radius: 4px;
- border-bottom-right-radius: 4px;
- box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
- /* firefox specific markup */
- -moz-border-radius-bottomleft: 4px;
- -moz-border-radius-bottomright: 4px;
- -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
- /* webkit specific markup */
- -webkit-border-bottom-left-radius: 4px;
- -webkit-border-bottom-right-radius: 4px;
- -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ border-bottom: 1px solid var(--memdef-border-color);
+ border-left: 1px solid var(--memdef-border-color);
+ border-right: 1px solid var(--memdef-border-color);
+ padding: 6px 10px 2px 10px;
+ border-top-width: 0;
+ border-bottom-left-radius: 4px;
+ border-bottom-right-radius: 4px;
}
dl.reflist dt {
- padding: 5px;
+ padding: 5px;
}
dl.reflist dd {
- margin: 0px 0px 10px 0px;
- padding: 5px;
+ margin: 0px 0px 10px 0px;
+ padding: 5px;
}
.paramkey {
@@ -1182,9 +1349,9 @@ dl.reflist dd {
.paramname {
white-space: nowrap;
- padding: 0px;
- padding-bottom: 1px;
- margin-left: 2px;
+ padding: 0px;
+ padding-bottom: 1px;
+ margin-left: 2px;
}
.paramname em {
@@ -1198,23 +1365,23 @@ dl.reflist dd {
}
.params, .retval, .exception, .tparams {
- margin-left: 0px;
- padding-left: 0px;
+ margin-left: 0px;
+ padding-left: 0px;
}
.params .paramname, .retval .paramname, .tparams .paramname, .exception .paramname {
- font-weight: bold;
- vertical-align: top;
+ font-weight: bold;
+ vertical-align: top;
}
.params .paramtype, .tparams .paramtype {
- font-style: italic;
- vertical-align: top;
+ font-style: italic;
+ vertical-align: top;
}
.params .paramdir, .tparams .paramdir {
- font-family: var(--font-family-monospace);
- vertical-align: top;
+ font-family: var(--font-family-monospace);
+ vertical-align: top;
}
table.mlabels {
@@ -1233,15 +1400,15 @@ td.mlabels-right {
}
span.mlabels {
- margin-left: 8px;
+ margin-left: 8px;
}
span.mlabel {
- background-color: var(--label-background-color);
- border-top:1px solid var(--label-left-top-border-color);
- border-left:1px solid var(--label-left-top-border-color);
- border-right:1px solid var(--label-right-bottom-border-color);
- border-bottom:1px solid var(--label-right-bottom-border-color);
+ background-color: var(--label-background-color);
+ border-top:1px solid var(--label-left-top-border-color);
+ border-left:1px solid var(--label-left-top-border-color);
+ border-right:1px solid var(--label-right-bottom-border-color);
+ border-bottom:1px solid var(--label-right-bottom-border-color);
text-shadow: none;
color: var(--label-foreground-color);
margin-right: 4px;
@@ -1259,39 +1426,37 @@ span.mlabel {
/* these are for tree view inside a (index) page */
div.directory {
- margin: 10px 0px;
- border-top: 1px solid var(--directory-separator-color);
- border-bottom: 1px solid var(--directory-separator-color);
- width: 100%;
+ margin: 10px 0px;
+ width: 100%;
}
.directory table {
- border-collapse:collapse;
+ border-collapse:collapse;
}
.directory td {
- margin: 0px;
- padding: 0px;
+ margin: 0px;
+ padding: 0px;
vertical-align: top;
}
.directory td.entry {
- white-space: nowrap;
- padding-right: 6px;
+ white-space: nowrap;
+ padding-right: 6px;
padding-top: 3px;
}
.directory td.entry a {
- outline:none;
+ outline:none;
}
.directory td.entry a img {
- border: none;
+ border: none;
}
.directory td.desc {
- width: 100%;
- padding-left: 6px;
+ width: 100%;
+ padding-left: 6px;
padding-right: 6px;
padding-top: 3px;
border-left: 1px solid rgba(0,0,0,0.05);
@@ -1312,90 +1477,178 @@ div.directory {
}
.directory .levels {
- white-space: nowrap;
- width: 100%;
- text-align: right;
- font-size: 9pt;
+ white-space: nowrap;
+ width: 100%;
+ text-align: right;
+ font-size: 9pt;
}
.directory .levels span {
- cursor: pointer;
- padding-left: 2px;
- padding-right: 2px;
+ cursor: pointer;
+ padding-left: 2px;
+ padding-right: 2px;
color: var(--page-link-color);
}
.arrow {
- color: var(--nav-arrow-color);
- -webkit-user-select: none;
- -khtml-user-select: none;
- -moz-user-select: none;
- -ms-user-select: none;
- user-select: none;
- cursor: pointer;
- font-size: 80%;
- display: inline-block;
- width: 16px;
- height: 22px;
+ color: var(--nav-background-color);
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ cursor: pointer;
+ font-size: 80%;
+ display: inline-block;
+ width: 16px;
+ height: 14px;
+ transition: opacity 0.3s ease;
+}
+
+span.arrowhead {
+ position: relative;
+ padding: 0;
+ margin: 0 0 0 2px;
+ display: inline-block;
+ width: 5px;
+ height: 5px;
+ border-right: 2px solid var(--nav-arrow-color);
+ border-bottom: 2px solid var(--nav-arrow-color);
+ transform: rotate(-45deg);
+ transition: transform 0.3s ease;
+}
+
+span.arrowhead.opened {
+ transform: rotate(45deg);
+}
+
+.selected span.arrowhead {
+ border-right: 2px solid var(--nav-arrow-selected-color);
+ border-bottom: 2px solid var(--nav-arrow-selected-color);
}
.icon {
- font-family: var(--font-family-icon);
- line-height: normal;
- font-weight: bold;
- font-size: 12px;
- height: 14px;
- width: 16px;
- display: inline-block;
- background-color: var(--icon-background-color);
- color: var(--icon-foreground-color);
- text-align: center;
- border-radius: 4px;
- margin-left: 2px;
- margin-right: 2px;
+ font-family: var(--font-family-icon);
+ line-height: normal;
+ font-weight: bold;
+ font-size: 12px;
+ height: 14px;
+ width: 16px;
+ display: inline-block;
+ background-color: var(--icon-background-color);
+ color: var(--icon-foreground-color);
+ text-align: center;
+ border-radius: 4px;
+ margin-left: 2px;
+ margin-right: 2px;
}
.icona {
- width: 24px;
- height: 22px;
- display: inline-block;
+ width: 24px;
+ height: 22px;
+ display: inline-block;
}
-.iconfopen {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:var(--icon-folder-open-image);
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
+.iconfolder {
+ width: 24px;
+ height: 18px;
+ margin-top: 6px;
+ vertical-align:top;
+ display: inline-block;
+ position: relative;
}
-.iconfclosed {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:var(--icon-folder-closed-image);
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
+.icondoc {
+ width: 24px;
+ height: 18px;
+ margin-top: 3px;
+ vertical-align:top;
+ display: inline-block;
+ position: relative;
}
-.icondoc {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:var(--icon-doc-image);
- background-position: 0px -4px;
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
+.folder-icon {
+ width: 16px;
+ height: 11px;
+ background-color: var(--icon-folder-fill-color);
+ border: 1px solid var(--icon-folder-border-color);
+ border-radius: 0 2px 2px 2px;
+ position: relative;
+ box-sizing: content-box;
+}
+
+.folder-icon::after {
+ content: '';
+ position: absolute;
+ top: 2px;
+ left: -1px;
+ width: 16px;
+ height: 7px;
+ background-color: var(--icon-folder-open-fill-color);
+ border: 1px solid var(--icon-folder-border-color);
+ border-radius: 7px 7px 2px 2px;
+ transform-origin: top left;
+ opacity: 0;
+ transition: all 0.3s linear;
+}
+
+.folder-icon::before {
+ content: '';
+ position: absolute;
+ top: -3px;
+ left: -1px;
+ width: 6px;
+ height: 2px;
+ background-color: var(--icon-folder-fill-color);
+ border-top: 1px solid var(--icon-folder-border-color);
+ border-left: 1px solid var(--icon-folder-border-color);
+ border-right: 1px solid var(--icon-folder-border-color);
+ border-radius: 2px 2px 0 0;
+}
+
+.folder-icon.open::after {
+ top: 3px;
+ opacity: 1;
+}
+
+.doc-icon {
+ left: 6px;
+ width: 12px;
+ height: 16px;
+ background-color: var(--icon-doc-border-color);
+ clip-path: polygon(0 0, 66% 0, 100% 25%, 100% 100%, 0 100%);
+ position: relative;
+ display: inline-block;
+}
+.doc-icon::before {
+ content: "";
+ left: 1px;
+ top: 1px;
+ width: 10px;
+ height: 14px;
+ background-color: var(--icon-doc-fill-color);
+ clip-path: polygon(0 0, 66% 0, 100% 25%, 100% 100%, 0 100%);
+ position: absolute;
+ box-sizing: border-box;
+}
+.doc-icon::after {
+ content: "";
+ left: 7px;
+ top: 0px;
+ width: 3px;
+ height: 3px;
+ background-color: transparent;
+ position: absolute;
+ border: 1px solid var(--icon-doc-border-color);
}
+
+
+
/* @end */
div.dynheader {
- margin-top: 8px;
+ margin-top: 8px;
-webkit-touch-callout: none;
-webkit-user-select: none;
-khtml-user-select: none;
@@ -1404,6 +1657,13 @@ div.dynheader {
user-select: none;
}
+span.dynarrow {
+ position: relative;
+ display: inline-block;
+ width: 12px;
+ bottom: 1px;
+}
+
address {
font-style: normal;
color: var(--footer-foreground-color);
@@ -1415,8 +1675,8 @@ table.doxtable caption {
table.doxtable {
border-collapse:collapse;
- margin-top: 4px;
- margin-bottom: 4px;
+ margin-top: 4px;
+ margin-bottom: 4px;
}
table.doxtable td, table.doxtable th {
@@ -1433,133 +1693,145 @@ table.doxtable th {
}
table.fieldtable {
- margin-bottom: 10px;
- border: 1px solid var(--memdef-border-color);
- border-spacing: 0px;
- border-radius: 4px;
- box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
+ margin-bottom: 10px;
+ border: 1px solid var(--memdef-border-color);
+ border-spacing: 0px;
+ border-radius: 4px;
+ box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
}
.fieldtable td, .fieldtable th {
- padding: 3px 7px 2px;
+ padding: 3px 7px 2px;
}
.fieldtable td.fieldtype, .fieldtable td.fieldname, .fieldtable td.fieldinit {
- white-space: nowrap;
- border-right: 1px solid var(--memdef-border-color);
- border-bottom: 1px solid var(--memdef-border-color);
- vertical-align: top;
+ white-space: nowrap;
+ border-right: 1px solid var(--memdef-border-color);
+ border-bottom: 1px solid var(--memdef-border-color);
+ vertical-align: top;
}
.fieldtable td.fieldname {
- padding-top: 3px;
+ padding-top: 3px;
}
.fieldtable td.fieldinit {
- padding-top: 3px;
- text-align: right;
+ padding-top: 3px;
+ text-align: right;
}
.fieldtable td.fielddoc {
- border-bottom: 1px solid var(--memdef-border-color);
+ border-bottom: 1px solid var(--memdef-border-color);
}
.fieldtable td.fielddoc p:first-child {
- margin-top: 0px;
+ margin-top: 0px;
}
.fieldtable td.fielddoc p:last-child {
- margin-bottom: 2px;
+ margin-bottom: 2px;
}
.fieldtable tr:last-child td {
- border-bottom: none;
+ border-bottom: none;
}
.fieldtable th {
- background-image: var(--memdef-title-gradient-image);
- background-repeat:repeat-x;
- background-color: var(--memdef-title-background-color);
- font-size: 90%;
- color: var(--memdef-proto-text-color);
- padding-bottom: 4px;
- padding-top: 5px;
- text-align:left;
- font-weight: 400;
- border-top-left-radius: 4px;
- border-top-right-radius: 4px;
- border-bottom: 1px solid var(--memdef-border-color);
-}
-
-
-.tabsearch {
- top: 0px;
- left: 10px;
- height: 36px;
- background-image: var(--nav-gradient-image);
- z-index: 101;
+ background-color: var(--memdef-title-background-color);
+ font-size: 90%;
+ color: var(--memdef-proto-text-color);
+ padding-bottom: 4px;
+ padding-top: 5px;
+ text-align:left;
+ font-weight: 400;
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+ border-bottom: 1px solid var(--memdef-border-color);
+}
+
+/* ----------- navigation breadcrumb styling ----------- */
+
+#nav-path ul {
+ height: 30px;
+ line-height: 30px;
+ color: var(--nav-text-normal-color);
overflow: hidden;
- font-size: 13px;
+ margin: 0px;
+ padding-left: 4px;
+ background-image: none;
+ background: var(--page-background-color);
+ border-bottom: 1px solid var(--nav-breadcrumb-separator-color);
+ font-size: var(--nav-font-size-level1);
+ font-family: var(--font-family-nav);
+ position: relative;
+ z-index: 100;
}
-.navpath ul
-{
- font-size: 11px;
- background-image: var(--nav-gradient-image);
- background-repeat:repeat-x;
- background-position: 0 -5px;
- height:30px;
- line-height:30px;
- color:var(--nav-text-normal-color);
- border:solid 1px var(--nav-breadcrumb-border-color);
- overflow:hidden;
- margin:0px;
- padding:0px;
-}
-
-.navpath li
-{
+#main-nav {
+ border-bottom: 1px solid var(--nav-border-color);
+}
+
+.navpath li {
list-style-type:none;
float:left;
+ color: var(--nav-foreground-color);
+}
+
+.navpath li.footer {
+ list-style-type:none;
+ float:right;
padding-left:10px;
padding-right:15px;
- background-image:var(--nav-breadcrumb-image);
+ background-image:none;
background-repeat:no-repeat;
background-position:right;
- color: var(--nav-foreground-color);
+ font-size: 8pt;
+ color: var(--footer-foreground-color);
}
-.navpath li.navelem a
-{
- height:32px;
- display:block;
- outline: none;
- color: var(--nav-text-normal-color);
- font-family: var(--font-family-nav);
- text-shadow: var(--nav-text-normal-shadow);
- text-decoration: none;
+#nav-path li.navelem {
+ background-image: none;
+ display: flex;
+ align-items: center;
+ padding-left: 15px;
}
-.navpath li.navelem a:hover
-{
- color: var(--nav-text-hover-color);
- text-shadow: var(--nav-text-hover-shadow);
+.navpath li.navelem a {
+ text-shadow: none;
+ display: inline-block;
+ color: var(--nav-breadcrumb-color);
+ position: relative;
+ top: 0px;
+ height: 30px;
+ margin-right: -20px;
}
-.navpath li.footer
-{
- list-style-type:none;
- float:right;
- padding-left:10px;
- padding-right:15px;
- background-image:none;
- background-repeat:no-repeat;
- background-position:right;
- color: var(--footer-foreground-color);
- font-size: 8pt;
+#nav-path li.navelem:after {
+ content: '';
+ display: inline-block;
+ position: relative;
+ top: 0;
+ right: -15px;
+ width: 30px;
+ height: 30px;
+ transform: scaleX(0.5) scale(0.707) rotate(45deg);
+ z-index: 10;
+ background: var(--page-background-color);
+ box-shadow: 2px -2px 0 2px var(--nav-breadcrumb-separator-color);
+ border-radius: 0 5px 0 50px;
+}
+
+#nav-path li.navelem:first-child {
+ margin-left: -6px;
}
+#nav-path li.navelem:hover,
+#nav-path li.navelem:hover:after {
+ background-color: var(--nav-breadcrumb-active-bg);
+}
+
+/* ---------------------- */
div.summary
{
@@ -1577,14 +1849,14 @@ div.summary a
table.classindex
{
- margin: 10px;
- white-space: nowrap;
- margin-left: 3%;
- margin-right: 3%;
- width: 94%;
- border: 0;
- border-spacing: 0;
- padding: 0;
+ margin: 10px;
+ white-space: nowrap;
+ margin-left: 3%;
+ margin-right: 3%;
+ width: 94%;
+ border: 0;
+ border-spacing: 0;
+ padding: 0;
}
div.ingroups
@@ -1601,10 +1873,8 @@ div.ingroups a
div.header
{
- background-image: var(--header-gradient-image);
- background-repeat:repeat-x;
- background-color: var(--header-background-color);
margin: 0px;
+ background-color: var(--header-background-color);
border-bottom: 1px solid var(--header-separator-color);
}
@@ -1613,168 +1883,105 @@ div.headertitle
padding: 5px 5px 5px 10px;
}
-.PageDocRTL-title div.headertitle {
- text-align: right;
- direction: rtl;
-}
-
dl {
- padding: 0 0 0 0;
-}
-
-/*
-
-dl.section {
- margin-left: 0px;
- padding-left: 0px;
-}
-
-dl.note {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #D0C000;
-}
-
-dl.warning, dl.attention, dl.important {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #FF0000;
-}
-
-dl.pre, dl.post, dl.invariant {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #00D000;
-}
-
-dl.deprecated {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #505050;
-}
-
-dl.todo {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #00C0E0;
-}
-
-dl.test {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #3030E0;
-}
-
-dl.bug {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #C08050;
+ padding: 0 0 0 0;
}
-*/
-
dl.bug dt a, dl.deprecated dt a, dl.todo dt a, dl.test a {
- font-weight: bold !important;
+ font-weight: bold !important;
}
dl.warning, dl.attention, dl.important, dl.note, dl.deprecated, dl.bug,
dl.invariant, dl.pre, dl.post, dl.todo, dl.test, dl.remark {
- padding: 10px;
- margin: 10px 0px;
- overflow: hidden;
- margin-left: 0;
- border-radius: 4px;
+ padding: 10px;
+ margin: 10px 0px;
+ overflow: hidden;
+ margin-left: 0;
+ border-radius: 4px;
}
dl.section dd {
- margin-bottom: 2px;
+ margin-bottom: 2px;
}
dl.warning, dl.attention, dl.important {
- background: var(--warning-color-bg);
- border-left: 8px solid var(--warning-color-hl);
- color: var(--warning-color-text);
+ background: var(--warning-color-bg);
+ border-left: 8px solid var(--warning-color-hl);
+ color: var(--warning-color-text);
}
dl.warning dt, dl.attention dt, dl.important dt {
- color: var(--warning-color-hl);
+ color: var(--warning-color-hl);
}
dl.note, dl.remark {
- background: var(--note-color-bg);
- border-left: 8px solid var(--note-color-hl);
- color: var(--note-color-text);
+ background: var(--note-color-bg);
+ border-left: 8px solid var(--note-color-hl);
+ color: var(--note-color-text);
}
dl.note dt, dl.remark dt {
- color: var(--note-color-hl);
+ color: var(--note-color-hl);
}
dl.todo {
- background: var(--todo-color-bg);
- border-left: 8px solid var(--todo-color-hl);
- color: var(--todo-color-text);
+ background: var(--todo-color-bg);
+ border-left: 8px solid var(--todo-color-hl);
+ color: var(--todo-color-text);
}
dl.todo dt {
- color: var(--todo-color-hl);
+ color: var(--todo-color-hl);
}
dl.test {
- background: var(--test-color-bg);
- border-left: 8px solid var(--test-color-hl);
- color: var(--test-color-text);
+ background: var(--test-color-bg);
+ border-left: 8px solid var(--test-color-hl);
+ color: var(--test-color-text);
}
dl.test dt {
- color: var(--test-color-hl);
+ color: var(--test-color-hl);
}
dl.bug dt a {
- color: var(--bug-color-hl) !important;
+ color: var(--bug-color-hl) !important;
}
dl.bug {
- background: var(--bug-color-bg);
- border-left: 8px solid var(--bug-color-hl);
- color: var(--bug-color-text);
+ background: var(--bug-color-bg);
+ border-left: 8px solid var(--bug-color-hl);
+ color: var(--bug-color-text);
}
dl.bug dt a {
- color: var(--bug-color-hl) !important;
+ color: var(--bug-color-hl) !important;
}
dl.deprecated {
- background: var(--deprecated-color-bg);
- border-left: 8px solid var(--deprecated-color-hl);
- color: var(--deprecated-color-text);
+ background: var(--deprecated-color-bg);
+ border-left: 8px solid var(--deprecated-color-hl);
+ color: var(--deprecated-color-text);
}
dl.deprecated dt a {
- color: var(--deprecated-color-hl) !important;
+ color: var(--deprecated-color-hl) !important;
}
dl.note dd, dl.warning dd, dl.pre dd, dl.post dd,
dl.remark dd, dl.attention dd, dl.important dd, dl.invariant dd,
dl.bug dd, dl.deprecated dd, dl.todo dd, dl.test dd {
- margin-inline-start: 0px;
+ margin-inline-start: 0px;
}
dl.invariant, dl.pre, dl.post {
- background: var(--invariant-color-bg);
- border-left: 8px solid var(--invariant-color-hl);
- color: var(--invariant-color-text);
+ background: var(--invariant-color-bg);
+ border-left: 8px solid var(--invariant-color-hl);
+ color: var(--invariant-color-text);
}
dl.invariant dt, dl.pre dt, dl.post dt {
- color: var(--invariant-color-hl);
+ color: var(--invariant-color-hl);
}
@@ -1797,16 +2004,16 @@ dl.invariant dt, dl.pre dt, dl.post dt {
#projectalign
{
- vertical-align: middle;
- padding-left: 0.5em;
+ vertical-align: middle;
+ padding-left: 0.5em;
}
#projectname
{
font-size: 200%;
font-family: var(--font-family-title);
- margin: 0px;
- padding: 2px 0px;
+ margin: 0;
+ padding: 0;
}
#side-nav #projectname
@@ -1817,7 +2024,7 @@ dl.invariant dt, dl.pre dt, dl.post dt {
#projectbrief
{
font-size: 90%;
- font-family: var(--font-family-title);
+ font-family: var(--font-family-title);
margin: 0px;
padding: 0px;
}
@@ -1825,43 +2032,42 @@ dl.invariant dt, dl.pre dt, dl.post dt {
#projectnumber
{
font-size: 50%;
- font-family: 50% var(--font-family-title);
+ font-family: var(--font-family-title);
margin: 0px;
padding: 0px;
}
#titlearea
{
- padding: 0px;
+ padding: 0 0 0 5px;
margin: 0px;
- width: 100%;
border-bottom: 1px solid var(--title-separator-color);
background-color: var(--title-background-color);
}
.image
{
- text-align: center;
+ text-align: center;
}
.dotgraph
{
- text-align: center;
+ text-align: center;
}
.mscgraph
{
- text-align: center;
+ text-align: center;
}
.plantumlgraph
{
- text-align: center;
+ text-align: center;
}
.diagraph
{
- text-align: center;
+ text-align: center;
}
.caption
@@ -1870,67 +2076,67 @@ dl.invariant dt, dl.pre dt, dl.post dt {
}
dl.citelist {
- margin-bottom:50px;
+ margin-bottom:50px;
}
dl.citelist dt {
- color:var(--citation-label-color);
- float:left;
- font-weight:bold;
- margin-right:10px;
- padding:5px;
- text-align:right;
- width:52px;
+ color:var(--citation-label-color);
+ float:left;
+ font-weight:bold;
+ margin-right:10px;
+ padding:5px;
+ text-align:right;
+ width:52px;
}
dl.citelist dd {
- margin:2px 0 2px 72px;
- padding:5px 0;
+ margin:2px 0 2px 72px;
+ padding:5px 0;
}
div.toc {
- padding: 14px 25px;
- background-color: var(--toc-background-color);
- border: 1px solid var(--toc-border-color);
- border-radius: 7px 7px 7px 7px;
- float: right;
- height: auto;
- margin: 0 8px 10px 10px;
- width: 200px;
+ padding: 14px 25px;
+ background-color: var(--toc-background-color);
+ border: 1px solid var(--toc-border-color);
+ border-radius: 7px 7px 7px 7px;
+ float: right;
+ height: auto;
+ margin: 0 8px 10px 10px;
+ width: 200px;
}
div.toc li {
- background: var(--toc-down-arrow-image) no-repeat scroll 0 5px transparent;
- font: 10px/1.2 var(--font-family-toc);
- margin-top: 5px;
- padding-left: 10px;
- padding-top: 2px;
+ background: var(--toc-down-arrow-image) no-repeat scroll 0 5px transparent;
+ font: 10px/1.2 var(--font-family-toc);
+ margin-top: 5px;
+ padding-left: 10px;
+ padding-top: 2px;
}
div.toc h3 {
- font: bold 12px/1.2 var(--font-family-toc);
+ font: bold 12px/1.2 var(--font-family-toc);
color: var(--toc-header-color);
- border-bottom: 0 none;
- margin: 0;
+ border-bottom: 0 none;
+ margin: 0;
}
div.toc ul {
- list-style: none outside none;
- border: medium none;
- padding: 0px;
+ list-style: none outside none;
+ border: medium none;
+ padding: 0px;
}
div.toc li[class^='level'] {
- margin-left: 15px;
+ margin-left: 15px;
}
div.toc li.level1 {
- margin-left: 0px;
+ margin-left: 0px;
}
div.toc li.empty {
- background-image: none;
- margin-top: 0px;
+ background-image: none;
+ margin-top: 0px;
}
span.emoji {
@@ -1940,13 +2146,12 @@ span.emoji {
}
span.obfuscator {
- display: none;
+ display: none;
}
.inherit_header {
- font-weight: bold;
- color: var(--inherit-header-color);
- cursor: pointer;
+ font-weight: 400;
+ cursor: pointer;
-webkit-touch-callout: none;
-webkit-user-select: none;
-khtml-user-select: none;
@@ -1956,49 +2161,49 @@ span.obfuscator {
}
.inherit_header td {
- padding: 6px 0px 2px 5px;
+ padding: 6px 0 2px 0;
}
.inherit {
- display: none;
+ display: none;
}
tr.heading h2 {
- margin-top: 12px;
- margin-bottom: 4px;
+ margin-top: 12px;
+ margin-bottom: 12px;
}
/* tooltip related style info */
.ttc {
- position: absolute;
- display: none;
+ position: absolute;
+ display: none;
}
#powerTip {
cursor: default;
- /*white-space: nowrap;*/
- color: var(--tooltip-foreground-color);
+ color: var(--tooltip-foreground-color);
background-color: var(--tooltip-background-color);
+ backdrop-filter: var(--tooltip-backdrop-filter);
+ -webkit-backdrop-filter: var(--tooltip-backdrop-filter);
border: 1px solid var(--tooltip-border-color);
- border-radius: 4px 4px 4px 4px;
+ border-radius: 4px;
box-shadow: var(--tooltip-shadow);
display: none;
font-size: smaller;
max-width: 80%;
- opacity: 0.9;
padding: 1ex 1em 1em;
position: absolute;
z-index: 2147483647;
}
#powerTip div.ttdoc {
- color: var(--tooltip-doc-color);
+ color: var(--tooltip-doc-color);
font-style: italic;
}
#powerTip div.ttname a {
- font-weight: bold;
+ font-weight: bold;
}
#powerTip a {
@@ -2006,18 +2211,18 @@ tr.heading h2 {
}
#powerTip div.ttname {
- font-weight: bold;
+ font-weight: bold;
}
#powerTip div.ttdeci {
- color: var(--tooltip-declaration-color);
+ color: var(--tooltip-declaration-color);
}
#powerTip div {
- margin: 0px;
- padding: 0px;
- font-size: 12px;
- font-family: var(--font-family-tooltip);
+ margin: 0px;
+ padding: 0px;
+ font-size: 12px;
+ font-family: var(--font-family-tooltip);
line-height: 16px;
}
@@ -2063,7 +2268,7 @@ tr.heading h2 {
}
#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after {
- border-top-color: var(--tooltip-background-color);
+ border-top-color: var(--tooltip-arrow-background-color);
border-width: 10px;
margin: 0px -10px;
}
@@ -2091,7 +2296,7 @@ tr.heading h2 {
}
#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after {
- border-bottom-color: var(--tooltip-background-color);
+ border-bottom-color: var(--tooltip-arrow-background-color);
border-width: 10px;
margin: 0px -10px;
}
@@ -2148,29 +2353,29 @@ tr.heading h2 {
@media print
{
- #top { display: none; }
- #side-nav { display: none; }
- #nav-path { display: none; }
- body { overflow:visible; }
- h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
- .summary { display: none; }
- .memitem { page-break-inside: avoid; }
- #doc-content
- {
- margin-left:0 !important;
- height:auto !important;
- width:auto !important;
- overflow:inherit;
- display:inline;
- }
+ #top { display: none; }
+ #side-nav { display: none; }
+ #nav-path { display: none; }
+ body { overflow:visible; }
+ h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
+ .summary { display: none; }
+ .memitem { page-break-inside: avoid; }
+ #doc-content
+ {
+ margin-left:0 !important;
+ height:auto !important;
+ width:auto !important;
+ overflow:inherit;
+ display:inline;
+ }
}
/* @group Markdown */
table.markdownTable {
border-collapse:collapse;
- margin-top: 4px;
- margin-bottom: 4px;
+ margin-top: 4px;
+ margin-bottom: 4px;
}
table.markdownTable td, table.markdownTable th {
@@ -2203,11 +2408,11 @@ th.markdownTableHeadCenter, td.markdownTableBodyCenter {
tt, code, kbd
{
- display: inline-block;
+ display: inline-block;
}
tt, code, kbd
{
- vertical-align: top;
+ vertical-align: top;
}
/* @end */
@@ -2216,26 +2421,27 @@ u {
}
details>summary {
- list-style-type: none;
+ list-style-type: none;
}
details > summary::-webkit-details-marker {
- display: none;
+ display: none;
}
details>summary::before {
- content: "\25ba";
- padding-right:4px;
- font-size: 80%;
+ content: "\25ba";
+ padding-right:4px;
+ font-size: 80%;
}
details[open]>summary::before {
- content: "\25bc";
- padding-right:4px;
- font-size: 80%;
+ content: "\25bc";
+ padding-right:4px;
+ font-size: 80%;
}
-body {
+:root {
+ scrollbar-width: thin;
scrollbar-color: var(--scrollbar-thumb-color) var(--scrollbar-background-color);
}
diff --git a/docs/html/doxygen_crawl.html b/docs/html/doxygen_crawl.html
index 1a7784e..6b8ae0b 100644
--- a/docs/html/doxygen_crawl.html
+++ b/docs/html/doxygen_crawl.html
@@ -4,7 +4,7 @@
Validator / crawler helper
-
+
diff --git a/docs/html/dynsections.js b/docs/html/dynsections.js
index b05f4c8..0e15bd4 100644
--- a/docs/html/dynsections.js
+++ b/docs/html/dynsections.js
@@ -28,7 +28,6 @@ function toggleVisibility(linkObj) {
}
let dynsection = {
-
// helper function
updateStripes : function() {
$('table.directory tr').
@@ -44,15 +43,13 @@ let dynsection = {
const trigger = $('#'+base+'-trigger');
const src=$(trigger).attr('src');
if (content.is(':visible')===true) {
- content.hide();
+ content.slideUp('fast');
summary.show();
- $(linkObj).addClass('closed').removeClass('opened');
- $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png');
+ $(linkObj).find('.arrowhead').addClass('closed').removeClass('opened');
} else {
- content.show();
+ content.slideDown('fast');
summary.hide();
- $(linkObj).removeClass('closed').addClass('opened');
- $(trigger).attr('src',src.substring(0,src.length-10)+'open.png');
+ $(linkObj).find('.arrowhead').removeClass('closed').addClass('opened');
}
return false;
},
@@ -63,12 +60,12 @@ let dynsection = {
const i = $('#img'+this.id.substring(3));
const a = $('#arr'+this.id.substring(3));
if (lD3D12 Memory Allocator: Frequently asked questions
-
-
@@ -33,33 +31,22 @@
-
+
-
- Frequently asked questions
+ Frequently asked questions
What is D3D12MA?
@@ -96,18 +83,18 @@
What is the license of D3D12MA?
D3D12MA is licensed under MIT, which means it is open source and free software.
What is the purpose of D3D12MA?
-D3D12MA helps with handling one aspect of DX12 usage, which is GPU memory management - allocation of ID3D12Heap objects and creation of ID3D12Resource objects - buffers and textures.
+D3D12MA helps with handling one aspect of DX12 usage, which is GPU memory management - allocation of ID3D12Heap objects and creation of ID3D12Resource objects - buffers and textures.
Do I need to use D3D12MA?
You don't need to, but it may be beneficial in many cases. DX12 is a complex and low-level API, so libraries like this that abstract certain aspects of the API and bring them to a higher level are useful. When developing any non-trivial graphics application, you may benefit from using a memory allocator. Using D3D12MA can save time compared to implementing your own.
-In DX12 you can create each resource separately with its own implicit memory heap by calling CreateCommittedResource, but this may not be the optimal solution. For more information, see Committed versus placed resources.
+In DX12 you can create each resource separately with its own implicit memory heap by calling CreateCommittedResource, but this may not be the optimal solution. For more information, see Committed versus placed resources.
When should I not use D3D12MA?
While D3D12MA is useful for many applications that use the DX12 API, there are cases when it may be a better choice not to use it. For example, if the application is very simple, e.g. serving as a sample or a learning exercise to help you understand or teach others the basics of DX12, and it creates only a small number of buffers and textures, then including D3D12MA may be an overkill. Developing your own memory allocator may also be a good learning exercise.
What are the benefits of using D3D12MA?
-- D3D12MA allocates large blocks of
ID3D12Heap memory and sub-allocates parts of them to create your placed resources. Allocating a new block of GPU memory may be a time-consuming operation. Sub-allocating parts of a memory block requires implementing an allocation algorithm, which is a non-trivial task. D3D12MA does that, using an advanced and efficient algorithm that works well in various use cases.
+- D3D12MA allocates large blocks of ID3D12Heap memory and sub-allocates parts of them to create your placed resources. Allocating a new block of GPU memory may be a time-consuming operation. Sub-allocating parts of a memory block requires implementing an allocation algorithm, which is a non-trivial task. D3D12MA does that, using an advanced and efficient algorithm that works well in various use cases.
- D3D12MA offers a simple API that allows creating placed buffers and textures within one function call like D3D12MA::Allocator::CreateResource.
-The library is doing much more under the hood. For example, it keeps buffers separate from textures when needed, respecting D3D12_RESOURCE_HEAP_TIER. It also makes use of the "small texture alignment" automatically, so you don't need to think about it.
+The library is doing much more under the hood. For example, it keeps buffers separate from textures when needed, respecting D3D12_RESOURCE_HEAP_TIER. It also makes use of the "small texture alignment" automatically, so you don't need to think about it.
Which version should I pick?
You can just pick the latest version from the "master" branch. It is kept in a good shape most of the time, compiling and working correctly, with no compatibility-breaking changes and no unfinished code.
If you want an even more stable version, you can pick the latest official release. Current code from the master branch is occasionally tagged as a release, with CHANGELOG carefully curated to enumerate all important changes since the previous version.
@@ -119,10 +106,10 @@
I am not a fan of modern C++. Can I still use it?
Very likely yes. We acknowledge that many C++ developers, especially in the games industry, do not appreciate all the latest features that the language has to offer.
-- D3D12MA doesn't throw or catch any C++ exceptions. It reports errors by returning a
HRESULT value instead, just like DX12. If you don't use exceptions in your project, your code is not exception-safe, or even if you disable exception handling in the compiler options, you can still use D3D12MA.
-- D3D12MA doesn't use C++ run-time type information like
typeid or dynamic_cast, so if you disable RTTI in the compiler options, you can still use the library.
-- D3D12MA uses only a limited subset of standard C and C++ library. It doesn't use STL containers like
std::vector, map, or string, either in the public interface nor in the internal implementation. It implements its own containers instead.
-- If you don't use the default heap memory allocator through
malloc/free or new/delete but implement your own allocator instead, you can pass it to D3D12MA as D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks and the library will use your functions for every dynamic heap allocation made internally.
+- D3D12MA doesn't throw or catch any C++ exceptions. It reports errors by returning a HRESULT value instead, just like DX12. If you don't use exceptions in your project, your code is not exception-safe, or even if you disable exception handling in the compiler options, you can still use D3D12MA.
+- D3D12MA doesn't use C++ run-time type information like typeid or dynamic_cast, so if you disable RTTI in the compiler options, you can still use the library.
+- D3D12MA uses only a limited subset of standard C and C++ library. It doesn't use STL containers like std::vector, map, or string, either in the public interface nor in the internal implementation. It implements its own containers instead.
+- If you don't use the default heap memory allocator through malloc/free or new/delete but implement your own allocator instead, you can pass it to D3D12MA as D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks and the library will use your functions for every dynamic heap allocation made internally.
Is it available for other programming languages?
D3D12MA is a C++ library in similar style as DX12. Bindings to other programming languages are out of scope of this project, but they are welcome as external projects. Some of them are listed in README.md, "See also" section, including binding to C. Before using any of them, please check if they are still maintained and updated to use a recent version of D3D12MA.
@@ -132,7 +119,7 @@
No! While D3D12MA is published by AMD, it works on any GPU that supports DX12, whether a discrete PC graphics card or a processor integrated graphics. It doesn't give AMD GPUs any advantage over any other GPUs.
What DirectX 12 versions are supported?
D3D12MA is updated to support latest versions of DirectX 12, as available through recent retail versions of the DirectX 12 Agility SDK. Support for new features added in the preview version of the Agility SDK is developed on separate branches until they are included in the retail version.
-The library also supports older versions down to the base DX12 shipping with Windows SDK. Features added by later versions of the Agility SDK are automatically enabled conditionally using #ifdef preprocessor macros depending on the version of the SDK that you compile your project with.
+The library also supports older versions down to the base DX12 shipping with Windows SDK. Features added by later versions of the Agility SDK are automatically enabled conditionally using #ifdef preprocessor macros depending on the version of the SDK that you compile your project with.
Does it support other graphics APIs, like Vulkan(R)?
No, but we offer an equivalent library for Vulkan: Vulkan Memory Allocator. It uses the same core allocation algorithm. It also shares many features with D3D12MA, like the support for custom pools and virtual allocator. However, it is not identical in terms of the features supported. Its API also looks different, because while the interface of D3D12MA is similar in style to DX12, the interface of VMA is similar to Vulkan.
Is the library lightweight?
@@ -154,8 +141,8 @@
If you want to report a suspected bug, you can also create a ticket the same way. Before doing this, please put some effort into the investigation of whether the bug is really in the library and not in your code or in the DX12 implementation (the GPU driver) on your platform:
- Enable D3D Debug Layer and make sure it is free from any errors.
-- Make sure
D3D12MA_ASSERT is defined to an implementation that can report a failure and not ignore it.
-- Try making your allocation using pure DX12 functions like
CreateCommittedResource() rather than D3D12MA and see if the bug persists.
+- Make sure D3D12MA_ASSERT is defined to an implementation that can report a failure and not ignore it.
+- Try making your allocation using pure DX12 functions like CreateCommittedResource() rather than D3D12MA and see if the bug persists.
I found some compilation warnings. How can we fix them?
Seeing compiler warnings may be annoying to some developers, but it is a design decision to not fix all of them. Due to the nature of the C++ language, certain preprocessor macros can make some variables unused, function parameters unreferenced, or conditional expressions constant in some configurations. The code of this library should not be bigger or more complicated just to silence these warnings. It is recommended to disable such warnings instead. For more information, see Features not supported.
@@ -164,7 +151,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/files.html b/docs/html/files.html
index 0ccb6a5..5ce45bf 100644
--- a/docs/html/files.html
+++ b/docs/html/files.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: File List
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all files with brief descriptions:
[detail level 12]
- ▼ include D3D12MemAlloc.h include D3D12MemAlloc.h
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions.html b/docs/html/functions.html
index 0690bb7..e1beea4 100644
--- a/docs/html/functions.html
+++ b/docs/html/functions.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all class members with links to the classes they belong to:
-- a -
+- a -
- Alignment : D3D12MA::VIRTUAL_ALLOCATION_DESC
- Allocate() : D3D12MA::VirtualBlock
- AllocateMemory() : D3D12MA::Allocator
@@ -100,7 +87,7 @@ - a -
-- b -
+- b -
- BeginDefragmentation() : D3D12MA::Allocator, D3D12MA::Pool
- BeginPass() : D3D12MA::DefragmentationContext
- block : D3D12MA::Allocation
@@ -114,7 +101,7 @@ - b -
-- c -
+- c -
- CalculateStatistics() : D3D12MA::Allocator, D3D12MA::Pool, D3D12MA::VirtualBlock
- CALLOCATION_DESC() : D3D12MA::CALLOCATION_DESC
- Clear() : D3D12MA::VirtualBlock
@@ -134,25 +121,25 @@ - c -
-- d -
+- d -
- D3D12MA_DELETE : D3D12MA::Allocation, D3D12MA::Allocator, D3D12MA::DefragmentationContext, D3D12MA::Pool, D3D12MA::VirtualBlock
-- e -
+- e -
- EndPass() : D3D12MA::DefragmentationContext
- ExtraHeapFlags : D3D12MA::ALLOCATION_DESC
-- f -
+- f -
- Flags : D3D12MA::ALLOCATION_DESC, D3D12MA::ALLOCATOR_DESC, D3D12MA::DEFRAGMENTATION_DESC, D3D12MA::POOL_DESC, D3D12MA::VIRTUAL_ALLOCATION_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
- FreeAllocation() : D3D12MA::VirtualBlock
- FreeStatsString() : D3D12MA::Allocator, D3D12MA::VirtualBlock
-- g -
+- g -
- GetAlignment() : D3D12MA::Allocation
- GetAllocationInfo() : D3D12MA::VirtualBlock
- GetBudget() : D3D12MA::Allocator
@@ -170,7 +157,7 @@ - g -
-- h -
+- h -
- heap : D3D12MA::Allocation
- HeapFlags : D3D12MA::POOL_DESC
- HeapProperties : D3D12MA::POOL_DESC
@@ -179,7 +166,7 @@ - h -
-- i -
+- i -
- IsCacheCoherentUMA() : D3D12MA::Allocator
- IsEmpty() : D3D12MA::VirtualBlock
- IsGPUUploadHeapSupported() : D3D12MA::Allocator
@@ -187,12 +174,12 @@ - i -
-- l -
+- l -
- list : D3D12MA::Allocation
-- m -
+- m -
- m_Committed : D3D12MA::Allocation
- m_Heap : D3D12MA::Allocation
- m_Placed : D3D12MA::Allocation
@@ -206,18 +193,18 @@ - m -
-- n -
+- n -
- next : D3D12MA::Allocation
-- o -
+- o -
- Offset : D3D12MA::VIRTUAL_ALLOCATION_INFO
- Operation : D3D12MA::DEFRAGMENTATION_MOVE
-- p -
+- p -
- pAdapter : D3D12MA::ALLOCATOR_DESC
- pAllocate : D3D12MA::ALLOCATION_CALLBACKS
- pAllocationCallbacks : D3D12MA::ALLOCATOR_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
@@ -233,12 +220,12 @@ - p -
-- r -
+- r -
- ResidencyPriority : D3D12MA::POOL_DESC
-- s -
+- s -
- SetAllocationPrivateData() : D3D12MA::VirtualBlock
- SetCurrentFrameIndex() : D3D12MA::Allocator
- SetName() : D3D12MA::Allocation, D3D12MA::Pool
@@ -249,12 +236,12 @@ - s -
-- t -
+- t -
- Total : D3D12MA::TotalStatistics
-- u -
+- u -
- UnusedRangeCount : D3D12MA::DetailedStatistics
- UnusedRangeSizeMax : D3D12MA::DetailedStatistics
- UnusedRangeSizeMin : D3D12MA::DetailedStatistics
@@ -263,7 +250,7 @@ - u -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html
index 23515d8..8f38cf0 100644
--- a/docs/html/functions_func.html
+++ b/docs/html/functions_func.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members - Functions
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all functions with links to the classes they belong to:
-- a -
+- a -
- Allocate() : D3D12MA::VirtualBlock
- AllocateMemory() : D3D12MA::Allocator
-- b -
+- b -
- BeginDefragmentation() : D3D12MA::Allocator, D3D12MA::Pool
- BeginPass() : D3D12MA::DefragmentationContext
- BuildStatsString() : D3D12MA::Allocator, D3D12MA::VirtualBlock
-- c -
+- c -
- CalculateStatistics() : D3D12MA::Allocator, D3D12MA::Pool, D3D12MA::VirtualBlock
- CALLOCATION_DESC() : D3D12MA::CALLOCATION_DESC
- Clear() : D3D12MA::VirtualBlock
@@ -116,18 +103,18 @@ - c -
-- e -
+- e -
- EndPass() : D3D12MA::DefragmentationContext
-- f -
+- f -
- FreeAllocation() : D3D12MA::VirtualBlock
- FreeStatsString() : D3D12MA::Allocator, D3D12MA::VirtualBlock
-- g -
+- g -
- GetAlignment() : D3D12MA::Allocation
- GetAllocationInfo() : D3D12MA::VirtualBlock
- GetBudget() : D3D12MA::Allocator
@@ -145,7 +132,7 @@ - g -
-- i -
+- i -
- IsCacheCoherentUMA() : D3D12MA::Allocator
- IsEmpty() : D3D12MA::VirtualBlock
- IsGPUUploadHeapSupported() : D3D12MA::Allocator
@@ -153,7 +140,7 @@ - i -
-- s -
+- s -
- SetAllocationPrivateData() : D3D12MA::VirtualBlock
- SetCurrentFrameIndex() : D3D12MA::Allocator
- SetName() : D3D12MA::Allocation, D3D12MA::Pool
@@ -163,7 +150,7 @@ - s -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions_rela.html b/docs/html/functions_rela.html
index b9d0728..f21eddd 100644
--- a/docs/html/functions_rela.html
+++ b/docs/html/functions_rela.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members - Related Symbols
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions_vars.html b/docs/html/functions_vars.html
index f63ab83..fe4ed5f 100644
--- a/docs/html/functions_vars.html
+++ b/docs/html/functions_vars.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members - Variables
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all variables with links to the classes they belong to:
-- a -
+- a -
- Alignment : D3D12MA::VIRTUAL_ALLOCATION_DESC
- AllocationBytes : D3D12MA::Statistics
- AllocationCount : D3D12MA::Statistics
@@ -98,7 +85,7 @@ - a -
-- b -
+- b -
- block : D3D12MA::Allocation
- BlockBytes : D3D12MA::Statistics
- BlockCount : D3D12MA::Statistics
@@ -109,22 +96,22 @@ - b -
-- c -
+- c -
- CustomPool : D3D12MA::ALLOCATION_DESC
-- e -
+- e -
- ExtraHeapFlags : D3D12MA::ALLOCATION_DESC
-- f -
+- f -
- Flags : D3D12MA::ALLOCATION_DESC, D3D12MA::ALLOCATOR_DESC, D3D12MA::DEFRAGMENTATION_DESC, D3D12MA::POOL_DESC, D3D12MA::VIRTUAL_ALLOCATION_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
-- h -
+- h -
- heap : D3D12MA::Allocation
- HeapFlags : D3D12MA::POOL_DESC
- HeapProperties : D3D12MA::POOL_DESC
@@ -133,12 +120,12 @@ - h -
-- l -
+- l -
- list : D3D12MA::Allocation
-- m -
+- m -
- m_Committed : D3D12MA::Allocation
- m_Heap : D3D12MA::Allocation
- m_Placed : D3D12MA::Allocation
@@ -152,18 +139,18 @@ - m -
-- n -
+- n -
- next : D3D12MA::Allocation
-- o -
+- o -
- Offset : D3D12MA::VIRTUAL_ALLOCATION_INFO
- Operation : D3D12MA::DEFRAGMENTATION_MOVE
-- p -
+- p -
- pAdapter : D3D12MA::ALLOCATOR_DESC
- pAllocate : D3D12MA::ALLOCATION_CALLBACKS
- pAllocationCallbacks : D3D12MA::ALLOCATOR_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
@@ -179,23 +166,23 @@ - p -
-- r -
+- r -
- ResidencyPriority : D3D12MA::POOL_DESC
-- s -
+- s -
- Size : D3D12MA::VIRTUAL_ALLOCATION_DESC, D3D12MA::VIRTUAL_ALLOCATION_INFO, D3D12MA::VIRTUAL_BLOCK_DESC
- Stats : D3D12MA::Budget, D3D12MA::DetailedStatistics
-- t -
+- t -
- Total : D3D12MA::TotalStatistics
-- u -
+- u -
- UnusedRangeCount : D3D12MA::DetailedStatistics
- UnusedRangeSizeMax : D3D12MA::DetailedStatistics
- UnusedRangeSizeMin : D3D12MA::DetailedStatistics
@@ -204,7 +191,7 @@ - u -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/general_considerations.html b/docs/html/general_considerations.html
index ef3888a..05a30ff 100644
--- a/docs/html/general_considerations.html
+++ b/docs/html/general_considerations.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: General considerations
-
-
@@ -33,33 +31,22 @@
-
+
-
- General considerations
+ General considerations
-
+
Thread safety
-- The library has no global state, so separate D3D12MA::Allocator objects can be used independently. In typical applications there should be no need to create multiple such objects though - one per
ID3D12Device is enough.
+- The library has no global state, so separate D3D12MA::Allocator objects can be used independently. In typical applications there should be no need to create multiple such objects though - one per ID3D12Device is enough.
- All calls to methods of D3D12MA::Allocator class are safe to be made from multiple threads simultaneously because they are synchronized internally when needed.
- When the allocator is created with D3D12MA::ALLOCATOR_FLAG_SINGLETHREADED, calls to methods of D3D12MA::Allocator class must be made from a single thread or synchronized by the user. Using this flag may improve performance.
- D3D12MA::VirtualBlock is not safe to be used from multiple threads simultaneously.
-
+
Versioning and compatibility
The library uses Semantic Versioning, which means version numbers follow convention: Major.Minor.Patch (e.g. 2.3.0), where:
@@ -109,13 +96,13 @@ <
All changes between official releases are documented in file "CHANGELOG.md".
- Warning
- Backward compatiblity is considered on the level of C++ source code, not binary linkage. Adding new members to existing structures is treated as backward compatible if initializing the new members to binary zero results in the old behavior. You should always fully initialize all library structures to zeros and not rely on their exact binary size.
-
+
Features not supported
Features deliberately excluded from the scope of this library:
- Descriptor allocation. Although also called "heaps", objects that represent descriptors are separate part of the D3D12 API from buffers and textures. You can still use Virtual allocator to manage descriptors and their ranges inside a descriptor heap.
- Support for reserved (tiled) resources. We don't recommend using them. For more information, see [1].
-- Support for
ID3D12Device::Evict and MakeResident. We don't recommend using them. You can call them on the D3D12 objects manually. Plese keep in mind, however, that eviction happens on the level of entire ID3D12Heap memory blocks and not individual buffers or textures which may be placed inside them.
+- Support for ID3D12Device::Evict and MakeResident. We don't recommend using them. You can call them on the D3D12 objects manually. Plese keep in mind, however, that eviction happens on the level of entire ID3D12Heap memory blocks and not individual buffers or textures which may be placed inside them.
- Handling CPU memory allocation failures. When dynamically creating small C++ objects in CPU memory (not the GPU memory), allocation failures are not handled gracefully, because that would complicate code significantly and is usually not needed in desktop PC applications anyway. Success of an allocation is just checked with an assert.
- Code free of any compiler warnings. There are many preprocessor macros that make some variables unused, function parameters unreferenced, or conditional expressions constant in some configurations. The code of this library should not be bigger or more complicated just to silence these warnings. It is recommended to disable such warnings instead.
- This is a C++ library. Bindings or ports to any other programming languages are welcome as external projects but are not going to be included into this repository.
@@ -125,7 +112,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/globals.html b/docs/html/globals.html
index 00f8dbd..27989c1 100644
--- a/docs/html/globals.html
+++ b/docs/html/globals.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: File Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/globals_defs.html b/docs/html/globals_defs.html
index feb2e5c..00db10d 100644
--- a/docs/html/globals_defs.html
+++ b/docs/html/globals_defs.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: File Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html
index 292f556..5785855 100644
--- a/docs/html/hierarchy.html
+++ b/docs/html/hierarchy.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Hierarchy
-
-
@@ -33,35 +31,24 @@
-
+
-
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 12]
CD3D12MA::ALLOCATION_CALLBACKS Custom callbacks to CPU memory allocation functions ▼CD3D12MA::ALLOCATION_DESC Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource CD3D12MA::ALLOCATION_DESC Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource CD3D12MA::CALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure CD3D12MA::ALLOCATOR_DESC Parameters of created Allocator object. To be used with CreateAllocator() CD3D12MA::Budget Statistics of current memory usage and available budget for a specific memory segment group CD3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Parameters for incremental defragmentation steps CD3D12MA::DEFRAGMENTATION_STATS Statistics returned for defragmentation process by function DefragmentationContext::GetStats() CD3D12MA::DetailedStatistics More detailed statistics than D3D12MA::Statistics ▼CIUnknownImpl CIUnknownImpl CD3D12MA::Allocation Represents single memory allocation CD3D12MA::Allocator Represents main object of this library initialized for particular ID3D12Device CD3D12MA::Allocator Represents main object of this library initialized for particular ID3D12Device CD3D12MA::DefragmentationContext Represents defragmentation process in progress CD3D12MA::Pool Custom memory pool CD3D12MA::VirtualBlock Represents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory ▼CD3D12MA::POOL_DESC Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool CD3D12MA::POOL_DESC Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool CD3D12MA::CPOOL_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure CD3D12MA::Statistics Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total CD3D12MA::TotalStatistics General statistics from current state of the allocator - total memory usage across all memory heaps and segments ▼CD3D12MA::VIRTUAL_ALLOCATION_DESC Parameters of created virtual allocation to be passed to VirtualBlock::Allocate() CD3D12MA::VIRTUAL_ALLOCATION_DESC Parameters of created virtual allocation to be passed to VirtualBlock::Allocate() CD3D12MA::CVIRTUAL_ALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure CD3D12MA::VIRTUAL_ALLOCATION_INFO Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo() ▼CD3D12MA::VIRTUAL_BLOCK_DESC Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock() CD3D12MA::VIRTUAL_BLOCK_DESC Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock() CD3D12MA::CVIRTUAL_BLOCK_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure CD3D12MA::VirtualAllocation Represents single memory allocation done inside VirtualBlock
@@ -120,7 +107,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/index.html b/docs/html/index.html
index e005026..d7434ba 100644
--- a/docs/html/index.html
+++ b/docs/html/index.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12 Memory Allocator
-
-
@@ -33,35 +31,24 @@
-
+
-
D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved.
License: MIT
-Documentation of all members: D3D12MemAlloc.h
-
+
Documentation of all members: D3D12MemAlloc.h
+
Table of contents
- Frequently asked questions
@@ -131,10 +118,10 @@
-
+
Web links
-- Direct3D 12 Memory Allocator at GPUOpen.com - product page
+- Direct3D 12 Memory Allocator at GPUOpen.com - product page
- GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com - source code repository
@@ -142,7 +129,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/linear_algorithm.html b/docs/html/linear_algorithm.html
index 25d5301..0bc59b0 100644
--- a/docs/html/linear_algorithm.html
+++ b/docs/html/linear_algorithm.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Linear allocation algorithm
-
-
@@ -33,33 +31,22 @@
-
+
-
- Linear allocation algorithm
+ Linear allocation algorithm
Each D3D12 memory block managed by this library has accompanying metadata that keeps track of used and unused regions. By default, the metadata structure and algorithm tries to find best place for new allocations among free regions to optimize memory usage. This way you can allocate and free objects in any order.
@@ -96,17 +83,17 @@
Sometimes there is a need to use simpler, linear allocation algorithm. You can create custom pool that uses such algorithm by adding flag D3D12MA::POOL_FLAG_ALGORITHM_LINEAR to D3D12MA::POOL_DESC::Flags while creating D3D12MA::Pool object. Then an alternative metadata management is used. It always creates new allocations after last one and doesn't reuse free regions after allocations freed in the middle. It results in better allocation performance and less memory consumed by metadata.
With this one flag, you can create a custom pool that can be used in many ways: free-at-once, stack, double stack, and ring buffer. See below for details. You don't need to specify explicitly which of these options you are going to use - it is detected automatically.
-
+
Free-at-once
-
In a pool that uses linear algorithm, you still need to free all the allocations individually by calling allocation->Release(). You can free them in any order. New allocations are always made after last one - free space in the middle is not reused. However, when you release all the allocation and the pool becomes empty, allocation starts from the beginning again. This way you can use linear algorithm to speed up creation of allocations that you are going to release all at once.
+In a pool that uses linear algorithm, you still need to free all the allocations individually by calling allocation->Release(). You can free them in any order. New allocations are always made after last one - free space in the middle is not reused. However, when you release all the allocation and the pool becomes empty, allocation starts from the beginning again. This way you can use linear algorithm to speed up creation of allocations that you are going to release all at once.
This mode is also available for pools created with D3D12MA::POOL_DESC::MaxBlockCount value that allows multiple memory blocks.
-
+
Stack
When you free an allocation that was created last, its space can be reused. Thanks to this, if you always release allocations in the order opposite to their creation (LIFO - Last In First Out), you can achieve behavior of a stack.
This mode is also available for pools created with D3D12MA::POOL_DESC::MaxBlockCount value that allows multiple memory blocks.
-
+
Double stack
The space reserved by a custom pool with linear algorithm may be used by two stacks:
@@ -116,20 +103,20 @@
To make allocation from the upper stack, add flag D3D12MA::ALLOCATION_FLAG_UPPER_ADDRESS to D3D12MA::ALLOCATION_DESC::Flags.
Double stack is available only in pools with one memory block - D3D12MA::POOL_DESC::MaxBlockCount must be 1. Otherwise behavior is undefined.
-When the two stacks' ends meet so there is not enough space between them for a new allocation, such allocation fails with usual E_OUTOFMEMORY error.
-
+
When the two stacks' ends meet so there is not enough space between them for a new allocation, such allocation fails with usual E_OUTOFMEMORY error.
+
Ring buffer
When you free some allocations from the beginning and there is not enough free space for a new one at the end of a pool, allocator's "cursor" wraps around to the beginning and starts allocation there. Thanks to this, if you always release allocations in the same order as you created them (FIFO - First In First Out), you can achieve behavior of a ring buffer / queue.
Ring buffer is available only in pools with one memory block - D3D12MA::POOL_DESC::MaxBlockCount must be 1. Otherwise behavior is undefined.
-
+
Additional considerations
Linear algorithm can also be used with Virtual allocator. See flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/menu.js b/docs/html/menu.js
index 0fd1e99..15f9c52 100644
--- a/docs/html/menu.js
+++ b/docs/html/menu.js
@@ -49,7 +49,7 @@ function initMenu(relPath,searchEnabled,serverSide,searchPage,search,treeview) {
searchBoxHtml=''+
''+
'');
$('#main-nav').append(makeTree(menudata,relPath));
$('#main-nav').children(':first').addClass('sm sm-dox').attr('id','main-menu');
- if (searchBoxHtml) {
- $('#main-menu').append('');
- }
+ $('#main-menu').append('');
const $mainMenuState = $('#main-menu-state');
let prevWidth = 0;
if ($mainMenuState.length) {
diff --git a/docs/html/namespace_d3_d12_m_a.html b/docs/html/namespace_d3_d12_m_a.html
index e770fdc..b4ae5de 100644
--- a/docs/html/namespace_d3_d12_m_a.html
+++ b/docs/html/namespace_d3_d12_m_a.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA Namespace Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
-
+
Classes
class Allocation class Allocation Represents single memory allocation. More...
struct ALLOCATION_CALLBACKS struct ALLOCATION_CALLBACKS Custom callbacks to CPU memory allocation functions. More...
struct ALLOCATION_DESC struct ALLOCATION_DESC Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource. More...
class Allocator Represents main object of this library initialized for particular ID3D12Device. More...
struct ALLOCATOR_DESC class Allocator Represents main object of this library initialized for particular ID3D12Device. More...
struct ALLOCATOR_DESC Parameters of created Allocator object. To be used with CreateAllocator(). More...
struct Budget struct Budget Statistics of current memory usage and available budget for a specific memory segment group. More...
struct CALLOCATION_DESC struct CALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure. More...
struct CPOOL_DESC struct CPOOL_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure. More...
struct CVIRTUAL_ALLOCATION_DESC struct CVIRTUAL_ALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure. More...
struct CVIRTUAL_BLOCK_DESC struct CVIRTUAL_BLOCK_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure. More...
struct DEFRAGMENTATION_DESC struct DEFRAGMENTATION_DESC Parameters for defragmentation. More...
struct DEFRAGMENTATION_MOVE struct DEFRAGMENTATION_MOVE Single move of an allocation to be done for defragmentation. More...
struct DEFRAGMENTATION_PASS_MOVE_INFO struct DEFRAGMENTATION_PASS_MOVE_INFO Parameters for incremental defragmentation steps. More...
struct DEFRAGMENTATION_STATS struct DEFRAGMENTATION_STATS Statistics returned for defragmentation process by function DefragmentationContext::GetStats(). More...
class DefragmentationContext class DefragmentationContext Represents defragmentation process in progress. More...
struct DetailedStatistics struct DetailedStatistics More detailed statistics than D3D12MA::Statistics. More...
class Pool class Pool Custom memory pool. More...
struct POOL_DESC struct POOL_DESC Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool. More...
struct Statistics struct Statistics Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total. More...
struct TotalStatistics struct TotalStatistics General statistics from current state of the allocator - total memory usage across all memory heaps and segments. More...
struct VIRTUAL_ALLOCATION_DESC struct VIRTUAL_ALLOCATION_DESC Parameters of created virtual allocation to be passed to VirtualBlock::Allocate(). More...
struct VIRTUAL_ALLOCATION_INFO struct VIRTUAL_ALLOCATION_INFO Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo(). More...
struct VIRTUAL_BLOCK_DESC struct VIRTUAL_BLOCK_DESC Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock(). More...
struct VirtualAllocation struct VirtualAllocation Represents single memory allocation done inside VirtualBlock. More...
class VirtualBlock class VirtualBlock Represents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory. More...
-
+
Typedefs
typedef UINT64 AllocHandle Unique identifier of single allocation done inside the memory heap.
using ALLOCATE_FUNC_PTR = void* (*)(size_t Size, size_t Alignment, void* pPrivateData) Pointer to custom callback function that allocates CPU memory.
using FREE_FUNC_PTR = void (*)(void* pMemory, void* pPrivateData) Pointer to custom callback function that deallocates CPU memory.
-
+
Enumerations
enum ALLOCATION_FLAGS {
ALLOCATION_FLAG_NONE = 0
@@ -203,20 +162,17 @@
} Bit flags to be used with ALLOCATION_DESC::Flags. More...
enum DEFRAGMENTATION_FLAGS { DEFRAGMENTATION_FLAG_ALGORITHM_FAST = 0x1
, DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED = 0x2
, DEFRAGMENTATION_FLAG_ALGORITHM_FULL = 0x4
, DEFRAGMENTATION_FLAG_ALGORITHM_MASK
} Flags to be passed as DEFRAGMENTATION_DESC::Flags. More...
enum DEFRAGMENTATION_MOVE_OPERATION { DEFRAGMENTATION_MOVE_OPERATION_COPY = 0
, DEFRAGMENTATION_MOVE_OPERATION_IGNORE = 1
, DEFRAGMENTATION_MOVE_OPERATION_DESTROY = 2
} Operation performed on single defragmentation move. More...
enum POOL_FLAGS {
POOL_FLAG_NONE = 0
, POOL_FLAG_ALGORITHM_LINEAR = 0x1
@@ -227,7 +183,6 @@
} Bit flags to be used with POOL_DESC::Flags. More...
enum ALLOCATOR_FLAGS {
ALLOCATOR_FLAG_NONE = 0
, ALLOCATOR_FLAG_SINGLETHREADED = 0x1
@@ -239,13 +194,11 @@
} Bit flags to be used with ALLOCATOR_DESC::Flags. More...
enum VIRTUAL_BLOCK_FLAGS { VIRTUAL_BLOCK_FLAG_NONE = 0
, VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR = POOL_FLAG_ALGORITHM_LINEAR
, VIRTUAL_BLOCK_FLAG_ALGORITHM_MASK = POOL_FLAG_ALGORITHM_MASK
} Bit flags to be used with VIRTUAL_BLOCK_DESC::Flags. More...
enum VIRTUAL_ALLOCATION_FLAGS {
VIRTUAL_ALLOCATION_FLAG_NONE = 0
, VIRTUAL_ALLOCATION_FLAG_UPPER_ADDRESS = ALLOCATION_FLAG_UPPER_ADDRESS
@@ -257,18 +210,15 @@
} Bit flags to be used with VIRTUAL_ALLOCATION_DESC::Flags. More...
-
+
Functions
D3D12MA_API HRESULT CreateAllocator (const ALLOCATOR_DESC *pDesc, Allocator **ppAllocator) Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
D3D12MA_API HRESULT CreateVirtualBlock (const VIRTUAL_BLOCK_DESC *pDesc, VirtualBlock **ppVirtualBlock) Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
-Typedef Documentation
+Typedef Documentation
◆ ALLOCATE_FUNC_PTR
@@ -314,11 +264,11 @@
Pointer to custom callback function that deallocates CPU memory.
-pMemory = null should be accepted and ignored.
+pMemory = null should be accepted and ignored.
-Enumeration Type Documentation
+Enumeration Type Documentation
◆ ALLOCATION_FLAGS
@@ -338,21 +288,21 @@ ALLOCATION_FLAG_COMMITTED Set this flag if the allocation should have its own dedicated memory allocation (committed resource with implicit heap).
Use it for special, big resources, like fullscreen textures used as render targets.
-- When used with functions like D3D12MA::Allocator::CreateResource, it will use
ID3D12Device::CreateCommittedResource, so the created allocation will contain a resource (D3D12MA::Allocation::GetResource() != NULL) but will not have a heap (D3D12MA::Allocation::GetHeap() == NULL), as the heap is implicit.
-- When used with raw memory allocation like D3D12MA::Allocator::AllocateMemory, it will use
ID3D12Device::CreateHeap, so the created allocation will contain a heap (D3D12MA::Allocation::GetHeap() != NULL) and its offset will always be 0.
+- When used with functions like D3D12MA::Allocator::CreateResource, it will use ID3D12Device::CreateCommittedResource, so the created allocation will contain a resource (D3D12MA::Allocation::GetResource() != NULL) but will not have a heap (D3D12MA::Allocation::GetHeap() == NULL), as the heap is implicit.
+- When used with raw memory allocation like D3D12MA::Allocator::AllocateMemory, it will use ID3D12Device::CreateHeap, so the created allocation will contain a heap (D3D12MA::Allocation::GetHeap() != NULL) and its offset will always be 0.
ALLOCATION_FLAG_NEVER_ALLOCATE Set this flag to only try to allocate from existing memory heaps and never create new such heap.
-If new allocation cannot be placed in any of the existing heaps, allocation fails with E_OUTOFMEMORY error.
+If new allocation cannot be placed in any of the existing heaps, allocation fails with E_OUTOFMEMORY error.
You should not use D3D12MA::ALLOCATION_FLAG_COMMITTED and D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE at the same time. It makes no sense.
ALLOCATION_FLAG_WITHIN_BUDGET Create allocation only if additional memory required for it, if any, won't exceed memory budget. Otherwise return E_OUTOFMEMORY.
+ALLOCATION_FLAG_WITHIN_BUDGET Create allocation only if additional memory required for it, if any, won't exceed memory budget. Otherwise return E_OUTOFMEMORY.
ALLOCATION_FLAG_UPPER_ADDRESS Allocation will be created from upper stack in a double stack pool.
This flag is only allowed for custom pools created with POOL_FLAG_ALGORITHM_LINEAR flag.
ALLOCATION_FLAG_CAN_ALIAS Set this flag if the allocated memory will have aliasing resources.
-Use this when calling D3D12MA::Allocator::CreateResource() and similar to guarantee creation of explicit heap for desired allocation and prevent it from using CreateCommittedResource, so that new allocation object will always have allocation->GetHeap() != NULL.
+Use this when calling D3D12MA::Allocator::CreateResource() and similar to guarantee creation of explicit heap for desired allocation and prevent it from using CreateCommittedResource, so that new allocation object will always have allocation->GetHeap() != NULL.
ALLOCATION_FLAG_STRATEGY_MIN_MEMORY Allocation strategy that chooses smallest possible free range for the allocation to minimize memory usage and fragmentation, possibly at the expense of allocation time.
ALLOCATION_FLAG_STRATEGY_FIRST_FIT Alias to ALLOCATION_FLAG_STRATEGY_MIN_TIME.
ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
+ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
ALLOCATOR_FLAG_ALWAYS_COMMITTED Every allocation will be created as a committed resource - will have its own memory block.
Affects both default pools and custom pools. To be used for debugging purposes only. There is also an equivalent flag for custom pools: D3D12MA::POOL_FLAG_ALWAYS_COMMITTED.
ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED Heaps created for the default pools will be created with flag D3D12_HEAP_FLAG_CREATE_NOT_ZEROED, allowing for their memory to be not zeroed by the system if possible, which can speed up allocation.
+ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED Heaps created for the default pools will be created with flag D3D12_HEAP_FLAG_CREATE_NOT_ZEROED, allowing for their memory to be not zeroed by the system if possible, which can speed up allocation.
Only affects default pools. To use the flag with Custom memory pools, you need to add it manually:
poolDesc.heapFlags |= D3D12_HEAP_FLAG_CREATE_NOT_ZEROED;
-Only avaiable if ID3D12Device8 is present. Otherwise, the flag is ignored.
+Only avaiable if ID3D12Device8 is present. Otherwise, the flag is ignored.
ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED Optimization, allocate MSAA textures as committed resources always.
Specify this flag to create MSAA textures with implicit heaps, as if they were created with flag D3D12MA::ALLOCATION_FLAG_COMMITTED. Usage of this flags enables all default pools to create its heaps on smaller alignment not suitable for MSAA textures.
@@ -424,11 +374,11 @@
Enumerator DEFRAGMENTATION_FLAG_ALGORITHM_FAST Use simple but fast algorithm for defragmentation. May not achieve best results but will require least time to compute and least allocations to copy.
DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED Default defragmentation algorithm, applied also when no ALGORITHM flag is specified. Offers a balance between defragmentation quality and the amount of allocations and bytes that need to be moved.
+DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED Default defragmentation algorithm, applied also when no ALGORITHM flag is specified. Offers a balance between defragmentation quality and the amount of allocations and bytes that need to be moved.
DEFRAGMENTATION_FLAG_ALGORITHM_FULL Perform full defragmentation of memory. Can result in notably more time to compute and allocations to copy, but will achieve best memory packing.
DEFRAGMENTATION_FLAG_ALGORITHM_MASK A bit mask to extract only ALGORITHM bits from entire set of flags.
+DEFRAGMENTATION_FLAG_ALGORITHM_MASK A bit mask to extract only ALGORITHM bits from entire set of flags.
-Enumerator DEFRAGMENTATION_MOVE_OPERATION_COPY Resource has been recreated at pDstTmpAllocation, data has been copied, old resource has been destroyed. pSrcAllocation will be changed to point to the new place. This is the default value set by DefragmentationContext::BeginPass().
+Enumerator DEFRAGMENTATION_MOVE_OPERATION_COPY Resource has been recreated at pDstTmpAllocation, data has been copied, old resource has been destroyed. pSrcAllocation will be changed to point to the new place. This is the default value set by DefragmentationContext::BeginPass().
DEFRAGMENTATION_MOVE_OPERATION_IGNORE Set this value if you cannot move the allocation. New place reserved at pDstTmpAllocation will be freed. pSrcAllocation will remain unchanged.
+DEFRAGMENTATION_MOVE_OPERATION_IGNORE Set this value if you cannot move the allocation. New place reserved at pDstTmpAllocation will be freed. pSrcAllocation will remain unchanged.
DEFRAGMENTATION_MOVE_OPERATION_DESTROY Set this value if you decide to abandon the allocation and you destroyed the resource. New place reserved pDstTmpAllocation will be freed, along with pSrcAllocation.
+DEFRAGMENTATION_MOVE_OPERATION_DESTROY Set this value if you decide to abandon the allocation and you destroyed the resource. New place reserved pDstTmpAllocation will be freed, along with pSrcAllocation.
VIRTUAL_ALLOCATION_FLAG_STRATEGY_MIN_OFFSET
Allocation strategy that chooses always the lowest offset in available space. This is not the most efficient strategy but achieves highly packed data.
VIRTUAL_ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
+VIRTUAL_ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
These strategy flags are binary compatible with equivalent flags in ALLOCATION_FLAGS.
Function Documentation
+Function Documentation
◆ CreateAllocator()
@@ -567,8 +517,8 @@
-Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
-You normally only need to call it once and keep a single Allocator object for your ID3D12Device.
+Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
+You normally only need to call it once and keep a single Allocator object for your ID3D12Device.
@@ -591,7 +541,7 @@
-Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
+Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
Note you don't need to create D3D12MA::Allocator to use virtual blocks.
@@ -599,7 +549,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers.html b/docs/html/namespacemembers.html
index 6881ab0..4cadc29 100644
--- a/docs/html/namespacemembers.html
+++ b/docs/html/namespacemembers.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all namespace members with links to the namespace documentation for each member:
-- a -
+- a -
- ALLOCATE_FUNC_PTR : D3D12MA
- ALLOCATION_FLAG_CAN_ALIAS : D3D12MA
- ALLOCATION_FLAG_COMMITTED : D3D12MA
@@ -112,13 +99,13 @@ - a -
-- c -
+- c -
-- d -
+- d -
- DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FAST : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FULL : D3D12MA
@@ -131,12 +118,12 @@ - d -
-- f -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_enum.html b/docs/html/namespacemembers_enum.html
index 5723a6b..90ffd55 100644
--- a/docs/html/namespacemembers_enum.html
+++ b/docs/html/namespacemembers_enum.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_eval.html b/docs/html/namespacemembers_eval.html
index 365527c..4a4922b 100644
--- a/docs/html/namespacemembers_eval.html
+++ b/docs/html/namespacemembers_eval.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all namespace enum values with links to the namespace documentation for each enum value:
-- a -
+- a -
- ALLOCATION_FLAG_CAN_ALIAS : D3D12MA
- ALLOCATION_FLAG_COMMITTED : D3D12MA
- ALLOCATION_FLAG_NEVER_ALLOCATE : D3D12MA
@@ -108,7 +95,7 @@ - a -
-- d -
+- d -
- DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FAST : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FULL : D3D12MA
@@ -119,7 +106,7 @@ - d -
-- p -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_func.html b/docs/html/namespacemembers_func.html
index 02a9cdd..c8a70c7 100644
--- a/docs/html/namespacemembers_func.html
+++ b/docs/html/namespacemembers_func.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_type.html b/docs/html/namespacemembers_type.html
index b56e9c4..e9561e2 100644
--- a/docs/html/namespacemembers_type.html
+++ b/docs/html/namespacemembers_type.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespaces.html b/docs/html/namespaces.html
index fe8ddce..acd9768 100644
--- a/docs/html/namespaces.html
+++ b/docs/html/namespaces.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace List
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/navtree.css b/docs/html/navtree.css
index 69211d4..0ea3a07 100644
--- a/docs/html/navtree.css
+++ b/docs/html/navtree.css
@@ -11,8 +11,8 @@
#nav-tree li {
white-space:nowrap;
- margin:0px;
- padding:0px;
+ margin:0;
+ padding:0;
}
#nav-tree .plus {
@@ -20,15 +20,10 @@
}
#nav-tree .selected {
- background-image: url('tab_a.png');
- background-repeat:repeat-x;
- color: var(--nav-text-active-color);
- text-shadow: var(--nav-text-active-shadow);
-}
-
-#nav-tree .selected .arrow {
- color: var(--nav-arrow-selected-color);
- text-shadow: none;
+ position: relative;
+ background-color: var(--nav-menu-active-bg);
+ border-radius: 0 6px 6px 0;
+ /*margin-right: 5px;*/
}
#nav-tree img {
@@ -48,6 +43,7 @@
margin:0px;
padding:0px;
font: 12px var(--font-family-nav);
+ line-height: 22px;
}
#nav-tree .label a {
@@ -56,7 +52,7 @@
#nav-tree .selected a {
text-decoration:none;
- color:var(--nav-text-active-color);
+ color:var(--page-link-color);
}
#nav-tree .children_ul {
@@ -65,8 +61,9 @@
}
#nav-tree .item {
- margin:0px;
- padding:0px;
+ margin: 0 6px 0 -5px;
+ padding: 0 0 0 5px;
+ height: 22px;
}
#nav-tree {
@@ -89,7 +86,6 @@
display:block;
position: absolute;
left: 0px;
- width: $width;
overflow : hidden;
}
@@ -98,15 +94,31 @@
}
.ui-resizable-e {
- background-image:var(--nav-splitbar-image);
- background-size:100%;
- background-repeat:repeat-y;
- background-attachment: scroll;
- cursor:ew-resize;
+ transition: opacity 0.5s ease;
+ background-color: var(--nav-splitbar-bg-color);
+ opacity:0;
+ cursor:col-resize;
height:100%;
right:0;
top:0;
width:6px;
+ position: relative;
+}
+
+.ui-resizable-e:after {
+ content: '';
+ display: block;
+ top: 50%;
+ left: 1px;
+ width: 2px;
+ height: 15px;
+ border-left: 1px solid var(--nav-splitbar-handle-color);
+ border-right: 1px solid var(--nav-splitbar-handle-color);
+ position: absolute;
+}
+
+.ui-resizable-e:hover {
+ opacity: 1;
}
.ui-resizable-handle {
@@ -121,24 +133,97 @@
}
#nav-tree {
- background-repeat:repeat-x;
background-color: var(--nav-background-color);
-webkit-overflow-scrolling : touch; /* iOS 5+ */
+ scrollbar-width: thin;
+ border-right: 1px solid var(--nav-border-color);
+ padding-left: 5px;
}
#nav-sync {
position:absolute;
- top:5px;
- right:24px;
- z-index:0;
+ top:0px;
+ right:0px;
+ z-index:1;
}
#nav-sync img {
opacity:0.3;
}
-#nav-sync img:hover {
- opacity:0.9;
+div.nav-sync-icon {
+ position: relative;
+ width: 24px;
+ height: 17px;
+ left: -6px;
+ top: -1px;
+ opacity: 0.7;
+ display: inline-block;
+ background-color: var(--sync-icon-background-color);
+ border: 1px solid var(--sync-icon-border-color);
+ box-sizing: content-box;
+}
+
+div.nav-sync-icon:hover {
+ background-color: var(--sync-icon-selected-background-color);
+ opacity: 1.0;
+}
+
+div.nav-sync-icon.active:after {
+ content: '';
+ background-color: var(--sync-icon-background-color);
+ border-top: 2px solid var(--sync-icon-color);
+ position: absolute;
+ width: 16px;
+ height: 0px;
+ top: 7px;
+ left: 4px;
+}
+
+div.nav-sync-icon.active:hover:after {
+ border-top: 2px solid var(--sync-icon-selected-color);
+}
+
+span.sync-icon-left {
+ position: absolute;
+ padding: 0;
+ margin: 0;
+ top: 3px;
+ left: 4px;
+ display: inline-block;
+ width: 8px;
+ height: 8px;
+ border-left: 2px solid var(--sync-icon-color);
+ border-top: 2px solid var(--sync-icon-color);
+ transform: rotate(-45deg);
+}
+
+span.sync-icon-right {
+ position: absolute;
+ padding: 0;
+ margin: 0;
+ top: 3px;
+ left: 10px;
+ display: inline-block;
+ width: 8px;
+ height: 8px;
+ border-right: 2px solid var(--sync-icon-color);
+ border-bottom: 2px solid var(--sync-icon-color);
+ transform: rotate(-45deg);
+}
+
+div.nav-sync-icon:hover span.sync-icon-left {
+ border-left: 2px solid var(--sync-icon-selected-color);
+ border-top: 2px solid var(--sync-icon-selected-color);
+}
+
+div.nav-sync-icon:hover span.sync-icon-right {
+ border-right: 2px solid var(--sync-icon-selected-color);
+ border-bottom: 2px solid var(--sync-icon-selected-color);
+}
+
+#nav-path ul {
+ border-top: 1px solid var(--nav-breadcrumb-separator-color);
}
@media print
@@ -147,3 +232,96 @@
div.ui-resizable-handle { display: none; position: relative; }
}
+/*---------------------------*/
+#container {
+ display: grid;
+ grid-template-columns: auto auto;
+ overflow: hidden;
+}
+
+#page-nav {
+ background: var(--nav-background-color);
+ display: block;
+ width: 250px;
+ box-sizing: content-box;
+ position: relative;
+ border-left: 1px solid var(--nav-border-color);
+}
+
+#page-nav-tree {
+ display: inline-block;
+}
+
+#page-nav-resize-handle {
+ transition: opacity 0.5s ease;
+ background-color: var(--nav-splitbar-bg-color);
+ opacity:0;
+ cursor:col-resize;
+ height:100%;
+ right:0;
+ top:0;
+ width:6px;
+ position: relative;
+ z-index: 1;
+ user-select: none;
+}
+
+#page-nav-resize-handle:after {
+ content: '';
+ display: block;
+ top: 50%;
+ left: 1px;
+ width: 2px;
+ height: 15px;
+ border-left: 1px solid var(--nav-splitbar-handle-color);
+ border-right: 1px solid var(--nav-splitbar-handle-color);
+ position: absolute;
+}
+
+#page-nav-resize-handle.dragging,
+#page-nav-resize-handle:hover {
+ opacity: 1;
+}
+
+#page-nav-contents {
+ padding: 0;
+ margin: 0;
+ display: block;
+ top: 0;
+ left: 0;
+ height: 100%;
+ width: 100%;
+ position: absolute;
+ overflow: auto;
+ scrollbar-width: thin;
+ -webkit-overflow-scrolling : touch; /* iOS 5+ */
+}
+
+ul.page-outline,
+ul.page-outline ul {
+ text-indent: 0;
+ list-style: none outside none;
+ padding: 0 0 0 4px;
+}
+
+ul.page-outline {
+ margin: 0 4px 4px 6px;
+}
+
+ul.page-outline div.item {
+ font: 12px var(--font-family-nav);
+ line-height: 22px;
+}
+
+ul.page-outline li {
+ white-space: nowrap;
+}
+
+ul.page-outline li.vis {
+ background-color: var(--nav-breadcrumb-active-bg);
+}
+
+#container.resizing {
+ cursor: col-resize;
+ user-select: none;
+}
diff --git a/docs/html/optimal_allocation.html b/docs/html/optimal_allocation.html
index 627471c..88f3e62 100644
--- a/docs/html/optimal_allocation.html
+++ b/docs/html/optimal_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Optimal resource allocation
-
-
@@ -33,33 +31,22 @@
-
+
-
- Optimal resource allocation
+ Optimal resource allocation
This library tries to automatically make optimal choices for the resources you create, so you don't need to care about them. There are some advanced features of Direct3D 12 that you may use to optimize your memory management. There are also some settings in D3D12MA that you may change to alter its default behavior. This page provides miscellaneous advice about features of D3D12 and D3D12MA that are non-essential, but may improve the stability or performance of your app.
-
+
Avoiding running out of memory
When trying to allocate more memory than available in the current heap (e.g., video memory on the graphics card, system memory), one of few bad things can happen:
-- The allocation (resource creation) function call can fail with
HRESULT value other than S_OK.
+- The allocation (resource creation) function call can fail with HRESULT value other than S_OK.
- The allocation may succeed, but take long time (even a significant fraction of a second).
- Some resources are automatically demoted from video memory to system memory, degrading the app performance.
- Even a crash of the entire graphics driver can happen, resulting in the D3D12 "device removal", which is usually catastrophic for the application.
@@ -113,34 +100,34 @@ Statistics of current memory usage and available budget for a specific memory segment group.Definition D3D12MemAlloc.h:474
UINT64 BudgetBytesEstimated amount of memory available to the program.Definition D3D12MemAlloc.h:497
UINT64 UsageBytesEstimated current memory usage of the program.Definition D3D12MemAlloc.h:486
-- Implementation detail
- DXGI interface offers function
IDXGIAdapter3::QueryVideoMemoryInfo that queries the current memory usage and budget. This library automatically makes use of it when available (when you use recent enough version of the DirectX SDK). If not, it falls back to estimating the usage and budget based on the total amount of the allocated memory and 80% of the full memory capacity, respectively.
+- Implementation detail
- DXGI interface offers function IDXGIAdapter3::QueryVideoMemoryInfo that queries the current memory usage and budget. This library automatically makes use of it when available (when you use recent enough version of the DirectX SDK). If not, it falls back to estimating the usage and budget based on the total amount of the allocated memory and 80% of the full memory capacity, respectively.
- Implementation detail
- Allocating large heaps and creating placed resources in them is one of the main features of this library. However, if allocating new such block would exceed the budget, it will automatically prefer creating the resource as committed to have exactly the right size, which can lower the chance of getting into trouble in case of over-commitment.
When creating non-essential resources, you can use D3D12MA::ALLOCATION_FLAG_WITHIN_BUDGET. Then, in case the allocation would exceed the budget, the library will return failure from the function without attempting to allocate the actual D3D12 memory.
-It may also be a good idea to support failed resource creation. For non-essential resources, when function D3D12MA::Allocator::CreateResource fails with a result other than S_OK, it is worth implementing some way of recovery instead of terminating or crashing the entire app.
-
+
It may also be a good idea to support failed resource creation. For non-essential resources, when function D3D12MA::Allocator::CreateResource fails with a result other than S_OK, it is worth implementing some way of recovery instead of terminating or crashing the entire app.
+
Allocation performance
Creating D3D12 resources (buffers and textures) can be a time-consuming operation. The duration can be unpredictable, spanning from a small fraction of a millisecond to a significant fraction of a second. Thus, it is recommended to allocate all the memory and create all the resources needed upfront rather than doing it during application runtime. For example, a video game can try to create its resources on startup or when loading a new level. Of course, is is not always possible. For example, open-world games may require loading and unloading some graphical assets in the background (often called "streaming").
-Creating and releasing D3D12 resources on a separate thread in the background may help. Both ID3D12Device and D3D12MA::Allocator objects are thread-safe, synchronized internally. However, cases were observed where resource creation calls like ID3D12Device::CreateCommittedResource were blocking other D3D12 calls like ExecuteCommandLists or Present somewhere inside the graphics driver, so hitches can happen even when using multithreading.
-The most expensive part is typically the allocation of a new D3D12 memory heap. This library tackles this problem by automatically allocating large heaps (64 MB by default) and creating resources as placed inside of them. When a new requested resource can be placed in a free space of an existing heap and doesn't require allocating a new heap, this operation is typically much faster, as it only requires creating a new ID3D12Resource object and not allocating new memory. This is the main benefit of using D3D12MA compared to the naive approach of using Direct3D 12 directly and creating each resource as committed with CreateCommittedResource, which would result in a separate allocation of an implicit heap every time.
-When a large number of small buffers needs to be created, the overhead of creating even just separate ID3D12Resource objects can be significant. It can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs. This library can also help with it. See section "Sub-allocating buffers" below.
+Creating and releasing D3D12 resources on a separate thread in the background may help. Both ID3D12Device and D3D12MA::Allocator objects are thread-safe, synchronized internally. However, cases were observed where resource creation calls like ID3D12Device::CreateCommittedResource were blocking other D3D12 calls like ExecuteCommandLists or Present somewhere inside the graphics driver, so hitches can happen even when using multithreading.
+The most expensive part is typically the allocation of a new D3D12 memory heap. This library tackles this problem by automatically allocating large heaps (64 MB by default) and creating resources as placed inside of them. When a new requested resource can be placed in a free space of an existing heap and doesn't require allocating a new heap, this operation is typically much faster, as it only requires creating a new ID3D12Resource object and not allocating new memory. This is the main benefit of using D3D12MA compared to the naive approach of using Direct3D 12 directly and creating each resource as committed with CreateCommittedResource, which would result in a separate allocation of an implicit heap every time.
+When a large number of small buffers needs to be created, the overhead of creating even just separate ID3D12Resource objects can be significant. It can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs. This library can also help with it. See section "Sub-allocating buffers" below.
- Implementation detail
- The CPU performance overhead of using this library is low. It uses a high-quality allocation algorithm called Two-Level Segregated Fit (TLSF), which in most cases can find a free place for a new allocation in few steps. The library also doesn't perform too many CPU heap allocations. In may cases, the allocation happens with 0 new CPU heap allocations performed by the library. Even the creation of a D3D12MA::Allocation object itself doesn't typically feature an CPU allocation, because these objects are returned out of a dedicated memory pool.
Another reason for the slowness of D3D12 memory allocation is the guarantee that the newly allocated memory is filled with zeros. When creating and destroying resources placed in an existing heap, this overhead is not present, and the memory is not zeroed - it may contain random data left by the resource previously allocated in that place. In recent versions of the DirectX 12 SDK, clearing the memory of the newly created D3D12 heaps can also be disabled for the improved performance. D3D12MA can use this feature when:
- D3D12MA::ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED is used during the creation of the main allocator object.
-D3D12_HEAP_FLAG_CREATE_NOT_ZEROED is passed to D3D12MA::POOL_DESC::HeapFlags during the creation of a custom pool.- D3D12_HEAP_FLAG_CREATE_NOT_ZEROED is passed to D3D12MA::POOL_DESC::HeapFlags during the creation of a custom pool.
It is recommended to always use these flags. The downside is that when the memory is not filled with zeros, while you don't properly clear it or otherwise initialize its content before use (which is required by D3D12), you may observe incorrect behavior. This problem mostly affects render-target and depth-stencil textures.
When an allocation needs to be made in a performance-critical code, you can use D3D12MA::ALLOCATION_FLAG_STRATEGY_MIN_TIME. In influences multiple heuristics inside the library to prefer faster allocation at the expense of possibly less optimal placement in the memory.
If the resource to be created is non-essential, while the performance is paramount, you can also use D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE. It will create the resource only if it can be placed inside and existing memory heap and return failure from the function if a new heap would need to be allocated, which should guarantee good performance of such function call.
-
+
Sub-allocating buffers
-
When a large number of small buffers needs to be created, the overhead of creating separate ID3D12Resource objects can be significant. It can also cause a significant waste of memory, as placed buffers need to be aligned to D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB by default. These problems can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs.
+When a large number of small buffers needs to be created, the overhead of creating separate ID3D12Resource objects can be significant. It can also cause a significant waste of memory, as placed buffers need to be aligned to D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB by default. These problems can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs.
It requires implementing a custom allocator for the data inside the buffer and using offsets to individual regions. When all the regions can be allocated linearly and freed all at once, implementing such allocator is trivial. When every region has the same size, implementing an allocator is also quite simple when using a "free list" algorithm. However, when regions can have different sizes and can be allocated and freed in random order, it requires a full allocation algorithm. D3D12MA can help with it by exposing its core allocation algorithm for custom usages. For more details and example code, see chapter: Virtual allocator. It can be used for all the cases mentioned above without too much performance overhead, because the D3D12MA::VirtualAllocation object is just a lightweight handle.
-When sub-allocating a buffer, you need to remember to explicitly request proper alignment required for each region. For example, data used as a constant buffer must be aligned to D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT = 256 B.
-
+
When sub-allocating a buffer, you need to remember to explicitly request proper alignment required for each region. For example, data used as a constant buffer must be aligned to D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT = 256 B.
+
Residency priority
When too much video memory is allocated, one of the things that can happen is the system demoting some heaps to the system memory. Moving data between memory pools or reaching out directly to the system memory through PCI Express bus can have large performance overhead, which can slow down the application, or even make the game unplayable any more. Unfortunately, it is not possible to fully control or prevent this demotion. Best thing to do is avoiding memory over-commitment. For more information, see section "Avoiding running out of memory" above.
-Recent versions of DirectX 12 SDK offer function ID3D12Device1::SetResidencyPriority that sets a hint about the priority of a resource - how important it is to stay resident in the video memory. Setting the priority happens at the level of an entire memory heap. D3D12MA offers an interface to set this priority in form of D3D12MA::POOL_DESC::ResidencyPriority parameter. It affects all allocations made out of the custom pool created with it, both placed inside large heaps and created as committed.
+Recent versions of DirectX 12 SDK offer function ID3D12Device1::SetResidencyPriority that sets a hint about the priority of a resource - how important it is to stay resident in the video memory. Setting the priority happens at the level of an entire memory heap. D3D12MA offers an interface to set this priority in form of D3D12MA::POOL_DESC::ResidencyPriority parameter. It affects all allocations made out of the custom pool created with it, both placed inside large heaps and created as committed.
It is recommended to create a custom pool for the purpose of using high residency priority of all resources that are critical for the performance, especially those that are written by the GPU, like render-target, depth-stencil textures, UAV textures and buffers. It is also worth creating them as committed, so that each one will have its own implicit heap. This can minimize the chance that an entire large heap is demoted to system memory, degrading performance of all the resources placed in it.
Example:
D3D12MA::CPOOL_DESC poolDesc = D3D12MA::CPOOL_DESC{
@@ -175,14 +162,14 @@
D3D12_RESIDENCY_PRIORITY priority = D3D12_RESIDENCY_PRIORITY_HIGH;
device1->SetResidencyPriority(1, &res, &priority);
ID3D12Resource * GetResource() constReturns D3D12 resource associated with this object.Definition D3D12MemAlloc.h:552
-
Note this is not the same as explicit eviction controlled using ID3D12Device::Evict and MakeResident functions. Resources evicted explicitly are illegal to access until they are made resident again, while the demotion described here happens automatically and only slows down the execution.
-
+
Note this is not the same as explicit eviction controlled using ID3D12Device::Evict and MakeResident functions. Resources evicted explicitly are illegal to access until they are made resident again, while the demotion described here happens automatically and only slows down the execution.
+
GPU upload heap
Direct3D 12 offers a fixed set of memory heap types:
-D3D12_HEAP_TYPE_DEFAULT: Represents the video memory. It is available and fast to access for the GPU. It should be used for all resources that are written by the GPU (like render-target and depth-stencil textures, UAV) and resources that are frequently read by the GPU (like textures intended for sampling, vertex, index, and constant buffers).D3D12_HEAP_TYPE_UPLOAD: Represents the system memory that is uncached and write-combined. It can be mapped and accessed by the CPU code using a pointer. It supports only buffers, not textures. It is intended for "staging buffers" that are filled by the CPU code and then used as a source of copy operations to the DEFAULT heap. It can also be accessed directly by the GPU - shaders can read from buffers created in this memory.D3D12_HEAP_TYPE_READBACK: Represents the system memory that is cached. It is intended for buffers used as a destination of copy operations from the DEFAULT heap.- D3D12_HEAP_TYPE_DEFAULT: Represents the video memory. It is available and fast to access for the GPU. It should be used for all resources that are written by the GPU (like render-target and depth-stencil textures, UAV) and resources that are frequently read by the GPU (like textures intended for sampling, vertex, index, and constant buffers).
+- D3D12_HEAP_TYPE_UPLOAD: Represents the system memory that is uncached and write-combined. It can be mapped and accessed by the CPU code using a pointer. It supports only buffers, not textures. It is intended for "staging buffers" that are filled by the CPU code and then used as a source of copy operations to the DEFAULT heap. It can also be accessed directly by the GPU - shaders can read from buffers created in this memory.
+- D3D12_HEAP_TYPE_READBACK: Represents the system memory that is cached. It is intended for buffers used as a destination of copy operations from the DEFAULT heap.
Note that in systems with a discrete graphics card, access to system memory is fast from the CPU code (like the C++ code mapping D3D12 buffers and accessing them through a pointer), while access to the video memory is fast from the GPU code (like shaders reading and writing buffers and textures). Any copy operation or direct access between these memory heap types happens through PCI Express bus, which can be relatively slow.
Modern systems offer a feature called Resizable BAR (ReBAR) that gives the CPU direct access to the full video memory. To be available, this feature needs to be supported by the whole hardware-software environment, including:
@@ -192,20 +179,20 @@
- Supporting operating system.
- The feature needs to be enabled in the UEFI settings. It is typically called "Above 4G Decoding" and "Resizable Bar".
-Recent versions of DirectX 12 SDK give access to this feature in form of a new, 4th memory pool: D3D12_HEAP_TYPE_GPU_UPLOAD. Resources created in it behave logically similar to the D3D12_HEAP_TYPE_UPLOAD heap:
+Recent versions of DirectX 12 SDK give access to this feature in form of a new, 4th memory pool: D3D12_HEAP_TYPE_GPU_UPLOAD. Resources created in it behave logically similar to the D3D12_HEAP_TYPE_UPLOAD heap:
- They support mapping and direct access from the CPU code through a pointer.
-- The mapped memory is uncached and write-combined, so it should be only written sequentially (e.g., number-by-number or using
memcpy). It shouldn't be accessed randomly or read, because it is extremely slow for uncached memory.
+- The mapped memory is uncached and write-combined, so it should be only written sequentially (e.g., number-by-number or using memcpy). It shouldn't be accessed randomly or read, because it is extremely slow for uncached memory.
- Only buffers are supported.
- Those buffers can be used as a source of copy operations or directly accessed by the GPU.
-The main difference is that resources created in the new D3D12_HEAP_TYPE_GPU_UPLOAD are placed in the video memory, while resources created in the old D3D12_HEAP_TYPE_UPLOAD are placed in the system memory. This implies which budgets are consumed by new resources allocated in those heaps. This also implies which operations involve transferring data through the PCI Express bus.
+The main difference is that resources created in the new D3D12_HEAP_TYPE_GPU_UPLOAD are placed in the video memory, while resources created in the old D3D12_HEAP_TYPE_UPLOAD are placed in the system memory. This implies which budgets are consumed by new resources allocated in those heaps. This also implies which operations involve transferring data through the PCI Express bus.
-- As
D3D12_HEAP_TYPE_UPLOAD uses the system memory, writes from the CPU code through a mapped pointer are faster, while copies or direct access from the GPU are slower because they need to go through PCIe.
-- As the new
D3D12_HEAP_TYPE_GPU_UPLOAD uses the video memory, copies or direct access from the GPU are faster, while writes from the CPU code through a mapped pointer can be slower, because they need to go through PCIe. For maximum performance of copy operations from this heap, a graphics or compute queue should be used, not a copy queue.
+- As D3D12_HEAP_TYPE_UPLOAD uses the system memory, writes from the CPU code through a mapped pointer are faster, while copies or direct access from the GPU are slower because they need to go through PCIe.
+- As the new D3D12_HEAP_TYPE_GPU_UPLOAD uses the video memory, copies or direct access from the GPU are faster, while writes from the CPU code through a mapped pointer can be slower, because they need to go through PCIe. For maximum performance of copy operations from this heap, a graphics or compute queue should be used, not a copy queue.
GPU Upload Heap can be used for performance optimization of some resources that need to be written by the CPU and read by the GPU. It can be beneficial especially for resources that need to change frequently (often called "dynamic").
-D3D12MA supports GPU upload heap when recent enough version of DirectX 12 SDK is used and when the current system supports it. The support can be queried using function D3D12MA::Allocator::IsGPUUploadHeapSupported(). When it returns TRUE, you can create resources using D3D12_HEAP_TYPE_GPU_UPLOAD. You can also just try creating such resource. Example:
+D3D12MA supports GPU upload heap when recent enough version of DirectX 12 SDK is used and when the current system supports it. The support can be queried using function D3D12MA::Allocator::IsGPUUploadHeapSupported(). When it returns TRUE, you can create resources using D3D12_HEAP_TYPE_GPU_UPLOAD. You can also just try creating such resource. Example:
D3D12MA::CALLOCATION_DESC allocDesc = D3D12MA::CALLOCATION_DESC{
D3D12_HEAP_TYPE_GPU_UPLOAD }; // !!!
@@ -240,13 +227,13 @@
else
// Some other error code e.g., out of memory...
D3D12_HEAP_TYPE HeapTypeThe type of memory heap where the new allocation should be placed.Definition D3D12MemAlloc.h:347
-
+
Committed versus placed resources
When using D3D12 API directly, there are 3 ways of creating resources:
-- Committed, using function
ID3D12Device::CreateCommittedResource. It creates the resource with its own memory heap, which is called an "implicit heap" and cannot be accessed directly.
-- Placed, using function
ID3D12Device::CreatePlacedResource. A ID3D12Heap needs to be created beforehand using ID3D12Device::CreateHeap. Then, the resource can be created as placed inside the heap at a specific offset.
-- Reserved, using function
ID3D12Device::CreateReservedResource. This library doesn't support them directly.
+- Committed, using function ID3D12Device::CreateCommittedResource. It creates the resource with its own memory heap, which is called an "implicit heap" and cannot be accessed directly.
+- Placed, using function ID3D12Device::CreatePlacedResource. A ID3D12Heap needs to be created beforehand using ID3D12Device::CreateHeap. Then, the resource can be created as placed inside the heap at a specific offset.
+- Reserved, using function ID3D12Device::CreateReservedResource. This library doesn't support them directly.
A naive solution would be to create all the resources as committed. It works, because in D3D12 there is no strict limit on the number of resources or heaps that can be created. However, there are certain advantages and disadvantages of using committed versus placed resources:
- The advantage of committed resources is that they are always created with a new heap, which is initialized with zeros. When a resource is created as placed, the memory may contain random data left by the resource previously allocated in that place. When the memory is not filled with zeros, while you don't properly clear it or otherwise initialize its content before use (which is required by D3D12), you may observe incorrect behavior. On the other hand, using committed resources and having every new resource filled with zeros can leave this kind of bugs undetected.
-- Manual eviction with
ID3D12Device::Evict and MakeResident functions work at the level of the entire heap, and so does ID3D12Device1::SetResidencyPriority, so creating resources as committed allows more fine-grained control over the eviction and residency priority of individual resources.
+- Manual eviction with ID3D12Device::Evict and MakeResident functions work at the level of the entire heap, and so does ID3D12Device1::SetResidencyPriority, so creating resources as committed allows more fine-grained control over the eviction and residency priority of individual resources.
- The advantage of placed resources is that they can be created in a region of a heap overlapping with some other resources. This approach is commonly called "aliasing". It can save memory, but it needs careful control over the resources that overlap in memory to make sure they are not used at the same time, there is an aliasing barrier issued between their usage, and the resource used after aliasing is correctly cleared every time. Committed resources don't offer this possibility, because every committed resource has its own exclusive memory heap. For more information, see chapter Resource aliasing (overlap).
When creating resources with the help of D3D12MA using function D3D12MA::Allocator::CreateResource, you typically don't need to care about all this. The library automatically makes the choice of creating the new resource as committed or placed. However, in cases when you need the information or the control over this choice between committed and placed, the library offers facilities to do that, described below.
@@ -303,18 +290,18 @@
UINT64 BlockSizeSize of a single heap (memory block) to be allocated as part of this pool, in bytes....Definition D3D12MemAlloc.h:933
You can request a new resource to be created as placed by using D3D12MA::ALLOCATION_FLAG_CAN_ALIAS. This is required especially if you plan to create another resource in the same region of memory, aliasing with your resource - hence the name of this flag.
Note D3D12MA::ALLOCATION_FLAG_CAN_ALIAS can be even combined with D3D12MA::ALLOCATION_FLAG_COMMITTED. In this case, the resource is not created as committed, but it is also not placed as part of a larger heap. What happens instead is that a new heap is created with the exact size required for the resource, and the resource is created in it, placed at offset 0.
-
+
Resource alignment
Certain types of resources require certain alignment in memory. An alignment is a requirement for the address or offset to the beginning of the resource to be a multiply of some value, which is always a power of 2. For committed resources, the problem is non-existent, because committed resources have their own implicit heaps where they are created at offset 0, which meets any alignment requirement. For placed resources, D3D12MA takes care of the alignment automatically.
-- Implementation detail
- Default alignment required MSAA textures is
D3D12_DEFAULT_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 4 MB. Default alignment required for buffers and other textures is D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB.
+- Implementation detail
- Default alignment required MSAA textures is D3D12_DEFAULT_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 4 MB. Default alignment required for buffers and other textures is D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB.
Because the alignment required for buffers is 64 KB, small buffers can waste a lot of memory in between when created as placed. When such small buffers are created as committed, some graphics drivers are able to pack them better. D3D12MA automatically takes advantage of this by preferring to create small buffers as committed. This heuristics is enabled by default. It is also a tradeoff - it can make the allocation of these buffers slower. It can be disabled for an individual resource by using D3D12MA::ALLOCATION_FLAG_STRATEGY_MIN_TIME and for the entire allocator by using D3D12MA::ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED.
-For certain textures that meet a complex set of requirements, special "small alignment" can be applied. Details can be found in Microsoft documentation of the D3D12_RESOURCE_DESC structure. For MSAA textures, the small alignment is D3D12_SMALL_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB. For other textures, the small alignment is D3D12_SMALL_RESOURCE_PLACEMENT_ALIGNMENT = 4 KB. D3D12MA uses this feature automatically. Detailed behavior can be disabled or controlled by predefining macro D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT.
-D3D12 also has a concept of alignment of the entire heap, passed through D3D12_HEAP_DESC::Alignment. This library automatically sets the alignment as small as possible. Unfortunately, any heap that has a chance of hosting an MSAA texture needs to have the alignment set to 4 MB. This problem can be overcome by passing D3D12MA::ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of the main allocator object and D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of any custom heap that supports textures, not only buffers. With those flags, the alignment of the heaps created by D3D12MA can be lower, but any MSAA textures are created as committed. You should always use these flags in your code unless you really need to create some MSAA textures as placed.
+For certain textures that meet a complex set of requirements, special "small alignment" can be applied. Details can be found in Microsoft documentation of the D3D12_RESOURCE_DESC structure. For MSAA textures, the small alignment is D3D12_SMALL_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB. For other textures, the small alignment is D3D12_SMALL_RESOURCE_PLACEMENT_ALIGNMENT = 4 KB. D3D12MA uses this feature automatically. Detailed behavior can be disabled or controlled by predefining macro D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT.
+D3D12 also has a concept of alignment of the entire heap, passed through D3D12_HEAP_DESC::Alignment. This library automatically sets the alignment as small as possible. Unfortunately, any heap that has a chance of hosting an MSAA texture needs to have the alignment set to 4 MB. This problem can be overcome by passing D3D12MA::ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of the main allocator object and D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of any custom heap that supports textures, not only buffers. With those flags, the alignment of the heaps created by D3D12MA can be lower, but any MSAA textures are created as committed. You should always use these flags in your code unless you really need to create some MSAA textures as placed.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/quick_start.html b/docs/html/quick_start.html
index f9219d2..4eba7e6 100644
--- a/docs/html/quick_start.html
+++ b/docs/html/quick_start.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Quick start
-
-
@@ -33,33 +31,22 @@
-
+
-
- Quick start
+ Quick start
-
+
Project setup and initialization
This is a small, standalone C++ library. It consists of 2 files: "D3D12MemAlloc.h" header file with public interface and "D3D12MemAlloc.cpp" with internal implementation. The only external dependencies are WinAPI, Direct3D 12, and parts of C/C++ standard library (but STL containers, exceptions, or RTTI are not used).
The library is developed and tested using Microsoft Visual Studio 2022, but it should work with other compilers as well. It is designed for 64-bit code.
To use the library in your project:
-(1.) Copy files D3D12MemAlloc.cpp, D3D12MemAlloc.h to your project.
-(2.) Make D3D12MemAlloc.cpp compiling as part of the project, as C++ code.
+(1.) Copy files D3D12MemAlloc.cpp, D3D12MemAlloc.h to your project.
+(2.) Make D3D12MemAlloc.cpp compiling as part of the project, as C++ code.
(3.) Include library header in each CPP file that needs to use the library.
#include "D3D12MemAlloc.h"
-(4.) Right after you created ID3D12Device, fill D3D12MA::ALLOCATOR_DESC structure and call function D3D12MA::CreateAllocator to create the main D3D12MA::Allocator object.
+
(4.) Right after you created ID3D12Device, fill D3D12MA::ALLOCATOR_DESC structure and call function D3D12MA::CreateAllocator to create the main D3D12MA::Allocator object.
Please note that all symbols of the library are declared inside D3D12MA namespace.
IDXGIAdapter* adapter = ...
ID3D12Device* device = ...
@@ -119,12 +106,12 @@
D3D12MA_API HRESULT CreateAllocator(const ALLOCATOR_DESC *pDesc, Allocator **ppAllocator)Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
(5.) Right before destroying the D3D12 device, destroy the allocator object.
allocator->Release();
-Objects of this library must be destroyed by calling Release method. They are somewhat compatible with COM: they implement IUnknown interface with its virtual methods: AddRef, Release, QueryInterface, and they are reference-counted internally. You can use smart pointers designed for COM with objects of this library - e.g. CComPtr or Microsoft::WRL::ComPtr. The reference counter is thread-safe. QueryInterface method supports only IUnknown, as classes of this library don't define their own GUIDs.
-
+
Objects of this library must be destroyed by calling Release method. They are somewhat compatible with COM: they implement IUnknown interface with its virtual methods: AddRef, Release, QueryInterface, and they are reference-counted internally. You can use smart pointers designed for COM with objects of this library - e.g. CComPtr or Microsoft::WRL::ComPtr. The reference counter is thread-safe. QueryInterface method supports only IUnknown, as classes of this library don't define their own GUIDs.
+
Creating resources
-To use the library for creating resources (textures and buffers), call method D3D12MA::Allocator::CreateResource in the place where you would previously call ID3D12Device::CreateCommittedResource.
-The function has similar syntax, but it expects structure D3D12MA::ALLOCATION_DESC to be passed along with D3D12_RESOURCE_DESC and other parameters for created resource. This structure describes parameters of the desired memory allocation, including choice of D3D12_HEAP_TYPE.
-The function returns a new object of type D3D12MA::Allocation. It represents allocated memory and can be queried for size, offset, ID3D12Heap. It also holds a reference to the ID3D12Resource, which can be accessed by calling D3D12MA::Allocation::GetResource().
+To use the library for creating resources (textures and buffers), call method D3D12MA::Allocator::CreateResource in the place where you would previously call ID3D12Device::CreateCommittedResource.
+The function has similar syntax, but it expects structure D3D12MA::ALLOCATION_DESC to be passed along with D3D12_RESOURCE_DESC and other parameters for created resource. This structure describes parameters of the desired memory allocation, including choice of D3D12_HEAP_TYPE.
+The function returns a new object of type D3D12MA::Allocation. It represents allocated memory and can be queried for size, offset, ID3D12Heap. It also holds a reference to the ID3D12Resource, which can be accessed by calling D3D12MA::Allocation::GetResource().
D3D12_RESOURCE_DESC resourceDesc = {};
resourceDesc.Dimension = D3D12_RESOURCE_DIMENSION_TEXTURE2D;
resourceDesc.Alignment = 0;
@@ -160,13 +147,13 @@
D3D12_HEAP_TYPE HeapTypeThe type of memory heap where the new allocation should be placed.Definition D3D12MemAlloc.h:347
You need to release the allocation object when no longer needed. This will also release the D3D12 resource.
allocation->Release();
-The advantage of using the allocator instead of creating committed resource, and the main purpose of this library, is that it can decide to allocate bigger memory heap internally using ID3D12Device::CreateHeap and place multiple resources in it, at different offsets, using ID3D12Device::CreatePlacedResource. The library manages its own collection of allocated memory blocks (heaps) and remembers which parts of them are occupied and which parts are free to be used for new resources.
-It is important to remember that resources created as placed don't have their memory initialized to zeros, but may contain garbage data, so they need to be fully initialized before usage, e.g. using Clear (ClearRenderTargetView), Discard (DiscardResource), or Copy (CopyResource).
-The library also automatically handles resource heap tier. When D3D12_FEATURE_DATA_D3D12_OPTIONS::ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1, resources of 3 types: buffers, textures that are render targets or depth-stencil, and other textures must be kept in separate heaps. When D3D12_RESOURCE_HEAP_TIER_2, they can be kept together. By using this library, you don't need to handle this manually.
-
+
The advantage of using the allocator instead of creating committed resource, and the main purpose of this library, is that it can decide to allocate bigger memory heap internally using ID3D12Device::CreateHeap and place multiple resources in it, at different offsets, using ID3D12Device::CreatePlacedResource. The library manages its own collection of allocated memory blocks (heaps) and remembers which parts of them are occupied and which parts are free to be used for new resources.
+It is important to remember that resources created as placed don't have their memory initialized to zeros, but may contain garbage data, so they need to be fully initialized before usage, e.g. using Clear (ClearRenderTargetView), Discard (DiscardResource), or Copy (CopyResource).
+The library also automatically handles resource heap tier. When D3D12_FEATURE_DATA_D3D12_OPTIONS::ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1, resources of 3 types: buffers, textures that are render targets or depth-stencil, and other textures must be kept in separate heaps. When D3D12_RESOURCE_HEAP_TIER_2, they can be kept together. By using this library, you don't need to handle this manually.
+
Resource reference counting
-ID3D12Resource and other interfaces of Direct3D 12 use COM, so they are reference-counted. Objects of this library are reference-counted as well. An object of type D3D12MA::Allocation remembers the resource (buffer or texture) that was created together with this memory allocation and holds a reference to the ID3D12Resource object. (Note this is a difference to Vulkan Memory Allocator, where a VmaAllocation object has no connection with the buffer or image that was created with it.) Thus, it is important to manage the resource reference counter properly.
-The simplest use case is shown in the code snippet above. When only D3D12MA::Allocation object is obtained from a function call like D3D12MA::Allocator::CreateResource, it remembers the ID3D12Resource that was created with it and holds a reference to it. The resource can be obtained by calling allocation->GetResource(), which doesn't increment the resource reference counter. Calling allocation->Release() will decrease the resource reference counter, which is 1 in this case, so the resource will be released.
+ID3D12Resource and other interfaces of Direct3D 12 use COM, so they are reference-counted. Objects of this library are reference-counted as well. An object of type D3D12MA::Allocation remembers the resource (buffer or texture) that was created together with this memory allocation and holds a reference to the ID3D12Resource object. (Note this is a difference to Vulkan Memory Allocator, where a VmaAllocation object has no connection with the buffer or image that was created with it.) Thus, it is important to manage the resource reference counter properly.
+The simplest use case is shown in the code snippet above. When only D3D12MA::Allocation object is obtained from a function call like D3D12MA::Allocator::CreateResource, it remembers the ID3D12Resource that was created with it and holds a reference to it. The resource can be obtained by calling allocation->GetResource(), which doesn't increment the resource reference counter. Calling allocation->Release() will decrease the resource reference counter, which is 1 in this case, so the resource will be released.
Second option is to retrieve a pointer to the resource along with D3D12MA::Allocation. Last parameters of the resource creation function can be used for this purpose.
D3D12MA::Allocation* allocation;
ID3D12Resource* resource;
@@ -179,15 +166,15 @@
IID_PPV_ARGS(&resource));
// Use resource...
-
In this case, returned pointer resource is equal to allocation->GetResource(), but the creation function additionally increases resource reference counter for the purpose of returning it from this call (it actually calls QueryInterface internally), so the resource will have the counter = 2. The resource then need to be released along with the allocation, in this particular order, to make sure the resource is destroyed before its memory heap can potentially be freed.
+In this case, returned pointer resource is equal to allocation->GetResource(), but the creation function additionally increases resource reference counter for the purpose of returning it from this call (it actually calls QueryInterface internally), so the resource will have the counter = 2. The resource then need to be released along with the allocation, in this particular order, to make sure the resource is destroyed before its memory heap can potentially be freed.
resource->Release();
allocation->Release();
-More advanced use cases are possible when we consider that an D3D12MA::Allocation object can just hold a reference to any resource. It can be changed by calling D3D12MA::Allocation::SetResource. This function releases the old resource and calls AddRef on the new one.
-Special care must be taken when performing defragmentation. The new resource created at the destination place should be set as pass.pMoves[i].pDstTmpAllocation->SetResource(newRes), but it is moved to the source allocation at end of the defragmentation pass, while the old resource accessible through pass.pMoves[i].pSrcAllocation->GetResource() is then released. For more information, see documentation chapter Defragmentation.
-
+
More advanced use cases are possible when we consider that an D3D12MA::Allocation object can just hold a reference to any resource. It can be changed by calling D3D12MA::Allocation::SetResource. This function releases the old resource and calls AddRef on the new one.
+Special care must be taken when performing defragmentation. The new resource created at the destination place should be set as pass.pMoves[i].pDstTmpAllocation->SetResource(newRes), but it is moved to the source allocation at end of the defragmentation pass, while the old resource accessible through pass.pMoves[i].pSrcAllocation->GetResource() is then released. For more information, see documentation chapter Defragmentation.
+
Mapping memory
-The process of getting regular CPU-side pointer to the memory of a resource in Direct3D is called "mapping". There are rules and restrictions to this process, as described in D3D12 documentation of ID3D12Resource::Map method.
-Mapping happens on the level of particular resources, not entire memory heaps, and so it is out of scope of this library. Just as the documentation of the Map function says:
+The process of getting regular CPU-side pointer to the memory of a resource in Direct3D is called "mapping". There are rules and restrictions to this process, as described in D3D12 documentation of ID3D12Resource::Map method.
+Mapping happens on the level of particular resources, not entire memory heaps, and so it is out of scope of this library. Just as the documentation of the Map function says:
- Returned pointer refers to data of particular subresource, not entire memory heap.
- You can map same resource multiple times. It is ref-counted internally.
@@ -196,7 +183,7 @@
- Unmapping may not be required before using written data - some heap types on some platforms support resources persistently mapped.
When using this library, you can map and use your resources normally without considering whether they are created as committed resources or placed resources in one large heap.
-Example for buffer created and filled in UPLOAD heap type:
+Example for buffer created and filled in UPLOAD heap type:
const UINT64 bufSize = 65536;
const float* bufData = ...;
@@ -233,17 +220,17 @@
memcpy(mappedPtr, bufData, bufSize);
resource->Unmap(0, NULL);
-
+
Helper structures
-
DirectX 12 Agility SDK offers a library of helpers in files "build\native\include\d3dx12\*.h". They include structures that help with complete and concise initialization of the core D3D12 *_DESC structures by using some basic C++ features (constructors, static methods, default parameters). They inherit from these structures, so they support implicit casting to them. For example, structure CD3DX12_RESOURCE_DESC can be used to conveniently fill in structure D3D12_RESOURCE_DESC.
-Similarly, this library provides a set of helper structures that aid in initialization of some of the *_DESC structures defined in the library. These are:
+DirectX 12 Agility SDK offers a library of helpers in files "build\native\include\d3dx12\*.h". They include structures that help with complete and concise initialization of the core D3D12 *_DESC structures by using some basic C++ features (constructors, static methods, default parameters). They inherit from these structures, so they support implicit casting to them. For example, structure CD3DX12_RESOURCE_DESC can be used to conveniently fill in structure D3D12_RESOURCE_DESC.
+Similarly, this library provides a set of helper structures that aid in initialization of some of the *_DESC structures defined in the library. These are:
- D3D12MA::CALLOCATION_DESC, which inherits from D3D12MA::ALLOCATION_DESC.
- D3D12MA::CPOOL_DESC, which inherits from D3D12MA::POOL_DESC.
- D3D12MA::CVIRTUAL_BLOCK_DESC, which inherits from D3D12MA::VIRTUAL_BLOCK_DESC.
- D3D12MA::CVIRTUAL_ALLOCATION_DESC, which inherits from D3D12MA::VIRTUAL_ALLOCATION_DESC.
-For example, when you want to create a buffer in the UPLAOD heap using minimal allocation time, you can use base structures:
+For example, when you want to create a buffer in the UPLAOD heap using minimal allocation time, you can use base structures:
D3D12MA::ALLOCATION_DESC allocDesc;
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_STRATEGY_MIN_TIME;
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
@@ -291,7 +278,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/resource_aliasing.html b/docs/html/resource_aliasing.html
index c89a007..1275544 100644
--- a/docs/html/resource_aliasing.html
+++ b/docs/html/resource_aliasing.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Resource aliasing (overlap)
-
-
@@ -33,33 +31,22 @@
-
+
-
- Resource aliasing (overlap)
+ Resource aliasing (overlap)
New explicit graphics APIs (Vulkan and Direct3D 12), thanks to manual memory management, give an opportunity to alias (overlap) multiple resources in the same region of memory - a feature not available in the old APIs (Direct3D 11, OpenGL). It can be useful to save video memory, but it must be used with caution.
@@ -171,18 +158,18 @@
Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.Definition D3D12MemAlloc.h:338
D3D12_HEAP_FLAGS ExtraHeapFlagsAdditional heap flags to be used when allocating memory.Definition D3D12MemAlloc.h:363
D3D12_HEAP_TYPE HeapTypeThe type of memory heap where the new allocation should be placed.Definition D3D12MemAlloc.h:347
-Remember that using resouces that alias in memory requires proper synchronization. You need to issue a special barrier of type D3D12_RESOURCE_BARRIER_TYPE_ALIASING. You also need to treat a resource after aliasing as uninitialized - containing garbage data. For example, if you use res1 and then want to use res2, you need to first initialize res2 using either Clear, Discard, or Copy to the entire resource.
+Remember that using resouces that alias in memory requires proper synchronization. You need to issue a special barrier of type D3D12_RESOURCE_BARRIER_TYPE_ALIASING. You also need to treat a resource after aliasing as uninitialized - containing garbage data. For example, if you use res1 and then want to use res2, you need to first initialize res2 using either Clear, Discard, or Copy to the entire resource.
Additional considerations:
- D3D12 also allows to interpret contents of memory between aliasing resources consistently in some cases, which is called "data inheritance". For details, see Microsoft documentation chapter "Memory Aliasing and Data Inheritance".
-- You can create more complex layout where different textures and buffers are bound at different offsets inside one large allocation. For example, one can imagine a big texture used in some render passes, aliasing with a set of many small buffers used in some further passes. To bind a resource at non-zero offset of an allocation, call D3D12MA::Allocator::CreateAliasingResource with appropriate value of
AllocationLocalOffset parameter.
-- Resources of the three categories: buffers, textures with
RENDER_TARGET or DEPTH_STENCIL flags, and all other textures, can be placed in the same memory only when allocator->GetD3D12Options().ResourceHeapTier >= D3D12_RESOURCE_HEAP_TIER_2. Otherwise they must be placed in different memory heap types, and thus aliasing them is not possible.
+- You can create more complex layout where different textures and buffers are bound at different offsets inside one large allocation. For example, one can imagine a big texture used in some render passes, aliasing with a set of many small buffers used in some further passes. To bind a resource at non-zero offset of an allocation, call D3D12MA::Allocator::CreateAliasingResource with appropriate value of AllocationLocalOffset parameter.
+- Resources of the three categories: buffers, textures with RENDER_TARGET or DEPTH_STENCIL flags, and all other textures, can be placed in the same memory only when allocator->GetD3D12Options().ResourceHeapTier >= D3D12_RESOURCE_HEAP_TIER_2. Otherwise they must be placed in different memory heap types, and thus aliasing them is not possible.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/search/pages_0.js b/docs/html/search/pages_0.js
index 6c4bc1e..4e13aaf 100644
--- a/docs/html/search/pages_0.js
+++ b/docs/html/search/pages_0.js
@@ -1,10 +1,23 @@
var searchData=
[
- ['algorithm_0',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
- ['aliasing_20overlap_1',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
- ['allocation_2',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
- ['allocation_20algorithm_3',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
- ['allocator_4',['D3D12 Memory Allocator',['../index.html',1,'']]],
- ['allocator_5',['Virtual allocator',['../virtual_allocator.html',1,'optimal_allocation']]],
- ['asked_20questions_6',['Frequently asked questions',['../faq.html',1,'index']]]
+ ['additional_20considerations_0',['Additional considerations',['../linear_algorithm.html#linear_algorithm_additional_considerations',1,'Additional considerations'],['../virtual_allocator.html#virtual_allocator_additional_considerations',1,'Additional considerations']]],
+ ['algorithm_1',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
+ ['aliasing_20overlap_2',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
+ ['alignment_3',['Resource alignment',['../optimal_allocation.html#optimal_allocation_resource_alignment',1,'']]],
+ ['alignment_20and_20units_4',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]],
+ ['allocating_20buffers_5',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]],
+ ['allocation_6',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
+ ['allocation_20algorithm_7',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
+ ['allocation_20parameters_8',['Allocation parameters',['../virtual_allocator.html#virtual_allocator_allocation_parameters',1,'']]],
+ ['allocation_20performance_9',['Allocation performance',['../optimal_allocation.html#optimal_allocation_allocation_Performance',1,'']]],
+ ['allocations_10',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]],
+ ['allocator_11',['D3D12 Memory Allocator',['../index.html',1,'']]],
+ ['allocator_12',['allocator',['../configuration.html#custom_memory_allocator',1,'Custom CPU memory allocator'],['../virtual_allocator.html',1,'Virtual allocator']]],
+ ['and_20benefits_13',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]],
+ ['and_20compatibility_14',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]],
+ ['and_20initialization_15',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]],
+ ['and_20units_16',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]],
+ ['asked_20questions_17',['Frequently asked questions',['../faq.html',1,'index']]],
+ ['at_20once_18',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]],
+ ['avoiding_20running_20out_20of_20memory_19',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]]
];
diff --git a/docs/html/search/pages_1.js b/docs/html/search/pages_1.js
index 91cb574..d34b057 100644
--- a/docs/html/search/pages_1.js
+++ b/docs/html/search/pages_1.js
@@ -1,6 +1,7 @@
var searchData=
[
- ['configuration_0',['Configuration',['../configuration.html',1,'index']]],
- ['considerations_1',['General considerations',['../general_considerations.html',1,'index']]],
- ['custom_20memory_20pools_2',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
+ ['benefits_0',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]],
+ ['block_1',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]],
+ ['buffer_2',['Ring buffer',['../linear_algorithm.html#linear_algorithm_ring_buffer',1,'']]],
+ ['buffers_3',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]]
];
diff --git a/docs/html/search/pages_10.js b/docs/html/search/pages_10.js
new file mode 100644
index 0000000..af3b029
--- /dev/null
+++ b/docs/html/search/pages_10.js
@@ -0,0 +1,13 @@
+var searchData=
+[
+ ['safety_0',['Thread safety',['../general_considerations.html#general_considerations_thread_safety',1,'']]],
+ ['setup_20and_20initialization_1',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]],
+ ['stack_2',['Stack',['../linear_algorithm.html#linear_algorithm_stack',1,'']]],
+ ['stack_3',['Double stack',['../linear_algorithm.html#linear_algorithm_double_stack',1,'']]],
+ ['start_4',['Quick start',['../quick_start.html',1,'index']]],
+ ['statistics_5',['Statistics',['../statistics.html',1,'Statistics'],['../virtual_allocator.html#virtual_allocator_statistics',1,'Statistics']]],
+ ['statistics_6',['Numeric statistics',['../statistics.html#statistics_numeric_statistics',1,'']]],
+ ['structures_7',['Helper structures',['../quick_start.html#quick_start_helper_structures',1,'']]],
+ ['sub_20allocating_20buffers_8',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]],
+ ['supported_9',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]]
+];
diff --git a/docs/html/search/pages_11.js b/docs/html/search/pages_11.js
new file mode 100644
index 0000000..ce665b6
--- /dev/null
+++ b/docs/html/search/pages_11.js
@@ -0,0 +1,5 @@
+var searchData=
+[
+ ['table_20of_20contents_0',['Table of contents',['../index.html#main_table_of_contents',1,'']]],
+ ['thread_20safety_1',['Thread safety',['../general_considerations.html#general_considerations_thread_safety',1,'']]]
+];
diff --git a/docs/html/search/pages_12.js b/docs/html/search/pages_12.js
new file mode 100644
index 0000000..32f0ad5
--- /dev/null
+++ b/docs/html/search/pages_12.js
@@ -0,0 +1,6 @@
+var searchData=
+[
+ ['units_0',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]],
+ ['upload_20heap_1',['GPU upload heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'']]],
+ ['usage_2',['Usage',['../custom_pools.html#custom_pools_usage',1,'']]]
+];
diff --git a/docs/html/search/pages_13.js b/docs/html/search/pages_13.js
new file mode 100644
index 0000000..aa04e5d
--- /dev/null
+++ b/docs/html/search/pages_13.js
@@ -0,0 +1,8 @@
+var searchData=
+[
+ ['versioning_20and_20compatibility_0',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]],
+ ['versus_20placed_20resources_1',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]],
+ ['virtual_20allocations_2',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]],
+ ['virtual_20allocator_3',['Virtual allocator',['../virtual_allocator.html',1,'optimal_allocation']]],
+ ['virtual_20block_4',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]]
+];
diff --git a/docs/html/search/pages_14.js b/docs/html/search/pages_14.js
new file mode 100644
index 0000000..8225a92
--- /dev/null
+++ b/docs/html/search/pages_14.js
@@ -0,0 +1,4 @@
+var searchData=
+[
+ ['web_20links_0',['Web links',['../index.html#main_see_also',1,'']]]
+];
diff --git a/docs/html/search/pages_2.js b/docs/html/search/pages_2.js
index 8aa1a38..7553f75 100644
--- a/docs/html/search/pages_2.js
+++ b/docs/html/search/pages_2.js
@@ -1,5 +1,14 @@
var searchData=
[
- ['d3d12_20memory_20allocator_0',['D3D12 Memory Allocator',['../index.html',1,'']]],
- ['defragmentation_1',['Defragmentation',['../defragmentation.html',1,'optimal_allocation']]]
+ ['committed_20versus_20placed_20resources_0',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]],
+ ['compatibility_1',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]],
+ ['configuration_2',['Configuration',['../configuration.html',1,'index']]],
+ ['considerations_3',['considerations',['../linear_algorithm.html#linear_algorithm_additional_considerations',1,'Additional considerations'],['../virtual_allocator.html#virtual_allocator_additional_considerations',1,'Additional considerations'],['../general_considerations.html',1,'General considerations']]],
+ ['contents_4',['Table of contents',['../index.html#main_table_of_contents',1,'']]],
+ ['counting_5',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]],
+ ['cpu_20memory_20allocator_6',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]],
+ ['creating_20resources_7',['Creating resources',['../quick_start.html#quick_start_creating_resources',1,'']]],
+ ['creating_20virtual_20block_8',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]],
+ ['custom_20cpu_20memory_20allocator_9',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]],
+ ['custom_20memory_20pools_10',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
];
diff --git a/docs/html/search/pages_3.js b/docs/html/search/pages_3.js
index 842b2bb..89d174b 100644
--- a/docs/html/search/pages_3.js
+++ b/docs/html/search/pages_3.js
@@ -1,4 +1,9 @@
var searchData=
[
- ['frequently_20asked_20questions_0',['Frequently asked questions',['../faq.html',1,'index']]]
+ ['d3d12_20memory_20allocator_0',['D3D12 Memory Allocator',['../index.html',1,'']]],
+ ['deallocation_1',['Deallocation',['../virtual_allocator.html#virtual_allocator_deallocation',1,'']]],
+ ['debug_20margins_2',['Debug margins',['../configuration.html#debug_margins',1,'']]],
+ ['defragmentation_3',['Defragmentation',['../defragmentation.html',1,'optimal_allocation']]],
+ ['double_20stack_4',['Double stack',['../linear_algorithm.html#linear_algorithm_double_stack',1,'']]],
+ ['dump_5',['JSON dump',['../statistics.html#statistics_json_dump',1,'']]]
];
diff --git a/docs/html/search/pages_4.js b/docs/html/search/pages_4.js
index 1aed57d..6f9860c 100644
--- a/docs/html/search/pages_4.js
+++ b/docs/html/search/pages_4.js
@@ -1,4 +1,7 @@
var searchData=
[
- ['general_20considerations_0',['General considerations',['../general_considerations.html',1,'index']]]
+ ['features_20and_20benefits_0',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]],
+ ['features_20not_20supported_1',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]],
+ ['free_20at_20once_2',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]],
+ ['frequently_20asked_20questions_3',['Frequently asked questions',['../faq.html',1,'index']]]
];
diff --git a/docs/html/search/pages_5.js b/docs/html/search/pages_5.js
index b965ff9..b85c57f 100644
--- a/docs/html/search/pages_5.js
+++ b/docs/html/search/pages_5.js
@@ -1,4 +1,5 @@
var searchData=
[
- ['linear_20allocation_20algorithm_0',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]]
+ ['general_20considerations_0',['General considerations',['../general_considerations.html',1,'index']]],
+ ['gpu_20upload_20heap_1',['GPU upload heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'']]]
];
diff --git a/docs/html/search/pages_6.js b/docs/html/search/pages_6.js
index 2fa4310..6386d6c 100644
--- a/docs/html/search/pages_6.js
+++ b/docs/html/search/pages_6.js
@@ -1,5 +1,5 @@
var searchData=
[
- ['memory_20allocator_0',['D3D12 Memory Allocator',['../index.html',1,'']]],
- ['memory_20pools_1',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
+ ['heap_0',['GPU upload heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'']]],
+ ['helper_20structures_1',['Helper structures',['../quick_start.html#quick_start_helper_structures',1,'']]]
];
diff --git a/docs/html/search/pages_7.js b/docs/html/search/pages_7.js
index 0c3cb7f..75d0639 100644
--- a/docs/html/search/pages_7.js
+++ b/docs/html/search/pages_7.js
@@ -1,5 +1,4 @@
var searchData=
[
- ['optimal_20resource_20allocation_0',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
- ['overlap_1',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]]
+ ['initialization_0',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]]
];
diff --git a/docs/html/search/pages_8.js b/docs/html/search/pages_8.js
index f4128dd..2f270a2 100644
--- a/docs/html/search/pages_8.js
+++ b/docs/html/search/pages_8.js
@@ -1,4 +1,4 @@
var searchData=
[
- ['pools_0',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
+ ['json_20dump_0',['JSON dump',['../statistics.html#statistics_json_dump',1,'']]]
];
diff --git a/docs/html/search/pages_9.js b/docs/html/search/pages_9.js
index c9afe7b..9cdb234 100644
--- a/docs/html/search/pages_9.js
+++ b/docs/html/search/pages_9.js
@@ -1,5 +1,5 @@
var searchData=
[
- ['questions_0',['Frequently asked questions',['../faq.html',1,'index']]],
- ['quick_20start_1',['Quick start',['../quick_start.html',1,'index']]]
+ ['linear_20allocation_20algorithm_0',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
+ ['links_1',['Web links',['../index.html#main_see_also',1,'']]]
];
diff --git a/docs/html/search/pages_a.js b/docs/html/search/pages_a.js
index 53f0a34..0ce8dfd 100644
--- a/docs/html/search/pages_a.js
+++ b/docs/html/search/pages_a.js
@@ -1,5 +1,10 @@
var searchData=
[
- ['resource_20aliasing_20overlap_0',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
- ['resource_20allocation_1',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]]
+ ['making_20virtual_20allocations_0',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]],
+ ['mapping_20memory_1',['Mapping memory',['../quick_start.html#quick_start_mapping_memory',1,'']]],
+ ['margins_2',['Debug margins',['../configuration.html#debug_margins',1,'']]],
+ ['memory_3',['memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'Avoiding running out of memory'],['../quick_start.html#quick_start_mapping_memory',1,'Mapping memory']]],
+ ['memory_20allocator_4',['D3D12 Memory Allocator',['../index.html',1,'']]],
+ ['memory_20allocator_5',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]],
+ ['memory_20pools_6',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
];
diff --git a/docs/html/search/pages_b.js b/docs/html/search/pages_b.js
index d4b7ec0..a1fc386 100644
--- a/docs/html/search/pages_b.js
+++ b/docs/html/search/pages_b.js
@@ -1,5 +1,5 @@
var searchData=
[
- ['start_0',['Quick start',['../quick_start.html',1,'index']]],
- ['statistics_1',['Statistics',['../statistics.html',1,'optimal_allocation']]]
+ ['not_20supported_0',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]],
+ ['numeric_20statistics_1',['Numeric statistics',['../statistics.html#statistics_numeric_statistics',1,'']]]
];
diff --git a/docs/html/search/pages_c.js b/docs/html/search/pages_c.js
index 6f1ceb8..2036541 100644
--- a/docs/html/search/pages_c.js
+++ b/docs/html/search/pages_c.js
@@ -1,4 +1,9 @@
var searchData=
[
- ['virtual_20allocator_0',['Virtual allocator',['../virtual_allocator.html',1,'optimal_allocation']]]
+ ['of_20contents_0',['Table of contents',['../index.html#main_table_of_contents',1,'']]],
+ ['of_20memory_1',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]],
+ ['once_2',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]],
+ ['optimal_20resource_20allocation_3',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
+ ['out_20of_20memory_4',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]],
+ ['overlap_5',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]]
];
diff --git a/docs/html/search/pages_d.js b/docs/html/search/pages_d.js
new file mode 100644
index 0000000..61cd771
--- /dev/null
+++ b/docs/html/search/pages_d.js
@@ -0,0 +1,9 @@
+var searchData=
+[
+ ['parameters_0',['Allocation parameters',['../virtual_allocator.html#virtual_allocator_allocation_parameters',1,'']]],
+ ['performance_1',['Allocation performance',['../optimal_allocation.html#optimal_allocation_allocation_Performance',1,'']]],
+ ['placed_20resources_2',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]],
+ ['pools_3',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]],
+ ['priority_4',['Residency priority',['../optimal_allocation.html#optimal_allocation_residency_priority',1,'']]],
+ ['project_20setup_20and_20initialization_5',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]]
+];
diff --git a/docs/html/search/pages_e.js b/docs/html/search/pages_e.js
new file mode 100644
index 0000000..c9afe7b
--- /dev/null
+++ b/docs/html/search/pages_e.js
@@ -0,0 +1,5 @@
+var searchData=
+[
+ ['questions_0',['Frequently asked questions',['../faq.html',1,'index']]],
+ ['quick_20start_1',['Quick start',['../quick_start.html',1,'index']]]
+];
diff --git a/docs/html/search/pages_f.js b/docs/html/search/pages_f.js
new file mode 100644
index 0000000..97e8dbf
--- /dev/null
+++ b/docs/html/search/pages_f.js
@@ -0,0 +1,12 @@
+var searchData=
+[
+ ['reference_20counting_0',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]],
+ ['residency_20priority_1',['Residency priority',['../optimal_allocation.html#optimal_allocation_residency_priority',1,'']]],
+ ['resource_20aliasing_20overlap_2',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
+ ['resource_20alignment_3',['Resource alignment',['../optimal_allocation.html#optimal_allocation_resource_alignment',1,'']]],
+ ['resource_20allocation_4',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
+ ['resource_20reference_20counting_5',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]],
+ ['resources_6',['resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'Committed versus placed resources'],['../quick_start.html#quick_start_creating_resources',1,'Creating resources']]],
+ ['ring_20buffer_7',['Ring buffer',['../linear_algorithm.html#linear_algorithm_ring_buffer',1,'']]],
+ ['running_20out_20of_20memory_8',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]]
+];
diff --git a/docs/html/search/search.css b/docs/html/search/search.css
index 19f76f9..956f31f 100644
--- a/docs/html/search/search.css
+++ b/docs/html/search/search.css
@@ -5,8 +5,8 @@
display: flex;
justify-content: center;
align-items: center;
- height: 36px;
- margin-right: 1em;
+ height: 43px;
+ margin-right: 0;
}
/*---------------- Search box styling */
@@ -27,43 +27,23 @@ dark-mode-toggle {
white-space : nowrap;
background: var(--search-background-color);
border-radius: 0.65em;
- box-shadow: var(--search-box-shadow);
+ border: 1px solid var(--search-box-border-color);
z-index: 102;
+ margin-right: 4px;
}
#MSearchBox .left {
display: inline-block;
vertical-align: middle;
- height: 1.4em;
-}
-
-#MSearchSelect {
- display: inline-block;
- vertical-align: middle;
- width: 20px;
- height: 19px;
- background-image: var(--search-magnification-select-image);
- margin: 0 0 0 0.3em;
- padding: 0;
+ height: 1.6em;
}
-#MSearchSelectExt {
- display: inline-block;
- vertical-align: middle;
- width: 10px;
- height: 19px;
- background-image: var(--search-magnification-image);
- margin: 0 0 0 0.5em;
- padding: 0;
-}
-
-
#MSearchField {
display: inline-block;
- vertical-align: middle;
+ vertical-align: top;
width: 7.5em;
- height: 19px;
- margin: 0 0.15em;
+ height: 22px;
+ margin: 0 0 0 0.15em;
padding: 0;
line-height: 1em;
border:none;
@@ -86,7 +66,7 @@ dark-mode-toggle {
display: inline-block;
vertical-align: middle;
width: 1.4em;
- height: 1.4em;
+ height: 1.6em;
}
#MSearchClose {
@@ -101,14 +81,100 @@ dark-mode-toggle {
}
#MSearchCloseImg {
- padding: 0.3em;
- margin: 0;
+ margin: 6px 0 0 4px;
+}
+
+.close-icon {
+ width: 11px;
+ height: 11px;
+ background-color: var(--search-close-icon-bg-color);
+ border-radius: 50%;
+ position: relative;
+ display: flex;
+ justify-content: center;
+ align-items: center;
+ box-sizing: content-box;
+}
+
+.close-icon:before,
+.close-icon:after {
+ content: '';
+ position: absolute;
+ width: 7px;
+ height: 1px;
+ background-color: var(--search-close-icon-fg-color);
+}
+
+.close-icon:before {
+ transform: rotate(45deg);
}
+.close-icon:after {
+ transform: rotate(-45deg);
+}
+
+
.MSearchBoxActive #MSearchField {
color: var(--search-active-color);
}
+.search-icon {
+ width: 20px;
+ height: 20px;
+ display: inline-block;
+ position: relative;
+ margin-left: 3px;
+}
+
+#MSearchSelectExt.search-icon {
+ width: 10px;
+}
+
+#MSearchSelectExt + input {
+ margin-left: 5px;
+}
+
+.search-icon::before, .search-icon::after {
+ content: '';
+ position: absolute;
+ border: 1.5px solid var(--search-foreground-color);
+ box-sizing: content-box;
+}
+
+.search-icon::before {
+ width: 6px;
+ height: 6px;
+ border-radius: 50%;
+ top: 7px;
+ left: 2px;
+ background: var(--search-background-color);
+}
+
+.search-icon::after {
+ border: 1px solid var(--search-foreground-color);
+ width: 0px;
+ height: 3px;
+ border-radius: 2px;
+ top: 15px;
+ left: 8px;
+ transform: rotate(-45deg);
+ transform-origin: top left;
+}
+
+.search-icon-dropdown {
+ content: '';
+ width: 0;
+ height: 0;
+ border-left: 3px solid transparent;
+ border-right: 3px solid transparent;
+ border-top: 3px solid var(--search-foreground-color);
+ top: 8px;
+ left: 15px;
+ transform: translateX(-50%);
+ position: absolute;
+}
+
+
/*---------------- Search filter selection */
@@ -119,15 +185,12 @@ dark-mode-toggle {
left: 0; top: 0;
border: 1px solid var(--search-filter-border-color);
background-color: var(--search-filter-background-color);
+ backdrop-filter: var(--search-filter-backdrop-filter);
+ -webkit-backdrop-filter: var(--search-filter-backdrop-filter);
z-index: 10001;
padding-top: 4px;
padding-bottom: 4px;
- -moz-border-radius: 4px;
- -webkit-border-top-left-radius: 4px;
- -webkit-border-top-right-radius: 4px;
- -webkit-border-bottom-left-radius: 4px;
- -webkit-border-bottom-right-radius: 4px;
- -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ border-radius: 4px;
}
.SelectItem {
@@ -176,18 +239,39 @@ iframe#MSearchResults {
height: 15em;
}
+@keyframes slideInSearchResults {
+ from {
+ opacity: 0;
+ transform: translate(0, 15px);
+ }
+
+ to {
+ opacity: 1;
+ transform: translate(0, 20px);
+ }
+}
+
#MSearchResultsWindow {
display: none;
position: absolute;
- left: 0; top: 0;
+ left: auto;
+ right: 4px;
+ top: 0;
border: 1px solid var(--search-results-border-color);
background-color: var(--search-results-background-color);
+ backdrop-filter: var(--search-results-backdrop-filter);
+ -webkit-backdrop-filter: var(--search-results-backdrop-filter);
z-index:10000;
width: 300px;
height: 400px;
overflow: auto;
+ border-radius: 8px;
+ transform: translate(0, 20px);
+ animation: ease-out 280ms slideInSearchResults;
+ box-shadow: 0 2px 8px 0 rgba(0,0,0,.075);
}
+
/* ----------------------------------- */
@@ -201,13 +285,13 @@ iframe#MSearchResults {
}
.SRPage .SREntry {
- font-size: 8pt;
- padding: 1px 5px;
+ font-size: 10pt;
+ padding: 2px 5px;
}
div.SRPage {
margin: 5px 2px;
- background-color: var(--search-results-background-color);
+ /*background-color: var(--search-results-background-color);*/
}
.SRChildren {
@@ -261,14 +345,17 @@ div.searchresults {
margin-right: 10px;
}
+#searchBoxPos1 dark-mode-toggle {
+ margin-top: 4px;
+}
+
/*---------------- External search page results */
.pages b {
- color: white;
+ color: var(--nav-foreground-color);
padding: 5px 5px 3px 5px;
- background-image: var(--nav-gradient-active-image-parent);
- background-repeat: repeat-x;
- text-shadow: 0 1px 1px #000000;
+ background-color: var(--nav-menu-active-bg);
+ border-radius: 4px;
}
.pages {
diff --git a/docs/html/search/search.js b/docs/html/search/search.js
index 666af01..dc14410 100644
--- a/docs/html/search/search.js
+++ b/docs/html/search/search.js
@@ -607,6 +607,12 @@ function createResults(resultsPath) {
elem.setAttribute('className',attr);
}
+ const decodeHtml = (html) => {
+ const txt = document.createElement("textarea");
+ txt.innerHTML = html;
+ return txt.value;
+ };
+
const results = document.getElementById("SRResults");
results.innerHTML = '';
searchData.forEach((elem,index) => {
@@ -620,10 +626,14 @@ function createResults(resultsPath) {
srLink.setAttribute('id','Item'+index);
setKeyActions(srLink,'return searchResults.Nav(event,'+index+')');
setClassAttr(srLink,'SRSymbol');
- srLink.innerHTML = elem[1][0];
+ srLink.innerHTML = decodeHtml(elem[1][0]);
srEntry.appendChild(srLink);
if (elem[1].length==2) { // single result
- srLink.setAttribute('href',resultsPath+elem[1][1][0]);
+ if (elem[1][1][0].startsWith('http://') || elem[1][1][0].startsWith('https://')) { // absolute path
+ srLink.setAttribute('href',elem[1][1][0]);
+ } else { // relative path
+ srLink.setAttribute('href',resultsPath+elem[1][1][0]);
+ }
srLink.setAttribute('onclick','searchBox.CloseResultsWindow()');
if (elem[1][1][1]) {
srLink.setAttribute('target','_parent');
@@ -632,7 +642,7 @@ function createResults(resultsPath) {
}
const srScope = document.createElement('span');
setClassAttr(srScope,'SRScope');
- srScope.innerHTML = elem[1][1][2];
+ srScope.innerHTML = decodeHtml(elem[1][1][2]);
srEntry.appendChild(srScope);
} else { // multiple results
srLink.setAttribute('href','javascript:searchResults.Toggle("SR_'+id+'")');
@@ -643,14 +653,18 @@ function createResults(resultsPath) {
srChild.setAttribute('id','Item'+index+'_c'+c);
setKeyActions(srChild,'return searchResults.NavChild(event,'+index+','+c+')');
setClassAttr(srChild,'SRScope');
- srChild.setAttribute('href',resultsPath+elem[1][c+1][0]);
+ if (elem[1][c+1][0].startsWith('http://') || elem[1][c+1][0].startsWith('https://')) { // absolute path
+ srChild.setAttribute('href',elem[1][c+1][0]);
+ } else { // relative path
+ srChild.setAttribute('href',resultsPath+elem[1][c+1][0]);
+ }
srChild.setAttribute('onclick','searchBox.CloseResultsWindow()');
if (elem[1][c+1][1]) {
srChild.setAttribute('target','_parent');
} else {
srChild.setAttribute('target','_blank');
}
- srChild.innerHTML = elem[1][c+1][2];
+ srChild.innerHTML = decodeHtml(elem[1][c+1][2]);
srChildren.appendChild(srChild);
}
srEntry.appendChild(srChildren);
diff --git a/docs/html/search/searchdata.js b/docs/html/search/searchdata.js
index 1b7813a..2029dc1 100644
--- a/docs/html/search/searchdata.js
+++ b/docs/html/search/searchdata.js
@@ -11,7 +11,7 @@ var indexSectionsWithContent =
8: "adpv",
9: "cd",
10: "d",
- 11: "acdfglmopqrsv"
+ 11: "abcdfghijlmnopqrstuvw"
};
var indexSectionNames =
diff --git a/docs/html/statistics.html b/docs/html/statistics.html
index f261c65..b9b1e29 100644
--- a/docs/html/statistics.html
+++ b/docs/html/statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Statistics
-
-
@@ -33,33 +31,22 @@
-
+
-
- Statistics
+ Statistics
This library contains several functions that return information about its internal state, especially the amount of memory allocated from D3D12.
-
+
Numeric statistics
If you need to obtain basic statistics about memory usage per memory segment group, together with current budget, you can call function D3D12MA::Allocator::GetBudget() and inspect structure D3D12MA::Budget. This is useful to keep track of memory usage and stay withing budget. Example:
D3D12MA::Budget localBudget;
@@ -112,8 +99,8 @@
UINT64 UsageBytesEstimated current memory usage of the program.Definition D3D12MemAlloc.h:486
You can query for more detailed statistics per heap type, memory segment group, and totals, including minimum and maximum allocation size and unused range size, by calling function D3D12MA::Allocator::CalculateStatistics() and inspecting structure D3D12MA::TotalStatistics. This function is slower though, as it has to traverse all the internal data structures, so it should be used only for debugging purposes.
You can query for statistics of a custom pool using function D3D12MA::Pool::GetStatistics() or D3D12MA::Pool::CalculateStatistics().
-You can query for information about a specific allocation using functions of the D3D12MA::Allocation class, e.g. GetSize(), GetOffset(), GetHeap().
-
+
You can query for information about a specific allocation using functions of the D3D12MA::Allocation class, e.g. GetSize(), GetOffset(), GetHeap().
+
JSON dump
You can dump internal state of the allocator to a string in JSON format using function D3D12MA::Allocator::BuildStatsString(). The result is guaranteed to be correct JSON. It uses Windows Unicode (UTF-16) encoding. Any strings provided by user (see D3D12MA::Allocation::SetName()) are copied as-is and properly escaped for JSON. It must be freed using function D3D12MA::Allocator::FreeStatsString().
The format of this JSON string is not part of official documentation of the library, but it will not change in backward-incompatible way without increasing library major version number and appropriate mention in changelog.
@@ -122,7 +109,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html
index 223cc58..f967c0c 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html
index bb90eaa..495fe3f 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::ALLOCATION_CALLBACKS Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
ALLOCATE_FUNC_PTR pAllocate Allocation function.
FREE_FUNC_PTR pFree Dellocation function.
void * pPrivateData Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
-Detailed Description
+Detailed Description
Custom callbacks to CPU memory allocation functions.
-Member Data Documentation
+Member Data Documentation
◆ pAllocate
@@ -159,7 +143,7 @@
-Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
+Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
@@ -169,7 +153,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 0dd1a39..f398da5 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -102,7 +89,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 5363747..d914ec6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,33 +90,28 @@
Inheritance diagram for D3D12MA::ALLOCATION_DESC:
-
-
-
+
Public Attributes
ALLOCATION_FLAGS Flags Flags for the allocation.
D3D12_HEAP_TYPE HeapType The type of memory heap where the new allocation should be placed.
D3D12_HEAP_FLAGS ExtraHeapFlags Additional heap flags to be used when allocating memory.
Pool * CustomPool Custom pool to place the new resource in. Optional.
void * pPrivateData Custom general-purpose pointer that will be stored in D3D12MA::Allocation.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.
-Member Data Documentation
+Member Data Documentation
◆ CustomPool
@@ -143,7 +125,7 @@
Custom pool to place the new resource in. Optional.
-When not null, the resource will be created inside specified custom pool. Members HeapType, ExtraHeapFlags are then ignored.
+When not null, the resource will be created inside specified custom pool. Members HeapType, ExtraHeapFlags are then ignored.
@@ -162,9 +144,9 @@ D3D12MA::Allocator::CreateResource(), you don't need to care. Necessary flag D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, or D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES is added automatically.
-- If you use D3D12MA::Allocator::AllocateMemory(), you should specify one of those
ALLOW_ONLY flags. Except when you validate that D3D12MA::Allocator::GetD3D12Options().ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1 - then you can leave it 0.
-- You can specify additional flags if needed. Then the memory will always be allocated as separate block using
D3D12Device::CreateCommittedResource or CreateHeap, not as part of an existing larget block.
+- If you use D3D12MA::Allocator::CreateResource(), you don't need to care. Necessary flag D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, or D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES is added automatically.
+- If you use D3D12MA::Allocator::AllocateMemory(), you should specify one of those ALLOW_ONLY flags. Except when you validate that D3D12MA::Allocator::GetD3D12Options().ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1 - then you can leave it 0.
+- You can specify additional flags if needed. Then the memory will always be allocated as separate block using D3D12Device::CreateCommittedResource or CreateHeap, not as part of an existing larget block.
When D3D12MA::ALLOCATION_DESC::CustomPool != NULL this member is ignored.
@@ -199,7 +181,7 @@
The type of memory heap where the new allocation should be placed.
-It must be one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK.
+It must be one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK.
When D3D12MA::ALLOCATION_DESC::CustomPool != NULL this member is ignored.
@@ -226,7 +208,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html
index ccc6e9d..cfc611c 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -102,7 +89,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html
index 8673896..33029a6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::ALLOCATOR_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
ALLOCATOR_FLAGS Flags Flags for the entire allocator.
ID3D12Device * pDevice UINT64 PreferredBlockSize Preferred size of a single ID3D12Heap block to be allocated.
Preferred size of a single ID3D12Heap block to be allocated.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
IDXGIAdapter * pAdapter
-Detailed Description
+Detailed Description
Parameters of created Allocator object. To be used with CreateAllocator().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -148,7 +130,7 @@
DXGI Adapter object that you use for D3D12 and this allocator.
-Allocator is doing AddRef/Release on this object.
+Allocator is doing AddRef/Release on this object.
@@ -181,7 +163,7 @@
Direct3D device object that the allocator should be attached to.
-Allocator is doing AddRef/Release on this object.
+Allocator is doing AddRef/Release on this object.
@@ -197,7 +179,7 @@
-Preferred size of a single ID3D12Heap block to be allocated.
+Preferred size of a single ID3D12Heap block to be allocated.
Set to 0 to use default, which is currently 64 MiB.
@@ -208,7 +190,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_budget-members.html b/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
index ddeda17..26e4bee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_budget.html b/docs/html/struct_d3_d12_m_a_1_1_budget.html
index 4798ab6..8e8f354 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_budget.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_budget.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Budget Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Statistics fetched from the library.
UINT64 UsageBytes Estimated current memory usage of the program.
UINT64 BudgetBytes Estimated amount of memory available to the program.
-Detailed Description
+Detailed Description
Statistics of current memory usage and available budget for a specific memory segment group.
These are fast to calculate. See function D3D12MA::Allocator::GetBudget().
-Member Data Documentation
+Member Data Documentation
◆ BudgetBytes
@@ -129,8 +113,8 @@
Estimated amount of memory available to the program.
-Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
-It might be different (most probably smaller) than memory capacity returned by D3D12MA::Allocator::GetMemoryCapacity() due to factors external to the program, decided by the operating system. Difference BudgetBytes - UsageBytes is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.
+Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
+It might be different (most probably smaller) than memory capacity returned by D3D12MA::Allocator::GetMemoryCapacity() due to factors external to the program, decided by the operating system. Difference BudgetBytes - UsageBytes is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.
@@ -163,8 +147,8 @@
Estimated current memory usage of the program.
-Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
-It might be different than BlockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipeline state objects, descriptor heaps, command lists, or heaps and resources allocated outside of this library, if any.
+Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
+It might be different than BlockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipeline state objects, descriptor heaps, command lists, or heaps and resources allocated outside of this library, if any.
@@ -174,7 +158,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 656581f..9423c7f 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 49c2950..cae7b08 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,49 +90,40 @@
Inheritance diagram for D3D12MA::CALLOCATION_DESC:
-
-
-
+
Public Member Functions
CALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CALLOCATION_DESC (const ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::ALLOCATION_DESC structure.
CALLOCATION_DESC (Pool *customPool, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of an allocation to be created in a specific custom pool.
CALLOCATION_DESC (D3D12_HEAP_TYPE heapType, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL, D3D12_HEAP_FLAGS extraHeapFlags=D3D12MA_RECOMMENDED_HEAP_FLAGS) noexcept Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::ALLOCATION_DESC Public Attributes inherited from D3D12MA::ALLOCATION_DESC ALLOCATION_FLAGS Flags Flags for the allocation.
D3D12_HEAP_TYPE HeapType The type of memory heap where the new allocation should be placed.
D3D12_HEAP_FLAGS ExtraHeapFlags Additional heap flags to be used when allocating memory.
Pool * CustomPool Custom pool to place the new resource in. Optional.
void * pPrivateData Custom general-purpose pointer that will be stored in D3D12MA::Allocation.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CALLOCATION_DESC() [1/4]
@@ -273,7 +251,7 @@
-Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
+Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
@@ -283,7 +261,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
index 1cb0dea..66262d0 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -110,7 +97,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
index fb6bf6f..37f7330 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CPOOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,61 +90,48 @@
Inheritance diagram for D3D12MA::CPOOL_DESC:
-
-
-
+
Public Member Functions
CPOOL_DESC ()=default Default constructor. Leaves the structure uninitialized.
CPOOL_DESC (const POOL_DESC &o) noexcept Constructor initializing from the base D3D12MA::POOL_DESC structure.
CPOOL_DESC (D3D12_HEAP_TYPE heapType, D3D12_HEAP_FLAGS heapFlags, POOL_FLAGS flags=D3D12MA_RECOMMENDED_POOL_FLAGS, UINT64 blockSize=0, UINT minBlockCount=0, UINT maxBlockCount=UINT_MAX, D3D12_RESIDENCY_PRIORITY residencyPriority=D3D12_RESIDENCY_PRIORITY_NORMAL) noexcept Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
CPOOL_DESC (const D3D12_HEAP_PROPERTIES heapProperties, D3D12_HEAP_FLAGS heapFlags, POOL_FLAGS flags=D3D12MA_RECOMMENDED_POOL_FLAGS, UINT64 blockSize=0, UINT minBlockCount=0, UINT maxBlockCount=UINT_MAX, D3D12_RESIDENCY_PRIORITY residencyPriority=D3D12_RESIDENCY_PRIORITY_NORMAL) noexcept Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::POOL_DESC Public Attributes inherited from D3D12MA::POOL_DESC POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CPOOL_DESC() [1/4]
@@ -264,7 +238,7 @@
-Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
+Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
@@ -320,7 +294,7 @@
-Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
+Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
@@ -330,7 +304,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 8eb5d11..da976da 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -104,7 +91,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index cb1fe74..714062b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,43 +90,36 @@
Inheritance diagram for D3D12MA::CVIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_ALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_ALLOCATION_DESC (const VIRTUAL_ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
CVIRTUAL_ALLOCATION_DESC (UINT64 size, UINT64 alignment, VIRTUAL_ALLOCATION_FLAGS flags=VIRTUAL_ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of a virtual allocation with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_ALLOCATION_DESC() [1/3]
@@ -241,7 +221,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index eeecc96..27af579 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index 78fbb71..e24e9a8 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,40 +90,34 @@
Inheritance diagram for D3D12MA::CVIRTUAL_BLOCK_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_BLOCK_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_BLOCK_DESC (const VIRTUAL_BLOCK_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_BLOCK_DESC structure.
CVIRTUAL_BLOCK_DESC (UINT64 size, VIRTUAL_BLOCK_FLAGS flags=VIRTUAL_BLOCK_FLAG_NONE, const ALLOCATION_CALLBACKS *allocationCallbacks=NULL) noexcept Constructor initializing description of a virtual block with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_BLOCK_DESC() [1/3]
@@ -233,7 +214,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
index 698ab11..69adefa 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
index c65cd1a..242a2ed 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_FLAGS Flags Flags.
UINT64 MaxBytesPerPass Maximum numbers of bytes that can be copied during single pass, while moving allocations to different places.
UINT32 MaxAllocationsPerPass Maximum number of allocations that can be moved during single pass to a different place.
-Detailed Description
+Detailed Description
Parameters for defragmentation.
To be used with functions Allocator::BeginDefragmentation() and Pool::BeginDefragmentation().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -172,7 +156,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
index 4fed39a..f20848d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
index 8a8bf70..87c182e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_MOVE Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_MOVE_OPERATION Operation Operation to be performed on the allocation by DefragmentationContext::EndPass(). Default value is DEFRAGMENTATION_MOVE_OPERATION_COPY. You can modify it.
Allocation * pSrcAllocation Allocation that should be moved.
Allocation * pDstTmpAllocation Temporary allocation pointing to destination memory that will replace pSrcAllocation.
Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Detailed Description
+Detailed Description
Single move of an allocation to be done for defragmentation.
-Member Data Documentation
+Member Data Documentation
◆ Operation
@@ -143,9 +127,9 @@
-Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
-- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make
pSrcAllocation point to this memory.
+Temporary allocation pointing to destination memory that will replace pSrcAllocation.
+Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
+- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make pSrcAllocation point to this memory.
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
index 28aefc6..3e0a1e4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -99,7 +86,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
index 1212826..6e37ac2 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,19 +87,17 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT32 MoveCount Number of elements in the pMoves array.
Number of elements in the pMoves array.
DEFRAGMENTATION_MOVE * pMoves Array of moves to be performed by the user in the current defragmentation pass.
-Detailed Description
+Detailed Description
Parameters for incremental defragmentation steps.
To be used with function DefragmentationContext::BeginPass().
-Member Data Documentation
+Member Data Documentation
◆ MoveCount
@@ -125,7 +110,7 @@
-Number of elements in the pMoves array.
+Number of elements in the pMoves array.
@@ -142,12 +127,12 @@
Array of moves to be performed by the user in the current defragmentation pass.
-Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
+Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
For each element, you should:
-- Create a new resource in the place pointed by
pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
-- Store new resource in
pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
-- Copy data from the
pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
+- Create a new resource in the place pointed by pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
+- Store new resource in pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
+- Copy data from the pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
- Make sure these commands finished executing on the GPU.
Only then you can finish defragmentation pass by calling DefragmentationContext::EndPass(). After this call, the allocation will point to the new place in memory.
@@ -162,7 +147,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
index 6723fa3..be2d910 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
index b7f806d..220d0bd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_STATS Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,24 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 BytesMoved Total number of bytes that have been copied while moving allocations to different places.
UINT64 BytesFreed Total number of bytes that have been released to the system by freeing empty heaps.
UINT32 AllocationsMoved Number of allocations that have been moved to different places.
UINT32 HeapsFreed Number of empty ID3D12Heap objects that have been released to the system.
Number of empty ID3D12Heap objects that have been released to the system.
-Detailed Description
+Detailed Description
Statistics returned for defragmentation process by function DefragmentationContext::GetStats().
-Member Data Documentation
+Member Data Documentation
◆ AllocationsMoved
@@ -178,7 +161,7 @@
-Number of empty ID3D12Heap objects that have been released to the system.
+Number of empty ID3D12Heap objects that have been released to the system.
@@ -188,7 +171,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
index 9167002..13c5446 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
index f4f534a..88fa33d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DetailedStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,35 +87,29 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Basic statistics.
UINT UnusedRangeCount Number of free ranges of memory between allocations.
UINT64 AllocationSizeMin Smallest allocation size. UINT64_MAX if there are 0 allocations.
Smallest allocation size. UINT64_MAX if there are 0 allocations.
UINT64 AllocationSizeMax Largest allocation size. 0 if there are 0 allocations.
UINT64 UnusedRangeSizeMin Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
UINT64 UnusedRangeSizeMax Largest empty range size. 0 if there are 0 empty ranges.
-Detailed Description
+Detailed Description
More detailed statistics than D3D12MA::Statistics.
These are slower to calculate. Use for debugging purposes. See functions: D3D12MA::Allocator::CalculateStatistics(), D3D12MA::Pool::CalculateStatistics().
Averages are not provided because they can be easily calculated as:
UINT64 AllocationSizeAvg = DetailedStats.Statistics.AllocationBytes / detailedStats.Statistics.AllocationCount;
UINT64 UnusedBytes = DetailedStats.Statistics.BlockBytes - DetailedStats.Statistics.AllocationBytes;
UINT64 UnusedRangeSizeAvg = UnusedBytes / DetailedStats.UnusedRangeCount;
- Member Data Documentation
+ Member Data Documentation
◆ AllocationSizeMax
@@ -157,7 +138,7 @@
-Smallest allocation size. UINT64_MAX if there are 0 allocations.
+Smallest allocation size. UINT64_MAX if there are 0 allocations.
@@ -221,7 +202,7 @@
-Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
+Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
@@ -231,7 +212,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
index 2ae0d33..654ade6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
index fcb0f64..d812aff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::POOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,45 +90,36 @@
Inheritance diagram for D3D12MA::POOL_DESC:
-
-
-
+
Public Attributes
POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool.
-Member Data Documentation
+Member Data Documentation
◆ BlockSize
@@ -189,7 +167,7 @@
Heap flags to be used when allocating heaps of this pool.
-It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
+It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
It is recommended to also add D3D12MA_RECOMMENDED_POOL_FLAGS. You can specify additional flags if needed.
@@ -207,7 +185,7 @@
The parameters of memory heap where allocations of this pool should be placed.
-In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
+In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
@@ -224,7 +202,7 @@
Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
-Set to 0 to use default, which is UINT64_MAX, which means no limit.
+Set to 0 to use default, which is UINT64_MAX, which means no limit.
Set to same value as D3D12MA::POOL_DESC::MinBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.
@@ -293,10 +271,10 @@
Residency priority to be set for all allocations made in this pool. Optional.
-Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
-Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
-This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
-There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
+Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
+Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
+This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
+There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
@@ -306,7 +284,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
index a970156..67b61fe 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
index b7e7c30..853c2ff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Statistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,21 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT BlockCount Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
UINT AllocationCount Number of D3D12MA::Allocation objects allocated.
UINT64 BlockBytes Number of bytes allocated in memory blocks.
UINT64 AllocationBytes Total number of bytes occupied by all D3D12MA::Allocation objects.
-Detailed Description
+Detailed Description
Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total.
These are fast to calculate. See functions: D3D12MA::Allocator::GetBudget(), D3D12MA::Pool::GetStatistics().
-Member Data Documentation
+Member Data Documentation
◆ AllocationBytes
@@ -132,7 +115,7 @@
Total number of bytes occupied by all D3D12MA::Allocation objects.
-Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
+Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
@@ -149,7 +132,7 @@
Number of D3D12MA::Allocation objects allocated.
-Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
+Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
@@ -181,7 +164,7 @@
-Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
+Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
-
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
Represents main object of this library initialized for particular ID3D12Device.
+
Represents main object of this library initialized for particular ID3D12Device. More...
#include <D3D12MemAlloc.h>
+
Public Member Functions
const D3D12_FEATURE_DATA_D3D12_OPTIONS & GetD3D12Options () const Returns cached options retrieved from D3D12 device.
BOOL IsUMA () const Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::UMA was found to be true.
Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::UMA was found to be true.
BOOL IsCacheCoherentUMA () const Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMA was found to be true.
Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMA was found to be true.
BOOL IsGPUUploadHeapSupported () const Returns true if GPU Upload Heaps are supported on the current system.
UINT64 GetMemoryCapacity (UINT memorySegmentGroup) const Returns total amount of memory of specific segment group, in bytes.
HRESULT CreateResource (const ALLOCATION_DESC *pAllocDesc, const D3D12_RESOURCE_DESC *pResourceDesc, D3D12_RESOURCE_STATES InitialResourceState, const D3D12_CLEAR_VALUE *pOptimizedClearValue, Allocation **ppAllocation, REFIID riidResource, void **ppvResource) Allocates memory and creates a D3D12 resource (buffer or texture). This is the main allocation function.
HRESULT CreateResource2 (const ALLOCATION_DESC *pAllocDesc, const D3D12_RESOURCE_DESC1 *pResourceDesc, D3D12_RESOURCE_STATES InitialResourceState, const D3D12_CLEAR_VALUE *pOptimizedClearValue, Allocation **ppAllocation, REFIID riidResource, void **ppvResource) Similar to Allocator::CreateResource, but supports new structure D3D12_RESOURCE_DESC1.
Similar to Allocator::CreateResource, but supports new structure D3D12_RESOURCE_DESC1.
HRESULT CreateResource3 (const ALLOCATION_DESC *pAllocDesc, const D3D12_RESOURCE_DESC1 *pResourceDesc, D3D12_BARRIER_LAYOUT InitialLayout, const D3D12_CLEAR_VALUE *pOptimizedClearValue, UINT32 NumCastableFormats, const DXGI_FORMAT *pCastableFormats, Allocation **ppAllocation, REFIID riidResource, void **ppvResource) Similar to Allocator::CreateResource2, but there are initial layout instead of state and castable formats list.
HRESULT AllocateMemory (const ALLOCATION_DESC *pAllocDesc, const D3D12_RESOURCE_ALLOCATION_INFO *pAllocInfo, Allocation **ppAllocation) Allocates memory without creating any resource placed in it.
HRESULT CreateAliasingResource (Allocation *pAllocation, UINT64 AllocationLocalOffset, const D3D12_RESOURCE_DESC *pResourceDesc, D3D12_RESOURCE_STATES InitialResourceState, const D3D12_CLEAR_VALUE *pOptimizedClearValue, REFIID riidResource, void **ppvResource) Creates a new resource in place of an existing allocation. This is useful for memory aliasing.
HRESULT CreateAliasingResource1 (Allocation *pAllocation, UINT64 AllocationLocalOffset, const D3D12_RESOURCE_DESC1 *pResourceDesc, D3D12_RESOURCE_STATES InitialResourceState, const D3D12_CLEAR_VALUE *pOptimizedClearValue, REFIID riidResource, void **ppvResource) Similar to Allocator::CreateAliasingResource, but supports new structure D3D12_RESOURCE_DESC1.
Similar to Allocator::CreateAliasingResource, but supports new structure D3D12_RESOURCE_DESC1.
HRESULT CreateAliasingResource2 (Allocation *pAllocation, UINT64 AllocationLocalOffset, const D3D12_RESOURCE_DESC1 *pResourceDesc, D3D12_BARRIER_LAYOUT InitialLayout, const D3D12_CLEAR_VALUE *pOptimizedClearValue, UINT32 NumCastableFormats, const DXGI_FORMAT *pCastableFormats, REFIID riidResource, void **ppvResource) Similar to Allocator::CreateAliasingResource1, but there are initial layout instead of state and castable formats list.
HRESULT CreatePool (const POOL_DESC *pPoolDesc, Pool **ppPool) Creates custom pool.
void SetCurrentFrameIndex (UINT frameIndex) Sets the index of the current frame.
void GetBudget (Budget *pLocalBudget, Budget *pNonLocalBudget) Retrieves information about current memory usage and budget.
void CalculateStatistics (TotalStatistics *pStats) Retrieves statistics from current state of the allocator.
void BuildStatsString (WCHAR **ppStatsString, BOOL DetailedMap) const Builds and returns statistics as a string in JSON format.
void FreeStatsString (WCHAR *pStatsString) const Frees memory of a string returned from Allocator::BuildStatsString.
void BeginDefragmentation (const DEFRAGMENTATION_DESC *pDesc, DefragmentationContext **ppContext) Begins defragmentation process of the default pools.
Public Member Functions
D3D12_FEATURE_DATA_ARCHITECTURE1::UMA was found to be true. D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMA was found to be true. D3D12_RESOURCE_DESC1. D3D12_RESOURCE_DESC1. Represents main object of this library initialized for particular ID3D12Device.
Fill structure D3D12MA::ALLOCATOR_DESC and call function CreateAllocator() to create it. Call method Release() to destroy it.
It is recommended to create just one object of this type per ID3D12Device object, right after Direct3D 12 is initialized and keep it alive until before Direct3D device is destroyed.
Represents main object of this library initialized for particular ID3D12Device.
+Fill structure D3D12MA::ALLOCATOR_DESC and call function CreateAllocator() to create it. Call method Release() to destroy it.
+It is recommended to create just one object of this type per ID3D12Device object, right after Direct3D 12 is initialized and keep it alive until before Direct3D device is destroyed.
+Allocates memory without creating any resource placed in it.
-This function is similar to ID3D12Device::CreateHeap, but it may really assign part of a larger, existing heap to the allocation.
pAllocDesc->heapFlags should contain one of these values, depending on type of resources you are going to create in this memory: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if you validate that ResourceHeapTier = 2 - then heapFlags may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0. Additional flags in heapFlags are allowed as well.
pAllocInfo->SizeInBytes must be multiply of 64KB. pAllocInfo->Alignment must be one of the legal values as described in documentation of D3D12_HEAP_DESC.
This function is similar to ID3D12Device::CreateHeap, but it may really assign part of a larger, existing heap to the allocation.
+pAllocDesc->heapFlags should contain one of these values, depending on type of resources you are going to create in this memory: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if you validate that ResourceHeapTier = 2 - then heapFlags may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0. Additional flags in heapFlags are allowed as well.
+pAllocInfo->SizeInBytes must be multiply of 64KB. pAllocInfo->Alignment must be one of the legal values as described in documentation of D3D12_HEAP_DESC.
If you use D3D12MA::ALLOCATION_FLAG_COMMITTED you will get a separate memory block - a heap that always has offset 0.
@@ -257,7 +225,7 @@Parameters
[out] ppStatsString Must be freed using Allocator::FreeStatsString. DetailedMap TRUE to include full list of allocations (can make the string quite long), FALSE to only return statistics. DetailedMap TRUE to include full list of allocations (can make the string quite long), FALSE to only return statistics.
@@ -332,17 +300,17 @@ Parameters
- pAllocation Existing allocation indicating the memory where the new resource should be created. It can be created using D3D12MA::Allocator::CreateResource and already have a resource bound to it, or can be a raw memory allocated with D3D12MA::Allocator::AllocateMemory. It must not be created as committed so that ID3D12Heap is available and not implicit. AllocationLocalOffset Additional offset in bytes to be applied when allocating the resource. Local from the start of pAllocation, not the beginning of the whole ID3D12Heap! If the new resource should start from the beginning of the pAllocation it should be 0. pAllocation Existing allocation indicating the memory where the new resource should be created. It can be created using D3D12MA::Allocator::CreateResource and already have a resource bound to it, or can be a raw memory allocated with D3D12MA::Allocator::AllocateMemory. It must not be created as committed so that ID3D12Heap is available and not implicit. AllocationLocalOffset Additional offset in bytes to be applied when allocating the resource. Local from the start of pAllocation, not the beginning of the whole ID3D12Heap! If the new resource should start from the beginning of the pAllocation it should be 0. pResourceDesc Description of the new resource to be created. InitialResourceState pOptimizedClearValue riidResource [out] ppvResource Returns pointer to the new resource. The resource is not bound with pAllocation. This pointer must not be null - you must get the resource pointer and Release it when no longer needed. [out] ppvResource Returns pointer to the new resource. The resource is not bound with pAllocation. This pointer must not be null - you must get the resource pointer and Release it when no longer needed.
-Memory requirements of the new resource are checked for validation. If its size exceeds the end of pAllocation or required alignment is not fulfilled considering pAllocation->GetOffset() + AllocationLocalOffset, the function returns E_INVALIDARG.
+Memory requirements of the new resource are checked for validation. If its size exceeds the end of pAllocation or required alignment is not fulfilled considering pAllocation->GetOffset() + AllocationLocalOffset, the function returns E_INVALIDARG.
@@ -390,9 +358,9 @@
-Similar to Allocator::CreateAliasingResource, but supports new structure D3D12_RESOURCE_DESC1.
-It internally uses ID3D12Device8::CreatePlacedResource1.
-To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
+Similar to Allocator::CreateAliasingResource, but supports new structure D3D12_RESOURCE_DESC1.
+It internally uses ID3D12Device8::CreatePlacedResource1.
+To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
@@ -451,8 +419,8 @@
Similar to Allocator::CreateAliasingResource1, but there are initial layout instead of state and castable formats list.
-It internally uses ID3D12Device10::CreatePlacedResource2.
-To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
+It internally uses ID3D12Device10::CreatePlacedResource2.
+To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
@@ -524,9 +492,9 @@
Allocates memory and creates a D3D12 resource (buffer or texture). This is the main allocation function.
-The function is similar to ID3D12Device::CreateCommittedResource, but it may really call ID3D12Device::CreatePlacedResource to assign part of a larger, existing memory heap to the new resource, which is the main purpose of this whole library.
-If ppvResource is null, you receive only ppAllocation object from this function. It holds pointer to ID3D12Resource that can be queried using function D3D12MA::Allocation::GetResource(). Reference count of the resource object is 1. It is automatically destroyed when you destroy the allocation object.
-If ppvResource is not null, you receive pointer to the resource next to allocation object. Reference count of the resource object is then increased by calling QueryInterface, so you need to manually Release it along with the allocation.
+The function is similar to ID3D12Device::CreateCommittedResource, but it may really call ID3D12Device::CreatePlacedResource to assign part of a larger, existing memory heap to the new resource, which is the main purpose of this whole library.
+If ppvResource is null, you receive only ppAllocation object from this function. It holds pointer to ID3D12Resource that can be queried using function D3D12MA::Allocation::GetResource(). Reference count of the resource object is 1. It is automatically destroyed when you destroy the allocation object.
+If ppvResource is not null, you receive pointer to the resource next to allocation object. Reference count of the resource object is then increased by calling QueryInterface, so you need to manually Release it along with the allocation.
- Parameters
-
@@ -587,9 +555,9 @@
-Similar to Allocator::CreateResource, but supports new structure D3D12_RESOURCE_DESC1.
-It internally uses ID3D12Device8::CreateCommittedResource2 or ID3D12Device8::CreatePlacedResource1.
-To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
+Similar to Allocator::CreateResource, but supports new structure D3D12_RESOURCE_DESC1.
+It internally uses ID3D12Device8::CreateCommittedResource2 or ID3D12Device8::CreatePlacedResource1.
+To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
@@ -648,8 +616,8 @@
Similar to Allocator::CreateResource2, but there are initial layout instead of state and castable formats list.
-It internally uses ID3D12Device10::CreateCommittedResource3 or ID3D12Device10::CreatePlacedResource2.
-To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
+It internally uses ID3D12Device10::CreateCommittedResource3 or ID3D12Device10::CreatePlacedResource2.
+To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
@@ -700,14 +668,14 @@ IsUMA() == FALSE (discrete graphics card):
-pLocalBudget returns the budget of the video memory.pNonLocalBudget returns the budget of the system memory available for D3D12 resources.- When IsUMA() == FALSE (discrete graphics card):
+- pLocalBudget returns the budget of the video memory.
+- pNonLocalBudget returns the budget of the system memory available for D3D12 resources.
-- When IsUMA()
== TRUE (integrated graphics chip):
-pLocalBudget returns the budget of the shared memory available for all D3D12 resources. All memory is considered "local".pNonLocalBudget is not applicable and returns zeros.- When IsUMA() == TRUE (integrated graphics chip):
+- pLocalBudget returns the budget of the shared memory available for all D3D12 resources. All memory is considered "local".
+- pNonLocalBudget is not applicable and returns zeros.
@@ -753,20 +721,20 @@ - Parameters
-
- memorySegmentGroup use DXGI_MEMORY_SEGMENT_GROUP_LOCAL or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL. memorySegmentGroup use DXGI_MEMORY_SEGMENT_GROUP_LOCAL or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL.
-This information is taken from DXGI_ADAPTER_DESC. It is not recommended to use this number. You should preferably call GetBudget() and limit memory usage to D3D12MA::Budget::BudgetBytes instead.
+This information is taken from DXGI_ADAPTER_DESC. It is not recommended to use this number. You should preferably call GetBudget() and limit memory usage to D3D12MA::Budget::BudgetBytes instead.
-- When IsUMA()
== FALSE (discrete graphics card):
-GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the video memory.GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) returns the size of the system memory available for D3D12 resources.- When IsUMA() == FALSE (discrete graphics card):
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the video memory.
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) returns the size of the system memory available for D3D12 resources.
-- When IsUMA()
== TRUE (integrated graphics chip):
-GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the shared memory available for all D3D12 resources. All memory is considered "local".GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) is not applicable and returns 0. - When IsUMA() == TRUE (integrated graphics chip):
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the shared memory available for all D3D12 resources. All memory is considered "local".
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) is not applicable and returns 0.
@@ -788,7 +756,7 @@
-Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMA was found to be true.
+Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMA was found to be true.
For more information about how to use it, see articles in Microsoft Docs articles:
- "UMA Optimizations: CPU Accessible Textures and Standard Swizzle"
@@ -814,8 +782,8 @@
Returns true if GPU Upload Heaps are supported on the current system.
-When true, you can use D3D12_HEAP_TYPE_GPU_UPLOAD.
-This flag is fetched from D3D12_FEATURE_D3D12_OPTIONS16::GPUUploadHeapSupported.
+When true, you can use D3D12_HEAP_TYPE_GPU_UPLOAD.
+This flag is fetched from D3D12_FEATURE_D3D12_OPTIONS16::GPUUploadHeapSupported.
@@ -834,7 +802,7 @@
-Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::UMA was found to be true.
+Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::UMA was found to be true.
For more information about how to use it, see articles in Microsoft Docs articles:
- "UMA Optimizations: CPU Accessible Textures and Standard Swizzle"
@@ -870,7 +838,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html
index 4049a20..6cfb1dd 100644
--- a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html
index 405cb9f..7ab0038 100644
--- a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html
+++ b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DefragmentationContext Class Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,22 +93,19 @@
-
+
Public Member Functions
HRESULT BeginPass (DEFRAGMENTATION_PASS_MOVE_INFO *pPassInfo) Starts single defragmentation pass.
HRESULT EndPass (DEFRAGMENTATION_PASS_MOVE_INFO *pPassInfo) Ends single defragmentation pass.
void GetStats (DEFRAGMENTATION_STATS *pStats) Returns statistics of the defragmentation performed so far.
-Detailed Description
+Detailed Description
Represents defragmentation process in progress.
You can create this object using Allocator::BeginDefragmentation (for default pools) or Pool::BeginDefragmentation (for a custom pool).
-Member Function Documentation
+Member Function Documentation
◆ BeginPass()
@@ -145,8 +129,8 @@ - Returns
-S_OK if no more moves are possible. Then you can omit call to DefragmentationContext::EndPass() and simply end whole defragmentation.S_FALSE if there are pending moves returned in pPassInfo. You need to perform them, call DefragmentationContext::EndPass(), and then preferably try another pass with DefragmentationContext::BeginPass(). - S_OK if no more moves are possible. Then you can omit call to DefragmentationContext::EndPass() and simply end whole defragmentation.
+- S_FALSE if there are pending moves returned in pPassInfo. You need to perform them, call DefragmentationContext::EndPass(), and then preferably try another pass with DefragmentationContext::BeginPass().
- Returns
- Returns
S_OK if no more moves are possible or S_FALSE if more defragmentations are possible.
-Ends incremental defragmentation pass and commits all defragmentation moves from pPassInfo. After this call:
+- Returns
- Returns S_OK if no more moves are possible or S_FALSE if more defragmentations are possible.
+Ends incremental defragmentation pass and commits all defragmentation moves from pPassInfo. After this call:
-- Allocation at
pPassInfo[i].pSrcAllocation that had pPassInfo[i].Operation == DEFRAGMENTATION_MOVE_OPERATION_COPY (which is the default) will be pointing to the new destination place.
-- Allocation at
pPassInfo[i].pSrcAllocation that had pPassInfo[i].operation == DEFRAGMENTATION_MOVE_OPERATION_DESTROY will be released.
+- Allocation at pPassInfo[i].pSrcAllocation that had pPassInfo[i].Operation == DEFRAGMENTATION_MOVE_OPERATION_COPY (which is the default) will be pointing to the new destination place.
+- Allocation at pPassInfo[i].pSrcAllocation that had pPassInfo[i].operation == DEFRAGMENTATION_MOVE_OPERATION_DESTROY will be released.
If no more moves are possible you can end whole defragmentation.
@@ -209,7 +193,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_pool-members.html b/docs/html/class_d3_d12_m_a_1_1_pool-members.html
index e500fb5..9acf601 100644
--- a/docs/html/class_d3_d12_m_a_1_1_pool-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_pool-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -104,7 +91,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_pool.html b/docs/html/class_d3_d12_m_a_1_1_pool.html
index 7aabe1c..07742d9 100644
--- a/docs/html/class_d3_d12_m_a_1_1_pool.html
+++ b/docs/html/class_d3_d12_m_a_1_1_pool.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Pool Class Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,32 +93,26 @@
-
+
Public Member Functions
POOL_DESC GetDesc () const Returns copy of parameters of the pool.
void GetStatistics (Statistics *pStats) Retrieves basic statistics of the custom pool that are fast to calculate.
void CalculateStatistics (DetailedStatistics *pStats) Retrieves detailed statistics of the custom pool that are slower to calculate.
void SetName (LPCWSTR Name) Associates a name with the pool. This name is for use in debug diagnostics and tools.
LPCWSTR GetName () const Returns the name associated with the pool object.
HRESULT BeginDefragmentation (const DEFRAGMENTATION_DESC *pDesc, DefragmentationContext **ppContext) Begins defragmentation process of the current pool.
-Detailed Description
+Detailed Description
Custom memory pool.
Represents a separate set of heaps (memory blocks) that can be used to create D3D12MA::Allocation-s and resources in it. Usually there is no need to create custom pools - creating resources in default pool is sufficient.
To create custom pool, fill D3D12MA::POOL_DESC and call D3D12MA::Allocator::CreatePool.
-Member Function Documentation
+Member Function Documentation
◆ BeginDefragmentation()
@@ -160,8 +141,8 @@ - Returns
-S_OK if defragmentation can begin.E_NOINTERFACE if defragmentation is not supported.- S_OK if defragmentation can begin.
+- E_NOINTERFACE if defragmentation is not supported.
For more information about defragmentation, see documentation chapter: Defragmentation.
@@ -276,7 +257,7 @@ Name can be NULL.
@@ -286,7 +267,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html b/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html
index 190326b..1e40ead 100644
--- a/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -109,7 +96,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_virtual_block.html b/docs/html/class_d3_d12_m_a_1_1_virtual_block.html
index 5f6a3f2..0cb9114 100644
--- a/docs/html/class_d3_d12_m_a_1_1_virtual_block.html
+++ b/docs/html/class_d3_d12_m_a_1_1_virtual_block.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualBlock Class Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,45 +93,35 @@
-
+
Public Member Functions
BOOL IsEmpty () const Returns true if the block is empty - contains 0 allocations.
void GetAllocationInfo (VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) const Returns information about an allocation - its offset, size and custom pointer.
HRESULT Allocate (const VIRTUAL_ALLOCATION_DESC *pDesc, VirtualAllocation *pAllocation, UINT64 *pOffset) Creates new allocation.
void FreeAllocation (VirtualAllocation allocation) Frees the allocation.
void Clear () Frees all the allocations.
void SetAllocationPrivateData (VirtualAllocation allocation, void *pPrivateData) Changes custom pointer for an allocation to a new value.
void GetStatistics (Statistics *pStats) const Retrieves basic statistics of the virtual block that are fast to calculate.
void CalculateStatistics (DetailedStatistics *pStats) const Retrieves detailed statistics of the virtual block that are slower to calculate.
void BuildStatsString (WCHAR **ppStatsString) const Builds and returns statistics as a string in JSON format, including the list of allocations with their parameters.
void FreeStatsString (WCHAR *pStatsString) const Frees memory of a string returned from VirtualBlock::BuildStatsString.
-Detailed Description
+Detailed Description
Represents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory.
This class allows to use the core algorithm of the library custom allocations e.g. CPU memory or sub-allocation regions inside a single GPU buffer.
-To create this object, fill in D3D12MA::VIRTUAL_BLOCK_DESC and call CreateVirtualBlock(). To destroy it, call its method VirtualBlock::Release(). You need to free all the allocations within this block or call Clear() before destroying it.
+To create this object, fill in D3D12MA::VIRTUAL_BLOCK_DESC and call CreateVirtualBlock(). To destroy it, call its method VirtualBlock::Release(). You need to free all the allocations within this block or call Clear() before destroying it.
This object is not thread-safe - should not be used from multiple threads simultaneously, must be synchronized externally.
-Member Function Documentation
+Member Function Documentation
◆ Allocate()
@@ -178,8 +155,8 @@ - Returns
S_OK if allocation succeeded, E_OUTOFMEMORY if it failed.If the allocation failed, pAllocation->AllocHandle is set to 0 and pOffset, if not null, is set to UINT64_MAX.
+- Returns
- S_OK if allocation succeeded, E_OUTOFMEMORY if it failed.
+If the allocation failed, pAllocation->AllocHandle is set to 0 and pOffset, if not null, is set to UINT64_MAX.
@@ -268,7 +245,7 @@
Frees the allocation.
-Calling this function with allocation.AllocHandle == 0 is correct and does nothing.
+Calling this function with allocation.AllocHandle == 0 is correct and does nothing.
@@ -387,7 +364,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/classes.html b/docs/html/classes.html
index 3b8ddf2..e85eb86 100644
--- a/docs/html/classes.html
+++ b/docs/html/classes.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Index
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/configuration.html b/docs/html/configuration.html
index 8eeaa50..65d7bdd 100644
--- a/docs/html/configuration.html
+++ b/docs/html/configuration.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Configuration
-
-
@@ -33,33 +31,22 @@
-
+
-
- Configuration
+ Configuration
-Please check file D3D12MemAlloc.cpp lines between "Configuration Begin" and "Configuration End" to find macros that you can define to change the behavior of the library, primarily for debugging purposes.
-
+Please check file D3D12MemAlloc.cpp lines between "Configuration Begin" and "Configuration End" to find macros that you can define to change the behavior of the library, primarily for debugging purposes.
+
Custom CPU memory allocator
-If you use custom allocator for CPU memory rather than default C++ operator new and delete or malloc and free functions, you can make this library using your allocator as well by filling structure D3D12MA::ALLOCATION_CALLBACKS and passing it as optional member D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks. Functions pointed there will be used by the library to make any CPU-side allocations. Example:
+If you use custom allocator for CPU memory rather than default C++ operator new and delete or malloc and free functions, you can make this library using your allocator as well by filling structure D3D12MA::ALLOCATION_CALLBACKS and passing it as optional member D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks. Functions pointed there will be used by the library to make any CPU-side allocations. Example:
#include <malloc.h>
void* CustomAllocate(size_t Size, size_t Alignment, void* pPrivateData)
@@ -133,11 +120,11 @@
ALLOCATOR_FLAGS FlagsFlags for the entire allocator.Definition D3D12MemAlloc.h:1126
-
+
Debug margins
-
By default, allocations are laid out in memory blocks next to each other if possible (considering required alignment returned by ID3D12Device::GetResourceAllocationInfo).
+By default, allocations are laid out in memory blocks next to each other if possible (considering required alignment returned by ID3D12Device::GetResourceAllocationInfo).
-Define macro D3D12MA_DEBUG_MARGIN to some non-zero value (e.g. 16) inside "D3D12MemAlloc.cpp" to enforce specified number of bytes as a margin after every allocation.
+Define macro D3D12MA_DEBUG_MARGIN to some non-zero value (e.g. 16) inside "D3D12MemAlloc.cpp" to enforce specified number of bytes as a margin after every allocation.
If your bug goes away after enabling margins, it means it may be caused by memory being overwritten outside of allocation boundaries. It is not 100% certain though. Change in application behavior may also be caused by different order and distribution of allocations across memory blocks after margins are applied.
Margins work with all memory heap types.
@@ -149,7 +136,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/custom_pools.html b/docs/html/custom_pools.html
index 9112b38..0bfd570 100644
--- a/docs/html/custom_pools.html
+++ b/docs/html/custom_pools.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Custom memory pools
-
-
@@ -33,33 +31,22 @@
-
+
-
- Custom memory pools
+ Custom memory pools
-A "pool" is a collection of memory blocks that share certain properties. Allocator creates 3 default pools: for D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK. A default pool automatically grows in size. Size of allocated blocks is also variable and managed automatically. Typical allocations are created in these pools. You can also create custom pools.
-
+A "pool" is a collection of memory blocks that share certain properties. Allocator creates 3 default pools: for D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK. A default pool automatically grows in size. Size of allocated blocks is also variable and managed automatically. Typical allocations are created in these pools. You can also create custom pools.
+
Usage
To create a custom pool, fill in structure D3D12MA::POOL_DESC and call function D3D12MA::Allocator::CreatePool to obtain object D3D12MA::Pool. Example:
All allocations must be released before releasing the pool. The pool must be released before relasing the allocator.
alloc->Release();
pool->Release();
-
+
Features and benefits
While it is recommended to use default pools whenever possible for simplicity and to give the allocator more opportunities for internal optimizations, custom pools may be useful in following cases:
- To keep some resources separate from others in memory.
- To keep track of memory usage of just a specific group of resources. Statistics can be queried using D3D12MA::Pool::CalculateStatistics.
-- To use specific size of a memory block (
ID3D12Heap). To set it, use member D3D12MA::POOL_DESC::BlockSize. When set to 0, the library uses automatically determined, variable block sizes.
+- To use specific size of a memory block (ID3D12Heap). To set it, use member D3D12MA::POOL_DESC::BlockSize. When set to 0, the library uses automatically determined, variable block sizes.
- To reserve some minimum amount of memory allocated. To use it, set member D3D12MA::POOL_DESC::MinBlockCount.
- To limit maximum amount of memory allocated. To use it, set member D3D12MA::POOL_DESC::MaxBlockCount.
-- To use extended parameters of the D3D12 memory allocation. While resources created from default pools can only specify
D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK, a custom pool may use non-standard D3D12_HEAP_PROPERTIES (member D3D12MA::POOL_DESC::HeapProperties) and D3D12_HEAP_FLAGS (D3D12MA::POOL_DESC::HeapFlags), which is useful e.g. for cross-adapter sharing or UMA (see also D3D12MA::Allocator::IsUMA).
+- To use extended parameters of the D3D12 memory allocation. While resources created from default pools can only specify D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK, a custom pool may use non-standard D3D12_HEAP_PROPERTIES (member D3D12MA::POOL_DESC::HeapProperties) and D3D12_HEAP_FLAGS (D3D12MA::POOL_DESC::HeapFlags), which is useful e.g. for cross-adapter sharing or UMA (see also D3D12MA::Allocator::IsUMA).
New versions of this library support creating committed allocations in custom pools. It is supported only when D3D12MA::POOL_DESC::BlockSize = 0. To use this feature, set D3D12MA::ALLOCATION_DESC::CustomPool to the pointer to your custom pool and D3D12MA::ALLOCATION_DESC::Flags to D3D12MA::ALLOCATION_FLAG_COMMITTED. Example:
ALLOCATION_DESC allocDesc = {};
@@ -136,12 +123,12 @@
ID3D12Resource* res;
hr = allocator->CreateResource(&allocDesc, &resDesc,
D3D12_RESOURCE_STATE_GENERIC_READ, NULL, &alloc, IID_PPV_ARGS(&res));
-
This feature may seem unnecessary, but creating committed allocations from custom pools may be useful in some cases, e.g. to have separate memory usage statistics for some group of resources or to use extended allocation parameters, like custom D3D12_HEAP_PROPERTIES, which are available only in custom pools.
+This feature may seem unnecessary, but creating committed allocations from custom pools may be useful in some cases, e.g. to have separate memory usage statistics for some group of resources or to use extended allocation parameters, like custom D3D12_HEAP_PROPERTIES, which are available only in custom pools.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/defragmentation.html b/docs/html/defragmentation.html
index d68a400..b82dbde 100644
--- a/docs/html/defragmentation.html
+++ b/docs/html/defragmentation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Defragmentation
-
-
@@ -33,33 +31,22 @@
-
+
-
- Defragmentation
+ Defragmentation
Interleaved allocations and deallocations of many objects of varying size can cause fragmentation over time, which can lead to a situation where the library is unable to find a continuous range of free memory for a new allocation despite there is enough free space, just scattered across many small free ranges between existing allocations.
-To mitigate this problem, you can use defragmentation feature. It doesn't happen automatically though and needs your cooperation, because D3D12MA is a low level library that only allocates memory. It cannot recreate buffers and textures in a new place as it doesn't remember the contents of D3D12_RESOURCE_DESC structure. It cannot copy their contents as it doesn't record any commands to a command list.
+To mitigate this problem, you can use defragmentation feature. It doesn't happen automatically though and needs your cooperation, because D3D12MA is a low level library that only allocates memory. It cannot recreate buffers and textures in a new place as it doesn't remember the contents of D3D12_RESOURCE_DESC structure. It cannot copy their contents as it doesn't record any commands to a command list.
Example:
D3D12MA::DEFRAGMENTATION_DESC defragDesc = {};
defragDesc.Flags = D3D12MA::DEFRAGMENTATION_FLAG_ALGORITHM_FAST;
@@ -162,11 +149,11 @@
Parameters for incremental defragmentation steps.Definition D3D12MemAlloc.h:768
DEFRAGMENTATION_MOVE * pMovesArray of moves to be performed by the user in the current defragmentation pass.Definition D3D12MemAlloc.h:792
UINT32 MoveCountNumber of elements in the pMoves array.Definition D3D12MemAlloc.h:770
-Although functions like D3D12MA::Allocator::CreateResource() create an allocation and a buffer/texture at once, these are just a shortcut for allocating memory and creating a placed resource. Defragmentation works on memory allocations only. You must handle the rest manually. Defragmentation is an iterative process that should repreat "passes" as long as related functions return S_FALSE not S_OK. In each pass:
+Although functions like D3D12MA::Allocator::CreateResource() create an allocation and a buffer/texture at once, these are just a shortcut for allocating memory and creating a placed resource. Defragmentation works on memory allocations only. You must handle the rest manually. Defragmentation is an iterative process that should repreat "passes" as long as related functions return S_FALSE not S_OK. In each pass:
- D3D12MA::DefragmentationContext::BeginPass() function call:
- Calculates and returns the list of allocations to be moved in this pass. Note this can be a time-consuming process.
-- Reserves destination memory for them by creating temporary destination allocations that you can query for their
ID3D12Heap + offset using methods like D3D12MA::Allocation::GetHeap().
+- Reserves destination memory for them by creating temporary destination allocations that you can query for their ID3D12Heap + offset using methods like D3D12MA::Allocation::GetHeap().
- Inside the pass, you should:
@@ -179,40 +166,40 @@
- D3D12MA::DefragmentationContext::EndPass() function call:
- Frees the source memory reserved for the allocations that are moved.
- Modifies source D3D12MA::Allocation objects that are moved to point to the destination reserved memory and destination resource, while source resource is released.
-- Frees
ID3D12Heap blocks that became empty.
+- Frees ID3D12Heap blocks that became empty.
-Defragmentation algorithm tries to move all suitable allocations. You can, however, refuse to move some of them inside a defragmentation pass, by setting pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This is not recommended and may result in suboptimal packing of the allocations after defragmentation. If you cannot ensure any allocation can be moved, it is better to keep movable allocations separate in a custom pool.
+Defragmentation algorithm tries to move all suitable allocations. You can, however, refuse to move some of them inside a defragmentation pass, by setting pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This is not recommended and may result in suboptimal packing of the allocations after defragmentation. If you cannot ensure any allocation can be moved, it is better to keep movable allocations separate in a custom pool.
Inside a pass, for each allocation that should be moved:
-- You should copy its data from the source to the destination place by calling e.g.
CopyResource().
+- You should copy its data from the source to the destination place by calling e.g. CopyResource().
- You need to make sure these commands finished executing before the source buffers/textures are released by D3D12MA::DefragmentationContext::EndPass().
- If a resource doesn't contain any meaningful data, e.g. it is a transient render-target texture to be cleared, filled, and used temporarily in each rendering frame, you can just recreate this texture without copying its data.
-- If the resource is in
D3D12_HEAP_TYPE_READBACK memory, you can copy its data on the CPU using memcpy().
-- If you cannot move the allocation, you can set
pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This will cancel the move.
+- If the resource is in D3D12_HEAP_TYPE_READBACK memory, you can copy its data on the CPU using memcpy().
+- If you cannot move the allocation, you can set pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This will cancel the move.
- D3D12MA::DefragmentationContext::EndPass() will then free the destination memory not the source memory of the allocation, leaving it unchanged.
-- If you decide the allocation is unimportant and can be destroyed instead of moved (e.g. it wasn't used for long time), you can set
pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY.
+- If you decide the allocation is unimportant and can be destroyed instead of moved (e.g. it wasn't used for long time), you can set pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY.
- D3D12MA::DefragmentationContext::EndPass() will then free both source and destination memory, and will destroy the source D3D12MA::Allocation object.
You can defragment a specific custom pool by calling D3D12MA::Pool::BeginDefragmentation or all the default pools by calling D3D12MA::Allocator::BeginDefragmentation (like in the example above).
-Defragmentation is always performed in each pool separately. Allocations are never moved between different heap types. The size of the destination memory reserved for a moved allocation is the same as the original one. Alignment of an allocation as it was determined using GetResourceAllocationInfo() is also respected after defragmentation. Buffers/textures should be recreated with the same D3D12_RESOURCE_DESC parameters as the original ones.
+Defragmentation is always performed in each pool separately. Allocations are never moved between different heap types. The size of the destination memory reserved for a moved allocation is the same as the original one. Alignment of an allocation as it was determined using GetResourceAllocationInfo() is also respected after defragmentation. Buffers/textures should be recreated with the same D3D12_RESOURCE_DESC parameters as the original ones.
You can perform the defragmentation incrementally to limit the number of allocations and bytes to be moved in each pass, e.g. to call it in sync with render frames and not to experience too big hitches. See members: D3D12MA::DEFRAGMENTATION_DESC::MaxBytesPerPass, D3D12MA::DEFRAGMENTATION_DESC::MaxAllocationsPerPass.
Thread safety: It is safe to perform the defragmentation asynchronously to render frames and other Direct3D 12 and D3D12MA usage, possibly from multiple threads, with the exception that allocations returned in D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO::pMoves shouldn't be released until the defragmentation pass is ended. During the call to D3D12MA::DefragmentationContext::BeginPass(), any operations on the memory pool affected by the defragmentation are blocked by a mutex.
-What it means in practice is that you shouldn't free any allocations from the defragmented pool since the moment a call to BeginPass begins. Otherwise, a thread performing the allocation->Release() would block for the time BeginPass executes and then free the allocation when it finishes, while the allocation could have ended up on the list of allocations to move. A solution to freeing allocations during defragmentation is to find such allocation on the list pass.pMoves[i] and set its operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY instead of calling allocation->Release(), or simply deferring the release to the time after defragmentation finished.
+What it means in practice is that you shouldn't free any allocations from the defragmented pool since the moment a call to BeginPass begins. Otherwise, a thread performing the allocation->Release() would block for the time BeginPass executes and then free the allocation when it finishes, while the allocation could have ended up on the list of allocations to move. A solution to freeing allocations during defragmentation is to find such allocation on the list pass.pMoves[i] and set its operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY instead of calling allocation->Release(), or simply deferring the release to the time after defragmentation finished.
Mapping is out of scope of this library and so it is not preserved after an allocation is moved during defragmentation. You need to map the new resource yourself if needed.
- Note
- Defragmentation is not supported in custom pools created with D3D12MA::POOL_FLAG_ALGORITHM_LINEAR.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html b/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
index fa88354..6e6d46e 100644
--- a/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
+++ b/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: C:/Code/D3D12MemoryAllocator/REPO/include Directory Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -92,15 +79,14 @@
-
+
Files
D3D12MemAlloc.h D3D12MemAlloc.h
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/doxygen.css b/docs/html/doxygen.css
index 4947e24..5d2eecd 100644
--- a/docs/html/doxygen.css
+++ b/docs/html/doxygen.css
@@ -1,11 +1,12 @@
-/* The standard CSS for doxygen 1.13.2*/
+/* The standard CSS for doxygen 1.14.0*/
html {
/* page base colors */
--page-background-color: white;
--page-foreground-color: black;
--page-link-color: #3D578C;
---page-visited-link-color: #4665A2;
+--page-visited-link-color: #3D578C;
+--page-external-link-color: #334975;
/* index */
--index-odd-item-bg-color: #F8F9FC;
@@ -16,46 +17,50 @@ html {
/* header */
--header-background-color: #F9FAFC;
--header-separator-color: #C4CFE5;
---header-gradient-image: url('nav_h.png');
---group-header-separator-color: #879ECB;
+--group-header-separator-color: #D9E0EE;
--group-header-color: #354C7B;
--inherit-header-color: gray;
--footer-foreground-color: #2A3D61;
---footer-logo-width: 104px;
+--footer-logo-width: 75px;
--citation-label-color: #334975;
--glow-color: cyan;
--title-background-color: white;
---title-separator-color: #5373B4;
+--title-separator-color: #C4CFE5;
--directory-separator-color: #9CAFD4;
--separator-color: #4A6AAA;
--blockquote-background-color: #F7F8FB;
--blockquote-border-color: #9CAFD4;
---scrollbar-thumb-color: #9CAFD4;
+--scrollbar-thumb-color: #C4CFE5;
--scrollbar-background-color: #F9FAFC;
--icon-background-color: #728DC1;
--icon-foreground-color: white;
+/*
--icon-doc-image: url('doc.svg');
--icon-folder-open-image: url('folderopen.svg');
---icon-folder-closed-image: url('folderclosed.svg');
+--icon-folder-closed-image: url('folderclosed.svg');*/
+--icon-folder-open-fill-color: #C4CFE5;
+--icon-folder-fill-color: #D8DFEE;
+--icon-folder-border-color: #4665A2;
+--icon-doc-fill-color: #D8DFEE;
+--icon-doc-border-color: #4665A2;
/* brief member declaration list */
--memdecl-background-color: #F9FAFC;
--memdecl-separator-color: #DEE4F0;
--memdecl-foreground-color: #555;
--memdecl-template-color: #4665A2;
+--memdecl-border-color: #D5DDEC;
/* detailed member list */
--memdef-border-color: #A8B8D9;
--memdef-title-background-color: #E2E8F2;
---memdef-title-gradient-image: url('nav_f.png');
---memdef-proto-background-color: #DFE5F1;
+--memdef-proto-background-color: #EEF1F7;
--memdef-proto-text-color: #253555;
---memdef-proto-text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
--memdef-doc-background-color: white;
--memdef-param-name-color: #602020;
--memdef-template-color: #4665A2;
@@ -74,29 +79,34 @@ html {
/** navigation bar/tree/menu */
--nav-background-color: #F9FAFC;
--nav-foreground-color: #364D7C;
---nav-gradient-image: url('tab_b.png');
---nav-gradient-hover-image: url('tab_h.png');
---nav-gradient-active-image: url('tab_a.png');
---nav-gradient-active-image-parent: url("../tab_a.png");
---nav-separator-image: url('tab_s.png');
---nav-breadcrumb-image: url('bc_s.png');
---nav-breadcrumb-border-color: #C2CDE4;
---nav-splitbar-image: url('splitbar.png');
+--nav-border-color: #C4CFE5;
+--nav-breadcrumb-separator-color: #C4CFE5;
+--nav-breadcrumb-active-bg: #EEF1F7;
+--nav-breadcrumb-color: #354C7B;
+--nav-breadcrumb-border-color: #E1E7F2;
+--nav-splitbar-bg-color: #DCE2EF;
+--nav-splitbar-handle-color: #9CAFD4;
--nav-font-size-level1: 13px;
--nav-font-size-level2: 10px;
--nav-font-size-level3: 9px;
--nav-text-normal-color: #283A5D;
--nav-text-hover-color: white;
--nav-text-active-color: white;
---nav-text-normal-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
---nav-text-hover-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
---nav-text-active-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
--nav-menu-button-color: #364D7C;
--nav-menu-background-color: white;
--nav-menu-foreground-color: #555555;
+--nav-menu-active-bg: #DCE2EF;
+--nav-menu-active-color: #9CAFD4;
--nav-menu-toggle-color: rgba(255, 255, 255, 0.5);
---nav-arrow-color: #9CAFD4;
---nav-arrow-selected-color: #9CAFD4;
+--nav-arrow-color: #B6C4DF;
+--nav-arrow-selected-color: #90A5CE;
+
+/* sync icon */
+--sync-icon-border-color: #C4CFE5;
+--sync-icon-background-color: #F9FAFC;
+--sync-icon-selected-background-color: #EEF1F7;
+--sync-icon-color: #C4CFE5;
+--sync-icon-selected-color: #6884BD;
/* table of contents */
--toc-background-color: #F4F6FA;
@@ -107,18 +117,20 @@ html {
/** search field */
--search-background-color: white;
--search-foreground-color: #909090;
---search-magnification-image: url('mag.svg');
---search-magnification-select-image: url('mag_sel.svg');
--search-active-color: black;
---search-filter-background-color: #F9FAFC;
+--search-filter-background-color: rgba(255,255,255,.7);
+--search-filter-backdrop-filter: blur(4px);
--search-filter-foreground-color: black;
---search-filter-border-color: #90A5CE;
+--search-filter-border-color: rgba(150,150,150,.4);
--search-filter-highlight-text-color: white;
--search-filter-highlight-bg-color: #3D578C;
--search-results-foreground-color: #425E97;
---search-results-background-color: #EEF1F7;
---search-results-border-color: black;
---search-box-shadow: inset 0.5px 0.5px 3px 0px #555;
+--search-results-background-color: rgba(255,255,255,.8);
+--search-results-backdrop-filter: blur(4px);
+--search-results-border-color: rgba(150,150,150,.4);
+--search-box-border-color: #B6C4DF;
+--search-close-icon-bg-color: #A0A0A0;
+--search-close-icon-fg-color: white;
/** code fragments */
--code-keyword-color: #008000;
@@ -147,23 +159,21 @@ html {
--fragment-lineno-link-hover-bg-color: #C8C8C8;
--fragment-copy-ok-color: #2EC82E;
--tooltip-foreground-color: black;
---tooltip-background-color: white;
---tooltip-border-color: gray;
+--tooltip-background-color: rgba(255,255,255,0.8);
+--tooltip-arrow-background-color: white;
+--tooltip-border-color: rgba(150,150,150,0.7);
+--tooltip-backdrop-filter: blur(3px);
--tooltip-doc-color: grey;
--tooltip-declaration-color: #006318;
--tooltip-link-color: #4665A2;
---tooltip-shadow: 1px 1px 7px gray;
+--tooltip-shadow: 0 4px 8px 0 rgba(0,0,0,.25);
--fold-line-color: #808080;
---fold-minus-image: url('minus.svg');
---fold-plus-image: url('plus.svg');
---fold-minus-image-relpath: url('../../minus.svg');
---fold-plus-image-relpath: url('../../plus.svg');
/** font-family */
---font-family-normal: Roboto,sans-serif;
+--font-family-normal: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-monospace: 'JetBrains Mono',Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace,fixed;
--font-family-nav: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
---font-family-title: Tahoma,Arial,sans-serif;
+--font-family-title: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-toc: Verdana,'DejaVu Sans',Geneva,sans-serif;
--font-family-search: Arial,Verdana,sans-serif;
--font-family-icon: Arial,Helvetica;
@@ -201,7 +211,8 @@ html {
--page-background-color: black;
--page-foreground-color: #C9D1D9;
--page-link-color: #90A5CE;
---page-visited-link-color: #A3B4D7;
+--page-visited-link-color: #90A5CE;
+--page-external-link-color: #A3B4D7;
/* index */
--index-odd-item-bg-color: #0B101A;
@@ -212,8 +223,7 @@ html {
/* header */
--header-background-color: #070B11;
--header-separator-color: #141C2E;
---header-gradient-image: url('nav_hd.png');
---group-header-separator-color: #283A5D;
+--group-header-separator-color: #1D2A43;
--group-header-color: #90A5CE;
--inherit-header-color: #A0A0A0;
@@ -223,35 +233,36 @@ html {
--glow-color: cyan;
--title-background-color: #090D16;
---title-separator-color: #354C79;
+--title-separator-color: #212F4B;
--directory-separator-color: #283A5D;
--separator-color: #283A5D;
--blockquote-background-color: #101826;
--blockquote-border-color: #283A5D;
---scrollbar-thumb-color: #283A5D;
+--scrollbar-thumb-color: #2C3F65;
--scrollbar-background-color: #070B11;
--icon-background-color: #334975;
--icon-foreground-color: #C4CFE5;
---icon-doc-image: url('docd.svg');
---icon-folder-open-image: url('folderopend.svg');
---icon-folder-closed-image: url('folderclosedd.svg');
+--icon-folder-open-fill-color: #4665A2;
+--icon-folder-fill-color: #5373B4;
+--icon-folder-border-color: #C4CFE5;
+--icon-doc-fill-color: #6884BD;
+--icon-doc-border-color: #C4CFE5;
/* brief member declaration list */
--memdecl-background-color: #0B101A;
--memdecl-separator-color: #2C3F65;
--memdecl-foreground-color: #BBB;
--memdecl-template-color: #7C95C6;
+--memdecl-border-color: #233250;
/* detailed member list */
--memdef-border-color: #233250;
--memdef-title-background-color: #1B2840;
---memdef-title-gradient-image: url('nav_fd.png');
--memdef-proto-background-color: #19243A;
--memdef-proto-text-color: #9DB0D4;
---memdef-proto-text-shadow: 0px 1px 1px rgba(0, 0, 0, 0.9);
--memdef-doc-background-color: black;
--memdef-param-name-color: #D28757;
--memdef-template-color: #7C95C6;
@@ -270,29 +281,34 @@ html {
/** navigation bar/tree/menu */
--nav-background-color: #101826;
--nav-foreground-color: #364D7C;
---nav-gradient-image: url('tab_bd.png');
---nav-gradient-hover-image: url('tab_hd.png');
---nav-gradient-active-image: url('tab_ad.png');
---nav-gradient-active-image-parent: url("../tab_ad.png");
---nav-separator-image: url('tab_sd.png');
---nav-breadcrumb-image: url('bc_sd.png');
+--nav-border-color: #212F4B;
+--nav-breadcrumb-separator-color: #212F4B;
+--nav-breadcrumb-active-bg: #1D2A43;
+--nav-breadcrumb-color: #90A5CE;
--nav-breadcrumb-border-color: #2A3D61;
---nav-splitbar-image: url('splitbard.png');
+--nav-splitbar-bg-color: #283A5D;
+--nav-splitbar-handle-color: #4665A2;
--nav-font-size-level1: 13px;
--nav-font-size-level2: 10px;
--nav-font-size-level3: 9px;
--nav-text-normal-color: #B6C4DF;
--nav-text-hover-color: #DCE2EF;
--nav-text-active-color: #DCE2EF;
---nav-text-normal-shadow: 0px 1px 1px black;
---nav-text-hover-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
---nav-text-active-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
--nav-menu-button-color: #B6C4DF;
--nav-menu-background-color: #05070C;
--nav-menu-foreground-color: #BBBBBB;
+--nav-menu-active-bg: #1D2A43;
+--nav-menu-active-color: #C9D3E7;
--nav-menu-toggle-color: rgba(255, 255, 255, 0.2);
---nav-arrow-color: #334975;
---nav-arrow-selected-color: #90A5CE;
+--nav-arrow-color: #4665A2;
+--nav-arrow-selected-color: #6884BD;
+
+/* sync icon */
+--sync-icon-border-color: #212F4B;
+--sync-icon-background-color: #101826;
+--sync-icon-selected-background-color: #1D2A43;
+--sync-icon-color: #4665A2;
+--sync-icon-selected-color: #5373B4;
/* table of contents */
--toc-background-color: #151E30;
@@ -303,18 +319,20 @@ html {
/** search field */
--search-background-color: black;
--search-foreground-color: #C5C5C5;
---search-magnification-image: url('mag_d.svg');
---search-magnification-select-image: url('mag_seld.svg');
---search-active-color: #C5C5C5;
+--search-active-color: #F5F5F5;
--search-filter-background-color: #101826;
--search-filter-foreground-color: #90A5CE;
+--search-filter-backdrop-filter: none;
--search-filter-border-color: #7C95C6;
--search-filter-highlight-text-color: #BCC9E2;
--search-filter-highlight-bg-color: #283A5D;
---search-results-background-color: #101826;
+--search-results-background-color: black;
--search-results-foreground-color: #90A5CE;
---search-results-border-color: #7C95C6;
---search-box-shadow: inset 0.5px 0.5px 3px 0px #2F436C;
+--search-results-backdrop-filter: none;
+--search-results-border-color: #334975;
+--search-box-border-color: #334975;
+--search-close-icon-bg-color: #909090;
+--search-close-icon-fg-color: black;
/** code fragments */
--code-keyword-color: #CC99CD;
@@ -344,22 +362,20 @@ html {
--fragment-copy-ok-color: #0EA80E;
--tooltip-foreground-color: #C9D1D9;
--tooltip-background-color: #202020;
+--tooltip-arrow-background-color: #202020;
+--tooltip-backdrop-filter: none;
--tooltip-border-color: #C9D1D9;
--tooltip-doc-color: #D9E1E9;
--tooltip-declaration-color: #20C348;
--tooltip-link-color: #79C0FF;
--tooltip-shadow: none;
--fold-line-color: #808080;
---fold-minus-image: url('minusd.svg');
---fold-plus-image: url('plusd.svg');
---fold-minus-image-relpath: url('../../minusd.svg');
---fold-plus-image-relpath: url('../../plusd.svg');
/** font-family */
---font-family-normal: Roboto,sans-serif;
+--font-family-normal: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-monospace: 'JetBrains Mono',Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace,fixed;
--font-family-nav: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
---font-family-title: Tahoma,Arial,sans-serif;
+--font-family-title: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-toc: Verdana,'DejaVu Sans',Geneva,sans-serif;
--font-family-search: Arial,Verdana,sans-serif;
--font-family-icon: Arial,Helvetica;
@@ -389,8 +405,8 @@ html {
--invariant-color-text: #cceed5;
}}
body {
- background-color: var(--page-background-color);
- color: var(--page-foreground-color);
+ background-color: var(--page-background-color);
+ color: var(--page-foreground-color);
}
body, table, div, p, dl {
@@ -400,13 +416,22 @@ body, table, div, p, dl {
line-height: 22px;
}
+body.resizing {
+ user-select: none;
+ -webkit-user-select: none;
+}
+
+#doc-content {
+ scrollbar-width: thin;
+}
+
/* @group Heading Levels */
.title {
font-family: var(--font-family-normal);
line-height: 28px;
- font-size: 150%;
- font-weight: bold;
+ font-size: 160%;
+ font-weight: 400;
margin: 10px 2px;
}
@@ -415,7 +440,10 @@ h1.groupheader {
}
h2.groupheader {
- border-bottom: 1px solid var(--group-header-separator-color);
+ box-shadow: 12px 0 var(--page-background-color),
+ -12px 0 var(--page-background-color),
+ 12px 1px var(--group-header-separator-color),
+ -12px 1px var(--group-header-separator-color);
color: var(--group-header-color);
font-size: 150%;
font-weight: normal;
@@ -425,6 +453,13 @@ h2.groupheader {
width: 100%;
}
+td h2.groupheader {
+ box-shadow: 13px 0 var(--page-background-color),
+ -13px 0 var(--page-background-color),
+ 13px 1px var(--group-header-separator-color),
+ -13px 1px var(--group-header-separator-color);
+}
+
h3.groupheader {
font-size: 100%;
}
@@ -451,8 +486,8 @@ p.startli, p.startdd {
}
th p.starttd, th p.intertd, th p.endtd {
- font-size: 100%;
- font-weight: 700;
+ font-size: 100%;
+ font-weight: 700;
}
p.starttd {
@@ -497,9 +532,11 @@ h3.version {
}
div.navtab {
- padding-right: 15px;
+ margin-right: 6px;
+ padding-right: 6px;
text-align: right;
line-height: 110%;
+ background-color: var(--nav-background-color);
}
div.navtab table {
@@ -512,19 +549,10 @@ td.navtab {
}
td.navtabHL {
- background-image: var(--nav-gradient-active-image);
- background-repeat:repeat-x;
padding-right: 6px;
padding-left: 6px;
-}
-
-td.navtabHL a, td.navtabHL a:visited {
- color: var(--nav-text-hover-color);
- text-shadow: var(--nav-text-hover-shadow);
-}
-
-a.navtab {
- font-weight: bold;
+ border-radius: 0 6px 6px 0;
+ background-color: var(--nav-menu-active-bg);
}
div.qindex{
@@ -599,16 +627,11 @@ a {
color: var(--page-visited-link-color);
}
-a:hover {
+span.label a:hover {
text-decoration: none;
background: linear-gradient(to bottom, transparent 0,transparent calc(100% - 1px), currentColor 100%);
}
-a:hover > span.arrow {
- text-decoration: none;
- background : var(--nav-background-color);
-}
-
a.el {
font-weight: bold;
}
@@ -616,12 +639,12 @@ a.el {
a.elRef {
}
-a.code, a.code:visited, a.line, a.line:visited {
- color: var(--code-link-color);
+a.el, a.el:visited, a.code, a.code:visited, a.line, a.line:visited {
+ color: var(--page-link-color);
}
a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited {
- color: var(--code-external-link-color);
+ color: var(--page-external-link-color);
}
a.code.hl_class { /* style for links to class names in code snippets */ }
@@ -658,118 +681,124 @@ dl.el {
}
ul.check {
- list-style:none;
- text-indent: -16px;
- padding-left: 38px;
+ list-style:none;
+ text-indent: -16px;
+ padding-left: 38px;
}
li.unchecked:before {
- content: "\2610\A0";
+ content: "\2610\A0";
}
li.checked:before {
- content: "\2611\A0";
+ content: "\2611\A0";
}
ol {
- text-indent: 0px;
+ text-indent: 0px;
}
ul {
- text-indent: 0px;
- overflow: visible;
+ text-indent: 0px;
+ overflow: visible;
}
ul.multicol {
- -moz-column-gap: 1em;
- -webkit-column-gap: 1em;
- column-gap: 1em;
- -moz-column-count: 3;
- -webkit-column-count: 3;
- column-count: 3;
- list-style-type: none;
+ -moz-column-gap: 1em;
+ -webkit-column-gap: 1em;
+ column-gap: 1em;
+ -moz-column-count: 3;
+ -webkit-column-count: 3;
+ column-count: 3;
+ list-style-type: none;
}
#side-nav ul {
- overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */
+ overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */
}
#main-nav ul {
- overflow: visible; /* reset ul rule for the navigation bar drop down lists */
+ overflow: visible; /* reset ul rule for the navigation bar drop down lists */
}
.fragment {
- text-align: left;
- direction: ltr;
- overflow-x: auto;
- overflow-y: hidden;
- position: relative;
- min-height: 12px;
- margin: 10px 0px;
- padding: 10px 10px;
- border: 1px solid var(--fragment-border-color);
- border-radius: 4px;
- background-color: var(--fragment-background-color);
- color: var(--fragment-foreground-color);
+ text-align: left;
+ direction: ltr;
+ overflow-x: auto;
+ overflow-y: hidden;
+ position: relative;
+ min-height: 12px;
+ margin: 10px 0px;
+ padding: 10px 10px;
+ border: 1px solid var(--fragment-border-color);
+ border-radius: 4px;
+ background-color: var(--fragment-background-color);
+ color: var(--fragment-foreground-color);
}
pre.fragment {
- word-wrap: break-word;
- font-size: 10pt;
- line-height: 125%;
- font-family: var(--font-family-monospace);
+ word-wrap: break-word;
+ font-size: 10pt;
+ line-height: 125%;
+ font-family: var(--font-family-monospace);
+}
+
+span.tt {
+ white-space: pre;
+ font-family: var(--font-family-monospace);
}
.clipboard {
- width: 24px;
- height: 24px;
- right: 5px;
- top: 5px;
- opacity: 0;
- position: absolute;
- display: inline;
- overflow: hidden;
- justify-content: center;
- align-items: center;
- cursor: pointer;
+ width: 24px;
+ height: 24px;
+ right: 5px;
+ top: 5px;
+ opacity: 0;
+ position: absolute;
+ display: inline;
+ overflow: hidden;
+ justify-content: center;
+ align-items: center;
+ cursor: pointer;
}
.clipboard.success {
- border: 1px solid var(--fragment-foreground-color);
- border-radius: 4px;
+ border: 1px solid var(--fragment-foreground-color);
+ border-radius: 4px;
}
.fragment:hover .clipboard, .clipboard.success {
- opacity: .4;
+ opacity: .4;
}
.clipboard:hover, .clipboard.success {
- opacity: 1 !important;
+ opacity: 1 !important;
}
.clipboard:active:not([class~=success]) svg {
- transform: scale(.91);
+ transform: scale(.91);
}
.clipboard.success svg {
- fill: var(--fragment-copy-ok-color);
+ fill: var(--fragment-copy-ok-color);
}
.clipboard.success {
- border-color: var(--fragment-copy-ok-color);
+ border-color: var(--fragment-copy-ok-color);
}
div.line {
font-family: var(--font-family-monospace);
- font-size: 13px;
+ font-size: 13px;
min-height: 13px;
line-height: 1.2;
- text-wrap: unrestricted;
+ text-wrap: wrap;
+ word-break: break-all;
white-space: -moz-pre-wrap; /* Moz */
white-space: -pre-wrap; /* Opera 4-6 */
white-space: -o-pre-wrap; /* Opera 7 */
white-space: pre-wrap; /* CSS3 */
word-wrap: break-word; /* IE 5.5+ */
- text-indent: -53px;
- padding-left: 53px;
+ text-indent: -62px;
+ padding-left: 62px;
padding-bottom: 0px;
margin: 0px;
-webkit-transition-property: background-color, box-shadow;
@@ -785,8 +814,8 @@ div.line {
}
div.line:after {
- content:"\000A";
- white-space: pre;
+ content:"\000A";
+ white-space: pre;
}
div.line.glow {
@@ -795,26 +824,67 @@ div.line.glow {
}
span.fold {
- margin-left: 5px;
- margin-right: 1px;
- margin-top: 0px;
- margin-bottom: 0px;
- padding: 0px;
display: inline-block;
width: 12px;
height: 12px;
- background-repeat:no-repeat;
- background-position:center;
+ margin-left: 4px;
+ margin-right: 1px;
+}
+
+span.foldnone {
+ display: inline-block;
+ position: relative;
+ cursor: pointer;
+ user-select: none;
+}
+
+span.fold.plus, span.fold.minus {
+ width: 10px;
+ height: 10px;
+ background-color: var(--fragment-background-color);
+ position: relative;
+ border: 1px solid var(--fold-line-color);
+ margin-right: 1px;
+}
+
+span.fold.plus::before, span.fold.minus::before {
+ content: '';
+ position: absolute;
+ background-color: var(--fold-line-color);
+}
+
+span.fold.plus::before {
+ width: 2px;
+ height: 6px;
+ top: 2px;
+ left: 4px;
+}
+
+span.fold.plus::after {
+ content: '';
+ position: absolute;
+ width: 6px;
+ height: 2px;
+ top: 4px;
+ left: 2px;
+ background-color: var(--fold-line-color);
+}
+
+span.fold.minus::before {
+ width: 6px;
+ height: 2px;
+ top: 4px;
+ left: 2px;
}
span.lineno {
padding-right: 4px;
- margin-right: 9px;
+ margin-right: 9px;
text-align: right;
border-right: 2px solid var(--fragment-lineno-border-color);
color: var(--fragment-lineno-foreground-color);
background-color: var(--fragment-lineno-background-color);
- white-space: pre;
+ white-space: pre;
}
span.lineno a, span.lineno a:visited {
color: var(--fragment-lineno-link-fg-color);
@@ -836,18 +906,27 @@ span.lineno a:hover {
}
div.classindex ul {
- list-style: none;
- padding-left: 0;
+ list-style: none;
+ padding-left: 0;
}
div.classindex span.ai {
- display: inline-block;
+ display: inline-block;
}
div.groupHeader {
- margin-left: 16px;
- margin-top: 12px;
- font-weight: bold;
+ box-shadow: 13px 0 var(--page-background-color),
+ -13px 0 var(--page-background-color),
+ 13px 1px var(--group-header-separator-color),
+ -13px 1px var(--group-header-separator-color);
+ color: var(--group-header-color);
+ font-size: 110%;
+ font-weight: 500;
+ margin-left: 0px;
+ margin-top: 0em;
+ margin-bottom: 6px;
+ padding-top: 8px;
+ padding-bottom: 4px;
}
div.groupText {
@@ -857,13 +936,13 @@ div.groupText {
body {
color: var(--page-foreground-color);
- margin: 0;
+ margin: 0;
}
div.contents {
margin-top: 10px;
margin-left: 12px;
- margin-right: 8px;
+ margin-right: 12px;
}
p.formulaDsp {
@@ -883,9 +962,9 @@ img.formulaInl, img.inline {
div.center {
text-align: center;
- margin-top: 0px;
- margin-bottom: 0px;
- padding: 0px;
+ margin-top: 0px;
+ margin-bottom: 0px;
+ padding: 0px;
}
div.center img {
@@ -960,10 +1039,10 @@ span.vhdllogic {
}
blockquote {
- background-color: var(--blockquote-background-color);
- border-left: 2px solid var(--blockquote-border-color);
- margin: 0 24px 0 4px;
- padding: 0 12px 0 16px;
+ background-color: var(--blockquote-background-color);
+ border-left: 2px solid var(--blockquote-border-color);
+ margin: 0 24px 0 4px;
+ padding: 0 12px 0 16px;
}
/* @end */
@@ -985,9 +1064,14 @@ th.dirtab {
}
hr {
- height: 0px;
border: none;
- border-top: 1px solid var(--separator-color);
+ margin-top: 16px;
+ margin-bottom: 16px;
+ height: 1px;
+ box-shadow: 13px 0 var(--page-background-color),
+ -13px 0 var(--page-background-color),
+ 13px 1px var(--group-header-separator-color),
+ -13px 1px var(--group-header-separator-color);
}
hr.footer {
@@ -1002,14 +1086,6 @@ table.memberdecls {
}
.memberdecls td, .fieldtable tr {
- -webkit-transition-property: background-color, box-shadow;
- -webkit-transition-duration: 0.5s;
- -moz-transition-property: background-color, box-shadow;
- -moz-transition-duration: 0.5s;
- -ms-transition-property: background-color, box-shadow;
- -ms-transition-duration: 0.5s;
- -o-transition-property: background-color, box-shadow;
- -o-transition-duration: 0.5s;
transition-property: background-color, box-shadow;
transition-duration: 0.5s;
}
@@ -1019,13 +1095,23 @@ table.memberdecls {
box-shadow: 0 0 15px var(--glow-color);
}
+.memberdecls tr[class^='memitem'] {
+ font-family: var(--font-family-monospace);
+}
+
.mdescLeft, .mdescRight,
-.memItemLeft, .memItemRight,
-.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
+.memItemLeft, .memItemRight {
+ padding-top: 2px;
+ padding-bottom: 2px;
+}
+
+.memTemplParams {
+ padding-left: 10px;
+ padding-top: 5px;
+}
+
+.memItemLeft, .memItemRight, .memTemplParams {
background-color: var(--memdecl-background-color);
- border: none;
- margin: 4px;
- padding: 1px 0 0 8px;
}
.mdescLeft, .mdescRight {
@@ -1033,27 +1119,104 @@ table.memberdecls {
color: var(--memdecl-foreground-color);
}
-.memSeparator {
- border-bottom: 1px solid var(--memdecl-separator-color);
- line-height: 1px;
- margin: 0px;
- padding: 0px;
+tr[class^='memdesc'] {
+ box-shadow: inset 0px 1px 3px 0px rgba(0,0,0,.075);
}
-.memItemLeft, .memTemplItemLeft {
- white-space: nowrap;
+.mdescLeft {
+ border-left: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
}
-.memItemRight, .memTemplItemRight {
- width: 100%;
+.mdescRight {
+ border-right: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
}
.memTemplParams {
color: var(--memdecl-template-color);
- white-space: nowrap;
+ white-space: nowrap;
font-size: 80%;
+ border-left: 1px solid var(--memdecl-border-color);
+ border-right: 1px solid var(--memdecl-border-color);
+}
+
+td.ititle {
+ border: 1px solid var(--memdecl-border-color);
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+ padding-left: 10px;
+}
+
+tr:not(:first-child) > td.ititle {
+ border-top: 0;
+ border-radius: 0;
}
+.memItemLeft {
+ white-space: nowrap;
+ border-left: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
+ padding-left: 10px;
+ transition: none;
+}
+
+.memItemRight {
+ width: 100%;
+ border-right: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
+ padding-right: 10px;
+ transition: none;
+}
+
+tr.heading + tr[class^='memitem'] td.memItemLeft,
+tr.groupHeader + tr[class^='memitem'] td.memItemLeft,
+tr.inherit_header + tr[class^='memitem'] td.memItemLeft {
+ border-top: 1px solid var(--memdecl-border-color);
+ border-top-left-radius: 4px;
+}
+
+tr.heading + tr[class^='memitem'] td.memItemRight,
+tr.groupHeader + tr[class^='memitem'] td.memItemRight,
+tr.inherit_header + tr[class^='memitem'] td.memItemRight {
+ border-top: 1px solid var(--memdecl-border-color);
+ border-top-right-radius: 4px;
+}
+
+tr.heading + tr[class^='memitem'] td.memTemplParams,
+tr.heading + tr td.ititle,
+tr.groupHeader + tr[class^='memitem'] td.memTemplParams,
+tr.groupHeader + tr td.ititle,
+tr.inherit_header + tr[class^='memitem'] td.memTemplParams {
+ border-top: 1px solid var(--memdecl-border-color);
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+}
+
+table.memberdecls tr:last-child td.memItemLeft,
+table.memberdecls tr:last-child td.mdescLeft,
+table.memberdecls tr[class^='memitem']:has(+ tr.groupHeader) td.memItemLeft,
+table.memberdecls tr[class^='memitem']:has(+ tr.inherit_header) td.memItemLeft,
+table.memberdecls tr[class^='memdesc']:has(+ tr.groupHeader) td.mdescLeft,
+table.memberdecls tr[class^='memdesc']:has(+ tr.inherit_header) td.mdescLeft {
+ border-bottom-left-radius: 4px;
+}
+
+table.memberdecls tr:last-child td.memItemRight,
+table.memberdecls tr:last-child td.mdescRight,
+table.memberdecls tr[class^='memitem']:has(+ tr.groupHeader) td.memItemRight,
+table.memberdecls tr[class^='memitem']:has(+ tr.inherit_header) td.memItemRight,
+table.memberdecls tr[class^='memdesc']:has(+ tr.groupHeader) td.mdescRight,
+table.memberdecls tr[class^='memdesc']:has(+ tr.inherit_header) td.mdescRight {
+ border-bottom-right-radius: 4px;
+}
+
+tr.template .memItemLeft, tr.template .memItemRight {
+ border-top: none;
+ padding-top: 0;
+}
+
+
/* @end */
/* @group Member Details */
@@ -1068,24 +1231,43 @@ table.memberdecls {
border-top-right-radius: 4px;
border-top-left-radius: 4px;
margin-bottom: -1px;
- background-image: var(--memdef-title-gradient-image);
- background-repeat: repeat-x;
- background-color: var(--memdef-title-background-color);
+ background-color: var(--memdef-proto-background-color);
line-height: 1.25;
- font-weight: 300;
+ font-family: var(--font-family-monospace);
+ font-weight: 500;
+ font-size: 16px;
float:left;
+ box-shadow: 0 10px 0 -1px var(--memdef-proto-background-color),
+ 0 2px 8px 0 rgba(0,0,0,.075);
+ position: relative;
+}
+
+.memtitle:after {
+ content: '';
+ display: block;
+ background: var(--memdef-proto-background-color);
+ height: 10px;
+ bottom: -10px;
+ left: 0px;
+ right: -14px;
+ position: absolute;
+ border-top-right-radius: 6px;
}
.permalink
{
- font-size: 65%;
- display: inline-block;
- vertical-align: middle;
+ font-family: var(--font-family-monospace);
+ font-weight: 500;
+ line-height: 1.25;
+ font-size: 16px;
+ display: inline-block;
+ vertical-align: middle;
}
.memtemplate {
font-size: 80%;
color: var(--memdef-template-color);
+ font-family: var(--font-family-monospace);
font-weight: normal;
margin-left: 9px;
}
@@ -1098,22 +1280,21 @@ table.memberdecls {
padding: 0;
margin-bottom: 10px;
margin-right: 5px;
- -webkit-transition: box-shadow 0.5s linear;
- -moz-transition: box-shadow 0.5s linear;
- -ms-transition: box-shadow 0.5s linear;
- -o-transition: box-shadow 0.5s linear;
- transition: box-shadow 0.5s linear;
- display: table !important;
- width: 100%;
+ display: table !important;
+ width: 100%;
+ box-shadow: 0 2px 8px 0 rgba(0,0,0,.075);
+ border-radius: 4px;
}
.memitem.glow {
- box-shadow: 0 0 15px var(--glow-color);
+ box-shadow: 0 0 15px var(--glow-color);
}
.memname {
- font-weight: 400;
- margin-left: 6px;
+ font-family: var(--font-family-monospace);
+ font-size: 13px;
+ font-weight: 400;
+ margin-left: 6px;
}
.memname td {
@@ -1121,53 +1302,39 @@ table.memberdecls {
}
.memproto, dl.reflist dt {
- border-top: 1px solid var(--memdef-border-color);
- border-left: 1px solid var(--memdef-border-color);
- border-right: 1px solid var(--memdef-border-color);
- padding: 6px 0px 6px 0px;
- color: var(--memdef-proto-text-color);
- font-weight: bold;
- text-shadow: var(--memdef-proto-text-shadow);
- background-color: var(--memdef-proto-background-color);
- box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
- border-top-right-radius: 4px;
+ border-top: 1px solid var(--memdef-border-color);
+ border-left: 1px solid var(--memdef-border-color);
+ border-right: 1px solid var(--memdef-border-color);
+ padding: 6px 0px 6px 0px;
+ color: var(--memdef-proto-text-color);
+ font-weight: bold;
+ background-color: var(--memdef-proto-background-color);
+ border-top-right-radius: 4px;
+ border-bottom: 1px solid var(--memdef-border-color);
}
.overload {
- font-family: var(--font-family-monospace);
+ font-family: var(--font-family-monospace);
font-size: 65%;
}
.memdoc, dl.reflist dd {
- border-bottom: 1px solid var(--memdef-border-color);
- border-left: 1px solid var(--memdef-border-color);
- border-right: 1px solid var(--memdef-border-color);
- padding: 6px 10px 2px 10px;
- border-top-width: 0;
- background-image:url('nav_g.png');
- background-repeat:repeat-x;
- background-color: var(--memdef-doc-background-color);
- /* opera specific markup */
- border-bottom-left-radius: 4px;
- border-bottom-right-radius: 4px;
- box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
- /* firefox specific markup */
- -moz-border-radius-bottomleft: 4px;
- -moz-border-radius-bottomright: 4px;
- -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
- /* webkit specific markup */
- -webkit-border-bottom-left-radius: 4px;
- -webkit-border-bottom-right-radius: 4px;
- -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ border-bottom: 1px solid var(--memdef-border-color);
+ border-left: 1px solid var(--memdef-border-color);
+ border-right: 1px solid var(--memdef-border-color);
+ padding: 6px 10px 2px 10px;
+ border-top-width: 0;
+ border-bottom-left-radius: 4px;
+ border-bottom-right-radius: 4px;
}
dl.reflist dt {
- padding: 5px;
+ padding: 5px;
}
dl.reflist dd {
- margin: 0px 0px 10px 0px;
- padding: 5px;
+ margin: 0px 0px 10px 0px;
+ padding: 5px;
}
.paramkey {
@@ -1182,9 +1349,9 @@ dl.reflist dd {
.paramname {
white-space: nowrap;
- padding: 0px;
- padding-bottom: 1px;
- margin-left: 2px;
+ padding: 0px;
+ padding-bottom: 1px;
+ margin-left: 2px;
}
.paramname em {
@@ -1198,23 +1365,23 @@ dl.reflist dd {
}
.params, .retval, .exception, .tparams {
- margin-left: 0px;
- padding-left: 0px;
+ margin-left: 0px;
+ padding-left: 0px;
}
.params .paramname, .retval .paramname, .tparams .paramname, .exception .paramname {
- font-weight: bold;
- vertical-align: top;
+ font-weight: bold;
+ vertical-align: top;
}
.params .paramtype, .tparams .paramtype {
- font-style: italic;
- vertical-align: top;
+ font-style: italic;
+ vertical-align: top;
}
.params .paramdir, .tparams .paramdir {
- font-family: var(--font-family-monospace);
- vertical-align: top;
+ font-family: var(--font-family-monospace);
+ vertical-align: top;
}
table.mlabels {
@@ -1233,15 +1400,15 @@ td.mlabels-right {
}
span.mlabels {
- margin-left: 8px;
+ margin-left: 8px;
}
span.mlabel {
- background-color: var(--label-background-color);
- border-top:1px solid var(--label-left-top-border-color);
- border-left:1px solid var(--label-left-top-border-color);
- border-right:1px solid var(--label-right-bottom-border-color);
- border-bottom:1px solid var(--label-right-bottom-border-color);
+ background-color: var(--label-background-color);
+ border-top:1px solid var(--label-left-top-border-color);
+ border-left:1px solid var(--label-left-top-border-color);
+ border-right:1px solid var(--label-right-bottom-border-color);
+ border-bottom:1px solid var(--label-right-bottom-border-color);
text-shadow: none;
color: var(--label-foreground-color);
margin-right: 4px;
@@ -1259,39 +1426,37 @@ span.mlabel {
/* these are for tree view inside a (index) page */
div.directory {
- margin: 10px 0px;
- border-top: 1px solid var(--directory-separator-color);
- border-bottom: 1px solid var(--directory-separator-color);
- width: 100%;
+ margin: 10px 0px;
+ width: 100%;
}
.directory table {
- border-collapse:collapse;
+ border-collapse:collapse;
}
.directory td {
- margin: 0px;
- padding: 0px;
+ margin: 0px;
+ padding: 0px;
vertical-align: top;
}
.directory td.entry {
- white-space: nowrap;
- padding-right: 6px;
+ white-space: nowrap;
+ padding-right: 6px;
padding-top: 3px;
}
.directory td.entry a {
- outline:none;
+ outline:none;
}
.directory td.entry a img {
- border: none;
+ border: none;
}
.directory td.desc {
- width: 100%;
- padding-left: 6px;
+ width: 100%;
+ padding-left: 6px;
padding-right: 6px;
padding-top: 3px;
border-left: 1px solid rgba(0,0,0,0.05);
@@ -1312,90 +1477,178 @@ div.directory {
}
.directory .levels {
- white-space: nowrap;
- width: 100%;
- text-align: right;
- font-size: 9pt;
+ white-space: nowrap;
+ width: 100%;
+ text-align: right;
+ font-size: 9pt;
}
.directory .levels span {
- cursor: pointer;
- padding-left: 2px;
- padding-right: 2px;
+ cursor: pointer;
+ padding-left: 2px;
+ padding-right: 2px;
color: var(--page-link-color);
}
.arrow {
- color: var(--nav-arrow-color);
- -webkit-user-select: none;
- -khtml-user-select: none;
- -moz-user-select: none;
- -ms-user-select: none;
- user-select: none;
- cursor: pointer;
- font-size: 80%;
- display: inline-block;
- width: 16px;
- height: 22px;
+ color: var(--nav-background-color);
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ cursor: pointer;
+ font-size: 80%;
+ display: inline-block;
+ width: 16px;
+ height: 14px;
+ transition: opacity 0.3s ease;
+}
+
+span.arrowhead {
+ position: relative;
+ padding: 0;
+ margin: 0 0 0 2px;
+ display: inline-block;
+ width: 5px;
+ height: 5px;
+ border-right: 2px solid var(--nav-arrow-color);
+ border-bottom: 2px solid var(--nav-arrow-color);
+ transform: rotate(-45deg);
+ transition: transform 0.3s ease;
+}
+
+span.arrowhead.opened {
+ transform: rotate(45deg);
+}
+
+.selected span.arrowhead {
+ border-right: 2px solid var(--nav-arrow-selected-color);
+ border-bottom: 2px solid var(--nav-arrow-selected-color);
}
.icon {
- font-family: var(--font-family-icon);
- line-height: normal;
- font-weight: bold;
- font-size: 12px;
- height: 14px;
- width: 16px;
- display: inline-block;
- background-color: var(--icon-background-color);
- color: var(--icon-foreground-color);
- text-align: center;
- border-radius: 4px;
- margin-left: 2px;
- margin-right: 2px;
+ font-family: var(--font-family-icon);
+ line-height: normal;
+ font-weight: bold;
+ font-size: 12px;
+ height: 14px;
+ width: 16px;
+ display: inline-block;
+ background-color: var(--icon-background-color);
+ color: var(--icon-foreground-color);
+ text-align: center;
+ border-radius: 4px;
+ margin-left: 2px;
+ margin-right: 2px;
}
.icona {
- width: 24px;
- height: 22px;
- display: inline-block;
+ width: 24px;
+ height: 22px;
+ display: inline-block;
}
-.iconfopen {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:var(--icon-folder-open-image);
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
+.iconfolder {
+ width: 24px;
+ height: 18px;
+ margin-top: 6px;
+ vertical-align:top;
+ display: inline-block;
+ position: relative;
}
-.iconfclosed {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:var(--icon-folder-closed-image);
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
+.icondoc {
+ width: 24px;
+ height: 18px;
+ margin-top: 3px;
+ vertical-align:top;
+ display: inline-block;
+ position: relative;
}
-.icondoc {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:var(--icon-doc-image);
- background-position: 0px -4px;
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
+.folder-icon {
+ width: 16px;
+ height: 11px;
+ background-color: var(--icon-folder-fill-color);
+ border: 1px solid var(--icon-folder-border-color);
+ border-radius: 0 2px 2px 2px;
+ position: relative;
+ box-sizing: content-box;
+}
+
+.folder-icon::after {
+ content: '';
+ position: absolute;
+ top: 2px;
+ left: -1px;
+ width: 16px;
+ height: 7px;
+ background-color: var(--icon-folder-open-fill-color);
+ border: 1px solid var(--icon-folder-border-color);
+ border-radius: 7px 7px 2px 2px;
+ transform-origin: top left;
+ opacity: 0;
+ transition: all 0.3s linear;
+}
+
+.folder-icon::before {
+ content: '';
+ position: absolute;
+ top: -3px;
+ left: -1px;
+ width: 6px;
+ height: 2px;
+ background-color: var(--icon-folder-fill-color);
+ border-top: 1px solid var(--icon-folder-border-color);
+ border-left: 1px solid var(--icon-folder-border-color);
+ border-right: 1px solid var(--icon-folder-border-color);
+ border-radius: 2px 2px 0 0;
+}
+
+.folder-icon.open::after {
+ top: 3px;
+ opacity: 1;
+}
+
+.doc-icon {
+ left: 6px;
+ width: 12px;
+ height: 16px;
+ background-color: var(--icon-doc-border-color);
+ clip-path: polygon(0 0, 66% 0, 100% 25%, 100% 100%, 0 100%);
+ position: relative;
+ display: inline-block;
+}
+.doc-icon::before {
+ content: "";
+ left: 1px;
+ top: 1px;
+ width: 10px;
+ height: 14px;
+ background-color: var(--icon-doc-fill-color);
+ clip-path: polygon(0 0, 66% 0, 100% 25%, 100% 100%, 0 100%);
+ position: absolute;
+ box-sizing: border-box;
+}
+.doc-icon::after {
+ content: "";
+ left: 7px;
+ top: 0px;
+ width: 3px;
+ height: 3px;
+ background-color: transparent;
+ position: absolute;
+ border: 1px solid var(--icon-doc-border-color);
}
+
+
+
/* @end */
div.dynheader {
- margin-top: 8px;
+ margin-top: 8px;
-webkit-touch-callout: none;
-webkit-user-select: none;
-khtml-user-select: none;
@@ -1404,6 +1657,13 @@ div.dynheader {
user-select: none;
}
+span.dynarrow {
+ position: relative;
+ display: inline-block;
+ width: 12px;
+ bottom: 1px;
+}
+
address {
font-style: normal;
color: var(--footer-foreground-color);
@@ -1415,8 +1675,8 @@ table.doxtable caption {
table.doxtable {
border-collapse:collapse;
- margin-top: 4px;
- margin-bottom: 4px;
+ margin-top: 4px;
+ margin-bottom: 4px;
}
table.doxtable td, table.doxtable th {
@@ -1433,133 +1693,145 @@ table.doxtable th {
}
table.fieldtable {
- margin-bottom: 10px;
- border: 1px solid var(--memdef-border-color);
- border-spacing: 0px;
- border-radius: 4px;
- box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
+ margin-bottom: 10px;
+ border: 1px solid var(--memdef-border-color);
+ border-spacing: 0px;
+ border-radius: 4px;
+ box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
}
.fieldtable td, .fieldtable th {
- padding: 3px 7px 2px;
+ padding: 3px 7px 2px;
}
.fieldtable td.fieldtype, .fieldtable td.fieldname, .fieldtable td.fieldinit {
- white-space: nowrap;
- border-right: 1px solid var(--memdef-border-color);
- border-bottom: 1px solid var(--memdef-border-color);
- vertical-align: top;
+ white-space: nowrap;
+ border-right: 1px solid var(--memdef-border-color);
+ border-bottom: 1px solid var(--memdef-border-color);
+ vertical-align: top;
}
.fieldtable td.fieldname {
- padding-top: 3px;
+ padding-top: 3px;
}
.fieldtable td.fieldinit {
- padding-top: 3px;
- text-align: right;
+ padding-top: 3px;
+ text-align: right;
}
.fieldtable td.fielddoc {
- border-bottom: 1px solid var(--memdef-border-color);
+ border-bottom: 1px solid var(--memdef-border-color);
}
.fieldtable td.fielddoc p:first-child {
- margin-top: 0px;
+ margin-top: 0px;
}
.fieldtable td.fielddoc p:last-child {
- margin-bottom: 2px;
+ margin-bottom: 2px;
}
.fieldtable tr:last-child td {
- border-bottom: none;
+ border-bottom: none;
}
.fieldtable th {
- background-image: var(--memdef-title-gradient-image);
- background-repeat:repeat-x;
- background-color: var(--memdef-title-background-color);
- font-size: 90%;
- color: var(--memdef-proto-text-color);
- padding-bottom: 4px;
- padding-top: 5px;
- text-align:left;
- font-weight: 400;
- border-top-left-radius: 4px;
- border-top-right-radius: 4px;
- border-bottom: 1px solid var(--memdef-border-color);
-}
-
-
-.tabsearch {
- top: 0px;
- left: 10px;
- height: 36px;
- background-image: var(--nav-gradient-image);
- z-index: 101;
+ background-color: var(--memdef-title-background-color);
+ font-size: 90%;
+ color: var(--memdef-proto-text-color);
+ padding-bottom: 4px;
+ padding-top: 5px;
+ text-align:left;
+ font-weight: 400;
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+ border-bottom: 1px solid var(--memdef-border-color);
+}
+
+/* ----------- navigation breadcrumb styling ----------- */
+
+#nav-path ul {
+ height: 30px;
+ line-height: 30px;
+ color: var(--nav-text-normal-color);
overflow: hidden;
- font-size: 13px;
+ margin: 0px;
+ padding-left: 4px;
+ background-image: none;
+ background: var(--page-background-color);
+ border-bottom: 1px solid var(--nav-breadcrumb-separator-color);
+ font-size: var(--nav-font-size-level1);
+ font-family: var(--font-family-nav);
+ position: relative;
+ z-index: 100;
}
-.navpath ul
-{
- font-size: 11px;
- background-image: var(--nav-gradient-image);
- background-repeat:repeat-x;
- background-position: 0 -5px;
- height:30px;
- line-height:30px;
- color:var(--nav-text-normal-color);
- border:solid 1px var(--nav-breadcrumb-border-color);
- overflow:hidden;
- margin:0px;
- padding:0px;
-}
-
-.navpath li
-{
+#main-nav {
+ border-bottom: 1px solid var(--nav-border-color);
+}
+
+.navpath li {
list-style-type:none;
float:left;
+ color: var(--nav-foreground-color);
+}
+
+.navpath li.footer {
+ list-style-type:none;
+ float:right;
padding-left:10px;
padding-right:15px;
- background-image:var(--nav-breadcrumb-image);
+ background-image:none;
background-repeat:no-repeat;
background-position:right;
- color: var(--nav-foreground-color);
+ font-size: 8pt;
+ color: var(--footer-foreground-color);
}
-.navpath li.navelem a
-{
- height:32px;
- display:block;
- outline: none;
- color: var(--nav-text-normal-color);
- font-family: var(--font-family-nav);
- text-shadow: var(--nav-text-normal-shadow);
- text-decoration: none;
+#nav-path li.navelem {
+ background-image: none;
+ display: flex;
+ align-items: center;
+ padding-left: 15px;
}
-.navpath li.navelem a:hover
-{
- color: var(--nav-text-hover-color);
- text-shadow: var(--nav-text-hover-shadow);
+.navpath li.navelem a {
+ text-shadow: none;
+ display: inline-block;
+ color: var(--nav-breadcrumb-color);
+ position: relative;
+ top: 0px;
+ height: 30px;
+ margin-right: -20px;
}
-.navpath li.footer
-{
- list-style-type:none;
- float:right;
- padding-left:10px;
- padding-right:15px;
- background-image:none;
- background-repeat:no-repeat;
- background-position:right;
- color: var(--footer-foreground-color);
- font-size: 8pt;
+#nav-path li.navelem:after {
+ content: '';
+ display: inline-block;
+ position: relative;
+ top: 0;
+ right: -15px;
+ width: 30px;
+ height: 30px;
+ transform: scaleX(0.5) scale(0.707) rotate(45deg);
+ z-index: 10;
+ background: var(--page-background-color);
+ box-shadow: 2px -2px 0 2px var(--nav-breadcrumb-separator-color);
+ border-radius: 0 5px 0 50px;
+}
+
+#nav-path li.navelem:first-child {
+ margin-left: -6px;
}
+#nav-path li.navelem:hover,
+#nav-path li.navelem:hover:after {
+ background-color: var(--nav-breadcrumb-active-bg);
+}
+
+/* ---------------------- */
div.summary
{
@@ -1577,14 +1849,14 @@ div.summary a
table.classindex
{
- margin: 10px;
- white-space: nowrap;
- margin-left: 3%;
- margin-right: 3%;
- width: 94%;
- border: 0;
- border-spacing: 0;
- padding: 0;
+ margin: 10px;
+ white-space: nowrap;
+ margin-left: 3%;
+ margin-right: 3%;
+ width: 94%;
+ border: 0;
+ border-spacing: 0;
+ padding: 0;
}
div.ingroups
@@ -1601,10 +1873,8 @@ div.ingroups a
div.header
{
- background-image: var(--header-gradient-image);
- background-repeat:repeat-x;
- background-color: var(--header-background-color);
margin: 0px;
+ background-color: var(--header-background-color);
border-bottom: 1px solid var(--header-separator-color);
}
@@ -1613,168 +1883,105 @@ div.headertitle
padding: 5px 5px 5px 10px;
}
-.PageDocRTL-title div.headertitle {
- text-align: right;
- direction: rtl;
-}
-
dl {
- padding: 0 0 0 0;
-}
-
-/*
-
-dl.section {
- margin-left: 0px;
- padding-left: 0px;
-}
-
-dl.note {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #D0C000;
-}
-
-dl.warning, dl.attention, dl.important {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #FF0000;
-}
-
-dl.pre, dl.post, dl.invariant {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #00D000;
-}
-
-dl.deprecated {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #505050;
-}
-
-dl.todo {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #00C0E0;
-}
-
-dl.test {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #3030E0;
-}
-
-dl.bug {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #C08050;
+ padding: 0 0 0 0;
}
-*/
-
dl.bug dt a, dl.deprecated dt a, dl.todo dt a, dl.test a {
- font-weight: bold !important;
+ font-weight: bold !important;
}
dl.warning, dl.attention, dl.important, dl.note, dl.deprecated, dl.bug,
dl.invariant, dl.pre, dl.post, dl.todo, dl.test, dl.remark {
- padding: 10px;
- margin: 10px 0px;
- overflow: hidden;
- margin-left: 0;
- border-radius: 4px;
+ padding: 10px;
+ margin: 10px 0px;
+ overflow: hidden;
+ margin-left: 0;
+ border-radius: 4px;
}
dl.section dd {
- margin-bottom: 2px;
+ margin-bottom: 2px;
}
dl.warning, dl.attention, dl.important {
- background: var(--warning-color-bg);
- border-left: 8px solid var(--warning-color-hl);
- color: var(--warning-color-text);
+ background: var(--warning-color-bg);
+ border-left: 8px solid var(--warning-color-hl);
+ color: var(--warning-color-text);
}
dl.warning dt, dl.attention dt, dl.important dt {
- color: var(--warning-color-hl);
+ color: var(--warning-color-hl);
}
dl.note, dl.remark {
- background: var(--note-color-bg);
- border-left: 8px solid var(--note-color-hl);
- color: var(--note-color-text);
+ background: var(--note-color-bg);
+ border-left: 8px solid var(--note-color-hl);
+ color: var(--note-color-text);
}
dl.note dt, dl.remark dt {
- color: var(--note-color-hl);
+ color: var(--note-color-hl);
}
dl.todo {
- background: var(--todo-color-bg);
- border-left: 8px solid var(--todo-color-hl);
- color: var(--todo-color-text);
+ background: var(--todo-color-bg);
+ border-left: 8px solid var(--todo-color-hl);
+ color: var(--todo-color-text);
}
dl.todo dt {
- color: var(--todo-color-hl);
+ color: var(--todo-color-hl);
}
dl.test {
- background: var(--test-color-bg);
- border-left: 8px solid var(--test-color-hl);
- color: var(--test-color-text);
+ background: var(--test-color-bg);
+ border-left: 8px solid var(--test-color-hl);
+ color: var(--test-color-text);
}
dl.test dt {
- color: var(--test-color-hl);
+ color: var(--test-color-hl);
}
dl.bug dt a {
- color: var(--bug-color-hl) !important;
+ color: var(--bug-color-hl) !important;
}
dl.bug {
- background: var(--bug-color-bg);
- border-left: 8px solid var(--bug-color-hl);
- color: var(--bug-color-text);
+ background: var(--bug-color-bg);
+ border-left: 8px solid var(--bug-color-hl);
+ color: var(--bug-color-text);
}
dl.bug dt a {
- color: var(--bug-color-hl) !important;
+ color: var(--bug-color-hl) !important;
}
dl.deprecated {
- background: var(--deprecated-color-bg);
- border-left: 8px solid var(--deprecated-color-hl);
- color: var(--deprecated-color-text);
+ background: var(--deprecated-color-bg);
+ border-left: 8px solid var(--deprecated-color-hl);
+ color: var(--deprecated-color-text);
}
dl.deprecated dt a {
- color: var(--deprecated-color-hl) !important;
+ color: var(--deprecated-color-hl) !important;
}
dl.note dd, dl.warning dd, dl.pre dd, dl.post dd,
dl.remark dd, dl.attention dd, dl.important dd, dl.invariant dd,
dl.bug dd, dl.deprecated dd, dl.todo dd, dl.test dd {
- margin-inline-start: 0px;
+ margin-inline-start: 0px;
}
dl.invariant, dl.pre, dl.post {
- background: var(--invariant-color-bg);
- border-left: 8px solid var(--invariant-color-hl);
- color: var(--invariant-color-text);
+ background: var(--invariant-color-bg);
+ border-left: 8px solid var(--invariant-color-hl);
+ color: var(--invariant-color-text);
}
dl.invariant dt, dl.pre dt, dl.post dt {
- color: var(--invariant-color-hl);
+ color: var(--invariant-color-hl);
}
@@ -1797,16 +2004,16 @@ dl.invariant dt, dl.pre dt, dl.post dt {
#projectalign
{
- vertical-align: middle;
- padding-left: 0.5em;
+ vertical-align: middle;
+ padding-left: 0.5em;
}
#projectname
{
font-size: 200%;
font-family: var(--font-family-title);
- margin: 0px;
- padding: 2px 0px;
+ margin: 0;
+ padding: 0;
}
#side-nav #projectname
@@ -1817,7 +2024,7 @@ dl.invariant dt, dl.pre dt, dl.post dt {
#projectbrief
{
font-size: 90%;
- font-family: var(--font-family-title);
+ font-family: var(--font-family-title);
margin: 0px;
padding: 0px;
}
@@ -1825,43 +2032,42 @@ dl.invariant dt, dl.pre dt, dl.post dt {
#projectnumber
{
font-size: 50%;
- font-family: 50% var(--font-family-title);
+ font-family: var(--font-family-title);
margin: 0px;
padding: 0px;
}
#titlearea
{
- padding: 0px;
+ padding: 0 0 0 5px;
margin: 0px;
- width: 100%;
border-bottom: 1px solid var(--title-separator-color);
background-color: var(--title-background-color);
}
.image
{
- text-align: center;
+ text-align: center;
}
.dotgraph
{
- text-align: center;
+ text-align: center;
}
.mscgraph
{
- text-align: center;
+ text-align: center;
}
.plantumlgraph
{
- text-align: center;
+ text-align: center;
}
.diagraph
{
- text-align: center;
+ text-align: center;
}
.caption
@@ -1870,67 +2076,67 @@ dl.invariant dt, dl.pre dt, dl.post dt {
}
dl.citelist {
- margin-bottom:50px;
+ margin-bottom:50px;
}
dl.citelist dt {
- color:var(--citation-label-color);
- float:left;
- font-weight:bold;
- margin-right:10px;
- padding:5px;
- text-align:right;
- width:52px;
+ color:var(--citation-label-color);
+ float:left;
+ font-weight:bold;
+ margin-right:10px;
+ padding:5px;
+ text-align:right;
+ width:52px;
}
dl.citelist dd {
- margin:2px 0 2px 72px;
- padding:5px 0;
+ margin:2px 0 2px 72px;
+ padding:5px 0;
}
div.toc {
- padding: 14px 25px;
- background-color: var(--toc-background-color);
- border: 1px solid var(--toc-border-color);
- border-radius: 7px 7px 7px 7px;
- float: right;
- height: auto;
- margin: 0 8px 10px 10px;
- width: 200px;
+ padding: 14px 25px;
+ background-color: var(--toc-background-color);
+ border: 1px solid var(--toc-border-color);
+ border-radius: 7px 7px 7px 7px;
+ float: right;
+ height: auto;
+ margin: 0 8px 10px 10px;
+ width: 200px;
}
div.toc li {
- background: var(--toc-down-arrow-image) no-repeat scroll 0 5px transparent;
- font: 10px/1.2 var(--font-family-toc);
- margin-top: 5px;
- padding-left: 10px;
- padding-top: 2px;
+ background: var(--toc-down-arrow-image) no-repeat scroll 0 5px transparent;
+ font: 10px/1.2 var(--font-family-toc);
+ margin-top: 5px;
+ padding-left: 10px;
+ padding-top: 2px;
}
div.toc h3 {
- font: bold 12px/1.2 var(--font-family-toc);
+ font: bold 12px/1.2 var(--font-family-toc);
color: var(--toc-header-color);
- border-bottom: 0 none;
- margin: 0;
+ border-bottom: 0 none;
+ margin: 0;
}
div.toc ul {
- list-style: none outside none;
- border: medium none;
- padding: 0px;
+ list-style: none outside none;
+ border: medium none;
+ padding: 0px;
}
div.toc li[class^='level'] {
- margin-left: 15px;
+ margin-left: 15px;
}
div.toc li.level1 {
- margin-left: 0px;
+ margin-left: 0px;
}
div.toc li.empty {
- background-image: none;
- margin-top: 0px;
+ background-image: none;
+ margin-top: 0px;
}
span.emoji {
@@ -1940,13 +2146,12 @@ span.emoji {
}
span.obfuscator {
- display: none;
+ display: none;
}
.inherit_header {
- font-weight: bold;
- color: var(--inherit-header-color);
- cursor: pointer;
+ font-weight: 400;
+ cursor: pointer;
-webkit-touch-callout: none;
-webkit-user-select: none;
-khtml-user-select: none;
@@ -1956,49 +2161,49 @@ span.obfuscator {
}
.inherit_header td {
- padding: 6px 0px 2px 5px;
+ padding: 6px 0 2px 0;
}
.inherit {
- display: none;
+ display: none;
}
tr.heading h2 {
- margin-top: 12px;
- margin-bottom: 4px;
+ margin-top: 12px;
+ margin-bottom: 12px;
}
/* tooltip related style info */
.ttc {
- position: absolute;
- display: none;
+ position: absolute;
+ display: none;
}
#powerTip {
cursor: default;
- /*white-space: nowrap;*/
- color: var(--tooltip-foreground-color);
+ color: var(--tooltip-foreground-color);
background-color: var(--tooltip-background-color);
+ backdrop-filter: var(--tooltip-backdrop-filter);
+ -webkit-backdrop-filter: var(--tooltip-backdrop-filter);
border: 1px solid var(--tooltip-border-color);
- border-radius: 4px 4px 4px 4px;
+ border-radius: 4px;
box-shadow: var(--tooltip-shadow);
display: none;
font-size: smaller;
max-width: 80%;
- opacity: 0.9;
padding: 1ex 1em 1em;
position: absolute;
z-index: 2147483647;
}
#powerTip div.ttdoc {
- color: var(--tooltip-doc-color);
+ color: var(--tooltip-doc-color);
font-style: italic;
}
#powerTip div.ttname a {
- font-weight: bold;
+ font-weight: bold;
}
#powerTip a {
@@ -2006,18 +2211,18 @@ tr.heading h2 {
}
#powerTip div.ttname {
- font-weight: bold;
+ font-weight: bold;
}
#powerTip div.ttdeci {
- color: var(--tooltip-declaration-color);
+ color: var(--tooltip-declaration-color);
}
#powerTip div {
- margin: 0px;
- padding: 0px;
- font-size: 12px;
- font-family: var(--font-family-tooltip);
+ margin: 0px;
+ padding: 0px;
+ font-size: 12px;
+ font-family: var(--font-family-tooltip);
line-height: 16px;
}
@@ -2063,7 +2268,7 @@ tr.heading h2 {
}
#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after {
- border-top-color: var(--tooltip-background-color);
+ border-top-color: var(--tooltip-arrow-background-color);
border-width: 10px;
margin: 0px -10px;
}
@@ -2091,7 +2296,7 @@ tr.heading h2 {
}
#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after {
- border-bottom-color: var(--tooltip-background-color);
+ border-bottom-color: var(--tooltip-arrow-background-color);
border-width: 10px;
margin: 0px -10px;
}
@@ -2148,29 +2353,29 @@ tr.heading h2 {
@media print
{
- #top { display: none; }
- #side-nav { display: none; }
- #nav-path { display: none; }
- body { overflow:visible; }
- h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
- .summary { display: none; }
- .memitem { page-break-inside: avoid; }
- #doc-content
- {
- margin-left:0 !important;
- height:auto !important;
- width:auto !important;
- overflow:inherit;
- display:inline;
- }
+ #top { display: none; }
+ #side-nav { display: none; }
+ #nav-path { display: none; }
+ body { overflow:visible; }
+ h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
+ .summary { display: none; }
+ .memitem { page-break-inside: avoid; }
+ #doc-content
+ {
+ margin-left:0 !important;
+ height:auto !important;
+ width:auto !important;
+ overflow:inherit;
+ display:inline;
+ }
}
/* @group Markdown */
table.markdownTable {
border-collapse:collapse;
- margin-top: 4px;
- margin-bottom: 4px;
+ margin-top: 4px;
+ margin-bottom: 4px;
}
table.markdownTable td, table.markdownTable th {
@@ -2203,11 +2408,11 @@ th.markdownTableHeadCenter, td.markdownTableBodyCenter {
tt, code, kbd
{
- display: inline-block;
+ display: inline-block;
}
tt, code, kbd
{
- vertical-align: top;
+ vertical-align: top;
}
/* @end */
@@ -2216,26 +2421,27 @@ u {
}
details>summary {
- list-style-type: none;
+ list-style-type: none;
}
details > summary::-webkit-details-marker {
- display: none;
+ display: none;
}
details>summary::before {
- content: "\25ba";
- padding-right:4px;
- font-size: 80%;
+ content: "\25ba";
+ padding-right:4px;
+ font-size: 80%;
}
details[open]>summary::before {
- content: "\25bc";
- padding-right:4px;
- font-size: 80%;
+ content: "\25bc";
+ padding-right:4px;
+ font-size: 80%;
}
-body {
+:root {
+ scrollbar-width: thin;
scrollbar-color: var(--scrollbar-thumb-color) var(--scrollbar-background-color);
}
diff --git a/docs/html/doxygen_crawl.html b/docs/html/doxygen_crawl.html
index 1a7784e..6b8ae0b 100644
--- a/docs/html/doxygen_crawl.html
+++ b/docs/html/doxygen_crawl.html
@@ -4,7 +4,7 @@
Validator / crawler helper
-
+
diff --git a/docs/html/dynsections.js b/docs/html/dynsections.js
index b05f4c8..0e15bd4 100644
--- a/docs/html/dynsections.js
+++ b/docs/html/dynsections.js
@@ -28,7 +28,6 @@ function toggleVisibility(linkObj) {
}
let dynsection = {
-
// helper function
updateStripes : function() {
$('table.directory tr').
@@ -44,15 +43,13 @@ let dynsection = {
const trigger = $('#'+base+'-trigger');
const src=$(trigger).attr('src');
if (content.is(':visible')===true) {
- content.hide();
+ content.slideUp('fast');
summary.show();
- $(linkObj).addClass('closed').removeClass('opened');
- $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png');
+ $(linkObj).find('.arrowhead').addClass('closed').removeClass('opened');
} else {
- content.show();
+ content.slideDown('fast');
summary.hide();
- $(linkObj).removeClass('closed').addClass('opened');
- $(trigger).attr('src',src.substring(0,src.length-10)+'open.png');
+ $(linkObj).find('.arrowhead').removeClass('closed').addClass('opened');
}
return false;
},
@@ -63,12 +60,12 @@ let dynsection = {
const i = $('#img'+this.id.substring(3));
const a = $('#arr'+this.id.substring(3));
if (lD3D12 Memory Allocator: Frequently asked questions
-
-
@@ -33,33 +31,22 @@
-
+
-
- Frequently asked questions
+ Frequently asked questions
What is D3D12MA?
@@ -96,18 +83,18 @@
What is the license of D3D12MA?
D3D12MA is licensed under MIT, which means it is open source and free software.
What is the purpose of D3D12MA?
-D3D12MA helps with handling one aspect of DX12 usage, which is GPU memory management - allocation of ID3D12Heap objects and creation of ID3D12Resource objects - buffers and textures.
+D3D12MA helps with handling one aspect of DX12 usage, which is GPU memory management - allocation of ID3D12Heap objects and creation of ID3D12Resource objects - buffers and textures.
Do I need to use D3D12MA?
You don't need to, but it may be beneficial in many cases. DX12 is a complex and low-level API, so libraries like this that abstract certain aspects of the API and bring them to a higher level are useful. When developing any non-trivial graphics application, you may benefit from using a memory allocator. Using D3D12MA can save time compared to implementing your own.
-In DX12 you can create each resource separately with its own implicit memory heap by calling CreateCommittedResource, but this may not be the optimal solution. For more information, see Committed versus placed resources.
+In DX12 you can create each resource separately with its own implicit memory heap by calling CreateCommittedResource, but this may not be the optimal solution. For more information, see Committed versus placed resources.
When should I not use D3D12MA?
While D3D12MA is useful for many applications that use the DX12 API, there are cases when it may be a better choice not to use it. For example, if the application is very simple, e.g. serving as a sample or a learning exercise to help you understand or teach others the basics of DX12, and it creates only a small number of buffers and textures, then including D3D12MA may be an overkill. Developing your own memory allocator may also be a good learning exercise.
What are the benefits of using D3D12MA?
-- D3D12MA allocates large blocks of
ID3D12Heap memory and sub-allocates parts of them to create your placed resources. Allocating a new block of GPU memory may be a time-consuming operation. Sub-allocating parts of a memory block requires implementing an allocation algorithm, which is a non-trivial task. D3D12MA does that, using an advanced and efficient algorithm that works well in various use cases.
+- D3D12MA allocates large blocks of ID3D12Heap memory and sub-allocates parts of them to create your placed resources. Allocating a new block of GPU memory may be a time-consuming operation. Sub-allocating parts of a memory block requires implementing an allocation algorithm, which is a non-trivial task. D3D12MA does that, using an advanced and efficient algorithm that works well in various use cases.
- D3D12MA offers a simple API that allows creating placed buffers and textures within one function call like D3D12MA::Allocator::CreateResource.
-The library is doing much more under the hood. For example, it keeps buffers separate from textures when needed, respecting D3D12_RESOURCE_HEAP_TIER. It also makes use of the "small texture alignment" automatically, so you don't need to think about it.
+The library is doing much more under the hood. For example, it keeps buffers separate from textures when needed, respecting D3D12_RESOURCE_HEAP_TIER. It also makes use of the "small texture alignment" automatically, so you don't need to think about it.
Which version should I pick?
You can just pick the latest version from the "master" branch. It is kept in a good shape most of the time, compiling and working correctly, with no compatibility-breaking changes and no unfinished code.
If you want an even more stable version, you can pick the latest official release. Current code from the master branch is occasionally tagged as a release, with CHANGELOG carefully curated to enumerate all important changes since the previous version.
@@ -119,10 +106,10 @@
I am not a fan of modern C++. Can I still use it?
Very likely yes. We acknowledge that many C++ developers, especially in the games industry, do not appreciate all the latest features that the language has to offer.
-- D3D12MA doesn't throw or catch any C++ exceptions. It reports errors by returning a
HRESULT value instead, just like DX12. If you don't use exceptions in your project, your code is not exception-safe, or even if you disable exception handling in the compiler options, you can still use D3D12MA.
-- D3D12MA doesn't use C++ run-time type information like
typeid or dynamic_cast, so if you disable RTTI in the compiler options, you can still use the library.
-- D3D12MA uses only a limited subset of standard C and C++ library. It doesn't use STL containers like
std::vector, map, or string, either in the public interface nor in the internal implementation. It implements its own containers instead.
-- If you don't use the default heap memory allocator through
malloc/free or new/delete but implement your own allocator instead, you can pass it to D3D12MA as D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks and the library will use your functions for every dynamic heap allocation made internally.
+- D3D12MA doesn't throw or catch any C++ exceptions. It reports errors by returning a HRESULT value instead, just like DX12. If you don't use exceptions in your project, your code is not exception-safe, or even if you disable exception handling in the compiler options, you can still use D3D12MA.
+- D3D12MA doesn't use C++ run-time type information like typeid or dynamic_cast, so if you disable RTTI in the compiler options, you can still use the library.
+- D3D12MA uses only a limited subset of standard C and C++ library. It doesn't use STL containers like std::vector, map, or string, either in the public interface nor in the internal implementation. It implements its own containers instead.
+- If you don't use the default heap memory allocator through malloc/free or new/delete but implement your own allocator instead, you can pass it to D3D12MA as D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks and the library will use your functions for every dynamic heap allocation made internally.
Is it available for other programming languages?
D3D12MA is a C++ library in similar style as DX12. Bindings to other programming languages are out of scope of this project, but they are welcome as external projects. Some of them are listed in README.md, "See also" section, including binding to C. Before using any of them, please check if they are still maintained and updated to use a recent version of D3D12MA.
@@ -132,7 +119,7 @@
No! While D3D12MA is published by AMD, it works on any GPU that supports DX12, whether a discrete PC graphics card or a processor integrated graphics. It doesn't give AMD GPUs any advantage over any other GPUs.
What DirectX 12 versions are supported?
D3D12MA is updated to support latest versions of DirectX 12, as available through recent retail versions of the DirectX 12 Agility SDK. Support for new features added in the preview version of the Agility SDK is developed on separate branches until they are included in the retail version.
-The library also supports older versions down to the base DX12 shipping with Windows SDK. Features added by later versions of the Agility SDK are automatically enabled conditionally using #ifdef preprocessor macros depending on the version of the SDK that you compile your project with.
+The library also supports older versions down to the base DX12 shipping with Windows SDK. Features added by later versions of the Agility SDK are automatically enabled conditionally using #ifdef preprocessor macros depending on the version of the SDK that you compile your project with.
Does it support other graphics APIs, like Vulkan(R)?
No, but we offer an equivalent library for Vulkan: Vulkan Memory Allocator. It uses the same core allocation algorithm. It also shares many features with D3D12MA, like the support for custom pools and virtual allocator. However, it is not identical in terms of the features supported. Its API also looks different, because while the interface of D3D12MA is similar in style to DX12, the interface of VMA is similar to Vulkan.
Is the library lightweight?
@@ -154,8 +141,8 @@
If you want to report a suspected bug, you can also create a ticket the same way. Before doing this, please put some effort into the investigation of whether the bug is really in the library and not in your code or in the DX12 implementation (the GPU driver) on your platform:
- Enable D3D Debug Layer and make sure it is free from any errors.
-- Make sure
D3D12MA_ASSERT is defined to an implementation that can report a failure and not ignore it.
-- Try making your allocation using pure DX12 functions like
CreateCommittedResource() rather than D3D12MA and see if the bug persists.
+- Make sure D3D12MA_ASSERT is defined to an implementation that can report a failure and not ignore it.
+- Try making your allocation using pure DX12 functions like CreateCommittedResource() rather than D3D12MA and see if the bug persists.
I found some compilation warnings. How can we fix them?
Seeing compiler warnings may be annoying to some developers, but it is a design decision to not fix all of them. Due to the nature of the C++ language, certain preprocessor macros can make some variables unused, function parameters unreferenced, or conditional expressions constant in some configurations. The code of this library should not be bigger or more complicated just to silence these warnings. It is recommended to disable such warnings instead. For more information, see Features not supported.
@@ -164,7 +151,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/files.html b/docs/html/files.html
index 0ccb6a5..5ce45bf 100644
--- a/docs/html/files.html
+++ b/docs/html/files.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: File List
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all files with brief descriptions:
[detail level 12]
- ▼ include D3D12MemAlloc.h include D3D12MemAlloc.h
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions.html b/docs/html/functions.html
index 0690bb7..e1beea4 100644
--- a/docs/html/functions.html
+++ b/docs/html/functions.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all class members with links to the classes they belong to:
-- a -
+- a -
- Alignment : D3D12MA::VIRTUAL_ALLOCATION_DESC
- Allocate() : D3D12MA::VirtualBlock
- AllocateMemory() : D3D12MA::Allocator
@@ -100,7 +87,7 @@ - a -
-- b -
+- b -
- BeginDefragmentation() : D3D12MA::Allocator, D3D12MA::Pool
- BeginPass() : D3D12MA::DefragmentationContext
- block : D3D12MA::Allocation
@@ -114,7 +101,7 @@ - b -
-- c -
+- c -
- CalculateStatistics() : D3D12MA::Allocator, D3D12MA::Pool, D3D12MA::VirtualBlock
- CALLOCATION_DESC() : D3D12MA::CALLOCATION_DESC
- Clear() : D3D12MA::VirtualBlock
@@ -134,25 +121,25 @@ - c -
-- d -
+- d -
- D3D12MA_DELETE : D3D12MA::Allocation, D3D12MA::Allocator, D3D12MA::DefragmentationContext, D3D12MA::Pool, D3D12MA::VirtualBlock
-- e -
+- e -
- EndPass() : D3D12MA::DefragmentationContext
- ExtraHeapFlags : D3D12MA::ALLOCATION_DESC
-- f -
+- f -
- Flags : D3D12MA::ALLOCATION_DESC, D3D12MA::ALLOCATOR_DESC, D3D12MA::DEFRAGMENTATION_DESC, D3D12MA::POOL_DESC, D3D12MA::VIRTUAL_ALLOCATION_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
- FreeAllocation() : D3D12MA::VirtualBlock
- FreeStatsString() : D3D12MA::Allocator, D3D12MA::VirtualBlock
-- g -
+- g -
- GetAlignment() : D3D12MA::Allocation
- GetAllocationInfo() : D3D12MA::VirtualBlock
- GetBudget() : D3D12MA::Allocator
@@ -170,7 +157,7 @@ - g -
-- h -
+- h -
- heap : D3D12MA::Allocation
- HeapFlags : D3D12MA::POOL_DESC
- HeapProperties : D3D12MA::POOL_DESC
@@ -179,7 +166,7 @@ - h -
-- i -
+- i -
- IsCacheCoherentUMA() : D3D12MA::Allocator
- IsEmpty() : D3D12MA::VirtualBlock
- IsGPUUploadHeapSupported() : D3D12MA::Allocator
@@ -187,12 +174,12 @@ - i -
-- l -
+- l -
- list : D3D12MA::Allocation
-- m -
+- m -
- m_Committed : D3D12MA::Allocation
- m_Heap : D3D12MA::Allocation
- m_Placed : D3D12MA::Allocation
@@ -206,18 +193,18 @@ - m -
-- n -
+- n -
- next : D3D12MA::Allocation
-- o -
+- o -
- Offset : D3D12MA::VIRTUAL_ALLOCATION_INFO
- Operation : D3D12MA::DEFRAGMENTATION_MOVE
-- p -
+- p -
- pAdapter : D3D12MA::ALLOCATOR_DESC
- pAllocate : D3D12MA::ALLOCATION_CALLBACKS
- pAllocationCallbacks : D3D12MA::ALLOCATOR_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
@@ -233,12 +220,12 @@ - p -
-- r -
+- r -
- ResidencyPriority : D3D12MA::POOL_DESC
-- s -
+- s -
- SetAllocationPrivateData() : D3D12MA::VirtualBlock
- SetCurrentFrameIndex() : D3D12MA::Allocator
- SetName() : D3D12MA::Allocation, D3D12MA::Pool
@@ -249,12 +236,12 @@ - s -
-- t -
+- t -
- Total : D3D12MA::TotalStatistics
-- u -
+- u -
- UnusedRangeCount : D3D12MA::DetailedStatistics
- UnusedRangeSizeMax : D3D12MA::DetailedStatistics
- UnusedRangeSizeMin : D3D12MA::DetailedStatistics
@@ -263,7 +250,7 @@ - u -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html
index 23515d8..8f38cf0 100644
--- a/docs/html/functions_func.html
+++ b/docs/html/functions_func.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members - Functions
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all functions with links to the classes they belong to:
-- a -
+- a -
- Allocate() : D3D12MA::VirtualBlock
- AllocateMemory() : D3D12MA::Allocator
-- b -
+- b -
- BeginDefragmentation() : D3D12MA::Allocator, D3D12MA::Pool
- BeginPass() : D3D12MA::DefragmentationContext
- BuildStatsString() : D3D12MA::Allocator, D3D12MA::VirtualBlock
-- c -
+- c -
- CalculateStatistics() : D3D12MA::Allocator, D3D12MA::Pool, D3D12MA::VirtualBlock
- CALLOCATION_DESC() : D3D12MA::CALLOCATION_DESC
- Clear() : D3D12MA::VirtualBlock
@@ -116,18 +103,18 @@ - c -
-- e -
+- e -
- EndPass() : D3D12MA::DefragmentationContext
-- f -
+- f -
- FreeAllocation() : D3D12MA::VirtualBlock
- FreeStatsString() : D3D12MA::Allocator, D3D12MA::VirtualBlock
-- g -
+- g -
- GetAlignment() : D3D12MA::Allocation
- GetAllocationInfo() : D3D12MA::VirtualBlock
- GetBudget() : D3D12MA::Allocator
@@ -145,7 +132,7 @@ - g -
-- i -
+- i -
- IsCacheCoherentUMA() : D3D12MA::Allocator
- IsEmpty() : D3D12MA::VirtualBlock
- IsGPUUploadHeapSupported() : D3D12MA::Allocator
@@ -153,7 +140,7 @@ - i -
-- s -
+- s -
- SetAllocationPrivateData() : D3D12MA::VirtualBlock
- SetCurrentFrameIndex() : D3D12MA::Allocator
- SetName() : D3D12MA::Allocation, D3D12MA::Pool
@@ -163,7 +150,7 @@ - s -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions_rela.html b/docs/html/functions_rela.html
index b9d0728..f21eddd 100644
--- a/docs/html/functions_rela.html
+++ b/docs/html/functions_rela.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members - Related Symbols
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions_vars.html b/docs/html/functions_vars.html
index f63ab83..fe4ed5f 100644
--- a/docs/html/functions_vars.html
+++ b/docs/html/functions_vars.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members - Variables
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all variables with links to the classes they belong to:
-- a -
+- a -
- Alignment : D3D12MA::VIRTUAL_ALLOCATION_DESC
- AllocationBytes : D3D12MA::Statistics
- AllocationCount : D3D12MA::Statistics
@@ -98,7 +85,7 @@ - a -
-- b -
+- b -
- block : D3D12MA::Allocation
- BlockBytes : D3D12MA::Statistics
- BlockCount : D3D12MA::Statistics
@@ -109,22 +96,22 @@ - b -
-- c -
+- c -
- CustomPool : D3D12MA::ALLOCATION_DESC
-- e -
+- e -
- ExtraHeapFlags : D3D12MA::ALLOCATION_DESC
-- f -
+- f -
- Flags : D3D12MA::ALLOCATION_DESC, D3D12MA::ALLOCATOR_DESC, D3D12MA::DEFRAGMENTATION_DESC, D3D12MA::POOL_DESC, D3D12MA::VIRTUAL_ALLOCATION_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
-- h -
+- h -
- heap : D3D12MA::Allocation
- HeapFlags : D3D12MA::POOL_DESC
- HeapProperties : D3D12MA::POOL_DESC
@@ -133,12 +120,12 @@ - h -
-- l -
+- l -
- list : D3D12MA::Allocation
-- m -
+- m -
- m_Committed : D3D12MA::Allocation
- m_Heap : D3D12MA::Allocation
- m_Placed : D3D12MA::Allocation
@@ -152,18 +139,18 @@ - m -
-- n -
+- n -
- next : D3D12MA::Allocation
-- o -
+- o -
- Offset : D3D12MA::VIRTUAL_ALLOCATION_INFO
- Operation : D3D12MA::DEFRAGMENTATION_MOVE
-- p -
+- p -
- pAdapter : D3D12MA::ALLOCATOR_DESC
- pAllocate : D3D12MA::ALLOCATION_CALLBACKS
- pAllocationCallbacks : D3D12MA::ALLOCATOR_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
@@ -179,23 +166,23 @@ - p -
-- r -
+- r -
- ResidencyPriority : D3D12MA::POOL_DESC
-- s -
+- s -
- Size : D3D12MA::VIRTUAL_ALLOCATION_DESC, D3D12MA::VIRTUAL_ALLOCATION_INFO, D3D12MA::VIRTUAL_BLOCK_DESC
- Stats : D3D12MA::Budget, D3D12MA::DetailedStatistics
-- t -
+- t -
- Total : D3D12MA::TotalStatistics
-- u -
+- u -
- UnusedRangeCount : D3D12MA::DetailedStatistics
- UnusedRangeSizeMax : D3D12MA::DetailedStatistics
- UnusedRangeSizeMin : D3D12MA::DetailedStatistics
@@ -204,7 +191,7 @@ - u -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/general_considerations.html b/docs/html/general_considerations.html
index ef3888a..05a30ff 100644
--- a/docs/html/general_considerations.html
+++ b/docs/html/general_considerations.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: General considerations
-
-
@@ -33,33 +31,22 @@
-
+
-
- General considerations
+ General considerations
-
+
Thread safety
-- The library has no global state, so separate D3D12MA::Allocator objects can be used independently. In typical applications there should be no need to create multiple such objects though - one per
ID3D12Device is enough.
+- The library has no global state, so separate D3D12MA::Allocator objects can be used independently. In typical applications there should be no need to create multiple such objects though - one per ID3D12Device is enough.
- All calls to methods of D3D12MA::Allocator class are safe to be made from multiple threads simultaneously because they are synchronized internally when needed.
- When the allocator is created with D3D12MA::ALLOCATOR_FLAG_SINGLETHREADED, calls to methods of D3D12MA::Allocator class must be made from a single thread or synchronized by the user. Using this flag may improve performance.
- D3D12MA::VirtualBlock is not safe to be used from multiple threads simultaneously.
-
+
Versioning and compatibility
The library uses Semantic Versioning, which means version numbers follow convention: Major.Minor.Patch (e.g. 2.3.0), where:
@@ -109,13 +96,13 @@ <
All changes between official releases are documented in file "CHANGELOG.md".
- Warning
- Backward compatiblity is considered on the level of C++ source code, not binary linkage. Adding new members to existing structures is treated as backward compatible if initializing the new members to binary zero results in the old behavior. You should always fully initialize all library structures to zeros and not rely on their exact binary size.
-
+
Features not supported
Features deliberately excluded from the scope of this library:
- Descriptor allocation. Although also called "heaps", objects that represent descriptors are separate part of the D3D12 API from buffers and textures. You can still use Virtual allocator to manage descriptors and their ranges inside a descriptor heap.
- Support for reserved (tiled) resources. We don't recommend using them. For more information, see [1].
-- Support for
ID3D12Device::Evict and MakeResident. We don't recommend using them. You can call them on the D3D12 objects manually. Plese keep in mind, however, that eviction happens on the level of entire ID3D12Heap memory blocks and not individual buffers or textures which may be placed inside them.
+- Support for ID3D12Device::Evict and MakeResident. We don't recommend using them. You can call them on the D3D12 objects manually. Plese keep in mind, however, that eviction happens on the level of entire ID3D12Heap memory blocks and not individual buffers or textures which may be placed inside them.
- Handling CPU memory allocation failures. When dynamically creating small C++ objects in CPU memory (not the GPU memory), allocation failures are not handled gracefully, because that would complicate code significantly and is usually not needed in desktop PC applications anyway. Success of an allocation is just checked with an assert.
- Code free of any compiler warnings. There are many preprocessor macros that make some variables unused, function parameters unreferenced, or conditional expressions constant in some configurations. The code of this library should not be bigger or more complicated just to silence these warnings. It is recommended to disable such warnings instead.
- This is a C++ library. Bindings or ports to any other programming languages are welcome as external projects but are not going to be included into this repository.
@@ -125,7 +112,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/globals.html b/docs/html/globals.html
index 00f8dbd..27989c1 100644
--- a/docs/html/globals.html
+++ b/docs/html/globals.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: File Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/globals_defs.html b/docs/html/globals_defs.html
index feb2e5c..00db10d 100644
--- a/docs/html/globals_defs.html
+++ b/docs/html/globals_defs.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: File Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html
index 292f556..5785855 100644
--- a/docs/html/hierarchy.html
+++ b/docs/html/hierarchy.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Hierarchy
-
-
@@ -33,35 +31,24 @@
-
+
-
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 12]
CD3D12MA::ALLOCATION_CALLBACKS Custom callbacks to CPU memory allocation functions ▼CD3D12MA::ALLOCATION_DESC Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource CD3D12MA::ALLOCATION_DESC Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource CD3D12MA::CALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure CD3D12MA::ALLOCATOR_DESC Parameters of created Allocator object. To be used with CreateAllocator() CD3D12MA::Budget Statistics of current memory usage and available budget for a specific memory segment group CD3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Parameters for incremental defragmentation steps CD3D12MA::DEFRAGMENTATION_STATS Statistics returned for defragmentation process by function DefragmentationContext::GetStats() CD3D12MA::DetailedStatistics More detailed statistics than D3D12MA::Statistics ▼CIUnknownImpl CIUnknownImpl CD3D12MA::Allocation Represents single memory allocation CD3D12MA::Allocator Represents main object of this library initialized for particular ID3D12Device CD3D12MA::Allocator Represents main object of this library initialized for particular ID3D12Device CD3D12MA::DefragmentationContext Represents defragmentation process in progress CD3D12MA::Pool Custom memory pool CD3D12MA::VirtualBlock Represents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory ▼CD3D12MA::POOL_DESC Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool CD3D12MA::POOL_DESC Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool CD3D12MA::CPOOL_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure CD3D12MA::Statistics Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total CD3D12MA::TotalStatistics General statistics from current state of the allocator - total memory usage across all memory heaps and segments ▼CD3D12MA::VIRTUAL_ALLOCATION_DESC Parameters of created virtual allocation to be passed to VirtualBlock::Allocate() CD3D12MA::VIRTUAL_ALLOCATION_DESC Parameters of created virtual allocation to be passed to VirtualBlock::Allocate() CD3D12MA::CVIRTUAL_ALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure CD3D12MA::VIRTUAL_ALLOCATION_INFO Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo() ▼CD3D12MA::VIRTUAL_BLOCK_DESC Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock() CD3D12MA::VIRTUAL_BLOCK_DESC Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock() CD3D12MA::CVIRTUAL_BLOCK_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure CD3D12MA::VirtualAllocation Represents single memory allocation done inside VirtualBlock
@@ -120,7 +107,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/index.html b/docs/html/index.html
index e005026..d7434ba 100644
--- a/docs/html/index.html
+++ b/docs/html/index.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12 Memory Allocator
-
-
@@ -33,35 +31,24 @@
-
+
-
D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved.
License: MIT
-Documentation of all members: D3D12MemAlloc.h
-
+
Documentation of all members: D3D12MemAlloc.h
+
Table of contents
- Frequently asked questions
@@ -131,10 +118,10 @@
-
+
Web links
-- Direct3D 12 Memory Allocator at GPUOpen.com - product page
+- Direct3D 12 Memory Allocator at GPUOpen.com - product page
- GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com - source code repository
@@ -142,7 +129,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/linear_algorithm.html b/docs/html/linear_algorithm.html
index 25d5301..0bc59b0 100644
--- a/docs/html/linear_algorithm.html
+++ b/docs/html/linear_algorithm.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Linear allocation algorithm
-
-
@@ -33,33 +31,22 @@
-
+
-
- Linear allocation algorithm
+ Linear allocation algorithm
Each D3D12 memory block managed by this library has accompanying metadata that keeps track of used and unused regions. By default, the metadata structure and algorithm tries to find best place for new allocations among free regions to optimize memory usage. This way you can allocate and free objects in any order.
@@ -96,17 +83,17 @@
Sometimes there is a need to use simpler, linear allocation algorithm. You can create custom pool that uses such algorithm by adding flag D3D12MA::POOL_FLAG_ALGORITHM_LINEAR to D3D12MA::POOL_DESC::Flags while creating D3D12MA::Pool object. Then an alternative metadata management is used. It always creates new allocations after last one and doesn't reuse free regions after allocations freed in the middle. It results in better allocation performance and less memory consumed by metadata.
With this one flag, you can create a custom pool that can be used in many ways: free-at-once, stack, double stack, and ring buffer. See below for details. You don't need to specify explicitly which of these options you are going to use - it is detected automatically.
-
+
Free-at-once
-
In a pool that uses linear algorithm, you still need to free all the allocations individually by calling allocation->Release(). You can free them in any order. New allocations are always made after last one - free space in the middle is not reused. However, when you release all the allocation and the pool becomes empty, allocation starts from the beginning again. This way you can use linear algorithm to speed up creation of allocations that you are going to release all at once.
+In a pool that uses linear algorithm, you still need to free all the allocations individually by calling allocation->Release(). You can free them in any order. New allocations are always made after last one - free space in the middle is not reused. However, when you release all the allocation and the pool becomes empty, allocation starts from the beginning again. This way you can use linear algorithm to speed up creation of allocations that you are going to release all at once.
This mode is also available for pools created with D3D12MA::POOL_DESC::MaxBlockCount value that allows multiple memory blocks.
-
+
Stack
When you free an allocation that was created last, its space can be reused. Thanks to this, if you always release allocations in the order opposite to their creation (LIFO - Last In First Out), you can achieve behavior of a stack.
This mode is also available for pools created with D3D12MA::POOL_DESC::MaxBlockCount value that allows multiple memory blocks.
-
+
Double stack
The space reserved by a custom pool with linear algorithm may be used by two stacks:
@@ -116,20 +103,20 @@
To make allocation from the upper stack, add flag D3D12MA::ALLOCATION_FLAG_UPPER_ADDRESS to D3D12MA::ALLOCATION_DESC::Flags.
Double stack is available only in pools with one memory block - D3D12MA::POOL_DESC::MaxBlockCount must be 1. Otherwise behavior is undefined.
-When the two stacks' ends meet so there is not enough space between them for a new allocation, such allocation fails with usual E_OUTOFMEMORY error.
-
+
When the two stacks' ends meet so there is not enough space between them for a new allocation, such allocation fails with usual E_OUTOFMEMORY error.
+
Ring buffer
When you free some allocations from the beginning and there is not enough free space for a new one at the end of a pool, allocator's "cursor" wraps around to the beginning and starts allocation there. Thanks to this, if you always release allocations in the same order as you created them (FIFO - First In First Out), you can achieve behavior of a ring buffer / queue.
Ring buffer is available only in pools with one memory block - D3D12MA::POOL_DESC::MaxBlockCount must be 1. Otherwise behavior is undefined.
-
+
Additional considerations
Linear algorithm can also be used with Virtual allocator. See flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/menu.js b/docs/html/menu.js
index 0fd1e99..15f9c52 100644
--- a/docs/html/menu.js
+++ b/docs/html/menu.js
@@ -49,7 +49,7 @@ function initMenu(relPath,searchEnabled,serverSide,searchPage,search,treeview) {
searchBoxHtml=''+
''+
'');
$('#main-nav').append(makeTree(menudata,relPath));
$('#main-nav').children(':first').addClass('sm sm-dox').attr('id','main-menu');
- if (searchBoxHtml) {
- $('#main-menu').append('');
- }
+ $('#main-menu').append('');
const $mainMenuState = $('#main-menu-state');
let prevWidth = 0;
if ($mainMenuState.length) {
diff --git a/docs/html/namespace_d3_d12_m_a.html b/docs/html/namespace_d3_d12_m_a.html
index e770fdc..b4ae5de 100644
--- a/docs/html/namespace_d3_d12_m_a.html
+++ b/docs/html/namespace_d3_d12_m_a.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA Namespace Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
-
+
Classes
class Allocation class Allocation Represents single memory allocation. More...
struct ALLOCATION_CALLBACKS struct ALLOCATION_CALLBACKS Custom callbacks to CPU memory allocation functions. More...
struct ALLOCATION_DESC struct ALLOCATION_DESC Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource. More...
class Allocator Represents main object of this library initialized for particular ID3D12Device. More...
struct ALLOCATOR_DESC class Allocator Represents main object of this library initialized for particular ID3D12Device. More...
struct ALLOCATOR_DESC Parameters of created Allocator object. To be used with CreateAllocator(). More...
struct Budget struct Budget Statistics of current memory usage and available budget for a specific memory segment group. More...
struct CALLOCATION_DESC struct CALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure. More...
struct CPOOL_DESC struct CPOOL_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure. More...
struct CVIRTUAL_ALLOCATION_DESC struct CVIRTUAL_ALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure. More...
struct CVIRTUAL_BLOCK_DESC struct CVIRTUAL_BLOCK_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure. More...
struct DEFRAGMENTATION_DESC struct DEFRAGMENTATION_DESC Parameters for defragmentation. More...
struct DEFRAGMENTATION_MOVE struct DEFRAGMENTATION_MOVE Single move of an allocation to be done for defragmentation. More...
struct DEFRAGMENTATION_PASS_MOVE_INFO struct DEFRAGMENTATION_PASS_MOVE_INFO Parameters for incremental defragmentation steps. More...
struct DEFRAGMENTATION_STATS struct DEFRAGMENTATION_STATS Statistics returned for defragmentation process by function DefragmentationContext::GetStats(). More...
class DefragmentationContext class DefragmentationContext Represents defragmentation process in progress. More...
struct DetailedStatistics struct DetailedStatistics More detailed statistics than D3D12MA::Statistics. More...
class Pool class Pool Custom memory pool. More...
struct POOL_DESC struct POOL_DESC Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool. More...
struct Statistics struct Statistics Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total. More...
struct TotalStatistics struct TotalStatistics General statistics from current state of the allocator - total memory usage across all memory heaps and segments. More...
struct VIRTUAL_ALLOCATION_DESC struct VIRTUAL_ALLOCATION_DESC Parameters of created virtual allocation to be passed to VirtualBlock::Allocate(). More...
struct VIRTUAL_ALLOCATION_INFO struct VIRTUAL_ALLOCATION_INFO Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo(). More...
struct VIRTUAL_BLOCK_DESC struct VIRTUAL_BLOCK_DESC Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock(). More...
struct VirtualAllocation struct VirtualAllocation Represents single memory allocation done inside VirtualBlock. More...
class VirtualBlock class VirtualBlock Represents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory. More...
-
+
Typedefs
typedef UINT64 AllocHandle Unique identifier of single allocation done inside the memory heap.
using ALLOCATE_FUNC_PTR = void* (*)(size_t Size, size_t Alignment, void* pPrivateData) Pointer to custom callback function that allocates CPU memory.
using FREE_FUNC_PTR = void (*)(void* pMemory, void* pPrivateData) Pointer to custom callback function that deallocates CPU memory.
-
+
Enumerations
enum ALLOCATION_FLAGS {
ALLOCATION_FLAG_NONE = 0
@@ -203,20 +162,17 @@
} Bit flags to be used with ALLOCATION_DESC::Flags. More...
enum DEFRAGMENTATION_FLAGS { DEFRAGMENTATION_FLAG_ALGORITHM_FAST = 0x1
, DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED = 0x2
, DEFRAGMENTATION_FLAG_ALGORITHM_FULL = 0x4
, DEFRAGMENTATION_FLAG_ALGORITHM_MASK
} Flags to be passed as DEFRAGMENTATION_DESC::Flags. More...
enum DEFRAGMENTATION_MOVE_OPERATION { DEFRAGMENTATION_MOVE_OPERATION_COPY = 0
, DEFRAGMENTATION_MOVE_OPERATION_IGNORE = 1
, DEFRAGMENTATION_MOVE_OPERATION_DESTROY = 2
} Operation performed on single defragmentation move. More...
enum POOL_FLAGS {
POOL_FLAG_NONE = 0
, POOL_FLAG_ALGORITHM_LINEAR = 0x1
@@ -227,7 +183,6 @@
} Bit flags to be used with POOL_DESC::Flags. More...
enum ALLOCATOR_FLAGS {
ALLOCATOR_FLAG_NONE = 0
, ALLOCATOR_FLAG_SINGLETHREADED = 0x1
@@ -239,13 +194,11 @@
} Bit flags to be used with ALLOCATOR_DESC::Flags. More...
enum VIRTUAL_BLOCK_FLAGS { VIRTUAL_BLOCK_FLAG_NONE = 0
, VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR = POOL_FLAG_ALGORITHM_LINEAR
, VIRTUAL_BLOCK_FLAG_ALGORITHM_MASK = POOL_FLAG_ALGORITHM_MASK
} Bit flags to be used with VIRTUAL_BLOCK_DESC::Flags. More...
enum VIRTUAL_ALLOCATION_FLAGS {
VIRTUAL_ALLOCATION_FLAG_NONE = 0
, VIRTUAL_ALLOCATION_FLAG_UPPER_ADDRESS = ALLOCATION_FLAG_UPPER_ADDRESS
@@ -257,18 +210,15 @@
} Bit flags to be used with VIRTUAL_ALLOCATION_DESC::Flags. More...
-
+
Functions
D3D12MA_API HRESULT CreateAllocator (const ALLOCATOR_DESC *pDesc, Allocator **ppAllocator) Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
D3D12MA_API HRESULT CreateVirtualBlock (const VIRTUAL_BLOCK_DESC *pDesc, VirtualBlock **ppVirtualBlock) Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
-Typedef Documentation
+Typedef Documentation
◆ ALLOCATE_FUNC_PTR
@@ -314,11 +264,11 @@
Pointer to custom callback function that deallocates CPU memory.
-pMemory = null should be accepted and ignored.
+pMemory = null should be accepted and ignored.
-Enumeration Type Documentation
+Enumeration Type Documentation
◆ ALLOCATION_FLAGS
@@ -338,21 +288,21 @@ ALLOCATION_FLAG_COMMITTED Set this flag if the allocation should have its own dedicated memory allocation (committed resource with implicit heap).
Use it for special, big resources, like fullscreen textures used as render targets.
-- When used with functions like D3D12MA::Allocator::CreateResource, it will use
ID3D12Device::CreateCommittedResource, so the created allocation will contain a resource (D3D12MA::Allocation::GetResource() != NULL) but will not have a heap (D3D12MA::Allocation::GetHeap() == NULL), as the heap is implicit.
-- When used with raw memory allocation like D3D12MA::Allocator::AllocateMemory, it will use
ID3D12Device::CreateHeap, so the created allocation will contain a heap (D3D12MA::Allocation::GetHeap() != NULL) and its offset will always be 0.
+- When used with functions like D3D12MA::Allocator::CreateResource, it will use ID3D12Device::CreateCommittedResource, so the created allocation will contain a resource (D3D12MA::Allocation::GetResource() != NULL) but will not have a heap (D3D12MA::Allocation::GetHeap() == NULL), as the heap is implicit.
+- When used with raw memory allocation like D3D12MA::Allocator::AllocateMemory, it will use ID3D12Device::CreateHeap, so the created allocation will contain a heap (D3D12MA::Allocation::GetHeap() != NULL) and its offset will always be 0.
ALLOCATION_FLAG_NEVER_ALLOCATE Set this flag to only try to allocate from existing memory heaps and never create new such heap.
-If new allocation cannot be placed in any of the existing heaps, allocation fails with E_OUTOFMEMORY error.
+If new allocation cannot be placed in any of the existing heaps, allocation fails with E_OUTOFMEMORY error.
You should not use D3D12MA::ALLOCATION_FLAG_COMMITTED and D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE at the same time. It makes no sense.
ALLOCATION_FLAG_WITHIN_BUDGET Create allocation only if additional memory required for it, if any, won't exceed memory budget. Otherwise return E_OUTOFMEMORY.
+ALLOCATION_FLAG_WITHIN_BUDGET Create allocation only if additional memory required for it, if any, won't exceed memory budget. Otherwise return E_OUTOFMEMORY.
ALLOCATION_FLAG_UPPER_ADDRESS Allocation will be created from upper stack in a double stack pool.
This flag is only allowed for custom pools created with POOL_FLAG_ALGORITHM_LINEAR flag.
ALLOCATION_FLAG_CAN_ALIAS Set this flag if the allocated memory will have aliasing resources.
-Use this when calling D3D12MA::Allocator::CreateResource() and similar to guarantee creation of explicit heap for desired allocation and prevent it from using CreateCommittedResource, so that new allocation object will always have allocation->GetHeap() != NULL.
+Use this when calling D3D12MA::Allocator::CreateResource() and similar to guarantee creation of explicit heap for desired allocation and prevent it from using CreateCommittedResource, so that new allocation object will always have allocation->GetHeap() != NULL.
ALLOCATION_FLAG_STRATEGY_MIN_MEMORY Allocation strategy that chooses smallest possible free range for the allocation to minimize memory usage and fragmentation, possibly at the expense of allocation time.
ALLOCATION_FLAG_STRATEGY_FIRST_FIT Alias to ALLOCATION_FLAG_STRATEGY_MIN_TIME.
ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
+ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
ALLOCATOR_FLAG_ALWAYS_COMMITTED Every allocation will be created as a committed resource - will have its own memory block.
Affects both default pools and custom pools. To be used for debugging purposes only. There is also an equivalent flag for custom pools: D3D12MA::POOL_FLAG_ALWAYS_COMMITTED.
ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED Heaps created for the default pools will be created with flag D3D12_HEAP_FLAG_CREATE_NOT_ZEROED, allowing for their memory to be not zeroed by the system if possible, which can speed up allocation.
+ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED Heaps created for the default pools will be created with flag D3D12_HEAP_FLAG_CREATE_NOT_ZEROED, allowing for their memory to be not zeroed by the system if possible, which can speed up allocation.
Only affects default pools. To use the flag with Custom memory pools, you need to add it manually:
poolDesc.heapFlags |= D3D12_HEAP_FLAG_CREATE_NOT_ZEROED;
-Only avaiable if ID3D12Device8 is present. Otherwise, the flag is ignored.
+Only avaiable if ID3D12Device8 is present. Otherwise, the flag is ignored.
ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED Optimization, allocate MSAA textures as committed resources always.
Specify this flag to create MSAA textures with implicit heaps, as if they were created with flag D3D12MA::ALLOCATION_FLAG_COMMITTED. Usage of this flags enables all default pools to create its heaps on smaller alignment not suitable for MSAA textures.
@@ -424,11 +374,11 @@
Enumerator DEFRAGMENTATION_FLAG_ALGORITHM_FAST Use simple but fast algorithm for defragmentation. May not achieve best results but will require least time to compute and least allocations to copy.
DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED Default defragmentation algorithm, applied also when no ALGORITHM flag is specified. Offers a balance between defragmentation quality and the amount of allocations and bytes that need to be moved.
+DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED Default defragmentation algorithm, applied also when no ALGORITHM flag is specified. Offers a balance between defragmentation quality and the amount of allocations and bytes that need to be moved.
DEFRAGMENTATION_FLAG_ALGORITHM_FULL Perform full defragmentation of memory. Can result in notably more time to compute and allocations to copy, but will achieve best memory packing.
DEFRAGMENTATION_FLAG_ALGORITHM_MASK A bit mask to extract only ALGORITHM bits from entire set of flags.
+DEFRAGMENTATION_FLAG_ALGORITHM_MASK A bit mask to extract only ALGORITHM bits from entire set of flags.
-Enumerator DEFRAGMENTATION_MOVE_OPERATION_COPY Resource has been recreated at pDstTmpAllocation, data has been copied, old resource has been destroyed. pSrcAllocation will be changed to point to the new place. This is the default value set by DefragmentationContext::BeginPass().
+Enumerator DEFRAGMENTATION_MOVE_OPERATION_COPY Resource has been recreated at pDstTmpAllocation, data has been copied, old resource has been destroyed. pSrcAllocation will be changed to point to the new place. This is the default value set by DefragmentationContext::BeginPass().
DEFRAGMENTATION_MOVE_OPERATION_IGNORE Set this value if you cannot move the allocation. New place reserved at pDstTmpAllocation will be freed. pSrcAllocation will remain unchanged.
+DEFRAGMENTATION_MOVE_OPERATION_IGNORE Set this value if you cannot move the allocation. New place reserved at pDstTmpAllocation will be freed. pSrcAllocation will remain unchanged.
DEFRAGMENTATION_MOVE_OPERATION_DESTROY Set this value if you decide to abandon the allocation and you destroyed the resource. New place reserved pDstTmpAllocation will be freed, along with pSrcAllocation.
+DEFRAGMENTATION_MOVE_OPERATION_DESTROY Set this value if you decide to abandon the allocation and you destroyed the resource. New place reserved pDstTmpAllocation will be freed, along with pSrcAllocation.
VIRTUAL_ALLOCATION_FLAG_STRATEGY_MIN_OFFSET
Allocation strategy that chooses always the lowest offset in available space. This is not the most efficient strategy but achieves highly packed data.
VIRTUAL_ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
+VIRTUAL_ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
These strategy flags are binary compatible with equivalent flags in ALLOCATION_FLAGS.
Function Documentation
+Function Documentation
◆ CreateAllocator()
@@ -567,8 +517,8 @@
-Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
-You normally only need to call it once and keep a single Allocator object for your ID3D12Device.
+Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
+You normally only need to call it once and keep a single Allocator object for your ID3D12Device.
@@ -591,7 +541,7 @@
-Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
+Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
Note you don't need to create D3D12MA::Allocator to use virtual blocks.
@@ -599,7 +549,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers.html b/docs/html/namespacemembers.html
index 6881ab0..4cadc29 100644
--- a/docs/html/namespacemembers.html
+++ b/docs/html/namespacemembers.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all namespace members with links to the namespace documentation for each member:
-- a -
+- a -
- ALLOCATE_FUNC_PTR : D3D12MA
- ALLOCATION_FLAG_CAN_ALIAS : D3D12MA
- ALLOCATION_FLAG_COMMITTED : D3D12MA
@@ -112,13 +99,13 @@ - a -
-- c -
+- c -
-- d -
+- d -
- DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FAST : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FULL : D3D12MA
@@ -131,12 +118,12 @@ - d -
-- f -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_enum.html b/docs/html/namespacemembers_enum.html
index 5723a6b..90ffd55 100644
--- a/docs/html/namespacemembers_enum.html
+++ b/docs/html/namespacemembers_enum.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_eval.html b/docs/html/namespacemembers_eval.html
index 365527c..4a4922b 100644
--- a/docs/html/namespacemembers_eval.html
+++ b/docs/html/namespacemembers_eval.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all namespace enum values with links to the namespace documentation for each enum value:
-- a -
+- a -
- ALLOCATION_FLAG_CAN_ALIAS : D3D12MA
- ALLOCATION_FLAG_COMMITTED : D3D12MA
- ALLOCATION_FLAG_NEVER_ALLOCATE : D3D12MA
@@ -108,7 +95,7 @@ - a -
-- d -
+- d -
- DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FAST : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FULL : D3D12MA
@@ -119,7 +106,7 @@ - d -
-- p -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_func.html b/docs/html/namespacemembers_func.html
index 02a9cdd..c8a70c7 100644
--- a/docs/html/namespacemembers_func.html
+++ b/docs/html/namespacemembers_func.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_type.html b/docs/html/namespacemembers_type.html
index b56e9c4..e9561e2 100644
--- a/docs/html/namespacemembers_type.html
+++ b/docs/html/namespacemembers_type.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespaces.html b/docs/html/namespaces.html
index fe8ddce..acd9768 100644
--- a/docs/html/namespaces.html
+++ b/docs/html/namespaces.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace List
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/navtree.css b/docs/html/navtree.css
index 69211d4..0ea3a07 100644
--- a/docs/html/navtree.css
+++ b/docs/html/navtree.css
@@ -11,8 +11,8 @@
#nav-tree li {
white-space:nowrap;
- margin:0px;
- padding:0px;
+ margin:0;
+ padding:0;
}
#nav-tree .plus {
@@ -20,15 +20,10 @@
}
#nav-tree .selected {
- background-image: url('tab_a.png');
- background-repeat:repeat-x;
- color: var(--nav-text-active-color);
- text-shadow: var(--nav-text-active-shadow);
-}
-
-#nav-tree .selected .arrow {
- color: var(--nav-arrow-selected-color);
- text-shadow: none;
+ position: relative;
+ background-color: var(--nav-menu-active-bg);
+ border-radius: 0 6px 6px 0;
+ /*margin-right: 5px;*/
}
#nav-tree img {
@@ -48,6 +43,7 @@
margin:0px;
padding:0px;
font: 12px var(--font-family-nav);
+ line-height: 22px;
}
#nav-tree .label a {
@@ -56,7 +52,7 @@
#nav-tree .selected a {
text-decoration:none;
- color:var(--nav-text-active-color);
+ color:var(--page-link-color);
}
#nav-tree .children_ul {
@@ -65,8 +61,9 @@
}
#nav-tree .item {
- margin:0px;
- padding:0px;
+ margin: 0 6px 0 -5px;
+ padding: 0 0 0 5px;
+ height: 22px;
}
#nav-tree {
@@ -89,7 +86,6 @@
display:block;
position: absolute;
left: 0px;
- width: $width;
overflow : hidden;
}
@@ -98,15 +94,31 @@
}
.ui-resizable-e {
- background-image:var(--nav-splitbar-image);
- background-size:100%;
- background-repeat:repeat-y;
- background-attachment: scroll;
- cursor:ew-resize;
+ transition: opacity 0.5s ease;
+ background-color: var(--nav-splitbar-bg-color);
+ opacity:0;
+ cursor:col-resize;
height:100%;
right:0;
top:0;
width:6px;
+ position: relative;
+}
+
+.ui-resizable-e:after {
+ content: '';
+ display: block;
+ top: 50%;
+ left: 1px;
+ width: 2px;
+ height: 15px;
+ border-left: 1px solid var(--nav-splitbar-handle-color);
+ border-right: 1px solid var(--nav-splitbar-handle-color);
+ position: absolute;
+}
+
+.ui-resizable-e:hover {
+ opacity: 1;
}
.ui-resizable-handle {
@@ -121,24 +133,97 @@
}
#nav-tree {
- background-repeat:repeat-x;
background-color: var(--nav-background-color);
-webkit-overflow-scrolling : touch; /* iOS 5+ */
+ scrollbar-width: thin;
+ border-right: 1px solid var(--nav-border-color);
+ padding-left: 5px;
}
#nav-sync {
position:absolute;
- top:5px;
- right:24px;
- z-index:0;
+ top:0px;
+ right:0px;
+ z-index:1;
}
#nav-sync img {
opacity:0.3;
}
-#nav-sync img:hover {
- opacity:0.9;
+div.nav-sync-icon {
+ position: relative;
+ width: 24px;
+ height: 17px;
+ left: -6px;
+ top: -1px;
+ opacity: 0.7;
+ display: inline-block;
+ background-color: var(--sync-icon-background-color);
+ border: 1px solid var(--sync-icon-border-color);
+ box-sizing: content-box;
+}
+
+div.nav-sync-icon:hover {
+ background-color: var(--sync-icon-selected-background-color);
+ opacity: 1.0;
+}
+
+div.nav-sync-icon.active:after {
+ content: '';
+ background-color: var(--sync-icon-background-color);
+ border-top: 2px solid var(--sync-icon-color);
+ position: absolute;
+ width: 16px;
+ height: 0px;
+ top: 7px;
+ left: 4px;
+}
+
+div.nav-sync-icon.active:hover:after {
+ border-top: 2px solid var(--sync-icon-selected-color);
+}
+
+span.sync-icon-left {
+ position: absolute;
+ padding: 0;
+ margin: 0;
+ top: 3px;
+ left: 4px;
+ display: inline-block;
+ width: 8px;
+ height: 8px;
+ border-left: 2px solid var(--sync-icon-color);
+ border-top: 2px solid var(--sync-icon-color);
+ transform: rotate(-45deg);
+}
+
+span.sync-icon-right {
+ position: absolute;
+ padding: 0;
+ margin: 0;
+ top: 3px;
+ left: 10px;
+ display: inline-block;
+ width: 8px;
+ height: 8px;
+ border-right: 2px solid var(--sync-icon-color);
+ border-bottom: 2px solid var(--sync-icon-color);
+ transform: rotate(-45deg);
+}
+
+div.nav-sync-icon:hover span.sync-icon-left {
+ border-left: 2px solid var(--sync-icon-selected-color);
+ border-top: 2px solid var(--sync-icon-selected-color);
+}
+
+div.nav-sync-icon:hover span.sync-icon-right {
+ border-right: 2px solid var(--sync-icon-selected-color);
+ border-bottom: 2px solid var(--sync-icon-selected-color);
+}
+
+#nav-path ul {
+ border-top: 1px solid var(--nav-breadcrumb-separator-color);
}
@media print
@@ -147,3 +232,96 @@
div.ui-resizable-handle { display: none; position: relative; }
}
+/*---------------------------*/
+#container {
+ display: grid;
+ grid-template-columns: auto auto;
+ overflow: hidden;
+}
+
+#page-nav {
+ background: var(--nav-background-color);
+ display: block;
+ width: 250px;
+ box-sizing: content-box;
+ position: relative;
+ border-left: 1px solid var(--nav-border-color);
+}
+
+#page-nav-tree {
+ display: inline-block;
+}
+
+#page-nav-resize-handle {
+ transition: opacity 0.5s ease;
+ background-color: var(--nav-splitbar-bg-color);
+ opacity:0;
+ cursor:col-resize;
+ height:100%;
+ right:0;
+ top:0;
+ width:6px;
+ position: relative;
+ z-index: 1;
+ user-select: none;
+}
+
+#page-nav-resize-handle:after {
+ content: '';
+ display: block;
+ top: 50%;
+ left: 1px;
+ width: 2px;
+ height: 15px;
+ border-left: 1px solid var(--nav-splitbar-handle-color);
+ border-right: 1px solid var(--nav-splitbar-handle-color);
+ position: absolute;
+}
+
+#page-nav-resize-handle.dragging,
+#page-nav-resize-handle:hover {
+ opacity: 1;
+}
+
+#page-nav-contents {
+ padding: 0;
+ margin: 0;
+ display: block;
+ top: 0;
+ left: 0;
+ height: 100%;
+ width: 100%;
+ position: absolute;
+ overflow: auto;
+ scrollbar-width: thin;
+ -webkit-overflow-scrolling : touch; /* iOS 5+ */
+}
+
+ul.page-outline,
+ul.page-outline ul {
+ text-indent: 0;
+ list-style: none outside none;
+ padding: 0 0 0 4px;
+}
+
+ul.page-outline {
+ margin: 0 4px 4px 6px;
+}
+
+ul.page-outline div.item {
+ font: 12px var(--font-family-nav);
+ line-height: 22px;
+}
+
+ul.page-outline li {
+ white-space: nowrap;
+}
+
+ul.page-outline li.vis {
+ background-color: var(--nav-breadcrumb-active-bg);
+}
+
+#container.resizing {
+ cursor: col-resize;
+ user-select: none;
+}
diff --git a/docs/html/optimal_allocation.html b/docs/html/optimal_allocation.html
index 627471c..88f3e62 100644
--- a/docs/html/optimal_allocation.html
+++ b/docs/html/optimal_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Optimal resource allocation
-
-
@@ -33,33 +31,22 @@
-
+
-
- Optimal resource allocation
+ Optimal resource allocation
This library tries to automatically make optimal choices for the resources you create, so you don't need to care about them. There are some advanced features of Direct3D 12 that you may use to optimize your memory management. There are also some settings in D3D12MA that you may change to alter its default behavior. This page provides miscellaneous advice about features of D3D12 and D3D12MA that are non-essential, but may improve the stability or performance of your app.
-
+
Avoiding running out of memory
When trying to allocate more memory than available in the current heap (e.g., video memory on the graphics card, system memory), one of few bad things can happen:
-- The allocation (resource creation) function call can fail with
HRESULT value other than S_OK.
+- The allocation (resource creation) function call can fail with HRESULT value other than S_OK.
- The allocation may succeed, but take long time (even a significant fraction of a second).
- Some resources are automatically demoted from video memory to system memory, degrading the app performance.
- Even a crash of the entire graphics driver can happen, resulting in the D3D12 "device removal", which is usually catastrophic for the application.
@@ -113,34 +100,34 @@ Statistics of current memory usage and available budget for a specific memory segment group.Definition D3D12MemAlloc.h:474
UINT64 BudgetBytesEstimated amount of memory available to the program.Definition D3D12MemAlloc.h:497
UINT64 UsageBytesEstimated current memory usage of the program.Definition D3D12MemAlloc.h:486
-- Implementation detail
- DXGI interface offers function
IDXGIAdapter3::QueryVideoMemoryInfo that queries the current memory usage and budget. This library automatically makes use of it when available (when you use recent enough version of the DirectX SDK). If not, it falls back to estimating the usage and budget based on the total amount of the allocated memory and 80% of the full memory capacity, respectively.
+- Implementation detail
- DXGI interface offers function IDXGIAdapter3::QueryVideoMemoryInfo that queries the current memory usage and budget. This library automatically makes use of it when available (when you use recent enough version of the DirectX SDK). If not, it falls back to estimating the usage and budget based on the total amount of the allocated memory and 80% of the full memory capacity, respectively.
- Implementation detail
- Allocating large heaps and creating placed resources in them is one of the main features of this library. However, if allocating new such block would exceed the budget, it will automatically prefer creating the resource as committed to have exactly the right size, which can lower the chance of getting into trouble in case of over-commitment.
When creating non-essential resources, you can use D3D12MA::ALLOCATION_FLAG_WITHIN_BUDGET. Then, in case the allocation would exceed the budget, the library will return failure from the function without attempting to allocate the actual D3D12 memory.
-It may also be a good idea to support failed resource creation. For non-essential resources, when function D3D12MA::Allocator::CreateResource fails with a result other than S_OK, it is worth implementing some way of recovery instead of terminating or crashing the entire app.
-
+
It may also be a good idea to support failed resource creation. For non-essential resources, when function D3D12MA::Allocator::CreateResource fails with a result other than S_OK, it is worth implementing some way of recovery instead of terminating or crashing the entire app.
+
Allocation performance
Creating D3D12 resources (buffers and textures) can be a time-consuming operation. The duration can be unpredictable, spanning from a small fraction of a millisecond to a significant fraction of a second. Thus, it is recommended to allocate all the memory and create all the resources needed upfront rather than doing it during application runtime. For example, a video game can try to create its resources on startup or when loading a new level. Of course, is is not always possible. For example, open-world games may require loading and unloading some graphical assets in the background (often called "streaming").
-Creating and releasing D3D12 resources on a separate thread in the background may help. Both ID3D12Device and D3D12MA::Allocator objects are thread-safe, synchronized internally. However, cases were observed where resource creation calls like ID3D12Device::CreateCommittedResource were blocking other D3D12 calls like ExecuteCommandLists or Present somewhere inside the graphics driver, so hitches can happen even when using multithreading.
-The most expensive part is typically the allocation of a new D3D12 memory heap. This library tackles this problem by automatically allocating large heaps (64 MB by default) and creating resources as placed inside of them. When a new requested resource can be placed in a free space of an existing heap and doesn't require allocating a new heap, this operation is typically much faster, as it only requires creating a new ID3D12Resource object and not allocating new memory. This is the main benefit of using D3D12MA compared to the naive approach of using Direct3D 12 directly and creating each resource as committed with CreateCommittedResource, which would result in a separate allocation of an implicit heap every time.
-When a large number of small buffers needs to be created, the overhead of creating even just separate ID3D12Resource objects can be significant. It can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs. This library can also help with it. See section "Sub-allocating buffers" below.
+Creating and releasing D3D12 resources on a separate thread in the background may help. Both ID3D12Device and D3D12MA::Allocator objects are thread-safe, synchronized internally. However, cases were observed where resource creation calls like ID3D12Device::CreateCommittedResource were blocking other D3D12 calls like ExecuteCommandLists or Present somewhere inside the graphics driver, so hitches can happen even when using multithreading.
+The most expensive part is typically the allocation of a new D3D12 memory heap. This library tackles this problem by automatically allocating large heaps (64 MB by default) and creating resources as placed inside of them. When a new requested resource can be placed in a free space of an existing heap and doesn't require allocating a new heap, this operation is typically much faster, as it only requires creating a new ID3D12Resource object and not allocating new memory. This is the main benefit of using D3D12MA compared to the naive approach of using Direct3D 12 directly and creating each resource as committed with CreateCommittedResource, which would result in a separate allocation of an implicit heap every time.
+When a large number of small buffers needs to be created, the overhead of creating even just separate ID3D12Resource objects can be significant. It can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs. This library can also help with it. See section "Sub-allocating buffers" below.
- Implementation detail
- The CPU performance overhead of using this library is low. It uses a high-quality allocation algorithm called Two-Level Segregated Fit (TLSF), which in most cases can find a free place for a new allocation in few steps. The library also doesn't perform too many CPU heap allocations. In may cases, the allocation happens with 0 new CPU heap allocations performed by the library. Even the creation of a D3D12MA::Allocation object itself doesn't typically feature an CPU allocation, because these objects are returned out of a dedicated memory pool.
Another reason for the slowness of D3D12 memory allocation is the guarantee that the newly allocated memory is filled with zeros. When creating and destroying resources placed in an existing heap, this overhead is not present, and the memory is not zeroed - it may contain random data left by the resource previously allocated in that place. In recent versions of the DirectX 12 SDK, clearing the memory of the newly created D3D12 heaps can also be disabled for the improved performance. D3D12MA can use this feature when:
- D3D12MA::ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED is used during the creation of the main allocator object.
-D3D12_HEAP_FLAG_CREATE_NOT_ZEROED is passed to D3D12MA::POOL_DESC::HeapFlags during the creation of a custom pool.- D3D12_HEAP_FLAG_CREATE_NOT_ZEROED is passed to D3D12MA::POOL_DESC::HeapFlags during the creation of a custom pool.
It is recommended to always use these flags. The downside is that when the memory is not filled with zeros, while you don't properly clear it or otherwise initialize its content before use (which is required by D3D12), you may observe incorrect behavior. This problem mostly affects render-target and depth-stencil textures.
When an allocation needs to be made in a performance-critical code, you can use D3D12MA::ALLOCATION_FLAG_STRATEGY_MIN_TIME. In influences multiple heuristics inside the library to prefer faster allocation at the expense of possibly less optimal placement in the memory.
If the resource to be created is non-essential, while the performance is paramount, you can also use D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE. It will create the resource only if it can be placed inside and existing memory heap and return failure from the function if a new heap would need to be allocated, which should guarantee good performance of such function call.
-
+
Sub-allocating buffers
-
When a large number of small buffers needs to be created, the overhead of creating separate ID3D12Resource objects can be significant. It can also cause a significant waste of memory, as placed buffers need to be aligned to D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB by default. These problems can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs.
+When a large number of small buffers needs to be created, the overhead of creating separate ID3D12Resource objects can be significant. It can also cause a significant waste of memory, as placed buffers need to be aligned to D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB by default. These problems can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs.
It requires implementing a custom allocator for the data inside the buffer and using offsets to individual regions. When all the regions can be allocated linearly and freed all at once, implementing such allocator is trivial. When every region has the same size, implementing an allocator is also quite simple when using a "free list" algorithm. However, when regions can have different sizes and can be allocated and freed in random order, it requires a full allocation algorithm. D3D12MA can help with it by exposing its core allocation algorithm for custom usages. For more details and example code, see chapter: Virtual allocator. It can be used for all the cases mentioned above without too much performance overhead, because the D3D12MA::VirtualAllocation object is just a lightweight handle.
-When sub-allocating a buffer, you need to remember to explicitly request proper alignment required for each region. For example, data used as a constant buffer must be aligned to D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT = 256 B.
-
+
When sub-allocating a buffer, you need to remember to explicitly request proper alignment required for each region. For example, data used as a constant buffer must be aligned to D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT = 256 B.
+
Residency priority
When too much video memory is allocated, one of the things that can happen is the system demoting some heaps to the system memory. Moving data between memory pools or reaching out directly to the system memory through PCI Express bus can have large performance overhead, which can slow down the application, or even make the game unplayable any more. Unfortunately, it is not possible to fully control or prevent this demotion. Best thing to do is avoiding memory over-commitment. For more information, see section "Avoiding running out of memory" above.
-Recent versions of DirectX 12 SDK offer function ID3D12Device1::SetResidencyPriority that sets a hint about the priority of a resource - how important it is to stay resident in the video memory. Setting the priority happens at the level of an entire memory heap. D3D12MA offers an interface to set this priority in form of D3D12MA::POOL_DESC::ResidencyPriority parameter. It affects all allocations made out of the custom pool created with it, both placed inside large heaps and created as committed.
+Recent versions of DirectX 12 SDK offer function ID3D12Device1::SetResidencyPriority that sets a hint about the priority of a resource - how important it is to stay resident in the video memory. Setting the priority happens at the level of an entire memory heap. D3D12MA offers an interface to set this priority in form of D3D12MA::POOL_DESC::ResidencyPriority parameter. It affects all allocations made out of the custom pool created with it, both placed inside large heaps and created as committed.
It is recommended to create a custom pool for the purpose of using high residency priority of all resources that are critical for the performance, especially those that are written by the GPU, like render-target, depth-stencil textures, UAV textures and buffers. It is also worth creating them as committed, so that each one will have its own implicit heap. This can minimize the chance that an entire large heap is demoted to system memory, degrading performance of all the resources placed in it.
Example:
D3D12MA::CPOOL_DESC poolDesc = D3D12MA::CPOOL_DESC{
@@ -175,14 +162,14 @@
D3D12_RESIDENCY_PRIORITY priority = D3D12_RESIDENCY_PRIORITY_HIGH;
device1->SetResidencyPriority(1, &res, &priority);
ID3D12Resource * GetResource() constReturns D3D12 resource associated with this object.Definition D3D12MemAlloc.h:552
-
Note this is not the same as explicit eviction controlled using ID3D12Device::Evict and MakeResident functions. Resources evicted explicitly are illegal to access until they are made resident again, while the demotion described here happens automatically and only slows down the execution.
-
+
Note this is not the same as explicit eviction controlled using ID3D12Device::Evict and MakeResident functions. Resources evicted explicitly are illegal to access until they are made resident again, while the demotion described here happens automatically and only slows down the execution.
+
GPU upload heap
Direct3D 12 offers a fixed set of memory heap types:
-D3D12_HEAP_TYPE_DEFAULT: Represents the video memory. It is available and fast to access for the GPU. It should be used for all resources that are written by the GPU (like render-target and depth-stencil textures, UAV) and resources that are frequently read by the GPU (like textures intended for sampling, vertex, index, and constant buffers).D3D12_HEAP_TYPE_UPLOAD: Represents the system memory that is uncached and write-combined. It can be mapped and accessed by the CPU code using a pointer. It supports only buffers, not textures. It is intended for "staging buffers" that are filled by the CPU code and then used as a source of copy operations to the DEFAULT heap. It can also be accessed directly by the GPU - shaders can read from buffers created in this memory.D3D12_HEAP_TYPE_READBACK: Represents the system memory that is cached. It is intended for buffers used as a destination of copy operations from the DEFAULT heap.- D3D12_HEAP_TYPE_DEFAULT: Represents the video memory. It is available and fast to access for the GPU. It should be used for all resources that are written by the GPU (like render-target and depth-stencil textures, UAV) and resources that are frequently read by the GPU (like textures intended for sampling, vertex, index, and constant buffers).
+- D3D12_HEAP_TYPE_UPLOAD: Represents the system memory that is uncached and write-combined. It can be mapped and accessed by the CPU code using a pointer. It supports only buffers, not textures. It is intended for "staging buffers" that are filled by the CPU code and then used as a source of copy operations to the DEFAULT heap. It can also be accessed directly by the GPU - shaders can read from buffers created in this memory.
+- D3D12_HEAP_TYPE_READBACK: Represents the system memory that is cached. It is intended for buffers used as a destination of copy operations from the DEFAULT heap.
Note that in systems with a discrete graphics card, access to system memory is fast from the CPU code (like the C++ code mapping D3D12 buffers and accessing them through a pointer), while access to the video memory is fast from the GPU code (like shaders reading and writing buffers and textures). Any copy operation or direct access between these memory heap types happens through PCI Express bus, which can be relatively slow.
Modern systems offer a feature called Resizable BAR (ReBAR) that gives the CPU direct access to the full video memory. To be available, this feature needs to be supported by the whole hardware-software environment, including:
@@ -192,20 +179,20 @@
- Supporting operating system.
- The feature needs to be enabled in the UEFI settings. It is typically called "Above 4G Decoding" and "Resizable Bar".
-Recent versions of DirectX 12 SDK give access to this feature in form of a new, 4th memory pool: D3D12_HEAP_TYPE_GPU_UPLOAD. Resources created in it behave logically similar to the D3D12_HEAP_TYPE_UPLOAD heap:
+Recent versions of DirectX 12 SDK give access to this feature in form of a new, 4th memory pool: D3D12_HEAP_TYPE_GPU_UPLOAD. Resources created in it behave logically similar to the D3D12_HEAP_TYPE_UPLOAD heap:
- They support mapping and direct access from the CPU code through a pointer.
-- The mapped memory is uncached and write-combined, so it should be only written sequentially (e.g., number-by-number or using
memcpy). It shouldn't be accessed randomly or read, because it is extremely slow for uncached memory.
+- The mapped memory is uncached and write-combined, so it should be only written sequentially (e.g., number-by-number or using memcpy). It shouldn't be accessed randomly or read, because it is extremely slow for uncached memory.
- Only buffers are supported.
- Those buffers can be used as a source of copy operations or directly accessed by the GPU.
-The main difference is that resources created in the new D3D12_HEAP_TYPE_GPU_UPLOAD are placed in the video memory, while resources created in the old D3D12_HEAP_TYPE_UPLOAD are placed in the system memory. This implies which budgets are consumed by new resources allocated in those heaps. This also implies which operations involve transferring data through the PCI Express bus.
+The main difference is that resources created in the new D3D12_HEAP_TYPE_GPU_UPLOAD are placed in the video memory, while resources created in the old D3D12_HEAP_TYPE_UPLOAD are placed in the system memory. This implies which budgets are consumed by new resources allocated in those heaps. This also implies which operations involve transferring data through the PCI Express bus.
-- As
D3D12_HEAP_TYPE_UPLOAD uses the system memory, writes from the CPU code through a mapped pointer are faster, while copies or direct access from the GPU are slower because they need to go through PCIe.
-- As the new
D3D12_HEAP_TYPE_GPU_UPLOAD uses the video memory, copies or direct access from the GPU are faster, while writes from the CPU code through a mapped pointer can be slower, because they need to go through PCIe. For maximum performance of copy operations from this heap, a graphics or compute queue should be used, not a copy queue.
+- As D3D12_HEAP_TYPE_UPLOAD uses the system memory, writes from the CPU code through a mapped pointer are faster, while copies or direct access from the GPU are slower because they need to go through PCIe.
+- As the new D3D12_HEAP_TYPE_GPU_UPLOAD uses the video memory, copies or direct access from the GPU are faster, while writes from the CPU code through a mapped pointer can be slower, because they need to go through PCIe. For maximum performance of copy operations from this heap, a graphics or compute queue should be used, not a copy queue.
GPU Upload Heap can be used for performance optimization of some resources that need to be written by the CPU and read by the GPU. It can be beneficial especially for resources that need to change frequently (often called "dynamic").
-D3D12MA supports GPU upload heap when recent enough version of DirectX 12 SDK is used and when the current system supports it. The support can be queried using function D3D12MA::Allocator::IsGPUUploadHeapSupported(). When it returns TRUE, you can create resources using D3D12_HEAP_TYPE_GPU_UPLOAD. You can also just try creating such resource. Example:
+D3D12MA supports GPU upload heap when recent enough version of DirectX 12 SDK is used and when the current system supports it. The support can be queried using function D3D12MA::Allocator::IsGPUUploadHeapSupported(). When it returns TRUE, you can create resources using D3D12_HEAP_TYPE_GPU_UPLOAD. You can also just try creating such resource. Example:
D3D12MA::CALLOCATION_DESC allocDesc = D3D12MA::CALLOCATION_DESC{
D3D12_HEAP_TYPE_GPU_UPLOAD }; // !!!
@@ -240,13 +227,13 @@
else
// Some other error code e.g., out of memory...
D3D12_HEAP_TYPE HeapTypeThe type of memory heap where the new allocation should be placed.Definition D3D12MemAlloc.h:347
-
+
Committed versus placed resources
When using D3D12 API directly, there are 3 ways of creating resources:
-- Committed, using function
ID3D12Device::CreateCommittedResource. It creates the resource with its own memory heap, which is called an "implicit heap" and cannot be accessed directly.
-- Placed, using function
ID3D12Device::CreatePlacedResource. A ID3D12Heap needs to be created beforehand using ID3D12Device::CreateHeap. Then, the resource can be created as placed inside the heap at a specific offset.
-- Reserved, using function
ID3D12Device::CreateReservedResource. This library doesn't support them directly.
+- Committed, using function ID3D12Device::CreateCommittedResource. It creates the resource with its own memory heap, which is called an "implicit heap" and cannot be accessed directly.
+- Placed, using function ID3D12Device::CreatePlacedResource. A ID3D12Heap needs to be created beforehand using ID3D12Device::CreateHeap. Then, the resource can be created as placed inside the heap at a specific offset.
+- Reserved, using function ID3D12Device::CreateReservedResource. This library doesn't support them directly.
A naive solution would be to create all the resources as committed. It works, because in D3D12 there is no strict limit on the number of resources or heaps that can be created. However, there are certain advantages and disadvantages of using committed versus placed resources:
- The advantage of committed resources is that they are always created with a new heap, which is initialized with zeros. When a resource is created as placed, the memory may contain random data left by the resource previously allocated in that place. When the memory is not filled with zeros, while you don't properly clear it or otherwise initialize its content before use (which is required by D3D12), you may observe incorrect behavior. On the other hand, using committed resources and having every new resource filled with zeros can leave this kind of bugs undetected.
-- Manual eviction with
ID3D12Device::Evict and MakeResident functions work at the level of the entire heap, and so does ID3D12Device1::SetResidencyPriority, so creating resources as committed allows more fine-grained control over the eviction and residency priority of individual resources.
+- Manual eviction with ID3D12Device::Evict and MakeResident functions work at the level of the entire heap, and so does ID3D12Device1::SetResidencyPriority, so creating resources as committed allows more fine-grained control over the eviction and residency priority of individual resources.
- The advantage of placed resources is that they can be created in a region of a heap overlapping with some other resources. This approach is commonly called "aliasing". It can save memory, but it needs careful control over the resources that overlap in memory to make sure they are not used at the same time, there is an aliasing barrier issued between their usage, and the resource used after aliasing is correctly cleared every time. Committed resources don't offer this possibility, because every committed resource has its own exclusive memory heap. For more information, see chapter Resource aliasing (overlap).
When creating resources with the help of D3D12MA using function D3D12MA::Allocator::CreateResource, you typically don't need to care about all this. The library automatically makes the choice of creating the new resource as committed or placed. However, in cases when you need the information or the control over this choice between committed and placed, the library offers facilities to do that, described below.
@@ -303,18 +290,18 @@
UINT64 BlockSizeSize of a single heap (memory block) to be allocated as part of this pool, in bytes....Definition D3D12MemAlloc.h:933
You can request a new resource to be created as placed by using D3D12MA::ALLOCATION_FLAG_CAN_ALIAS. This is required especially if you plan to create another resource in the same region of memory, aliasing with your resource - hence the name of this flag.
Note D3D12MA::ALLOCATION_FLAG_CAN_ALIAS can be even combined with D3D12MA::ALLOCATION_FLAG_COMMITTED. In this case, the resource is not created as committed, but it is also not placed as part of a larger heap. What happens instead is that a new heap is created with the exact size required for the resource, and the resource is created in it, placed at offset 0.
-
+
Resource alignment
Certain types of resources require certain alignment in memory. An alignment is a requirement for the address or offset to the beginning of the resource to be a multiply of some value, which is always a power of 2. For committed resources, the problem is non-existent, because committed resources have their own implicit heaps where they are created at offset 0, which meets any alignment requirement. For placed resources, D3D12MA takes care of the alignment automatically.
-- Implementation detail
- Default alignment required MSAA textures is
D3D12_DEFAULT_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 4 MB. Default alignment required for buffers and other textures is D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB.
+- Implementation detail
- Default alignment required MSAA textures is D3D12_DEFAULT_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 4 MB. Default alignment required for buffers and other textures is D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB.
Because the alignment required for buffers is 64 KB, small buffers can waste a lot of memory in between when created as placed. When such small buffers are created as committed, some graphics drivers are able to pack them better. D3D12MA automatically takes advantage of this by preferring to create small buffers as committed. This heuristics is enabled by default. It is also a tradeoff - it can make the allocation of these buffers slower. It can be disabled for an individual resource by using D3D12MA::ALLOCATION_FLAG_STRATEGY_MIN_TIME and for the entire allocator by using D3D12MA::ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED.
-For certain textures that meet a complex set of requirements, special "small alignment" can be applied. Details can be found in Microsoft documentation of the D3D12_RESOURCE_DESC structure. For MSAA textures, the small alignment is D3D12_SMALL_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB. For other textures, the small alignment is D3D12_SMALL_RESOURCE_PLACEMENT_ALIGNMENT = 4 KB. D3D12MA uses this feature automatically. Detailed behavior can be disabled or controlled by predefining macro D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT.
-D3D12 also has a concept of alignment of the entire heap, passed through D3D12_HEAP_DESC::Alignment. This library automatically sets the alignment as small as possible. Unfortunately, any heap that has a chance of hosting an MSAA texture needs to have the alignment set to 4 MB. This problem can be overcome by passing D3D12MA::ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of the main allocator object and D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of any custom heap that supports textures, not only buffers. With those flags, the alignment of the heaps created by D3D12MA can be lower, but any MSAA textures are created as committed. You should always use these flags in your code unless you really need to create some MSAA textures as placed.
+For certain textures that meet a complex set of requirements, special "small alignment" can be applied. Details can be found in Microsoft documentation of the D3D12_RESOURCE_DESC structure. For MSAA textures, the small alignment is D3D12_SMALL_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB. For other textures, the small alignment is D3D12_SMALL_RESOURCE_PLACEMENT_ALIGNMENT = 4 KB. D3D12MA uses this feature automatically. Detailed behavior can be disabled or controlled by predefining macro D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT.
+D3D12 also has a concept of alignment of the entire heap, passed through D3D12_HEAP_DESC::Alignment. This library automatically sets the alignment as small as possible. Unfortunately, any heap that has a chance of hosting an MSAA texture needs to have the alignment set to 4 MB. This problem can be overcome by passing D3D12MA::ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of the main allocator object and D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of any custom heap that supports textures, not only buffers. With those flags, the alignment of the heaps created by D3D12MA can be lower, but any MSAA textures are created as committed. You should always use these flags in your code unless you really need to create some MSAA textures as placed.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/quick_start.html b/docs/html/quick_start.html
index f9219d2..4eba7e6 100644
--- a/docs/html/quick_start.html
+++ b/docs/html/quick_start.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Quick start
-
-
@@ -33,33 +31,22 @@
-
+
-
- Quick start
+ Quick start
-
+
Project setup and initialization
This is a small, standalone C++ library. It consists of 2 files: "D3D12MemAlloc.h" header file with public interface and "D3D12MemAlloc.cpp" with internal implementation. The only external dependencies are WinAPI, Direct3D 12, and parts of C/C++ standard library (but STL containers, exceptions, or RTTI are not used).
The library is developed and tested using Microsoft Visual Studio 2022, but it should work with other compilers as well. It is designed for 64-bit code.
To use the library in your project:
-(1.) Copy files D3D12MemAlloc.cpp, D3D12MemAlloc.h to your project.
-(2.) Make D3D12MemAlloc.cpp compiling as part of the project, as C++ code.
+(1.) Copy files D3D12MemAlloc.cpp, D3D12MemAlloc.h to your project.
+(2.) Make D3D12MemAlloc.cpp compiling as part of the project, as C++ code.
(3.) Include library header in each CPP file that needs to use the library.
#include "D3D12MemAlloc.h"
-(4.) Right after you created ID3D12Device, fill D3D12MA::ALLOCATOR_DESC structure and call function D3D12MA::CreateAllocator to create the main D3D12MA::Allocator object.
+
(4.) Right after you created ID3D12Device, fill D3D12MA::ALLOCATOR_DESC structure and call function D3D12MA::CreateAllocator to create the main D3D12MA::Allocator object.
Please note that all symbols of the library are declared inside D3D12MA namespace.
IDXGIAdapter* adapter = ...
ID3D12Device* device = ...
@@ -119,12 +106,12 @@
D3D12MA_API HRESULT CreateAllocator(const ALLOCATOR_DESC *pDesc, Allocator **ppAllocator)Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
(5.) Right before destroying the D3D12 device, destroy the allocator object.
allocator->Release();
-Objects of this library must be destroyed by calling Release method. They are somewhat compatible with COM: they implement IUnknown interface with its virtual methods: AddRef, Release, QueryInterface, and they are reference-counted internally. You can use smart pointers designed for COM with objects of this library - e.g. CComPtr or Microsoft::WRL::ComPtr. The reference counter is thread-safe. QueryInterface method supports only IUnknown, as classes of this library don't define their own GUIDs.
-
+
Objects of this library must be destroyed by calling Release method. They are somewhat compatible with COM: they implement IUnknown interface with its virtual methods: AddRef, Release, QueryInterface, and they are reference-counted internally. You can use smart pointers designed for COM with objects of this library - e.g. CComPtr or Microsoft::WRL::ComPtr. The reference counter is thread-safe. QueryInterface method supports only IUnknown, as classes of this library don't define their own GUIDs.
+
Creating resources
-To use the library for creating resources (textures and buffers), call method D3D12MA::Allocator::CreateResource in the place where you would previously call ID3D12Device::CreateCommittedResource.
-The function has similar syntax, but it expects structure D3D12MA::ALLOCATION_DESC to be passed along with D3D12_RESOURCE_DESC and other parameters for created resource. This structure describes parameters of the desired memory allocation, including choice of D3D12_HEAP_TYPE.
-The function returns a new object of type D3D12MA::Allocation. It represents allocated memory and can be queried for size, offset, ID3D12Heap. It also holds a reference to the ID3D12Resource, which can be accessed by calling D3D12MA::Allocation::GetResource().
+To use the library for creating resources (textures and buffers), call method D3D12MA::Allocator::CreateResource in the place where you would previously call ID3D12Device::CreateCommittedResource.
+The function has similar syntax, but it expects structure D3D12MA::ALLOCATION_DESC to be passed along with D3D12_RESOURCE_DESC and other parameters for created resource. This structure describes parameters of the desired memory allocation, including choice of D3D12_HEAP_TYPE.
+The function returns a new object of type D3D12MA::Allocation. It represents allocated memory and can be queried for size, offset, ID3D12Heap. It also holds a reference to the ID3D12Resource, which can be accessed by calling D3D12MA::Allocation::GetResource().
D3D12_RESOURCE_DESC resourceDesc = {};
resourceDesc.Dimension = D3D12_RESOURCE_DIMENSION_TEXTURE2D;
resourceDesc.Alignment = 0;
@@ -160,13 +147,13 @@
D3D12_HEAP_TYPE HeapTypeThe type of memory heap where the new allocation should be placed.Definition D3D12MemAlloc.h:347
You need to release the allocation object when no longer needed. This will also release the D3D12 resource.
allocation->Release();
-The advantage of using the allocator instead of creating committed resource, and the main purpose of this library, is that it can decide to allocate bigger memory heap internally using ID3D12Device::CreateHeap and place multiple resources in it, at different offsets, using ID3D12Device::CreatePlacedResource. The library manages its own collection of allocated memory blocks (heaps) and remembers which parts of them are occupied and which parts are free to be used for new resources.
-It is important to remember that resources created as placed don't have their memory initialized to zeros, but may contain garbage data, so they need to be fully initialized before usage, e.g. using Clear (ClearRenderTargetView), Discard (DiscardResource), or Copy (CopyResource).
-The library also automatically handles resource heap tier. When D3D12_FEATURE_DATA_D3D12_OPTIONS::ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1, resources of 3 types: buffers, textures that are render targets or depth-stencil, and other textures must be kept in separate heaps. When D3D12_RESOURCE_HEAP_TIER_2, they can be kept together. By using this library, you don't need to handle this manually.
-
+
The advantage of using the allocator instead of creating committed resource, and the main purpose of this library, is that it can decide to allocate bigger memory heap internally using ID3D12Device::CreateHeap and place multiple resources in it, at different offsets, using ID3D12Device::CreatePlacedResource. The library manages its own collection of allocated memory blocks (heaps) and remembers which parts of them are occupied and which parts are free to be used for new resources.
+It is important to remember that resources created as placed don't have their memory initialized to zeros, but may contain garbage data, so they need to be fully initialized before usage, e.g. using Clear (ClearRenderTargetView), Discard (DiscardResource), or Copy (CopyResource).
+The library also automatically handles resource heap tier. When D3D12_FEATURE_DATA_D3D12_OPTIONS::ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1, resources of 3 types: buffers, textures that are render targets or depth-stencil, and other textures must be kept in separate heaps. When D3D12_RESOURCE_HEAP_TIER_2, they can be kept together. By using this library, you don't need to handle this manually.
+
Resource reference counting
-ID3D12Resource and other interfaces of Direct3D 12 use COM, so they are reference-counted. Objects of this library are reference-counted as well. An object of type D3D12MA::Allocation remembers the resource (buffer or texture) that was created together with this memory allocation and holds a reference to the ID3D12Resource object. (Note this is a difference to Vulkan Memory Allocator, where a VmaAllocation object has no connection with the buffer or image that was created with it.) Thus, it is important to manage the resource reference counter properly.
-The simplest use case is shown in the code snippet above. When only D3D12MA::Allocation object is obtained from a function call like D3D12MA::Allocator::CreateResource, it remembers the ID3D12Resource that was created with it and holds a reference to it. The resource can be obtained by calling allocation->GetResource(), which doesn't increment the resource reference counter. Calling allocation->Release() will decrease the resource reference counter, which is 1 in this case, so the resource will be released.
+ID3D12Resource and other interfaces of Direct3D 12 use COM, so they are reference-counted. Objects of this library are reference-counted as well. An object of type D3D12MA::Allocation remembers the resource (buffer or texture) that was created together with this memory allocation and holds a reference to the ID3D12Resource object. (Note this is a difference to Vulkan Memory Allocator, where a VmaAllocation object has no connection with the buffer or image that was created with it.) Thus, it is important to manage the resource reference counter properly.
+The simplest use case is shown in the code snippet above. When only D3D12MA::Allocation object is obtained from a function call like D3D12MA::Allocator::CreateResource, it remembers the ID3D12Resource that was created with it and holds a reference to it. The resource can be obtained by calling allocation->GetResource(), which doesn't increment the resource reference counter. Calling allocation->Release() will decrease the resource reference counter, which is 1 in this case, so the resource will be released.
Second option is to retrieve a pointer to the resource along with D3D12MA::Allocation. Last parameters of the resource creation function can be used for this purpose.
D3D12MA::Allocation* allocation;
ID3D12Resource* resource;
@@ -179,15 +166,15 @@
IID_PPV_ARGS(&resource));
// Use resource...
-
In this case, returned pointer resource is equal to allocation->GetResource(), but the creation function additionally increases resource reference counter for the purpose of returning it from this call (it actually calls QueryInterface internally), so the resource will have the counter = 2. The resource then need to be released along with the allocation, in this particular order, to make sure the resource is destroyed before its memory heap can potentially be freed.
+In this case, returned pointer resource is equal to allocation->GetResource(), but the creation function additionally increases resource reference counter for the purpose of returning it from this call (it actually calls QueryInterface internally), so the resource will have the counter = 2. The resource then need to be released along with the allocation, in this particular order, to make sure the resource is destroyed before its memory heap can potentially be freed.
resource->Release();
allocation->Release();
-More advanced use cases are possible when we consider that an D3D12MA::Allocation object can just hold a reference to any resource. It can be changed by calling D3D12MA::Allocation::SetResource. This function releases the old resource and calls AddRef on the new one.
-Special care must be taken when performing defragmentation. The new resource created at the destination place should be set as pass.pMoves[i].pDstTmpAllocation->SetResource(newRes), but it is moved to the source allocation at end of the defragmentation pass, while the old resource accessible through pass.pMoves[i].pSrcAllocation->GetResource() is then released. For more information, see documentation chapter Defragmentation.
-
+
More advanced use cases are possible when we consider that an D3D12MA::Allocation object can just hold a reference to any resource. It can be changed by calling D3D12MA::Allocation::SetResource. This function releases the old resource and calls AddRef on the new one.
+Special care must be taken when performing defragmentation. The new resource created at the destination place should be set as pass.pMoves[i].pDstTmpAllocation->SetResource(newRes), but it is moved to the source allocation at end of the defragmentation pass, while the old resource accessible through pass.pMoves[i].pSrcAllocation->GetResource() is then released. For more information, see documentation chapter Defragmentation.
+
Mapping memory
-The process of getting regular CPU-side pointer to the memory of a resource in Direct3D is called "mapping". There are rules and restrictions to this process, as described in D3D12 documentation of ID3D12Resource::Map method.
-Mapping happens on the level of particular resources, not entire memory heaps, and so it is out of scope of this library. Just as the documentation of the Map function says:
+The process of getting regular CPU-side pointer to the memory of a resource in Direct3D is called "mapping". There are rules and restrictions to this process, as described in D3D12 documentation of ID3D12Resource::Map method.
+Mapping happens on the level of particular resources, not entire memory heaps, and so it is out of scope of this library. Just as the documentation of the Map function says:
- Returned pointer refers to data of particular subresource, not entire memory heap.
- You can map same resource multiple times. It is ref-counted internally.
@@ -196,7 +183,7 @@
- Unmapping may not be required before using written data - some heap types on some platforms support resources persistently mapped.
When using this library, you can map and use your resources normally without considering whether they are created as committed resources or placed resources in one large heap.
-Example for buffer created and filled in UPLOAD heap type:
+Example for buffer created and filled in UPLOAD heap type:
const UINT64 bufSize = 65536;
const float* bufData = ...;
@@ -233,17 +220,17 @@
memcpy(mappedPtr, bufData, bufSize);
resource->Unmap(0, NULL);
-
+
Helper structures
-
DirectX 12 Agility SDK offers a library of helpers in files "build\native\include\d3dx12\*.h". They include structures that help with complete and concise initialization of the core D3D12 *_DESC structures by using some basic C++ features (constructors, static methods, default parameters). They inherit from these structures, so they support implicit casting to them. For example, structure CD3DX12_RESOURCE_DESC can be used to conveniently fill in structure D3D12_RESOURCE_DESC.
-Similarly, this library provides a set of helper structures that aid in initialization of some of the *_DESC structures defined in the library. These are:
+DirectX 12 Agility SDK offers a library of helpers in files "build\native\include\d3dx12\*.h". They include structures that help with complete and concise initialization of the core D3D12 *_DESC structures by using some basic C++ features (constructors, static methods, default parameters). They inherit from these structures, so they support implicit casting to them. For example, structure CD3DX12_RESOURCE_DESC can be used to conveniently fill in structure D3D12_RESOURCE_DESC.
+Similarly, this library provides a set of helper structures that aid in initialization of some of the *_DESC structures defined in the library. These are:
- D3D12MA::CALLOCATION_DESC, which inherits from D3D12MA::ALLOCATION_DESC.
- D3D12MA::CPOOL_DESC, which inherits from D3D12MA::POOL_DESC.
- D3D12MA::CVIRTUAL_BLOCK_DESC, which inherits from D3D12MA::VIRTUAL_BLOCK_DESC.
- D3D12MA::CVIRTUAL_ALLOCATION_DESC, which inherits from D3D12MA::VIRTUAL_ALLOCATION_DESC.
-For example, when you want to create a buffer in the UPLAOD heap using minimal allocation time, you can use base structures:
+For example, when you want to create a buffer in the UPLAOD heap using minimal allocation time, you can use base structures:
D3D12MA::ALLOCATION_DESC allocDesc;
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_STRATEGY_MIN_TIME;
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
@@ -291,7 +278,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/resource_aliasing.html b/docs/html/resource_aliasing.html
index c89a007..1275544 100644
--- a/docs/html/resource_aliasing.html
+++ b/docs/html/resource_aliasing.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Resource aliasing (overlap)
-
-
@@ -33,33 +31,22 @@
-
+
-
- Resource aliasing (overlap)
+ Resource aliasing (overlap)
New explicit graphics APIs (Vulkan and Direct3D 12), thanks to manual memory management, give an opportunity to alias (overlap) multiple resources in the same region of memory - a feature not available in the old APIs (Direct3D 11, OpenGL). It can be useful to save video memory, but it must be used with caution.
@@ -171,18 +158,18 @@
Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.Definition D3D12MemAlloc.h:338
D3D12_HEAP_FLAGS ExtraHeapFlagsAdditional heap flags to be used when allocating memory.Definition D3D12MemAlloc.h:363
D3D12_HEAP_TYPE HeapTypeThe type of memory heap where the new allocation should be placed.Definition D3D12MemAlloc.h:347
-Remember that using resouces that alias in memory requires proper synchronization. You need to issue a special barrier of type D3D12_RESOURCE_BARRIER_TYPE_ALIASING. You also need to treat a resource after aliasing as uninitialized - containing garbage data. For example, if you use res1 and then want to use res2, you need to first initialize res2 using either Clear, Discard, or Copy to the entire resource.
+Remember that using resouces that alias in memory requires proper synchronization. You need to issue a special barrier of type D3D12_RESOURCE_BARRIER_TYPE_ALIASING. You also need to treat a resource after aliasing as uninitialized - containing garbage data. For example, if you use res1 and then want to use res2, you need to first initialize res2 using either Clear, Discard, or Copy to the entire resource.
Additional considerations:
- D3D12 also allows to interpret contents of memory between aliasing resources consistently in some cases, which is called "data inheritance". For details, see Microsoft documentation chapter "Memory Aliasing and Data Inheritance".
-- You can create more complex layout where different textures and buffers are bound at different offsets inside one large allocation. For example, one can imagine a big texture used in some render passes, aliasing with a set of many small buffers used in some further passes. To bind a resource at non-zero offset of an allocation, call D3D12MA::Allocator::CreateAliasingResource with appropriate value of
AllocationLocalOffset parameter.
-- Resources of the three categories: buffers, textures with
RENDER_TARGET or DEPTH_STENCIL flags, and all other textures, can be placed in the same memory only when allocator->GetD3D12Options().ResourceHeapTier >= D3D12_RESOURCE_HEAP_TIER_2. Otherwise they must be placed in different memory heap types, and thus aliasing them is not possible.
+- You can create more complex layout where different textures and buffers are bound at different offsets inside one large allocation. For example, one can imagine a big texture used in some render passes, aliasing with a set of many small buffers used in some further passes. To bind a resource at non-zero offset of an allocation, call D3D12MA::Allocator::CreateAliasingResource with appropriate value of AllocationLocalOffset parameter.
+- Resources of the three categories: buffers, textures with RENDER_TARGET or DEPTH_STENCIL flags, and all other textures, can be placed in the same memory only when allocator->GetD3D12Options().ResourceHeapTier >= D3D12_RESOURCE_HEAP_TIER_2. Otherwise they must be placed in different memory heap types, and thus aliasing them is not possible.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/search/pages_0.js b/docs/html/search/pages_0.js
index 6c4bc1e..4e13aaf 100644
--- a/docs/html/search/pages_0.js
+++ b/docs/html/search/pages_0.js
@@ -1,10 +1,23 @@
var searchData=
[
- ['algorithm_0',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
- ['aliasing_20overlap_1',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
- ['allocation_2',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
- ['allocation_20algorithm_3',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
- ['allocator_4',['D3D12 Memory Allocator',['../index.html',1,'']]],
- ['allocator_5',['Virtual allocator',['../virtual_allocator.html',1,'optimal_allocation']]],
- ['asked_20questions_6',['Frequently asked questions',['../faq.html',1,'index']]]
+ ['additional_20considerations_0',['Additional considerations',['../linear_algorithm.html#linear_algorithm_additional_considerations',1,'Additional considerations'],['../virtual_allocator.html#virtual_allocator_additional_considerations',1,'Additional considerations']]],
+ ['algorithm_1',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
+ ['aliasing_20overlap_2',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
+ ['alignment_3',['Resource alignment',['../optimal_allocation.html#optimal_allocation_resource_alignment',1,'']]],
+ ['alignment_20and_20units_4',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]],
+ ['allocating_20buffers_5',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]],
+ ['allocation_6',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
+ ['allocation_20algorithm_7',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
+ ['allocation_20parameters_8',['Allocation parameters',['../virtual_allocator.html#virtual_allocator_allocation_parameters',1,'']]],
+ ['allocation_20performance_9',['Allocation performance',['../optimal_allocation.html#optimal_allocation_allocation_Performance',1,'']]],
+ ['allocations_10',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]],
+ ['allocator_11',['D3D12 Memory Allocator',['../index.html',1,'']]],
+ ['allocator_12',['allocator',['../configuration.html#custom_memory_allocator',1,'Custom CPU memory allocator'],['../virtual_allocator.html',1,'Virtual allocator']]],
+ ['and_20benefits_13',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]],
+ ['and_20compatibility_14',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]],
+ ['and_20initialization_15',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]],
+ ['and_20units_16',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]],
+ ['asked_20questions_17',['Frequently asked questions',['../faq.html',1,'index']]],
+ ['at_20once_18',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]],
+ ['avoiding_20running_20out_20of_20memory_19',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]]
];
diff --git a/docs/html/search/pages_1.js b/docs/html/search/pages_1.js
index 91cb574..d34b057 100644
--- a/docs/html/search/pages_1.js
+++ b/docs/html/search/pages_1.js
@@ -1,6 +1,7 @@
var searchData=
[
- ['configuration_0',['Configuration',['../configuration.html',1,'index']]],
- ['considerations_1',['General considerations',['../general_considerations.html',1,'index']]],
- ['custom_20memory_20pools_2',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
+ ['benefits_0',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]],
+ ['block_1',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]],
+ ['buffer_2',['Ring buffer',['../linear_algorithm.html#linear_algorithm_ring_buffer',1,'']]],
+ ['buffers_3',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]]
];
diff --git a/docs/html/search/pages_10.js b/docs/html/search/pages_10.js
new file mode 100644
index 0000000..af3b029
--- /dev/null
+++ b/docs/html/search/pages_10.js
@@ -0,0 +1,13 @@
+var searchData=
+[
+ ['safety_0',['Thread safety',['../general_considerations.html#general_considerations_thread_safety',1,'']]],
+ ['setup_20and_20initialization_1',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]],
+ ['stack_2',['Stack',['../linear_algorithm.html#linear_algorithm_stack',1,'']]],
+ ['stack_3',['Double stack',['../linear_algorithm.html#linear_algorithm_double_stack',1,'']]],
+ ['start_4',['Quick start',['../quick_start.html',1,'index']]],
+ ['statistics_5',['Statistics',['../statistics.html',1,'Statistics'],['../virtual_allocator.html#virtual_allocator_statistics',1,'Statistics']]],
+ ['statistics_6',['Numeric statistics',['../statistics.html#statistics_numeric_statistics',1,'']]],
+ ['structures_7',['Helper structures',['../quick_start.html#quick_start_helper_structures',1,'']]],
+ ['sub_20allocating_20buffers_8',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]],
+ ['supported_9',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]]
+];
diff --git a/docs/html/search/pages_11.js b/docs/html/search/pages_11.js
new file mode 100644
index 0000000..ce665b6
--- /dev/null
+++ b/docs/html/search/pages_11.js
@@ -0,0 +1,5 @@
+var searchData=
+[
+ ['table_20of_20contents_0',['Table of contents',['../index.html#main_table_of_contents',1,'']]],
+ ['thread_20safety_1',['Thread safety',['../general_considerations.html#general_considerations_thread_safety',1,'']]]
+];
diff --git a/docs/html/search/pages_12.js b/docs/html/search/pages_12.js
new file mode 100644
index 0000000..32f0ad5
--- /dev/null
+++ b/docs/html/search/pages_12.js
@@ -0,0 +1,6 @@
+var searchData=
+[
+ ['units_0',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]],
+ ['upload_20heap_1',['GPU upload heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'']]],
+ ['usage_2',['Usage',['../custom_pools.html#custom_pools_usage',1,'']]]
+];
diff --git a/docs/html/search/pages_13.js b/docs/html/search/pages_13.js
new file mode 100644
index 0000000..aa04e5d
--- /dev/null
+++ b/docs/html/search/pages_13.js
@@ -0,0 +1,8 @@
+var searchData=
+[
+ ['versioning_20and_20compatibility_0',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]],
+ ['versus_20placed_20resources_1',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]],
+ ['virtual_20allocations_2',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]],
+ ['virtual_20allocator_3',['Virtual allocator',['../virtual_allocator.html',1,'optimal_allocation']]],
+ ['virtual_20block_4',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]]
+];
diff --git a/docs/html/search/pages_14.js b/docs/html/search/pages_14.js
new file mode 100644
index 0000000..8225a92
--- /dev/null
+++ b/docs/html/search/pages_14.js
@@ -0,0 +1,4 @@
+var searchData=
+[
+ ['web_20links_0',['Web links',['../index.html#main_see_also',1,'']]]
+];
diff --git a/docs/html/search/pages_2.js b/docs/html/search/pages_2.js
index 8aa1a38..7553f75 100644
--- a/docs/html/search/pages_2.js
+++ b/docs/html/search/pages_2.js
@@ -1,5 +1,14 @@
var searchData=
[
- ['d3d12_20memory_20allocator_0',['D3D12 Memory Allocator',['../index.html',1,'']]],
- ['defragmentation_1',['Defragmentation',['../defragmentation.html',1,'optimal_allocation']]]
+ ['committed_20versus_20placed_20resources_0',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]],
+ ['compatibility_1',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]],
+ ['configuration_2',['Configuration',['../configuration.html',1,'index']]],
+ ['considerations_3',['considerations',['../linear_algorithm.html#linear_algorithm_additional_considerations',1,'Additional considerations'],['../virtual_allocator.html#virtual_allocator_additional_considerations',1,'Additional considerations'],['../general_considerations.html',1,'General considerations']]],
+ ['contents_4',['Table of contents',['../index.html#main_table_of_contents',1,'']]],
+ ['counting_5',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]],
+ ['cpu_20memory_20allocator_6',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]],
+ ['creating_20resources_7',['Creating resources',['../quick_start.html#quick_start_creating_resources',1,'']]],
+ ['creating_20virtual_20block_8',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]],
+ ['custom_20cpu_20memory_20allocator_9',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]],
+ ['custom_20memory_20pools_10',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
];
diff --git a/docs/html/search/pages_3.js b/docs/html/search/pages_3.js
index 842b2bb..89d174b 100644
--- a/docs/html/search/pages_3.js
+++ b/docs/html/search/pages_3.js
@@ -1,4 +1,9 @@
var searchData=
[
- ['frequently_20asked_20questions_0',['Frequently asked questions',['../faq.html',1,'index']]]
+ ['d3d12_20memory_20allocator_0',['D3D12 Memory Allocator',['../index.html',1,'']]],
+ ['deallocation_1',['Deallocation',['../virtual_allocator.html#virtual_allocator_deallocation',1,'']]],
+ ['debug_20margins_2',['Debug margins',['../configuration.html#debug_margins',1,'']]],
+ ['defragmentation_3',['Defragmentation',['../defragmentation.html',1,'optimal_allocation']]],
+ ['double_20stack_4',['Double stack',['../linear_algorithm.html#linear_algorithm_double_stack',1,'']]],
+ ['dump_5',['JSON dump',['../statistics.html#statistics_json_dump',1,'']]]
];
diff --git a/docs/html/search/pages_4.js b/docs/html/search/pages_4.js
index 1aed57d..6f9860c 100644
--- a/docs/html/search/pages_4.js
+++ b/docs/html/search/pages_4.js
@@ -1,4 +1,7 @@
var searchData=
[
- ['general_20considerations_0',['General considerations',['../general_considerations.html',1,'index']]]
+ ['features_20and_20benefits_0',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]],
+ ['features_20not_20supported_1',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]],
+ ['free_20at_20once_2',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]],
+ ['frequently_20asked_20questions_3',['Frequently asked questions',['../faq.html',1,'index']]]
];
diff --git a/docs/html/search/pages_5.js b/docs/html/search/pages_5.js
index b965ff9..b85c57f 100644
--- a/docs/html/search/pages_5.js
+++ b/docs/html/search/pages_5.js
@@ -1,4 +1,5 @@
var searchData=
[
- ['linear_20allocation_20algorithm_0',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]]
+ ['general_20considerations_0',['General considerations',['../general_considerations.html',1,'index']]],
+ ['gpu_20upload_20heap_1',['GPU upload heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'']]]
];
diff --git a/docs/html/search/pages_6.js b/docs/html/search/pages_6.js
index 2fa4310..6386d6c 100644
--- a/docs/html/search/pages_6.js
+++ b/docs/html/search/pages_6.js
@@ -1,5 +1,5 @@
var searchData=
[
- ['memory_20allocator_0',['D3D12 Memory Allocator',['../index.html',1,'']]],
- ['memory_20pools_1',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
+ ['heap_0',['GPU upload heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'']]],
+ ['helper_20structures_1',['Helper structures',['../quick_start.html#quick_start_helper_structures',1,'']]]
];
diff --git a/docs/html/search/pages_7.js b/docs/html/search/pages_7.js
index 0c3cb7f..75d0639 100644
--- a/docs/html/search/pages_7.js
+++ b/docs/html/search/pages_7.js
@@ -1,5 +1,4 @@
var searchData=
[
- ['optimal_20resource_20allocation_0',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
- ['overlap_1',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]]
+ ['initialization_0',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]]
];
diff --git a/docs/html/search/pages_8.js b/docs/html/search/pages_8.js
index f4128dd..2f270a2 100644
--- a/docs/html/search/pages_8.js
+++ b/docs/html/search/pages_8.js
@@ -1,4 +1,4 @@
var searchData=
[
- ['pools_0',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
+ ['json_20dump_0',['JSON dump',['../statistics.html#statistics_json_dump',1,'']]]
];
diff --git a/docs/html/search/pages_9.js b/docs/html/search/pages_9.js
index c9afe7b..9cdb234 100644
--- a/docs/html/search/pages_9.js
+++ b/docs/html/search/pages_9.js
@@ -1,5 +1,5 @@
var searchData=
[
- ['questions_0',['Frequently asked questions',['../faq.html',1,'index']]],
- ['quick_20start_1',['Quick start',['../quick_start.html',1,'index']]]
+ ['linear_20allocation_20algorithm_0',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
+ ['links_1',['Web links',['../index.html#main_see_also',1,'']]]
];
diff --git a/docs/html/search/pages_a.js b/docs/html/search/pages_a.js
index 53f0a34..0ce8dfd 100644
--- a/docs/html/search/pages_a.js
+++ b/docs/html/search/pages_a.js
@@ -1,5 +1,10 @@
var searchData=
[
- ['resource_20aliasing_20overlap_0',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
- ['resource_20allocation_1',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]]
+ ['making_20virtual_20allocations_0',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]],
+ ['mapping_20memory_1',['Mapping memory',['../quick_start.html#quick_start_mapping_memory',1,'']]],
+ ['margins_2',['Debug margins',['../configuration.html#debug_margins',1,'']]],
+ ['memory_3',['memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'Avoiding running out of memory'],['../quick_start.html#quick_start_mapping_memory',1,'Mapping memory']]],
+ ['memory_20allocator_4',['D3D12 Memory Allocator',['../index.html',1,'']]],
+ ['memory_20allocator_5',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]],
+ ['memory_20pools_6',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
];
diff --git a/docs/html/search/pages_b.js b/docs/html/search/pages_b.js
index d4b7ec0..a1fc386 100644
--- a/docs/html/search/pages_b.js
+++ b/docs/html/search/pages_b.js
@@ -1,5 +1,5 @@
var searchData=
[
- ['start_0',['Quick start',['../quick_start.html',1,'index']]],
- ['statistics_1',['Statistics',['../statistics.html',1,'optimal_allocation']]]
+ ['not_20supported_0',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]],
+ ['numeric_20statistics_1',['Numeric statistics',['../statistics.html#statistics_numeric_statistics',1,'']]]
];
diff --git a/docs/html/search/pages_c.js b/docs/html/search/pages_c.js
index 6f1ceb8..2036541 100644
--- a/docs/html/search/pages_c.js
+++ b/docs/html/search/pages_c.js
@@ -1,4 +1,9 @@
var searchData=
[
- ['virtual_20allocator_0',['Virtual allocator',['../virtual_allocator.html',1,'optimal_allocation']]]
+ ['of_20contents_0',['Table of contents',['../index.html#main_table_of_contents',1,'']]],
+ ['of_20memory_1',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]],
+ ['once_2',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]],
+ ['optimal_20resource_20allocation_3',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
+ ['out_20of_20memory_4',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]],
+ ['overlap_5',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]]
];
diff --git a/docs/html/search/pages_d.js b/docs/html/search/pages_d.js
new file mode 100644
index 0000000..61cd771
--- /dev/null
+++ b/docs/html/search/pages_d.js
@@ -0,0 +1,9 @@
+var searchData=
+[
+ ['parameters_0',['Allocation parameters',['../virtual_allocator.html#virtual_allocator_allocation_parameters',1,'']]],
+ ['performance_1',['Allocation performance',['../optimal_allocation.html#optimal_allocation_allocation_Performance',1,'']]],
+ ['placed_20resources_2',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]],
+ ['pools_3',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]],
+ ['priority_4',['Residency priority',['../optimal_allocation.html#optimal_allocation_residency_priority',1,'']]],
+ ['project_20setup_20and_20initialization_5',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]]
+];
diff --git a/docs/html/search/pages_e.js b/docs/html/search/pages_e.js
new file mode 100644
index 0000000..c9afe7b
--- /dev/null
+++ b/docs/html/search/pages_e.js
@@ -0,0 +1,5 @@
+var searchData=
+[
+ ['questions_0',['Frequently asked questions',['../faq.html',1,'index']]],
+ ['quick_20start_1',['Quick start',['../quick_start.html',1,'index']]]
+];
diff --git a/docs/html/search/pages_f.js b/docs/html/search/pages_f.js
new file mode 100644
index 0000000..97e8dbf
--- /dev/null
+++ b/docs/html/search/pages_f.js
@@ -0,0 +1,12 @@
+var searchData=
+[
+ ['reference_20counting_0',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]],
+ ['residency_20priority_1',['Residency priority',['../optimal_allocation.html#optimal_allocation_residency_priority',1,'']]],
+ ['resource_20aliasing_20overlap_2',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
+ ['resource_20alignment_3',['Resource alignment',['../optimal_allocation.html#optimal_allocation_resource_alignment',1,'']]],
+ ['resource_20allocation_4',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
+ ['resource_20reference_20counting_5',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]],
+ ['resources_6',['resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'Committed versus placed resources'],['../quick_start.html#quick_start_creating_resources',1,'Creating resources']]],
+ ['ring_20buffer_7',['Ring buffer',['../linear_algorithm.html#linear_algorithm_ring_buffer',1,'']]],
+ ['running_20out_20of_20memory_8',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]]
+];
diff --git a/docs/html/search/search.css b/docs/html/search/search.css
index 19f76f9..956f31f 100644
--- a/docs/html/search/search.css
+++ b/docs/html/search/search.css
@@ -5,8 +5,8 @@
display: flex;
justify-content: center;
align-items: center;
- height: 36px;
- margin-right: 1em;
+ height: 43px;
+ margin-right: 0;
}
/*---------------- Search box styling */
@@ -27,43 +27,23 @@ dark-mode-toggle {
white-space : nowrap;
background: var(--search-background-color);
border-radius: 0.65em;
- box-shadow: var(--search-box-shadow);
+ border: 1px solid var(--search-box-border-color);
z-index: 102;
+ margin-right: 4px;
}
#MSearchBox .left {
display: inline-block;
vertical-align: middle;
- height: 1.4em;
-}
-
-#MSearchSelect {
- display: inline-block;
- vertical-align: middle;
- width: 20px;
- height: 19px;
- background-image: var(--search-magnification-select-image);
- margin: 0 0 0 0.3em;
- padding: 0;
+ height: 1.6em;
}
-#MSearchSelectExt {
- display: inline-block;
- vertical-align: middle;
- width: 10px;
- height: 19px;
- background-image: var(--search-magnification-image);
- margin: 0 0 0 0.5em;
- padding: 0;
-}
-
-
#MSearchField {
display: inline-block;
- vertical-align: middle;
+ vertical-align: top;
width: 7.5em;
- height: 19px;
- margin: 0 0.15em;
+ height: 22px;
+ margin: 0 0 0 0.15em;
padding: 0;
line-height: 1em;
border:none;
@@ -86,7 +66,7 @@ dark-mode-toggle {
display: inline-block;
vertical-align: middle;
width: 1.4em;
- height: 1.4em;
+ height: 1.6em;
}
#MSearchClose {
@@ -101,14 +81,100 @@ dark-mode-toggle {
}
#MSearchCloseImg {
- padding: 0.3em;
- margin: 0;
+ margin: 6px 0 0 4px;
+}
+
+.close-icon {
+ width: 11px;
+ height: 11px;
+ background-color: var(--search-close-icon-bg-color);
+ border-radius: 50%;
+ position: relative;
+ display: flex;
+ justify-content: center;
+ align-items: center;
+ box-sizing: content-box;
+}
+
+.close-icon:before,
+.close-icon:after {
+ content: '';
+ position: absolute;
+ width: 7px;
+ height: 1px;
+ background-color: var(--search-close-icon-fg-color);
+}
+
+.close-icon:before {
+ transform: rotate(45deg);
}
+.close-icon:after {
+ transform: rotate(-45deg);
+}
+
+
.MSearchBoxActive #MSearchField {
color: var(--search-active-color);
}
+.search-icon {
+ width: 20px;
+ height: 20px;
+ display: inline-block;
+ position: relative;
+ margin-left: 3px;
+}
+
+#MSearchSelectExt.search-icon {
+ width: 10px;
+}
+
+#MSearchSelectExt + input {
+ margin-left: 5px;
+}
+
+.search-icon::before, .search-icon::after {
+ content: '';
+ position: absolute;
+ border: 1.5px solid var(--search-foreground-color);
+ box-sizing: content-box;
+}
+
+.search-icon::before {
+ width: 6px;
+ height: 6px;
+ border-radius: 50%;
+ top: 7px;
+ left: 2px;
+ background: var(--search-background-color);
+}
+
+.search-icon::after {
+ border: 1px solid var(--search-foreground-color);
+ width: 0px;
+ height: 3px;
+ border-radius: 2px;
+ top: 15px;
+ left: 8px;
+ transform: rotate(-45deg);
+ transform-origin: top left;
+}
+
+.search-icon-dropdown {
+ content: '';
+ width: 0;
+ height: 0;
+ border-left: 3px solid transparent;
+ border-right: 3px solid transparent;
+ border-top: 3px solid var(--search-foreground-color);
+ top: 8px;
+ left: 15px;
+ transform: translateX(-50%);
+ position: absolute;
+}
+
+
/*---------------- Search filter selection */
@@ -119,15 +185,12 @@ dark-mode-toggle {
left: 0; top: 0;
border: 1px solid var(--search-filter-border-color);
background-color: var(--search-filter-background-color);
+ backdrop-filter: var(--search-filter-backdrop-filter);
+ -webkit-backdrop-filter: var(--search-filter-backdrop-filter);
z-index: 10001;
padding-top: 4px;
padding-bottom: 4px;
- -moz-border-radius: 4px;
- -webkit-border-top-left-radius: 4px;
- -webkit-border-top-right-radius: 4px;
- -webkit-border-bottom-left-radius: 4px;
- -webkit-border-bottom-right-radius: 4px;
- -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ border-radius: 4px;
}
.SelectItem {
@@ -176,18 +239,39 @@ iframe#MSearchResults {
height: 15em;
}
+@keyframes slideInSearchResults {
+ from {
+ opacity: 0;
+ transform: translate(0, 15px);
+ }
+
+ to {
+ opacity: 1;
+ transform: translate(0, 20px);
+ }
+}
+
#MSearchResultsWindow {
display: none;
position: absolute;
- left: 0; top: 0;
+ left: auto;
+ right: 4px;
+ top: 0;
border: 1px solid var(--search-results-border-color);
background-color: var(--search-results-background-color);
+ backdrop-filter: var(--search-results-backdrop-filter);
+ -webkit-backdrop-filter: var(--search-results-backdrop-filter);
z-index:10000;
width: 300px;
height: 400px;
overflow: auto;
+ border-radius: 8px;
+ transform: translate(0, 20px);
+ animation: ease-out 280ms slideInSearchResults;
+ box-shadow: 0 2px 8px 0 rgba(0,0,0,.075);
}
+
/* ----------------------------------- */
@@ -201,13 +285,13 @@ iframe#MSearchResults {
}
.SRPage .SREntry {
- font-size: 8pt;
- padding: 1px 5px;
+ font-size: 10pt;
+ padding: 2px 5px;
}
div.SRPage {
margin: 5px 2px;
- background-color: var(--search-results-background-color);
+ /*background-color: var(--search-results-background-color);*/
}
.SRChildren {
@@ -261,14 +345,17 @@ div.searchresults {
margin-right: 10px;
}
+#searchBoxPos1 dark-mode-toggle {
+ margin-top: 4px;
+}
+
/*---------------- External search page results */
.pages b {
- color: white;
+ color: var(--nav-foreground-color);
padding: 5px 5px 3px 5px;
- background-image: var(--nav-gradient-active-image-parent);
- background-repeat: repeat-x;
- text-shadow: 0 1px 1px #000000;
+ background-color: var(--nav-menu-active-bg);
+ border-radius: 4px;
}
.pages {
diff --git a/docs/html/search/search.js b/docs/html/search/search.js
index 666af01..dc14410 100644
--- a/docs/html/search/search.js
+++ b/docs/html/search/search.js
@@ -607,6 +607,12 @@ function createResults(resultsPath) {
elem.setAttribute('className',attr);
}
+ const decodeHtml = (html) => {
+ const txt = document.createElement("textarea");
+ txt.innerHTML = html;
+ return txt.value;
+ };
+
const results = document.getElementById("SRResults");
results.innerHTML = '';
searchData.forEach((elem,index) => {
@@ -620,10 +626,14 @@ function createResults(resultsPath) {
srLink.setAttribute('id','Item'+index);
setKeyActions(srLink,'return searchResults.Nav(event,'+index+')');
setClassAttr(srLink,'SRSymbol');
- srLink.innerHTML = elem[1][0];
+ srLink.innerHTML = decodeHtml(elem[1][0]);
srEntry.appendChild(srLink);
if (elem[1].length==2) { // single result
- srLink.setAttribute('href',resultsPath+elem[1][1][0]);
+ if (elem[1][1][0].startsWith('http://') || elem[1][1][0].startsWith('https://')) { // absolute path
+ srLink.setAttribute('href',elem[1][1][0]);
+ } else { // relative path
+ srLink.setAttribute('href',resultsPath+elem[1][1][0]);
+ }
srLink.setAttribute('onclick','searchBox.CloseResultsWindow()');
if (elem[1][1][1]) {
srLink.setAttribute('target','_parent');
@@ -632,7 +642,7 @@ function createResults(resultsPath) {
}
const srScope = document.createElement('span');
setClassAttr(srScope,'SRScope');
- srScope.innerHTML = elem[1][1][2];
+ srScope.innerHTML = decodeHtml(elem[1][1][2]);
srEntry.appendChild(srScope);
} else { // multiple results
srLink.setAttribute('href','javascript:searchResults.Toggle("SR_'+id+'")');
@@ -643,14 +653,18 @@ function createResults(resultsPath) {
srChild.setAttribute('id','Item'+index+'_c'+c);
setKeyActions(srChild,'return searchResults.NavChild(event,'+index+','+c+')');
setClassAttr(srChild,'SRScope');
- srChild.setAttribute('href',resultsPath+elem[1][c+1][0]);
+ if (elem[1][c+1][0].startsWith('http://') || elem[1][c+1][0].startsWith('https://')) { // absolute path
+ srChild.setAttribute('href',elem[1][c+1][0]);
+ } else { // relative path
+ srChild.setAttribute('href',resultsPath+elem[1][c+1][0]);
+ }
srChild.setAttribute('onclick','searchBox.CloseResultsWindow()');
if (elem[1][c+1][1]) {
srChild.setAttribute('target','_parent');
} else {
srChild.setAttribute('target','_blank');
}
- srChild.innerHTML = elem[1][c+1][2];
+ srChild.innerHTML = decodeHtml(elem[1][c+1][2]);
srChildren.appendChild(srChild);
}
srEntry.appendChild(srChildren);
diff --git a/docs/html/search/searchdata.js b/docs/html/search/searchdata.js
index 1b7813a..2029dc1 100644
--- a/docs/html/search/searchdata.js
+++ b/docs/html/search/searchdata.js
@@ -11,7 +11,7 @@ var indexSectionsWithContent =
8: "adpv",
9: "cd",
10: "d",
- 11: "acdfglmopqrsv"
+ 11: "abcdfghijlmnopqrstuvw"
};
var indexSectionNames =
diff --git a/docs/html/statistics.html b/docs/html/statistics.html
index f261c65..b9b1e29 100644
--- a/docs/html/statistics.html
+++ b/docs/html/statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Statistics
-
-
@@ -33,33 +31,22 @@
-
+
-
- Statistics
+ Statistics
This library contains several functions that return information about its internal state, especially the amount of memory allocated from D3D12.
-
+
Numeric statistics
If you need to obtain basic statistics about memory usage per memory segment group, together with current budget, you can call function D3D12MA::Allocator::GetBudget() and inspect structure D3D12MA::Budget. This is useful to keep track of memory usage and stay withing budget. Example:
D3D12MA::Budget localBudget;
@@ -112,8 +99,8 @@
UINT64 UsageBytesEstimated current memory usage of the program.Definition D3D12MemAlloc.h:486
You can query for more detailed statistics per heap type, memory segment group, and totals, including minimum and maximum allocation size and unused range size, by calling function D3D12MA::Allocator::CalculateStatistics() and inspecting structure D3D12MA::TotalStatistics. This function is slower though, as it has to traverse all the internal data structures, so it should be used only for debugging purposes.
You can query for statistics of a custom pool using function D3D12MA::Pool::GetStatistics() or D3D12MA::Pool::CalculateStatistics().
-You can query for information about a specific allocation using functions of the D3D12MA::Allocation class, e.g. GetSize(), GetOffset(), GetHeap().
-
+
You can query for information about a specific allocation using functions of the D3D12MA::Allocation class, e.g. GetSize(), GetOffset(), GetHeap().
+
JSON dump
You can dump internal state of the allocator to a string in JSON format using function D3D12MA::Allocator::BuildStatsString(). The result is guaranteed to be correct JSON. It uses Windows Unicode (UTF-16) encoding. Any strings provided by user (see D3D12MA::Allocation::SetName()) are copied as-is and properly escaped for JSON. It must be freed using function D3D12MA::Allocator::FreeStatsString().
The format of this JSON string is not part of official documentation of the library, but it will not change in backward-incompatible way without increasing library major version number and appropriate mention in changelog.
@@ -122,7 +109,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html
index 223cc58..f967c0c 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html
index bb90eaa..495fe3f 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::ALLOCATION_CALLBACKS Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
ALLOCATE_FUNC_PTR pAllocate Allocation function.
FREE_FUNC_PTR pFree Dellocation function.
void * pPrivateData Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
-Detailed Description
+Detailed Description
Custom callbacks to CPU memory allocation functions.
-Member Data Documentation
+Member Data Documentation
◆ pAllocate
@@ -159,7 +143,7 @@
-Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
+Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
@@ -169,7 +153,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 0dd1a39..f398da5 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -102,7 +89,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 5363747..d914ec6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,33 +90,28 @@
Inheritance diagram for D3D12MA::ALLOCATION_DESC:
-
-
-
+
Public Attributes
ALLOCATION_FLAGS Flags Flags for the allocation.
D3D12_HEAP_TYPE HeapType The type of memory heap where the new allocation should be placed.
D3D12_HEAP_FLAGS ExtraHeapFlags Additional heap flags to be used when allocating memory.
Pool * CustomPool Custom pool to place the new resource in. Optional.
void * pPrivateData Custom general-purpose pointer that will be stored in D3D12MA::Allocation.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.
-Member Data Documentation
+Member Data Documentation
◆ CustomPool
@@ -143,7 +125,7 @@
Custom pool to place the new resource in. Optional.
-When not null, the resource will be created inside specified custom pool. Members HeapType, ExtraHeapFlags are then ignored.
+When not null, the resource will be created inside specified custom pool. Members HeapType, ExtraHeapFlags are then ignored.
@@ -162,9 +144,9 @@ D3D12MA::Allocator::CreateResource(), you don't need to care. Necessary flag D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, or D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES is added automatically.
-- If you use D3D12MA::Allocator::AllocateMemory(), you should specify one of those
ALLOW_ONLY flags. Except when you validate that D3D12MA::Allocator::GetD3D12Options().ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1 - then you can leave it 0.
-- You can specify additional flags if needed. Then the memory will always be allocated as separate block using
D3D12Device::CreateCommittedResource or CreateHeap, not as part of an existing larget block.
+- If you use D3D12MA::Allocator::CreateResource(), you don't need to care. Necessary flag D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, or D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES is added automatically.
+- If you use D3D12MA::Allocator::AllocateMemory(), you should specify one of those ALLOW_ONLY flags. Except when you validate that D3D12MA::Allocator::GetD3D12Options().ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1 - then you can leave it 0.
+- You can specify additional flags if needed. Then the memory will always be allocated as separate block using D3D12Device::CreateCommittedResource or CreateHeap, not as part of an existing larget block.
When D3D12MA::ALLOCATION_DESC::CustomPool != NULL this member is ignored.
@@ -199,7 +181,7 @@
The type of memory heap where the new allocation should be placed.
-It must be one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK.
+It must be one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK.
When D3D12MA::ALLOCATION_DESC::CustomPool != NULL this member is ignored.
@@ -226,7 +208,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html
index ccc6e9d..cfc611c 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -102,7 +89,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html
index 8673896..33029a6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::ALLOCATOR_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
ALLOCATOR_FLAGS Flags Flags for the entire allocator.
ID3D12Device * pDevice UINT64 PreferredBlockSize Preferred size of a single ID3D12Heap block to be allocated.
Preferred size of a single ID3D12Heap block to be allocated.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
IDXGIAdapter * pAdapter
-Detailed Description
+Detailed Description
Parameters of created Allocator object. To be used with CreateAllocator().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -148,7 +130,7 @@
DXGI Adapter object that you use for D3D12 and this allocator.
-Allocator is doing AddRef/Release on this object.
+Allocator is doing AddRef/Release on this object.
@@ -181,7 +163,7 @@
Direct3D device object that the allocator should be attached to.
-Allocator is doing AddRef/Release on this object.
+Allocator is doing AddRef/Release on this object.
@@ -197,7 +179,7 @@
-Preferred size of a single ID3D12Heap block to be allocated.
+Preferred size of a single ID3D12Heap block to be allocated.
Set to 0 to use default, which is currently 64 MiB.
@@ -208,7 +190,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_budget-members.html b/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
index ddeda17..26e4bee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_budget.html b/docs/html/struct_d3_d12_m_a_1_1_budget.html
index 4798ab6..8e8f354 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_budget.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_budget.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Budget Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Statistics fetched from the library.
UINT64 UsageBytes Estimated current memory usage of the program.
UINT64 BudgetBytes Estimated amount of memory available to the program.
-Detailed Description
+Detailed Description
Statistics of current memory usage and available budget for a specific memory segment group.
These are fast to calculate. See function D3D12MA::Allocator::GetBudget().
-Member Data Documentation
+Member Data Documentation
◆ BudgetBytes
@@ -129,8 +113,8 @@
Estimated amount of memory available to the program.
-Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
-It might be different (most probably smaller) than memory capacity returned by D3D12MA::Allocator::GetMemoryCapacity() due to factors external to the program, decided by the operating system. Difference BudgetBytes - UsageBytes is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.
+Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
+It might be different (most probably smaller) than memory capacity returned by D3D12MA::Allocator::GetMemoryCapacity() due to factors external to the program, decided by the operating system. Difference BudgetBytes - UsageBytes is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.
@@ -163,8 +147,8 @@
Estimated current memory usage of the program.
-Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
-It might be different than BlockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipeline state objects, descriptor heaps, command lists, or heaps and resources allocated outside of this library, if any.
+Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
+It might be different than BlockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipeline state objects, descriptor heaps, command lists, or heaps and resources allocated outside of this library, if any.
@@ -174,7 +158,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 656581f..9423c7f 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 49c2950..cae7b08 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,49 +90,40 @@
Inheritance diagram for D3D12MA::CALLOCATION_DESC:
-
-
-
+
Public Member Functions
CALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CALLOCATION_DESC (const ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::ALLOCATION_DESC structure.
CALLOCATION_DESC (Pool *customPool, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of an allocation to be created in a specific custom pool.
CALLOCATION_DESC (D3D12_HEAP_TYPE heapType, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL, D3D12_HEAP_FLAGS extraHeapFlags=D3D12MA_RECOMMENDED_HEAP_FLAGS) noexcept Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::ALLOCATION_DESC Public Attributes inherited from D3D12MA::ALLOCATION_DESC ALLOCATION_FLAGS Flags Flags for the allocation.
D3D12_HEAP_TYPE HeapType The type of memory heap where the new allocation should be placed.
D3D12_HEAP_FLAGS ExtraHeapFlags Additional heap flags to be used when allocating memory.
Pool * CustomPool Custom pool to place the new resource in. Optional.
void * pPrivateData Custom general-purpose pointer that will be stored in D3D12MA::Allocation.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CALLOCATION_DESC() [1/4]
@@ -273,7 +251,7 @@
-Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
+Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
@@ -283,7 +261,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
index 1cb0dea..66262d0 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -110,7 +97,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
index fb6bf6f..37f7330 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CPOOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,61 +90,48 @@
Inheritance diagram for D3D12MA::CPOOL_DESC:
-
-
-
+
Public Member Functions
CPOOL_DESC ()=default Default constructor. Leaves the structure uninitialized.
CPOOL_DESC (const POOL_DESC &o) noexcept Constructor initializing from the base D3D12MA::POOL_DESC structure.
CPOOL_DESC (D3D12_HEAP_TYPE heapType, D3D12_HEAP_FLAGS heapFlags, POOL_FLAGS flags=D3D12MA_RECOMMENDED_POOL_FLAGS, UINT64 blockSize=0, UINT minBlockCount=0, UINT maxBlockCount=UINT_MAX, D3D12_RESIDENCY_PRIORITY residencyPriority=D3D12_RESIDENCY_PRIORITY_NORMAL) noexcept Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
CPOOL_DESC (const D3D12_HEAP_PROPERTIES heapProperties, D3D12_HEAP_FLAGS heapFlags, POOL_FLAGS flags=D3D12MA_RECOMMENDED_POOL_FLAGS, UINT64 blockSize=0, UINT minBlockCount=0, UINT maxBlockCount=UINT_MAX, D3D12_RESIDENCY_PRIORITY residencyPriority=D3D12_RESIDENCY_PRIORITY_NORMAL) noexcept Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::POOL_DESC Public Attributes inherited from D3D12MA::POOL_DESC POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CPOOL_DESC() [1/4]
@@ -264,7 +238,7 @@
-Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
+Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
@@ -320,7 +294,7 @@
-Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
+Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
@@ -330,7 +304,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 8eb5d11..da976da 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -104,7 +91,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index cb1fe74..714062b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,43 +90,36 @@
Inheritance diagram for D3D12MA::CVIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_ALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_ALLOCATION_DESC (const VIRTUAL_ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
CVIRTUAL_ALLOCATION_DESC (UINT64 size, UINT64 alignment, VIRTUAL_ALLOCATION_FLAGS flags=VIRTUAL_ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of a virtual allocation with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_ALLOCATION_DESC() [1/3]
@@ -241,7 +221,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index eeecc96..27af579 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index 78fbb71..e24e9a8 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,40 +90,34 @@
Inheritance diagram for D3D12MA::CVIRTUAL_BLOCK_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_BLOCK_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_BLOCK_DESC (const VIRTUAL_BLOCK_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_BLOCK_DESC structure.
CVIRTUAL_BLOCK_DESC (UINT64 size, VIRTUAL_BLOCK_FLAGS flags=VIRTUAL_BLOCK_FLAG_NONE, const ALLOCATION_CALLBACKS *allocationCallbacks=NULL) noexcept Constructor initializing description of a virtual block with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_BLOCK_DESC() [1/3]
@@ -233,7 +214,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
index 698ab11..69adefa 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
index c65cd1a..242a2ed 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_FLAGS Flags Flags.
UINT64 MaxBytesPerPass Maximum numbers of bytes that can be copied during single pass, while moving allocations to different places.
UINT32 MaxAllocationsPerPass Maximum number of allocations that can be moved during single pass to a different place.
-Detailed Description
+Detailed Description
Parameters for defragmentation.
To be used with functions Allocator::BeginDefragmentation() and Pool::BeginDefragmentation().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -172,7 +156,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
index 4fed39a..f20848d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
index 8a8bf70..87c182e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_MOVE Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_MOVE_OPERATION Operation Operation to be performed on the allocation by DefragmentationContext::EndPass(). Default value is DEFRAGMENTATION_MOVE_OPERATION_COPY. You can modify it.
Allocation * pSrcAllocation Allocation that should be moved.
Allocation * pDstTmpAllocation Temporary allocation pointing to destination memory that will replace pSrcAllocation.
Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Detailed Description
+Detailed Description
Single move of an allocation to be done for defragmentation.
-Member Data Documentation
+Member Data Documentation
◆ Operation
@@ -143,9 +127,9 @@
-Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
-- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make
pSrcAllocation point to this memory.
+Temporary allocation pointing to destination memory that will replace pSrcAllocation.
+Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
+- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make pSrcAllocation point to this memory.
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
index 28aefc6..3e0a1e4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -99,7 +86,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
index 1212826..6e37ac2 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,19 +87,17 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT32 MoveCount Number of elements in the pMoves array.
Number of elements in the pMoves array.
DEFRAGMENTATION_MOVE * pMoves Array of moves to be performed by the user in the current defragmentation pass.
-Detailed Description
+Detailed Description
Parameters for incremental defragmentation steps.
To be used with function DefragmentationContext::BeginPass().
-Member Data Documentation
+Member Data Documentation
◆ MoveCount
@@ -125,7 +110,7 @@
-Number of elements in the pMoves array.
+Number of elements in the pMoves array.
@@ -142,12 +127,12 @@
Array of moves to be performed by the user in the current defragmentation pass.
-Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
+Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
For each element, you should:
-- Create a new resource in the place pointed by
pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
-- Store new resource in
pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
-- Copy data from the
pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
+- Create a new resource in the place pointed by pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
+- Store new resource in pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
+- Copy data from the pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
- Make sure these commands finished executing on the GPU.
Only then you can finish defragmentation pass by calling DefragmentationContext::EndPass(). After this call, the allocation will point to the new place in memory.
@@ -162,7 +147,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
index 6723fa3..be2d910 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
index b7f806d..220d0bd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_STATS Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,24 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 BytesMoved Total number of bytes that have been copied while moving allocations to different places.
UINT64 BytesFreed Total number of bytes that have been released to the system by freeing empty heaps.
UINT32 AllocationsMoved Number of allocations that have been moved to different places.
UINT32 HeapsFreed Number of empty ID3D12Heap objects that have been released to the system.
Number of empty ID3D12Heap objects that have been released to the system.
-Detailed Description
+Detailed Description
Statistics returned for defragmentation process by function DefragmentationContext::GetStats().
-Member Data Documentation
+Member Data Documentation
◆ AllocationsMoved
@@ -178,7 +161,7 @@
-Number of empty ID3D12Heap objects that have been released to the system.
+Number of empty ID3D12Heap objects that have been released to the system.
@@ -188,7 +171,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
index 9167002..13c5446 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
index f4f534a..88fa33d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DetailedStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,35 +87,29 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Basic statistics.
UINT UnusedRangeCount Number of free ranges of memory between allocations.
UINT64 AllocationSizeMin Smallest allocation size. UINT64_MAX if there are 0 allocations.
Smallest allocation size. UINT64_MAX if there are 0 allocations.
UINT64 AllocationSizeMax Largest allocation size. 0 if there are 0 allocations.
UINT64 UnusedRangeSizeMin Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
UINT64 UnusedRangeSizeMax Largest empty range size. 0 if there are 0 empty ranges.
-Detailed Description
+Detailed Description
More detailed statistics than D3D12MA::Statistics.
These are slower to calculate. Use for debugging purposes. See functions: D3D12MA::Allocator::CalculateStatistics(), D3D12MA::Pool::CalculateStatistics().
Averages are not provided because they can be easily calculated as:
UINT64 AllocationSizeAvg = DetailedStats.Statistics.AllocationBytes / detailedStats.Statistics.AllocationCount;
UINT64 UnusedBytes = DetailedStats.Statistics.BlockBytes - DetailedStats.Statistics.AllocationBytes;
UINT64 UnusedRangeSizeAvg = UnusedBytes / DetailedStats.UnusedRangeCount;
- Member Data Documentation
+ Member Data Documentation
◆ AllocationSizeMax
@@ -157,7 +138,7 @@
-Smallest allocation size. UINT64_MAX if there are 0 allocations.
+Smallest allocation size. UINT64_MAX if there are 0 allocations.
@@ -221,7 +202,7 @@
-Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
+Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
@@ -231,7 +212,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
index 2ae0d33..654ade6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
index fcb0f64..d812aff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::POOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,45 +90,36 @@
Inheritance diagram for D3D12MA::POOL_DESC:
-
-
-
+
Public Attributes
POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool.
-Member Data Documentation
+Member Data Documentation
◆ BlockSize
@@ -189,7 +167,7 @@
Heap flags to be used when allocating heaps of this pool.
-It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
+It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
It is recommended to also add D3D12MA_RECOMMENDED_POOL_FLAGS. You can specify additional flags if needed.
@@ -207,7 +185,7 @@
The parameters of memory heap where allocations of this pool should be placed.
-In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
+In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
@@ -224,7 +202,7 @@
Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
-Set to 0 to use default, which is UINT64_MAX, which means no limit.
+Set to 0 to use default, which is UINT64_MAX, which means no limit.
Set to same value as D3D12MA::POOL_DESC::MinBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.
@@ -293,10 +271,10 @@
Residency priority to be set for all allocations made in this pool. Optional.
-Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
-Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
-This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
-There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
+Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
+Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
+This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
+There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
@@ -306,7 +284,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
index a970156..67b61fe 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
index b7e7c30..853c2ff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Statistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,21 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT BlockCount Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
UINT AllocationCount Number of D3D12MA::Allocation objects allocated.
UINT64 BlockBytes Number of bytes allocated in memory blocks.
UINT64 AllocationBytes Total number of bytes occupied by all D3D12MA::Allocation objects.
-Detailed Description
+Detailed Description
Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total.
These are fast to calculate. See functions: D3D12MA::Allocator::GetBudget(), D3D12MA::Pool::GetStatistics().
-Member Data Documentation
+Member Data Documentation
◆ AllocationBytes
@@ -132,7 +115,7 @@
Total number of bytes occupied by all D3D12MA::Allocation objects.
-Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
+Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
@@ -149,7 +132,7 @@
Number of D3D12MA::Allocation objects allocated.
-Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
+Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
@@ -181,7 +164,7 @@
-Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
+Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
-
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
| [out] | ppStatsString | Must be freed using Allocator::FreeStatsString. |
| DetailedMap | TRUE to include full list of allocations (can make the string quite long), FALSE to only return statistics. | |
| DetailedMap | TRUE to include full list of allocations (can make the string quite long), FALSE to only return statistics. |
| pAllocation | Existing allocation indicating the memory where the new resource should be created. It can be created using D3D12MA::Allocator::CreateResource and already have a resource bound to it, or can be a raw memory allocated with D3D12MA::Allocator::AllocateMemory. It must not be created as committed so that ID3D12Heap is available and not implicit. | |
| AllocationLocalOffset | Additional offset in bytes to be applied when allocating the resource. Local from the start of pAllocation, not the beginning of the whole ID3D12Heap! If the new resource should start from the beginning of the pAllocation it should be 0. | |
| pAllocation | Existing allocation indicating the memory where the new resource should be created. It can be created using D3D12MA::Allocator::CreateResource and already have a resource bound to it, or can be a raw memory allocated with D3D12MA::Allocator::AllocateMemory. It must not be created as committed so that ID3D12Heap is available and not implicit. | |
| AllocationLocalOffset | Additional offset in bytes to be applied when allocating the resource. Local from the start of pAllocation, not the beginning of the whole ID3D12Heap! If the new resource should start from the beginning of the pAllocation it should be 0. | |
| pResourceDesc | Description of the new resource to be created. | |
| InitialResourceState | ||
| pOptimizedClearValue | ||
| riidResource | ||
| [out] | ppvResource | Returns pointer to the new resource. The resource is not bound with pAllocation. This pointer must not be null - you must get the resource pointer and Release it when no longer needed. |
| [out] | ppvResource | Returns pointer to the new resource. The resource is not bound with pAllocation. This pointer must not be null - you must get the resource pointer and Release it when no longer needed. |
Memory requirements of the new resource are checked for validation. If its size exceeds the end of pAllocation or required alignment is not fulfilled considering pAllocation->GetOffset() + AllocationLocalOffset, the function returns E_INVALIDARG.
Memory requirements of the new resource are checked for validation. If its size exceeds the end of pAllocation or required alignment is not fulfilled considering pAllocation->GetOffset() + AllocationLocalOffset, the function returns E_INVALIDARG.
@@ -390,9 +358,9 @@
-Similar to Allocator::CreateAliasingResource, but supports new structure D3D12_RESOURCE_DESC1.
-It internally uses ID3D12Device8::CreatePlacedResource1.
-To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
+Similar to Allocator::CreateAliasingResource, but supports new structure D3D12_RESOURCE_DESC1.
+It internally uses ID3D12Device8::CreatePlacedResource1.
+To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
@@ -451,8 +419,8 @@
Similar to Allocator::CreateAliasingResource1, but there are initial layout instead of state and castable formats list.
-It internally uses ID3D12Device10::CreatePlacedResource2.
-To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
+It internally uses ID3D12Device10::CreatePlacedResource2.
+To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
@@ -524,9 +492,9 @@
Allocates memory and creates a D3D12 resource (buffer or texture). This is the main allocation function.
-The function is similar to ID3D12Device::CreateCommittedResource, but it may really call ID3D12Device::CreatePlacedResource to assign part of a larger, existing memory heap to the new resource, which is the main purpose of this whole library.
-If ppvResource is null, you receive only ppAllocation object from this function. It holds pointer to ID3D12Resource that can be queried using function D3D12MA::Allocation::GetResource(). Reference count of the resource object is 1. It is automatically destroyed when you destroy the allocation object.
-If ppvResource is not null, you receive pointer to the resource next to allocation object. Reference count of the resource object is then increased by calling QueryInterface, so you need to manually Release it along with the allocation.
+The function is similar to ID3D12Device::CreateCommittedResource, but it may really call ID3D12Device::CreatePlacedResource to assign part of a larger, existing memory heap to the new resource, which is the main purpose of this whole library.
+If ppvResource is null, you receive only ppAllocation object from this function. It holds pointer to ID3D12Resource that can be queried using function D3D12MA::Allocation::GetResource(). Reference count of the resource object is 1. It is automatically destroyed when you destroy the allocation object.
+If ppvResource is not null, you receive pointer to the resource next to allocation object. Reference count of the resource object is then increased by calling QueryInterface, so you need to manually Release it along with the allocation.
- Parameters
-
@@ -587,9 +555,9 @@
-Similar to Allocator::CreateResource, but supports new structure D3D12_RESOURCE_DESC1.
-It internally uses ID3D12Device8::CreateCommittedResource2 or ID3D12Device8::CreatePlacedResource1.
-To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
+Similar to Allocator::CreateResource, but supports new structure D3D12_RESOURCE_DESC1.
+It internally uses ID3D12Device8::CreateCommittedResource2 or ID3D12Device8::CreatePlacedResource1.
+To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
@@ -648,8 +616,8 @@
Similar to Allocator::CreateResource2, but there are initial layout instead of state and castable formats list.
-It internally uses ID3D12Device10::CreateCommittedResource3 or ID3D12Device10::CreatePlacedResource2.
-To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
+It internally uses ID3D12Device10::CreateCommittedResource3 or ID3D12Device10::CreatePlacedResource2.
+To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
@@ -700,14 +668,14 @@ IsUMA() == FALSE (discrete graphics card):
-pLocalBudget returns the budget of the video memory.pNonLocalBudget returns the budget of the system memory available for D3D12 resources.- When IsUMA() == FALSE (discrete graphics card):
+- pLocalBudget returns the budget of the video memory.
+- pNonLocalBudget returns the budget of the system memory available for D3D12 resources.
-- When IsUMA()
== TRUE (integrated graphics chip):
-pLocalBudget returns the budget of the shared memory available for all D3D12 resources. All memory is considered "local".pNonLocalBudget is not applicable and returns zeros.- When IsUMA() == TRUE (integrated graphics chip):
+- pLocalBudget returns the budget of the shared memory available for all D3D12 resources. All memory is considered "local".
+- pNonLocalBudget is not applicable and returns zeros.
@@ -753,20 +721,20 @@ - Parameters
-
- memorySegmentGroup use DXGI_MEMORY_SEGMENT_GROUP_LOCAL or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL. memorySegmentGroup use DXGI_MEMORY_SEGMENT_GROUP_LOCAL or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL.
-This information is taken from DXGI_ADAPTER_DESC. It is not recommended to use this number. You should preferably call GetBudget() and limit memory usage to D3D12MA::Budget::BudgetBytes instead.
+This information is taken from DXGI_ADAPTER_DESC. It is not recommended to use this number. You should preferably call GetBudget() and limit memory usage to D3D12MA::Budget::BudgetBytes instead.
-- When IsUMA()
== FALSE (discrete graphics card):
-GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the video memory.GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) returns the size of the system memory available for D3D12 resources.- When IsUMA() == FALSE (discrete graphics card):
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the video memory.
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) returns the size of the system memory available for D3D12 resources.
-- When IsUMA()
== TRUE (integrated graphics chip):
-GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the shared memory available for all D3D12 resources. All memory is considered "local".GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) is not applicable and returns 0. - When IsUMA() == TRUE (integrated graphics chip):
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the shared memory available for all D3D12 resources. All memory is considered "local".
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) is not applicable and returns 0.
@@ -788,7 +756,7 @@
-Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMA was found to be true.
+Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMA was found to be true.
For more information about how to use it, see articles in Microsoft Docs articles:
- "UMA Optimizations: CPU Accessible Textures and Standard Swizzle"
@@ -814,8 +782,8 @@
Returns true if GPU Upload Heaps are supported on the current system.
-When true, you can use D3D12_HEAP_TYPE_GPU_UPLOAD.
-This flag is fetched from D3D12_FEATURE_D3D12_OPTIONS16::GPUUploadHeapSupported.
+When true, you can use D3D12_HEAP_TYPE_GPU_UPLOAD.
+This flag is fetched from D3D12_FEATURE_D3D12_OPTIONS16::GPUUploadHeapSupported.
@@ -834,7 +802,7 @@
-Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::UMA was found to be true.
+Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::UMA was found to be true.
For more information about how to use it, see articles in Microsoft Docs articles:
- "UMA Optimizations: CPU Accessible Textures and Standard Swizzle"
@@ -870,7 +838,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html
index 4049a20..6cfb1dd 100644
--- a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html
index 405cb9f..7ab0038 100644
--- a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html
+++ b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DefragmentationContext Class Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,22 +93,19 @@
-
+
Public Member Functions
HRESULT BeginPass (DEFRAGMENTATION_PASS_MOVE_INFO *pPassInfo) Starts single defragmentation pass.
HRESULT EndPass (DEFRAGMENTATION_PASS_MOVE_INFO *pPassInfo) Ends single defragmentation pass.
void GetStats (DEFRAGMENTATION_STATS *pStats) Returns statistics of the defragmentation performed so far.
-Detailed Description
+Detailed Description
Represents defragmentation process in progress.
You can create this object using Allocator::BeginDefragmentation (for default pools) or Pool::BeginDefragmentation (for a custom pool).
-Member Function Documentation
+Member Function Documentation
◆ BeginPass()
@@ -145,8 +129,8 @@ - Returns
-S_OK if no more moves are possible. Then you can omit call to DefragmentationContext::EndPass() and simply end whole defragmentation.S_FALSE if there are pending moves returned in pPassInfo. You need to perform them, call DefragmentationContext::EndPass(), and then preferably try another pass with DefragmentationContext::BeginPass(). - S_OK if no more moves are possible. Then you can omit call to DefragmentationContext::EndPass() and simply end whole defragmentation.
+- S_FALSE if there are pending moves returned in pPassInfo. You need to perform them, call DefragmentationContext::EndPass(), and then preferably try another pass with DefragmentationContext::BeginPass().
- Returns
- Returns
S_OK if no more moves are possible or S_FALSE if more defragmentations are possible.
-Ends incremental defragmentation pass and commits all defragmentation moves from pPassInfo. After this call:
+- Returns
- Returns S_OK if no more moves are possible or S_FALSE if more defragmentations are possible.
+Ends incremental defragmentation pass and commits all defragmentation moves from pPassInfo. After this call:
-- Allocation at
pPassInfo[i].pSrcAllocation that had pPassInfo[i].Operation == DEFRAGMENTATION_MOVE_OPERATION_COPY (which is the default) will be pointing to the new destination place.
-- Allocation at
pPassInfo[i].pSrcAllocation that had pPassInfo[i].operation == DEFRAGMENTATION_MOVE_OPERATION_DESTROY will be released.
+- Allocation at pPassInfo[i].pSrcAllocation that had pPassInfo[i].Operation == DEFRAGMENTATION_MOVE_OPERATION_COPY (which is the default) will be pointing to the new destination place.
+- Allocation at pPassInfo[i].pSrcAllocation that had pPassInfo[i].operation == DEFRAGMENTATION_MOVE_OPERATION_DESTROY will be released.
If no more moves are possible you can end whole defragmentation.
@@ -209,7 +193,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_pool-members.html b/docs/html/class_d3_d12_m_a_1_1_pool-members.html
index e500fb5..9acf601 100644
--- a/docs/html/class_d3_d12_m_a_1_1_pool-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_pool-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -104,7 +91,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_pool.html b/docs/html/class_d3_d12_m_a_1_1_pool.html
index 7aabe1c..07742d9 100644
--- a/docs/html/class_d3_d12_m_a_1_1_pool.html
+++ b/docs/html/class_d3_d12_m_a_1_1_pool.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Pool Class Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,32 +93,26 @@
-
+
Public Member Functions
POOL_DESC GetDesc () const Returns copy of parameters of the pool.
void GetStatistics (Statistics *pStats) Retrieves basic statistics of the custom pool that are fast to calculate.
void CalculateStatistics (DetailedStatistics *pStats) Retrieves detailed statistics of the custom pool that are slower to calculate.
void SetName (LPCWSTR Name) Associates a name with the pool. This name is for use in debug diagnostics and tools.
LPCWSTR GetName () const Returns the name associated with the pool object.
HRESULT BeginDefragmentation (const DEFRAGMENTATION_DESC *pDesc, DefragmentationContext **ppContext) Begins defragmentation process of the current pool.
-Detailed Description
+Detailed Description
Custom memory pool.
Represents a separate set of heaps (memory blocks) that can be used to create D3D12MA::Allocation-s and resources in it. Usually there is no need to create custom pools - creating resources in default pool is sufficient.
To create custom pool, fill D3D12MA::POOL_DESC and call D3D12MA::Allocator::CreatePool.
-Member Function Documentation
+Member Function Documentation
◆ BeginDefragmentation()
@@ -160,8 +141,8 @@ - Returns
-S_OK if defragmentation can begin.E_NOINTERFACE if defragmentation is not supported.- S_OK if defragmentation can begin.
+- E_NOINTERFACE if defragmentation is not supported.
For more information about defragmentation, see documentation chapter: Defragmentation.
@@ -276,7 +257,7 @@ Name can be NULL.
@@ -286,7 +267,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html b/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html
index 190326b..1e40ead 100644
--- a/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -109,7 +96,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_virtual_block.html b/docs/html/class_d3_d12_m_a_1_1_virtual_block.html
index 5f6a3f2..0cb9114 100644
--- a/docs/html/class_d3_d12_m_a_1_1_virtual_block.html
+++ b/docs/html/class_d3_d12_m_a_1_1_virtual_block.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualBlock Class Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,45 +93,35 @@
-
+
Public Member Functions
BOOL IsEmpty () const Returns true if the block is empty - contains 0 allocations.
void GetAllocationInfo (VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) const Returns information about an allocation - its offset, size and custom pointer.
HRESULT Allocate (const VIRTUAL_ALLOCATION_DESC *pDesc, VirtualAllocation *pAllocation, UINT64 *pOffset) Creates new allocation.
void FreeAllocation (VirtualAllocation allocation) Frees the allocation.
void Clear () Frees all the allocations.
void SetAllocationPrivateData (VirtualAllocation allocation, void *pPrivateData) Changes custom pointer for an allocation to a new value.
void GetStatistics (Statistics *pStats) const Retrieves basic statistics of the virtual block that are fast to calculate.
void CalculateStatistics (DetailedStatistics *pStats) const Retrieves detailed statistics of the virtual block that are slower to calculate.
void BuildStatsString (WCHAR **ppStatsString) const Builds and returns statistics as a string in JSON format, including the list of allocations with their parameters.
void FreeStatsString (WCHAR *pStatsString) const Frees memory of a string returned from VirtualBlock::BuildStatsString.
-Detailed Description
+Detailed Description
Represents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory.
This class allows to use the core algorithm of the library custom allocations e.g. CPU memory or sub-allocation regions inside a single GPU buffer.
-To create this object, fill in D3D12MA::VIRTUAL_BLOCK_DESC and call CreateVirtualBlock(). To destroy it, call its method VirtualBlock::Release(). You need to free all the allocations within this block or call Clear() before destroying it.
+To create this object, fill in D3D12MA::VIRTUAL_BLOCK_DESC and call CreateVirtualBlock(). To destroy it, call its method VirtualBlock::Release(). You need to free all the allocations within this block or call Clear() before destroying it.
This object is not thread-safe - should not be used from multiple threads simultaneously, must be synchronized externally.
-Member Function Documentation
+Member Function Documentation
◆ Allocate()
@@ -178,8 +155,8 @@ - Returns
S_OK if allocation succeeded, E_OUTOFMEMORY if it failed.If the allocation failed, pAllocation->AllocHandle is set to 0 and pOffset, if not null, is set to UINT64_MAX.
+- Returns
- S_OK if allocation succeeded, E_OUTOFMEMORY if it failed.
+If the allocation failed, pAllocation->AllocHandle is set to 0 and pOffset, if not null, is set to UINT64_MAX.
@@ -268,7 +245,7 @@
Frees the allocation.
-Calling this function with allocation.AllocHandle == 0 is correct and does nothing.
+Calling this function with allocation.AllocHandle == 0 is correct and does nothing.
@@ -387,7 +364,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/classes.html b/docs/html/classes.html
index 3b8ddf2..e85eb86 100644
--- a/docs/html/classes.html
+++ b/docs/html/classes.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Index
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/configuration.html b/docs/html/configuration.html
index 8eeaa50..65d7bdd 100644
--- a/docs/html/configuration.html
+++ b/docs/html/configuration.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Configuration
-
-
@@ -33,33 +31,22 @@
-
+
-
- Configuration
+ Configuration
-Please check file D3D12MemAlloc.cpp lines between "Configuration Begin" and "Configuration End" to find macros that you can define to change the behavior of the library, primarily for debugging purposes.
-
+Please check file D3D12MemAlloc.cpp lines between "Configuration Begin" and "Configuration End" to find macros that you can define to change the behavior of the library, primarily for debugging purposes.
+
Custom CPU memory allocator
-If you use custom allocator for CPU memory rather than default C++ operator new and delete or malloc and free functions, you can make this library using your allocator as well by filling structure D3D12MA::ALLOCATION_CALLBACKS and passing it as optional member D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks. Functions pointed there will be used by the library to make any CPU-side allocations. Example:
+If you use custom allocator for CPU memory rather than default C++ operator new and delete or malloc and free functions, you can make this library using your allocator as well by filling structure D3D12MA::ALLOCATION_CALLBACKS and passing it as optional member D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks. Functions pointed there will be used by the library to make any CPU-side allocations. Example:
#include <malloc.h>
void* CustomAllocate(size_t Size, size_t Alignment, void* pPrivateData)
@@ -133,11 +120,11 @@
ALLOCATOR_FLAGS FlagsFlags for the entire allocator.Definition D3D12MemAlloc.h:1126
-
+
Debug margins
-
By default, allocations are laid out in memory blocks next to each other if possible (considering required alignment returned by ID3D12Device::GetResourceAllocationInfo).
+By default, allocations are laid out in memory blocks next to each other if possible (considering required alignment returned by ID3D12Device::GetResourceAllocationInfo).
-Define macro D3D12MA_DEBUG_MARGIN to some non-zero value (e.g. 16) inside "D3D12MemAlloc.cpp" to enforce specified number of bytes as a margin after every allocation.
+Define macro D3D12MA_DEBUG_MARGIN to some non-zero value (e.g. 16) inside "D3D12MemAlloc.cpp" to enforce specified number of bytes as a margin after every allocation.
If your bug goes away after enabling margins, it means it may be caused by memory being overwritten outside of allocation boundaries. It is not 100% certain though. Change in application behavior may also be caused by different order and distribution of allocations across memory blocks after margins are applied.
Margins work with all memory heap types.
@@ -149,7 +136,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/custom_pools.html b/docs/html/custom_pools.html
index 9112b38..0bfd570 100644
--- a/docs/html/custom_pools.html
+++ b/docs/html/custom_pools.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Custom memory pools
-
-
@@ -33,33 +31,22 @@
-
+
-
- Custom memory pools
+ Custom memory pools
-A "pool" is a collection of memory blocks that share certain properties. Allocator creates 3 default pools: for D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK. A default pool automatically grows in size. Size of allocated blocks is also variable and managed automatically. Typical allocations are created in these pools. You can also create custom pools.
-
+A "pool" is a collection of memory blocks that share certain properties. Allocator creates 3 default pools: for D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK. A default pool automatically grows in size. Size of allocated blocks is also variable and managed automatically. Typical allocations are created in these pools. You can also create custom pools.
+
Usage
To create a custom pool, fill in structure D3D12MA::POOL_DESC and call function D3D12MA::Allocator::CreatePool to obtain object D3D12MA::Pool. Example:
All allocations must be released before releasing the pool. The pool must be released before relasing the allocator.
alloc->Release();
pool->Release();
-
+
Features and benefits
While it is recommended to use default pools whenever possible for simplicity and to give the allocator more opportunities for internal optimizations, custom pools may be useful in following cases:
- To keep some resources separate from others in memory.
- To keep track of memory usage of just a specific group of resources. Statistics can be queried using D3D12MA::Pool::CalculateStatistics.
-- To use specific size of a memory block (
ID3D12Heap). To set it, use member D3D12MA::POOL_DESC::BlockSize. When set to 0, the library uses automatically determined, variable block sizes.
+- To use specific size of a memory block (ID3D12Heap). To set it, use member D3D12MA::POOL_DESC::BlockSize. When set to 0, the library uses automatically determined, variable block sizes.
- To reserve some minimum amount of memory allocated. To use it, set member D3D12MA::POOL_DESC::MinBlockCount.
- To limit maximum amount of memory allocated. To use it, set member D3D12MA::POOL_DESC::MaxBlockCount.
-- To use extended parameters of the D3D12 memory allocation. While resources created from default pools can only specify
D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK, a custom pool may use non-standard D3D12_HEAP_PROPERTIES (member D3D12MA::POOL_DESC::HeapProperties) and D3D12_HEAP_FLAGS (D3D12MA::POOL_DESC::HeapFlags), which is useful e.g. for cross-adapter sharing or UMA (see also D3D12MA::Allocator::IsUMA).
+- To use extended parameters of the D3D12 memory allocation. While resources created from default pools can only specify D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK, a custom pool may use non-standard D3D12_HEAP_PROPERTIES (member D3D12MA::POOL_DESC::HeapProperties) and D3D12_HEAP_FLAGS (D3D12MA::POOL_DESC::HeapFlags), which is useful e.g. for cross-adapter sharing or UMA (see also D3D12MA::Allocator::IsUMA).
New versions of this library support creating committed allocations in custom pools. It is supported only when D3D12MA::POOL_DESC::BlockSize = 0. To use this feature, set D3D12MA::ALLOCATION_DESC::CustomPool to the pointer to your custom pool and D3D12MA::ALLOCATION_DESC::Flags to D3D12MA::ALLOCATION_FLAG_COMMITTED. Example:
ALLOCATION_DESC allocDesc = {};
@@ -136,12 +123,12 @@
ID3D12Resource* res;
hr = allocator->CreateResource(&allocDesc, &resDesc,
D3D12_RESOURCE_STATE_GENERIC_READ, NULL, &alloc, IID_PPV_ARGS(&res));
-
This feature may seem unnecessary, but creating committed allocations from custom pools may be useful in some cases, e.g. to have separate memory usage statistics for some group of resources or to use extended allocation parameters, like custom D3D12_HEAP_PROPERTIES, which are available only in custom pools.
+This feature may seem unnecessary, but creating committed allocations from custom pools may be useful in some cases, e.g. to have separate memory usage statistics for some group of resources or to use extended allocation parameters, like custom D3D12_HEAP_PROPERTIES, which are available only in custom pools.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/defragmentation.html b/docs/html/defragmentation.html
index d68a400..b82dbde 100644
--- a/docs/html/defragmentation.html
+++ b/docs/html/defragmentation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Defragmentation
-
-
@@ -33,33 +31,22 @@
-
+
-
- Defragmentation
+ Defragmentation
Interleaved allocations and deallocations of many objects of varying size can cause fragmentation over time, which can lead to a situation where the library is unable to find a continuous range of free memory for a new allocation despite there is enough free space, just scattered across many small free ranges between existing allocations.
-To mitigate this problem, you can use defragmentation feature. It doesn't happen automatically though and needs your cooperation, because D3D12MA is a low level library that only allocates memory. It cannot recreate buffers and textures in a new place as it doesn't remember the contents of D3D12_RESOURCE_DESC structure. It cannot copy their contents as it doesn't record any commands to a command list.
+To mitigate this problem, you can use defragmentation feature. It doesn't happen automatically though and needs your cooperation, because D3D12MA is a low level library that only allocates memory. It cannot recreate buffers and textures in a new place as it doesn't remember the contents of D3D12_RESOURCE_DESC structure. It cannot copy their contents as it doesn't record any commands to a command list.
Example:
D3D12MA::DEFRAGMENTATION_DESC defragDesc = {};
defragDesc.Flags = D3D12MA::DEFRAGMENTATION_FLAG_ALGORITHM_FAST;
@@ -162,11 +149,11 @@
Parameters for incremental defragmentation steps.Definition D3D12MemAlloc.h:768
DEFRAGMENTATION_MOVE * pMovesArray of moves to be performed by the user in the current defragmentation pass.Definition D3D12MemAlloc.h:792
UINT32 MoveCountNumber of elements in the pMoves array.Definition D3D12MemAlloc.h:770
-Although functions like D3D12MA::Allocator::CreateResource() create an allocation and a buffer/texture at once, these are just a shortcut for allocating memory and creating a placed resource. Defragmentation works on memory allocations only. You must handle the rest manually. Defragmentation is an iterative process that should repreat "passes" as long as related functions return S_FALSE not S_OK. In each pass:
+Although functions like D3D12MA::Allocator::CreateResource() create an allocation and a buffer/texture at once, these are just a shortcut for allocating memory and creating a placed resource. Defragmentation works on memory allocations only. You must handle the rest manually. Defragmentation is an iterative process that should repreat "passes" as long as related functions return S_FALSE not S_OK. In each pass:
- D3D12MA::DefragmentationContext::BeginPass() function call:
- Calculates and returns the list of allocations to be moved in this pass. Note this can be a time-consuming process.
-- Reserves destination memory for them by creating temporary destination allocations that you can query for their
ID3D12Heap + offset using methods like D3D12MA::Allocation::GetHeap().
+- Reserves destination memory for them by creating temporary destination allocations that you can query for their ID3D12Heap + offset using methods like D3D12MA::Allocation::GetHeap().
- Inside the pass, you should:
@@ -179,40 +166,40 @@
- D3D12MA::DefragmentationContext::EndPass() function call:
- Frees the source memory reserved for the allocations that are moved.
- Modifies source D3D12MA::Allocation objects that are moved to point to the destination reserved memory and destination resource, while source resource is released.
-- Frees
ID3D12Heap blocks that became empty.
+- Frees ID3D12Heap blocks that became empty.
-Defragmentation algorithm tries to move all suitable allocations. You can, however, refuse to move some of them inside a defragmentation pass, by setting pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This is not recommended and may result in suboptimal packing of the allocations after defragmentation. If you cannot ensure any allocation can be moved, it is better to keep movable allocations separate in a custom pool.
+Defragmentation algorithm tries to move all suitable allocations. You can, however, refuse to move some of them inside a defragmentation pass, by setting pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This is not recommended and may result in suboptimal packing of the allocations after defragmentation. If you cannot ensure any allocation can be moved, it is better to keep movable allocations separate in a custom pool.
Inside a pass, for each allocation that should be moved:
-- You should copy its data from the source to the destination place by calling e.g.
CopyResource().
+- You should copy its data from the source to the destination place by calling e.g. CopyResource().
- You need to make sure these commands finished executing before the source buffers/textures are released by D3D12MA::DefragmentationContext::EndPass().
- If a resource doesn't contain any meaningful data, e.g. it is a transient render-target texture to be cleared, filled, and used temporarily in each rendering frame, you can just recreate this texture without copying its data.
-- If the resource is in
D3D12_HEAP_TYPE_READBACK memory, you can copy its data on the CPU using memcpy().
-- If you cannot move the allocation, you can set
pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This will cancel the move.
+- If the resource is in D3D12_HEAP_TYPE_READBACK memory, you can copy its data on the CPU using memcpy().
+- If you cannot move the allocation, you can set pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This will cancel the move.
- D3D12MA::DefragmentationContext::EndPass() will then free the destination memory not the source memory of the allocation, leaving it unchanged.
-- If you decide the allocation is unimportant and can be destroyed instead of moved (e.g. it wasn't used for long time), you can set
pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY.
+- If you decide the allocation is unimportant and can be destroyed instead of moved (e.g. it wasn't used for long time), you can set pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY.
- D3D12MA::DefragmentationContext::EndPass() will then free both source and destination memory, and will destroy the source D3D12MA::Allocation object.
You can defragment a specific custom pool by calling D3D12MA::Pool::BeginDefragmentation or all the default pools by calling D3D12MA::Allocator::BeginDefragmentation (like in the example above).
-Defragmentation is always performed in each pool separately. Allocations are never moved between different heap types. The size of the destination memory reserved for a moved allocation is the same as the original one. Alignment of an allocation as it was determined using GetResourceAllocationInfo() is also respected after defragmentation. Buffers/textures should be recreated with the same D3D12_RESOURCE_DESC parameters as the original ones.
+Defragmentation is always performed in each pool separately. Allocations are never moved between different heap types. The size of the destination memory reserved for a moved allocation is the same as the original one. Alignment of an allocation as it was determined using GetResourceAllocationInfo() is also respected after defragmentation. Buffers/textures should be recreated with the same D3D12_RESOURCE_DESC parameters as the original ones.
You can perform the defragmentation incrementally to limit the number of allocations and bytes to be moved in each pass, e.g. to call it in sync with render frames and not to experience too big hitches. See members: D3D12MA::DEFRAGMENTATION_DESC::MaxBytesPerPass, D3D12MA::DEFRAGMENTATION_DESC::MaxAllocationsPerPass.
Thread safety: It is safe to perform the defragmentation asynchronously to render frames and other Direct3D 12 and D3D12MA usage, possibly from multiple threads, with the exception that allocations returned in D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO::pMoves shouldn't be released until the defragmentation pass is ended. During the call to D3D12MA::DefragmentationContext::BeginPass(), any operations on the memory pool affected by the defragmentation are blocked by a mutex.
-What it means in practice is that you shouldn't free any allocations from the defragmented pool since the moment a call to BeginPass begins. Otherwise, a thread performing the allocation->Release() would block for the time BeginPass executes and then free the allocation when it finishes, while the allocation could have ended up on the list of allocations to move. A solution to freeing allocations during defragmentation is to find such allocation on the list pass.pMoves[i] and set its operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY instead of calling allocation->Release(), or simply deferring the release to the time after defragmentation finished.
+What it means in practice is that you shouldn't free any allocations from the defragmented pool since the moment a call to BeginPass begins. Otherwise, a thread performing the allocation->Release() would block for the time BeginPass executes and then free the allocation when it finishes, while the allocation could have ended up on the list of allocations to move. A solution to freeing allocations during defragmentation is to find such allocation on the list pass.pMoves[i] and set its operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY instead of calling allocation->Release(), or simply deferring the release to the time after defragmentation finished.
Mapping is out of scope of this library and so it is not preserved after an allocation is moved during defragmentation. You need to map the new resource yourself if needed.
- Note
- Defragmentation is not supported in custom pools created with D3D12MA::POOL_FLAG_ALGORITHM_LINEAR.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html b/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
index fa88354..6e6d46e 100644
--- a/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
+++ b/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: C:/Code/D3D12MemoryAllocator/REPO/include Directory Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -92,15 +79,14 @@
-
+
Files
D3D12MemAlloc.h D3D12MemAlloc.h
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/doxygen.css b/docs/html/doxygen.css
index 4947e24..5d2eecd 100644
--- a/docs/html/doxygen.css
+++ b/docs/html/doxygen.css
@@ -1,11 +1,12 @@
-/* The standard CSS for doxygen 1.13.2*/
+/* The standard CSS for doxygen 1.14.0*/
html {
/* page base colors */
--page-background-color: white;
--page-foreground-color: black;
--page-link-color: #3D578C;
---page-visited-link-color: #4665A2;
+--page-visited-link-color: #3D578C;
+--page-external-link-color: #334975;
/* index */
--index-odd-item-bg-color: #F8F9FC;
@@ -16,46 +17,50 @@ html {
/* header */
--header-background-color: #F9FAFC;
--header-separator-color: #C4CFE5;
---header-gradient-image: url('nav_h.png');
---group-header-separator-color: #879ECB;
+--group-header-separator-color: #D9E0EE;
--group-header-color: #354C7B;
--inherit-header-color: gray;
--footer-foreground-color: #2A3D61;
---footer-logo-width: 104px;
+--footer-logo-width: 75px;
--citation-label-color: #334975;
--glow-color: cyan;
--title-background-color: white;
---title-separator-color: #5373B4;
+--title-separator-color: #C4CFE5;
--directory-separator-color: #9CAFD4;
--separator-color: #4A6AAA;
--blockquote-background-color: #F7F8FB;
--blockquote-border-color: #9CAFD4;
---scrollbar-thumb-color: #9CAFD4;
+--scrollbar-thumb-color: #C4CFE5;
--scrollbar-background-color: #F9FAFC;
--icon-background-color: #728DC1;
--icon-foreground-color: white;
+/*
--icon-doc-image: url('doc.svg');
--icon-folder-open-image: url('folderopen.svg');
---icon-folder-closed-image: url('folderclosed.svg');
+--icon-folder-closed-image: url('folderclosed.svg');*/
+--icon-folder-open-fill-color: #C4CFE5;
+--icon-folder-fill-color: #D8DFEE;
+--icon-folder-border-color: #4665A2;
+--icon-doc-fill-color: #D8DFEE;
+--icon-doc-border-color: #4665A2;
/* brief member declaration list */
--memdecl-background-color: #F9FAFC;
--memdecl-separator-color: #DEE4F0;
--memdecl-foreground-color: #555;
--memdecl-template-color: #4665A2;
+--memdecl-border-color: #D5DDEC;
/* detailed member list */
--memdef-border-color: #A8B8D9;
--memdef-title-background-color: #E2E8F2;
---memdef-title-gradient-image: url('nav_f.png');
---memdef-proto-background-color: #DFE5F1;
+--memdef-proto-background-color: #EEF1F7;
--memdef-proto-text-color: #253555;
---memdef-proto-text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
--memdef-doc-background-color: white;
--memdef-param-name-color: #602020;
--memdef-template-color: #4665A2;
@@ -74,29 +79,34 @@ html {
/** navigation bar/tree/menu */
--nav-background-color: #F9FAFC;
--nav-foreground-color: #364D7C;
---nav-gradient-image: url('tab_b.png');
---nav-gradient-hover-image: url('tab_h.png');
---nav-gradient-active-image: url('tab_a.png');
---nav-gradient-active-image-parent: url("../tab_a.png");
---nav-separator-image: url('tab_s.png');
---nav-breadcrumb-image: url('bc_s.png');
---nav-breadcrumb-border-color: #C2CDE4;
---nav-splitbar-image: url('splitbar.png');
+--nav-border-color: #C4CFE5;
+--nav-breadcrumb-separator-color: #C4CFE5;
+--nav-breadcrumb-active-bg: #EEF1F7;
+--nav-breadcrumb-color: #354C7B;
+--nav-breadcrumb-border-color: #E1E7F2;
+--nav-splitbar-bg-color: #DCE2EF;
+--nav-splitbar-handle-color: #9CAFD4;
--nav-font-size-level1: 13px;
--nav-font-size-level2: 10px;
--nav-font-size-level3: 9px;
--nav-text-normal-color: #283A5D;
--nav-text-hover-color: white;
--nav-text-active-color: white;
---nav-text-normal-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
---nav-text-hover-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
---nav-text-active-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
--nav-menu-button-color: #364D7C;
--nav-menu-background-color: white;
--nav-menu-foreground-color: #555555;
+--nav-menu-active-bg: #DCE2EF;
+--nav-menu-active-color: #9CAFD4;
--nav-menu-toggle-color: rgba(255, 255, 255, 0.5);
---nav-arrow-color: #9CAFD4;
---nav-arrow-selected-color: #9CAFD4;
+--nav-arrow-color: #B6C4DF;
+--nav-arrow-selected-color: #90A5CE;
+
+/* sync icon */
+--sync-icon-border-color: #C4CFE5;
+--sync-icon-background-color: #F9FAFC;
+--sync-icon-selected-background-color: #EEF1F7;
+--sync-icon-color: #C4CFE5;
+--sync-icon-selected-color: #6884BD;
/* table of contents */
--toc-background-color: #F4F6FA;
@@ -107,18 +117,20 @@ html {
/** search field */
--search-background-color: white;
--search-foreground-color: #909090;
---search-magnification-image: url('mag.svg');
---search-magnification-select-image: url('mag_sel.svg');
--search-active-color: black;
---search-filter-background-color: #F9FAFC;
+--search-filter-background-color: rgba(255,255,255,.7);
+--search-filter-backdrop-filter: blur(4px);
--search-filter-foreground-color: black;
---search-filter-border-color: #90A5CE;
+--search-filter-border-color: rgba(150,150,150,.4);
--search-filter-highlight-text-color: white;
--search-filter-highlight-bg-color: #3D578C;
--search-results-foreground-color: #425E97;
---search-results-background-color: #EEF1F7;
---search-results-border-color: black;
---search-box-shadow: inset 0.5px 0.5px 3px 0px #555;
+--search-results-background-color: rgba(255,255,255,.8);
+--search-results-backdrop-filter: blur(4px);
+--search-results-border-color: rgba(150,150,150,.4);
+--search-box-border-color: #B6C4DF;
+--search-close-icon-bg-color: #A0A0A0;
+--search-close-icon-fg-color: white;
/** code fragments */
--code-keyword-color: #008000;
@@ -147,23 +159,21 @@ html {
--fragment-lineno-link-hover-bg-color: #C8C8C8;
--fragment-copy-ok-color: #2EC82E;
--tooltip-foreground-color: black;
---tooltip-background-color: white;
---tooltip-border-color: gray;
+--tooltip-background-color: rgba(255,255,255,0.8);
+--tooltip-arrow-background-color: white;
+--tooltip-border-color: rgba(150,150,150,0.7);
+--tooltip-backdrop-filter: blur(3px);
--tooltip-doc-color: grey;
--tooltip-declaration-color: #006318;
--tooltip-link-color: #4665A2;
---tooltip-shadow: 1px 1px 7px gray;
+--tooltip-shadow: 0 4px 8px 0 rgba(0,0,0,.25);
--fold-line-color: #808080;
---fold-minus-image: url('minus.svg');
---fold-plus-image: url('plus.svg');
---fold-minus-image-relpath: url('../../minus.svg');
---fold-plus-image-relpath: url('../../plus.svg');
/** font-family */
---font-family-normal: Roboto,sans-serif;
+--font-family-normal: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-monospace: 'JetBrains Mono',Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace,fixed;
--font-family-nav: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
---font-family-title: Tahoma,Arial,sans-serif;
+--font-family-title: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-toc: Verdana,'DejaVu Sans',Geneva,sans-serif;
--font-family-search: Arial,Verdana,sans-serif;
--font-family-icon: Arial,Helvetica;
@@ -201,7 +211,8 @@ html {
--page-background-color: black;
--page-foreground-color: #C9D1D9;
--page-link-color: #90A5CE;
---page-visited-link-color: #A3B4D7;
+--page-visited-link-color: #90A5CE;
+--page-external-link-color: #A3B4D7;
/* index */
--index-odd-item-bg-color: #0B101A;
@@ -212,8 +223,7 @@ html {
/* header */
--header-background-color: #070B11;
--header-separator-color: #141C2E;
---header-gradient-image: url('nav_hd.png');
---group-header-separator-color: #283A5D;
+--group-header-separator-color: #1D2A43;
--group-header-color: #90A5CE;
--inherit-header-color: #A0A0A0;
@@ -223,35 +233,36 @@ html {
--glow-color: cyan;
--title-background-color: #090D16;
---title-separator-color: #354C79;
+--title-separator-color: #212F4B;
--directory-separator-color: #283A5D;
--separator-color: #283A5D;
--blockquote-background-color: #101826;
--blockquote-border-color: #283A5D;
---scrollbar-thumb-color: #283A5D;
+--scrollbar-thumb-color: #2C3F65;
--scrollbar-background-color: #070B11;
--icon-background-color: #334975;
--icon-foreground-color: #C4CFE5;
---icon-doc-image: url('docd.svg');
---icon-folder-open-image: url('folderopend.svg');
---icon-folder-closed-image: url('folderclosedd.svg');
+--icon-folder-open-fill-color: #4665A2;
+--icon-folder-fill-color: #5373B4;
+--icon-folder-border-color: #C4CFE5;
+--icon-doc-fill-color: #6884BD;
+--icon-doc-border-color: #C4CFE5;
/* brief member declaration list */
--memdecl-background-color: #0B101A;
--memdecl-separator-color: #2C3F65;
--memdecl-foreground-color: #BBB;
--memdecl-template-color: #7C95C6;
+--memdecl-border-color: #233250;
/* detailed member list */
--memdef-border-color: #233250;
--memdef-title-background-color: #1B2840;
---memdef-title-gradient-image: url('nav_fd.png');
--memdef-proto-background-color: #19243A;
--memdef-proto-text-color: #9DB0D4;
---memdef-proto-text-shadow: 0px 1px 1px rgba(0, 0, 0, 0.9);
--memdef-doc-background-color: black;
--memdef-param-name-color: #D28757;
--memdef-template-color: #7C95C6;
@@ -270,29 +281,34 @@ html {
/** navigation bar/tree/menu */
--nav-background-color: #101826;
--nav-foreground-color: #364D7C;
---nav-gradient-image: url('tab_bd.png');
---nav-gradient-hover-image: url('tab_hd.png');
---nav-gradient-active-image: url('tab_ad.png');
---nav-gradient-active-image-parent: url("../tab_ad.png");
---nav-separator-image: url('tab_sd.png');
---nav-breadcrumb-image: url('bc_sd.png');
+--nav-border-color: #212F4B;
+--nav-breadcrumb-separator-color: #212F4B;
+--nav-breadcrumb-active-bg: #1D2A43;
+--nav-breadcrumb-color: #90A5CE;
--nav-breadcrumb-border-color: #2A3D61;
---nav-splitbar-image: url('splitbard.png');
+--nav-splitbar-bg-color: #283A5D;
+--nav-splitbar-handle-color: #4665A2;
--nav-font-size-level1: 13px;
--nav-font-size-level2: 10px;
--nav-font-size-level3: 9px;
--nav-text-normal-color: #B6C4DF;
--nav-text-hover-color: #DCE2EF;
--nav-text-active-color: #DCE2EF;
---nav-text-normal-shadow: 0px 1px 1px black;
---nav-text-hover-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
---nav-text-active-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
--nav-menu-button-color: #B6C4DF;
--nav-menu-background-color: #05070C;
--nav-menu-foreground-color: #BBBBBB;
+--nav-menu-active-bg: #1D2A43;
+--nav-menu-active-color: #C9D3E7;
--nav-menu-toggle-color: rgba(255, 255, 255, 0.2);
---nav-arrow-color: #334975;
---nav-arrow-selected-color: #90A5CE;
+--nav-arrow-color: #4665A2;
+--nav-arrow-selected-color: #6884BD;
+
+/* sync icon */
+--sync-icon-border-color: #212F4B;
+--sync-icon-background-color: #101826;
+--sync-icon-selected-background-color: #1D2A43;
+--sync-icon-color: #4665A2;
+--sync-icon-selected-color: #5373B4;
/* table of contents */
--toc-background-color: #151E30;
@@ -303,18 +319,20 @@ html {
/** search field */
--search-background-color: black;
--search-foreground-color: #C5C5C5;
---search-magnification-image: url('mag_d.svg');
---search-magnification-select-image: url('mag_seld.svg');
---search-active-color: #C5C5C5;
+--search-active-color: #F5F5F5;
--search-filter-background-color: #101826;
--search-filter-foreground-color: #90A5CE;
+--search-filter-backdrop-filter: none;
--search-filter-border-color: #7C95C6;
--search-filter-highlight-text-color: #BCC9E2;
--search-filter-highlight-bg-color: #283A5D;
---search-results-background-color: #101826;
+--search-results-background-color: black;
--search-results-foreground-color: #90A5CE;
---search-results-border-color: #7C95C6;
---search-box-shadow: inset 0.5px 0.5px 3px 0px #2F436C;
+--search-results-backdrop-filter: none;
+--search-results-border-color: #334975;
+--search-box-border-color: #334975;
+--search-close-icon-bg-color: #909090;
+--search-close-icon-fg-color: black;
/** code fragments */
--code-keyword-color: #CC99CD;
@@ -344,22 +362,20 @@ html {
--fragment-copy-ok-color: #0EA80E;
--tooltip-foreground-color: #C9D1D9;
--tooltip-background-color: #202020;
+--tooltip-arrow-background-color: #202020;
+--tooltip-backdrop-filter: none;
--tooltip-border-color: #C9D1D9;
--tooltip-doc-color: #D9E1E9;
--tooltip-declaration-color: #20C348;
--tooltip-link-color: #79C0FF;
--tooltip-shadow: none;
--fold-line-color: #808080;
---fold-minus-image: url('minusd.svg');
---fold-plus-image: url('plusd.svg');
---fold-minus-image-relpath: url('../../minusd.svg');
---fold-plus-image-relpath: url('../../plusd.svg');
/** font-family */
---font-family-normal: Roboto,sans-serif;
+--font-family-normal: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-monospace: 'JetBrains Mono',Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace,fixed;
--font-family-nav: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
---font-family-title: Tahoma,Arial,sans-serif;
+--font-family-title: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-toc: Verdana,'DejaVu Sans',Geneva,sans-serif;
--font-family-search: Arial,Verdana,sans-serif;
--font-family-icon: Arial,Helvetica;
@@ -389,8 +405,8 @@ html {
--invariant-color-text: #cceed5;
}}
body {
- background-color: var(--page-background-color);
- color: var(--page-foreground-color);
+ background-color: var(--page-background-color);
+ color: var(--page-foreground-color);
}
body, table, div, p, dl {
@@ -400,13 +416,22 @@ body, table, div, p, dl {
line-height: 22px;
}
+body.resizing {
+ user-select: none;
+ -webkit-user-select: none;
+}
+
+#doc-content {
+ scrollbar-width: thin;
+}
+
/* @group Heading Levels */
.title {
font-family: var(--font-family-normal);
line-height: 28px;
- font-size: 150%;
- font-weight: bold;
+ font-size: 160%;
+ font-weight: 400;
margin: 10px 2px;
}
@@ -415,7 +440,10 @@ h1.groupheader {
}
h2.groupheader {
- border-bottom: 1px solid var(--group-header-separator-color);
+ box-shadow: 12px 0 var(--page-background-color),
+ -12px 0 var(--page-background-color),
+ 12px 1px var(--group-header-separator-color),
+ -12px 1px var(--group-header-separator-color);
color: var(--group-header-color);
font-size: 150%;
font-weight: normal;
@@ -425,6 +453,13 @@ h2.groupheader {
width: 100%;
}
+td h2.groupheader {
+ box-shadow: 13px 0 var(--page-background-color),
+ -13px 0 var(--page-background-color),
+ 13px 1px var(--group-header-separator-color),
+ -13px 1px var(--group-header-separator-color);
+}
+
h3.groupheader {
font-size: 100%;
}
@@ -451,8 +486,8 @@ p.startli, p.startdd {
}
th p.starttd, th p.intertd, th p.endtd {
- font-size: 100%;
- font-weight: 700;
+ font-size: 100%;
+ font-weight: 700;
}
p.starttd {
@@ -497,9 +532,11 @@ h3.version {
}
div.navtab {
- padding-right: 15px;
+ margin-right: 6px;
+ padding-right: 6px;
text-align: right;
line-height: 110%;
+ background-color: var(--nav-background-color);
}
div.navtab table {
@@ -512,19 +549,10 @@ td.navtab {
}
td.navtabHL {
- background-image: var(--nav-gradient-active-image);
- background-repeat:repeat-x;
padding-right: 6px;
padding-left: 6px;
-}
-
-td.navtabHL a, td.navtabHL a:visited {
- color: var(--nav-text-hover-color);
- text-shadow: var(--nav-text-hover-shadow);
-}
-
-a.navtab {
- font-weight: bold;
+ border-radius: 0 6px 6px 0;
+ background-color: var(--nav-menu-active-bg);
}
div.qindex{
@@ -599,16 +627,11 @@ a {
color: var(--page-visited-link-color);
}
-a:hover {
+span.label a:hover {
text-decoration: none;
background: linear-gradient(to bottom, transparent 0,transparent calc(100% - 1px), currentColor 100%);
}
-a:hover > span.arrow {
- text-decoration: none;
- background : var(--nav-background-color);
-}
-
a.el {
font-weight: bold;
}
@@ -616,12 +639,12 @@ a.el {
a.elRef {
}
-a.code, a.code:visited, a.line, a.line:visited {
- color: var(--code-link-color);
+a.el, a.el:visited, a.code, a.code:visited, a.line, a.line:visited {
+ color: var(--page-link-color);
}
a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited {
- color: var(--code-external-link-color);
+ color: var(--page-external-link-color);
}
a.code.hl_class { /* style for links to class names in code snippets */ }
@@ -658,118 +681,124 @@ dl.el {
}
ul.check {
- list-style:none;
- text-indent: -16px;
- padding-left: 38px;
+ list-style:none;
+ text-indent: -16px;
+ padding-left: 38px;
}
li.unchecked:before {
- content: "\2610\A0";
+ content: "\2610\A0";
}
li.checked:before {
- content: "\2611\A0";
+ content: "\2611\A0";
}
ol {
- text-indent: 0px;
+ text-indent: 0px;
}
ul {
- text-indent: 0px;
- overflow: visible;
+ text-indent: 0px;
+ overflow: visible;
}
ul.multicol {
- -moz-column-gap: 1em;
- -webkit-column-gap: 1em;
- column-gap: 1em;
- -moz-column-count: 3;
- -webkit-column-count: 3;
- column-count: 3;
- list-style-type: none;
+ -moz-column-gap: 1em;
+ -webkit-column-gap: 1em;
+ column-gap: 1em;
+ -moz-column-count: 3;
+ -webkit-column-count: 3;
+ column-count: 3;
+ list-style-type: none;
}
#side-nav ul {
- overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */
+ overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */
}
#main-nav ul {
- overflow: visible; /* reset ul rule for the navigation bar drop down lists */
+ overflow: visible; /* reset ul rule for the navigation bar drop down lists */
}
.fragment {
- text-align: left;
- direction: ltr;
- overflow-x: auto;
- overflow-y: hidden;
- position: relative;
- min-height: 12px;
- margin: 10px 0px;
- padding: 10px 10px;
- border: 1px solid var(--fragment-border-color);
- border-radius: 4px;
- background-color: var(--fragment-background-color);
- color: var(--fragment-foreground-color);
+ text-align: left;
+ direction: ltr;
+ overflow-x: auto;
+ overflow-y: hidden;
+ position: relative;
+ min-height: 12px;
+ margin: 10px 0px;
+ padding: 10px 10px;
+ border: 1px solid var(--fragment-border-color);
+ border-radius: 4px;
+ background-color: var(--fragment-background-color);
+ color: var(--fragment-foreground-color);
}
pre.fragment {
- word-wrap: break-word;
- font-size: 10pt;
- line-height: 125%;
- font-family: var(--font-family-monospace);
+ word-wrap: break-word;
+ font-size: 10pt;
+ line-height: 125%;
+ font-family: var(--font-family-monospace);
+}
+
+span.tt {
+ white-space: pre;
+ font-family: var(--font-family-monospace);
}
.clipboard {
- width: 24px;
- height: 24px;
- right: 5px;
- top: 5px;
- opacity: 0;
- position: absolute;
- display: inline;
- overflow: hidden;
- justify-content: center;
- align-items: center;
- cursor: pointer;
+ width: 24px;
+ height: 24px;
+ right: 5px;
+ top: 5px;
+ opacity: 0;
+ position: absolute;
+ display: inline;
+ overflow: hidden;
+ justify-content: center;
+ align-items: center;
+ cursor: pointer;
}
.clipboard.success {
- border: 1px solid var(--fragment-foreground-color);
- border-radius: 4px;
+ border: 1px solid var(--fragment-foreground-color);
+ border-radius: 4px;
}
.fragment:hover .clipboard, .clipboard.success {
- opacity: .4;
+ opacity: .4;
}
.clipboard:hover, .clipboard.success {
- opacity: 1 !important;
+ opacity: 1 !important;
}
.clipboard:active:not([class~=success]) svg {
- transform: scale(.91);
+ transform: scale(.91);
}
.clipboard.success svg {
- fill: var(--fragment-copy-ok-color);
+ fill: var(--fragment-copy-ok-color);
}
.clipboard.success {
- border-color: var(--fragment-copy-ok-color);
+ border-color: var(--fragment-copy-ok-color);
}
div.line {
font-family: var(--font-family-monospace);
- font-size: 13px;
+ font-size: 13px;
min-height: 13px;
line-height: 1.2;
- text-wrap: unrestricted;
+ text-wrap: wrap;
+ word-break: break-all;
white-space: -moz-pre-wrap; /* Moz */
white-space: -pre-wrap; /* Opera 4-6 */
white-space: -o-pre-wrap; /* Opera 7 */
white-space: pre-wrap; /* CSS3 */
word-wrap: break-word; /* IE 5.5+ */
- text-indent: -53px;
- padding-left: 53px;
+ text-indent: -62px;
+ padding-left: 62px;
padding-bottom: 0px;
margin: 0px;
-webkit-transition-property: background-color, box-shadow;
@@ -785,8 +814,8 @@ div.line {
}
div.line:after {
- content:"\000A";
- white-space: pre;
+ content:"\000A";
+ white-space: pre;
}
div.line.glow {
@@ -795,26 +824,67 @@ div.line.glow {
}
span.fold {
- margin-left: 5px;
- margin-right: 1px;
- margin-top: 0px;
- margin-bottom: 0px;
- padding: 0px;
display: inline-block;
width: 12px;
height: 12px;
- background-repeat:no-repeat;
- background-position:center;
+ margin-left: 4px;
+ margin-right: 1px;
+}
+
+span.foldnone {
+ display: inline-block;
+ position: relative;
+ cursor: pointer;
+ user-select: none;
+}
+
+span.fold.plus, span.fold.minus {
+ width: 10px;
+ height: 10px;
+ background-color: var(--fragment-background-color);
+ position: relative;
+ border: 1px solid var(--fold-line-color);
+ margin-right: 1px;
+}
+
+span.fold.plus::before, span.fold.minus::before {
+ content: '';
+ position: absolute;
+ background-color: var(--fold-line-color);
+}
+
+span.fold.plus::before {
+ width: 2px;
+ height: 6px;
+ top: 2px;
+ left: 4px;
+}
+
+span.fold.plus::after {
+ content: '';
+ position: absolute;
+ width: 6px;
+ height: 2px;
+ top: 4px;
+ left: 2px;
+ background-color: var(--fold-line-color);
+}
+
+span.fold.minus::before {
+ width: 6px;
+ height: 2px;
+ top: 4px;
+ left: 2px;
}
span.lineno {
padding-right: 4px;
- margin-right: 9px;
+ margin-right: 9px;
text-align: right;
border-right: 2px solid var(--fragment-lineno-border-color);
color: var(--fragment-lineno-foreground-color);
background-color: var(--fragment-lineno-background-color);
- white-space: pre;
+ white-space: pre;
}
span.lineno a, span.lineno a:visited {
color: var(--fragment-lineno-link-fg-color);
@@ -836,18 +906,27 @@ span.lineno a:hover {
}
div.classindex ul {
- list-style: none;
- padding-left: 0;
+ list-style: none;
+ padding-left: 0;
}
div.classindex span.ai {
- display: inline-block;
+ display: inline-block;
}
div.groupHeader {
- margin-left: 16px;
- margin-top: 12px;
- font-weight: bold;
+ box-shadow: 13px 0 var(--page-background-color),
+ -13px 0 var(--page-background-color),
+ 13px 1px var(--group-header-separator-color),
+ -13px 1px var(--group-header-separator-color);
+ color: var(--group-header-color);
+ font-size: 110%;
+ font-weight: 500;
+ margin-left: 0px;
+ margin-top: 0em;
+ margin-bottom: 6px;
+ padding-top: 8px;
+ padding-bottom: 4px;
}
div.groupText {
@@ -857,13 +936,13 @@ div.groupText {
body {
color: var(--page-foreground-color);
- margin: 0;
+ margin: 0;
}
div.contents {
margin-top: 10px;
margin-left: 12px;
- margin-right: 8px;
+ margin-right: 12px;
}
p.formulaDsp {
@@ -883,9 +962,9 @@ img.formulaInl, img.inline {
div.center {
text-align: center;
- margin-top: 0px;
- margin-bottom: 0px;
- padding: 0px;
+ margin-top: 0px;
+ margin-bottom: 0px;
+ padding: 0px;
}
div.center img {
@@ -960,10 +1039,10 @@ span.vhdllogic {
}
blockquote {
- background-color: var(--blockquote-background-color);
- border-left: 2px solid var(--blockquote-border-color);
- margin: 0 24px 0 4px;
- padding: 0 12px 0 16px;
+ background-color: var(--blockquote-background-color);
+ border-left: 2px solid var(--blockquote-border-color);
+ margin: 0 24px 0 4px;
+ padding: 0 12px 0 16px;
}
/* @end */
@@ -985,9 +1064,14 @@ th.dirtab {
}
hr {
- height: 0px;
border: none;
- border-top: 1px solid var(--separator-color);
+ margin-top: 16px;
+ margin-bottom: 16px;
+ height: 1px;
+ box-shadow: 13px 0 var(--page-background-color),
+ -13px 0 var(--page-background-color),
+ 13px 1px var(--group-header-separator-color),
+ -13px 1px var(--group-header-separator-color);
}
hr.footer {
@@ -1002,14 +1086,6 @@ table.memberdecls {
}
.memberdecls td, .fieldtable tr {
- -webkit-transition-property: background-color, box-shadow;
- -webkit-transition-duration: 0.5s;
- -moz-transition-property: background-color, box-shadow;
- -moz-transition-duration: 0.5s;
- -ms-transition-property: background-color, box-shadow;
- -ms-transition-duration: 0.5s;
- -o-transition-property: background-color, box-shadow;
- -o-transition-duration: 0.5s;
transition-property: background-color, box-shadow;
transition-duration: 0.5s;
}
@@ -1019,13 +1095,23 @@ table.memberdecls {
box-shadow: 0 0 15px var(--glow-color);
}
+.memberdecls tr[class^='memitem'] {
+ font-family: var(--font-family-monospace);
+}
+
.mdescLeft, .mdescRight,
-.memItemLeft, .memItemRight,
-.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
+.memItemLeft, .memItemRight {
+ padding-top: 2px;
+ padding-bottom: 2px;
+}
+
+.memTemplParams {
+ padding-left: 10px;
+ padding-top: 5px;
+}
+
+.memItemLeft, .memItemRight, .memTemplParams {
background-color: var(--memdecl-background-color);
- border: none;
- margin: 4px;
- padding: 1px 0 0 8px;
}
.mdescLeft, .mdescRight {
@@ -1033,27 +1119,104 @@ table.memberdecls {
color: var(--memdecl-foreground-color);
}
-.memSeparator {
- border-bottom: 1px solid var(--memdecl-separator-color);
- line-height: 1px;
- margin: 0px;
- padding: 0px;
+tr[class^='memdesc'] {
+ box-shadow: inset 0px 1px 3px 0px rgba(0,0,0,.075);
}
-.memItemLeft, .memTemplItemLeft {
- white-space: nowrap;
+.mdescLeft {
+ border-left: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
}
-.memItemRight, .memTemplItemRight {
- width: 100%;
+.mdescRight {
+ border-right: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
}
.memTemplParams {
color: var(--memdecl-template-color);
- white-space: nowrap;
+ white-space: nowrap;
font-size: 80%;
+ border-left: 1px solid var(--memdecl-border-color);
+ border-right: 1px solid var(--memdecl-border-color);
+}
+
+td.ititle {
+ border: 1px solid var(--memdecl-border-color);
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+ padding-left: 10px;
+}
+
+tr:not(:first-child) > td.ititle {
+ border-top: 0;
+ border-radius: 0;
}
+.memItemLeft {
+ white-space: nowrap;
+ border-left: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
+ padding-left: 10px;
+ transition: none;
+}
+
+.memItemRight {
+ width: 100%;
+ border-right: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
+ padding-right: 10px;
+ transition: none;
+}
+
+tr.heading + tr[class^='memitem'] td.memItemLeft,
+tr.groupHeader + tr[class^='memitem'] td.memItemLeft,
+tr.inherit_header + tr[class^='memitem'] td.memItemLeft {
+ border-top: 1px solid var(--memdecl-border-color);
+ border-top-left-radius: 4px;
+}
+
+tr.heading + tr[class^='memitem'] td.memItemRight,
+tr.groupHeader + tr[class^='memitem'] td.memItemRight,
+tr.inherit_header + tr[class^='memitem'] td.memItemRight {
+ border-top: 1px solid var(--memdecl-border-color);
+ border-top-right-radius: 4px;
+}
+
+tr.heading + tr[class^='memitem'] td.memTemplParams,
+tr.heading + tr td.ititle,
+tr.groupHeader + tr[class^='memitem'] td.memTemplParams,
+tr.groupHeader + tr td.ititle,
+tr.inherit_header + tr[class^='memitem'] td.memTemplParams {
+ border-top: 1px solid var(--memdecl-border-color);
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+}
+
+table.memberdecls tr:last-child td.memItemLeft,
+table.memberdecls tr:last-child td.mdescLeft,
+table.memberdecls tr[class^='memitem']:has(+ tr.groupHeader) td.memItemLeft,
+table.memberdecls tr[class^='memitem']:has(+ tr.inherit_header) td.memItemLeft,
+table.memberdecls tr[class^='memdesc']:has(+ tr.groupHeader) td.mdescLeft,
+table.memberdecls tr[class^='memdesc']:has(+ tr.inherit_header) td.mdescLeft {
+ border-bottom-left-radius: 4px;
+}
+
+table.memberdecls tr:last-child td.memItemRight,
+table.memberdecls tr:last-child td.mdescRight,
+table.memberdecls tr[class^='memitem']:has(+ tr.groupHeader) td.memItemRight,
+table.memberdecls tr[class^='memitem']:has(+ tr.inherit_header) td.memItemRight,
+table.memberdecls tr[class^='memdesc']:has(+ tr.groupHeader) td.mdescRight,
+table.memberdecls tr[class^='memdesc']:has(+ tr.inherit_header) td.mdescRight {
+ border-bottom-right-radius: 4px;
+}
+
+tr.template .memItemLeft, tr.template .memItemRight {
+ border-top: none;
+ padding-top: 0;
+}
+
+
/* @end */
/* @group Member Details */
@@ -1068,24 +1231,43 @@ table.memberdecls {
border-top-right-radius: 4px;
border-top-left-radius: 4px;
margin-bottom: -1px;
- background-image: var(--memdef-title-gradient-image);
- background-repeat: repeat-x;
- background-color: var(--memdef-title-background-color);
+ background-color: var(--memdef-proto-background-color);
line-height: 1.25;
- font-weight: 300;
+ font-family: var(--font-family-monospace);
+ font-weight: 500;
+ font-size: 16px;
float:left;
+ box-shadow: 0 10px 0 -1px var(--memdef-proto-background-color),
+ 0 2px 8px 0 rgba(0,0,0,.075);
+ position: relative;
+}
+
+.memtitle:after {
+ content: '';
+ display: block;
+ background: var(--memdef-proto-background-color);
+ height: 10px;
+ bottom: -10px;
+ left: 0px;
+ right: -14px;
+ position: absolute;
+ border-top-right-radius: 6px;
}
.permalink
{
- font-size: 65%;
- display: inline-block;
- vertical-align: middle;
+ font-family: var(--font-family-monospace);
+ font-weight: 500;
+ line-height: 1.25;
+ font-size: 16px;
+ display: inline-block;
+ vertical-align: middle;
}
.memtemplate {
font-size: 80%;
color: var(--memdef-template-color);
+ font-family: var(--font-family-monospace);
font-weight: normal;
margin-left: 9px;
}
@@ -1098,22 +1280,21 @@ table.memberdecls {
padding: 0;
margin-bottom: 10px;
margin-right: 5px;
- -webkit-transition: box-shadow 0.5s linear;
- -moz-transition: box-shadow 0.5s linear;
- -ms-transition: box-shadow 0.5s linear;
- -o-transition: box-shadow 0.5s linear;
- transition: box-shadow 0.5s linear;
- display: table !important;
- width: 100%;
+ display: table !important;
+ width: 100%;
+ box-shadow: 0 2px 8px 0 rgba(0,0,0,.075);
+ border-radius: 4px;
}
.memitem.glow {
- box-shadow: 0 0 15px var(--glow-color);
+ box-shadow: 0 0 15px var(--glow-color);
}
.memname {
- font-weight: 400;
- margin-left: 6px;
+ font-family: var(--font-family-monospace);
+ font-size: 13px;
+ font-weight: 400;
+ margin-left: 6px;
}
.memname td {
@@ -1121,53 +1302,39 @@ table.memberdecls {
}
.memproto, dl.reflist dt {
- border-top: 1px solid var(--memdef-border-color);
- border-left: 1px solid var(--memdef-border-color);
- border-right: 1px solid var(--memdef-border-color);
- padding: 6px 0px 6px 0px;
- color: var(--memdef-proto-text-color);
- font-weight: bold;
- text-shadow: var(--memdef-proto-text-shadow);
- background-color: var(--memdef-proto-background-color);
- box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
- border-top-right-radius: 4px;
+ border-top: 1px solid var(--memdef-border-color);
+ border-left: 1px solid var(--memdef-border-color);
+ border-right: 1px solid var(--memdef-border-color);
+ padding: 6px 0px 6px 0px;
+ color: var(--memdef-proto-text-color);
+ font-weight: bold;
+ background-color: var(--memdef-proto-background-color);
+ border-top-right-radius: 4px;
+ border-bottom: 1px solid var(--memdef-border-color);
}
.overload {
- font-family: var(--font-family-monospace);
+ font-family: var(--font-family-monospace);
font-size: 65%;
}
.memdoc, dl.reflist dd {
- border-bottom: 1px solid var(--memdef-border-color);
- border-left: 1px solid var(--memdef-border-color);
- border-right: 1px solid var(--memdef-border-color);
- padding: 6px 10px 2px 10px;
- border-top-width: 0;
- background-image:url('nav_g.png');
- background-repeat:repeat-x;
- background-color: var(--memdef-doc-background-color);
- /* opera specific markup */
- border-bottom-left-radius: 4px;
- border-bottom-right-radius: 4px;
- box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
- /* firefox specific markup */
- -moz-border-radius-bottomleft: 4px;
- -moz-border-radius-bottomright: 4px;
- -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
- /* webkit specific markup */
- -webkit-border-bottom-left-radius: 4px;
- -webkit-border-bottom-right-radius: 4px;
- -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ border-bottom: 1px solid var(--memdef-border-color);
+ border-left: 1px solid var(--memdef-border-color);
+ border-right: 1px solid var(--memdef-border-color);
+ padding: 6px 10px 2px 10px;
+ border-top-width: 0;
+ border-bottom-left-radius: 4px;
+ border-bottom-right-radius: 4px;
}
dl.reflist dt {
- padding: 5px;
+ padding: 5px;
}
dl.reflist dd {
- margin: 0px 0px 10px 0px;
- padding: 5px;
+ margin: 0px 0px 10px 0px;
+ padding: 5px;
}
.paramkey {
@@ -1182,9 +1349,9 @@ dl.reflist dd {
.paramname {
white-space: nowrap;
- padding: 0px;
- padding-bottom: 1px;
- margin-left: 2px;
+ padding: 0px;
+ padding-bottom: 1px;
+ margin-left: 2px;
}
.paramname em {
@@ -1198,23 +1365,23 @@ dl.reflist dd {
}
.params, .retval, .exception, .tparams {
- margin-left: 0px;
- padding-left: 0px;
+ margin-left: 0px;
+ padding-left: 0px;
}
.params .paramname, .retval .paramname, .tparams .paramname, .exception .paramname {
- font-weight: bold;
- vertical-align: top;
+ font-weight: bold;
+ vertical-align: top;
}
.params .paramtype, .tparams .paramtype {
- font-style: italic;
- vertical-align: top;
+ font-style: italic;
+ vertical-align: top;
}
.params .paramdir, .tparams .paramdir {
- font-family: var(--font-family-monospace);
- vertical-align: top;
+ font-family: var(--font-family-monospace);
+ vertical-align: top;
}
table.mlabels {
@@ -1233,15 +1400,15 @@ td.mlabels-right {
}
span.mlabels {
- margin-left: 8px;
+ margin-left: 8px;
}
span.mlabel {
- background-color: var(--label-background-color);
- border-top:1px solid var(--label-left-top-border-color);
- border-left:1px solid var(--label-left-top-border-color);
- border-right:1px solid var(--label-right-bottom-border-color);
- border-bottom:1px solid var(--label-right-bottom-border-color);
+ background-color: var(--label-background-color);
+ border-top:1px solid var(--label-left-top-border-color);
+ border-left:1px solid var(--label-left-top-border-color);
+ border-right:1px solid var(--label-right-bottom-border-color);
+ border-bottom:1px solid var(--label-right-bottom-border-color);
text-shadow: none;
color: var(--label-foreground-color);
margin-right: 4px;
@@ -1259,39 +1426,37 @@ span.mlabel {
/* these are for tree view inside a (index) page */
div.directory {
- margin: 10px 0px;
- border-top: 1px solid var(--directory-separator-color);
- border-bottom: 1px solid var(--directory-separator-color);
- width: 100%;
+ margin: 10px 0px;
+ width: 100%;
}
.directory table {
- border-collapse:collapse;
+ border-collapse:collapse;
}
.directory td {
- margin: 0px;
- padding: 0px;
+ margin: 0px;
+ padding: 0px;
vertical-align: top;
}
.directory td.entry {
- white-space: nowrap;
- padding-right: 6px;
+ white-space: nowrap;
+ padding-right: 6px;
padding-top: 3px;
}
.directory td.entry a {
- outline:none;
+ outline:none;
}
.directory td.entry a img {
- border: none;
+ border: none;
}
.directory td.desc {
- width: 100%;
- padding-left: 6px;
+ width: 100%;
+ padding-left: 6px;
padding-right: 6px;
padding-top: 3px;
border-left: 1px solid rgba(0,0,0,0.05);
@@ -1312,90 +1477,178 @@ div.directory {
}
.directory .levels {
- white-space: nowrap;
- width: 100%;
- text-align: right;
- font-size: 9pt;
+ white-space: nowrap;
+ width: 100%;
+ text-align: right;
+ font-size: 9pt;
}
.directory .levels span {
- cursor: pointer;
- padding-left: 2px;
- padding-right: 2px;
+ cursor: pointer;
+ padding-left: 2px;
+ padding-right: 2px;
color: var(--page-link-color);
}
.arrow {
- color: var(--nav-arrow-color);
- -webkit-user-select: none;
- -khtml-user-select: none;
- -moz-user-select: none;
- -ms-user-select: none;
- user-select: none;
- cursor: pointer;
- font-size: 80%;
- display: inline-block;
- width: 16px;
- height: 22px;
+ color: var(--nav-background-color);
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ cursor: pointer;
+ font-size: 80%;
+ display: inline-block;
+ width: 16px;
+ height: 14px;
+ transition: opacity 0.3s ease;
+}
+
+span.arrowhead {
+ position: relative;
+ padding: 0;
+ margin: 0 0 0 2px;
+ display: inline-block;
+ width: 5px;
+ height: 5px;
+ border-right: 2px solid var(--nav-arrow-color);
+ border-bottom: 2px solid var(--nav-arrow-color);
+ transform: rotate(-45deg);
+ transition: transform 0.3s ease;
+}
+
+span.arrowhead.opened {
+ transform: rotate(45deg);
+}
+
+.selected span.arrowhead {
+ border-right: 2px solid var(--nav-arrow-selected-color);
+ border-bottom: 2px solid var(--nav-arrow-selected-color);
}
.icon {
- font-family: var(--font-family-icon);
- line-height: normal;
- font-weight: bold;
- font-size: 12px;
- height: 14px;
- width: 16px;
- display: inline-block;
- background-color: var(--icon-background-color);
- color: var(--icon-foreground-color);
- text-align: center;
- border-radius: 4px;
- margin-left: 2px;
- margin-right: 2px;
+ font-family: var(--font-family-icon);
+ line-height: normal;
+ font-weight: bold;
+ font-size: 12px;
+ height: 14px;
+ width: 16px;
+ display: inline-block;
+ background-color: var(--icon-background-color);
+ color: var(--icon-foreground-color);
+ text-align: center;
+ border-radius: 4px;
+ margin-left: 2px;
+ margin-right: 2px;
}
.icona {
- width: 24px;
- height: 22px;
- display: inline-block;
+ width: 24px;
+ height: 22px;
+ display: inline-block;
}
-.iconfopen {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:var(--icon-folder-open-image);
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
+.iconfolder {
+ width: 24px;
+ height: 18px;
+ margin-top: 6px;
+ vertical-align:top;
+ display: inline-block;
+ position: relative;
}
-.iconfclosed {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:var(--icon-folder-closed-image);
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
+.icondoc {
+ width: 24px;
+ height: 18px;
+ margin-top: 3px;
+ vertical-align:top;
+ display: inline-block;
+ position: relative;
}
-.icondoc {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:var(--icon-doc-image);
- background-position: 0px -4px;
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
+.folder-icon {
+ width: 16px;
+ height: 11px;
+ background-color: var(--icon-folder-fill-color);
+ border: 1px solid var(--icon-folder-border-color);
+ border-radius: 0 2px 2px 2px;
+ position: relative;
+ box-sizing: content-box;
+}
+
+.folder-icon::after {
+ content: '';
+ position: absolute;
+ top: 2px;
+ left: -1px;
+ width: 16px;
+ height: 7px;
+ background-color: var(--icon-folder-open-fill-color);
+ border: 1px solid var(--icon-folder-border-color);
+ border-radius: 7px 7px 2px 2px;
+ transform-origin: top left;
+ opacity: 0;
+ transition: all 0.3s linear;
+}
+
+.folder-icon::before {
+ content: '';
+ position: absolute;
+ top: -3px;
+ left: -1px;
+ width: 6px;
+ height: 2px;
+ background-color: var(--icon-folder-fill-color);
+ border-top: 1px solid var(--icon-folder-border-color);
+ border-left: 1px solid var(--icon-folder-border-color);
+ border-right: 1px solid var(--icon-folder-border-color);
+ border-radius: 2px 2px 0 0;
+}
+
+.folder-icon.open::after {
+ top: 3px;
+ opacity: 1;
+}
+
+.doc-icon {
+ left: 6px;
+ width: 12px;
+ height: 16px;
+ background-color: var(--icon-doc-border-color);
+ clip-path: polygon(0 0, 66% 0, 100% 25%, 100% 100%, 0 100%);
+ position: relative;
+ display: inline-block;
+}
+.doc-icon::before {
+ content: "";
+ left: 1px;
+ top: 1px;
+ width: 10px;
+ height: 14px;
+ background-color: var(--icon-doc-fill-color);
+ clip-path: polygon(0 0, 66% 0, 100% 25%, 100% 100%, 0 100%);
+ position: absolute;
+ box-sizing: border-box;
+}
+.doc-icon::after {
+ content: "";
+ left: 7px;
+ top: 0px;
+ width: 3px;
+ height: 3px;
+ background-color: transparent;
+ position: absolute;
+ border: 1px solid var(--icon-doc-border-color);
}
+
+
+
/* @end */
div.dynheader {
- margin-top: 8px;
+ margin-top: 8px;
-webkit-touch-callout: none;
-webkit-user-select: none;
-khtml-user-select: none;
@@ -1404,6 +1657,13 @@ div.dynheader {
user-select: none;
}
+span.dynarrow {
+ position: relative;
+ display: inline-block;
+ width: 12px;
+ bottom: 1px;
+}
+
address {
font-style: normal;
color: var(--footer-foreground-color);
@@ -1415,8 +1675,8 @@ table.doxtable caption {
table.doxtable {
border-collapse:collapse;
- margin-top: 4px;
- margin-bottom: 4px;
+ margin-top: 4px;
+ margin-bottom: 4px;
}
table.doxtable td, table.doxtable th {
@@ -1433,133 +1693,145 @@ table.doxtable th {
}
table.fieldtable {
- margin-bottom: 10px;
- border: 1px solid var(--memdef-border-color);
- border-spacing: 0px;
- border-radius: 4px;
- box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
+ margin-bottom: 10px;
+ border: 1px solid var(--memdef-border-color);
+ border-spacing: 0px;
+ border-radius: 4px;
+ box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
}
.fieldtable td, .fieldtable th {
- padding: 3px 7px 2px;
+ padding: 3px 7px 2px;
}
.fieldtable td.fieldtype, .fieldtable td.fieldname, .fieldtable td.fieldinit {
- white-space: nowrap;
- border-right: 1px solid var(--memdef-border-color);
- border-bottom: 1px solid var(--memdef-border-color);
- vertical-align: top;
+ white-space: nowrap;
+ border-right: 1px solid var(--memdef-border-color);
+ border-bottom: 1px solid var(--memdef-border-color);
+ vertical-align: top;
}
.fieldtable td.fieldname {
- padding-top: 3px;
+ padding-top: 3px;
}
.fieldtable td.fieldinit {
- padding-top: 3px;
- text-align: right;
+ padding-top: 3px;
+ text-align: right;
}
.fieldtable td.fielddoc {
- border-bottom: 1px solid var(--memdef-border-color);
+ border-bottom: 1px solid var(--memdef-border-color);
}
.fieldtable td.fielddoc p:first-child {
- margin-top: 0px;
+ margin-top: 0px;
}
.fieldtable td.fielddoc p:last-child {
- margin-bottom: 2px;
+ margin-bottom: 2px;
}
.fieldtable tr:last-child td {
- border-bottom: none;
+ border-bottom: none;
}
.fieldtable th {
- background-image: var(--memdef-title-gradient-image);
- background-repeat:repeat-x;
- background-color: var(--memdef-title-background-color);
- font-size: 90%;
- color: var(--memdef-proto-text-color);
- padding-bottom: 4px;
- padding-top: 5px;
- text-align:left;
- font-weight: 400;
- border-top-left-radius: 4px;
- border-top-right-radius: 4px;
- border-bottom: 1px solid var(--memdef-border-color);
-}
-
-
-.tabsearch {
- top: 0px;
- left: 10px;
- height: 36px;
- background-image: var(--nav-gradient-image);
- z-index: 101;
+ background-color: var(--memdef-title-background-color);
+ font-size: 90%;
+ color: var(--memdef-proto-text-color);
+ padding-bottom: 4px;
+ padding-top: 5px;
+ text-align:left;
+ font-weight: 400;
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+ border-bottom: 1px solid var(--memdef-border-color);
+}
+
+/* ----------- navigation breadcrumb styling ----------- */
+
+#nav-path ul {
+ height: 30px;
+ line-height: 30px;
+ color: var(--nav-text-normal-color);
overflow: hidden;
- font-size: 13px;
+ margin: 0px;
+ padding-left: 4px;
+ background-image: none;
+ background: var(--page-background-color);
+ border-bottom: 1px solid var(--nav-breadcrumb-separator-color);
+ font-size: var(--nav-font-size-level1);
+ font-family: var(--font-family-nav);
+ position: relative;
+ z-index: 100;
}
-.navpath ul
-{
- font-size: 11px;
- background-image: var(--nav-gradient-image);
- background-repeat:repeat-x;
- background-position: 0 -5px;
- height:30px;
- line-height:30px;
- color:var(--nav-text-normal-color);
- border:solid 1px var(--nav-breadcrumb-border-color);
- overflow:hidden;
- margin:0px;
- padding:0px;
-}
-
-.navpath li
-{
+#main-nav {
+ border-bottom: 1px solid var(--nav-border-color);
+}
+
+.navpath li {
list-style-type:none;
float:left;
+ color: var(--nav-foreground-color);
+}
+
+.navpath li.footer {
+ list-style-type:none;
+ float:right;
padding-left:10px;
padding-right:15px;
- background-image:var(--nav-breadcrumb-image);
+ background-image:none;
background-repeat:no-repeat;
background-position:right;
- color: var(--nav-foreground-color);
+ font-size: 8pt;
+ color: var(--footer-foreground-color);
}
-.navpath li.navelem a
-{
- height:32px;
- display:block;
- outline: none;
- color: var(--nav-text-normal-color);
- font-family: var(--font-family-nav);
- text-shadow: var(--nav-text-normal-shadow);
- text-decoration: none;
+#nav-path li.navelem {
+ background-image: none;
+ display: flex;
+ align-items: center;
+ padding-left: 15px;
}
-.navpath li.navelem a:hover
-{
- color: var(--nav-text-hover-color);
- text-shadow: var(--nav-text-hover-shadow);
+.navpath li.navelem a {
+ text-shadow: none;
+ display: inline-block;
+ color: var(--nav-breadcrumb-color);
+ position: relative;
+ top: 0px;
+ height: 30px;
+ margin-right: -20px;
}
-.navpath li.footer
-{
- list-style-type:none;
- float:right;
- padding-left:10px;
- padding-right:15px;
- background-image:none;
- background-repeat:no-repeat;
- background-position:right;
- color: var(--footer-foreground-color);
- font-size: 8pt;
+#nav-path li.navelem:after {
+ content: '';
+ display: inline-block;
+ position: relative;
+ top: 0;
+ right: -15px;
+ width: 30px;
+ height: 30px;
+ transform: scaleX(0.5) scale(0.707) rotate(45deg);
+ z-index: 10;
+ background: var(--page-background-color);
+ box-shadow: 2px -2px 0 2px var(--nav-breadcrumb-separator-color);
+ border-radius: 0 5px 0 50px;
+}
+
+#nav-path li.navelem:first-child {
+ margin-left: -6px;
}
+#nav-path li.navelem:hover,
+#nav-path li.navelem:hover:after {
+ background-color: var(--nav-breadcrumb-active-bg);
+}
+
+/* ---------------------- */
div.summary
{
@@ -1577,14 +1849,14 @@ div.summary a
table.classindex
{
- margin: 10px;
- white-space: nowrap;
- margin-left: 3%;
- margin-right: 3%;
- width: 94%;
- border: 0;
- border-spacing: 0;
- padding: 0;
+ margin: 10px;
+ white-space: nowrap;
+ margin-left: 3%;
+ margin-right: 3%;
+ width: 94%;
+ border: 0;
+ border-spacing: 0;
+ padding: 0;
}
div.ingroups
@@ -1601,10 +1873,8 @@ div.ingroups a
div.header
{
- background-image: var(--header-gradient-image);
- background-repeat:repeat-x;
- background-color: var(--header-background-color);
margin: 0px;
+ background-color: var(--header-background-color);
border-bottom: 1px solid var(--header-separator-color);
}
@@ -1613,168 +1883,105 @@ div.headertitle
padding: 5px 5px 5px 10px;
}
-.PageDocRTL-title div.headertitle {
- text-align: right;
- direction: rtl;
-}
-
dl {
- padding: 0 0 0 0;
-}
-
-/*
-
-dl.section {
- margin-left: 0px;
- padding-left: 0px;
-}
-
-dl.note {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #D0C000;
-}
-
-dl.warning, dl.attention, dl.important {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #FF0000;
-}
-
-dl.pre, dl.post, dl.invariant {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #00D000;
-}
-
-dl.deprecated {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #505050;
-}
-
-dl.todo {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #00C0E0;
-}
-
-dl.test {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #3030E0;
-}
-
-dl.bug {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #C08050;
+ padding: 0 0 0 0;
}
-*/
-
dl.bug dt a, dl.deprecated dt a, dl.todo dt a, dl.test a {
- font-weight: bold !important;
+ font-weight: bold !important;
}
dl.warning, dl.attention, dl.important, dl.note, dl.deprecated, dl.bug,
dl.invariant, dl.pre, dl.post, dl.todo, dl.test, dl.remark {
- padding: 10px;
- margin: 10px 0px;
- overflow: hidden;
- margin-left: 0;
- border-radius: 4px;
+ padding: 10px;
+ margin: 10px 0px;
+ overflow: hidden;
+ margin-left: 0;
+ border-radius: 4px;
}
dl.section dd {
- margin-bottom: 2px;
+ margin-bottom: 2px;
}
dl.warning, dl.attention, dl.important {
- background: var(--warning-color-bg);
- border-left: 8px solid var(--warning-color-hl);
- color: var(--warning-color-text);
+ background: var(--warning-color-bg);
+ border-left: 8px solid var(--warning-color-hl);
+ color: var(--warning-color-text);
}
dl.warning dt, dl.attention dt, dl.important dt {
- color: var(--warning-color-hl);
+ color: var(--warning-color-hl);
}
dl.note, dl.remark {
- background: var(--note-color-bg);
- border-left: 8px solid var(--note-color-hl);
- color: var(--note-color-text);
+ background: var(--note-color-bg);
+ border-left: 8px solid var(--note-color-hl);
+ color: var(--note-color-text);
}
dl.note dt, dl.remark dt {
- color: var(--note-color-hl);
+ color: var(--note-color-hl);
}
dl.todo {
- background: var(--todo-color-bg);
- border-left: 8px solid var(--todo-color-hl);
- color: var(--todo-color-text);
+ background: var(--todo-color-bg);
+ border-left: 8px solid var(--todo-color-hl);
+ color: var(--todo-color-text);
}
dl.todo dt {
- color: var(--todo-color-hl);
+ color: var(--todo-color-hl);
}
dl.test {
- background: var(--test-color-bg);
- border-left: 8px solid var(--test-color-hl);
- color: var(--test-color-text);
+ background: var(--test-color-bg);
+ border-left: 8px solid var(--test-color-hl);
+ color: var(--test-color-text);
}
dl.test dt {
- color: var(--test-color-hl);
+ color: var(--test-color-hl);
}
dl.bug dt a {
- color: var(--bug-color-hl) !important;
+ color: var(--bug-color-hl) !important;
}
dl.bug {
- background: var(--bug-color-bg);
- border-left: 8px solid var(--bug-color-hl);
- color: var(--bug-color-text);
+ background: var(--bug-color-bg);
+ border-left: 8px solid var(--bug-color-hl);
+ color: var(--bug-color-text);
}
dl.bug dt a {
- color: var(--bug-color-hl) !important;
+ color: var(--bug-color-hl) !important;
}
dl.deprecated {
- background: var(--deprecated-color-bg);
- border-left: 8px solid var(--deprecated-color-hl);
- color: var(--deprecated-color-text);
+ background: var(--deprecated-color-bg);
+ border-left: 8px solid var(--deprecated-color-hl);
+ color: var(--deprecated-color-text);
}
dl.deprecated dt a {
- color: var(--deprecated-color-hl) !important;
+ color: var(--deprecated-color-hl) !important;
}
dl.note dd, dl.warning dd, dl.pre dd, dl.post dd,
dl.remark dd, dl.attention dd, dl.important dd, dl.invariant dd,
dl.bug dd, dl.deprecated dd, dl.todo dd, dl.test dd {
- margin-inline-start: 0px;
+ margin-inline-start: 0px;
}
dl.invariant, dl.pre, dl.post {
- background: var(--invariant-color-bg);
- border-left: 8px solid var(--invariant-color-hl);
- color: var(--invariant-color-text);
+ background: var(--invariant-color-bg);
+ border-left: 8px solid var(--invariant-color-hl);
+ color: var(--invariant-color-text);
}
dl.invariant dt, dl.pre dt, dl.post dt {
- color: var(--invariant-color-hl);
+ color: var(--invariant-color-hl);
}
@@ -1797,16 +2004,16 @@ dl.invariant dt, dl.pre dt, dl.post dt {
#projectalign
{
- vertical-align: middle;
- padding-left: 0.5em;
+ vertical-align: middle;
+ padding-left: 0.5em;
}
#projectname
{
font-size: 200%;
font-family: var(--font-family-title);
- margin: 0px;
- padding: 2px 0px;
+ margin: 0;
+ padding: 0;
}
#side-nav #projectname
@@ -1817,7 +2024,7 @@ dl.invariant dt, dl.pre dt, dl.post dt {
#projectbrief
{
font-size: 90%;
- font-family: var(--font-family-title);
+ font-family: var(--font-family-title);
margin: 0px;
padding: 0px;
}
@@ -1825,43 +2032,42 @@ dl.invariant dt, dl.pre dt, dl.post dt {
#projectnumber
{
font-size: 50%;
- font-family: 50% var(--font-family-title);
+ font-family: var(--font-family-title);
margin: 0px;
padding: 0px;
}
#titlearea
{
- padding: 0px;
+ padding: 0 0 0 5px;
margin: 0px;
- width: 100%;
border-bottom: 1px solid var(--title-separator-color);
background-color: var(--title-background-color);
}
.image
{
- text-align: center;
+ text-align: center;
}
.dotgraph
{
- text-align: center;
+ text-align: center;
}
.mscgraph
{
- text-align: center;
+ text-align: center;
}
.plantumlgraph
{
- text-align: center;
+ text-align: center;
}
.diagraph
{
- text-align: center;
+ text-align: center;
}
.caption
@@ -1870,67 +2076,67 @@ dl.invariant dt, dl.pre dt, dl.post dt {
}
dl.citelist {
- margin-bottom:50px;
+ margin-bottom:50px;
}
dl.citelist dt {
- color:var(--citation-label-color);
- float:left;
- font-weight:bold;
- margin-right:10px;
- padding:5px;
- text-align:right;
- width:52px;
+ color:var(--citation-label-color);
+ float:left;
+ font-weight:bold;
+ margin-right:10px;
+ padding:5px;
+ text-align:right;
+ width:52px;
}
dl.citelist dd {
- margin:2px 0 2px 72px;
- padding:5px 0;
+ margin:2px 0 2px 72px;
+ padding:5px 0;
}
div.toc {
- padding: 14px 25px;
- background-color: var(--toc-background-color);
- border: 1px solid var(--toc-border-color);
- border-radius: 7px 7px 7px 7px;
- float: right;
- height: auto;
- margin: 0 8px 10px 10px;
- width: 200px;
+ padding: 14px 25px;
+ background-color: var(--toc-background-color);
+ border: 1px solid var(--toc-border-color);
+ border-radius: 7px 7px 7px 7px;
+ float: right;
+ height: auto;
+ margin: 0 8px 10px 10px;
+ width: 200px;
}
div.toc li {
- background: var(--toc-down-arrow-image) no-repeat scroll 0 5px transparent;
- font: 10px/1.2 var(--font-family-toc);
- margin-top: 5px;
- padding-left: 10px;
- padding-top: 2px;
+ background: var(--toc-down-arrow-image) no-repeat scroll 0 5px transparent;
+ font: 10px/1.2 var(--font-family-toc);
+ margin-top: 5px;
+ padding-left: 10px;
+ padding-top: 2px;
}
div.toc h3 {
- font: bold 12px/1.2 var(--font-family-toc);
+ font: bold 12px/1.2 var(--font-family-toc);
color: var(--toc-header-color);
- border-bottom: 0 none;
- margin: 0;
+ border-bottom: 0 none;
+ margin: 0;
}
div.toc ul {
- list-style: none outside none;
- border: medium none;
- padding: 0px;
+ list-style: none outside none;
+ border: medium none;
+ padding: 0px;
}
div.toc li[class^='level'] {
- margin-left: 15px;
+ margin-left: 15px;
}
div.toc li.level1 {
- margin-left: 0px;
+ margin-left: 0px;
}
div.toc li.empty {
- background-image: none;
- margin-top: 0px;
+ background-image: none;
+ margin-top: 0px;
}
span.emoji {
@@ -1940,13 +2146,12 @@ span.emoji {
}
span.obfuscator {
- display: none;
+ display: none;
}
.inherit_header {
- font-weight: bold;
- color: var(--inherit-header-color);
- cursor: pointer;
+ font-weight: 400;
+ cursor: pointer;
-webkit-touch-callout: none;
-webkit-user-select: none;
-khtml-user-select: none;
@@ -1956,49 +2161,49 @@ span.obfuscator {
}
.inherit_header td {
- padding: 6px 0px 2px 5px;
+ padding: 6px 0 2px 0;
}
.inherit {
- display: none;
+ display: none;
}
tr.heading h2 {
- margin-top: 12px;
- margin-bottom: 4px;
+ margin-top: 12px;
+ margin-bottom: 12px;
}
/* tooltip related style info */
.ttc {
- position: absolute;
- display: none;
+ position: absolute;
+ display: none;
}
#powerTip {
cursor: default;
- /*white-space: nowrap;*/
- color: var(--tooltip-foreground-color);
+ color: var(--tooltip-foreground-color);
background-color: var(--tooltip-background-color);
+ backdrop-filter: var(--tooltip-backdrop-filter);
+ -webkit-backdrop-filter: var(--tooltip-backdrop-filter);
border: 1px solid var(--tooltip-border-color);
- border-radius: 4px 4px 4px 4px;
+ border-radius: 4px;
box-shadow: var(--tooltip-shadow);
display: none;
font-size: smaller;
max-width: 80%;
- opacity: 0.9;
padding: 1ex 1em 1em;
position: absolute;
z-index: 2147483647;
}
#powerTip div.ttdoc {
- color: var(--tooltip-doc-color);
+ color: var(--tooltip-doc-color);
font-style: italic;
}
#powerTip div.ttname a {
- font-weight: bold;
+ font-weight: bold;
}
#powerTip a {
@@ -2006,18 +2211,18 @@ tr.heading h2 {
}
#powerTip div.ttname {
- font-weight: bold;
+ font-weight: bold;
}
#powerTip div.ttdeci {
- color: var(--tooltip-declaration-color);
+ color: var(--tooltip-declaration-color);
}
#powerTip div {
- margin: 0px;
- padding: 0px;
- font-size: 12px;
- font-family: var(--font-family-tooltip);
+ margin: 0px;
+ padding: 0px;
+ font-size: 12px;
+ font-family: var(--font-family-tooltip);
line-height: 16px;
}
@@ -2063,7 +2268,7 @@ tr.heading h2 {
}
#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after {
- border-top-color: var(--tooltip-background-color);
+ border-top-color: var(--tooltip-arrow-background-color);
border-width: 10px;
margin: 0px -10px;
}
@@ -2091,7 +2296,7 @@ tr.heading h2 {
}
#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after {
- border-bottom-color: var(--tooltip-background-color);
+ border-bottom-color: var(--tooltip-arrow-background-color);
border-width: 10px;
margin: 0px -10px;
}
@@ -2148,29 +2353,29 @@ tr.heading h2 {
@media print
{
- #top { display: none; }
- #side-nav { display: none; }
- #nav-path { display: none; }
- body { overflow:visible; }
- h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
- .summary { display: none; }
- .memitem { page-break-inside: avoid; }
- #doc-content
- {
- margin-left:0 !important;
- height:auto !important;
- width:auto !important;
- overflow:inherit;
- display:inline;
- }
+ #top { display: none; }
+ #side-nav { display: none; }
+ #nav-path { display: none; }
+ body { overflow:visible; }
+ h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
+ .summary { display: none; }
+ .memitem { page-break-inside: avoid; }
+ #doc-content
+ {
+ margin-left:0 !important;
+ height:auto !important;
+ width:auto !important;
+ overflow:inherit;
+ display:inline;
+ }
}
/* @group Markdown */
table.markdownTable {
border-collapse:collapse;
- margin-top: 4px;
- margin-bottom: 4px;
+ margin-top: 4px;
+ margin-bottom: 4px;
}
table.markdownTable td, table.markdownTable th {
@@ -2203,11 +2408,11 @@ th.markdownTableHeadCenter, td.markdownTableBodyCenter {
tt, code, kbd
{
- display: inline-block;
+ display: inline-block;
}
tt, code, kbd
{
- vertical-align: top;
+ vertical-align: top;
}
/* @end */
@@ -2216,26 +2421,27 @@ u {
}
details>summary {
- list-style-type: none;
+ list-style-type: none;
}
details > summary::-webkit-details-marker {
- display: none;
+ display: none;
}
details>summary::before {
- content: "\25ba";
- padding-right:4px;
- font-size: 80%;
+ content: "\25ba";
+ padding-right:4px;
+ font-size: 80%;
}
details[open]>summary::before {
- content: "\25bc";
- padding-right:4px;
- font-size: 80%;
+ content: "\25bc";
+ padding-right:4px;
+ font-size: 80%;
}
-body {
+:root {
+ scrollbar-width: thin;
scrollbar-color: var(--scrollbar-thumb-color) var(--scrollbar-background-color);
}
diff --git a/docs/html/doxygen_crawl.html b/docs/html/doxygen_crawl.html
index 1a7784e..6b8ae0b 100644
--- a/docs/html/doxygen_crawl.html
+++ b/docs/html/doxygen_crawl.html
@@ -4,7 +4,7 @@
Validator / crawler helper
-
+
diff --git a/docs/html/dynsections.js b/docs/html/dynsections.js
index b05f4c8..0e15bd4 100644
--- a/docs/html/dynsections.js
+++ b/docs/html/dynsections.js
@@ -28,7 +28,6 @@ function toggleVisibility(linkObj) {
}
let dynsection = {
-
// helper function
updateStripes : function() {
$('table.directory tr').
@@ -44,15 +43,13 @@ let dynsection = {
const trigger = $('#'+base+'-trigger');
const src=$(trigger).attr('src');
if (content.is(':visible')===true) {
- content.hide();
+ content.slideUp('fast');
summary.show();
- $(linkObj).addClass('closed').removeClass('opened');
- $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png');
+ $(linkObj).find('.arrowhead').addClass('closed').removeClass('opened');
} else {
- content.show();
+ content.slideDown('fast');
summary.hide();
- $(linkObj).removeClass('closed').addClass('opened');
- $(trigger).attr('src',src.substring(0,src.length-10)+'open.png');
+ $(linkObj).find('.arrowhead').removeClass('closed').addClass('opened');
}
return false;
},
@@ -63,12 +60,12 @@ let dynsection = {
const i = $('#img'+this.id.substring(3));
const a = $('#arr'+this.id.substring(3));
if (lD3D12 Memory Allocator: Frequently asked questions
-
-
@@ -33,33 +31,22 @@
-
+
-
- Frequently asked questions
+ Frequently asked questions
What is D3D12MA?
@@ -96,18 +83,18 @@
What is the license of D3D12MA?
D3D12MA is licensed under MIT, which means it is open source and free software.
What is the purpose of D3D12MA?
-D3D12MA helps with handling one aspect of DX12 usage, which is GPU memory management - allocation of ID3D12Heap objects and creation of ID3D12Resource objects - buffers and textures.
+D3D12MA helps with handling one aspect of DX12 usage, which is GPU memory management - allocation of ID3D12Heap objects and creation of ID3D12Resource objects - buffers and textures.
Do I need to use D3D12MA?
You don't need to, but it may be beneficial in many cases. DX12 is a complex and low-level API, so libraries like this that abstract certain aspects of the API and bring them to a higher level are useful. When developing any non-trivial graphics application, you may benefit from using a memory allocator. Using D3D12MA can save time compared to implementing your own.
-In DX12 you can create each resource separately with its own implicit memory heap by calling CreateCommittedResource, but this may not be the optimal solution. For more information, see Committed versus placed resources.
+In DX12 you can create each resource separately with its own implicit memory heap by calling CreateCommittedResource, but this may not be the optimal solution. For more information, see Committed versus placed resources.
When should I not use D3D12MA?
While D3D12MA is useful for many applications that use the DX12 API, there are cases when it may be a better choice not to use it. For example, if the application is very simple, e.g. serving as a sample or a learning exercise to help you understand or teach others the basics of DX12, and it creates only a small number of buffers and textures, then including D3D12MA may be an overkill. Developing your own memory allocator may also be a good learning exercise.
What are the benefits of using D3D12MA?
-- D3D12MA allocates large blocks of
ID3D12Heap memory and sub-allocates parts of them to create your placed resources. Allocating a new block of GPU memory may be a time-consuming operation. Sub-allocating parts of a memory block requires implementing an allocation algorithm, which is a non-trivial task. D3D12MA does that, using an advanced and efficient algorithm that works well in various use cases.
+- D3D12MA allocates large blocks of ID3D12Heap memory and sub-allocates parts of them to create your placed resources. Allocating a new block of GPU memory may be a time-consuming operation. Sub-allocating parts of a memory block requires implementing an allocation algorithm, which is a non-trivial task. D3D12MA does that, using an advanced and efficient algorithm that works well in various use cases.
- D3D12MA offers a simple API that allows creating placed buffers and textures within one function call like D3D12MA::Allocator::CreateResource.
-The library is doing much more under the hood. For example, it keeps buffers separate from textures when needed, respecting D3D12_RESOURCE_HEAP_TIER. It also makes use of the "small texture alignment" automatically, so you don't need to think about it.
+The library is doing much more under the hood. For example, it keeps buffers separate from textures when needed, respecting D3D12_RESOURCE_HEAP_TIER. It also makes use of the "small texture alignment" automatically, so you don't need to think about it.
Which version should I pick?
You can just pick the latest version from the "master" branch. It is kept in a good shape most of the time, compiling and working correctly, with no compatibility-breaking changes and no unfinished code.
If you want an even more stable version, you can pick the latest official release. Current code from the master branch is occasionally tagged as a release, with CHANGELOG carefully curated to enumerate all important changes since the previous version.
@@ -119,10 +106,10 @@
I am not a fan of modern C++. Can I still use it?
Very likely yes. We acknowledge that many C++ developers, especially in the games industry, do not appreciate all the latest features that the language has to offer.
-- D3D12MA doesn't throw or catch any C++ exceptions. It reports errors by returning a
HRESULT value instead, just like DX12. If you don't use exceptions in your project, your code is not exception-safe, or even if you disable exception handling in the compiler options, you can still use D3D12MA.
-- D3D12MA doesn't use C++ run-time type information like
typeid or dynamic_cast, so if you disable RTTI in the compiler options, you can still use the library.
-- D3D12MA uses only a limited subset of standard C and C++ library. It doesn't use STL containers like
std::vector, map, or string, either in the public interface nor in the internal implementation. It implements its own containers instead.
-- If you don't use the default heap memory allocator through
malloc/free or new/delete but implement your own allocator instead, you can pass it to D3D12MA as D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks and the library will use your functions for every dynamic heap allocation made internally.
+- D3D12MA doesn't throw or catch any C++ exceptions. It reports errors by returning a HRESULT value instead, just like DX12. If you don't use exceptions in your project, your code is not exception-safe, or even if you disable exception handling in the compiler options, you can still use D3D12MA.
+- D3D12MA doesn't use C++ run-time type information like typeid or dynamic_cast, so if you disable RTTI in the compiler options, you can still use the library.
+- D3D12MA uses only a limited subset of standard C and C++ library. It doesn't use STL containers like std::vector, map, or string, either in the public interface nor in the internal implementation. It implements its own containers instead.
+- If you don't use the default heap memory allocator through malloc/free or new/delete but implement your own allocator instead, you can pass it to D3D12MA as D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks and the library will use your functions for every dynamic heap allocation made internally.
Is it available for other programming languages?
D3D12MA is a C++ library in similar style as DX12. Bindings to other programming languages are out of scope of this project, but they are welcome as external projects. Some of them are listed in README.md, "See also" section, including binding to C. Before using any of them, please check if they are still maintained and updated to use a recent version of D3D12MA.
@@ -132,7 +119,7 @@
No! While D3D12MA is published by AMD, it works on any GPU that supports DX12, whether a discrete PC graphics card or a processor integrated graphics. It doesn't give AMD GPUs any advantage over any other GPUs.
What DirectX 12 versions are supported?
D3D12MA is updated to support latest versions of DirectX 12, as available through recent retail versions of the DirectX 12 Agility SDK. Support for new features added in the preview version of the Agility SDK is developed on separate branches until they are included in the retail version.
-The library also supports older versions down to the base DX12 shipping with Windows SDK. Features added by later versions of the Agility SDK are automatically enabled conditionally using #ifdef preprocessor macros depending on the version of the SDK that you compile your project with.
+The library also supports older versions down to the base DX12 shipping with Windows SDK. Features added by later versions of the Agility SDK are automatically enabled conditionally using #ifdef preprocessor macros depending on the version of the SDK that you compile your project with.
Does it support other graphics APIs, like Vulkan(R)?
No, but we offer an equivalent library for Vulkan: Vulkan Memory Allocator. It uses the same core allocation algorithm. It also shares many features with D3D12MA, like the support for custom pools and virtual allocator. However, it is not identical in terms of the features supported. Its API also looks different, because while the interface of D3D12MA is similar in style to DX12, the interface of VMA is similar to Vulkan.
Is the library lightweight?
@@ -154,8 +141,8 @@
If you want to report a suspected bug, you can also create a ticket the same way. Before doing this, please put some effort into the investigation of whether the bug is really in the library and not in your code or in the DX12 implementation (the GPU driver) on your platform:
- Enable D3D Debug Layer and make sure it is free from any errors.
-- Make sure
D3D12MA_ASSERT is defined to an implementation that can report a failure and not ignore it.
-- Try making your allocation using pure DX12 functions like
CreateCommittedResource() rather than D3D12MA and see if the bug persists.
+- Make sure D3D12MA_ASSERT is defined to an implementation that can report a failure and not ignore it.
+- Try making your allocation using pure DX12 functions like CreateCommittedResource() rather than D3D12MA and see if the bug persists.
I found some compilation warnings. How can we fix them?
Seeing compiler warnings may be annoying to some developers, but it is a design decision to not fix all of them. Due to the nature of the C++ language, certain preprocessor macros can make some variables unused, function parameters unreferenced, or conditional expressions constant in some configurations. The code of this library should not be bigger or more complicated just to silence these warnings. It is recommended to disable such warnings instead. For more information, see Features not supported.
@@ -164,7 +151,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/files.html b/docs/html/files.html
index 0ccb6a5..5ce45bf 100644
--- a/docs/html/files.html
+++ b/docs/html/files.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: File List
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all files with brief descriptions:
[detail level 12]
- ▼ include D3D12MemAlloc.h include D3D12MemAlloc.h
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions.html b/docs/html/functions.html
index 0690bb7..e1beea4 100644
--- a/docs/html/functions.html
+++ b/docs/html/functions.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all class members with links to the classes they belong to:
-- a -
+- a -
- Alignment : D3D12MA::VIRTUAL_ALLOCATION_DESC
- Allocate() : D3D12MA::VirtualBlock
- AllocateMemory() : D3D12MA::Allocator
@@ -100,7 +87,7 @@ - a -
-- b -
+- b -
- BeginDefragmentation() : D3D12MA::Allocator, D3D12MA::Pool
- BeginPass() : D3D12MA::DefragmentationContext
- block : D3D12MA::Allocation
@@ -114,7 +101,7 @@ - b -
-- c -
+- c -
- CalculateStatistics() : D3D12MA::Allocator, D3D12MA::Pool, D3D12MA::VirtualBlock
- CALLOCATION_DESC() : D3D12MA::CALLOCATION_DESC
- Clear() : D3D12MA::VirtualBlock
@@ -134,25 +121,25 @@ - c -
-- d -
+- d -
- D3D12MA_DELETE : D3D12MA::Allocation, D3D12MA::Allocator, D3D12MA::DefragmentationContext, D3D12MA::Pool, D3D12MA::VirtualBlock
-- e -
+- e -
- EndPass() : D3D12MA::DefragmentationContext
- ExtraHeapFlags : D3D12MA::ALLOCATION_DESC
-- f -
+- f -
- Flags : D3D12MA::ALLOCATION_DESC, D3D12MA::ALLOCATOR_DESC, D3D12MA::DEFRAGMENTATION_DESC, D3D12MA::POOL_DESC, D3D12MA::VIRTUAL_ALLOCATION_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
- FreeAllocation() : D3D12MA::VirtualBlock
- FreeStatsString() : D3D12MA::Allocator, D3D12MA::VirtualBlock
-- g -
+- g -
- GetAlignment() : D3D12MA::Allocation
- GetAllocationInfo() : D3D12MA::VirtualBlock
- GetBudget() : D3D12MA::Allocator
@@ -170,7 +157,7 @@ - g -
-- h -
+- h -
- heap : D3D12MA::Allocation
- HeapFlags : D3D12MA::POOL_DESC
- HeapProperties : D3D12MA::POOL_DESC
@@ -179,7 +166,7 @@ - h -
-- i -
+- i -
- IsCacheCoherentUMA() : D3D12MA::Allocator
- IsEmpty() : D3D12MA::VirtualBlock
- IsGPUUploadHeapSupported() : D3D12MA::Allocator
@@ -187,12 +174,12 @@ - i -
-- l -
+- l -
- list : D3D12MA::Allocation
-- m -
+- m -
- m_Committed : D3D12MA::Allocation
- m_Heap : D3D12MA::Allocation
- m_Placed : D3D12MA::Allocation
@@ -206,18 +193,18 @@ - m -
-- n -
+- n -
- next : D3D12MA::Allocation
-- o -
+- o -
- Offset : D3D12MA::VIRTUAL_ALLOCATION_INFO
- Operation : D3D12MA::DEFRAGMENTATION_MOVE
-- p -
+- p -
- pAdapter : D3D12MA::ALLOCATOR_DESC
- pAllocate : D3D12MA::ALLOCATION_CALLBACKS
- pAllocationCallbacks : D3D12MA::ALLOCATOR_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
@@ -233,12 +220,12 @@ - p -
-- r -
+- r -
- ResidencyPriority : D3D12MA::POOL_DESC
-- s -
+- s -
- SetAllocationPrivateData() : D3D12MA::VirtualBlock
- SetCurrentFrameIndex() : D3D12MA::Allocator
- SetName() : D3D12MA::Allocation, D3D12MA::Pool
@@ -249,12 +236,12 @@ - s -
-- t -
+- t -
- Total : D3D12MA::TotalStatistics
-- u -
+- u -
- UnusedRangeCount : D3D12MA::DetailedStatistics
- UnusedRangeSizeMax : D3D12MA::DetailedStatistics
- UnusedRangeSizeMin : D3D12MA::DetailedStatistics
@@ -263,7 +250,7 @@ - u -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html
index 23515d8..8f38cf0 100644
--- a/docs/html/functions_func.html
+++ b/docs/html/functions_func.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members - Functions
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all functions with links to the classes they belong to:
-- a -
+- a -
- Allocate() : D3D12MA::VirtualBlock
- AllocateMemory() : D3D12MA::Allocator
-- b -
+- b -
- BeginDefragmentation() : D3D12MA::Allocator, D3D12MA::Pool
- BeginPass() : D3D12MA::DefragmentationContext
- BuildStatsString() : D3D12MA::Allocator, D3D12MA::VirtualBlock
-- c -
+- c -
- CalculateStatistics() : D3D12MA::Allocator, D3D12MA::Pool, D3D12MA::VirtualBlock
- CALLOCATION_DESC() : D3D12MA::CALLOCATION_DESC
- Clear() : D3D12MA::VirtualBlock
@@ -116,18 +103,18 @@ - c -
-- e -
+- e -
- EndPass() : D3D12MA::DefragmentationContext
-- f -
+- f -
- FreeAllocation() : D3D12MA::VirtualBlock
- FreeStatsString() : D3D12MA::Allocator, D3D12MA::VirtualBlock
-- g -
+- g -
- GetAlignment() : D3D12MA::Allocation
- GetAllocationInfo() : D3D12MA::VirtualBlock
- GetBudget() : D3D12MA::Allocator
@@ -145,7 +132,7 @@ - g -
-- i -
+- i -
- IsCacheCoherentUMA() : D3D12MA::Allocator
- IsEmpty() : D3D12MA::VirtualBlock
- IsGPUUploadHeapSupported() : D3D12MA::Allocator
@@ -153,7 +140,7 @@ - i -
-- s -
+- s -
- SetAllocationPrivateData() : D3D12MA::VirtualBlock
- SetCurrentFrameIndex() : D3D12MA::Allocator
- SetName() : D3D12MA::Allocation, D3D12MA::Pool
@@ -163,7 +150,7 @@ - s -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions_rela.html b/docs/html/functions_rela.html
index b9d0728..f21eddd 100644
--- a/docs/html/functions_rela.html
+++ b/docs/html/functions_rela.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members - Related Symbols
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions_vars.html b/docs/html/functions_vars.html
index f63ab83..fe4ed5f 100644
--- a/docs/html/functions_vars.html
+++ b/docs/html/functions_vars.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members - Variables
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all variables with links to the classes they belong to:
-- a -
+- a -
- Alignment : D3D12MA::VIRTUAL_ALLOCATION_DESC
- AllocationBytes : D3D12MA::Statistics
- AllocationCount : D3D12MA::Statistics
@@ -98,7 +85,7 @@ - a -
-- b -
+- b -
- block : D3D12MA::Allocation
- BlockBytes : D3D12MA::Statistics
- BlockCount : D3D12MA::Statistics
@@ -109,22 +96,22 @@ - b -
-- c -
+- c -
- CustomPool : D3D12MA::ALLOCATION_DESC
-- e -
+- e -
- ExtraHeapFlags : D3D12MA::ALLOCATION_DESC
-- f -
+- f -
- Flags : D3D12MA::ALLOCATION_DESC, D3D12MA::ALLOCATOR_DESC, D3D12MA::DEFRAGMENTATION_DESC, D3D12MA::POOL_DESC, D3D12MA::VIRTUAL_ALLOCATION_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
-- h -
+- h -
- heap : D3D12MA::Allocation
- HeapFlags : D3D12MA::POOL_DESC
- HeapProperties : D3D12MA::POOL_DESC
@@ -133,12 +120,12 @@ - h -
-- l -
+- l -
- list : D3D12MA::Allocation
-- m -
+- m -
- m_Committed : D3D12MA::Allocation
- m_Heap : D3D12MA::Allocation
- m_Placed : D3D12MA::Allocation
@@ -152,18 +139,18 @@ - m -
-- n -
+- n -
- next : D3D12MA::Allocation
-- o -
+- o -
- Offset : D3D12MA::VIRTUAL_ALLOCATION_INFO
- Operation : D3D12MA::DEFRAGMENTATION_MOVE
-- p -
+- p -
- pAdapter : D3D12MA::ALLOCATOR_DESC
- pAllocate : D3D12MA::ALLOCATION_CALLBACKS
- pAllocationCallbacks : D3D12MA::ALLOCATOR_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
@@ -179,23 +166,23 @@ - p -
-- r -
+- r -
- ResidencyPriority : D3D12MA::POOL_DESC
-- s -
+- s -
- Size : D3D12MA::VIRTUAL_ALLOCATION_DESC, D3D12MA::VIRTUAL_ALLOCATION_INFO, D3D12MA::VIRTUAL_BLOCK_DESC
- Stats : D3D12MA::Budget, D3D12MA::DetailedStatistics
-- t -
+- t -
- Total : D3D12MA::TotalStatistics
-- u -
+- u -
- UnusedRangeCount : D3D12MA::DetailedStatistics
- UnusedRangeSizeMax : D3D12MA::DetailedStatistics
- UnusedRangeSizeMin : D3D12MA::DetailedStatistics
@@ -204,7 +191,7 @@ - u -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/general_considerations.html b/docs/html/general_considerations.html
index ef3888a..05a30ff 100644
--- a/docs/html/general_considerations.html
+++ b/docs/html/general_considerations.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: General considerations
-
-
@@ -33,33 +31,22 @@
-
+
-
- General considerations
+ General considerations
-
+
Thread safety
-- The library has no global state, so separate D3D12MA::Allocator objects can be used independently. In typical applications there should be no need to create multiple such objects though - one per
ID3D12Device is enough.
+- The library has no global state, so separate D3D12MA::Allocator objects can be used independently. In typical applications there should be no need to create multiple such objects though - one per ID3D12Device is enough.
- All calls to methods of D3D12MA::Allocator class are safe to be made from multiple threads simultaneously because they are synchronized internally when needed.
- When the allocator is created with D3D12MA::ALLOCATOR_FLAG_SINGLETHREADED, calls to methods of D3D12MA::Allocator class must be made from a single thread or synchronized by the user. Using this flag may improve performance.
- D3D12MA::VirtualBlock is not safe to be used from multiple threads simultaneously.
-
+
Versioning and compatibility
The library uses Semantic Versioning, which means version numbers follow convention: Major.Minor.Patch (e.g. 2.3.0), where:
@@ -109,13 +96,13 @@ <
All changes between official releases are documented in file "CHANGELOG.md".
- Warning
- Backward compatiblity is considered on the level of C++ source code, not binary linkage. Adding new members to existing structures is treated as backward compatible if initializing the new members to binary zero results in the old behavior. You should always fully initialize all library structures to zeros and not rely on their exact binary size.
-
+
Features not supported
Features deliberately excluded from the scope of this library:
- Descriptor allocation. Although also called "heaps", objects that represent descriptors are separate part of the D3D12 API from buffers and textures. You can still use Virtual allocator to manage descriptors and their ranges inside a descriptor heap.
- Support for reserved (tiled) resources. We don't recommend using them. For more information, see [1].
-- Support for
ID3D12Device::Evict and MakeResident. We don't recommend using them. You can call them on the D3D12 objects manually. Plese keep in mind, however, that eviction happens on the level of entire ID3D12Heap memory blocks and not individual buffers or textures which may be placed inside them.
+- Support for ID3D12Device::Evict and MakeResident. We don't recommend using them. You can call them on the D3D12 objects manually. Plese keep in mind, however, that eviction happens on the level of entire ID3D12Heap memory blocks and not individual buffers or textures which may be placed inside them.
- Handling CPU memory allocation failures. When dynamically creating small C++ objects in CPU memory (not the GPU memory), allocation failures are not handled gracefully, because that would complicate code significantly and is usually not needed in desktop PC applications anyway. Success of an allocation is just checked with an assert.
- Code free of any compiler warnings. There are many preprocessor macros that make some variables unused, function parameters unreferenced, or conditional expressions constant in some configurations. The code of this library should not be bigger or more complicated just to silence these warnings. It is recommended to disable such warnings instead.
- This is a C++ library. Bindings or ports to any other programming languages are welcome as external projects but are not going to be included into this repository.
@@ -125,7 +112,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/globals.html b/docs/html/globals.html
index 00f8dbd..27989c1 100644
--- a/docs/html/globals.html
+++ b/docs/html/globals.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: File Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/globals_defs.html b/docs/html/globals_defs.html
index feb2e5c..00db10d 100644
--- a/docs/html/globals_defs.html
+++ b/docs/html/globals_defs.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: File Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html
index 292f556..5785855 100644
--- a/docs/html/hierarchy.html
+++ b/docs/html/hierarchy.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Hierarchy
-
-
@@ -33,35 +31,24 @@
-
+
-
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 12]
CD3D12MA::ALLOCATION_CALLBACKS Custom callbacks to CPU memory allocation functions ▼CD3D12MA::ALLOCATION_DESC Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource CD3D12MA::ALLOCATION_DESC Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource CD3D12MA::CALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure CD3D12MA::ALLOCATOR_DESC Parameters of created Allocator object. To be used with CreateAllocator() CD3D12MA::Budget Statistics of current memory usage and available budget for a specific memory segment group CD3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Parameters for incremental defragmentation steps CD3D12MA::DEFRAGMENTATION_STATS Statistics returned for defragmentation process by function DefragmentationContext::GetStats() CD3D12MA::DetailedStatistics More detailed statistics than D3D12MA::Statistics ▼CIUnknownImpl CIUnknownImpl CD3D12MA::Allocation Represents single memory allocation CD3D12MA::Allocator Represents main object of this library initialized for particular ID3D12Device CD3D12MA::Allocator Represents main object of this library initialized for particular ID3D12Device CD3D12MA::DefragmentationContext Represents defragmentation process in progress CD3D12MA::Pool Custom memory pool CD3D12MA::VirtualBlock Represents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory ▼CD3D12MA::POOL_DESC Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool CD3D12MA::POOL_DESC Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool CD3D12MA::CPOOL_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure CD3D12MA::Statistics Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total CD3D12MA::TotalStatistics General statistics from current state of the allocator - total memory usage across all memory heaps and segments ▼CD3D12MA::VIRTUAL_ALLOCATION_DESC Parameters of created virtual allocation to be passed to VirtualBlock::Allocate() CD3D12MA::VIRTUAL_ALLOCATION_DESC Parameters of created virtual allocation to be passed to VirtualBlock::Allocate() CD3D12MA::CVIRTUAL_ALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure CD3D12MA::VIRTUAL_ALLOCATION_INFO Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo() ▼CD3D12MA::VIRTUAL_BLOCK_DESC Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock() CD3D12MA::VIRTUAL_BLOCK_DESC Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock() CD3D12MA::CVIRTUAL_BLOCK_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure CD3D12MA::VirtualAllocation Represents single memory allocation done inside VirtualBlock
@@ -120,7 +107,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/index.html b/docs/html/index.html
index e005026..d7434ba 100644
--- a/docs/html/index.html
+++ b/docs/html/index.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12 Memory Allocator
-
-
@@ -33,35 +31,24 @@
-
+
-
D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved.
License: MIT
-Documentation of all members: D3D12MemAlloc.h
-
+
Documentation of all members: D3D12MemAlloc.h
+
Table of contents
- Frequently asked questions
@@ -131,10 +118,10 @@
-
+
Web links
-- Direct3D 12 Memory Allocator at GPUOpen.com - product page
+- Direct3D 12 Memory Allocator at GPUOpen.com - product page
- GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com - source code repository
@@ -142,7 +129,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/linear_algorithm.html b/docs/html/linear_algorithm.html
index 25d5301..0bc59b0 100644
--- a/docs/html/linear_algorithm.html
+++ b/docs/html/linear_algorithm.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Linear allocation algorithm
-
-
@@ -33,33 +31,22 @@
-
+
-
- Linear allocation algorithm
+ Linear allocation algorithm
Each D3D12 memory block managed by this library has accompanying metadata that keeps track of used and unused regions. By default, the metadata structure and algorithm tries to find best place for new allocations among free regions to optimize memory usage. This way you can allocate and free objects in any order.
@@ -96,17 +83,17 @@
Sometimes there is a need to use simpler, linear allocation algorithm. You can create custom pool that uses such algorithm by adding flag D3D12MA::POOL_FLAG_ALGORITHM_LINEAR to D3D12MA::POOL_DESC::Flags while creating D3D12MA::Pool object. Then an alternative metadata management is used. It always creates new allocations after last one and doesn't reuse free regions after allocations freed in the middle. It results in better allocation performance and less memory consumed by metadata.
With this one flag, you can create a custom pool that can be used in many ways: free-at-once, stack, double stack, and ring buffer. See below for details. You don't need to specify explicitly which of these options you are going to use - it is detected automatically.
-
+
Free-at-once
-
In a pool that uses linear algorithm, you still need to free all the allocations individually by calling allocation->Release(). You can free them in any order. New allocations are always made after last one - free space in the middle is not reused. However, when you release all the allocation and the pool becomes empty, allocation starts from the beginning again. This way you can use linear algorithm to speed up creation of allocations that you are going to release all at once.
+In a pool that uses linear algorithm, you still need to free all the allocations individually by calling allocation->Release(). You can free them in any order. New allocations are always made after last one - free space in the middle is not reused. However, when you release all the allocation and the pool becomes empty, allocation starts from the beginning again. This way you can use linear algorithm to speed up creation of allocations that you are going to release all at once.
This mode is also available for pools created with D3D12MA::POOL_DESC::MaxBlockCount value that allows multiple memory blocks.
-
+
Stack
When you free an allocation that was created last, its space can be reused. Thanks to this, if you always release allocations in the order opposite to their creation (LIFO - Last In First Out), you can achieve behavior of a stack.
This mode is also available for pools created with D3D12MA::POOL_DESC::MaxBlockCount value that allows multiple memory blocks.
-
+
Double stack
The space reserved by a custom pool with linear algorithm may be used by two stacks:
@@ -116,20 +103,20 @@
To make allocation from the upper stack, add flag D3D12MA::ALLOCATION_FLAG_UPPER_ADDRESS to D3D12MA::ALLOCATION_DESC::Flags.
Double stack is available only in pools with one memory block - D3D12MA::POOL_DESC::MaxBlockCount must be 1. Otherwise behavior is undefined.
-When the two stacks' ends meet so there is not enough space between them for a new allocation, such allocation fails with usual E_OUTOFMEMORY error.
-
+
When the two stacks' ends meet so there is not enough space between them for a new allocation, such allocation fails with usual E_OUTOFMEMORY error.
+
Ring buffer
When you free some allocations from the beginning and there is not enough free space for a new one at the end of a pool, allocator's "cursor" wraps around to the beginning and starts allocation there. Thanks to this, if you always release allocations in the same order as you created them (FIFO - First In First Out), you can achieve behavior of a ring buffer / queue.
Ring buffer is available only in pools with one memory block - D3D12MA::POOL_DESC::MaxBlockCount must be 1. Otherwise behavior is undefined.
-
+
Additional considerations
Linear algorithm can also be used with Virtual allocator. See flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/menu.js b/docs/html/menu.js
index 0fd1e99..15f9c52 100644
--- a/docs/html/menu.js
+++ b/docs/html/menu.js
@@ -49,7 +49,7 @@ function initMenu(relPath,searchEnabled,serverSide,searchPage,search,treeview) {
searchBoxHtml=''+
''+
'');
$('#main-nav').append(makeTree(menudata,relPath));
$('#main-nav').children(':first').addClass('sm sm-dox').attr('id','main-menu');
- if (searchBoxHtml) {
- $('#main-menu').append('');
- }
+ $('#main-menu').append('');
const $mainMenuState = $('#main-menu-state');
let prevWidth = 0;
if ($mainMenuState.length) {
diff --git a/docs/html/namespace_d3_d12_m_a.html b/docs/html/namespace_d3_d12_m_a.html
index e770fdc..b4ae5de 100644
--- a/docs/html/namespace_d3_d12_m_a.html
+++ b/docs/html/namespace_d3_d12_m_a.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA Namespace Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
-
+
Classes
class Allocation class Allocation Represents single memory allocation. More...
struct ALLOCATION_CALLBACKS struct ALLOCATION_CALLBACKS Custom callbacks to CPU memory allocation functions. More...
struct ALLOCATION_DESC struct ALLOCATION_DESC Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource. More...
class Allocator Represents main object of this library initialized for particular ID3D12Device. More...
struct ALLOCATOR_DESC class Allocator Represents main object of this library initialized for particular ID3D12Device. More...
struct ALLOCATOR_DESC Parameters of created Allocator object. To be used with CreateAllocator(). More...
struct Budget struct Budget Statistics of current memory usage and available budget for a specific memory segment group. More...
struct CALLOCATION_DESC struct CALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure. More...
struct CPOOL_DESC struct CPOOL_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure. More...
struct CVIRTUAL_ALLOCATION_DESC struct CVIRTUAL_ALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure. More...
struct CVIRTUAL_BLOCK_DESC struct CVIRTUAL_BLOCK_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure. More...
struct DEFRAGMENTATION_DESC struct DEFRAGMENTATION_DESC Parameters for defragmentation. More...
struct DEFRAGMENTATION_MOVE struct DEFRAGMENTATION_MOVE Single move of an allocation to be done for defragmentation. More...
struct DEFRAGMENTATION_PASS_MOVE_INFO struct DEFRAGMENTATION_PASS_MOVE_INFO Parameters for incremental defragmentation steps. More...
struct DEFRAGMENTATION_STATS struct DEFRAGMENTATION_STATS Statistics returned for defragmentation process by function DefragmentationContext::GetStats(). More...
class DefragmentationContext class DefragmentationContext Represents defragmentation process in progress. More...
struct DetailedStatistics struct DetailedStatistics More detailed statistics than D3D12MA::Statistics. More...
class Pool class Pool Custom memory pool. More...
struct POOL_DESC struct POOL_DESC Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool. More...
struct Statistics struct Statistics Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total. More...
struct TotalStatistics struct TotalStatistics General statistics from current state of the allocator - total memory usage across all memory heaps and segments. More...
struct VIRTUAL_ALLOCATION_DESC struct VIRTUAL_ALLOCATION_DESC Parameters of created virtual allocation to be passed to VirtualBlock::Allocate(). More...
struct VIRTUAL_ALLOCATION_INFO struct VIRTUAL_ALLOCATION_INFO Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo(). More...
struct VIRTUAL_BLOCK_DESC struct VIRTUAL_BLOCK_DESC Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock(). More...
struct VirtualAllocation struct VirtualAllocation Represents single memory allocation done inside VirtualBlock. More...
class VirtualBlock class VirtualBlock Represents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory. More...
-
+
Typedefs
typedef UINT64 AllocHandle Unique identifier of single allocation done inside the memory heap.
using ALLOCATE_FUNC_PTR = void* (*)(size_t Size, size_t Alignment, void* pPrivateData) Pointer to custom callback function that allocates CPU memory.
using FREE_FUNC_PTR = void (*)(void* pMemory, void* pPrivateData) Pointer to custom callback function that deallocates CPU memory.
-
+
Enumerations
enum ALLOCATION_FLAGS {
ALLOCATION_FLAG_NONE = 0
@@ -203,20 +162,17 @@
} Bit flags to be used with ALLOCATION_DESC::Flags. More...
enum DEFRAGMENTATION_FLAGS { DEFRAGMENTATION_FLAG_ALGORITHM_FAST = 0x1
, DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED = 0x2
, DEFRAGMENTATION_FLAG_ALGORITHM_FULL = 0x4
, DEFRAGMENTATION_FLAG_ALGORITHM_MASK
} Flags to be passed as DEFRAGMENTATION_DESC::Flags. More...
enum DEFRAGMENTATION_MOVE_OPERATION { DEFRAGMENTATION_MOVE_OPERATION_COPY = 0
, DEFRAGMENTATION_MOVE_OPERATION_IGNORE = 1
, DEFRAGMENTATION_MOVE_OPERATION_DESTROY = 2
} Operation performed on single defragmentation move. More...
enum POOL_FLAGS {
POOL_FLAG_NONE = 0
, POOL_FLAG_ALGORITHM_LINEAR = 0x1
@@ -227,7 +183,6 @@
} Bit flags to be used with POOL_DESC::Flags. More...
enum ALLOCATOR_FLAGS {
ALLOCATOR_FLAG_NONE = 0
, ALLOCATOR_FLAG_SINGLETHREADED = 0x1
@@ -239,13 +194,11 @@
} Bit flags to be used with ALLOCATOR_DESC::Flags. More...
enum VIRTUAL_BLOCK_FLAGS { VIRTUAL_BLOCK_FLAG_NONE = 0
, VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR = POOL_FLAG_ALGORITHM_LINEAR
, VIRTUAL_BLOCK_FLAG_ALGORITHM_MASK = POOL_FLAG_ALGORITHM_MASK
} Bit flags to be used with VIRTUAL_BLOCK_DESC::Flags. More...
enum VIRTUAL_ALLOCATION_FLAGS {
VIRTUAL_ALLOCATION_FLAG_NONE = 0
, VIRTUAL_ALLOCATION_FLAG_UPPER_ADDRESS = ALLOCATION_FLAG_UPPER_ADDRESS
@@ -257,18 +210,15 @@
} Bit flags to be used with VIRTUAL_ALLOCATION_DESC::Flags. More...
-
+
Functions
D3D12MA_API HRESULT CreateAllocator (const ALLOCATOR_DESC *pDesc, Allocator **ppAllocator) Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
D3D12MA_API HRESULT CreateVirtualBlock (const VIRTUAL_BLOCK_DESC *pDesc, VirtualBlock **ppVirtualBlock) Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
-Typedef Documentation
+Typedef Documentation
◆ ALLOCATE_FUNC_PTR
@@ -314,11 +264,11 @@
Pointer to custom callback function that deallocates CPU memory.
-pMemory = null should be accepted and ignored.
+pMemory = null should be accepted and ignored.
-Enumeration Type Documentation
+Enumeration Type Documentation
◆ ALLOCATION_FLAGS
@@ -338,21 +288,21 @@ ALLOCATION_FLAG_COMMITTED Set this flag if the allocation should have its own dedicated memory allocation (committed resource with implicit heap).
Use it for special, big resources, like fullscreen textures used as render targets.
-- When used with functions like D3D12MA::Allocator::CreateResource, it will use
ID3D12Device::CreateCommittedResource, so the created allocation will contain a resource (D3D12MA::Allocation::GetResource() != NULL) but will not have a heap (D3D12MA::Allocation::GetHeap() == NULL), as the heap is implicit.
-- When used with raw memory allocation like D3D12MA::Allocator::AllocateMemory, it will use
ID3D12Device::CreateHeap, so the created allocation will contain a heap (D3D12MA::Allocation::GetHeap() != NULL) and its offset will always be 0.
+- When used with functions like D3D12MA::Allocator::CreateResource, it will use ID3D12Device::CreateCommittedResource, so the created allocation will contain a resource (D3D12MA::Allocation::GetResource() != NULL) but will not have a heap (D3D12MA::Allocation::GetHeap() == NULL), as the heap is implicit.
+- When used with raw memory allocation like D3D12MA::Allocator::AllocateMemory, it will use ID3D12Device::CreateHeap, so the created allocation will contain a heap (D3D12MA::Allocation::GetHeap() != NULL) and its offset will always be 0.
ALLOCATION_FLAG_NEVER_ALLOCATE Set this flag to only try to allocate from existing memory heaps and never create new such heap.
-If new allocation cannot be placed in any of the existing heaps, allocation fails with E_OUTOFMEMORY error.
+If new allocation cannot be placed in any of the existing heaps, allocation fails with E_OUTOFMEMORY error.
You should not use D3D12MA::ALLOCATION_FLAG_COMMITTED and D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE at the same time. It makes no sense.
ALLOCATION_FLAG_WITHIN_BUDGET Create allocation only if additional memory required for it, if any, won't exceed memory budget. Otherwise return E_OUTOFMEMORY.
+ALLOCATION_FLAG_WITHIN_BUDGET Create allocation only if additional memory required for it, if any, won't exceed memory budget. Otherwise return E_OUTOFMEMORY.
ALLOCATION_FLAG_UPPER_ADDRESS Allocation will be created from upper stack in a double stack pool.
This flag is only allowed for custom pools created with POOL_FLAG_ALGORITHM_LINEAR flag.
ALLOCATION_FLAG_CAN_ALIAS Set this flag if the allocated memory will have aliasing resources.
-Use this when calling D3D12MA::Allocator::CreateResource() and similar to guarantee creation of explicit heap for desired allocation and prevent it from using CreateCommittedResource, so that new allocation object will always have allocation->GetHeap() != NULL.
+Use this when calling D3D12MA::Allocator::CreateResource() and similar to guarantee creation of explicit heap for desired allocation and prevent it from using CreateCommittedResource, so that new allocation object will always have allocation->GetHeap() != NULL.
ALLOCATION_FLAG_STRATEGY_MIN_MEMORY Allocation strategy that chooses smallest possible free range for the allocation to minimize memory usage and fragmentation, possibly at the expense of allocation time.
ALLOCATION_FLAG_STRATEGY_FIRST_FIT Alias to ALLOCATION_FLAG_STRATEGY_MIN_TIME.
ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
+ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
ALLOCATOR_FLAG_ALWAYS_COMMITTED Every allocation will be created as a committed resource - will have its own memory block.
Affects both default pools and custom pools. To be used for debugging purposes only. There is also an equivalent flag for custom pools: D3D12MA::POOL_FLAG_ALWAYS_COMMITTED.
ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED Heaps created for the default pools will be created with flag D3D12_HEAP_FLAG_CREATE_NOT_ZEROED, allowing for their memory to be not zeroed by the system if possible, which can speed up allocation.
+ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED Heaps created for the default pools will be created with flag D3D12_HEAP_FLAG_CREATE_NOT_ZEROED, allowing for their memory to be not zeroed by the system if possible, which can speed up allocation.
Only affects default pools. To use the flag with Custom memory pools, you need to add it manually:
poolDesc.heapFlags |= D3D12_HEAP_FLAG_CREATE_NOT_ZEROED;
-Only avaiable if ID3D12Device8 is present. Otherwise, the flag is ignored.
+Only avaiable if ID3D12Device8 is present. Otherwise, the flag is ignored.
ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED Optimization, allocate MSAA textures as committed resources always.
Specify this flag to create MSAA textures with implicit heaps, as if they were created with flag D3D12MA::ALLOCATION_FLAG_COMMITTED. Usage of this flags enables all default pools to create its heaps on smaller alignment not suitable for MSAA textures.
@@ -424,11 +374,11 @@
Enumerator DEFRAGMENTATION_FLAG_ALGORITHM_FAST Use simple but fast algorithm for defragmentation. May not achieve best results but will require least time to compute and least allocations to copy.
DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED Default defragmentation algorithm, applied also when no ALGORITHM flag is specified. Offers a balance between defragmentation quality and the amount of allocations and bytes that need to be moved.
+DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED Default defragmentation algorithm, applied also when no ALGORITHM flag is specified. Offers a balance between defragmentation quality and the amount of allocations and bytes that need to be moved.
DEFRAGMENTATION_FLAG_ALGORITHM_FULL Perform full defragmentation of memory. Can result in notably more time to compute and allocations to copy, but will achieve best memory packing.
DEFRAGMENTATION_FLAG_ALGORITHM_MASK A bit mask to extract only ALGORITHM bits from entire set of flags.
+DEFRAGMENTATION_FLAG_ALGORITHM_MASK A bit mask to extract only ALGORITHM bits from entire set of flags.
-Enumerator DEFRAGMENTATION_MOVE_OPERATION_COPY Resource has been recreated at pDstTmpAllocation, data has been copied, old resource has been destroyed. pSrcAllocation will be changed to point to the new place. This is the default value set by DefragmentationContext::BeginPass().
+Enumerator DEFRAGMENTATION_MOVE_OPERATION_COPY Resource has been recreated at pDstTmpAllocation, data has been copied, old resource has been destroyed. pSrcAllocation will be changed to point to the new place. This is the default value set by DefragmentationContext::BeginPass().
DEFRAGMENTATION_MOVE_OPERATION_IGNORE Set this value if you cannot move the allocation. New place reserved at pDstTmpAllocation will be freed. pSrcAllocation will remain unchanged.
+DEFRAGMENTATION_MOVE_OPERATION_IGNORE Set this value if you cannot move the allocation. New place reserved at pDstTmpAllocation will be freed. pSrcAllocation will remain unchanged.
DEFRAGMENTATION_MOVE_OPERATION_DESTROY Set this value if you decide to abandon the allocation and you destroyed the resource. New place reserved pDstTmpAllocation will be freed, along with pSrcAllocation.
+DEFRAGMENTATION_MOVE_OPERATION_DESTROY Set this value if you decide to abandon the allocation and you destroyed the resource. New place reserved pDstTmpAllocation will be freed, along with pSrcAllocation.
VIRTUAL_ALLOCATION_FLAG_STRATEGY_MIN_OFFSET
Allocation strategy that chooses always the lowest offset in available space. This is not the most efficient strategy but achieves highly packed data.
VIRTUAL_ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
+VIRTUAL_ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
These strategy flags are binary compatible with equivalent flags in ALLOCATION_FLAGS.
Function Documentation
+Function Documentation
◆ CreateAllocator()
@@ -567,8 +517,8 @@
-Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
-You normally only need to call it once and keep a single Allocator object for your ID3D12Device.
+Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
+You normally only need to call it once and keep a single Allocator object for your ID3D12Device.
@@ -591,7 +541,7 @@
-Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
+Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
Note you don't need to create D3D12MA::Allocator to use virtual blocks.
@@ -599,7 +549,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers.html b/docs/html/namespacemembers.html
index 6881ab0..4cadc29 100644
--- a/docs/html/namespacemembers.html
+++ b/docs/html/namespacemembers.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all namespace members with links to the namespace documentation for each member:
-- a -
+- a -
- ALLOCATE_FUNC_PTR : D3D12MA
- ALLOCATION_FLAG_CAN_ALIAS : D3D12MA
- ALLOCATION_FLAG_COMMITTED : D3D12MA
@@ -112,13 +99,13 @@ - a -
-- c -
+- c -
-- d -
+- d -
- DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FAST : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FULL : D3D12MA
@@ -131,12 +118,12 @@ - d -
-- f -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_enum.html b/docs/html/namespacemembers_enum.html
index 5723a6b..90ffd55 100644
--- a/docs/html/namespacemembers_enum.html
+++ b/docs/html/namespacemembers_enum.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_eval.html b/docs/html/namespacemembers_eval.html
index 365527c..4a4922b 100644
--- a/docs/html/namespacemembers_eval.html
+++ b/docs/html/namespacemembers_eval.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all namespace enum values with links to the namespace documentation for each enum value:
-- a -
+- a -
- ALLOCATION_FLAG_CAN_ALIAS : D3D12MA
- ALLOCATION_FLAG_COMMITTED : D3D12MA
- ALLOCATION_FLAG_NEVER_ALLOCATE : D3D12MA
@@ -108,7 +95,7 @@ - a -
-- d -
+- d -
- DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FAST : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FULL : D3D12MA
@@ -119,7 +106,7 @@ - d -
-- p -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_func.html b/docs/html/namespacemembers_func.html
index 02a9cdd..c8a70c7 100644
--- a/docs/html/namespacemembers_func.html
+++ b/docs/html/namespacemembers_func.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_type.html b/docs/html/namespacemembers_type.html
index b56e9c4..e9561e2 100644
--- a/docs/html/namespacemembers_type.html
+++ b/docs/html/namespacemembers_type.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespaces.html b/docs/html/namespaces.html
index fe8ddce..acd9768 100644
--- a/docs/html/namespaces.html
+++ b/docs/html/namespaces.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace List
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/navtree.css b/docs/html/navtree.css
index 69211d4..0ea3a07 100644
--- a/docs/html/navtree.css
+++ b/docs/html/navtree.css
@@ -11,8 +11,8 @@
#nav-tree li {
white-space:nowrap;
- margin:0px;
- padding:0px;
+ margin:0;
+ padding:0;
}
#nav-tree .plus {
@@ -20,15 +20,10 @@
}
#nav-tree .selected {
- background-image: url('tab_a.png');
- background-repeat:repeat-x;
- color: var(--nav-text-active-color);
- text-shadow: var(--nav-text-active-shadow);
-}
-
-#nav-tree .selected .arrow {
- color: var(--nav-arrow-selected-color);
- text-shadow: none;
+ position: relative;
+ background-color: var(--nav-menu-active-bg);
+ border-radius: 0 6px 6px 0;
+ /*margin-right: 5px;*/
}
#nav-tree img {
@@ -48,6 +43,7 @@
margin:0px;
padding:0px;
font: 12px var(--font-family-nav);
+ line-height: 22px;
}
#nav-tree .label a {
@@ -56,7 +52,7 @@
#nav-tree .selected a {
text-decoration:none;
- color:var(--nav-text-active-color);
+ color:var(--page-link-color);
}
#nav-tree .children_ul {
@@ -65,8 +61,9 @@
}
#nav-tree .item {
- margin:0px;
- padding:0px;
+ margin: 0 6px 0 -5px;
+ padding: 0 0 0 5px;
+ height: 22px;
}
#nav-tree {
@@ -89,7 +86,6 @@
display:block;
position: absolute;
left: 0px;
- width: $width;
overflow : hidden;
}
@@ -98,15 +94,31 @@
}
.ui-resizable-e {
- background-image:var(--nav-splitbar-image);
- background-size:100%;
- background-repeat:repeat-y;
- background-attachment: scroll;
- cursor:ew-resize;
+ transition: opacity 0.5s ease;
+ background-color: var(--nav-splitbar-bg-color);
+ opacity:0;
+ cursor:col-resize;
height:100%;
right:0;
top:0;
width:6px;
+ position: relative;
+}
+
+.ui-resizable-e:after {
+ content: '';
+ display: block;
+ top: 50%;
+ left: 1px;
+ width: 2px;
+ height: 15px;
+ border-left: 1px solid var(--nav-splitbar-handle-color);
+ border-right: 1px solid var(--nav-splitbar-handle-color);
+ position: absolute;
+}
+
+.ui-resizable-e:hover {
+ opacity: 1;
}
.ui-resizable-handle {
@@ -121,24 +133,97 @@
}
#nav-tree {
- background-repeat:repeat-x;
background-color: var(--nav-background-color);
-webkit-overflow-scrolling : touch; /* iOS 5+ */
+ scrollbar-width: thin;
+ border-right: 1px solid var(--nav-border-color);
+ padding-left: 5px;
}
#nav-sync {
position:absolute;
- top:5px;
- right:24px;
- z-index:0;
+ top:0px;
+ right:0px;
+ z-index:1;
}
#nav-sync img {
opacity:0.3;
}
-#nav-sync img:hover {
- opacity:0.9;
+div.nav-sync-icon {
+ position: relative;
+ width: 24px;
+ height: 17px;
+ left: -6px;
+ top: -1px;
+ opacity: 0.7;
+ display: inline-block;
+ background-color: var(--sync-icon-background-color);
+ border: 1px solid var(--sync-icon-border-color);
+ box-sizing: content-box;
+}
+
+div.nav-sync-icon:hover {
+ background-color: var(--sync-icon-selected-background-color);
+ opacity: 1.0;
+}
+
+div.nav-sync-icon.active:after {
+ content: '';
+ background-color: var(--sync-icon-background-color);
+ border-top: 2px solid var(--sync-icon-color);
+ position: absolute;
+ width: 16px;
+ height: 0px;
+ top: 7px;
+ left: 4px;
+}
+
+div.nav-sync-icon.active:hover:after {
+ border-top: 2px solid var(--sync-icon-selected-color);
+}
+
+span.sync-icon-left {
+ position: absolute;
+ padding: 0;
+ margin: 0;
+ top: 3px;
+ left: 4px;
+ display: inline-block;
+ width: 8px;
+ height: 8px;
+ border-left: 2px solid var(--sync-icon-color);
+ border-top: 2px solid var(--sync-icon-color);
+ transform: rotate(-45deg);
+}
+
+span.sync-icon-right {
+ position: absolute;
+ padding: 0;
+ margin: 0;
+ top: 3px;
+ left: 10px;
+ display: inline-block;
+ width: 8px;
+ height: 8px;
+ border-right: 2px solid var(--sync-icon-color);
+ border-bottom: 2px solid var(--sync-icon-color);
+ transform: rotate(-45deg);
+}
+
+div.nav-sync-icon:hover span.sync-icon-left {
+ border-left: 2px solid var(--sync-icon-selected-color);
+ border-top: 2px solid var(--sync-icon-selected-color);
+}
+
+div.nav-sync-icon:hover span.sync-icon-right {
+ border-right: 2px solid var(--sync-icon-selected-color);
+ border-bottom: 2px solid var(--sync-icon-selected-color);
+}
+
+#nav-path ul {
+ border-top: 1px solid var(--nav-breadcrumb-separator-color);
}
@media print
@@ -147,3 +232,96 @@
div.ui-resizable-handle { display: none; position: relative; }
}
+/*---------------------------*/
+#container {
+ display: grid;
+ grid-template-columns: auto auto;
+ overflow: hidden;
+}
+
+#page-nav {
+ background: var(--nav-background-color);
+ display: block;
+ width: 250px;
+ box-sizing: content-box;
+ position: relative;
+ border-left: 1px solid var(--nav-border-color);
+}
+
+#page-nav-tree {
+ display: inline-block;
+}
+
+#page-nav-resize-handle {
+ transition: opacity 0.5s ease;
+ background-color: var(--nav-splitbar-bg-color);
+ opacity:0;
+ cursor:col-resize;
+ height:100%;
+ right:0;
+ top:0;
+ width:6px;
+ position: relative;
+ z-index: 1;
+ user-select: none;
+}
+
+#page-nav-resize-handle:after {
+ content: '';
+ display: block;
+ top: 50%;
+ left: 1px;
+ width: 2px;
+ height: 15px;
+ border-left: 1px solid var(--nav-splitbar-handle-color);
+ border-right: 1px solid var(--nav-splitbar-handle-color);
+ position: absolute;
+}
+
+#page-nav-resize-handle.dragging,
+#page-nav-resize-handle:hover {
+ opacity: 1;
+}
+
+#page-nav-contents {
+ padding: 0;
+ margin: 0;
+ display: block;
+ top: 0;
+ left: 0;
+ height: 100%;
+ width: 100%;
+ position: absolute;
+ overflow: auto;
+ scrollbar-width: thin;
+ -webkit-overflow-scrolling : touch; /* iOS 5+ */
+}
+
+ul.page-outline,
+ul.page-outline ul {
+ text-indent: 0;
+ list-style: none outside none;
+ padding: 0 0 0 4px;
+}
+
+ul.page-outline {
+ margin: 0 4px 4px 6px;
+}
+
+ul.page-outline div.item {
+ font: 12px var(--font-family-nav);
+ line-height: 22px;
+}
+
+ul.page-outline li {
+ white-space: nowrap;
+}
+
+ul.page-outline li.vis {
+ background-color: var(--nav-breadcrumb-active-bg);
+}
+
+#container.resizing {
+ cursor: col-resize;
+ user-select: none;
+}
diff --git a/docs/html/optimal_allocation.html b/docs/html/optimal_allocation.html
index 627471c..88f3e62 100644
--- a/docs/html/optimal_allocation.html
+++ b/docs/html/optimal_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Optimal resource allocation
-
-
@@ -33,33 +31,22 @@
-
+
-
- Optimal resource allocation
+ Optimal resource allocation
This library tries to automatically make optimal choices for the resources you create, so you don't need to care about them. There are some advanced features of Direct3D 12 that you may use to optimize your memory management. There are also some settings in D3D12MA that you may change to alter its default behavior. This page provides miscellaneous advice about features of D3D12 and D3D12MA that are non-essential, but may improve the stability or performance of your app.
-
+
Avoiding running out of memory
When trying to allocate more memory than available in the current heap (e.g., video memory on the graphics card, system memory), one of few bad things can happen:
-- The allocation (resource creation) function call can fail with
HRESULT value other than S_OK.
+- The allocation (resource creation) function call can fail with HRESULT value other than S_OK.
- The allocation may succeed, but take long time (even a significant fraction of a second).
- Some resources are automatically demoted from video memory to system memory, degrading the app performance.
- Even a crash of the entire graphics driver can happen, resulting in the D3D12 "device removal", which is usually catastrophic for the application.
@@ -113,34 +100,34 @@ Statistics of current memory usage and available budget for a specific memory segment group.Definition D3D12MemAlloc.h:474
UINT64 BudgetBytesEstimated amount of memory available to the program.Definition D3D12MemAlloc.h:497
UINT64 UsageBytesEstimated current memory usage of the program.Definition D3D12MemAlloc.h:486
-- Implementation detail
- DXGI interface offers function
IDXGIAdapter3::QueryVideoMemoryInfo that queries the current memory usage and budget. This library automatically makes use of it when available (when you use recent enough version of the DirectX SDK). If not, it falls back to estimating the usage and budget based on the total amount of the allocated memory and 80% of the full memory capacity, respectively.
+- Implementation detail
- DXGI interface offers function IDXGIAdapter3::QueryVideoMemoryInfo that queries the current memory usage and budget. This library automatically makes use of it when available (when you use recent enough version of the DirectX SDK). If not, it falls back to estimating the usage and budget based on the total amount of the allocated memory and 80% of the full memory capacity, respectively.
- Implementation detail
- Allocating large heaps and creating placed resources in them is one of the main features of this library. However, if allocating new such block would exceed the budget, it will automatically prefer creating the resource as committed to have exactly the right size, which can lower the chance of getting into trouble in case of over-commitment.
When creating non-essential resources, you can use D3D12MA::ALLOCATION_FLAG_WITHIN_BUDGET. Then, in case the allocation would exceed the budget, the library will return failure from the function without attempting to allocate the actual D3D12 memory.
-It may also be a good idea to support failed resource creation. For non-essential resources, when function D3D12MA::Allocator::CreateResource fails with a result other than S_OK, it is worth implementing some way of recovery instead of terminating or crashing the entire app.
-
+
It may also be a good idea to support failed resource creation. For non-essential resources, when function D3D12MA::Allocator::CreateResource fails with a result other than S_OK, it is worth implementing some way of recovery instead of terminating or crashing the entire app.
+
Allocation performance
Creating D3D12 resources (buffers and textures) can be a time-consuming operation. The duration can be unpredictable, spanning from a small fraction of a millisecond to a significant fraction of a second. Thus, it is recommended to allocate all the memory and create all the resources needed upfront rather than doing it during application runtime. For example, a video game can try to create its resources on startup or when loading a new level. Of course, is is not always possible. For example, open-world games may require loading and unloading some graphical assets in the background (often called "streaming").
-Creating and releasing D3D12 resources on a separate thread in the background may help. Both ID3D12Device and D3D12MA::Allocator objects are thread-safe, synchronized internally. However, cases were observed where resource creation calls like ID3D12Device::CreateCommittedResource were blocking other D3D12 calls like ExecuteCommandLists or Present somewhere inside the graphics driver, so hitches can happen even when using multithreading.
-The most expensive part is typically the allocation of a new D3D12 memory heap. This library tackles this problem by automatically allocating large heaps (64 MB by default) and creating resources as placed inside of them. When a new requested resource can be placed in a free space of an existing heap and doesn't require allocating a new heap, this operation is typically much faster, as it only requires creating a new ID3D12Resource object and not allocating new memory. This is the main benefit of using D3D12MA compared to the naive approach of using Direct3D 12 directly and creating each resource as committed with CreateCommittedResource, which would result in a separate allocation of an implicit heap every time.
-When a large number of small buffers needs to be created, the overhead of creating even just separate ID3D12Resource objects can be significant. It can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs. This library can also help with it. See section "Sub-allocating buffers" below.
+Creating and releasing D3D12 resources on a separate thread in the background may help. Both ID3D12Device and D3D12MA::Allocator objects are thread-safe, synchronized internally. However, cases were observed where resource creation calls like ID3D12Device::CreateCommittedResource were blocking other D3D12 calls like ExecuteCommandLists or Present somewhere inside the graphics driver, so hitches can happen even when using multithreading.
+The most expensive part is typically the allocation of a new D3D12 memory heap. This library tackles this problem by automatically allocating large heaps (64 MB by default) and creating resources as placed inside of them. When a new requested resource can be placed in a free space of an existing heap and doesn't require allocating a new heap, this operation is typically much faster, as it only requires creating a new ID3D12Resource object and not allocating new memory. This is the main benefit of using D3D12MA compared to the naive approach of using Direct3D 12 directly and creating each resource as committed with CreateCommittedResource, which would result in a separate allocation of an implicit heap every time.
+When a large number of small buffers needs to be created, the overhead of creating even just separate ID3D12Resource objects can be significant. It can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs. This library can also help with it. See section "Sub-allocating buffers" below.
- Implementation detail
- The CPU performance overhead of using this library is low. It uses a high-quality allocation algorithm called Two-Level Segregated Fit (TLSF), which in most cases can find a free place for a new allocation in few steps. The library also doesn't perform too many CPU heap allocations. In may cases, the allocation happens with 0 new CPU heap allocations performed by the library. Even the creation of a D3D12MA::Allocation object itself doesn't typically feature an CPU allocation, because these objects are returned out of a dedicated memory pool.
Another reason for the slowness of D3D12 memory allocation is the guarantee that the newly allocated memory is filled with zeros. When creating and destroying resources placed in an existing heap, this overhead is not present, and the memory is not zeroed - it may contain random data left by the resource previously allocated in that place. In recent versions of the DirectX 12 SDK, clearing the memory of the newly created D3D12 heaps can also be disabled for the improved performance. D3D12MA can use this feature when:
- D3D12MA::ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED is used during the creation of the main allocator object.
-D3D12_HEAP_FLAG_CREATE_NOT_ZEROED is passed to D3D12MA::POOL_DESC::HeapFlags during the creation of a custom pool.- D3D12_HEAP_FLAG_CREATE_NOT_ZEROED is passed to D3D12MA::POOL_DESC::HeapFlags during the creation of a custom pool.
It is recommended to always use these flags. The downside is that when the memory is not filled with zeros, while you don't properly clear it or otherwise initialize its content before use (which is required by D3D12), you may observe incorrect behavior. This problem mostly affects render-target and depth-stencil textures.
When an allocation needs to be made in a performance-critical code, you can use D3D12MA::ALLOCATION_FLAG_STRATEGY_MIN_TIME. In influences multiple heuristics inside the library to prefer faster allocation at the expense of possibly less optimal placement in the memory.
If the resource to be created is non-essential, while the performance is paramount, you can also use D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE. It will create the resource only if it can be placed inside and existing memory heap and return failure from the function if a new heap would need to be allocated, which should guarantee good performance of such function call.
-
+
Sub-allocating buffers
-
When a large number of small buffers needs to be created, the overhead of creating separate ID3D12Resource objects can be significant. It can also cause a significant waste of memory, as placed buffers need to be aligned to D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB by default. These problems can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs.
+When a large number of small buffers needs to be created, the overhead of creating separate ID3D12Resource objects can be significant. It can also cause a significant waste of memory, as placed buffers need to be aligned to D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB by default. These problems can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs.
It requires implementing a custom allocator for the data inside the buffer and using offsets to individual regions. When all the regions can be allocated linearly and freed all at once, implementing such allocator is trivial. When every region has the same size, implementing an allocator is also quite simple when using a "free list" algorithm. However, when regions can have different sizes and can be allocated and freed in random order, it requires a full allocation algorithm. D3D12MA can help with it by exposing its core allocation algorithm for custom usages. For more details and example code, see chapter: Virtual allocator. It can be used for all the cases mentioned above without too much performance overhead, because the D3D12MA::VirtualAllocation object is just a lightweight handle.
-When sub-allocating a buffer, you need to remember to explicitly request proper alignment required for each region. For example, data used as a constant buffer must be aligned to D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT = 256 B.
-
+
When sub-allocating a buffer, you need to remember to explicitly request proper alignment required for each region. For example, data used as a constant buffer must be aligned to D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT = 256 B.
+
Residency priority
When too much video memory is allocated, one of the things that can happen is the system demoting some heaps to the system memory. Moving data between memory pools or reaching out directly to the system memory through PCI Express bus can have large performance overhead, which can slow down the application, or even make the game unplayable any more. Unfortunately, it is not possible to fully control or prevent this demotion. Best thing to do is avoiding memory over-commitment. For more information, see section "Avoiding running out of memory" above.
-Recent versions of DirectX 12 SDK offer function ID3D12Device1::SetResidencyPriority that sets a hint about the priority of a resource - how important it is to stay resident in the video memory. Setting the priority happens at the level of an entire memory heap. D3D12MA offers an interface to set this priority in form of D3D12MA::POOL_DESC::ResidencyPriority parameter. It affects all allocations made out of the custom pool created with it, both placed inside large heaps and created as committed.
+Recent versions of DirectX 12 SDK offer function ID3D12Device1::SetResidencyPriority that sets a hint about the priority of a resource - how important it is to stay resident in the video memory. Setting the priority happens at the level of an entire memory heap. D3D12MA offers an interface to set this priority in form of D3D12MA::POOL_DESC::ResidencyPriority parameter. It affects all allocations made out of the custom pool created with it, both placed inside large heaps and created as committed.
It is recommended to create a custom pool for the purpose of using high residency priority of all resources that are critical for the performance, especially those that are written by the GPU, like render-target, depth-stencil textures, UAV textures and buffers. It is also worth creating them as committed, so that each one will have its own implicit heap. This can minimize the chance that an entire large heap is demoted to system memory, degrading performance of all the resources placed in it.
Example:
D3D12MA::CPOOL_DESC poolDesc = D3D12MA::CPOOL_DESC{
@@ -175,14 +162,14 @@
D3D12_RESIDENCY_PRIORITY priority = D3D12_RESIDENCY_PRIORITY_HIGH;
device1->SetResidencyPriority(1, &res, &priority);
ID3D12Resource * GetResource() constReturns D3D12 resource associated with this object.Definition D3D12MemAlloc.h:552
-
Note this is not the same as explicit eviction controlled using ID3D12Device::Evict and MakeResident functions. Resources evicted explicitly are illegal to access until they are made resident again, while the demotion described here happens automatically and only slows down the execution.
-
+
Note this is not the same as explicit eviction controlled using ID3D12Device::Evict and MakeResident functions. Resources evicted explicitly are illegal to access until they are made resident again, while the demotion described here happens automatically and only slows down the execution.
+
GPU upload heap
Direct3D 12 offers a fixed set of memory heap types:
-D3D12_HEAP_TYPE_DEFAULT: Represents the video memory. It is available and fast to access for the GPU. It should be used for all resources that are written by the GPU (like render-target and depth-stencil textures, UAV) and resources that are frequently read by the GPU (like textures intended for sampling, vertex, index, and constant buffers).D3D12_HEAP_TYPE_UPLOAD: Represents the system memory that is uncached and write-combined. It can be mapped and accessed by the CPU code using a pointer. It supports only buffers, not textures. It is intended for "staging buffers" that are filled by the CPU code and then used as a source of copy operations to the DEFAULT heap. It can also be accessed directly by the GPU - shaders can read from buffers created in this memory.D3D12_HEAP_TYPE_READBACK: Represents the system memory that is cached. It is intended for buffers used as a destination of copy operations from the DEFAULT heap.- D3D12_HEAP_TYPE_DEFAULT: Represents the video memory. It is available and fast to access for the GPU. It should be used for all resources that are written by the GPU (like render-target and depth-stencil textures, UAV) and resources that are frequently read by the GPU (like textures intended for sampling, vertex, index, and constant buffers).
+- D3D12_HEAP_TYPE_UPLOAD: Represents the system memory that is uncached and write-combined. It can be mapped and accessed by the CPU code using a pointer. It supports only buffers, not textures. It is intended for "staging buffers" that are filled by the CPU code and then used as a source of copy operations to the DEFAULT heap. It can also be accessed directly by the GPU - shaders can read from buffers created in this memory.
+- D3D12_HEAP_TYPE_READBACK: Represents the system memory that is cached. It is intended for buffers used as a destination of copy operations from the DEFAULT heap.
Note that in systems with a discrete graphics card, access to system memory is fast from the CPU code (like the C++ code mapping D3D12 buffers and accessing them through a pointer), while access to the video memory is fast from the GPU code (like shaders reading and writing buffers and textures). Any copy operation or direct access between these memory heap types happens through PCI Express bus, which can be relatively slow.
Modern systems offer a feature called Resizable BAR (ReBAR) that gives the CPU direct access to the full video memory. To be available, this feature needs to be supported by the whole hardware-software environment, including:
@@ -192,20 +179,20 @@
- Supporting operating system.
- The feature needs to be enabled in the UEFI settings. It is typically called "Above 4G Decoding" and "Resizable Bar".
-Recent versions of DirectX 12 SDK give access to this feature in form of a new, 4th memory pool: D3D12_HEAP_TYPE_GPU_UPLOAD. Resources created in it behave logically similar to the D3D12_HEAP_TYPE_UPLOAD heap:
+Recent versions of DirectX 12 SDK give access to this feature in form of a new, 4th memory pool: D3D12_HEAP_TYPE_GPU_UPLOAD. Resources created in it behave logically similar to the D3D12_HEAP_TYPE_UPLOAD heap:
- They support mapping and direct access from the CPU code through a pointer.
-- The mapped memory is uncached and write-combined, so it should be only written sequentially (e.g., number-by-number or using
memcpy). It shouldn't be accessed randomly or read, because it is extremely slow for uncached memory.
+- The mapped memory is uncached and write-combined, so it should be only written sequentially (e.g., number-by-number or using memcpy). It shouldn't be accessed randomly or read, because it is extremely slow for uncached memory.
- Only buffers are supported.
- Those buffers can be used as a source of copy operations or directly accessed by the GPU.
-The main difference is that resources created in the new D3D12_HEAP_TYPE_GPU_UPLOAD are placed in the video memory, while resources created in the old D3D12_HEAP_TYPE_UPLOAD are placed in the system memory. This implies which budgets are consumed by new resources allocated in those heaps. This also implies which operations involve transferring data through the PCI Express bus.
+The main difference is that resources created in the new D3D12_HEAP_TYPE_GPU_UPLOAD are placed in the video memory, while resources created in the old D3D12_HEAP_TYPE_UPLOAD are placed in the system memory. This implies which budgets are consumed by new resources allocated in those heaps. This also implies which operations involve transferring data through the PCI Express bus.
-- As
D3D12_HEAP_TYPE_UPLOAD uses the system memory, writes from the CPU code through a mapped pointer are faster, while copies or direct access from the GPU are slower because they need to go through PCIe.
-- As the new
D3D12_HEAP_TYPE_GPU_UPLOAD uses the video memory, copies or direct access from the GPU are faster, while writes from the CPU code through a mapped pointer can be slower, because they need to go through PCIe. For maximum performance of copy operations from this heap, a graphics or compute queue should be used, not a copy queue.
+- As D3D12_HEAP_TYPE_UPLOAD uses the system memory, writes from the CPU code through a mapped pointer are faster, while copies or direct access from the GPU are slower because they need to go through PCIe.
+- As the new D3D12_HEAP_TYPE_GPU_UPLOAD uses the video memory, copies or direct access from the GPU are faster, while writes from the CPU code through a mapped pointer can be slower, because they need to go through PCIe. For maximum performance of copy operations from this heap, a graphics or compute queue should be used, not a copy queue.
GPU Upload Heap can be used for performance optimization of some resources that need to be written by the CPU and read by the GPU. It can be beneficial especially for resources that need to change frequently (often called "dynamic").
-D3D12MA supports GPU upload heap when recent enough version of DirectX 12 SDK is used and when the current system supports it. The support can be queried using function D3D12MA::Allocator::IsGPUUploadHeapSupported(). When it returns TRUE, you can create resources using D3D12_HEAP_TYPE_GPU_UPLOAD. You can also just try creating such resource. Example:
+D3D12MA supports GPU upload heap when recent enough version of DirectX 12 SDK is used and when the current system supports it. The support can be queried using function D3D12MA::Allocator::IsGPUUploadHeapSupported(). When it returns TRUE, you can create resources using D3D12_HEAP_TYPE_GPU_UPLOAD. You can also just try creating such resource. Example:
D3D12MA::CALLOCATION_DESC allocDesc = D3D12MA::CALLOCATION_DESC{
D3D12_HEAP_TYPE_GPU_UPLOAD }; // !!!
@@ -240,13 +227,13 @@
else
// Some other error code e.g., out of memory...
D3D12_HEAP_TYPE HeapTypeThe type of memory heap where the new allocation should be placed.Definition D3D12MemAlloc.h:347
-
+
Committed versus placed resources
When using D3D12 API directly, there are 3 ways of creating resources:
-- Committed, using function
ID3D12Device::CreateCommittedResource. It creates the resource with its own memory heap, which is called an "implicit heap" and cannot be accessed directly.
-- Placed, using function
ID3D12Device::CreatePlacedResource. A ID3D12Heap needs to be created beforehand using ID3D12Device::CreateHeap. Then, the resource can be created as placed inside the heap at a specific offset.
-- Reserved, using function
ID3D12Device::CreateReservedResource. This library doesn't support them directly.
+- Committed, using function ID3D12Device::CreateCommittedResource. It creates the resource with its own memory heap, which is called an "implicit heap" and cannot be accessed directly.
+- Placed, using function ID3D12Device::CreatePlacedResource. A ID3D12Heap needs to be created beforehand using ID3D12Device::CreateHeap. Then, the resource can be created as placed inside the heap at a specific offset.
+- Reserved, using function ID3D12Device::CreateReservedResource. This library doesn't support them directly.
A naive solution would be to create all the resources as committed. It works, because in D3D12 there is no strict limit on the number of resources or heaps that can be created. However, there are certain advantages and disadvantages of using committed versus placed resources:
- The advantage of committed resources is that they are always created with a new heap, which is initialized with zeros. When a resource is created as placed, the memory may contain random data left by the resource previously allocated in that place. When the memory is not filled with zeros, while you don't properly clear it or otherwise initialize its content before use (which is required by D3D12), you may observe incorrect behavior. On the other hand, using committed resources and having every new resource filled with zeros can leave this kind of bugs undetected.
-- Manual eviction with
ID3D12Device::Evict and MakeResident functions work at the level of the entire heap, and so does ID3D12Device1::SetResidencyPriority, so creating resources as committed allows more fine-grained control over the eviction and residency priority of individual resources.
+- Manual eviction with ID3D12Device::Evict and MakeResident functions work at the level of the entire heap, and so does ID3D12Device1::SetResidencyPriority, so creating resources as committed allows more fine-grained control over the eviction and residency priority of individual resources.
- The advantage of placed resources is that they can be created in a region of a heap overlapping with some other resources. This approach is commonly called "aliasing". It can save memory, but it needs careful control over the resources that overlap in memory to make sure they are not used at the same time, there is an aliasing barrier issued between their usage, and the resource used after aliasing is correctly cleared every time. Committed resources don't offer this possibility, because every committed resource has its own exclusive memory heap. For more information, see chapter Resource aliasing (overlap).
When creating resources with the help of D3D12MA using function D3D12MA::Allocator::CreateResource, you typically don't need to care about all this. The library automatically makes the choice of creating the new resource as committed or placed. However, in cases when you need the information or the control over this choice between committed and placed, the library offers facilities to do that, described below.
@@ -303,18 +290,18 @@
UINT64 BlockSizeSize of a single heap (memory block) to be allocated as part of this pool, in bytes....Definition D3D12MemAlloc.h:933
You can request a new resource to be created as placed by using D3D12MA::ALLOCATION_FLAG_CAN_ALIAS. This is required especially if you plan to create another resource in the same region of memory, aliasing with your resource - hence the name of this flag.
Note D3D12MA::ALLOCATION_FLAG_CAN_ALIAS can be even combined with D3D12MA::ALLOCATION_FLAG_COMMITTED. In this case, the resource is not created as committed, but it is also not placed as part of a larger heap. What happens instead is that a new heap is created with the exact size required for the resource, and the resource is created in it, placed at offset 0.
-
+
Resource alignment
Certain types of resources require certain alignment in memory. An alignment is a requirement for the address or offset to the beginning of the resource to be a multiply of some value, which is always a power of 2. For committed resources, the problem is non-existent, because committed resources have their own implicit heaps where they are created at offset 0, which meets any alignment requirement. For placed resources, D3D12MA takes care of the alignment automatically.
-- Implementation detail
- Default alignment required MSAA textures is
D3D12_DEFAULT_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 4 MB. Default alignment required for buffers and other textures is D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB.
+- Implementation detail
- Default alignment required MSAA textures is D3D12_DEFAULT_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 4 MB. Default alignment required for buffers and other textures is D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB.
Because the alignment required for buffers is 64 KB, small buffers can waste a lot of memory in between when created as placed. When such small buffers are created as committed, some graphics drivers are able to pack them better. D3D12MA automatically takes advantage of this by preferring to create small buffers as committed. This heuristics is enabled by default. It is also a tradeoff - it can make the allocation of these buffers slower. It can be disabled for an individual resource by using D3D12MA::ALLOCATION_FLAG_STRATEGY_MIN_TIME and for the entire allocator by using D3D12MA::ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED.
-For certain textures that meet a complex set of requirements, special "small alignment" can be applied. Details can be found in Microsoft documentation of the D3D12_RESOURCE_DESC structure. For MSAA textures, the small alignment is D3D12_SMALL_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB. For other textures, the small alignment is D3D12_SMALL_RESOURCE_PLACEMENT_ALIGNMENT = 4 KB. D3D12MA uses this feature automatically. Detailed behavior can be disabled or controlled by predefining macro D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT.
-D3D12 also has a concept of alignment of the entire heap, passed through D3D12_HEAP_DESC::Alignment. This library automatically sets the alignment as small as possible. Unfortunately, any heap that has a chance of hosting an MSAA texture needs to have the alignment set to 4 MB. This problem can be overcome by passing D3D12MA::ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of the main allocator object and D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of any custom heap that supports textures, not only buffers. With those flags, the alignment of the heaps created by D3D12MA can be lower, but any MSAA textures are created as committed. You should always use these flags in your code unless you really need to create some MSAA textures as placed.
+For certain textures that meet a complex set of requirements, special "small alignment" can be applied. Details can be found in Microsoft documentation of the D3D12_RESOURCE_DESC structure. For MSAA textures, the small alignment is D3D12_SMALL_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB. For other textures, the small alignment is D3D12_SMALL_RESOURCE_PLACEMENT_ALIGNMENT = 4 KB. D3D12MA uses this feature automatically. Detailed behavior can be disabled or controlled by predefining macro D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT.
+D3D12 also has a concept of alignment of the entire heap, passed through D3D12_HEAP_DESC::Alignment. This library automatically sets the alignment as small as possible. Unfortunately, any heap that has a chance of hosting an MSAA texture needs to have the alignment set to 4 MB. This problem can be overcome by passing D3D12MA::ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of the main allocator object and D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of any custom heap that supports textures, not only buffers. With those flags, the alignment of the heaps created by D3D12MA can be lower, but any MSAA textures are created as committed. You should always use these flags in your code unless you really need to create some MSAA textures as placed.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/quick_start.html b/docs/html/quick_start.html
index f9219d2..4eba7e6 100644
--- a/docs/html/quick_start.html
+++ b/docs/html/quick_start.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Quick start
-
-
@@ -33,33 +31,22 @@
-
+
-
- Quick start
+ Quick start
-
+
Project setup and initialization
This is a small, standalone C++ library. It consists of 2 files: "D3D12MemAlloc.h" header file with public interface and "D3D12MemAlloc.cpp" with internal implementation. The only external dependencies are WinAPI, Direct3D 12, and parts of C/C++ standard library (but STL containers, exceptions, or RTTI are not used).
The library is developed and tested using Microsoft Visual Studio 2022, but it should work with other compilers as well. It is designed for 64-bit code.
To use the library in your project:
-(1.) Copy files D3D12MemAlloc.cpp, D3D12MemAlloc.h to your project.
-(2.) Make D3D12MemAlloc.cpp compiling as part of the project, as C++ code.
+(1.) Copy files D3D12MemAlloc.cpp, D3D12MemAlloc.h to your project.
+(2.) Make D3D12MemAlloc.cpp compiling as part of the project, as C++ code.
(3.) Include library header in each CPP file that needs to use the library.
#include "D3D12MemAlloc.h"
-(4.) Right after you created ID3D12Device, fill D3D12MA::ALLOCATOR_DESC structure and call function D3D12MA::CreateAllocator to create the main D3D12MA::Allocator object.
+
(4.) Right after you created ID3D12Device, fill D3D12MA::ALLOCATOR_DESC structure and call function D3D12MA::CreateAllocator to create the main D3D12MA::Allocator object.
Please note that all symbols of the library are declared inside D3D12MA namespace.
IDXGIAdapter* adapter = ...
ID3D12Device* device = ...
@@ -119,12 +106,12 @@
D3D12MA_API HRESULT CreateAllocator(const ALLOCATOR_DESC *pDesc, Allocator **ppAllocator)Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
(5.) Right before destroying the D3D12 device, destroy the allocator object.
allocator->Release();
-Objects of this library must be destroyed by calling Release method. They are somewhat compatible with COM: they implement IUnknown interface with its virtual methods: AddRef, Release, QueryInterface, and they are reference-counted internally. You can use smart pointers designed for COM with objects of this library - e.g. CComPtr or Microsoft::WRL::ComPtr. The reference counter is thread-safe. QueryInterface method supports only IUnknown, as classes of this library don't define their own GUIDs.
-
+
Objects of this library must be destroyed by calling Release method. They are somewhat compatible with COM: they implement IUnknown interface with its virtual methods: AddRef, Release, QueryInterface, and they are reference-counted internally. You can use smart pointers designed for COM with objects of this library - e.g. CComPtr or Microsoft::WRL::ComPtr. The reference counter is thread-safe. QueryInterface method supports only IUnknown, as classes of this library don't define their own GUIDs.
+
Creating resources
-To use the library for creating resources (textures and buffers), call method D3D12MA::Allocator::CreateResource in the place where you would previously call ID3D12Device::CreateCommittedResource.
-The function has similar syntax, but it expects structure D3D12MA::ALLOCATION_DESC to be passed along with D3D12_RESOURCE_DESC and other parameters for created resource. This structure describes parameters of the desired memory allocation, including choice of D3D12_HEAP_TYPE.
-The function returns a new object of type D3D12MA::Allocation. It represents allocated memory and can be queried for size, offset, ID3D12Heap. It also holds a reference to the ID3D12Resource, which can be accessed by calling D3D12MA::Allocation::GetResource().
+To use the library for creating resources (textures and buffers), call method D3D12MA::Allocator::CreateResource in the place where you would previously call ID3D12Device::CreateCommittedResource.
+The function has similar syntax, but it expects structure D3D12MA::ALLOCATION_DESC to be passed along with D3D12_RESOURCE_DESC and other parameters for created resource. This structure describes parameters of the desired memory allocation, including choice of D3D12_HEAP_TYPE.
+The function returns a new object of type D3D12MA::Allocation. It represents allocated memory and can be queried for size, offset, ID3D12Heap. It also holds a reference to the ID3D12Resource, which can be accessed by calling D3D12MA::Allocation::GetResource().
D3D12_RESOURCE_DESC resourceDesc = {};
resourceDesc.Dimension = D3D12_RESOURCE_DIMENSION_TEXTURE2D;
resourceDesc.Alignment = 0;
@@ -160,13 +147,13 @@
D3D12_HEAP_TYPE HeapTypeThe type of memory heap where the new allocation should be placed.Definition D3D12MemAlloc.h:347
You need to release the allocation object when no longer needed. This will also release the D3D12 resource.
allocation->Release();
-The advantage of using the allocator instead of creating committed resource, and the main purpose of this library, is that it can decide to allocate bigger memory heap internally using ID3D12Device::CreateHeap and place multiple resources in it, at different offsets, using ID3D12Device::CreatePlacedResource. The library manages its own collection of allocated memory blocks (heaps) and remembers which parts of them are occupied and which parts are free to be used for new resources.
-It is important to remember that resources created as placed don't have their memory initialized to zeros, but may contain garbage data, so they need to be fully initialized before usage, e.g. using Clear (ClearRenderTargetView), Discard (DiscardResource), or Copy (CopyResource).
-The library also automatically handles resource heap tier. When D3D12_FEATURE_DATA_D3D12_OPTIONS::ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1, resources of 3 types: buffers, textures that are render targets or depth-stencil, and other textures must be kept in separate heaps. When D3D12_RESOURCE_HEAP_TIER_2, they can be kept together. By using this library, you don't need to handle this manually.
-
+
The advantage of using the allocator instead of creating committed resource, and the main purpose of this library, is that it can decide to allocate bigger memory heap internally using ID3D12Device::CreateHeap and place multiple resources in it, at different offsets, using ID3D12Device::CreatePlacedResource. The library manages its own collection of allocated memory blocks (heaps) and remembers which parts of them are occupied and which parts are free to be used for new resources.
+It is important to remember that resources created as placed don't have their memory initialized to zeros, but may contain garbage data, so they need to be fully initialized before usage, e.g. using Clear (ClearRenderTargetView), Discard (DiscardResource), or Copy (CopyResource).
+The library also automatically handles resource heap tier. When D3D12_FEATURE_DATA_D3D12_OPTIONS::ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1, resources of 3 types: buffers, textures that are render targets or depth-stencil, and other textures must be kept in separate heaps. When D3D12_RESOURCE_HEAP_TIER_2, they can be kept together. By using this library, you don't need to handle this manually.
+
Resource reference counting
-ID3D12Resource and other interfaces of Direct3D 12 use COM, so they are reference-counted. Objects of this library are reference-counted as well. An object of type D3D12MA::Allocation remembers the resource (buffer or texture) that was created together with this memory allocation and holds a reference to the ID3D12Resource object. (Note this is a difference to Vulkan Memory Allocator, where a VmaAllocation object has no connection with the buffer or image that was created with it.) Thus, it is important to manage the resource reference counter properly.
-The simplest use case is shown in the code snippet above. When only D3D12MA::Allocation object is obtained from a function call like D3D12MA::Allocator::CreateResource, it remembers the ID3D12Resource that was created with it and holds a reference to it. The resource can be obtained by calling allocation->GetResource(), which doesn't increment the resource reference counter. Calling allocation->Release() will decrease the resource reference counter, which is 1 in this case, so the resource will be released.
+ID3D12Resource and other interfaces of Direct3D 12 use COM, so they are reference-counted. Objects of this library are reference-counted as well. An object of type D3D12MA::Allocation remembers the resource (buffer or texture) that was created together with this memory allocation and holds a reference to the ID3D12Resource object. (Note this is a difference to Vulkan Memory Allocator, where a VmaAllocation object has no connection with the buffer or image that was created with it.) Thus, it is important to manage the resource reference counter properly.
+The simplest use case is shown in the code snippet above. When only D3D12MA::Allocation object is obtained from a function call like D3D12MA::Allocator::CreateResource, it remembers the ID3D12Resource that was created with it and holds a reference to it. The resource can be obtained by calling allocation->GetResource(), which doesn't increment the resource reference counter. Calling allocation->Release() will decrease the resource reference counter, which is 1 in this case, so the resource will be released.
Second option is to retrieve a pointer to the resource along with D3D12MA::Allocation. Last parameters of the resource creation function can be used for this purpose.
D3D12MA::Allocation* allocation;
ID3D12Resource* resource;
@@ -179,15 +166,15 @@
IID_PPV_ARGS(&resource));
// Use resource...
-
In this case, returned pointer resource is equal to allocation->GetResource(), but the creation function additionally increases resource reference counter for the purpose of returning it from this call (it actually calls QueryInterface internally), so the resource will have the counter = 2. The resource then need to be released along with the allocation, in this particular order, to make sure the resource is destroyed before its memory heap can potentially be freed.
+In this case, returned pointer resource is equal to allocation->GetResource(), but the creation function additionally increases resource reference counter for the purpose of returning it from this call (it actually calls QueryInterface internally), so the resource will have the counter = 2. The resource then need to be released along with the allocation, in this particular order, to make sure the resource is destroyed before its memory heap can potentially be freed.
resource->Release();
allocation->Release();
-More advanced use cases are possible when we consider that an D3D12MA::Allocation object can just hold a reference to any resource. It can be changed by calling D3D12MA::Allocation::SetResource. This function releases the old resource and calls AddRef on the new one.
-Special care must be taken when performing defragmentation. The new resource created at the destination place should be set as pass.pMoves[i].pDstTmpAllocation->SetResource(newRes), but it is moved to the source allocation at end of the defragmentation pass, while the old resource accessible through pass.pMoves[i].pSrcAllocation->GetResource() is then released. For more information, see documentation chapter Defragmentation.
-
+
More advanced use cases are possible when we consider that an D3D12MA::Allocation object can just hold a reference to any resource. It can be changed by calling D3D12MA::Allocation::SetResource. This function releases the old resource and calls AddRef on the new one.
+Special care must be taken when performing defragmentation. The new resource created at the destination place should be set as pass.pMoves[i].pDstTmpAllocation->SetResource(newRes), but it is moved to the source allocation at end of the defragmentation pass, while the old resource accessible through pass.pMoves[i].pSrcAllocation->GetResource() is then released. For more information, see documentation chapter Defragmentation.
+
Mapping memory
-The process of getting regular CPU-side pointer to the memory of a resource in Direct3D is called "mapping". There are rules and restrictions to this process, as described in D3D12 documentation of ID3D12Resource::Map method.
-Mapping happens on the level of particular resources, not entire memory heaps, and so it is out of scope of this library. Just as the documentation of the Map function says:
+The process of getting regular CPU-side pointer to the memory of a resource in Direct3D is called "mapping". There are rules and restrictions to this process, as described in D3D12 documentation of ID3D12Resource::Map method.
+Mapping happens on the level of particular resources, not entire memory heaps, and so it is out of scope of this library. Just as the documentation of the Map function says:
- Returned pointer refers to data of particular subresource, not entire memory heap.
- You can map same resource multiple times. It is ref-counted internally.
@@ -196,7 +183,7 @@
- Unmapping may not be required before using written data - some heap types on some platforms support resources persistently mapped.
When using this library, you can map and use your resources normally without considering whether they are created as committed resources or placed resources in one large heap.
-Example for buffer created and filled in UPLOAD heap type:
+Example for buffer created and filled in UPLOAD heap type:
const UINT64 bufSize = 65536;
const float* bufData = ...;
@@ -233,17 +220,17 @@
memcpy(mappedPtr, bufData, bufSize);
resource->Unmap(0, NULL);
-
+
Helper structures
-
DirectX 12 Agility SDK offers a library of helpers in files "build\native\include\d3dx12\*.h". They include structures that help with complete and concise initialization of the core D3D12 *_DESC structures by using some basic C++ features (constructors, static methods, default parameters). They inherit from these structures, so they support implicit casting to them. For example, structure CD3DX12_RESOURCE_DESC can be used to conveniently fill in structure D3D12_RESOURCE_DESC.
-Similarly, this library provides a set of helper structures that aid in initialization of some of the *_DESC structures defined in the library. These are:
+DirectX 12 Agility SDK offers a library of helpers in files "build\native\include\d3dx12\*.h". They include structures that help with complete and concise initialization of the core D3D12 *_DESC structures by using some basic C++ features (constructors, static methods, default parameters). They inherit from these structures, so they support implicit casting to them. For example, structure CD3DX12_RESOURCE_DESC can be used to conveniently fill in structure D3D12_RESOURCE_DESC.
+Similarly, this library provides a set of helper structures that aid in initialization of some of the *_DESC structures defined in the library. These are:
- D3D12MA::CALLOCATION_DESC, which inherits from D3D12MA::ALLOCATION_DESC.
- D3D12MA::CPOOL_DESC, which inherits from D3D12MA::POOL_DESC.
- D3D12MA::CVIRTUAL_BLOCK_DESC, which inherits from D3D12MA::VIRTUAL_BLOCK_DESC.
- D3D12MA::CVIRTUAL_ALLOCATION_DESC, which inherits from D3D12MA::VIRTUAL_ALLOCATION_DESC.
-For example, when you want to create a buffer in the UPLAOD heap using minimal allocation time, you can use base structures:
+For example, when you want to create a buffer in the UPLAOD heap using minimal allocation time, you can use base structures:
D3D12MA::ALLOCATION_DESC allocDesc;
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_STRATEGY_MIN_TIME;
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
@@ -291,7 +278,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/resource_aliasing.html b/docs/html/resource_aliasing.html
index c89a007..1275544 100644
--- a/docs/html/resource_aliasing.html
+++ b/docs/html/resource_aliasing.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Resource aliasing (overlap)
-
-
@@ -33,33 +31,22 @@
-
+
-
- Resource aliasing (overlap)
+ Resource aliasing (overlap)
New explicit graphics APIs (Vulkan and Direct3D 12), thanks to manual memory management, give an opportunity to alias (overlap) multiple resources in the same region of memory - a feature not available in the old APIs (Direct3D 11, OpenGL). It can be useful to save video memory, but it must be used with caution.
@@ -171,18 +158,18 @@
Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.Definition D3D12MemAlloc.h:338
D3D12_HEAP_FLAGS ExtraHeapFlagsAdditional heap flags to be used when allocating memory.Definition D3D12MemAlloc.h:363
D3D12_HEAP_TYPE HeapTypeThe type of memory heap where the new allocation should be placed.Definition D3D12MemAlloc.h:347
-Remember that using resouces that alias in memory requires proper synchronization. You need to issue a special barrier of type D3D12_RESOURCE_BARRIER_TYPE_ALIASING. You also need to treat a resource after aliasing as uninitialized - containing garbage data. For example, if you use res1 and then want to use res2, you need to first initialize res2 using either Clear, Discard, or Copy to the entire resource.
+Remember that using resouces that alias in memory requires proper synchronization. You need to issue a special barrier of type D3D12_RESOURCE_BARRIER_TYPE_ALIASING. You also need to treat a resource after aliasing as uninitialized - containing garbage data. For example, if you use res1 and then want to use res2, you need to first initialize res2 using either Clear, Discard, or Copy to the entire resource.
Additional considerations:
- D3D12 also allows to interpret contents of memory between aliasing resources consistently in some cases, which is called "data inheritance". For details, see Microsoft documentation chapter "Memory Aliasing and Data Inheritance".
-- You can create more complex layout where different textures and buffers are bound at different offsets inside one large allocation. For example, one can imagine a big texture used in some render passes, aliasing with a set of many small buffers used in some further passes. To bind a resource at non-zero offset of an allocation, call D3D12MA::Allocator::CreateAliasingResource with appropriate value of
AllocationLocalOffset parameter.
-- Resources of the three categories: buffers, textures with
RENDER_TARGET or DEPTH_STENCIL flags, and all other textures, can be placed in the same memory only when allocator->GetD3D12Options().ResourceHeapTier >= D3D12_RESOURCE_HEAP_TIER_2. Otherwise they must be placed in different memory heap types, and thus aliasing them is not possible.
+- You can create more complex layout where different textures and buffers are bound at different offsets inside one large allocation. For example, one can imagine a big texture used in some render passes, aliasing with a set of many small buffers used in some further passes. To bind a resource at non-zero offset of an allocation, call D3D12MA::Allocator::CreateAliasingResource with appropriate value of AllocationLocalOffset parameter.
+- Resources of the three categories: buffers, textures with RENDER_TARGET or DEPTH_STENCIL flags, and all other textures, can be placed in the same memory only when allocator->GetD3D12Options().ResourceHeapTier >= D3D12_RESOURCE_HEAP_TIER_2. Otherwise they must be placed in different memory heap types, and thus aliasing them is not possible.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/search/pages_0.js b/docs/html/search/pages_0.js
index 6c4bc1e..4e13aaf 100644
--- a/docs/html/search/pages_0.js
+++ b/docs/html/search/pages_0.js
@@ -1,10 +1,23 @@
var searchData=
[
- ['algorithm_0',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
- ['aliasing_20overlap_1',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
- ['allocation_2',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
- ['allocation_20algorithm_3',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
- ['allocator_4',['D3D12 Memory Allocator',['../index.html',1,'']]],
- ['allocator_5',['Virtual allocator',['../virtual_allocator.html',1,'optimal_allocation']]],
- ['asked_20questions_6',['Frequently asked questions',['../faq.html',1,'index']]]
+ ['additional_20considerations_0',['Additional considerations',['../linear_algorithm.html#linear_algorithm_additional_considerations',1,'Additional considerations'],['../virtual_allocator.html#virtual_allocator_additional_considerations',1,'Additional considerations']]],
+ ['algorithm_1',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
+ ['aliasing_20overlap_2',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
+ ['alignment_3',['Resource alignment',['../optimal_allocation.html#optimal_allocation_resource_alignment',1,'']]],
+ ['alignment_20and_20units_4',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]],
+ ['allocating_20buffers_5',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]],
+ ['allocation_6',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
+ ['allocation_20algorithm_7',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
+ ['allocation_20parameters_8',['Allocation parameters',['../virtual_allocator.html#virtual_allocator_allocation_parameters',1,'']]],
+ ['allocation_20performance_9',['Allocation performance',['../optimal_allocation.html#optimal_allocation_allocation_Performance',1,'']]],
+ ['allocations_10',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]],
+ ['allocator_11',['D3D12 Memory Allocator',['../index.html',1,'']]],
+ ['allocator_12',['allocator',['../configuration.html#custom_memory_allocator',1,'Custom CPU memory allocator'],['../virtual_allocator.html',1,'Virtual allocator']]],
+ ['and_20benefits_13',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]],
+ ['and_20compatibility_14',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]],
+ ['and_20initialization_15',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]],
+ ['and_20units_16',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]],
+ ['asked_20questions_17',['Frequently asked questions',['../faq.html',1,'index']]],
+ ['at_20once_18',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]],
+ ['avoiding_20running_20out_20of_20memory_19',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]]
];
diff --git a/docs/html/search/pages_1.js b/docs/html/search/pages_1.js
index 91cb574..d34b057 100644
--- a/docs/html/search/pages_1.js
+++ b/docs/html/search/pages_1.js
@@ -1,6 +1,7 @@
var searchData=
[
- ['configuration_0',['Configuration',['../configuration.html',1,'index']]],
- ['considerations_1',['General considerations',['../general_considerations.html',1,'index']]],
- ['custom_20memory_20pools_2',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
+ ['benefits_0',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]],
+ ['block_1',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]],
+ ['buffer_2',['Ring buffer',['../linear_algorithm.html#linear_algorithm_ring_buffer',1,'']]],
+ ['buffers_3',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]]
];
diff --git a/docs/html/search/pages_10.js b/docs/html/search/pages_10.js
new file mode 100644
index 0000000..af3b029
--- /dev/null
+++ b/docs/html/search/pages_10.js
@@ -0,0 +1,13 @@
+var searchData=
+[
+ ['safety_0',['Thread safety',['../general_considerations.html#general_considerations_thread_safety',1,'']]],
+ ['setup_20and_20initialization_1',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]],
+ ['stack_2',['Stack',['../linear_algorithm.html#linear_algorithm_stack',1,'']]],
+ ['stack_3',['Double stack',['../linear_algorithm.html#linear_algorithm_double_stack',1,'']]],
+ ['start_4',['Quick start',['../quick_start.html',1,'index']]],
+ ['statistics_5',['Statistics',['../statistics.html',1,'Statistics'],['../virtual_allocator.html#virtual_allocator_statistics',1,'Statistics']]],
+ ['statistics_6',['Numeric statistics',['../statistics.html#statistics_numeric_statistics',1,'']]],
+ ['structures_7',['Helper structures',['../quick_start.html#quick_start_helper_structures',1,'']]],
+ ['sub_20allocating_20buffers_8',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]],
+ ['supported_9',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]]
+];
diff --git a/docs/html/search/pages_11.js b/docs/html/search/pages_11.js
new file mode 100644
index 0000000..ce665b6
--- /dev/null
+++ b/docs/html/search/pages_11.js
@@ -0,0 +1,5 @@
+var searchData=
+[
+ ['table_20of_20contents_0',['Table of contents',['../index.html#main_table_of_contents',1,'']]],
+ ['thread_20safety_1',['Thread safety',['../general_considerations.html#general_considerations_thread_safety',1,'']]]
+];
diff --git a/docs/html/search/pages_12.js b/docs/html/search/pages_12.js
new file mode 100644
index 0000000..32f0ad5
--- /dev/null
+++ b/docs/html/search/pages_12.js
@@ -0,0 +1,6 @@
+var searchData=
+[
+ ['units_0',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]],
+ ['upload_20heap_1',['GPU upload heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'']]],
+ ['usage_2',['Usage',['../custom_pools.html#custom_pools_usage',1,'']]]
+];
diff --git a/docs/html/search/pages_13.js b/docs/html/search/pages_13.js
new file mode 100644
index 0000000..aa04e5d
--- /dev/null
+++ b/docs/html/search/pages_13.js
@@ -0,0 +1,8 @@
+var searchData=
+[
+ ['versioning_20and_20compatibility_0',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]],
+ ['versus_20placed_20resources_1',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]],
+ ['virtual_20allocations_2',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]],
+ ['virtual_20allocator_3',['Virtual allocator',['../virtual_allocator.html',1,'optimal_allocation']]],
+ ['virtual_20block_4',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]]
+];
diff --git a/docs/html/search/pages_14.js b/docs/html/search/pages_14.js
new file mode 100644
index 0000000..8225a92
--- /dev/null
+++ b/docs/html/search/pages_14.js
@@ -0,0 +1,4 @@
+var searchData=
+[
+ ['web_20links_0',['Web links',['../index.html#main_see_also',1,'']]]
+];
diff --git a/docs/html/search/pages_2.js b/docs/html/search/pages_2.js
index 8aa1a38..7553f75 100644
--- a/docs/html/search/pages_2.js
+++ b/docs/html/search/pages_2.js
@@ -1,5 +1,14 @@
var searchData=
[
- ['d3d12_20memory_20allocator_0',['D3D12 Memory Allocator',['../index.html',1,'']]],
- ['defragmentation_1',['Defragmentation',['../defragmentation.html',1,'optimal_allocation']]]
+ ['committed_20versus_20placed_20resources_0',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]],
+ ['compatibility_1',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]],
+ ['configuration_2',['Configuration',['../configuration.html',1,'index']]],
+ ['considerations_3',['considerations',['../linear_algorithm.html#linear_algorithm_additional_considerations',1,'Additional considerations'],['../virtual_allocator.html#virtual_allocator_additional_considerations',1,'Additional considerations'],['../general_considerations.html',1,'General considerations']]],
+ ['contents_4',['Table of contents',['../index.html#main_table_of_contents',1,'']]],
+ ['counting_5',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]],
+ ['cpu_20memory_20allocator_6',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]],
+ ['creating_20resources_7',['Creating resources',['../quick_start.html#quick_start_creating_resources',1,'']]],
+ ['creating_20virtual_20block_8',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]],
+ ['custom_20cpu_20memory_20allocator_9',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]],
+ ['custom_20memory_20pools_10',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
];
diff --git a/docs/html/search/pages_3.js b/docs/html/search/pages_3.js
index 842b2bb..89d174b 100644
--- a/docs/html/search/pages_3.js
+++ b/docs/html/search/pages_3.js
@@ -1,4 +1,9 @@
var searchData=
[
- ['frequently_20asked_20questions_0',['Frequently asked questions',['../faq.html',1,'index']]]
+ ['d3d12_20memory_20allocator_0',['D3D12 Memory Allocator',['../index.html',1,'']]],
+ ['deallocation_1',['Deallocation',['../virtual_allocator.html#virtual_allocator_deallocation',1,'']]],
+ ['debug_20margins_2',['Debug margins',['../configuration.html#debug_margins',1,'']]],
+ ['defragmentation_3',['Defragmentation',['../defragmentation.html',1,'optimal_allocation']]],
+ ['double_20stack_4',['Double stack',['../linear_algorithm.html#linear_algorithm_double_stack',1,'']]],
+ ['dump_5',['JSON dump',['../statistics.html#statistics_json_dump',1,'']]]
];
diff --git a/docs/html/search/pages_4.js b/docs/html/search/pages_4.js
index 1aed57d..6f9860c 100644
--- a/docs/html/search/pages_4.js
+++ b/docs/html/search/pages_4.js
@@ -1,4 +1,7 @@
var searchData=
[
- ['general_20considerations_0',['General considerations',['../general_considerations.html',1,'index']]]
+ ['features_20and_20benefits_0',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]],
+ ['features_20not_20supported_1',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]],
+ ['free_20at_20once_2',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]],
+ ['frequently_20asked_20questions_3',['Frequently asked questions',['../faq.html',1,'index']]]
];
diff --git a/docs/html/search/pages_5.js b/docs/html/search/pages_5.js
index b965ff9..b85c57f 100644
--- a/docs/html/search/pages_5.js
+++ b/docs/html/search/pages_5.js
@@ -1,4 +1,5 @@
var searchData=
[
- ['linear_20allocation_20algorithm_0',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]]
+ ['general_20considerations_0',['General considerations',['../general_considerations.html',1,'index']]],
+ ['gpu_20upload_20heap_1',['GPU upload heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'']]]
];
diff --git a/docs/html/search/pages_6.js b/docs/html/search/pages_6.js
index 2fa4310..6386d6c 100644
--- a/docs/html/search/pages_6.js
+++ b/docs/html/search/pages_6.js
@@ -1,5 +1,5 @@
var searchData=
[
- ['memory_20allocator_0',['D3D12 Memory Allocator',['../index.html',1,'']]],
- ['memory_20pools_1',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
+ ['heap_0',['GPU upload heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'']]],
+ ['helper_20structures_1',['Helper structures',['../quick_start.html#quick_start_helper_structures',1,'']]]
];
diff --git a/docs/html/search/pages_7.js b/docs/html/search/pages_7.js
index 0c3cb7f..75d0639 100644
--- a/docs/html/search/pages_7.js
+++ b/docs/html/search/pages_7.js
@@ -1,5 +1,4 @@
var searchData=
[
- ['optimal_20resource_20allocation_0',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
- ['overlap_1',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]]
+ ['initialization_0',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]]
];
diff --git a/docs/html/search/pages_8.js b/docs/html/search/pages_8.js
index f4128dd..2f270a2 100644
--- a/docs/html/search/pages_8.js
+++ b/docs/html/search/pages_8.js
@@ -1,4 +1,4 @@
var searchData=
[
- ['pools_0',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
+ ['json_20dump_0',['JSON dump',['../statistics.html#statistics_json_dump',1,'']]]
];
diff --git a/docs/html/search/pages_9.js b/docs/html/search/pages_9.js
index c9afe7b..9cdb234 100644
--- a/docs/html/search/pages_9.js
+++ b/docs/html/search/pages_9.js
@@ -1,5 +1,5 @@
var searchData=
[
- ['questions_0',['Frequently asked questions',['../faq.html',1,'index']]],
- ['quick_20start_1',['Quick start',['../quick_start.html',1,'index']]]
+ ['linear_20allocation_20algorithm_0',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
+ ['links_1',['Web links',['../index.html#main_see_also',1,'']]]
];
diff --git a/docs/html/search/pages_a.js b/docs/html/search/pages_a.js
index 53f0a34..0ce8dfd 100644
--- a/docs/html/search/pages_a.js
+++ b/docs/html/search/pages_a.js
@@ -1,5 +1,10 @@
var searchData=
[
- ['resource_20aliasing_20overlap_0',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
- ['resource_20allocation_1',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]]
+ ['making_20virtual_20allocations_0',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]],
+ ['mapping_20memory_1',['Mapping memory',['../quick_start.html#quick_start_mapping_memory',1,'']]],
+ ['margins_2',['Debug margins',['../configuration.html#debug_margins',1,'']]],
+ ['memory_3',['memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'Avoiding running out of memory'],['../quick_start.html#quick_start_mapping_memory',1,'Mapping memory']]],
+ ['memory_20allocator_4',['D3D12 Memory Allocator',['../index.html',1,'']]],
+ ['memory_20allocator_5',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]],
+ ['memory_20pools_6',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
];
diff --git a/docs/html/search/pages_b.js b/docs/html/search/pages_b.js
index d4b7ec0..a1fc386 100644
--- a/docs/html/search/pages_b.js
+++ b/docs/html/search/pages_b.js
@@ -1,5 +1,5 @@
var searchData=
[
- ['start_0',['Quick start',['../quick_start.html',1,'index']]],
- ['statistics_1',['Statistics',['../statistics.html',1,'optimal_allocation']]]
+ ['not_20supported_0',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]],
+ ['numeric_20statistics_1',['Numeric statistics',['../statistics.html#statistics_numeric_statistics',1,'']]]
];
diff --git a/docs/html/search/pages_c.js b/docs/html/search/pages_c.js
index 6f1ceb8..2036541 100644
--- a/docs/html/search/pages_c.js
+++ b/docs/html/search/pages_c.js
@@ -1,4 +1,9 @@
var searchData=
[
- ['virtual_20allocator_0',['Virtual allocator',['../virtual_allocator.html',1,'optimal_allocation']]]
+ ['of_20contents_0',['Table of contents',['../index.html#main_table_of_contents',1,'']]],
+ ['of_20memory_1',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]],
+ ['once_2',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]],
+ ['optimal_20resource_20allocation_3',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
+ ['out_20of_20memory_4',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]],
+ ['overlap_5',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]]
];
diff --git a/docs/html/search/pages_d.js b/docs/html/search/pages_d.js
new file mode 100644
index 0000000..61cd771
--- /dev/null
+++ b/docs/html/search/pages_d.js
@@ -0,0 +1,9 @@
+var searchData=
+[
+ ['parameters_0',['Allocation parameters',['../virtual_allocator.html#virtual_allocator_allocation_parameters',1,'']]],
+ ['performance_1',['Allocation performance',['../optimal_allocation.html#optimal_allocation_allocation_Performance',1,'']]],
+ ['placed_20resources_2',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]],
+ ['pools_3',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]],
+ ['priority_4',['Residency priority',['../optimal_allocation.html#optimal_allocation_residency_priority',1,'']]],
+ ['project_20setup_20and_20initialization_5',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]]
+];
diff --git a/docs/html/search/pages_e.js b/docs/html/search/pages_e.js
new file mode 100644
index 0000000..c9afe7b
--- /dev/null
+++ b/docs/html/search/pages_e.js
@@ -0,0 +1,5 @@
+var searchData=
+[
+ ['questions_0',['Frequently asked questions',['../faq.html',1,'index']]],
+ ['quick_20start_1',['Quick start',['../quick_start.html',1,'index']]]
+];
diff --git a/docs/html/search/pages_f.js b/docs/html/search/pages_f.js
new file mode 100644
index 0000000..97e8dbf
--- /dev/null
+++ b/docs/html/search/pages_f.js
@@ -0,0 +1,12 @@
+var searchData=
+[
+ ['reference_20counting_0',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]],
+ ['residency_20priority_1',['Residency priority',['../optimal_allocation.html#optimal_allocation_residency_priority',1,'']]],
+ ['resource_20aliasing_20overlap_2',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
+ ['resource_20alignment_3',['Resource alignment',['../optimal_allocation.html#optimal_allocation_resource_alignment',1,'']]],
+ ['resource_20allocation_4',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
+ ['resource_20reference_20counting_5',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]],
+ ['resources_6',['resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'Committed versus placed resources'],['../quick_start.html#quick_start_creating_resources',1,'Creating resources']]],
+ ['ring_20buffer_7',['Ring buffer',['../linear_algorithm.html#linear_algorithm_ring_buffer',1,'']]],
+ ['running_20out_20of_20memory_8',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]]
+];
diff --git a/docs/html/search/search.css b/docs/html/search/search.css
index 19f76f9..956f31f 100644
--- a/docs/html/search/search.css
+++ b/docs/html/search/search.css
@@ -5,8 +5,8 @@
display: flex;
justify-content: center;
align-items: center;
- height: 36px;
- margin-right: 1em;
+ height: 43px;
+ margin-right: 0;
}
/*---------------- Search box styling */
@@ -27,43 +27,23 @@ dark-mode-toggle {
white-space : nowrap;
background: var(--search-background-color);
border-radius: 0.65em;
- box-shadow: var(--search-box-shadow);
+ border: 1px solid var(--search-box-border-color);
z-index: 102;
+ margin-right: 4px;
}
#MSearchBox .left {
display: inline-block;
vertical-align: middle;
- height: 1.4em;
-}
-
-#MSearchSelect {
- display: inline-block;
- vertical-align: middle;
- width: 20px;
- height: 19px;
- background-image: var(--search-magnification-select-image);
- margin: 0 0 0 0.3em;
- padding: 0;
+ height: 1.6em;
}
-#MSearchSelectExt {
- display: inline-block;
- vertical-align: middle;
- width: 10px;
- height: 19px;
- background-image: var(--search-magnification-image);
- margin: 0 0 0 0.5em;
- padding: 0;
-}
-
-
#MSearchField {
display: inline-block;
- vertical-align: middle;
+ vertical-align: top;
width: 7.5em;
- height: 19px;
- margin: 0 0.15em;
+ height: 22px;
+ margin: 0 0 0 0.15em;
padding: 0;
line-height: 1em;
border:none;
@@ -86,7 +66,7 @@ dark-mode-toggle {
display: inline-block;
vertical-align: middle;
width: 1.4em;
- height: 1.4em;
+ height: 1.6em;
}
#MSearchClose {
@@ -101,14 +81,100 @@ dark-mode-toggle {
}
#MSearchCloseImg {
- padding: 0.3em;
- margin: 0;
+ margin: 6px 0 0 4px;
+}
+
+.close-icon {
+ width: 11px;
+ height: 11px;
+ background-color: var(--search-close-icon-bg-color);
+ border-radius: 50%;
+ position: relative;
+ display: flex;
+ justify-content: center;
+ align-items: center;
+ box-sizing: content-box;
+}
+
+.close-icon:before,
+.close-icon:after {
+ content: '';
+ position: absolute;
+ width: 7px;
+ height: 1px;
+ background-color: var(--search-close-icon-fg-color);
+}
+
+.close-icon:before {
+ transform: rotate(45deg);
}
+.close-icon:after {
+ transform: rotate(-45deg);
+}
+
+
.MSearchBoxActive #MSearchField {
color: var(--search-active-color);
}
+.search-icon {
+ width: 20px;
+ height: 20px;
+ display: inline-block;
+ position: relative;
+ margin-left: 3px;
+}
+
+#MSearchSelectExt.search-icon {
+ width: 10px;
+}
+
+#MSearchSelectExt + input {
+ margin-left: 5px;
+}
+
+.search-icon::before, .search-icon::after {
+ content: '';
+ position: absolute;
+ border: 1.5px solid var(--search-foreground-color);
+ box-sizing: content-box;
+}
+
+.search-icon::before {
+ width: 6px;
+ height: 6px;
+ border-radius: 50%;
+ top: 7px;
+ left: 2px;
+ background: var(--search-background-color);
+}
+
+.search-icon::after {
+ border: 1px solid var(--search-foreground-color);
+ width: 0px;
+ height: 3px;
+ border-radius: 2px;
+ top: 15px;
+ left: 8px;
+ transform: rotate(-45deg);
+ transform-origin: top left;
+}
+
+.search-icon-dropdown {
+ content: '';
+ width: 0;
+ height: 0;
+ border-left: 3px solid transparent;
+ border-right: 3px solid transparent;
+ border-top: 3px solid var(--search-foreground-color);
+ top: 8px;
+ left: 15px;
+ transform: translateX(-50%);
+ position: absolute;
+}
+
+
/*---------------- Search filter selection */
@@ -119,15 +185,12 @@ dark-mode-toggle {
left: 0; top: 0;
border: 1px solid var(--search-filter-border-color);
background-color: var(--search-filter-background-color);
+ backdrop-filter: var(--search-filter-backdrop-filter);
+ -webkit-backdrop-filter: var(--search-filter-backdrop-filter);
z-index: 10001;
padding-top: 4px;
padding-bottom: 4px;
- -moz-border-radius: 4px;
- -webkit-border-top-left-radius: 4px;
- -webkit-border-top-right-radius: 4px;
- -webkit-border-bottom-left-radius: 4px;
- -webkit-border-bottom-right-radius: 4px;
- -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ border-radius: 4px;
}
.SelectItem {
@@ -176,18 +239,39 @@ iframe#MSearchResults {
height: 15em;
}
+@keyframes slideInSearchResults {
+ from {
+ opacity: 0;
+ transform: translate(0, 15px);
+ }
+
+ to {
+ opacity: 1;
+ transform: translate(0, 20px);
+ }
+}
+
#MSearchResultsWindow {
display: none;
position: absolute;
- left: 0; top: 0;
+ left: auto;
+ right: 4px;
+ top: 0;
border: 1px solid var(--search-results-border-color);
background-color: var(--search-results-background-color);
+ backdrop-filter: var(--search-results-backdrop-filter);
+ -webkit-backdrop-filter: var(--search-results-backdrop-filter);
z-index:10000;
width: 300px;
height: 400px;
overflow: auto;
+ border-radius: 8px;
+ transform: translate(0, 20px);
+ animation: ease-out 280ms slideInSearchResults;
+ box-shadow: 0 2px 8px 0 rgba(0,0,0,.075);
}
+
/* ----------------------------------- */
@@ -201,13 +285,13 @@ iframe#MSearchResults {
}
.SRPage .SREntry {
- font-size: 8pt;
- padding: 1px 5px;
+ font-size: 10pt;
+ padding: 2px 5px;
}
div.SRPage {
margin: 5px 2px;
- background-color: var(--search-results-background-color);
+ /*background-color: var(--search-results-background-color);*/
}
.SRChildren {
@@ -261,14 +345,17 @@ div.searchresults {
margin-right: 10px;
}
+#searchBoxPos1 dark-mode-toggle {
+ margin-top: 4px;
+}
+
/*---------------- External search page results */
.pages b {
- color: white;
+ color: var(--nav-foreground-color);
padding: 5px 5px 3px 5px;
- background-image: var(--nav-gradient-active-image-parent);
- background-repeat: repeat-x;
- text-shadow: 0 1px 1px #000000;
+ background-color: var(--nav-menu-active-bg);
+ border-radius: 4px;
}
.pages {
diff --git a/docs/html/search/search.js b/docs/html/search/search.js
index 666af01..dc14410 100644
--- a/docs/html/search/search.js
+++ b/docs/html/search/search.js
@@ -607,6 +607,12 @@ function createResults(resultsPath) {
elem.setAttribute('className',attr);
}
+ const decodeHtml = (html) => {
+ const txt = document.createElement("textarea");
+ txt.innerHTML = html;
+ return txt.value;
+ };
+
const results = document.getElementById("SRResults");
results.innerHTML = '';
searchData.forEach((elem,index) => {
@@ -620,10 +626,14 @@ function createResults(resultsPath) {
srLink.setAttribute('id','Item'+index);
setKeyActions(srLink,'return searchResults.Nav(event,'+index+')');
setClassAttr(srLink,'SRSymbol');
- srLink.innerHTML = elem[1][0];
+ srLink.innerHTML = decodeHtml(elem[1][0]);
srEntry.appendChild(srLink);
if (elem[1].length==2) { // single result
- srLink.setAttribute('href',resultsPath+elem[1][1][0]);
+ if (elem[1][1][0].startsWith('http://') || elem[1][1][0].startsWith('https://')) { // absolute path
+ srLink.setAttribute('href',elem[1][1][0]);
+ } else { // relative path
+ srLink.setAttribute('href',resultsPath+elem[1][1][0]);
+ }
srLink.setAttribute('onclick','searchBox.CloseResultsWindow()');
if (elem[1][1][1]) {
srLink.setAttribute('target','_parent');
@@ -632,7 +642,7 @@ function createResults(resultsPath) {
}
const srScope = document.createElement('span');
setClassAttr(srScope,'SRScope');
- srScope.innerHTML = elem[1][1][2];
+ srScope.innerHTML = decodeHtml(elem[1][1][2]);
srEntry.appendChild(srScope);
} else { // multiple results
srLink.setAttribute('href','javascript:searchResults.Toggle("SR_'+id+'")');
@@ -643,14 +653,18 @@ function createResults(resultsPath) {
srChild.setAttribute('id','Item'+index+'_c'+c);
setKeyActions(srChild,'return searchResults.NavChild(event,'+index+','+c+')');
setClassAttr(srChild,'SRScope');
- srChild.setAttribute('href',resultsPath+elem[1][c+1][0]);
+ if (elem[1][c+1][0].startsWith('http://') || elem[1][c+1][0].startsWith('https://')) { // absolute path
+ srChild.setAttribute('href',elem[1][c+1][0]);
+ } else { // relative path
+ srChild.setAttribute('href',resultsPath+elem[1][c+1][0]);
+ }
srChild.setAttribute('onclick','searchBox.CloseResultsWindow()');
if (elem[1][c+1][1]) {
srChild.setAttribute('target','_parent');
} else {
srChild.setAttribute('target','_blank');
}
- srChild.innerHTML = elem[1][c+1][2];
+ srChild.innerHTML = decodeHtml(elem[1][c+1][2]);
srChildren.appendChild(srChild);
}
srEntry.appendChild(srChildren);
diff --git a/docs/html/search/searchdata.js b/docs/html/search/searchdata.js
index 1b7813a..2029dc1 100644
--- a/docs/html/search/searchdata.js
+++ b/docs/html/search/searchdata.js
@@ -11,7 +11,7 @@ var indexSectionsWithContent =
8: "adpv",
9: "cd",
10: "d",
- 11: "acdfglmopqrsv"
+ 11: "abcdfghijlmnopqrstuvw"
};
var indexSectionNames =
diff --git a/docs/html/statistics.html b/docs/html/statistics.html
index f261c65..b9b1e29 100644
--- a/docs/html/statistics.html
+++ b/docs/html/statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Statistics
-
-
@@ -33,33 +31,22 @@
-
+
-
- Statistics
+ Statistics
This library contains several functions that return information about its internal state, especially the amount of memory allocated from D3D12.
-
+
Numeric statistics
If you need to obtain basic statistics about memory usage per memory segment group, together with current budget, you can call function D3D12MA::Allocator::GetBudget() and inspect structure D3D12MA::Budget. This is useful to keep track of memory usage and stay withing budget. Example:
D3D12MA::Budget localBudget;
@@ -112,8 +99,8 @@
UINT64 UsageBytesEstimated current memory usage of the program.Definition D3D12MemAlloc.h:486
You can query for more detailed statistics per heap type, memory segment group, and totals, including minimum and maximum allocation size and unused range size, by calling function D3D12MA::Allocator::CalculateStatistics() and inspecting structure D3D12MA::TotalStatistics. This function is slower though, as it has to traverse all the internal data structures, so it should be used only for debugging purposes.
You can query for statistics of a custom pool using function D3D12MA::Pool::GetStatistics() or D3D12MA::Pool::CalculateStatistics().
-You can query for information about a specific allocation using functions of the D3D12MA::Allocation class, e.g. GetSize(), GetOffset(), GetHeap().
-
+
You can query for information about a specific allocation using functions of the D3D12MA::Allocation class, e.g. GetSize(), GetOffset(), GetHeap().
+
JSON dump
You can dump internal state of the allocator to a string in JSON format using function D3D12MA::Allocator::BuildStatsString(). The result is guaranteed to be correct JSON. It uses Windows Unicode (UTF-16) encoding. Any strings provided by user (see D3D12MA::Allocation::SetName()) are copied as-is and properly escaped for JSON. It must be freed using function D3D12MA::Allocator::FreeStatsString().
The format of this JSON string is not part of official documentation of the library, but it will not change in backward-incompatible way without increasing library major version number and appropriate mention in changelog.
@@ -122,7 +109,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html
index 223cc58..f967c0c 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html
index bb90eaa..495fe3f 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::ALLOCATION_CALLBACKS Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
ALLOCATE_FUNC_PTR pAllocate Allocation function.
FREE_FUNC_PTR pFree Dellocation function.
void * pPrivateData Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
-Detailed Description
+Detailed Description
Custom callbacks to CPU memory allocation functions.
-Member Data Documentation
+Member Data Documentation
◆ pAllocate
@@ -159,7 +143,7 @@
-Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
+Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
@@ -169,7 +153,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 0dd1a39..f398da5 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -102,7 +89,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 5363747..d914ec6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,33 +90,28 @@
Inheritance diagram for D3D12MA::ALLOCATION_DESC:
-
-
-
+
Public Attributes
ALLOCATION_FLAGS Flags Flags for the allocation.
D3D12_HEAP_TYPE HeapType The type of memory heap where the new allocation should be placed.
D3D12_HEAP_FLAGS ExtraHeapFlags Additional heap flags to be used when allocating memory.
Pool * CustomPool Custom pool to place the new resource in. Optional.
void * pPrivateData Custom general-purpose pointer that will be stored in D3D12MA::Allocation.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.
-Member Data Documentation
+Member Data Documentation
◆ CustomPool
@@ -143,7 +125,7 @@
Custom pool to place the new resource in. Optional.
-When not null, the resource will be created inside specified custom pool. Members HeapType, ExtraHeapFlags are then ignored.
+When not null, the resource will be created inside specified custom pool. Members HeapType, ExtraHeapFlags are then ignored.
@@ -162,9 +144,9 @@ D3D12MA::Allocator::CreateResource(), you don't need to care. Necessary flag D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, or D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES is added automatically.
-- If you use D3D12MA::Allocator::AllocateMemory(), you should specify one of those
ALLOW_ONLY flags. Except when you validate that D3D12MA::Allocator::GetD3D12Options().ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1 - then you can leave it 0.
-- You can specify additional flags if needed. Then the memory will always be allocated as separate block using
D3D12Device::CreateCommittedResource or CreateHeap, not as part of an existing larget block.
+- If you use D3D12MA::Allocator::CreateResource(), you don't need to care. Necessary flag D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, or D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES is added automatically.
+- If you use D3D12MA::Allocator::AllocateMemory(), you should specify one of those ALLOW_ONLY flags. Except when you validate that D3D12MA::Allocator::GetD3D12Options().ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1 - then you can leave it 0.
+- You can specify additional flags if needed. Then the memory will always be allocated as separate block using D3D12Device::CreateCommittedResource or CreateHeap, not as part of an existing larget block.
When D3D12MA::ALLOCATION_DESC::CustomPool != NULL this member is ignored.
@@ -199,7 +181,7 @@
The type of memory heap where the new allocation should be placed.
-It must be one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK.
+It must be one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK.
When D3D12MA::ALLOCATION_DESC::CustomPool != NULL this member is ignored.
@@ -226,7 +208,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html
index ccc6e9d..cfc611c 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -102,7 +89,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html
index 8673896..33029a6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::ALLOCATOR_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
ALLOCATOR_FLAGS Flags Flags for the entire allocator.
ID3D12Device * pDevice UINT64 PreferredBlockSize Preferred size of a single ID3D12Heap block to be allocated.
Preferred size of a single ID3D12Heap block to be allocated.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
IDXGIAdapter * pAdapter
-Detailed Description
+Detailed Description
Parameters of created Allocator object. To be used with CreateAllocator().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -148,7 +130,7 @@
DXGI Adapter object that you use for D3D12 and this allocator.
-Allocator is doing AddRef/Release on this object.
+Allocator is doing AddRef/Release on this object.
@@ -181,7 +163,7 @@
Direct3D device object that the allocator should be attached to.
-Allocator is doing AddRef/Release on this object.
+Allocator is doing AddRef/Release on this object.
@@ -197,7 +179,7 @@
-Preferred size of a single ID3D12Heap block to be allocated.
+Preferred size of a single ID3D12Heap block to be allocated.
Set to 0 to use default, which is currently 64 MiB.
@@ -208,7 +190,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_budget-members.html b/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
index ddeda17..26e4bee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_budget.html b/docs/html/struct_d3_d12_m_a_1_1_budget.html
index 4798ab6..8e8f354 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_budget.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_budget.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Budget Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Statistics fetched from the library.
UINT64 UsageBytes Estimated current memory usage of the program.
UINT64 BudgetBytes Estimated amount of memory available to the program.
-Detailed Description
+Detailed Description
Statistics of current memory usage and available budget for a specific memory segment group.
These are fast to calculate. See function D3D12MA::Allocator::GetBudget().
-Member Data Documentation
+Member Data Documentation
◆ BudgetBytes
@@ -129,8 +113,8 @@
Estimated amount of memory available to the program.
-Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
-It might be different (most probably smaller) than memory capacity returned by D3D12MA::Allocator::GetMemoryCapacity() due to factors external to the program, decided by the operating system. Difference BudgetBytes - UsageBytes is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.
+Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
+It might be different (most probably smaller) than memory capacity returned by D3D12MA::Allocator::GetMemoryCapacity() due to factors external to the program, decided by the operating system. Difference BudgetBytes - UsageBytes is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.
@@ -163,8 +147,8 @@
Estimated current memory usage of the program.
-Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
-It might be different than BlockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipeline state objects, descriptor heaps, command lists, or heaps and resources allocated outside of this library, if any.
+Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
+It might be different than BlockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipeline state objects, descriptor heaps, command lists, or heaps and resources allocated outside of this library, if any.
@@ -174,7 +158,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 656581f..9423c7f 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 49c2950..cae7b08 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,49 +90,40 @@
Inheritance diagram for D3D12MA::CALLOCATION_DESC:
-
-
-
+
Public Member Functions
CALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CALLOCATION_DESC (const ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::ALLOCATION_DESC structure.
CALLOCATION_DESC (Pool *customPool, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of an allocation to be created in a specific custom pool.
CALLOCATION_DESC (D3D12_HEAP_TYPE heapType, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL, D3D12_HEAP_FLAGS extraHeapFlags=D3D12MA_RECOMMENDED_HEAP_FLAGS) noexcept Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::ALLOCATION_DESC Public Attributes inherited from D3D12MA::ALLOCATION_DESC ALLOCATION_FLAGS Flags Flags for the allocation.
D3D12_HEAP_TYPE HeapType The type of memory heap where the new allocation should be placed.
D3D12_HEAP_FLAGS ExtraHeapFlags Additional heap flags to be used when allocating memory.
Pool * CustomPool Custom pool to place the new resource in. Optional.
void * pPrivateData Custom general-purpose pointer that will be stored in D3D12MA::Allocation.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CALLOCATION_DESC() [1/4]
@@ -273,7 +251,7 @@
-Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
+Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
@@ -283,7 +261,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
index 1cb0dea..66262d0 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -110,7 +97,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
index fb6bf6f..37f7330 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CPOOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,61 +90,48 @@
Inheritance diagram for D3D12MA::CPOOL_DESC:
-
-
-
+
Public Member Functions
CPOOL_DESC ()=default Default constructor. Leaves the structure uninitialized.
CPOOL_DESC (const POOL_DESC &o) noexcept Constructor initializing from the base D3D12MA::POOL_DESC structure.
CPOOL_DESC (D3D12_HEAP_TYPE heapType, D3D12_HEAP_FLAGS heapFlags, POOL_FLAGS flags=D3D12MA_RECOMMENDED_POOL_FLAGS, UINT64 blockSize=0, UINT minBlockCount=0, UINT maxBlockCount=UINT_MAX, D3D12_RESIDENCY_PRIORITY residencyPriority=D3D12_RESIDENCY_PRIORITY_NORMAL) noexcept Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
CPOOL_DESC (const D3D12_HEAP_PROPERTIES heapProperties, D3D12_HEAP_FLAGS heapFlags, POOL_FLAGS flags=D3D12MA_RECOMMENDED_POOL_FLAGS, UINT64 blockSize=0, UINT minBlockCount=0, UINT maxBlockCount=UINT_MAX, D3D12_RESIDENCY_PRIORITY residencyPriority=D3D12_RESIDENCY_PRIORITY_NORMAL) noexcept Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::POOL_DESC Public Attributes inherited from D3D12MA::POOL_DESC POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CPOOL_DESC() [1/4]
@@ -264,7 +238,7 @@
-Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
+Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
@@ -320,7 +294,7 @@
-Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
+Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
@@ -330,7 +304,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 8eb5d11..da976da 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -104,7 +91,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index cb1fe74..714062b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,43 +90,36 @@
Inheritance diagram for D3D12MA::CVIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_ALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_ALLOCATION_DESC (const VIRTUAL_ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
CVIRTUAL_ALLOCATION_DESC (UINT64 size, UINT64 alignment, VIRTUAL_ALLOCATION_FLAGS flags=VIRTUAL_ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of a virtual allocation with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_ALLOCATION_DESC() [1/3]
@@ -241,7 +221,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index eeecc96..27af579 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index 78fbb71..e24e9a8 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,40 +90,34 @@
Inheritance diagram for D3D12MA::CVIRTUAL_BLOCK_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_BLOCK_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_BLOCK_DESC (const VIRTUAL_BLOCK_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_BLOCK_DESC structure.
CVIRTUAL_BLOCK_DESC (UINT64 size, VIRTUAL_BLOCK_FLAGS flags=VIRTUAL_BLOCK_FLAG_NONE, const ALLOCATION_CALLBACKS *allocationCallbacks=NULL) noexcept Constructor initializing description of a virtual block with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_BLOCK_DESC() [1/3]
@@ -233,7 +214,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
index 698ab11..69adefa 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
index c65cd1a..242a2ed 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_FLAGS Flags Flags.
UINT64 MaxBytesPerPass Maximum numbers of bytes that can be copied during single pass, while moving allocations to different places.
UINT32 MaxAllocationsPerPass Maximum number of allocations that can be moved during single pass to a different place.
-Detailed Description
+Detailed Description
Parameters for defragmentation.
To be used with functions Allocator::BeginDefragmentation() and Pool::BeginDefragmentation().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -172,7 +156,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
index 4fed39a..f20848d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
index 8a8bf70..87c182e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_MOVE Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_MOVE_OPERATION Operation Operation to be performed on the allocation by DefragmentationContext::EndPass(). Default value is DEFRAGMENTATION_MOVE_OPERATION_COPY. You can modify it.
Allocation * pSrcAllocation Allocation that should be moved.
Allocation * pDstTmpAllocation Temporary allocation pointing to destination memory that will replace pSrcAllocation.
Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Detailed Description
+Detailed Description
Single move of an allocation to be done for defragmentation.
-Member Data Documentation
+Member Data Documentation
◆ Operation
@@ -143,9 +127,9 @@
-Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
-- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make
pSrcAllocation point to this memory.
+Temporary allocation pointing to destination memory that will replace pSrcAllocation.
+Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
+- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make pSrcAllocation point to this memory.
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
index 28aefc6..3e0a1e4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -99,7 +86,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
index 1212826..6e37ac2 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,19 +87,17 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT32 MoveCount Number of elements in the pMoves array.
Number of elements in the pMoves array.
DEFRAGMENTATION_MOVE * pMoves Array of moves to be performed by the user in the current defragmentation pass.
-Detailed Description
+Detailed Description
Parameters for incremental defragmentation steps.
To be used with function DefragmentationContext::BeginPass().
-Member Data Documentation
+Member Data Documentation
◆ MoveCount
@@ -125,7 +110,7 @@
-Number of elements in the pMoves array.
+Number of elements in the pMoves array.
@@ -142,12 +127,12 @@
Array of moves to be performed by the user in the current defragmentation pass.
-Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
+Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
For each element, you should:
-- Create a new resource in the place pointed by
pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
-- Store new resource in
pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
-- Copy data from the
pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
+- Create a new resource in the place pointed by pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
+- Store new resource in pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
+- Copy data from the pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
- Make sure these commands finished executing on the GPU.
Only then you can finish defragmentation pass by calling DefragmentationContext::EndPass(). After this call, the allocation will point to the new place in memory.
@@ -162,7 +147,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
index 6723fa3..be2d910 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
index b7f806d..220d0bd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_STATS Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,24 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 BytesMoved Total number of bytes that have been copied while moving allocations to different places.
UINT64 BytesFreed Total number of bytes that have been released to the system by freeing empty heaps.
UINT32 AllocationsMoved Number of allocations that have been moved to different places.
UINT32 HeapsFreed Number of empty ID3D12Heap objects that have been released to the system.
Number of empty ID3D12Heap objects that have been released to the system.
-Detailed Description
+Detailed Description
Statistics returned for defragmentation process by function DefragmentationContext::GetStats().
-Member Data Documentation
+Member Data Documentation
◆ AllocationsMoved
@@ -178,7 +161,7 @@
-Number of empty ID3D12Heap objects that have been released to the system.
+Number of empty ID3D12Heap objects that have been released to the system.
@@ -188,7 +171,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
index 9167002..13c5446 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
index f4f534a..88fa33d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DetailedStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,35 +87,29 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Basic statistics.
UINT UnusedRangeCount Number of free ranges of memory between allocations.
UINT64 AllocationSizeMin Smallest allocation size. UINT64_MAX if there are 0 allocations.
Smallest allocation size. UINT64_MAX if there are 0 allocations.
UINT64 AllocationSizeMax Largest allocation size. 0 if there are 0 allocations.
UINT64 UnusedRangeSizeMin Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
UINT64 UnusedRangeSizeMax Largest empty range size. 0 if there are 0 empty ranges.
-Detailed Description
+Detailed Description
More detailed statistics than D3D12MA::Statistics.
These are slower to calculate. Use for debugging purposes. See functions: D3D12MA::Allocator::CalculateStatistics(), D3D12MA::Pool::CalculateStatistics().
Averages are not provided because they can be easily calculated as:
UINT64 AllocationSizeAvg = DetailedStats.Statistics.AllocationBytes / detailedStats.Statistics.AllocationCount;
UINT64 UnusedBytes = DetailedStats.Statistics.BlockBytes - DetailedStats.Statistics.AllocationBytes;
UINT64 UnusedRangeSizeAvg = UnusedBytes / DetailedStats.UnusedRangeCount;
- Member Data Documentation
+ Member Data Documentation
◆ AllocationSizeMax
@@ -157,7 +138,7 @@
-Smallest allocation size. UINT64_MAX if there are 0 allocations.
+Smallest allocation size. UINT64_MAX if there are 0 allocations.
@@ -221,7 +202,7 @@
-Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
+Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
@@ -231,7 +212,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
index 2ae0d33..654ade6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
index fcb0f64..d812aff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::POOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,45 +90,36 @@
Inheritance diagram for D3D12MA::POOL_DESC:
-
-
-
+
Public Attributes
POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool.
-Member Data Documentation
+Member Data Documentation
◆ BlockSize
@@ -189,7 +167,7 @@
Heap flags to be used when allocating heaps of this pool.
-It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
+It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
It is recommended to also add D3D12MA_RECOMMENDED_POOL_FLAGS. You can specify additional flags if needed.
@@ -207,7 +185,7 @@
The parameters of memory heap where allocations of this pool should be placed.
-In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
+In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
@@ -224,7 +202,7 @@
Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
-Set to 0 to use default, which is UINT64_MAX, which means no limit.
+Set to 0 to use default, which is UINT64_MAX, which means no limit.
Set to same value as D3D12MA::POOL_DESC::MinBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.
@@ -293,10 +271,10 @@
Residency priority to be set for all allocations made in this pool. Optional.
-Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
-Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
-This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
-There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
+Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
+Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
+This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
+There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
@@ -306,7 +284,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
index a970156..67b61fe 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
index b7e7c30..853c2ff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Statistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,21 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT BlockCount Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
UINT AllocationCount Number of D3D12MA::Allocation objects allocated.
UINT64 BlockBytes Number of bytes allocated in memory blocks.
UINT64 AllocationBytes Total number of bytes occupied by all D3D12MA::Allocation objects.
-Detailed Description
+Detailed Description
Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total.
These are fast to calculate. See functions: D3D12MA::Allocator::GetBudget(), D3D12MA::Pool::GetStatistics().
-Member Data Documentation
+Member Data Documentation
◆ AllocationBytes
@@ -132,7 +115,7 @@
Total number of bytes occupied by all D3D12MA::Allocation objects.
-Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
+Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
@@ -149,7 +132,7 @@
Number of D3D12MA::Allocation objects allocated.
-Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
+Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
@@ -181,7 +164,7 @@
-Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
+Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
-
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
D3D12_RESOURCE_DESC1. ID3D12Device8::CreatePlacedResource1.ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. Similar to Allocator::CreateAliasingResource1, but there are initial layout instead of state and castable formats list.
-It internally uses ID3D12Device10::CreatePlacedResource2.
To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
It internally uses ID3D12Device10::CreatePlacedResource2.
+To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
@@ -524,9 +492,9 @@
Allocates memory and creates a D3D12 resource (buffer or texture). This is the main allocation function.
-The function is similar to ID3D12Device::CreateCommittedResource, but it may really call ID3D12Device::CreatePlacedResource to assign part of a larger, existing memory heap to the new resource, which is the main purpose of this whole library.
-If ppvResource is null, you receive only ppAllocation object from this function. It holds pointer to ID3D12Resource that can be queried using function D3D12MA::Allocation::GetResource(). Reference count of the resource object is 1. It is automatically destroyed when you destroy the allocation object.
-If ppvResource is not null, you receive pointer to the resource next to allocation object. Reference count of the resource object is then increased by calling QueryInterface, so you need to manually Release it along with the allocation.
+The function is similar to ID3D12Device::CreateCommittedResource, but it may really call ID3D12Device::CreatePlacedResource to assign part of a larger, existing memory heap to the new resource, which is the main purpose of this whole library.
+If ppvResource is null, you receive only ppAllocation object from this function. It holds pointer to ID3D12Resource that can be queried using function D3D12MA::Allocation::GetResource(). Reference count of the resource object is 1. It is automatically destroyed when you destroy the allocation object.
+If ppvResource is not null, you receive pointer to the resource next to allocation object. Reference count of the resource object is then increased by calling QueryInterface, so you need to manually Release it along with the allocation.
- Parameters
-
@@ -587,9 +555,9 @@
-Similar to Allocator::CreateResource, but supports new structure D3D12_RESOURCE_DESC1.
-It internally uses ID3D12Device8::CreateCommittedResource2 or ID3D12Device8::CreatePlacedResource1.
-To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
+Similar to Allocator::CreateResource, but supports new structure D3D12_RESOURCE_DESC1.
+It internally uses ID3D12Device8::CreateCommittedResource2 or ID3D12Device8::CreatePlacedResource1.
+To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
@@ -648,8 +616,8 @@
Similar to Allocator::CreateResource2, but there are initial layout instead of state and castable formats list.
-It internally uses ID3D12Device10::CreateCommittedResource3 or ID3D12Device10::CreatePlacedResource2.
-To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
+It internally uses ID3D12Device10::CreateCommittedResource3 or ID3D12Device10::CreatePlacedResource2.
+To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
@@ -700,14 +668,14 @@ IsUMA() == FALSE (discrete graphics card):
-pLocalBudget returns the budget of the video memory.pNonLocalBudget returns the budget of the system memory available for D3D12 resources.- When IsUMA() == FALSE (discrete graphics card):
+- pLocalBudget returns the budget of the video memory.
+- pNonLocalBudget returns the budget of the system memory available for D3D12 resources.
-- When IsUMA()
== TRUE (integrated graphics chip):
-pLocalBudget returns the budget of the shared memory available for all D3D12 resources. All memory is considered "local".pNonLocalBudget is not applicable and returns zeros.- When IsUMA() == TRUE (integrated graphics chip):
+- pLocalBudget returns the budget of the shared memory available for all D3D12 resources. All memory is considered "local".
+- pNonLocalBudget is not applicable and returns zeros.
@@ -753,20 +721,20 @@ - Parameters
-
- memorySegmentGroup use DXGI_MEMORY_SEGMENT_GROUP_LOCAL or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL. memorySegmentGroup use DXGI_MEMORY_SEGMENT_GROUP_LOCAL or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL.
-This information is taken from DXGI_ADAPTER_DESC. It is not recommended to use this number. You should preferably call GetBudget() and limit memory usage to D3D12MA::Budget::BudgetBytes instead.
+This information is taken from DXGI_ADAPTER_DESC. It is not recommended to use this number. You should preferably call GetBudget() and limit memory usage to D3D12MA::Budget::BudgetBytes instead.
-- When IsUMA()
== FALSE (discrete graphics card):
-GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the video memory.GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) returns the size of the system memory available for D3D12 resources.- When IsUMA() == FALSE (discrete graphics card):
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the video memory.
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) returns the size of the system memory available for D3D12 resources.
-- When IsUMA()
== TRUE (integrated graphics chip):
-GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the shared memory available for all D3D12 resources. All memory is considered "local".GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) is not applicable and returns 0. - When IsUMA() == TRUE (integrated graphics chip):
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the shared memory available for all D3D12 resources. All memory is considered "local".
+- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) is not applicable and returns 0.
@@ -788,7 +756,7 @@
-Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMA was found to be true.
+Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMA was found to be true.
For more information about how to use it, see articles in Microsoft Docs articles:
- "UMA Optimizations: CPU Accessible Textures and Standard Swizzle"
@@ -814,8 +782,8 @@
Returns true if GPU Upload Heaps are supported on the current system.
-When true, you can use D3D12_HEAP_TYPE_GPU_UPLOAD.
-This flag is fetched from D3D12_FEATURE_D3D12_OPTIONS16::GPUUploadHeapSupported.
+When true, you can use D3D12_HEAP_TYPE_GPU_UPLOAD.
+This flag is fetched from D3D12_FEATURE_D3D12_OPTIONS16::GPUUploadHeapSupported.
@@ -834,7 +802,7 @@
-Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::UMA was found to be true.
+Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::UMA was found to be true.
For more information about how to use it, see articles in Microsoft Docs articles:
- "UMA Optimizations: CPU Accessible Textures and Standard Swizzle"
@@ -870,7 +838,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html
index 4049a20..6cfb1dd 100644
--- a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html
index 405cb9f..7ab0038 100644
--- a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html
+++ b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DefragmentationContext Class Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,22 +93,19 @@
-
+
Public Member Functions
HRESULT BeginPass (DEFRAGMENTATION_PASS_MOVE_INFO *pPassInfo) Starts single defragmentation pass.
HRESULT EndPass (DEFRAGMENTATION_PASS_MOVE_INFO *pPassInfo) Ends single defragmentation pass.
void GetStats (DEFRAGMENTATION_STATS *pStats) Returns statistics of the defragmentation performed so far.
-Detailed Description
+Detailed Description
Represents defragmentation process in progress.
You can create this object using Allocator::BeginDefragmentation (for default pools) or Pool::BeginDefragmentation (for a custom pool).
-Member Function Documentation
+Member Function Documentation
◆ BeginPass()
@@ -145,8 +129,8 @@ - Returns
-S_OK if no more moves are possible. Then you can omit call to DefragmentationContext::EndPass() and simply end whole defragmentation.S_FALSE if there are pending moves returned in pPassInfo. You need to perform them, call DefragmentationContext::EndPass(), and then preferably try another pass with DefragmentationContext::BeginPass(). - S_OK if no more moves are possible. Then you can omit call to DefragmentationContext::EndPass() and simply end whole defragmentation.
+- S_FALSE if there are pending moves returned in pPassInfo. You need to perform them, call DefragmentationContext::EndPass(), and then preferably try another pass with DefragmentationContext::BeginPass().
- Returns
- Returns
S_OK if no more moves are possible or S_FALSE if more defragmentations are possible.
-Ends incremental defragmentation pass and commits all defragmentation moves from pPassInfo. After this call:
+- Returns
- Returns S_OK if no more moves are possible or S_FALSE if more defragmentations are possible.
+Ends incremental defragmentation pass and commits all defragmentation moves from pPassInfo. After this call:
-- Allocation at
pPassInfo[i].pSrcAllocation that had pPassInfo[i].Operation == DEFRAGMENTATION_MOVE_OPERATION_COPY (which is the default) will be pointing to the new destination place.
-- Allocation at
pPassInfo[i].pSrcAllocation that had pPassInfo[i].operation == DEFRAGMENTATION_MOVE_OPERATION_DESTROY will be released.
+- Allocation at pPassInfo[i].pSrcAllocation that had pPassInfo[i].Operation == DEFRAGMENTATION_MOVE_OPERATION_COPY (which is the default) will be pointing to the new destination place.
+- Allocation at pPassInfo[i].pSrcAllocation that had pPassInfo[i].operation == DEFRAGMENTATION_MOVE_OPERATION_DESTROY will be released.
If no more moves are possible you can end whole defragmentation.
@@ -209,7 +193,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_pool-members.html b/docs/html/class_d3_d12_m_a_1_1_pool-members.html
index e500fb5..9acf601 100644
--- a/docs/html/class_d3_d12_m_a_1_1_pool-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_pool-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -104,7 +91,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_pool.html b/docs/html/class_d3_d12_m_a_1_1_pool.html
index 7aabe1c..07742d9 100644
--- a/docs/html/class_d3_d12_m_a_1_1_pool.html
+++ b/docs/html/class_d3_d12_m_a_1_1_pool.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Pool Class Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,32 +93,26 @@
-
+
Public Member Functions
POOL_DESC GetDesc () const Returns copy of parameters of the pool.
void GetStatistics (Statistics *pStats) Retrieves basic statistics of the custom pool that are fast to calculate.
void CalculateStatistics (DetailedStatistics *pStats) Retrieves detailed statistics of the custom pool that are slower to calculate.
void SetName (LPCWSTR Name) Associates a name with the pool. This name is for use in debug diagnostics and tools.
LPCWSTR GetName () const Returns the name associated with the pool object.
HRESULT BeginDefragmentation (const DEFRAGMENTATION_DESC *pDesc, DefragmentationContext **ppContext) Begins defragmentation process of the current pool.
-Detailed Description
+Detailed Description
Custom memory pool.
Represents a separate set of heaps (memory blocks) that can be used to create D3D12MA::Allocation-s and resources in it. Usually there is no need to create custom pools - creating resources in default pool is sufficient.
To create custom pool, fill D3D12MA::POOL_DESC and call D3D12MA::Allocator::CreatePool.
-Member Function Documentation
+Member Function Documentation
◆ BeginDefragmentation()
@@ -160,8 +141,8 @@ - Returns
-S_OK if defragmentation can begin.E_NOINTERFACE if defragmentation is not supported.- S_OK if defragmentation can begin.
+- E_NOINTERFACE if defragmentation is not supported.
For more information about defragmentation, see documentation chapter: Defragmentation.
@@ -276,7 +257,7 @@ Name can be NULL.
@@ -286,7 +267,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html b/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html
index 190326b..1e40ead 100644
--- a/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -109,7 +96,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_virtual_block.html b/docs/html/class_d3_d12_m_a_1_1_virtual_block.html
index 5f6a3f2..0cb9114 100644
--- a/docs/html/class_d3_d12_m_a_1_1_virtual_block.html
+++ b/docs/html/class_d3_d12_m_a_1_1_virtual_block.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualBlock Class Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,45 +93,35 @@
-
+
Public Member Functions
BOOL IsEmpty () const Returns true if the block is empty - contains 0 allocations.
void GetAllocationInfo (VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) const Returns information about an allocation - its offset, size and custom pointer.
HRESULT Allocate (const VIRTUAL_ALLOCATION_DESC *pDesc, VirtualAllocation *pAllocation, UINT64 *pOffset) Creates new allocation.
void FreeAllocation (VirtualAllocation allocation) Frees the allocation.
void Clear () Frees all the allocations.
void SetAllocationPrivateData (VirtualAllocation allocation, void *pPrivateData) Changes custom pointer for an allocation to a new value.
void GetStatistics (Statistics *pStats) const Retrieves basic statistics of the virtual block that are fast to calculate.
void CalculateStatistics (DetailedStatistics *pStats) const Retrieves detailed statistics of the virtual block that are slower to calculate.
void BuildStatsString (WCHAR **ppStatsString) const Builds and returns statistics as a string in JSON format, including the list of allocations with their parameters.
void FreeStatsString (WCHAR *pStatsString) const Frees memory of a string returned from VirtualBlock::BuildStatsString.
-Detailed Description
+Detailed Description
Represents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory.
This class allows to use the core algorithm of the library custom allocations e.g. CPU memory or sub-allocation regions inside a single GPU buffer.
-To create this object, fill in D3D12MA::VIRTUAL_BLOCK_DESC and call CreateVirtualBlock(). To destroy it, call its method VirtualBlock::Release(). You need to free all the allocations within this block or call Clear() before destroying it.
+To create this object, fill in D3D12MA::VIRTUAL_BLOCK_DESC and call CreateVirtualBlock(). To destroy it, call its method VirtualBlock::Release(). You need to free all the allocations within this block or call Clear() before destroying it.
This object is not thread-safe - should not be used from multiple threads simultaneously, must be synchronized externally.
-Member Function Documentation
+Member Function Documentation
◆ Allocate()
@@ -178,8 +155,8 @@ - Returns
S_OK if allocation succeeded, E_OUTOFMEMORY if it failed.If the allocation failed, pAllocation->AllocHandle is set to 0 and pOffset, if not null, is set to UINT64_MAX.
+- Returns
- S_OK if allocation succeeded, E_OUTOFMEMORY if it failed.
+If the allocation failed, pAllocation->AllocHandle is set to 0 and pOffset, if not null, is set to UINT64_MAX.
@@ -268,7 +245,7 @@
Frees the allocation.
-Calling this function with allocation.AllocHandle == 0 is correct and does nothing.
+Calling this function with allocation.AllocHandle == 0 is correct and does nothing.
@@ -387,7 +364,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/classes.html b/docs/html/classes.html
index 3b8ddf2..e85eb86 100644
--- a/docs/html/classes.html
+++ b/docs/html/classes.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Index
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/configuration.html b/docs/html/configuration.html
index 8eeaa50..65d7bdd 100644
--- a/docs/html/configuration.html
+++ b/docs/html/configuration.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Configuration
-
-
@@ -33,33 +31,22 @@
-
+
-
- Configuration
+ Configuration
-Please check file D3D12MemAlloc.cpp lines between "Configuration Begin" and "Configuration End" to find macros that you can define to change the behavior of the library, primarily for debugging purposes.
-
+Please check file D3D12MemAlloc.cpp lines between "Configuration Begin" and "Configuration End" to find macros that you can define to change the behavior of the library, primarily for debugging purposes.
+
Custom CPU memory allocator
-If you use custom allocator for CPU memory rather than default C++ operator new and delete or malloc and free functions, you can make this library using your allocator as well by filling structure D3D12MA::ALLOCATION_CALLBACKS and passing it as optional member D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks. Functions pointed there will be used by the library to make any CPU-side allocations. Example:
+If you use custom allocator for CPU memory rather than default C++ operator new and delete or malloc and free functions, you can make this library using your allocator as well by filling structure D3D12MA::ALLOCATION_CALLBACKS and passing it as optional member D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks. Functions pointed there will be used by the library to make any CPU-side allocations. Example:
#include <malloc.h>
void* CustomAllocate(size_t Size, size_t Alignment, void* pPrivateData)
@@ -133,11 +120,11 @@
ALLOCATOR_FLAGS FlagsFlags for the entire allocator.Definition D3D12MemAlloc.h:1126
-
+
Debug margins
-
By default, allocations are laid out in memory blocks next to each other if possible (considering required alignment returned by ID3D12Device::GetResourceAllocationInfo).
+By default, allocations are laid out in memory blocks next to each other if possible (considering required alignment returned by ID3D12Device::GetResourceAllocationInfo).
-Define macro D3D12MA_DEBUG_MARGIN to some non-zero value (e.g. 16) inside "D3D12MemAlloc.cpp" to enforce specified number of bytes as a margin after every allocation.
+Define macro D3D12MA_DEBUG_MARGIN to some non-zero value (e.g. 16) inside "D3D12MemAlloc.cpp" to enforce specified number of bytes as a margin after every allocation.
If your bug goes away after enabling margins, it means it may be caused by memory being overwritten outside of allocation boundaries. It is not 100% certain though. Change in application behavior may also be caused by different order and distribution of allocations across memory blocks after margins are applied.
Margins work with all memory heap types.
@@ -149,7 +136,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/custom_pools.html b/docs/html/custom_pools.html
index 9112b38..0bfd570 100644
--- a/docs/html/custom_pools.html
+++ b/docs/html/custom_pools.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Custom memory pools
-
-
@@ -33,33 +31,22 @@
-
+
-
- Custom memory pools
+ Custom memory pools
-A "pool" is a collection of memory blocks that share certain properties. Allocator creates 3 default pools: for D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK. A default pool automatically grows in size. Size of allocated blocks is also variable and managed automatically. Typical allocations are created in these pools. You can also create custom pools.
-
+A "pool" is a collection of memory blocks that share certain properties. Allocator creates 3 default pools: for D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK. A default pool automatically grows in size. Size of allocated blocks is also variable and managed automatically. Typical allocations are created in these pools. You can also create custom pools.
+
Usage
To create a custom pool, fill in structure D3D12MA::POOL_DESC and call function D3D12MA::Allocator::CreatePool to obtain object D3D12MA::Pool. Example:
All allocations must be released before releasing the pool. The pool must be released before relasing the allocator.
alloc->Release();
pool->Release();
-
+
Features and benefits
While it is recommended to use default pools whenever possible for simplicity and to give the allocator more opportunities for internal optimizations, custom pools may be useful in following cases:
- To keep some resources separate from others in memory.
- To keep track of memory usage of just a specific group of resources. Statistics can be queried using D3D12MA::Pool::CalculateStatistics.
-- To use specific size of a memory block (
ID3D12Heap). To set it, use member D3D12MA::POOL_DESC::BlockSize. When set to 0, the library uses automatically determined, variable block sizes.
+- To use specific size of a memory block (ID3D12Heap). To set it, use member D3D12MA::POOL_DESC::BlockSize. When set to 0, the library uses automatically determined, variable block sizes.
- To reserve some minimum amount of memory allocated. To use it, set member D3D12MA::POOL_DESC::MinBlockCount.
- To limit maximum amount of memory allocated. To use it, set member D3D12MA::POOL_DESC::MaxBlockCount.
-- To use extended parameters of the D3D12 memory allocation. While resources created from default pools can only specify
D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK, a custom pool may use non-standard D3D12_HEAP_PROPERTIES (member D3D12MA::POOL_DESC::HeapProperties) and D3D12_HEAP_FLAGS (D3D12MA::POOL_DESC::HeapFlags), which is useful e.g. for cross-adapter sharing or UMA (see also D3D12MA::Allocator::IsUMA).
+- To use extended parameters of the D3D12 memory allocation. While resources created from default pools can only specify D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK, a custom pool may use non-standard D3D12_HEAP_PROPERTIES (member D3D12MA::POOL_DESC::HeapProperties) and D3D12_HEAP_FLAGS (D3D12MA::POOL_DESC::HeapFlags), which is useful e.g. for cross-adapter sharing or UMA (see also D3D12MA::Allocator::IsUMA).
New versions of this library support creating committed allocations in custom pools. It is supported only when D3D12MA::POOL_DESC::BlockSize = 0. To use this feature, set D3D12MA::ALLOCATION_DESC::CustomPool to the pointer to your custom pool and D3D12MA::ALLOCATION_DESC::Flags to D3D12MA::ALLOCATION_FLAG_COMMITTED. Example:
ALLOCATION_DESC allocDesc = {};
@@ -136,12 +123,12 @@
ID3D12Resource* res;
hr = allocator->CreateResource(&allocDesc, &resDesc,
D3D12_RESOURCE_STATE_GENERIC_READ, NULL, &alloc, IID_PPV_ARGS(&res));
-
This feature may seem unnecessary, but creating committed allocations from custom pools may be useful in some cases, e.g. to have separate memory usage statistics for some group of resources or to use extended allocation parameters, like custom D3D12_HEAP_PROPERTIES, which are available only in custom pools.
+This feature may seem unnecessary, but creating committed allocations from custom pools may be useful in some cases, e.g. to have separate memory usage statistics for some group of resources or to use extended allocation parameters, like custom D3D12_HEAP_PROPERTIES, which are available only in custom pools.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/defragmentation.html b/docs/html/defragmentation.html
index d68a400..b82dbde 100644
--- a/docs/html/defragmentation.html
+++ b/docs/html/defragmentation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Defragmentation
-
-
@@ -33,33 +31,22 @@
-
+
-
- Defragmentation
+ Defragmentation
Interleaved allocations and deallocations of many objects of varying size can cause fragmentation over time, which can lead to a situation where the library is unable to find a continuous range of free memory for a new allocation despite there is enough free space, just scattered across many small free ranges between existing allocations.
-To mitigate this problem, you can use defragmentation feature. It doesn't happen automatically though and needs your cooperation, because D3D12MA is a low level library that only allocates memory. It cannot recreate buffers and textures in a new place as it doesn't remember the contents of D3D12_RESOURCE_DESC structure. It cannot copy their contents as it doesn't record any commands to a command list.
+To mitigate this problem, you can use defragmentation feature. It doesn't happen automatically though and needs your cooperation, because D3D12MA is a low level library that only allocates memory. It cannot recreate buffers and textures in a new place as it doesn't remember the contents of D3D12_RESOURCE_DESC structure. It cannot copy their contents as it doesn't record any commands to a command list.
Example:
D3D12MA::DEFRAGMENTATION_DESC defragDesc = {};
defragDesc.Flags = D3D12MA::DEFRAGMENTATION_FLAG_ALGORITHM_FAST;
@@ -162,11 +149,11 @@
Parameters for incremental defragmentation steps.Definition D3D12MemAlloc.h:768
DEFRAGMENTATION_MOVE * pMovesArray of moves to be performed by the user in the current defragmentation pass.Definition D3D12MemAlloc.h:792
UINT32 MoveCountNumber of elements in the pMoves array.Definition D3D12MemAlloc.h:770
-Although functions like D3D12MA::Allocator::CreateResource() create an allocation and a buffer/texture at once, these are just a shortcut for allocating memory and creating a placed resource. Defragmentation works on memory allocations only. You must handle the rest manually. Defragmentation is an iterative process that should repreat "passes" as long as related functions return S_FALSE not S_OK. In each pass:
+Although functions like D3D12MA::Allocator::CreateResource() create an allocation and a buffer/texture at once, these are just a shortcut for allocating memory and creating a placed resource. Defragmentation works on memory allocations only. You must handle the rest manually. Defragmentation is an iterative process that should repreat "passes" as long as related functions return S_FALSE not S_OK. In each pass:
- D3D12MA::DefragmentationContext::BeginPass() function call:
- Calculates and returns the list of allocations to be moved in this pass. Note this can be a time-consuming process.
-- Reserves destination memory for them by creating temporary destination allocations that you can query for their
ID3D12Heap + offset using methods like D3D12MA::Allocation::GetHeap().
+- Reserves destination memory for them by creating temporary destination allocations that you can query for their ID3D12Heap + offset using methods like D3D12MA::Allocation::GetHeap().
- Inside the pass, you should:
@@ -179,40 +166,40 @@
- D3D12MA::DefragmentationContext::EndPass() function call:
- Frees the source memory reserved for the allocations that are moved.
- Modifies source D3D12MA::Allocation objects that are moved to point to the destination reserved memory and destination resource, while source resource is released.
-- Frees
ID3D12Heap blocks that became empty.
+- Frees ID3D12Heap blocks that became empty.
-Defragmentation algorithm tries to move all suitable allocations. You can, however, refuse to move some of them inside a defragmentation pass, by setting pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This is not recommended and may result in suboptimal packing of the allocations after defragmentation. If you cannot ensure any allocation can be moved, it is better to keep movable allocations separate in a custom pool.
+Defragmentation algorithm tries to move all suitable allocations. You can, however, refuse to move some of them inside a defragmentation pass, by setting pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This is not recommended and may result in suboptimal packing of the allocations after defragmentation. If you cannot ensure any allocation can be moved, it is better to keep movable allocations separate in a custom pool.
Inside a pass, for each allocation that should be moved:
-- You should copy its data from the source to the destination place by calling e.g.
CopyResource().
+- You should copy its data from the source to the destination place by calling e.g. CopyResource().
- You need to make sure these commands finished executing before the source buffers/textures are released by D3D12MA::DefragmentationContext::EndPass().
- If a resource doesn't contain any meaningful data, e.g. it is a transient render-target texture to be cleared, filled, and used temporarily in each rendering frame, you can just recreate this texture without copying its data.
-- If the resource is in
D3D12_HEAP_TYPE_READBACK memory, you can copy its data on the CPU using memcpy().
-- If you cannot move the allocation, you can set
pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This will cancel the move.
+- If the resource is in D3D12_HEAP_TYPE_READBACK memory, you can copy its data on the CPU using memcpy().
+- If you cannot move the allocation, you can set pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This will cancel the move.
- D3D12MA::DefragmentationContext::EndPass() will then free the destination memory not the source memory of the allocation, leaving it unchanged.
-- If you decide the allocation is unimportant and can be destroyed instead of moved (e.g. it wasn't used for long time), you can set
pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY.
+- If you decide the allocation is unimportant and can be destroyed instead of moved (e.g. it wasn't used for long time), you can set pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY.
- D3D12MA::DefragmentationContext::EndPass() will then free both source and destination memory, and will destroy the source D3D12MA::Allocation object.
You can defragment a specific custom pool by calling D3D12MA::Pool::BeginDefragmentation or all the default pools by calling D3D12MA::Allocator::BeginDefragmentation (like in the example above).
-Defragmentation is always performed in each pool separately. Allocations are never moved between different heap types. The size of the destination memory reserved for a moved allocation is the same as the original one. Alignment of an allocation as it was determined using GetResourceAllocationInfo() is also respected after defragmentation. Buffers/textures should be recreated with the same D3D12_RESOURCE_DESC parameters as the original ones.
+Defragmentation is always performed in each pool separately. Allocations are never moved between different heap types. The size of the destination memory reserved for a moved allocation is the same as the original one. Alignment of an allocation as it was determined using GetResourceAllocationInfo() is also respected after defragmentation. Buffers/textures should be recreated with the same D3D12_RESOURCE_DESC parameters as the original ones.
You can perform the defragmentation incrementally to limit the number of allocations and bytes to be moved in each pass, e.g. to call it in sync with render frames and not to experience too big hitches. See members: D3D12MA::DEFRAGMENTATION_DESC::MaxBytesPerPass, D3D12MA::DEFRAGMENTATION_DESC::MaxAllocationsPerPass.
Thread safety: It is safe to perform the defragmentation asynchronously to render frames and other Direct3D 12 and D3D12MA usage, possibly from multiple threads, with the exception that allocations returned in D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO::pMoves shouldn't be released until the defragmentation pass is ended. During the call to D3D12MA::DefragmentationContext::BeginPass(), any operations on the memory pool affected by the defragmentation are blocked by a mutex.
-What it means in practice is that you shouldn't free any allocations from the defragmented pool since the moment a call to BeginPass begins. Otherwise, a thread performing the allocation->Release() would block for the time BeginPass executes and then free the allocation when it finishes, while the allocation could have ended up on the list of allocations to move. A solution to freeing allocations during defragmentation is to find such allocation on the list pass.pMoves[i] and set its operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY instead of calling allocation->Release(), or simply deferring the release to the time after defragmentation finished.
+What it means in practice is that you shouldn't free any allocations from the defragmented pool since the moment a call to BeginPass begins. Otherwise, a thread performing the allocation->Release() would block for the time BeginPass executes and then free the allocation when it finishes, while the allocation could have ended up on the list of allocations to move. A solution to freeing allocations during defragmentation is to find such allocation on the list pass.pMoves[i] and set its operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY instead of calling allocation->Release(), or simply deferring the release to the time after defragmentation finished.
Mapping is out of scope of this library and so it is not preserved after an allocation is moved during defragmentation. You need to map the new resource yourself if needed.
- Note
- Defragmentation is not supported in custom pools created with D3D12MA::POOL_FLAG_ALGORITHM_LINEAR.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html b/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
index fa88354..6e6d46e 100644
--- a/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
+++ b/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: C:/Code/D3D12MemoryAllocator/REPO/include Directory Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -92,15 +79,14 @@
-
+
Files
D3D12MemAlloc.h D3D12MemAlloc.h
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/doxygen.css b/docs/html/doxygen.css
index 4947e24..5d2eecd 100644
--- a/docs/html/doxygen.css
+++ b/docs/html/doxygen.css
@@ -1,11 +1,12 @@
-/* The standard CSS for doxygen 1.13.2*/
+/* The standard CSS for doxygen 1.14.0*/
html {
/* page base colors */
--page-background-color: white;
--page-foreground-color: black;
--page-link-color: #3D578C;
---page-visited-link-color: #4665A2;
+--page-visited-link-color: #3D578C;
+--page-external-link-color: #334975;
/* index */
--index-odd-item-bg-color: #F8F9FC;
@@ -16,46 +17,50 @@ html {
/* header */
--header-background-color: #F9FAFC;
--header-separator-color: #C4CFE5;
---header-gradient-image: url('nav_h.png');
---group-header-separator-color: #879ECB;
+--group-header-separator-color: #D9E0EE;
--group-header-color: #354C7B;
--inherit-header-color: gray;
--footer-foreground-color: #2A3D61;
---footer-logo-width: 104px;
+--footer-logo-width: 75px;
--citation-label-color: #334975;
--glow-color: cyan;
--title-background-color: white;
---title-separator-color: #5373B4;
+--title-separator-color: #C4CFE5;
--directory-separator-color: #9CAFD4;
--separator-color: #4A6AAA;
--blockquote-background-color: #F7F8FB;
--blockquote-border-color: #9CAFD4;
---scrollbar-thumb-color: #9CAFD4;
+--scrollbar-thumb-color: #C4CFE5;
--scrollbar-background-color: #F9FAFC;
--icon-background-color: #728DC1;
--icon-foreground-color: white;
+/*
--icon-doc-image: url('doc.svg');
--icon-folder-open-image: url('folderopen.svg');
---icon-folder-closed-image: url('folderclosed.svg');
+--icon-folder-closed-image: url('folderclosed.svg');*/
+--icon-folder-open-fill-color: #C4CFE5;
+--icon-folder-fill-color: #D8DFEE;
+--icon-folder-border-color: #4665A2;
+--icon-doc-fill-color: #D8DFEE;
+--icon-doc-border-color: #4665A2;
/* brief member declaration list */
--memdecl-background-color: #F9FAFC;
--memdecl-separator-color: #DEE4F0;
--memdecl-foreground-color: #555;
--memdecl-template-color: #4665A2;
+--memdecl-border-color: #D5DDEC;
/* detailed member list */
--memdef-border-color: #A8B8D9;
--memdef-title-background-color: #E2E8F2;
---memdef-title-gradient-image: url('nav_f.png');
---memdef-proto-background-color: #DFE5F1;
+--memdef-proto-background-color: #EEF1F7;
--memdef-proto-text-color: #253555;
---memdef-proto-text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
--memdef-doc-background-color: white;
--memdef-param-name-color: #602020;
--memdef-template-color: #4665A2;
@@ -74,29 +79,34 @@ html {
/** navigation bar/tree/menu */
--nav-background-color: #F9FAFC;
--nav-foreground-color: #364D7C;
---nav-gradient-image: url('tab_b.png');
---nav-gradient-hover-image: url('tab_h.png');
---nav-gradient-active-image: url('tab_a.png');
---nav-gradient-active-image-parent: url("../tab_a.png");
---nav-separator-image: url('tab_s.png');
---nav-breadcrumb-image: url('bc_s.png');
---nav-breadcrumb-border-color: #C2CDE4;
---nav-splitbar-image: url('splitbar.png');
+--nav-border-color: #C4CFE5;
+--nav-breadcrumb-separator-color: #C4CFE5;
+--nav-breadcrumb-active-bg: #EEF1F7;
+--nav-breadcrumb-color: #354C7B;
+--nav-breadcrumb-border-color: #E1E7F2;
+--nav-splitbar-bg-color: #DCE2EF;
+--nav-splitbar-handle-color: #9CAFD4;
--nav-font-size-level1: 13px;
--nav-font-size-level2: 10px;
--nav-font-size-level3: 9px;
--nav-text-normal-color: #283A5D;
--nav-text-hover-color: white;
--nav-text-active-color: white;
---nav-text-normal-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
---nav-text-hover-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
---nav-text-active-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
--nav-menu-button-color: #364D7C;
--nav-menu-background-color: white;
--nav-menu-foreground-color: #555555;
+--nav-menu-active-bg: #DCE2EF;
+--nav-menu-active-color: #9CAFD4;
--nav-menu-toggle-color: rgba(255, 255, 255, 0.5);
---nav-arrow-color: #9CAFD4;
---nav-arrow-selected-color: #9CAFD4;
+--nav-arrow-color: #B6C4DF;
+--nav-arrow-selected-color: #90A5CE;
+
+/* sync icon */
+--sync-icon-border-color: #C4CFE5;
+--sync-icon-background-color: #F9FAFC;
+--sync-icon-selected-background-color: #EEF1F7;
+--sync-icon-color: #C4CFE5;
+--sync-icon-selected-color: #6884BD;
/* table of contents */
--toc-background-color: #F4F6FA;
@@ -107,18 +117,20 @@ html {
/** search field */
--search-background-color: white;
--search-foreground-color: #909090;
---search-magnification-image: url('mag.svg');
---search-magnification-select-image: url('mag_sel.svg');
--search-active-color: black;
---search-filter-background-color: #F9FAFC;
+--search-filter-background-color: rgba(255,255,255,.7);
+--search-filter-backdrop-filter: blur(4px);
--search-filter-foreground-color: black;
---search-filter-border-color: #90A5CE;
+--search-filter-border-color: rgba(150,150,150,.4);
--search-filter-highlight-text-color: white;
--search-filter-highlight-bg-color: #3D578C;
--search-results-foreground-color: #425E97;
---search-results-background-color: #EEF1F7;
---search-results-border-color: black;
---search-box-shadow: inset 0.5px 0.5px 3px 0px #555;
+--search-results-background-color: rgba(255,255,255,.8);
+--search-results-backdrop-filter: blur(4px);
+--search-results-border-color: rgba(150,150,150,.4);
+--search-box-border-color: #B6C4DF;
+--search-close-icon-bg-color: #A0A0A0;
+--search-close-icon-fg-color: white;
/** code fragments */
--code-keyword-color: #008000;
@@ -147,23 +159,21 @@ html {
--fragment-lineno-link-hover-bg-color: #C8C8C8;
--fragment-copy-ok-color: #2EC82E;
--tooltip-foreground-color: black;
---tooltip-background-color: white;
---tooltip-border-color: gray;
+--tooltip-background-color: rgba(255,255,255,0.8);
+--tooltip-arrow-background-color: white;
+--tooltip-border-color: rgba(150,150,150,0.7);
+--tooltip-backdrop-filter: blur(3px);
--tooltip-doc-color: grey;
--tooltip-declaration-color: #006318;
--tooltip-link-color: #4665A2;
---tooltip-shadow: 1px 1px 7px gray;
+--tooltip-shadow: 0 4px 8px 0 rgba(0,0,0,.25);
--fold-line-color: #808080;
---fold-minus-image: url('minus.svg');
---fold-plus-image: url('plus.svg');
---fold-minus-image-relpath: url('../../minus.svg');
---fold-plus-image-relpath: url('../../plus.svg');
/** font-family */
---font-family-normal: Roboto,sans-serif;
+--font-family-normal: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-monospace: 'JetBrains Mono',Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace,fixed;
--font-family-nav: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
---font-family-title: Tahoma,Arial,sans-serif;
+--font-family-title: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-toc: Verdana,'DejaVu Sans',Geneva,sans-serif;
--font-family-search: Arial,Verdana,sans-serif;
--font-family-icon: Arial,Helvetica;
@@ -201,7 +211,8 @@ html {
--page-background-color: black;
--page-foreground-color: #C9D1D9;
--page-link-color: #90A5CE;
---page-visited-link-color: #A3B4D7;
+--page-visited-link-color: #90A5CE;
+--page-external-link-color: #A3B4D7;
/* index */
--index-odd-item-bg-color: #0B101A;
@@ -212,8 +223,7 @@ html {
/* header */
--header-background-color: #070B11;
--header-separator-color: #141C2E;
---header-gradient-image: url('nav_hd.png');
---group-header-separator-color: #283A5D;
+--group-header-separator-color: #1D2A43;
--group-header-color: #90A5CE;
--inherit-header-color: #A0A0A0;
@@ -223,35 +233,36 @@ html {
--glow-color: cyan;
--title-background-color: #090D16;
---title-separator-color: #354C79;
+--title-separator-color: #212F4B;
--directory-separator-color: #283A5D;
--separator-color: #283A5D;
--blockquote-background-color: #101826;
--blockquote-border-color: #283A5D;
---scrollbar-thumb-color: #283A5D;
+--scrollbar-thumb-color: #2C3F65;
--scrollbar-background-color: #070B11;
--icon-background-color: #334975;
--icon-foreground-color: #C4CFE5;
---icon-doc-image: url('docd.svg');
---icon-folder-open-image: url('folderopend.svg');
---icon-folder-closed-image: url('folderclosedd.svg');
+--icon-folder-open-fill-color: #4665A2;
+--icon-folder-fill-color: #5373B4;
+--icon-folder-border-color: #C4CFE5;
+--icon-doc-fill-color: #6884BD;
+--icon-doc-border-color: #C4CFE5;
/* brief member declaration list */
--memdecl-background-color: #0B101A;
--memdecl-separator-color: #2C3F65;
--memdecl-foreground-color: #BBB;
--memdecl-template-color: #7C95C6;
+--memdecl-border-color: #233250;
/* detailed member list */
--memdef-border-color: #233250;
--memdef-title-background-color: #1B2840;
---memdef-title-gradient-image: url('nav_fd.png');
--memdef-proto-background-color: #19243A;
--memdef-proto-text-color: #9DB0D4;
---memdef-proto-text-shadow: 0px 1px 1px rgba(0, 0, 0, 0.9);
--memdef-doc-background-color: black;
--memdef-param-name-color: #D28757;
--memdef-template-color: #7C95C6;
@@ -270,29 +281,34 @@ html {
/** navigation bar/tree/menu */
--nav-background-color: #101826;
--nav-foreground-color: #364D7C;
---nav-gradient-image: url('tab_bd.png');
---nav-gradient-hover-image: url('tab_hd.png');
---nav-gradient-active-image: url('tab_ad.png');
---nav-gradient-active-image-parent: url("../tab_ad.png");
---nav-separator-image: url('tab_sd.png');
---nav-breadcrumb-image: url('bc_sd.png');
+--nav-border-color: #212F4B;
+--nav-breadcrumb-separator-color: #212F4B;
+--nav-breadcrumb-active-bg: #1D2A43;
+--nav-breadcrumb-color: #90A5CE;
--nav-breadcrumb-border-color: #2A3D61;
---nav-splitbar-image: url('splitbard.png');
+--nav-splitbar-bg-color: #283A5D;
+--nav-splitbar-handle-color: #4665A2;
--nav-font-size-level1: 13px;
--nav-font-size-level2: 10px;
--nav-font-size-level3: 9px;
--nav-text-normal-color: #B6C4DF;
--nav-text-hover-color: #DCE2EF;
--nav-text-active-color: #DCE2EF;
---nav-text-normal-shadow: 0px 1px 1px black;
---nav-text-hover-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
---nav-text-active-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
--nav-menu-button-color: #B6C4DF;
--nav-menu-background-color: #05070C;
--nav-menu-foreground-color: #BBBBBB;
+--nav-menu-active-bg: #1D2A43;
+--nav-menu-active-color: #C9D3E7;
--nav-menu-toggle-color: rgba(255, 255, 255, 0.2);
---nav-arrow-color: #334975;
---nav-arrow-selected-color: #90A5CE;
+--nav-arrow-color: #4665A2;
+--nav-arrow-selected-color: #6884BD;
+
+/* sync icon */
+--sync-icon-border-color: #212F4B;
+--sync-icon-background-color: #101826;
+--sync-icon-selected-background-color: #1D2A43;
+--sync-icon-color: #4665A2;
+--sync-icon-selected-color: #5373B4;
/* table of contents */
--toc-background-color: #151E30;
@@ -303,18 +319,20 @@ html {
/** search field */
--search-background-color: black;
--search-foreground-color: #C5C5C5;
---search-magnification-image: url('mag_d.svg');
---search-magnification-select-image: url('mag_seld.svg');
---search-active-color: #C5C5C5;
+--search-active-color: #F5F5F5;
--search-filter-background-color: #101826;
--search-filter-foreground-color: #90A5CE;
+--search-filter-backdrop-filter: none;
--search-filter-border-color: #7C95C6;
--search-filter-highlight-text-color: #BCC9E2;
--search-filter-highlight-bg-color: #283A5D;
---search-results-background-color: #101826;
+--search-results-background-color: black;
--search-results-foreground-color: #90A5CE;
---search-results-border-color: #7C95C6;
---search-box-shadow: inset 0.5px 0.5px 3px 0px #2F436C;
+--search-results-backdrop-filter: none;
+--search-results-border-color: #334975;
+--search-box-border-color: #334975;
+--search-close-icon-bg-color: #909090;
+--search-close-icon-fg-color: black;
/** code fragments */
--code-keyword-color: #CC99CD;
@@ -344,22 +362,20 @@ html {
--fragment-copy-ok-color: #0EA80E;
--tooltip-foreground-color: #C9D1D9;
--tooltip-background-color: #202020;
+--tooltip-arrow-background-color: #202020;
+--tooltip-backdrop-filter: none;
--tooltip-border-color: #C9D1D9;
--tooltip-doc-color: #D9E1E9;
--tooltip-declaration-color: #20C348;
--tooltip-link-color: #79C0FF;
--tooltip-shadow: none;
--fold-line-color: #808080;
---fold-minus-image: url('minusd.svg');
---fold-plus-image: url('plusd.svg');
---fold-minus-image-relpath: url('../../minusd.svg');
---fold-plus-image-relpath: url('../../plusd.svg');
/** font-family */
---font-family-normal: Roboto,sans-serif;
+--font-family-normal: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-monospace: 'JetBrains Mono',Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace,fixed;
--font-family-nav: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
---font-family-title: Tahoma,Arial,sans-serif;
+--font-family-title: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-toc: Verdana,'DejaVu Sans',Geneva,sans-serif;
--font-family-search: Arial,Verdana,sans-serif;
--font-family-icon: Arial,Helvetica;
@@ -389,8 +405,8 @@ html {
--invariant-color-text: #cceed5;
}}
body {
- background-color: var(--page-background-color);
- color: var(--page-foreground-color);
+ background-color: var(--page-background-color);
+ color: var(--page-foreground-color);
}
body, table, div, p, dl {
@@ -400,13 +416,22 @@ body, table, div, p, dl {
line-height: 22px;
}
+body.resizing {
+ user-select: none;
+ -webkit-user-select: none;
+}
+
+#doc-content {
+ scrollbar-width: thin;
+}
+
/* @group Heading Levels */
.title {
font-family: var(--font-family-normal);
line-height: 28px;
- font-size: 150%;
- font-weight: bold;
+ font-size: 160%;
+ font-weight: 400;
margin: 10px 2px;
}
@@ -415,7 +440,10 @@ h1.groupheader {
}
h2.groupheader {
- border-bottom: 1px solid var(--group-header-separator-color);
+ box-shadow: 12px 0 var(--page-background-color),
+ -12px 0 var(--page-background-color),
+ 12px 1px var(--group-header-separator-color),
+ -12px 1px var(--group-header-separator-color);
color: var(--group-header-color);
font-size: 150%;
font-weight: normal;
@@ -425,6 +453,13 @@ h2.groupheader {
width: 100%;
}
+td h2.groupheader {
+ box-shadow: 13px 0 var(--page-background-color),
+ -13px 0 var(--page-background-color),
+ 13px 1px var(--group-header-separator-color),
+ -13px 1px var(--group-header-separator-color);
+}
+
h3.groupheader {
font-size: 100%;
}
@@ -451,8 +486,8 @@ p.startli, p.startdd {
}
th p.starttd, th p.intertd, th p.endtd {
- font-size: 100%;
- font-weight: 700;
+ font-size: 100%;
+ font-weight: 700;
}
p.starttd {
@@ -497,9 +532,11 @@ h3.version {
}
div.navtab {
- padding-right: 15px;
+ margin-right: 6px;
+ padding-right: 6px;
text-align: right;
line-height: 110%;
+ background-color: var(--nav-background-color);
}
div.navtab table {
@@ -512,19 +549,10 @@ td.navtab {
}
td.navtabHL {
- background-image: var(--nav-gradient-active-image);
- background-repeat:repeat-x;
padding-right: 6px;
padding-left: 6px;
-}
-
-td.navtabHL a, td.navtabHL a:visited {
- color: var(--nav-text-hover-color);
- text-shadow: var(--nav-text-hover-shadow);
-}
-
-a.navtab {
- font-weight: bold;
+ border-radius: 0 6px 6px 0;
+ background-color: var(--nav-menu-active-bg);
}
div.qindex{
@@ -599,16 +627,11 @@ a {
color: var(--page-visited-link-color);
}
-a:hover {
+span.label a:hover {
text-decoration: none;
background: linear-gradient(to bottom, transparent 0,transparent calc(100% - 1px), currentColor 100%);
}
-a:hover > span.arrow {
- text-decoration: none;
- background : var(--nav-background-color);
-}
-
a.el {
font-weight: bold;
}
@@ -616,12 +639,12 @@ a.el {
a.elRef {
}
-a.code, a.code:visited, a.line, a.line:visited {
- color: var(--code-link-color);
+a.el, a.el:visited, a.code, a.code:visited, a.line, a.line:visited {
+ color: var(--page-link-color);
}
a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited {
- color: var(--code-external-link-color);
+ color: var(--page-external-link-color);
}
a.code.hl_class { /* style for links to class names in code snippets */ }
@@ -658,118 +681,124 @@ dl.el {
}
ul.check {
- list-style:none;
- text-indent: -16px;
- padding-left: 38px;
+ list-style:none;
+ text-indent: -16px;
+ padding-left: 38px;
}
li.unchecked:before {
- content: "\2610\A0";
+ content: "\2610\A0";
}
li.checked:before {
- content: "\2611\A0";
+ content: "\2611\A0";
}
ol {
- text-indent: 0px;
+ text-indent: 0px;
}
ul {
- text-indent: 0px;
- overflow: visible;
+ text-indent: 0px;
+ overflow: visible;
}
ul.multicol {
- -moz-column-gap: 1em;
- -webkit-column-gap: 1em;
- column-gap: 1em;
- -moz-column-count: 3;
- -webkit-column-count: 3;
- column-count: 3;
- list-style-type: none;
+ -moz-column-gap: 1em;
+ -webkit-column-gap: 1em;
+ column-gap: 1em;
+ -moz-column-count: 3;
+ -webkit-column-count: 3;
+ column-count: 3;
+ list-style-type: none;
}
#side-nav ul {
- overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */
+ overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */
}
#main-nav ul {
- overflow: visible; /* reset ul rule for the navigation bar drop down lists */
+ overflow: visible; /* reset ul rule for the navigation bar drop down lists */
}
.fragment {
- text-align: left;
- direction: ltr;
- overflow-x: auto;
- overflow-y: hidden;
- position: relative;
- min-height: 12px;
- margin: 10px 0px;
- padding: 10px 10px;
- border: 1px solid var(--fragment-border-color);
- border-radius: 4px;
- background-color: var(--fragment-background-color);
- color: var(--fragment-foreground-color);
+ text-align: left;
+ direction: ltr;
+ overflow-x: auto;
+ overflow-y: hidden;
+ position: relative;
+ min-height: 12px;
+ margin: 10px 0px;
+ padding: 10px 10px;
+ border: 1px solid var(--fragment-border-color);
+ border-radius: 4px;
+ background-color: var(--fragment-background-color);
+ color: var(--fragment-foreground-color);
}
pre.fragment {
- word-wrap: break-word;
- font-size: 10pt;
- line-height: 125%;
- font-family: var(--font-family-monospace);
+ word-wrap: break-word;
+ font-size: 10pt;
+ line-height: 125%;
+ font-family: var(--font-family-monospace);
+}
+
+span.tt {
+ white-space: pre;
+ font-family: var(--font-family-monospace);
}
.clipboard {
- width: 24px;
- height: 24px;
- right: 5px;
- top: 5px;
- opacity: 0;
- position: absolute;
- display: inline;
- overflow: hidden;
- justify-content: center;
- align-items: center;
- cursor: pointer;
+ width: 24px;
+ height: 24px;
+ right: 5px;
+ top: 5px;
+ opacity: 0;
+ position: absolute;
+ display: inline;
+ overflow: hidden;
+ justify-content: center;
+ align-items: center;
+ cursor: pointer;
}
.clipboard.success {
- border: 1px solid var(--fragment-foreground-color);
- border-radius: 4px;
+ border: 1px solid var(--fragment-foreground-color);
+ border-radius: 4px;
}
.fragment:hover .clipboard, .clipboard.success {
- opacity: .4;
+ opacity: .4;
}
.clipboard:hover, .clipboard.success {
- opacity: 1 !important;
+ opacity: 1 !important;
}
.clipboard:active:not([class~=success]) svg {
- transform: scale(.91);
+ transform: scale(.91);
}
.clipboard.success svg {
- fill: var(--fragment-copy-ok-color);
+ fill: var(--fragment-copy-ok-color);
}
.clipboard.success {
- border-color: var(--fragment-copy-ok-color);
+ border-color: var(--fragment-copy-ok-color);
}
div.line {
font-family: var(--font-family-monospace);
- font-size: 13px;
+ font-size: 13px;
min-height: 13px;
line-height: 1.2;
- text-wrap: unrestricted;
+ text-wrap: wrap;
+ word-break: break-all;
white-space: -moz-pre-wrap; /* Moz */
white-space: -pre-wrap; /* Opera 4-6 */
white-space: -o-pre-wrap; /* Opera 7 */
white-space: pre-wrap; /* CSS3 */
word-wrap: break-word; /* IE 5.5+ */
- text-indent: -53px;
- padding-left: 53px;
+ text-indent: -62px;
+ padding-left: 62px;
padding-bottom: 0px;
margin: 0px;
-webkit-transition-property: background-color, box-shadow;
@@ -785,8 +814,8 @@ div.line {
}
div.line:after {
- content:"\000A";
- white-space: pre;
+ content:"\000A";
+ white-space: pre;
}
div.line.glow {
@@ -795,26 +824,67 @@ div.line.glow {
}
span.fold {
- margin-left: 5px;
- margin-right: 1px;
- margin-top: 0px;
- margin-bottom: 0px;
- padding: 0px;
display: inline-block;
width: 12px;
height: 12px;
- background-repeat:no-repeat;
- background-position:center;
+ margin-left: 4px;
+ margin-right: 1px;
+}
+
+span.foldnone {
+ display: inline-block;
+ position: relative;
+ cursor: pointer;
+ user-select: none;
+}
+
+span.fold.plus, span.fold.minus {
+ width: 10px;
+ height: 10px;
+ background-color: var(--fragment-background-color);
+ position: relative;
+ border: 1px solid var(--fold-line-color);
+ margin-right: 1px;
+}
+
+span.fold.plus::before, span.fold.minus::before {
+ content: '';
+ position: absolute;
+ background-color: var(--fold-line-color);
+}
+
+span.fold.plus::before {
+ width: 2px;
+ height: 6px;
+ top: 2px;
+ left: 4px;
+}
+
+span.fold.plus::after {
+ content: '';
+ position: absolute;
+ width: 6px;
+ height: 2px;
+ top: 4px;
+ left: 2px;
+ background-color: var(--fold-line-color);
+}
+
+span.fold.minus::before {
+ width: 6px;
+ height: 2px;
+ top: 4px;
+ left: 2px;
}
span.lineno {
padding-right: 4px;
- margin-right: 9px;
+ margin-right: 9px;
text-align: right;
border-right: 2px solid var(--fragment-lineno-border-color);
color: var(--fragment-lineno-foreground-color);
background-color: var(--fragment-lineno-background-color);
- white-space: pre;
+ white-space: pre;
}
span.lineno a, span.lineno a:visited {
color: var(--fragment-lineno-link-fg-color);
@@ -836,18 +906,27 @@ span.lineno a:hover {
}
div.classindex ul {
- list-style: none;
- padding-left: 0;
+ list-style: none;
+ padding-left: 0;
}
div.classindex span.ai {
- display: inline-block;
+ display: inline-block;
}
div.groupHeader {
- margin-left: 16px;
- margin-top: 12px;
- font-weight: bold;
+ box-shadow: 13px 0 var(--page-background-color),
+ -13px 0 var(--page-background-color),
+ 13px 1px var(--group-header-separator-color),
+ -13px 1px var(--group-header-separator-color);
+ color: var(--group-header-color);
+ font-size: 110%;
+ font-weight: 500;
+ margin-left: 0px;
+ margin-top: 0em;
+ margin-bottom: 6px;
+ padding-top: 8px;
+ padding-bottom: 4px;
}
div.groupText {
@@ -857,13 +936,13 @@ div.groupText {
body {
color: var(--page-foreground-color);
- margin: 0;
+ margin: 0;
}
div.contents {
margin-top: 10px;
margin-left: 12px;
- margin-right: 8px;
+ margin-right: 12px;
}
p.formulaDsp {
@@ -883,9 +962,9 @@ img.formulaInl, img.inline {
div.center {
text-align: center;
- margin-top: 0px;
- margin-bottom: 0px;
- padding: 0px;
+ margin-top: 0px;
+ margin-bottom: 0px;
+ padding: 0px;
}
div.center img {
@@ -960,10 +1039,10 @@ span.vhdllogic {
}
blockquote {
- background-color: var(--blockquote-background-color);
- border-left: 2px solid var(--blockquote-border-color);
- margin: 0 24px 0 4px;
- padding: 0 12px 0 16px;
+ background-color: var(--blockquote-background-color);
+ border-left: 2px solid var(--blockquote-border-color);
+ margin: 0 24px 0 4px;
+ padding: 0 12px 0 16px;
}
/* @end */
@@ -985,9 +1064,14 @@ th.dirtab {
}
hr {
- height: 0px;
border: none;
- border-top: 1px solid var(--separator-color);
+ margin-top: 16px;
+ margin-bottom: 16px;
+ height: 1px;
+ box-shadow: 13px 0 var(--page-background-color),
+ -13px 0 var(--page-background-color),
+ 13px 1px var(--group-header-separator-color),
+ -13px 1px var(--group-header-separator-color);
}
hr.footer {
@@ -1002,14 +1086,6 @@ table.memberdecls {
}
.memberdecls td, .fieldtable tr {
- -webkit-transition-property: background-color, box-shadow;
- -webkit-transition-duration: 0.5s;
- -moz-transition-property: background-color, box-shadow;
- -moz-transition-duration: 0.5s;
- -ms-transition-property: background-color, box-shadow;
- -ms-transition-duration: 0.5s;
- -o-transition-property: background-color, box-shadow;
- -o-transition-duration: 0.5s;
transition-property: background-color, box-shadow;
transition-duration: 0.5s;
}
@@ -1019,13 +1095,23 @@ table.memberdecls {
box-shadow: 0 0 15px var(--glow-color);
}
+.memberdecls tr[class^='memitem'] {
+ font-family: var(--font-family-monospace);
+}
+
.mdescLeft, .mdescRight,
-.memItemLeft, .memItemRight,
-.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
+.memItemLeft, .memItemRight {
+ padding-top: 2px;
+ padding-bottom: 2px;
+}
+
+.memTemplParams {
+ padding-left: 10px;
+ padding-top: 5px;
+}
+
+.memItemLeft, .memItemRight, .memTemplParams {
background-color: var(--memdecl-background-color);
- border: none;
- margin: 4px;
- padding: 1px 0 0 8px;
}
.mdescLeft, .mdescRight {
@@ -1033,27 +1119,104 @@ table.memberdecls {
color: var(--memdecl-foreground-color);
}
-.memSeparator {
- border-bottom: 1px solid var(--memdecl-separator-color);
- line-height: 1px;
- margin: 0px;
- padding: 0px;
+tr[class^='memdesc'] {
+ box-shadow: inset 0px 1px 3px 0px rgba(0,0,0,.075);
}
-.memItemLeft, .memTemplItemLeft {
- white-space: nowrap;
+.mdescLeft {
+ border-left: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
}
-.memItemRight, .memTemplItemRight {
- width: 100%;
+.mdescRight {
+ border-right: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
}
.memTemplParams {
color: var(--memdecl-template-color);
- white-space: nowrap;
+ white-space: nowrap;
font-size: 80%;
+ border-left: 1px solid var(--memdecl-border-color);
+ border-right: 1px solid var(--memdecl-border-color);
+}
+
+td.ititle {
+ border: 1px solid var(--memdecl-border-color);
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+ padding-left: 10px;
+}
+
+tr:not(:first-child) > td.ititle {
+ border-top: 0;
+ border-radius: 0;
}
+.memItemLeft {
+ white-space: nowrap;
+ border-left: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
+ padding-left: 10px;
+ transition: none;
+}
+
+.memItemRight {
+ width: 100%;
+ border-right: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
+ padding-right: 10px;
+ transition: none;
+}
+
+tr.heading + tr[class^='memitem'] td.memItemLeft,
+tr.groupHeader + tr[class^='memitem'] td.memItemLeft,
+tr.inherit_header + tr[class^='memitem'] td.memItemLeft {
+ border-top: 1px solid var(--memdecl-border-color);
+ border-top-left-radius: 4px;
+}
+
+tr.heading + tr[class^='memitem'] td.memItemRight,
+tr.groupHeader + tr[class^='memitem'] td.memItemRight,
+tr.inherit_header + tr[class^='memitem'] td.memItemRight {
+ border-top: 1px solid var(--memdecl-border-color);
+ border-top-right-radius: 4px;
+}
+
+tr.heading + tr[class^='memitem'] td.memTemplParams,
+tr.heading + tr td.ititle,
+tr.groupHeader + tr[class^='memitem'] td.memTemplParams,
+tr.groupHeader + tr td.ititle,
+tr.inherit_header + tr[class^='memitem'] td.memTemplParams {
+ border-top: 1px solid var(--memdecl-border-color);
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+}
+
+table.memberdecls tr:last-child td.memItemLeft,
+table.memberdecls tr:last-child td.mdescLeft,
+table.memberdecls tr[class^='memitem']:has(+ tr.groupHeader) td.memItemLeft,
+table.memberdecls tr[class^='memitem']:has(+ tr.inherit_header) td.memItemLeft,
+table.memberdecls tr[class^='memdesc']:has(+ tr.groupHeader) td.mdescLeft,
+table.memberdecls tr[class^='memdesc']:has(+ tr.inherit_header) td.mdescLeft {
+ border-bottom-left-radius: 4px;
+}
+
+table.memberdecls tr:last-child td.memItemRight,
+table.memberdecls tr:last-child td.mdescRight,
+table.memberdecls tr[class^='memitem']:has(+ tr.groupHeader) td.memItemRight,
+table.memberdecls tr[class^='memitem']:has(+ tr.inherit_header) td.memItemRight,
+table.memberdecls tr[class^='memdesc']:has(+ tr.groupHeader) td.mdescRight,
+table.memberdecls tr[class^='memdesc']:has(+ tr.inherit_header) td.mdescRight {
+ border-bottom-right-radius: 4px;
+}
+
+tr.template .memItemLeft, tr.template .memItemRight {
+ border-top: none;
+ padding-top: 0;
+}
+
+
/* @end */
/* @group Member Details */
@@ -1068,24 +1231,43 @@ table.memberdecls {
border-top-right-radius: 4px;
border-top-left-radius: 4px;
margin-bottom: -1px;
- background-image: var(--memdef-title-gradient-image);
- background-repeat: repeat-x;
- background-color: var(--memdef-title-background-color);
+ background-color: var(--memdef-proto-background-color);
line-height: 1.25;
- font-weight: 300;
+ font-family: var(--font-family-monospace);
+ font-weight: 500;
+ font-size: 16px;
float:left;
+ box-shadow: 0 10px 0 -1px var(--memdef-proto-background-color),
+ 0 2px 8px 0 rgba(0,0,0,.075);
+ position: relative;
+}
+
+.memtitle:after {
+ content: '';
+ display: block;
+ background: var(--memdef-proto-background-color);
+ height: 10px;
+ bottom: -10px;
+ left: 0px;
+ right: -14px;
+ position: absolute;
+ border-top-right-radius: 6px;
}
.permalink
{
- font-size: 65%;
- display: inline-block;
- vertical-align: middle;
+ font-family: var(--font-family-monospace);
+ font-weight: 500;
+ line-height: 1.25;
+ font-size: 16px;
+ display: inline-block;
+ vertical-align: middle;
}
.memtemplate {
font-size: 80%;
color: var(--memdef-template-color);
+ font-family: var(--font-family-monospace);
font-weight: normal;
margin-left: 9px;
}
@@ -1098,22 +1280,21 @@ table.memberdecls {
padding: 0;
margin-bottom: 10px;
margin-right: 5px;
- -webkit-transition: box-shadow 0.5s linear;
- -moz-transition: box-shadow 0.5s linear;
- -ms-transition: box-shadow 0.5s linear;
- -o-transition: box-shadow 0.5s linear;
- transition: box-shadow 0.5s linear;
- display: table !important;
- width: 100%;
+ display: table !important;
+ width: 100%;
+ box-shadow: 0 2px 8px 0 rgba(0,0,0,.075);
+ border-radius: 4px;
}
.memitem.glow {
- box-shadow: 0 0 15px var(--glow-color);
+ box-shadow: 0 0 15px var(--glow-color);
}
.memname {
- font-weight: 400;
- margin-left: 6px;
+ font-family: var(--font-family-monospace);
+ font-size: 13px;
+ font-weight: 400;
+ margin-left: 6px;
}
.memname td {
@@ -1121,53 +1302,39 @@ table.memberdecls {
}
.memproto, dl.reflist dt {
- border-top: 1px solid var(--memdef-border-color);
- border-left: 1px solid var(--memdef-border-color);
- border-right: 1px solid var(--memdef-border-color);
- padding: 6px 0px 6px 0px;
- color: var(--memdef-proto-text-color);
- font-weight: bold;
- text-shadow: var(--memdef-proto-text-shadow);
- background-color: var(--memdef-proto-background-color);
- box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
- border-top-right-radius: 4px;
+ border-top: 1px solid var(--memdef-border-color);
+ border-left: 1px solid var(--memdef-border-color);
+ border-right: 1px solid var(--memdef-border-color);
+ padding: 6px 0px 6px 0px;
+ color: var(--memdef-proto-text-color);
+ font-weight: bold;
+ background-color: var(--memdef-proto-background-color);
+ border-top-right-radius: 4px;
+ border-bottom: 1px solid var(--memdef-border-color);
}
.overload {
- font-family: var(--font-family-monospace);
+ font-family: var(--font-family-monospace);
font-size: 65%;
}
.memdoc, dl.reflist dd {
- border-bottom: 1px solid var(--memdef-border-color);
- border-left: 1px solid var(--memdef-border-color);
- border-right: 1px solid var(--memdef-border-color);
- padding: 6px 10px 2px 10px;
- border-top-width: 0;
- background-image:url('nav_g.png');
- background-repeat:repeat-x;
- background-color: var(--memdef-doc-background-color);
- /* opera specific markup */
- border-bottom-left-radius: 4px;
- border-bottom-right-radius: 4px;
- box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
- /* firefox specific markup */
- -moz-border-radius-bottomleft: 4px;
- -moz-border-radius-bottomright: 4px;
- -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
- /* webkit specific markup */
- -webkit-border-bottom-left-radius: 4px;
- -webkit-border-bottom-right-radius: 4px;
- -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ border-bottom: 1px solid var(--memdef-border-color);
+ border-left: 1px solid var(--memdef-border-color);
+ border-right: 1px solid var(--memdef-border-color);
+ padding: 6px 10px 2px 10px;
+ border-top-width: 0;
+ border-bottom-left-radius: 4px;
+ border-bottom-right-radius: 4px;
}
dl.reflist dt {
- padding: 5px;
+ padding: 5px;
}
dl.reflist dd {
- margin: 0px 0px 10px 0px;
- padding: 5px;
+ margin: 0px 0px 10px 0px;
+ padding: 5px;
}
.paramkey {
@@ -1182,9 +1349,9 @@ dl.reflist dd {
.paramname {
white-space: nowrap;
- padding: 0px;
- padding-bottom: 1px;
- margin-left: 2px;
+ padding: 0px;
+ padding-bottom: 1px;
+ margin-left: 2px;
}
.paramname em {
@@ -1198,23 +1365,23 @@ dl.reflist dd {
}
.params, .retval, .exception, .tparams {
- margin-left: 0px;
- padding-left: 0px;
+ margin-left: 0px;
+ padding-left: 0px;
}
.params .paramname, .retval .paramname, .tparams .paramname, .exception .paramname {
- font-weight: bold;
- vertical-align: top;
+ font-weight: bold;
+ vertical-align: top;
}
.params .paramtype, .tparams .paramtype {
- font-style: italic;
- vertical-align: top;
+ font-style: italic;
+ vertical-align: top;
}
.params .paramdir, .tparams .paramdir {
- font-family: var(--font-family-monospace);
- vertical-align: top;
+ font-family: var(--font-family-monospace);
+ vertical-align: top;
}
table.mlabels {
@@ -1233,15 +1400,15 @@ td.mlabels-right {
}
span.mlabels {
- margin-left: 8px;
+ margin-left: 8px;
}
span.mlabel {
- background-color: var(--label-background-color);
- border-top:1px solid var(--label-left-top-border-color);
- border-left:1px solid var(--label-left-top-border-color);
- border-right:1px solid var(--label-right-bottom-border-color);
- border-bottom:1px solid var(--label-right-bottom-border-color);
+ background-color: var(--label-background-color);
+ border-top:1px solid var(--label-left-top-border-color);
+ border-left:1px solid var(--label-left-top-border-color);
+ border-right:1px solid var(--label-right-bottom-border-color);
+ border-bottom:1px solid var(--label-right-bottom-border-color);
text-shadow: none;
color: var(--label-foreground-color);
margin-right: 4px;
@@ -1259,39 +1426,37 @@ span.mlabel {
/* these are for tree view inside a (index) page */
div.directory {
- margin: 10px 0px;
- border-top: 1px solid var(--directory-separator-color);
- border-bottom: 1px solid var(--directory-separator-color);
- width: 100%;
+ margin: 10px 0px;
+ width: 100%;
}
.directory table {
- border-collapse:collapse;
+ border-collapse:collapse;
}
.directory td {
- margin: 0px;
- padding: 0px;
+ margin: 0px;
+ padding: 0px;
vertical-align: top;
}
.directory td.entry {
- white-space: nowrap;
- padding-right: 6px;
+ white-space: nowrap;
+ padding-right: 6px;
padding-top: 3px;
}
.directory td.entry a {
- outline:none;
+ outline:none;
}
.directory td.entry a img {
- border: none;
+ border: none;
}
.directory td.desc {
- width: 100%;
- padding-left: 6px;
+ width: 100%;
+ padding-left: 6px;
padding-right: 6px;
padding-top: 3px;
border-left: 1px solid rgba(0,0,0,0.05);
@@ -1312,90 +1477,178 @@ div.directory {
}
.directory .levels {
- white-space: nowrap;
- width: 100%;
- text-align: right;
- font-size: 9pt;
+ white-space: nowrap;
+ width: 100%;
+ text-align: right;
+ font-size: 9pt;
}
.directory .levels span {
- cursor: pointer;
- padding-left: 2px;
- padding-right: 2px;
+ cursor: pointer;
+ padding-left: 2px;
+ padding-right: 2px;
color: var(--page-link-color);
}
.arrow {
- color: var(--nav-arrow-color);
- -webkit-user-select: none;
- -khtml-user-select: none;
- -moz-user-select: none;
- -ms-user-select: none;
- user-select: none;
- cursor: pointer;
- font-size: 80%;
- display: inline-block;
- width: 16px;
- height: 22px;
+ color: var(--nav-background-color);
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ cursor: pointer;
+ font-size: 80%;
+ display: inline-block;
+ width: 16px;
+ height: 14px;
+ transition: opacity 0.3s ease;
+}
+
+span.arrowhead {
+ position: relative;
+ padding: 0;
+ margin: 0 0 0 2px;
+ display: inline-block;
+ width: 5px;
+ height: 5px;
+ border-right: 2px solid var(--nav-arrow-color);
+ border-bottom: 2px solid var(--nav-arrow-color);
+ transform: rotate(-45deg);
+ transition: transform 0.3s ease;
+}
+
+span.arrowhead.opened {
+ transform: rotate(45deg);
+}
+
+.selected span.arrowhead {
+ border-right: 2px solid var(--nav-arrow-selected-color);
+ border-bottom: 2px solid var(--nav-arrow-selected-color);
}
.icon {
- font-family: var(--font-family-icon);
- line-height: normal;
- font-weight: bold;
- font-size: 12px;
- height: 14px;
- width: 16px;
- display: inline-block;
- background-color: var(--icon-background-color);
- color: var(--icon-foreground-color);
- text-align: center;
- border-radius: 4px;
- margin-left: 2px;
- margin-right: 2px;
+ font-family: var(--font-family-icon);
+ line-height: normal;
+ font-weight: bold;
+ font-size: 12px;
+ height: 14px;
+ width: 16px;
+ display: inline-block;
+ background-color: var(--icon-background-color);
+ color: var(--icon-foreground-color);
+ text-align: center;
+ border-radius: 4px;
+ margin-left: 2px;
+ margin-right: 2px;
}
.icona {
- width: 24px;
- height: 22px;
- display: inline-block;
+ width: 24px;
+ height: 22px;
+ display: inline-block;
}
-.iconfopen {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:var(--icon-folder-open-image);
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
+.iconfolder {
+ width: 24px;
+ height: 18px;
+ margin-top: 6px;
+ vertical-align:top;
+ display: inline-block;
+ position: relative;
}
-.iconfclosed {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:var(--icon-folder-closed-image);
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
+.icondoc {
+ width: 24px;
+ height: 18px;
+ margin-top: 3px;
+ vertical-align:top;
+ display: inline-block;
+ position: relative;
}
-.icondoc {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:var(--icon-doc-image);
- background-position: 0px -4px;
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
+.folder-icon {
+ width: 16px;
+ height: 11px;
+ background-color: var(--icon-folder-fill-color);
+ border: 1px solid var(--icon-folder-border-color);
+ border-radius: 0 2px 2px 2px;
+ position: relative;
+ box-sizing: content-box;
+}
+
+.folder-icon::after {
+ content: '';
+ position: absolute;
+ top: 2px;
+ left: -1px;
+ width: 16px;
+ height: 7px;
+ background-color: var(--icon-folder-open-fill-color);
+ border: 1px solid var(--icon-folder-border-color);
+ border-radius: 7px 7px 2px 2px;
+ transform-origin: top left;
+ opacity: 0;
+ transition: all 0.3s linear;
+}
+
+.folder-icon::before {
+ content: '';
+ position: absolute;
+ top: -3px;
+ left: -1px;
+ width: 6px;
+ height: 2px;
+ background-color: var(--icon-folder-fill-color);
+ border-top: 1px solid var(--icon-folder-border-color);
+ border-left: 1px solid var(--icon-folder-border-color);
+ border-right: 1px solid var(--icon-folder-border-color);
+ border-radius: 2px 2px 0 0;
+}
+
+.folder-icon.open::after {
+ top: 3px;
+ opacity: 1;
+}
+
+.doc-icon {
+ left: 6px;
+ width: 12px;
+ height: 16px;
+ background-color: var(--icon-doc-border-color);
+ clip-path: polygon(0 0, 66% 0, 100% 25%, 100% 100%, 0 100%);
+ position: relative;
+ display: inline-block;
+}
+.doc-icon::before {
+ content: "";
+ left: 1px;
+ top: 1px;
+ width: 10px;
+ height: 14px;
+ background-color: var(--icon-doc-fill-color);
+ clip-path: polygon(0 0, 66% 0, 100% 25%, 100% 100%, 0 100%);
+ position: absolute;
+ box-sizing: border-box;
+}
+.doc-icon::after {
+ content: "";
+ left: 7px;
+ top: 0px;
+ width: 3px;
+ height: 3px;
+ background-color: transparent;
+ position: absolute;
+ border: 1px solid var(--icon-doc-border-color);
}
+
+
+
/* @end */
div.dynheader {
- margin-top: 8px;
+ margin-top: 8px;
-webkit-touch-callout: none;
-webkit-user-select: none;
-khtml-user-select: none;
@@ -1404,6 +1657,13 @@ div.dynheader {
user-select: none;
}
+span.dynarrow {
+ position: relative;
+ display: inline-block;
+ width: 12px;
+ bottom: 1px;
+}
+
address {
font-style: normal;
color: var(--footer-foreground-color);
@@ -1415,8 +1675,8 @@ table.doxtable caption {
table.doxtable {
border-collapse:collapse;
- margin-top: 4px;
- margin-bottom: 4px;
+ margin-top: 4px;
+ margin-bottom: 4px;
}
table.doxtable td, table.doxtable th {
@@ -1433,133 +1693,145 @@ table.doxtable th {
}
table.fieldtable {
- margin-bottom: 10px;
- border: 1px solid var(--memdef-border-color);
- border-spacing: 0px;
- border-radius: 4px;
- box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
+ margin-bottom: 10px;
+ border: 1px solid var(--memdef-border-color);
+ border-spacing: 0px;
+ border-radius: 4px;
+ box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
}
.fieldtable td, .fieldtable th {
- padding: 3px 7px 2px;
+ padding: 3px 7px 2px;
}
.fieldtable td.fieldtype, .fieldtable td.fieldname, .fieldtable td.fieldinit {
- white-space: nowrap;
- border-right: 1px solid var(--memdef-border-color);
- border-bottom: 1px solid var(--memdef-border-color);
- vertical-align: top;
+ white-space: nowrap;
+ border-right: 1px solid var(--memdef-border-color);
+ border-bottom: 1px solid var(--memdef-border-color);
+ vertical-align: top;
}
.fieldtable td.fieldname {
- padding-top: 3px;
+ padding-top: 3px;
}
.fieldtable td.fieldinit {
- padding-top: 3px;
- text-align: right;
+ padding-top: 3px;
+ text-align: right;
}
.fieldtable td.fielddoc {
- border-bottom: 1px solid var(--memdef-border-color);
+ border-bottom: 1px solid var(--memdef-border-color);
}
.fieldtable td.fielddoc p:first-child {
- margin-top: 0px;
+ margin-top: 0px;
}
.fieldtable td.fielddoc p:last-child {
- margin-bottom: 2px;
+ margin-bottom: 2px;
}
.fieldtable tr:last-child td {
- border-bottom: none;
+ border-bottom: none;
}
.fieldtable th {
- background-image: var(--memdef-title-gradient-image);
- background-repeat:repeat-x;
- background-color: var(--memdef-title-background-color);
- font-size: 90%;
- color: var(--memdef-proto-text-color);
- padding-bottom: 4px;
- padding-top: 5px;
- text-align:left;
- font-weight: 400;
- border-top-left-radius: 4px;
- border-top-right-radius: 4px;
- border-bottom: 1px solid var(--memdef-border-color);
-}
-
-
-.tabsearch {
- top: 0px;
- left: 10px;
- height: 36px;
- background-image: var(--nav-gradient-image);
- z-index: 101;
+ background-color: var(--memdef-title-background-color);
+ font-size: 90%;
+ color: var(--memdef-proto-text-color);
+ padding-bottom: 4px;
+ padding-top: 5px;
+ text-align:left;
+ font-weight: 400;
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+ border-bottom: 1px solid var(--memdef-border-color);
+}
+
+/* ----------- navigation breadcrumb styling ----------- */
+
+#nav-path ul {
+ height: 30px;
+ line-height: 30px;
+ color: var(--nav-text-normal-color);
overflow: hidden;
- font-size: 13px;
+ margin: 0px;
+ padding-left: 4px;
+ background-image: none;
+ background: var(--page-background-color);
+ border-bottom: 1px solid var(--nav-breadcrumb-separator-color);
+ font-size: var(--nav-font-size-level1);
+ font-family: var(--font-family-nav);
+ position: relative;
+ z-index: 100;
}
-.navpath ul
-{
- font-size: 11px;
- background-image: var(--nav-gradient-image);
- background-repeat:repeat-x;
- background-position: 0 -5px;
- height:30px;
- line-height:30px;
- color:var(--nav-text-normal-color);
- border:solid 1px var(--nav-breadcrumb-border-color);
- overflow:hidden;
- margin:0px;
- padding:0px;
-}
-
-.navpath li
-{
+#main-nav {
+ border-bottom: 1px solid var(--nav-border-color);
+}
+
+.navpath li {
list-style-type:none;
float:left;
+ color: var(--nav-foreground-color);
+}
+
+.navpath li.footer {
+ list-style-type:none;
+ float:right;
padding-left:10px;
padding-right:15px;
- background-image:var(--nav-breadcrumb-image);
+ background-image:none;
background-repeat:no-repeat;
background-position:right;
- color: var(--nav-foreground-color);
+ font-size: 8pt;
+ color: var(--footer-foreground-color);
}
-.navpath li.navelem a
-{
- height:32px;
- display:block;
- outline: none;
- color: var(--nav-text-normal-color);
- font-family: var(--font-family-nav);
- text-shadow: var(--nav-text-normal-shadow);
- text-decoration: none;
+#nav-path li.navelem {
+ background-image: none;
+ display: flex;
+ align-items: center;
+ padding-left: 15px;
}
-.navpath li.navelem a:hover
-{
- color: var(--nav-text-hover-color);
- text-shadow: var(--nav-text-hover-shadow);
+.navpath li.navelem a {
+ text-shadow: none;
+ display: inline-block;
+ color: var(--nav-breadcrumb-color);
+ position: relative;
+ top: 0px;
+ height: 30px;
+ margin-right: -20px;
}
-.navpath li.footer
-{
- list-style-type:none;
- float:right;
- padding-left:10px;
- padding-right:15px;
- background-image:none;
- background-repeat:no-repeat;
- background-position:right;
- color: var(--footer-foreground-color);
- font-size: 8pt;
+#nav-path li.navelem:after {
+ content: '';
+ display: inline-block;
+ position: relative;
+ top: 0;
+ right: -15px;
+ width: 30px;
+ height: 30px;
+ transform: scaleX(0.5) scale(0.707) rotate(45deg);
+ z-index: 10;
+ background: var(--page-background-color);
+ box-shadow: 2px -2px 0 2px var(--nav-breadcrumb-separator-color);
+ border-radius: 0 5px 0 50px;
+}
+
+#nav-path li.navelem:first-child {
+ margin-left: -6px;
}
+#nav-path li.navelem:hover,
+#nav-path li.navelem:hover:after {
+ background-color: var(--nav-breadcrumb-active-bg);
+}
+
+/* ---------------------- */
div.summary
{
@@ -1577,14 +1849,14 @@ div.summary a
table.classindex
{
- margin: 10px;
- white-space: nowrap;
- margin-left: 3%;
- margin-right: 3%;
- width: 94%;
- border: 0;
- border-spacing: 0;
- padding: 0;
+ margin: 10px;
+ white-space: nowrap;
+ margin-left: 3%;
+ margin-right: 3%;
+ width: 94%;
+ border: 0;
+ border-spacing: 0;
+ padding: 0;
}
div.ingroups
@@ -1601,10 +1873,8 @@ div.ingroups a
div.header
{
- background-image: var(--header-gradient-image);
- background-repeat:repeat-x;
- background-color: var(--header-background-color);
margin: 0px;
+ background-color: var(--header-background-color);
border-bottom: 1px solid var(--header-separator-color);
}
@@ -1613,168 +1883,105 @@ div.headertitle
padding: 5px 5px 5px 10px;
}
-.PageDocRTL-title div.headertitle {
- text-align: right;
- direction: rtl;
-}
-
dl {
- padding: 0 0 0 0;
-}
-
-/*
-
-dl.section {
- margin-left: 0px;
- padding-left: 0px;
-}
-
-dl.note {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #D0C000;
-}
-
-dl.warning, dl.attention, dl.important {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #FF0000;
-}
-
-dl.pre, dl.post, dl.invariant {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #00D000;
-}
-
-dl.deprecated {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #505050;
-}
-
-dl.todo {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #00C0E0;
-}
-
-dl.test {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #3030E0;
-}
-
-dl.bug {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #C08050;
+ padding: 0 0 0 0;
}
-*/
-
dl.bug dt a, dl.deprecated dt a, dl.todo dt a, dl.test a {
- font-weight: bold !important;
+ font-weight: bold !important;
}
dl.warning, dl.attention, dl.important, dl.note, dl.deprecated, dl.bug,
dl.invariant, dl.pre, dl.post, dl.todo, dl.test, dl.remark {
- padding: 10px;
- margin: 10px 0px;
- overflow: hidden;
- margin-left: 0;
- border-radius: 4px;
+ padding: 10px;
+ margin: 10px 0px;
+ overflow: hidden;
+ margin-left: 0;
+ border-radius: 4px;
}
dl.section dd {
- margin-bottom: 2px;
+ margin-bottom: 2px;
}
dl.warning, dl.attention, dl.important {
- background: var(--warning-color-bg);
- border-left: 8px solid var(--warning-color-hl);
- color: var(--warning-color-text);
+ background: var(--warning-color-bg);
+ border-left: 8px solid var(--warning-color-hl);
+ color: var(--warning-color-text);
}
dl.warning dt, dl.attention dt, dl.important dt {
- color: var(--warning-color-hl);
+ color: var(--warning-color-hl);
}
dl.note, dl.remark {
- background: var(--note-color-bg);
- border-left: 8px solid var(--note-color-hl);
- color: var(--note-color-text);
+ background: var(--note-color-bg);
+ border-left: 8px solid var(--note-color-hl);
+ color: var(--note-color-text);
}
dl.note dt, dl.remark dt {
- color: var(--note-color-hl);
+ color: var(--note-color-hl);
}
dl.todo {
- background: var(--todo-color-bg);
- border-left: 8px solid var(--todo-color-hl);
- color: var(--todo-color-text);
+ background: var(--todo-color-bg);
+ border-left: 8px solid var(--todo-color-hl);
+ color: var(--todo-color-text);
}
dl.todo dt {
- color: var(--todo-color-hl);
+ color: var(--todo-color-hl);
}
dl.test {
- background: var(--test-color-bg);
- border-left: 8px solid var(--test-color-hl);
- color: var(--test-color-text);
+ background: var(--test-color-bg);
+ border-left: 8px solid var(--test-color-hl);
+ color: var(--test-color-text);
}
dl.test dt {
- color: var(--test-color-hl);
+ color: var(--test-color-hl);
}
dl.bug dt a {
- color: var(--bug-color-hl) !important;
+ color: var(--bug-color-hl) !important;
}
dl.bug {
- background: var(--bug-color-bg);
- border-left: 8px solid var(--bug-color-hl);
- color: var(--bug-color-text);
+ background: var(--bug-color-bg);
+ border-left: 8px solid var(--bug-color-hl);
+ color: var(--bug-color-text);
}
dl.bug dt a {
- color: var(--bug-color-hl) !important;
+ color: var(--bug-color-hl) !important;
}
dl.deprecated {
- background: var(--deprecated-color-bg);
- border-left: 8px solid var(--deprecated-color-hl);
- color: var(--deprecated-color-text);
+ background: var(--deprecated-color-bg);
+ border-left: 8px solid var(--deprecated-color-hl);
+ color: var(--deprecated-color-text);
}
dl.deprecated dt a {
- color: var(--deprecated-color-hl) !important;
+ color: var(--deprecated-color-hl) !important;
}
dl.note dd, dl.warning dd, dl.pre dd, dl.post dd,
dl.remark dd, dl.attention dd, dl.important dd, dl.invariant dd,
dl.bug dd, dl.deprecated dd, dl.todo dd, dl.test dd {
- margin-inline-start: 0px;
+ margin-inline-start: 0px;
}
dl.invariant, dl.pre, dl.post {
- background: var(--invariant-color-bg);
- border-left: 8px solid var(--invariant-color-hl);
- color: var(--invariant-color-text);
+ background: var(--invariant-color-bg);
+ border-left: 8px solid var(--invariant-color-hl);
+ color: var(--invariant-color-text);
}
dl.invariant dt, dl.pre dt, dl.post dt {
- color: var(--invariant-color-hl);
+ color: var(--invariant-color-hl);
}
@@ -1797,16 +2004,16 @@ dl.invariant dt, dl.pre dt, dl.post dt {
#projectalign
{
- vertical-align: middle;
- padding-left: 0.5em;
+ vertical-align: middle;
+ padding-left: 0.5em;
}
#projectname
{
font-size: 200%;
font-family: var(--font-family-title);
- margin: 0px;
- padding: 2px 0px;
+ margin: 0;
+ padding: 0;
}
#side-nav #projectname
@@ -1817,7 +2024,7 @@ dl.invariant dt, dl.pre dt, dl.post dt {
#projectbrief
{
font-size: 90%;
- font-family: var(--font-family-title);
+ font-family: var(--font-family-title);
margin: 0px;
padding: 0px;
}
@@ -1825,43 +2032,42 @@ dl.invariant dt, dl.pre dt, dl.post dt {
#projectnumber
{
font-size: 50%;
- font-family: 50% var(--font-family-title);
+ font-family: var(--font-family-title);
margin: 0px;
padding: 0px;
}
#titlearea
{
- padding: 0px;
+ padding: 0 0 0 5px;
margin: 0px;
- width: 100%;
border-bottom: 1px solid var(--title-separator-color);
background-color: var(--title-background-color);
}
.image
{
- text-align: center;
+ text-align: center;
}
.dotgraph
{
- text-align: center;
+ text-align: center;
}
.mscgraph
{
- text-align: center;
+ text-align: center;
}
.plantumlgraph
{
- text-align: center;
+ text-align: center;
}
.diagraph
{
- text-align: center;
+ text-align: center;
}
.caption
@@ -1870,67 +2076,67 @@ dl.invariant dt, dl.pre dt, dl.post dt {
}
dl.citelist {
- margin-bottom:50px;
+ margin-bottom:50px;
}
dl.citelist dt {
- color:var(--citation-label-color);
- float:left;
- font-weight:bold;
- margin-right:10px;
- padding:5px;
- text-align:right;
- width:52px;
+ color:var(--citation-label-color);
+ float:left;
+ font-weight:bold;
+ margin-right:10px;
+ padding:5px;
+ text-align:right;
+ width:52px;
}
dl.citelist dd {
- margin:2px 0 2px 72px;
- padding:5px 0;
+ margin:2px 0 2px 72px;
+ padding:5px 0;
}
div.toc {
- padding: 14px 25px;
- background-color: var(--toc-background-color);
- border: 1px solid var(--toc-border-color);
- border-radius: 7px 7px 7px 7px;
- float: right;
- height: auto;
- margin: 0 8px 10px 10px;
- width: 200px;
+ padding: 14px 25px;
+ background-color: var(--toc-background-color);
+ border: 1px solid var(--toc-border-color);
+ border-radius: 7px 7px 7px 7px;
+ float: right;
+ height: auto;
+ margin: 0 8px 10px 10px;
+ width: 200px;
}
div.toc li {
- background: var(--toc-down-arrow-image) no-repeat scroll 0 5px transparent;
- font: 10px/1.2 var(--font-family-toc);
- margin-top: 5px;
- padding-left: 10px;
- padding-top: 2px;
+ background: var(--toc-down-arrow-image) no-repeat scroll 0 5px transparent;
+ font: 10px/1.2 var(--font-family-toc);
+ margin-top: 5px;
+ padding-left: 10px;
+ padding-top: 2px;
}
div.toc h3 {
- font: bold 12px/1.2 var(--font-family-toc);
+ font: bold 12px/1.2 var(--font-family-toc);
color: var(--toc-header-color);
- border-bottom: 0 none;
- margin: 0;
+ border-bottom: 0 none;
+ margin: 0;
}
div.toc ul {
- list-style: none outside none;
- border: medium none;
- padding: 0px;
+ list-style: none outside none;
+ border: medium none;
+ padding: 0px;
}
div.toc li[class^='level'] {
- margin-left: 15px;
+ margin-left: 15px;
}
div.toc li.level1 {
- margin-left: 0px;
+ margin-left: 0px;
}
div.toc li.empty {
- background-image: none;
- margin-top: 0px;
+ background-image: none;
+ margin-top: 0px;
}
span.emoji {
@@ -1940,13 +2146,12 @@ span.emoji {
}
span.obfuscator {
- display: none;
+ display: none;
}
.inherit_header {
- font-weight: bold;
- color: var(--inherit-header-color);
- cursor: pointer;
+ font-weight: 400;
+ cursor: pointer;
-webkit-touch-callout: none;
-webkit-user-select: none;
-khtml-user-select: none;
@@ -1956,49 +2161,49 @@ span.obfuscator {
}
.inherit_header td {
- padding: 6px 0px 2px 5px;
+ padding: 6px 0 2px 0;
}
.inherit {
- display: none;
+ display: none;
}
tr.heading h2 {
- margin-top: 12px;
- margin-bottom: 4px;
+ margin-top: 12px;
+ margin-bottom: 12px;
}
/* tooltip related style info */
.ttc {
- position: absolute;
- display: none;
+ position: absolute;
+ display: none;
}
#powerTip {
cursor: default;
- /*white-space: nowrap;*/
- color: var(--tooltip-foreground-color);
+ color: var(--tooltip-foreground-color);
background-color: var(--tooltip-background-color);
+ backdrop-filter: var(--tooltip-backdrop-filter);
+ -webkit-backdrop-filter: var(--tooltip-backdrop-filter);
border: 1px solid var(--tooltip-border-color);
- border-radius: 4px 4px 4px 4px;
+ border-radius: 4px;
box-shadow: var(--tooltip-shadow);
display: none;
font-size: smaller;
max-width: 80%;
- opacity: 0.9;
padding: 1ex 1em 1em;
position: absolute;
z-index: 2147483647;
}
#powerTip div.ttdoc {
- color: var(--tooltip-doc-color);
+ color: var(--tooltip-doc-color);
font-style: italic;
}
#powerTip div.ttname a {
- font-weight: bold;
+ font-weight: bold;
}
#powerTip a {
@@ -2006,18 +2211,18 @@ tr.heading h2 {
}
#powerTip div.ttname {
- font-weight: bold;
+ font-weight: bold;
}
#powerTip div.ttdeci {
- color: var(--tooltip-declaration-color);
+ color: var(--tooltip-declaration-color);
}
#powerTip div {
- margin: 0px;
- padding: 0px;
- font-size: 12px;
- font-family: var(--font-family-tooltip);
+ margin: 0px;
+ padding: 0px;
+ font-size: 12px;
+ font-family: var(--font-family-tooltip);
line-height: 16px;
}
@@ -2063,7 +2268,7 @@ tr.heading h2 {
}
#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after {
- border-top-color: var(--tooltip-background-color);
+ border-top-color: var(--tooltip-arrow-background-color);
border-width: 10px;
margin: 0px -10px;
}
@@ -2091,7 +2296,7 @@ tr.heading h2 {
}
#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after {
- border-bottom-color: var(--tooltip-background-color);
+ border-bottom-color: var(--tooltip-arrow-background-color);
border-width: 10px;
margin: 0px -10px;
}
@@ -2148,29 +2353,29 @@ tr.heading h2 {
@media print
{
- #top { display: none; }
- #side-nav { display: none; }
- #nav-path { display: none; }
- body { overflow:visible; }
- h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
- .summary { display: none; }
- .memitem { page-break-inside: avoid; }
- #doc-content
- {
- margin-left:0 !important;
- height:auto !important;
- width:auto !important;
- overflow:inherit;
- display:inline;
- }
+ #top { display: none; }
+ #side-nav { display: none; }
+ #nav-path { display: none; }
+ body { overflow:visible; }
+ h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
+ .summary { display: none; }
+ .memitem { page-break-inside: avoid; }
+ #doc-content
+ {
+ margin-left:0 !important;
+ height:auto !important;
+ width:auto !important;
+ overflow:inherit;
+ display:inline;
+ }
}
/* @group Markdown */
table.markdownTable {
border-collapse:collapse;
- margin-top: 4px;
- margin-bottom: 4px;
+ margin-top: 4px;
+ margin-bottom: 4px;
}
table.markdownTable td, table.markdownTable th {
@@ -2203,11 +2408,11 @@ th.markdownTableHeadCenter, td.markdownTableBodyCenter {
tt, code, kbd
{
- display: inline-block;
+ display: inline-block;
}
tt, code, kbd
{
- vertical-align: top;
+ vertical-align: top;
}
/* @end */
@@ -2216,26 +2421,27 @@ u {
}
details>summary {
- list-style-type: none;
+ list-style-type: none;
}
details > summary::-webkit-details-marker {
- display: none;
+ display: none;
}
details>summary::before {
- content: "\25ba";
- padding-right:4px;
- font-size: 80%;
+ content: "\25ba";
+ padding-right:4px;
+ font-size: 80%;
}
details[open]>summary::before {
- content: "\25bc";
- padding-right:4px;
- font-size: 80%;
+ content: "\25bc";
+ padding-right:4px;
+ font-size: 80%;
}
-body {
+:root {
+ scrollbar-width: thin;
scrollbar-color: var(--scrollbar-thumb-color) var(--scrollbar-background-color);
}
diff --git a/docs/html/doxygen_crawl.html b/docs/html/doxygen_crawl.html
index 1a7784e..6b8ae0b 100644
--- a/docs/html/doxygen_crawl.html
+++ b/docs/html/doxygen_crawl.html
@@ -4,7 +4,7 @@
Validator / crawler helper
-
+
diff --git a/docs/html/dynsections.js b/docs/html/dynsections.js
index b05f4c8..0e15bd4 100644
--- a/docs/html/dynsections.js
+++ b/docs/html/dynsections.js
@@ -28,7 +28,6 @@ function toggleVisibility(linkObj) {
}
let dynsection = {
-
// helper function
updateStripes : function() {
$('table.directory tr').
@@ -44,15 +43,13 @@ let dynsection = {
const trigger = $('#'+base+'-trigger');
const src=$(trigger).attr('src');
if (content.is(':visible')===true) {
- content.hide();
+ content.slideUp('fast');
summary.show();
- $(linkObj).addClass('closed').removeClass('opened');
- $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png');
+ $(linkObj).find('.arrowhead').addClass('closed').removeClass('opened');
} else {
- content.show();
+ content.slideDown('fast');
summary.hide();
- $(linkObj).removeClass('closed').addClass('opened');
- $(trigger).attr('src',src.substring(0,src.length-10)+'open.png');
+ $(linkObj).find('.arrowhead').removeClass('closed').addClass('opened');
}
return false;
},
@@ -63,12 +60,12 @@ let dynsection = {
const i = $('#img'+this.id.substring(3));
const a = $('#arr'+this.id.substring(3));
if (lD3D12 Memory Allocator: Frequently asked questions
-
-
@@ -33,33 +31,22 @@
-
+
-
- Frequently asked questions
+ Frequently asked questions
What is D3D12MA?
@@ -96,18 +83,18 @@
What is the license of D3D12MA?
D3D12MA is licensed under MIT, which means it is open source and free software.
What is the purpose of D3D12MA?
-D3D12MA helps with handling one aspect of DX12 usage, which is GPU memory management - allocation of ID3D12Heap objects and creation of ID3D12Resource objects - buffers and textures.
+D3D12MA helps with handling one aspect of DX12 usage, which is GPU memory management - allocation of ID3D12Heap objects and creation of ID3D12Resource objects - buffers and textures.
Do I need to use D3D12MA?
You don't need to, but it may be beneficial in many cases. DX12 is a complex and low-level API, so libraries like this that abstract certain aspects of the API and bring them to a higher level are useful. When developing any non-trivial graphics application, you may benefit from using a memory allocator. Using D3D12MA can save time compared to implementing your own.
-In DX12 you can create each resource separately with its own implicit memory heap by calling CreateCommittedResource, but this may not be the optimal solution. For more information, see Committed versus placed resources.
+In DX12 you can create each resource separately with its own implicit memory heap by calling CreateCommittedResource, but this may not be the optimal solution. For more information, see Committed versus placed resources.
When should I not use D3D12MA?
While D3D12MA is useful for many applications that use the DX12 API, there are cases when it may be a better choice not to use it. For example, if the application is very simple, e.g. serving as a sample or a learning exercise to help you understand or teach others the basics of DX12, and it creates only a small number of buffers and textures, then including D3D12MA may be an overkill. Developing your own memory allocator may also be a good learning exercise.
What are the benefits of using D3D12MA?
-- D3D12MA allocates large blocks of
ID3D12Heap memory and sub-allocates parts of them to create your placed resources. Allocating a new block of GPU memory may be a time-consuming operation. Sub-allocating parts of a memory block requires implementing an allocation algorithm, which is a non-trivial task. D3D12MA does that, using an advanced and efficient algorithm that works well in various use cases.
+- D3D12MA allocates large blocks of ID3D12Heap memory and sub-allocates parts of them to create your placed resources. Allocating a new block of GPU memory may be a time-consuming operation. Sub-allocating parts of a memory block requires implementing an allocation algorithm, which is a non-trivial task. D3D12MA does that, using an advanced and efficient algorithm that works well in various use cases.
- D3D12MA offers a simple API that allows creating placed buffers and textures within one function call like D3D12MA::Allocator::CreateResource.
-The library is doing much more under the hood. For example, it keeps buffers separate from textures when needed, respecting D3D12_RESOURCE_HEAP_TIER. It also makes use of the "small texture alignment" automatically, so you don't need to think about it.
+The library is doing much more under the hood. For example, it keeps buffers separate from textures when needed, respecting D3D12_RESOURCE_HEAP_TIER. It also makes use of the "small texture alignment" automatically, so you don't need to think about it.
Which version should I pick?
You can just pick the latest version from the "master" branch. It is kept in a good shape most of the time, compiling and working correctly, with no compatibility-breaking changes and no unfinished code.
If you want an even more stable version, you can pick the latest official release. Current code from the master branch is occasionally tagged as a release, with CHANGELOG carefully curated to enumerate all important changes since the previous version.
@@ -119,10 +106,10 @@
I am not a fan of modern C++. Can I still use it?
Very likely yes. We acknowledge that many C++ developers, especially in the games industry, do not appreciate all the latest features that the language has to offer.
-- D3D12MA doesn't throw or catch any C++ exceptions. It reports errors by returning a
HRESULT value instead, just like DX12. If you don't use exceptions in your project, your code is not exception-safe, or even if you disable exception handling in the compiler options, you can still use D3D12MA.
-- D3D12MA doesn't use C++ run-time type information like
typeid or dynamic_cast, so if you disable RTTI in the compiler options, you can still use the library.
-- D3D12MA uses only a limited subset of standard C and C++ library. It doesn't use STL containers like
std::vector, map, or string, either in the public interface nor in the internal implementation. It implements its own containers instead.
-- If you don't use the default heap memory allocator through
malloc/free or new/delete but implement your own allocator instead, you can pass it to D3D12MA as D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks and the library will use your functions for every dynamic heap allocation made internally.
+- D3D12MA doesn't throw or catch any C++ exceptions. It reports errors by returning a HRESULT value instead, just like DX12. If you don't use exceptions in your project, your code is not exception-safe, or even if you disable exception handling in the compiler options, you can still use D3D12MA.
+- D3D12MA doesn't use C++ run-time type information like typeid or dynamic_cast, so if you disable RTTI in the compiler options, you can still use the library.
+- D3D12MA uses only a limited subset of standard C and C++ library. It doesn't use STL containers like std::vector, map, or string, either in the public interface nor in the internal implementation. It implements its own containers instead.
+- If you don't use the default heap memory allocator through malloc/free or new/delete but implement your own allocator instead, you can pass it to D3D12MA as D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks and the library will use your functions for every dynamic heap allocation made internally.
Is it available for other programming languages?
D3D12MA is a C++ library in similar style as DX12. Bindings to other programming languages are out of scope of this project, but they are welcome as external projects. Some of them are listed in README.md, "See also" section, including binding to C. Before using any of them, please check if they are still maintained and updated to use a recent version of D3D12MA.
@@ -132,7 +119,7 @@
No! While D3D12MA is published by AMD, it works on any GPU that supports DX12, whether a discrete PC graphics card or a processor integrated graphics. It doesn't give AMD GPUs any advantage over any other GPUs.
What DirectX 12 versions are supported?
D3D12MA is updated to support latest versions of DirectX 12, as available through recent retail versions of the DirectX 12 Agility SDK. Support for new features added in the preview version of the Agility SDK is developed on separate branches until they are included in the retail version.
-The library also supports older versions down to the base DX12 shipping with Windows SDK. Features added by later versions of the Agility SDK are automatically enabled conditionally using #ifdef preprocessor macros depending on the version of the SDK that you compile your project with.
+The library also supports older versions down to the base DX12 shipping with Windows SDK. Features added by later versions of the Agility SDK are automatically enabled conditionally using #ifdef preprocessor macros depending on the version of the SDK that you compile your project with.
Does it support other graphics APIs, like Vulkan(R)?
No, but we offer an equivalent library for Vulkan: Vulkan Memory Allocator. It uses the same core allocation algorithm. It also shares many features with D3D12MA, like the support for custom pools and virtual allocator. However, it is not identical in terms of the features supported. Its API also looks different, because while the interface of D3D12MA is similar in style to DX12, the interface of VMA is similar to Vulkan.
Is the library lightweight?
@@ -154,8 +141,8 @@
If you want to report a suspected bug, you can also create a ticket the same way. Before doing this, please put some effort into the investigation of whether the bug is really in the library and not in your code or in the DX12 implementation (the GPU driver) on your platform:
- Enable D3D Debug Layer and make sure it is free from any errors.
-- Make sure
D3D12MA_ASSERT is defined to an implementation that can report a failure and not ignore it.
-- Try making your allocation using pure DX12 functions like
CreateCommittedResource() rather than D3D12MA and see if the bug persists.
+- Make sure D3D12MA_ASSERT is defined to an implementation that can report a failure and not ignore it.
+- Try making your allocation using pure DX12 functions like CreateCommittedResource() rather than D3D12MA and see if the bug persists.
I found some compilation warnings. How can we fix them?
Seeing compiler warnings may be annoying to some developers, but it is a design decision to not fix all of them. Due to the nature of the C++ language, certain preprocessor macros can make some variables unused, function parameters unreferenced, or conditional expressions constant in some configurations. The code of this library should not be bigger or more complicated just to silence these warnings. It is recommended to disable such warnings instead. For more information, see Features not supported.
@@ -164,7 +151,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/files.html b/docs/html/files.html
index 0ccb6a5..5ce45bf 100644
--- a/docs/html/files.html
+++ b/docs/html/files.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: File List
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all files with brief descriptions:
[detail level 12]
- ▼ include D3D12MemAlloc.h include D3D12MemAlloc.h
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions.html b/docs/html/functions.html
index 0690bb7..e1beea4 100644
--- a/docs/html/functions.html
+++ b/docs/html/functions.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all class members with links to the classes they belong to:
-- a -
+- a -
- Alignment : D3D12MA::VIRTUAL_ALLOCATION_DESC
- Allocate() : D3D12MA::VirtualBlock
- AllocateMemory() : D3D12MA::Allocator
@@ -100,7 +87,7 @@ - a -
-- b -
+- b -
- BeginDefragmentation() : D3D12MA::Allocator, D3D12MA::Pool
- BeginPass() : D3D12MA::DefragmentationContext
- block : D3D12MA::Allocation
@@ -114,7 +101,7 @@ - b -
-- c -
+- c -
- CalculateStatistics() : D3D12MA::Allocator, D3D12MA::Pool, D3D12MA::VirtualBlock
- CALLOCATION_DESC() : D3D12MA::CALLOCATION_DESC
- Clear() : D3D12MA::VirtualBlock
@@ -134,25 +121,25 @@ - c -
-- d -
+- d -
- D3D12MA_DELETE : D3D12MA::Allocation, D3D12MA::Allocator, D3D12MA::DefragmentationContext, D3D12MA::Pool, D3D12MA::VirtualBlock
-- e -
+- e -
- EndPass() : D3D12MA::DefragmentationContext
- ExtraHeapFlags : D3D12MA::ALLOCATION_DESC
-- f -
+- f -
- Flags : D3D12MA::ALLOCATION_DESC, D3D12MA::ALLOCATOR_DESC, D3D12MA::DEFRAGMENTATION_DESC, D3D12MA::POOL_DESC, D3D12MA::VIRTUAL_ALLOCATION_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
- FreeAllocation() : D3D12MA::VirtualBlock
- FreeStatsString() : D3D12MA::Allocator, D3D12MA::VirtualBlock
-- g -
+- g -
- GetAlignment() : D3D12MA::Allocation
- GetAllocationInfo() : D3D12MA::VirtualBlock
- GetBudget() : D3D12MA::Allocator
@@ -170,7 +157,7 @@ - g -
-- h -
+- h -
- heap : D3D12MA::Allocation
- HeapFlags : D3D12MA::POOL_DESC
- HeapProperties : D3D12MA::POOL_DESC
@@ -179,7 +166,7 @@ - h -
-- i -
+- i -
- IsCacheCoherentUMA() : D3D12MA::Allocator
- IsEmpty() : D3D12MA::VirtualBlock
- IsGPUUploadHeapSupported() : D3D12MA::Allocator
@@ -187,12 +174,12 @@ - i -
-- l -
+- l -
- list : D3D12MA::Allocation
-- m -
+- m -
- m_Committed : D3D12MA::Allocation
- m_Heap : D3D12MA::Allocation
- m_Placed : D3D12MA::Allocation
@@ -206,18 +193,18 @@ - m -
-- n -
+- n -
- next : D3D12MA::Allocation
-- o -
+- o -
- Offset : D3D12MA::VIRTUAL_ALLOCATION_INFO
- Operation : D3D12MA::DEFRAGMENTATION_MOVE
-- p -
+- p -
- pAdapter : D3D12MA::ALLOCATOR_DESC
- pAllocate : D3D12MA::ALLOCATION_CALLBACKS
- pAllocationCallbacks : D3D12MA::ALLOCATOR_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
@@ -233,12 +220,12 @@ - p -
-- r -
+- r -
- ResidencyPriority : D3D12MA::POOL_DESC
-- s -
+- s -
- SetAllocationPrivateData() : D3D12MA::VirtualBlock
- SetCurrentFrameIndex() : D3D12MA::Allocator
- SetName() : D3D12MA::Allocation, D3D12MA::Pool
@@ -249,12 +236,12 @@ - s -
-- t -
+- t -
- Total : D3D12MA::TotalStatistics
-- u -
+- u -
- UnusedRangeCount : D3D12MA::DetailedStatistics
- UnusedRangeSizeMax : D3D12MA::DetailedStatistics
- UnusedRangeSizeMin : D3D12MA::DetailedStatistics
@@ -263,7 +250,7 @@ - u -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html
index 23515d8..8f38cf0 100644
--- a/docs/html/functions_func.html
+++ b/docs/html/functions_func.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members - Functions
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all functions with links to the classes they belong to:
-- a -
+- a -
- Allocate() : D3D12MA::VirtualBlock
- AllocateMemory() : D3D12MA::Allocator
-- b -
+- b -
- BeginDefragmentation() : D3D12MA::Allocator, D3D12MA::Pool
- BeginPass() : D3D12MA::DefragmentationContext
- BuildStatsString() : D3D12MA::Allocator, D3D12MA::VirtualBlock
-- c -
+- c -
- CalculateStatistics() : D3D12MA::Allocator, D3D12MA::Pool, D3D12MA::VirtualBlock
- CALLOCATION_DESC() : D3D12MA::CALLOCATION_DESC
- Clear() : D3D12MA::VirtualBlock
@@ -116,18 +103,18 @@ - c -
-- e -
+- e -
- EndPass() : D3D12MA::DefragmentationContext
-- f -
+- f -
- FreeAllocation() : D3D12MA::VirtualBlock
- FreeStatsString() : D3D12MA::Allocator, D3D12MA::VirtualBlock
-- g -
+- g -
- GetAlignment() : D3D12MA::Allocation
- GetAllocationInfo() : D3D12MA::VirtualBlock
- GetBudget() : D3D12MA::Allocator
@@ -145,7 +132,7 @@ - g -
-- i -
+- i -
- IsCacheCoherentUMA() : D3D12MA::Allocator
- IsEmpty() : D3D12MA::VirtualBlock
- IsGPUUploadHeapSupported() : D3D12MA::Allocator
@@ -153,7 +140,7 @@ - i -
-- s -
+- s -
- SetAllocationPrivateData() : D3D12MA::VirtualBlock
- SetCurrentFrameIndex() : D3D12MA::Allocator
- SetName() : D3D12MA::Allocation, D3D12MA::Pool
@@ -163,7 +150,7 @@ - s -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions_rela.html b/docs/html/functions_rela.html
index b9d0728..f21eddd 100644
--- a/docs/html/functions_rela.html
+++ b/docs/html/functions_rela.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members - Related Symbols
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/functions_vars.html b/docs/html/functions_vars.html
index f63ab83..fe4ed5f 100644
--- a/docs/html/functions_vars.html
+++ b/docs/html/functions_vars.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Members - Variables
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all variables with links to the classes they belong to:
-- a -
+- a -
- Alignment : D3D12MA::VIRTUAL_ALLOCATION_DESC
- AllocationBytes : D3D12MA::Statistics
- AllocationCount : D3D12MA::Statistics
@@ -98,7 +85,7 @@ - a -
-- b -
+- b -
- block : D3D12MA::Allocation
- BlockBytes : D3D12MA::Statistics
- BlockCount : D3D12MA::Statistics
@@ -109,22 +96,22 @@ - b -
-- c -
+- c -
- CustomPool : D3D12MA::ALLOCATION_DESC
-- e -
+- e -
- ExtraHeapFlags : D3D12MA::ALLOCATION_DESC
-- f -
+- f -
- Flags : D3D12MA::ALLOCATION_DESC, D3D12MA::ALLOCATOR_DESC, D3D12MA::DEFRAGMENTATION_DESC, D3D12MA::POOL_DESC, D3D12MA::VIRTUAL_ALLOCATION_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
-- h -
+- h -
- heap : D3D12MA::Allocation
- HeapFlags : D3D12MA::POOL_DESC
- HeapProperties : D3D12MA::POOL_DESC
@@ -133,12 +120,12 @@ - h -
-- l -
+- l -
- list : D3D12MA::Allocation
-- m -
+- m -
- m_Committed : D3D12MA::Allocation
- m_Heap : D3D12MA::Allocation
- m_Placed : D3D12MA::Allocation
@@ -152,18 +139,18 @@ - m -
-- n -
+- n -
- next : D3D12MA::Allocation
-- o -
+- o -
- Offset : D3D12MA::VIRTUAL_ALLOCATION_INFO
- Operation : D3D12MA::DEFRAGMENTATION_MOVE
-- p -
+- p -
- pAdapter : D3D12MA::ALLOCATOR_DESC
- pAllocate : D3D12MA::ALLOCATION_CALLBACKS
- pAllocationCallbacks : D3D12MA::ALLOCATOR_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
@@ -179,23 +166,23 @@ - p -
-- r -
+- r -
- ResidencyPriority : D3D12MA::POOL_DESC
-- s -
+- s -
- Size : D3D12MA::VIRTUAL_ALLOCATION_DESC, D3D12MA::VIRTUAL_ALLOCATION_INFO, D3D12MA::VIRTUAL_BLOCK_DESC
- Stats : D3D12MA::Budget, D3D12MA::DetailedStatistics
-- t -
+- t -
- Total : D3D12MA::TotalStatistics
-- u -
+- u -
- UnusedRangeCount : D3D12MA::DetailedStatistics
- UnusedRangeSizeMax : D3D12MA::DetailedStatistics
- UnusedRangeSizeMin : D3D12MA::DetailedStatistics
@@ -204,7 +191,7 @@ - u -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/general_considerations.html b/docs/html/general_considerations.html
index ef3888a..05a30ff 100644
--- a/docs/html/general_considerations.html
+++ b/docs/html/general_considerations.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: General considerations
-
-
@@ -33,33 +31,22 @@
-
+
-
- General considerations
+ General considerations
-
+
Thread safety
-- The library has no global state, so separate D3D12MA::Allocator objects can be used independently. In typical applications there should be no need to create multiple such objects though - one per
ID3D12Device is enough.
+- The library has no global state, so separate D3D12MA::Allocator objects can be used independently. In typical applications there should be no need to create multiple such objects though - one per ID3D12Device is enough.
- All calls to methods of D3D12MA::Allocator class are safe to be made from multiple threads simultaneously because they are synchronized internally when needed.
- When the allocator is created with D3D12MA::ALLOCATOR_FLAG_SINGLETHREADED, calls to methods of D3D12MA::Allocator class must be made from a single thread or synchronized by the user. Using this flag may improve performance.
- D3D12MA::VirtualBlock is not safe to be used from multiple threads simultaneously.
-
+
Versioning and compatibility
The library uses Semantic Versioning, which means version numbers follow convention: Major.Minor.Patch (e.g. 2.3.0), where:
@@ -109,13 +96,13 @@ <
All changes between official releases are documented in file "CHANGELOG.md".
- Warning
- Backward compatiblity is considered on the level of C++ source code, not binary linkage. Adding new members to existing structures is treated as backward compatible if initializing the new members to binary zero results in the old behavior. You should always fully initialize all library structures to zeros and not rely on their exact binary size.
-
+
Features not supported
Features deliberately excluded from the scope of this library:
- Descriptor allocation. Although also called "heaps", objects that represent descriptors are separate part of the D3D12 API from buffers and textures. You can still use Virtual allocator to manage descriptors and their ranges inside a descriptor heap.
- Support for reserved (tiled) resources. We don't recommend using them. For more information, see [1].
-- Support for
ID3D12Device::Evict and MakeResident. We don't recommend using them. You can call them on the D3D12 objects manually. Plese keep in mind, however, that eviction happens on the level of entire ID3D12Heap memory blocks and not individual buffers or textures which may be placed inside them.
+- Support for ID3D12Device::Evict and MakeResident. We don't recommend using them. You can call them on the D3D12 objects manually. Plese keep in mind, however, that eviction happens on the level of entire ID3D12Heap memory blocks and not individual buffers or textures which may be placed inside them.
- Handling CPU memory allocation failures. When dynamically creating small C++ objects in CPU memory (not the GPU memory), allocation failures are not handled gracefully, because that would complicate code significantly and is usually not needed in desktop PC applications anyway. Success of an allocation is just checked with an assert.
- Code free of any compiler warnings. There are many preprocessor macros that make some variables unused, function parameters unreferenced, or conditional expressions constant in some configurations. The code of this library should not be bigger or more complicated just to silence these warnings. It is recommended to disable such warnings instead.
- This is a C++ library. Bindings or ports to any other programming languages are welcome as external projects but are not going to be included into this repository.
@@ -125,7 +112,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/globals.html b/docs/html/globals.html
index 00f8dbd..27989c1 100644
--- a/docs/html/globals.html
+++ b/docs/html/globals.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: File Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/globals_defs.html b/docs/html/globals_defs.html
index feb2e5c..00db10d 100644
--- a/docs/html/globals_defs.html
+++ b/docs/html/globals_defs.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: File Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html
index 292f556..5785855 100644
--- a/docs/html/hierarchy.html
+++ b/docs/html/hierarchy.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Hierarchy
-
-
@@ -33,35 +31,24 @@
-
+
-
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 12]
CD3D12MA::ALLOCATION_CALLBACKS Custom callbacks to CPU memory allocation functions ▼CD3D12MA::ALLOCATION_DESC Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource CD3D12MA::ALLOCATION_DESC Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource CD3D12MA::CALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure CD3D12MA::ALLOCATOR_DESC Parameters of created Allocator object. To be used with CreateAllocator() CD3D12MA::Budget Statistics of current memory usage and available budget for a specific memory segment group CD3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Parameters for incremental defragmentation steps CD3D12MA::DEFRAGMENTATION_STATS Statistics returned for defragmentation process by function DefragmentationContext::GetStats() CD3D12MA::DetailedStatistics More detailed statistics than D3D12MA::Statistics ▼CIUnknownImpl CIUnknownImpl CD3D12MA::Allocation Represents single memory allocation CD3D12MA::Allocator Represents main object of this library initialized for particular ID3D12Device CD3D12MA::Allocator Represents main object of this library initialized for particular ID3D12Device CD3D12MA::DefragmentationContext Represents defragmentation process in progress CD3D12MA::Pool Custom memory pool CD3D12MA::VirtualBlock Represents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory ▼CD3D12MA::POOL_DESC Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool CD3D12MA::POOL_DESC Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool CD3D12MA::CPOOL_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure CD3D12MA::Statistics Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total CD3D12MA::TotalStatistics General statistics from current state of the allocator - total memory usage across all memory heaps and segments ▼CD3D12MA::VIRTUAL_ALLOCATION_DESC Parameters of created virtual allocation to be passed to VirtualBlock::Allocate() CD3D12MA::VIRTUAL_ALLOCATION_DESC Parameters of created virtual allocation to be passed to VirtualBlock::Allocate() CD3D12MA::CVIRTUAL_ALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure CD3D12MA::VIRTUAL_ALLOCATION_INFO Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo() ▼CD3D12MA::VIRTUAL_BLOCK_DESC Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock() CD3D12MA::VIRTUAL_BLOCK_DESC Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock() CD3D12MA::CVIRTUAL_BLOCK_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure CD3D12MA::VirtualAllocation Represents single memory allocation done inside VirtualBlock
@@ -120,7 +107,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/index.html b/docs/html/index.html
index e005026..d7434ba 100644
--- a/docs/html/index.html
+++ b/docs/html/index.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12 Memory Allocator
-
-
@@ -33,35 +31,24 @@
-
+
-
D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved.
License: MIT
-Documentation of all members: D3D12MemAlloc.h
-
+
Documentation of all members: D3D12MemAlloc.h
+
Table of contents
- Frequently asked questions
@@ -131,10 +118,10 @@
-
+
Web links
-- Direct3D 12 Memory Allocator at GPUOpen.com - product page
+- Direct3D 12 Memory Allocator at GPUOpen.com - product page
- GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com - source code repository
@@ -142,7 +129,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/linear_algorithm.html b/docs/html/linear_algorithm.html
index 25d5301..0bc59b0 100644
--- a/docs/html/linear_algorithm.html
+++ b/docs/html/linear_algorithm.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Linear allocation algorithm
-
-
@@ -33,33 +31,22 @@
-
+
-
- Linear allocation algorithm
+ Linear allocation algorithm
Each D3D12 memory block managed by this library has accompanying metadata that keeps track of used and unused regions. By default, the metadata structure and algorithm tries to find best place for new allocations among free regions to optimize memory usage. This way you can allocate and free objects in any order.
@@ -96,17 +83,17 @@
Sometimes there is a need to use simpler, linear allocation algorithm. You can create custom pool that uses such algorithm by adding flag D3D12MA::POOL_FLAG_ALGORITHM_LINEAR to D3D12MA::POOL_DESC::Flags while creating D3D12MA::Pool object. Then an alternative metadata management is used. It always creates new allocations after last one and doesn't reuse free regions after allocations freed in the middle. It results in better allocation performance and less memory consumed by metadata.
With this one flag, you can create a custom pool that can be used in many ways: free-at-once, stack, double stack, and ring buffer. See below for details. You don't need to specify explicitly which of these options you are going to use - it is detected automatically.
-
+
Free-at-once
-
In a pool that uses linear algorithm, you still need to free all the allocations individually by calling allocation->Release(). You can free them in any order. New allocations are always made after last one - free space in the middle is not reused. However, when you release all the allocation and the pool becomes empty, allocation starts from the beginning again. This way you can use linear algorithm to speed up creation of allocations that you are going to release all at once.
+In a pool that uses linear algorithm, you still need to free all the allocations individually by calling allocation->Release(). You can free them in any order. New allocations are always made after last one - free space in the middle is not reused. However, when you release all the allocation and the pool becomes empty, allocation starts from the beginning again. This way you can use linear algorithm to speed up creation of allocations that you are going to release all at once.
This mode is also available for pools created with D3D12MA::POOL_DESC::MaxBlockCount value that allows multiple memory blocks.
-
+
Stack
When you free an allocation that was created last, its space can be reused. Thanks to this, if you always release allocations in the order opposite to their creation (LIFO - Last In First Out), you can achieve behavior of a stack.
This mode is also available for pools created with D3D12MA::POOL_DESC::MaxBlockCount value that allows multiple memory blocks.
-
+
Double stack
The space reserved by a custom pool with linear algorithm may be used by two stacks:
@@ -116,20 +103,20 @@
To make allocation from the upper stack, add flag D3D12MA::ALLOCATION_FLAG_UPPER_ADDRESS to D3D12MA::ALLOCATION_DESC::Flags.
Double stack is available only in pools with one memory block - D3D12MA::POOL_DESC::MaxBlockCount must be 1. Otherwise behavior is undefined.
-When the two stacks' ends meet so there is not enough space between them for a new allocation, such allocation fails with usual E_OUTOFMEMORY error.
-
+
When the two stacks' ends meet so there is not enough space between them for a new allocation, such allocation fails with usual E_OUTOFMEMORY error.
+
Ring buffer
When you free some allocations from the beginning and there is not enough free space for a new one at the end of a pool, allocator's "cursor" wraps around to the beginning and starts allocation there. Thanks to this, if you always release allocations in the same order as you created them (FIFO - First In First Out), you can achieve behavior of a ring buffer / queue.
Ring buffer is available only in pools with one memory block - D3D12MA::POOL_DESC::MaxBlockCount must be 1. Otherwise behavior is undefined.
-
+
Additional considerations
Linear algorithm can also be used with Virtual allocator. See flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/menu.js b/docs/html/menu.js
index 0fd1e99..15f9c52 100644
--- a/docs/html/menu.js
+++ b/docs/html/menu.js
@@ -49,7 +49,7 @@ function initMenu(relPath,searchEnabled,serverSide,searchPage,search,treeview) {
searchBoxHtml=''+
''+
'');
$('#main-nav').append(makeTree(menudata,relPath));
$('#main-nav').children(':first').addClass('sm sm-dox').attr('id','main-menu');
- if (searchBoxHtml) {
- $('#main-menu').append('');
- }
+ $('#main-menu').append('');
const $mainMenuState = $('#main-menu-state');
let prevWidth = 0;
if ($mainMenuState.length) {
diff --git a/docs/html/namespace_d3_d12_m_a.html b/docs/html/namespace_d3_d12_m_a.html
index e770fdc..b4ae5de 100644
--- a/docs/html/namespace_d3_d12_m_a.html
+++ b/docs/html/namespace_d3_d12_m_a.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA Namespace Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
-
+
Classes
class Allocation class Allocation Represents single memory allocation. More...
struct ALLOCATION_CALLBACKS struct ALLOCATION_CALLBACKS Custom callbacks to CPU memory allocation functions. More...
struct ALLOCATION_DESC struct ALLOCATION_DESC Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource. More...
class Allocator Represents main object of this library initialized for particular ID3D12Device. More...
struct ALLOCATOR_DESC class Allocator Represents main object of this library initialized for particular ID3D12Device. More...
struct ALLOCATOR_DESC Parameters of created Allocator object. To be used with CreateAllocator(). More...
struct Budget struct Budget Statistics of current memory usage and available budget for a specific memory segment group. More...
struct CALLOCATION_DESC struct CALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure. More...
struct CPOOL_DESC struct CPOOL_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure. More...
struct CVIRTUAL_ALLOCATION_DESC struct CVIRTUAL_ALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure. More...
struct CVIRTUAL_BLOCK_DESC struct CVIRTUAL_BLOCK_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure. More...
struct DEFRAGMENTATION_DESC struct DEFRAGMENTATION_DESC Parameters for defragmentation. More...
struct DEFRAGMENTATION_MOVE struct DEFRAGMENTATION_MOVE Single move of an allocation to be done for defragmentation. More...
struct DEFRAGMENTATION_PASS_MOVE_INFO struct DEFRAGMENTATION_PASS_MOVE_INFO Parameters for incremental defragmentation steps. More...
struct DEFRAGMENTATION_STATS struct DEFRAGMENTATION_STATS Statistics returned for defragmentation process by function DefragmentationContext::GetStats(). More...
class DefragmentationContext class DefragmentationContext Represents defragmentation process in progress. More...
struct DetailedStatistics struct DetailedStatistics More detailed statistics than D3D12MA::Statistics. More...
class Pool class Pool Custom memory pool. More...
struct POOL_DESC struct POOL_DESC Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool. More...
struct Statistics struct Statistics Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total. More...
struct TotalStatistics struct TotalStatistics General statistics from current state of the allocator - total memory usage across all memory heaps and segments. More...
struct VIRTUAL_ALLOCATION_DESC struct VIRTUAL_ALLOCATION_DESC Parameters of created virtual allocation to be passed to VirtualBlock::Allocate(). More...
struct VIRTUAL_ALLOCATION_INFO struct VIRTUAL_ALLOCATION_INFO Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo(). More...
struct VIRTUAL_BLOCK_DESC struct VIRTUAL_BLOCK_DESC Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock(). More...
struct VirtualAllocation struct VirtualAllocation Represents single memory allocation done inside VirtualBlock. More...
class VirtualBlock class VirtualBlock Represents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory. More...
-
+
Typedefs
typedef UINT64 AllocHandle Unique identifier of single allocation done inside the memory heap.
using ALLOCATE_FUNC_PTR = void* (*)(size_t Size, size_t Alignment, void* pPrivateData) Pointer to custom callback function that allocates CPU memory.
using FREE_FUNC_PTR = void (*)(void* pMemory, void* pPrivateData) Pointer to custom callback function that deallocates CPU memory.
-
+
Enumerations
enum ALLOCATION_FLAGS {
ALLOCATION_FLAG_NONE = 0
@@ -203,20 +162,17 @@
} Bit flags to be used with ALLOCATION_DESC::Flags. More...
enum DEFRAGMENTATION_FLAGS { DEFRAGMENTATION_FLAG_ALGORITHM_FAST = 0x1
, DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED = 0x2
, DEFRAGMENTATION_FLAG_ALGORITHM_FULL = 0x4
, DEFRAGMENTATION_FLAG_ALGORITHM_MASK
} Flags to be passed as DEFRAGMENTATION_DESC::Flags. More...
enum DEFRAGMENTATION_MOVE_OPERATION { DEFRAGMENTATION_MOVE_OPERATION_COPY = 0
, DEFRAGMENTATION_MOVE_OPERATION_IGNORE = 1
, DEFRAGMENTATION_MOVE_OPERATION_DESTROY = 2
} Operation performed on single defragmentation move. More...
enum POOL_FLAGS {
POOL_FLAG_NONE = 0
, POOL_FLAG_ALGORITHM_LINEAR = 0x1
@@ -227,7 +183,6 @@
} Bit flags to be used with POOL_DESC::Flags. More...
enum ALLOCATOR_FLAGS {
ALLOCATOR_FLAG_NONE = 0
, ALLOCATOR_FLAG_SINGLETHREADED = 0x1
@@ -239,13 +194,11 @@
} Bit flags to be used with ALLOCATOR_DESC::Flags. More...
enum VIRTUAL_BLOCK_FLAGS { VIRTUAL_BLOCK_FLAG_NONE = 0
, VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR = POOL_FLAG_ALGORITHM_LINEAR
, VIRTUAL_BLOCK_FLAG_ALGORITHM_MASK = POOL_FLAG_ALGORITHM_MASK
} Bit flags to be used with VIRTUAL_BLOCK_DESC::Flags. More...
enum VIRTUAL_ALLOCATION_FLAGS {
VIRTUAL_ALLOCATION_FLAG_NONE = 0
, VIRTUAL_ALLOCATION_FLAG_UPPER_ADDRESS = ALLOCATION_FLAG_UPPER_ADDRESS
@@ -257,18 +210,15 @@
} Bit flags to be used with VIRTUAL_ALLOCATION_DESC::Flags. More...
-
+
Functions
D3D12MA_API HRESULT CreateAllocator (const ALLOCATOR_DESC *pDesc, Allocator **ppAllocator) Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
D3D12MA_API HRESULT CreateVirtualBlock (const VIRTUAL_BLOCK_DESC *pDesc, VirtualBlock **ppVirtualBlock) Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
-Typedef Documentation
+Typedef Documentation
◆ ALLOCATE_FUNC_PTR
@@ -314,11 +264,11 @@
Pointer to custom callback function that deallocates CPU memory.
-pMemory = null should be accepted and ignored.
+pMemory = null should be accepted and ignored.
-Enumeration Type Documentation
+Enumeration Type Documentation
◆ ALLOCATION_FLAGS
@@ -338,21 +288,21 @@ ALLOCATION_FLAG_COMMITTED Set this flag if the allocation should have its own dedicated memory allocation (committed resource with implicit heap).
Use it for special, big resources, like fullscreen textures used as render targets.
-- When used with functions like D3D12MA::Allocator::CreateResource, it will use
ID3D12Device::CreateCommittedResource, so the created allocation will contain a resource (D3D12MA::Allocation::GetResource() != NULL) but will not have a heap (D3D12MA::Allocation::GetHeap() == NULL), as the heap is implicit.
-- When used with raw memory allocation like D3D12MA::Allocator::AllocateMemory, it will use
ID3D12Device::CreateHeap, so the created allocation will contain a heap (D3D12MA::Allocation::GetHeap() != NULL) and its offset will always be 0.
+- When used with functions like D3D12MA::Allocator::CreateResource, it will use ID3D12Device::CreateCommittedResource, so the created allocation will contain a resource (D3D12MA::Allocation::GetResource() != NULL) but will not have a heap (D3D12MA::Allocation::GetHeap() == NULL), as the heap is implicit.
+- When used with raw memory allocation like D3D12MA::Allocator::AllocateMemory, it will use ID3D12Device::CreateHeap, so the created allocation will contain a heap (D3D12MA::Allocation::GetHeap() != NULL) and its offset will always be 0.
ALLOCATION_FLAG_NEVER_ALLOCATE Set this flag to only try to allocate from existing memory heaps and never create new such heap.
-If new allocation cannot be placed in any of the existing heaps, allocation fails with E_OUTOFMEMORY error.
+If new allocation cannot be placed in any of the existing heaps, allocation fails with E_OUTOFMEMORY error.
You should not use D3D12MA::ALLOCATION_FLAG_COMMITTED and D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE at the same time. It makes no sense.
ALLOCATION_FLAG_WITHIN_BUDGET Create allocation only if additional memory required for it, if any, won't exceed memory budget. Otherwise return E_OUTOFMEMORY.
+ALLOCATION_FLAG_WITHIN_BUDGET Create allocation only if additional memory required for it, if any, won't exceed memory budget. Otherwise return E_OUTOFMEMORY.
ALLOCATION_FLAG_UPPER_ADDRESS Allocation will be created from upper stack in a double stack pool.
This flag is only allowed for custom pools created with POOL_FLAG_ALGORITHM_LINEAR flag.
ALLOCATION_FLAG_CAN_ALIAS Set this flag if the allocated memory will have aliasing resources.
-Use this when calling D3D12MA::Allocator::CreateResource() and similar to guarantee creation of explicit heap for desired allocation and prevent it from using CreateCommittedResource, so that new allocation object will always have allocation->GetHeap() != NULL.
+Use this when calling D3D12MA::Allocator::CreateResource() and similar to guarantee creation of explicit heap for desired allocation and prevent it from using CreateCommittedResource, so that new allocation object will always have allocation->GetHeap() != NULL.
ALLOCATION_FLAG_STRATEGY_MIN_MEMORY Allocation strategy that chooses smallest possible free range for the allocation to minimize memory usage and fragmentation, possibly at the expense of allocation time.
ALLOCATION_FLAG_STRATEGY_FIRST_FIT Alias to ALLOCATION_FLAG_STRATEGY_MIN_TIME.
ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
+ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
ALLOCATOR_FLAG_ALWAYS_COMMITTED Every allocation will be created as a committed resource - will have its own memory block.
Affects both default pools and custom pools. To be used for debugging purposes only. There is also an equivalent flag for custom pools: D3D12MA::POOL_FLAG_ALWAYS_COMMITTED.
ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED Heaps created for the default pools will be created with flag D3D12_HEAP_FLAG_CREATE_NOT_ZEROED, allowing for their memory to be not zeroed by the system if possible, which can speed up allocation.
+ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED Heaps created for the default pools will be created with flag D3D12_HEAP_FLAG_CREATE_NOT_ZEROED, allowing for their memory to be not zeroed by the system if possible, which can speed up allocation.
Only affects default pools. To use the flag with Custom memory pools, you need to add it manually:
poolDesc.heapFlags |= D3D12_HEAP_FLAG_CREATE_NOT_ZEROED;
-Only avaiable if ID3D12Device8 is present. Otherwise, the flag is ignored.
+Only avaiable if ID3D12Device8 is present. Otherwise, the flag is ignored.
ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED Optimization, allocate MSAA textures as committed resources always.
Specify this flag to create MSAA textures with implicit heaps, as if they were created with flag D3D12MA::ALLOCATION_FLAG_COMMITTED. Usage of this flags enables all default pools to create its heaps on smaller alignment not suitable for MSAA textures.
@@ -424,11 +374,11 @@
Enumerator DEFRAGMENTATION_FLAG_ALGORITHM_FAST Use simple but fast algorithm for defragmentation. May not achieve best results but will require least time to compute and least allocations to copy.
DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED Default defragmentation algorithm, applied also when no ALGORITHM flag is specified. Offers a balance between defragmentation quality and the amount of allocations and bytes that need to be moved.
+DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED Default defragmentation algorithm, applied also when no ALGORITHM flag is specified. Offers a balance between defragmentation quality and the amount of allocations and bytes that need to be moved.
DEFRAGMENTATION_FLAG_ALGORITHM_FULL Perform full defragmentation of memory. Can result in notably more time to compute and allocations to copy, but will achieve best memory packing.
DEFRAGMENTATION_FLAG_ALGORITHM_MASK A bit mask to extract only ALGORITHM bits from entire set of flags.
+DEFRAGMENTATION_FLAG_ALGORITHM_MASK A bit mask to extract only ALGORITHM bits from entire set of flags.
-Enumerator DEFRAGMENTATION_MOVE_OPERATION_COPY Resource has been recreated at pDstTmpAllocation, data has been copied, old resource has been destroyed. pSrcAllocation will be changed to point to the new place. This is the default value set by DefragmentationContext::BeginPass().
+Enumerator DEFRAGMENTATION_MOVE_OPERATION_COPY Resource has been recreated at pDstTmpAllocation, data has been copied, old resource has been destroyed. pSrcAllocation will be changed to point to the new place. This is the default value set by DefragmentationContext::BeginPass().
DEFRAGMENTATION_MOVE_OPERATION_IGNORE Set this value if you cannot move the allocation. New place reserved at pDstTmpAllocation will be freed. pSrcAllocation will remain unchanged.
+DEFRAGMENTATION_MOVE_OPERATION_IGNORE Set this value if you cannot move the allocation. New place reserved at pDstTmpAllocation will be freed. pSrcAllocation will remain unchanged.
DEFRAGMENTATION_MOVE_OPERATION_DESTROY Set this value if you decide to abandon the allocation and you destroyed the resource. New place reserved pDstTmpAllocation will be freed, along with pSrcAllocation.
+DEFRAGMENTATION_MOVE_OPERATION_DESTROY Set this value if you decide to abandon the allocation and you destroyed the resource. New place reserved pDstTmpAllocation will be freed, along with pSrcAllocation.
VIRTUAL_ALLOCATION_FLAG_STRATEGY_MIN_OFFSET
Allocation strategy that chooses always the lowest offset in available space. This is not the most efficient strategy but achieves highly packed data.
VIRTUAL_ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
+VIRTUAL_ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
These strategy flags are binary compatible with equivalent flags in ALLOCATION_FLAGS.
Function Documentation
+Function Documentation
◆ CreateAllocator()
@@ -567,8 +517,8 @@
-Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
-You normally only need to call it once and keep a single Allocator object for your ID3D12Device.
+Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
+You normally only need to call it once and keep a single Allocator object for your ID3D12Device.
@@ -591,7 +541,7 @@
-Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
+Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
Note you don't need to create D3D12MA::Allocator to use virtual blocks.
@@ -599,7 +549,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers.html b/docs/html/namespacemembers.html
index 6881ab0..4cadc29 100644
--- a/docs/html/namespacemembers.html
+++ b/docs/html/namespacemembers.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all namespace members with links to the namespace documentation for each member:
-- a -
+- a -
- ALLOCATE_FUNC_PTR : D3D12MA
- ALLOCATION_FLAG_CAN_ALIAS : D3D12MA
- ALLOCATION_FLAG_COMMITTED : D3D12MA
@@ -112,13 +99,13 @@ - a -
-- c -
+- c -
-- d -
+- d -
- DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FAST : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FULL : D3D12MA
@@ -131,12 +118,12 @@ - d -
-- f -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_enum.html b/docs/html/namespacemembers_enum.html
index 5723a6b..90ffd55 100644
--- a/docs/html/namespacemembers_enum.html
+++ b/docs/html/namespacemembers_enum.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_eval.html b/docs/html/namespacemembers_eval.html
index 365527c..4a4922b 100644
--- a/docs/html/namespacemembers_eval.html
+++ b/docs/html/namespacemembers_eval.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
Here is a list of all namespace enum values with links to the namespace documentation for each enum value:
-- a -
+- a -
- ALLOCATION_FLAG_CAN_ALIAS : D3D12MA
- ALLOCATION_FLAG_COMMITTED : D3D12MA
- ALLOCATION_FLAG_NEVER_ALLOCATE : D3D12MA
@@ -108,7 +95,7 @@ - a -
-- d -
+- d -
- DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FAST : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FULL : D3D12MA
@@ -119,7 +106,7 @@ - d -
-- p -
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_func.html b/docs/html/namespacemembers_func.html
index 02a9cdd..c8a70c7 100644
--- a/docs/html/namespacemembers_func.html
+++ b/docs/html/namespacemembers_func.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers_type.html b/docs/html/namespacemembers_type.html
index b56e9c4..e9561e2 100644
--- a/docs/html/namespacemembers_type.html
+++ b/docs/html/namespacemembers_type.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespaces.html b/docs/html/namespaces.html
index fe8ddce..acd9768 100644
--- a/docs/html/namespaces.html
+++ b/docs/html/namespaces.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace List
-
-
@@ -33,35 +31,24 @@
-
+
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/navtree.css b/docs/html/navtree.css
index 69211d4..0ea3a07 100644
--- a/docs/html/navtree.css
+++ b/docs/html/navtree.css
@@ -11,8 +11,8 @@
#nav-tree li {
white-space:nowrap;
- margin:0px;
- padding:0px;
+ margin:0;
+ padding:0;
}
#nav-tree .plus {
@@ -20,15 +20,10 @@
}
#nav-tree .selected {
- background-image: url('tab_a.png');
- background-repeat:repeat-x;
- color: var(--nav-text-active-color);
- text-shadow: var(--nav-text-active-shadow);
-}
-
-#nav-tree .selected .arrow {
- color: var(--nav-arrow-selected-color);
- text-shadow: none;
+ position: relative;
+ background-color: var(--nav-menu-active-bg);
+ border-radius: 0 6px 6px 0;
+ /*margin-right: 5px;*/
}
#nav-tree img {
@@ -48,6 +43,7 @@
margin:0px;
padding:0px;
font: 12px var(--font-family-nav);
+ line-height: 22px;
}
#nav-tree .label a {
@@ -56,7 +52,7 @@
#nav-tree .selected a {
text-decoration:none;
- color:var(--nav-text-active-color);
+ color:var(--page-link-color);
}
#nav-tree .children_ul {
@@ -65,8 +61,9 @@
}
#nav-tree .item {
- margin:0px;
- padding:0px;
+ margin: 0 6px 0 -5px;
+ padding: 0 0 0 5px;
+ height: 22px;
}
#nav-tree {
@@ -89,7 +86,6 @@
display:block;
position: absolute;
left: 0px;
- width: $width;
overflow : hidden;
}
@@ -98,15 +94,31 @@
}
.ui-resizable-e {
- background-image:var(--nav-splitbar-image);
- background-size:100%;
- background-repeat:repeat-y;
- background-attachment: scroll;
- cursor:ew-resize;
+ transition: opacity 0.5s ease;
+ background-color: var(--nav-splitbar-bg-color);
+ opacity:0;
+ cursor:col-resize;
height:100%;
right:0;
top:0;
width:6px;
+ position: relative;
+}
+
+.ui-resizable-e:after {
+ content: '';
+ display: block;
+ top: 50%;
+ left: 1px;
+ width: 2px;
+ height: 15px;
+ border-left: 1px solid var(--nav-splitbar-handle-color);
+ border-right: 1px solid var(--nav-splitbar-handle-color);
+ position: absolute;
+}
+
+.ui-resizable-e:hover {
+ opacity: 1;
}
.ui-resizable-handle {
@@ -121,24 +133,97 @@
}
#nav-tree {
- background-repeat:repeat-x;
background-color: var(--nav-background-color);
-webkit-overflow-scrolling : touch; /* iOS 5+ */
+ scrollbar-width: thin;
+ border-right: 1px solid var(--nav-border-color);
+ padding-left: 5px;
}
#nav-sync {
position:absolute;
- top:5px;
- right:24px;
- z-index:0;
+ top:0px;
+ right:0px;
+ z-index:1;
}
#nav-sync img {
opacity:0.3;
}
-#nav-sync img:hover {
- opacity:0.9;
+div.nav-sync-icon {
+ position: relative;
+ width: 24px;
+ height: 17px;
+ left: -6px;
+ top: -1px;
+ opacity: 0.7;
+ display: inline-block;
+ background-color: var(--sync-icon-background-color);
+ border: 1px solid var(--sync-icon-border-color);
+ box-sizing: content-box;
+}
+
+div.nav-sync-icon:hover {
+ background-color: var(--sync-icon-selected-background-color);
+ opacity: 1.0;
+}
+
+div.nav-sync-icon.active:after {
+ content: '';
+ background-color: var(--sync-icon-background-color);
+ border-top: 2px solid var(--sync-icon-color);
+ position: absolute;
+ width: 16px;
+ height: 0px;
+ top: 7px;
+ left: 4px;
+}
+
+div.nav-sync-icon.active:hover:after {
+ border-top: 2px solid var(--sync-icon-selected-color);
+}
+
+span.sync-icon-left {
+ position: absolute;
+ padding: 0;
+ margin: 0;
+ top: 3px;
+ left: 4px;
+ display: inline-block;
+ width: 8px;
+ height: 8px;
+ border-left: 2px solid var(--sync-icon-color);
+ border-top: 2px solid var(--sync-icon-color);
+ transform: rotate(-45deg);
+}
+
+span.sync-icon-right {
+ position: absolute;
+ padding: 0;
+ margin: 0;
+ top: 3px;
+ left: 10px;
+ display: inline-block;
+ width: 8px;
+ height: 8px;
+ border-right: 2px solid var(--sync-icon-color);
+ border-bottom: 2px solid var(--sync-icon-color);
+ transform: rotate(-45deg);
+}
+
+div.nav-sync-icon:hover span.sync-icon-left {
+ border-left: 2px solid var(--sync-icon-selected-color);
+ border-top: 2px solid var(--sync-icon-selected-color);
+}
+
+div.nav-sync-icon:hover span.sync-icon-right {
+ border-right: 2px solid var(--sync-icon-selected-color);
+ border-bottom: 2px solid var(--sync-icon-selected-color);
+}
+
+#nav-path ul {
+ border-top: 1px solid var(--nav-breadcrumb-separator-color);
}
@media print
@@ -147,3 +232,96 @@
div.ui-resizable-handle { display: none; position: relative; }
}
+/*---------------------------*/
+#container {
+ display: grid;
+ grid-template-columns: auto auto;
+ overflow: hidden;
+}
+
+#page-nav {
+ background: var(--nav-background-color);
+ display: block;
+ width: 250px;
+ box-sizing: content-box;
+ position: relative;
+ border-left: 1px solid var(--nav-border-color);
+}
+
+#page-nav-tree {
+ display: inline-block;
+}
+
+#page-nav-resize-handle {
+ transition: opacity 0.5s ease;
+ background-color: var(--nav-splitbar-bg-color);
+ opacity:0;
+ cursor:col-resize;
+ height:100%;
+ right:0;
+ top:0;
+ width:6px;
+ position: relative;
+ z-index: 1;
+ user-select: none;
+}
+
+#page-nav-resize-handle:after {
+ content: '';
+ display: block;
+ top: 50%;
+ left: 1px;
+ width: 2px;
+ height: 15px;
+ border-left: 1px solid var(--nav-splitbar-handle-color);
+ border-right: 1px solid var(--nav-splitbar-handle-color);
+ position: absolute;
+}
+
+#page-nav-resize-handle.dragging,
+#page-nav-resize-handle:hover {
+ opacity: 1;
+}
+
+#page-nav-contents {
+ padding: 0;
+ margin: 0;
+ display: block;
+ top: 0;
+ left: 0;
+ height: 100%;
+ width: 100%;
+ position: absolute;
+ overflow: auto;
+ scrollbar-width: thin;
+ -webkit-overflow-scrolling : touch; /* iOS 5+ */
+}
+
+ul.page-outline,
+ul.page-outline ul {
+ text-indent: 0;
+ list-style: none outside none;
+ padding: 0 0 0 4px;
+}
+
+ul.page-outline {
+ margin: 0 4px 4px 6px;
+}
+
+ul.page-outline div.item {
+ font: 12px var(--font-family-nav);
+ line-height: 22px;
+}
+
+ul.page-outline li {
+ white-space: nowrap;
+}
+
+ul.page-outline li.vis {
+ background-color: var(--nav-breadcrumb-active-bg);
+}
+
+#container.resizing {
+ cursor: col-resize;
+ user-select: none;
+}
diff --git a/docs/html/optimal_allocation.html b/docs/html/optimal_allocation.html
index 627471c..88f3e62 100644
--- a/docs/html/optimal_allocation.html
+++ b/docs/html/optimal_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Optimal resource allocation
-
-
@@ -33,33 +31,22 @@
-
+
-
- Optimal resource allocation
+ Optimal resource allocation
This library tries to automatically make optimal choices for the resources you create, so you don't need to care about them. There are some advanced features of Direct3D 12 that you may use to optimize your memory management. There are also some settings in D3D12MA that you may change to alter its default behavior. This page provides miscellaneous advice about features of D3D12 and D3D12MA that are non-essential, but may improve the stability or performance of your app.
-
+
Avoiding running out of memory
When trying to allocate more memory than available in the current heap (e.g., video memory on the graphics card, system memory), one of few bad things can happen:
-- The allocation (resource creation) function call can fail with
HRESULT value other than S_OK.
+- The allocation (resource creation) function call can fail with HRESULT value other than S_OK.
- The allocation may succeed, but take long time (even a significant fraction of a second).
- Some resources are automatically demoted from video memory to system memory, degrading the app performance.
- Even a crash of the entire graphics driver can happen, resulting in the D3D12 "device removal", which is usually catastrophic for the application.
@@ -113,34 +100,34 @@ Statistics of current memory usage and available budget for a specific memory segment group.Definition D3D12MemAlloc.h:474
UINT64 BudgetBytesEstimated amount of memory available to the program.Definition D3D12MemAlloc.h:497
UINT64 UsageBytesEstimated current memory usage of the program.Definition D3D12MemAlloc.h:486
-- Implementation detail
- DXGI interface offers function
IDXGIAdapter3::QueryVideoMemoryInfo that queries the current memory usage and budget. This library automatically makes use of it when available (when you use recent enough version of the DirectX SDK). If not, it falls back to estimating the usage and budget based on the total amount of the allocated memory and 80% of the full memory capacity, respectively.
+- Implementation detail
- DXGI interface offers function IDXGIAdapter3::QueryVideoMemoryInfo that queries the current memory usage and budget. This library automatically makes use of it when available (when you use recent enough version of the DirectX SDK). If not, it falls back to estimating the usage and budget based on the total amount of the allocated memory and 80% of the full memory capacity, respectively.
- Implementation detail
- Allocating large heaps and creating placed resources in them is one of the main features of this library. However, if allocating new such block would exceed the budget, it will automatically prefer creating the resource as committed to have exactly the right size, which can lower the chance of getting into trouble in case of over-commitment.
When creating non-essential resources, you can use D3D12MA::ALLOCATION_FLAG_WITHIN_BUDGET. Then, in case the allocation would exceed the budget, the library will return failure from the function without attempting to allocate the actual D3D12 memory.
-It may also be a good idea to support failed resource creation. For non-essential resources, when function D3D12MA::Allocator::CreateResource fails with a result other than S_OK, it is worth implementing some way of recovery instead of terminating or crashing the entire app.
-
+
It may also be a good idea to support failed resource creation. For non-essential resources, when function D3D12MA::Allocator::CreateResource fails with a result other than S_OK, it is worth implementing some way of recovery instead of terminating or crashing the entire app.
+
Allocation performance
Creating D3D12 resources (buffers and textures) can be a time-consuming operation. The duration can be unpredictable, spanning from a small fraction of a millisecond to a significant fraction of a second. Thus, it is recommended to allocate all the memory and create all the resources needed upfront rather than doing it during application runtime. For example, a video game can try to create its resources on startup or when loading a new level. Of course, is is not always possible. For example, open-world games may require loading and unloading some graphical assets in the background (often called "streaming").
-Creating and releasing D3D12 resources on a separate thread in the background may help. Both ID3D12Device and D3D12MA::Allocator objects are thread-safe, synchronized internally. However, cases were observed where resource creation calls like ID3D12Device::CreateCommittedResource were blocking other D3D12 calls like ExecuteCommandLists or Present somewhere inside the graphics driver, so hitches can happen even when using multithreading.
-The most expensive part is typically the allocation of a new D3D12 memory heap. This library tackles this problem by automatically allocating large heaps (64 MB by default) and creating resources as placed inside of them. When a new requested resource can be placed in a free space of an existing heap and doesn't require allocating a new heap, this operation is typically much faster, as it only requires creating a new ID3D12Resource object and not allocating new memory. This is the main benefit of using D3D12MA compared to the naive approach of using Direct3D 12 directly and creating each resource as committed with CreateCommittedResource, which would result in a separate allocation of an implicit heap every time.
-When a large number of small buffers needs to be created, the overhead of creating even just separate ID3D12Resource objects can be significant. It can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs. This library can also help with it. See section "Sub-allocating buffers" below.
+Creating and releasing D3D12 resources on a separate thread in the background may help. Both ID3D12Device and D3D12MA::Allocator objects are thread-safe, synchronized internally. However, cases were observed where resource creation calls like ID3D12Device::CreateCommittedResource were blocking other D3D12 calls like ExecuteCommandLists or Present somewhere inside the graphics driver, so hitches can happen even when using multithreading.
+The most expensive part is typically the allocation of a new D3D12 memory heap. This library tackles this problem by automatically allocating large heaps (64 MB by default) and creating resources as placed inside of them. When a new requested resource can be placed in a free space of an existing heap and doesn't require allocating a new heap, this operation is typically much faster, as it only requires creating a new ID3D12Resource object and not allocating new memory. This is the main benefit of using D3D12MA compared to the naive approach of using Direct3D 12 directly and creating each resource as committed with CreateCommittedResource, which would result in a separate allocation of an implicit heap every time.
+When a large number of small buffers needs to be created, the overhead of creating even just separate ID3D12Resource objects can be significant. It can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs. This library can also help with it. See section "Sub-allocating buffers" below.
- Implementation detail
- The CPU performance overhead of using this library is low. It uses a high-quality allocation algorithm called Two-Level Segregated Fit (TLSF), which in most cases can find a free place for a new allocation in few steps. The library also doesn't perform too many CPU heap allocations. In may cases, the allocation happens with 0 new CPU heap allocations performed by the library. Even the creation of a D3D12MA::Allocation object itself doesn't typically feature an CPU allocation, because these objects are returned out of a dedicated memory pool.
Another reason for the slowness of D3D12 memory allocation is the guarantee that the newly allocated memory is filled with zeros. When creating and destroying resources placed in an existing heap, this overhead is not present, and the memory is not zeroed - it may contain random data left by the resource previously allocated in that place. In recent versions of the DirectX 12 SDK, clearing the memory of the newly created D3D12 heaps can also be disabled for the improved performance. D3D12MA can use this feature when:
- D3D12MA::ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED is used during the creation of the main allocator object.
-D3D12_HEAP_FLAG_CREATE_NOT_ZEROED is passed to D3D12MA::POOL_DESC::HeapFlags during the creation of a custom pool.- D3D12_HEAP_FLAG_CREATE_NOT_ZEROED is passed to D3D12MA::POOL_DESC::HeapFlags during the creation of a custom pool.
It is recommended to always use these flags. The downside is that when the memory is not filled with zeros, while you don't properly clear it or otherwise initialize its content before use (which is required by D3D12), you may observe incorrect behavior. This problem mostly affects render-target and depth-stencil textures.
When an allocation needs to be made in a performance-critical code, you can use D3D12MA::ALLOCATION_FLAG_STRATEGY_MIN_TIME. In influences multiple heuristics inside the library to prefer faster allocation at the expense of possibly less optimal placement in the memory.
If the resource to be created is non-essential, while the performance is paramount, you can also use D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE. It will create the resource only if it can be placed inside and existing memory heap and return failure from the function if a new heap would need to be allocated, which should guarantee good performance of such function call.
-
+
Sub-allocating buffers
-
When a large number of small buffers needs to be created, the overhead of creating separate ID3D12Resource objects can be significant. It can also cause a significant waste of memory, as placed buffers need to be aligned to D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB by default. These problems can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs.
+When a large number of small buffers needs to be created, the overhead of creating separate ID3D12Resource objects can be significant. It can also cause a significant waste of memory, as placed buffers need to be aligned to D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB by default. These problems can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs.
It requires implementing a custom allocator for the data inside the buffer and using offsets to individual regions. When all the regions can be allocated linearly and freed all at once, implementing such allocator is trivial. When every region has the same size, implementing an allocator is also quite simple when using a "free list" algorithm. However, when regions can have different sizes and can be allocated and freed in random order, it requires a full allocation algorithm. D3D12MA can help with it by exposing its core allocation algorithm for custom usages. For more details and example code, see chapter: Virtual allocator. It can be used for all the cases mentioned above without too much performance overhead, because the D3D12MA::VirtualAllocation object is just a lightweight handle.
-When sub-allocating a buffer, you need to remember to explicitly request proper alignment required for each region. For example, data used as a constant buffer must be aligned to D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT = 256 B.
-
+
When sub-allocating a buffer, you need to remember to explicitly request proper alignment required for each region. For example, data used as a constant buffer must be aligned to D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT = 256 B.
+
Residency priority
When too much video memory is allocated, one of the things that can happen is the system demoting some heaps to the system memory. Moving data between memory pools or reaching out directly to the system memory through PCI Express bus can have large performance overhead, which can slow down the application, or even make the game unplayable any more. Unfortunately, it is not possible to fully control or prevent this demotion. Best thing to do is avoiding memory over-commitment. For more information, see section "Avoiding running out of memory" above.
-Recent versions of DirectX 12 SDK offer function ID3D12Device1::SetResidencyPriority that sets a hint about the priority of a resource - how important it is to stay resident in the video memory. Setting the priority happens at the level of an entire memory heap. D3D12MA offers an interface to set this priority in form of D3D12MA::POOL_DESC::ResidencyPriority parameter. It affects all allocations made out of the custom pool created with it, both placed inside large heaps and created as committed.
+Recent versions of DirectX 12 SDK offer function ID3D12Device1::SetResidencyPriority that sets a hint about the priority of a resource - how important it is to stay resident in the video memory. Setting the priority happens at the level of an entire memory heap. D3D12MA offers an interface to set this priority in form of D3D12MA::POOL_DESC::ResidencyPriority parameter. It affects all allocations made out of the custom pool created with it, both placed inside large heaps and created as committed.
It is recommended to create a custom pool for the purpose of using high residency priority of all resources that are critical for the performance, especially those that are written by the GPU, like render-target, depth-stencil textures, UAV textures and buffers. It is also worth creating them as committed, so that each one will have its own implicit heap. This can minimize the chance that an entire large heap is demoted to system memory, degrading performance of all the resources placed in it.
Example:
D3D12MA::CPOOL_DESC poolDesc = D3D12MA::CPOOL_DESC{
@@ -175,14 +162,14 @@
D3D12_RESIDENCY_PRIORITY priority = D3D12_RESIDENCY_PRIORITY_HIGH;
device1->SetResidencyPriority(1, &res, &priority);
ID3D12Resource * GetResource() constReturns D3D12 resource associated with this object.Definition D3D12MemAlloc.h:552
-
Note this is not the same as explicit eviction controlled using ID3D12Device::Evict and MakeResident functions. Resources evicted explicitly are illegal to access until they are made resident again, while the demotion described here happens automatically and only slows down the execution.
-
+
Note this is not the same as explicit eviction controlled using ID3D12Device::Evict and MakeResident functions. Resources evicted explicitly are illegal to access until they are made resident again, while the demotion described here happens automatically and only slows down the execution.
+
GPU upload heap
Direct3D 12 offers a fixed set of memory heap types:
-D3D12_HEAP_TYPE_DEFAULT: Represents the video memory. It is available and fast to access for the GPU. It should be used for all resources that are written by the GPU (like render-target and depth-stencil textures, UAV) and resources that are frequently read by the GPU (like textures intended for sampling, vertex, index, and constant buffers).D3D12_HEAP_TYPE_UPLOAD: Represents the system memory that is uncached and write-combined. It can be mapped and accessed by the CPU code using a pointer. It supports only buffers, not textures. It is intended for "staging buffers" that are filled by the CPU code and then used as a source of copy operations to the DEFAULT heap. It can also be accessed directly by the GPU - shaders can read from buffers created in this memory.D3D12_HEAP_TYPE_READBACK: Represents the system memory that is cached. It is intended for buffers used as a destination of copy operations from the DEFAULT heap.- D3D12_HEAP_TYPE_DEFAULT: Represents the video memory. It is available and fast to access for the GPU. It should be used for all resources that are written by the GPU (like render-target and depth-stencil textures, UAV) and resources that are frequently read by the GPU (like textures intended for sampling, vertex, index, and constant buffers).
+- D3D12_HEAP_TYPE_UPLOAD: Represents the system memory that is uncached and write-combined. It can be mapped and accessed by the CPU code using a pointer. It supports only buffers, not textures. It is intended for "staging buffers" that are filled by the CPU code and then used as a source of copy operations to the DEFAULT heap. It can also be accessed directly by the GPU - shaders can read from buffers created in this memory.
+- D3D12_HEAP_TYPE_READBACK: Represents the system memory that is cached. It is intended for buffers used as a destination of copy operations from the DEFAULT heap.
Note that in systems with a discrete graphics card, access to system memory is fast from the CPU code (like the C++ code mapping D3D12 buffers and accessing them through a pointer), while access to the video memory is fast from the GPU code (like shaders reading and writing buffers and textures). Any copy operation or direct access between these memory heap types happens through PCI Express bus, which can be relatively slow.
Modern systems offer a feature called Resizable BAR (ReBAR) that gives the CPU direct access to the full video memory. To be available, this feature needs to be supported by the whole hardware-software environment, including:
@@ -192,20 +179,20 @@
- Supporting operating system.
- The feature needs to be enabled in the UEFI settings. It is typically called "Above 4G Decoding" and "Resizable Bar".
-Recent versions of DirectX 12 SDK give access to this feature in form of a new, 4th memory pool: D3D12_HEAP_TYPE_GPU_UPLOAD. Resources created in it behave logically similar to the D3D12_HEAP_TYPE_UPLOAD heap:
+Recent versions of DirectX 12 SDK give access to this feature in form of a new, 4th memory pool: D3D12_HEAP_TYPE_GPU_UPLOAD. Resources created in it behave logically similar to the D3D12_HEAP_TYPE_UPLOAD heap:
- They support mapping and direct access from the CPU code through a pointer.
-- The mapped memory is uncached and write-combined, so it should be only written sequentially (e.g., number-by-number or using
memcpy). It shouldn't be accessed randomly or read, because it is extremely slow for uncached memory.
+- The mapped memory is uncached and write-combined, so it should be only written sequentially (e.g., number-by-number or using memcpy). It shouldn't be accessed randomly or read, because it is extremely slow for uncached memory.
- Only buffers are supported.
- Those buffers can be used as a source of copy operations or directly accessed by the GPU.
-The main difference is that resources created in the new D3D12_HEAP_TYPE_GPU_UPLOAD are placed in the video memory, while resources created in the old D3D12_HEAP_TYPE_UPLOAD are placed in the system memory. This implies which budgets are consumed by new resources allocated in those heaps. This also implies which operations involve transferring data through the PCI Express bus.
+The main difference is that resources created in the new D3D12_HEAP_TYPE_GPU_UPLOAD are placed in the video memory, while resources created in the old D3D12_HEAP_TYPE_UPLOAD are placed in the system memory. This implies which budgets are consumed by new resources allocated in those heaps. This also implies which operations involve transferring data through the PCI Express bus.
-- As
D3D12_HEAP_TYPE_UPLOAD uses the system memory, writes from the CPU code through a mapped pointer are faster, while copies or direct access from the GPU are slower because they need to go through PCIe.
-- As the new
D3D12_HEAP_TYPE_GPU_UPLOAD uses the video memory, copies or direct access from the GPU are faster, while writes from the CPU code through a mapped pointer can be slower, because they need to go through PCIe. For maximum performance of copy operations from this heap, a graphics or compute queue should be used, not a copy queue.
+- As D3D12_HEAP_TYPE_UPLOAD uses the system memory, writes from the CPU code through a mapped pointer are faster, while copies or direct access from the GPU are slower because they need to go through PCIe.
+- As the new D3D12_HEAP_TYPE_GPU_UPLOAD uses the video memory, copies or direct access from the GPU are faster, while writes from the CPU code through a mapped pointer can be slower, because they need to go through PCIe. For maximum performance of copy operations from this heap, a graphics or compute queue should be used, not a copy queue.
GPU Upload Heap can be used for performance optimization of some resources that need to be written by the CPU and read by the GPU. It can be beneficial especially for resources that need to change frequently (often called "dynamic").
-D3D12MA supports GPU upload heap when recent enough version of DirectX 12 SDK is used and when the current system supports it. The support can be queried using function D3D12MA::Allocator::IsGPUUploadHeapSupported(). When it returns TRUE, you can create resources using D3D12_HEAP_TYPE_GPU_UPLOAD. You can also just try creating such resource. Example:
+D3D12MA supports GPU upload heap when recent enough version of DirectX 12 SDK is used and when the current system supports it. The support can be queried using function D3D12MA::Allocator::IsGPUUploadHeapSupported(). When it returns TRUE, you can create resources using D3D12_HEAP_TYPE_GPU_UPLOAD. You can also just try creating such resource. Example:
D3D12MA::CALLOCATION_DESC allocDesc = D3D12MA::CALLOCATION_DESC{
D3D12_HEAP_TYPE_GPU_UPLOAD }; // !!!
@@ -240,13 +227,13 @@
else
// Some other error code e.g., out of memory...
D3D12_HEAP_TYPE HeapTypeThe type of memory heap where the new allocation should be placed.Definition D3D12MemAlloc.h:347
-
+
Committed versus placed resources
When using D3D12 API directly, there are 3 ways of creating resources:
-- Committed, using function
ID3D12Device::CreateCommittedResource. It creates the resource with its own memory heap, which is called an "implicit heap" and cannot be accessed directly.
-- Placed, using function
ID3D12Device::CreatePlacedResource. A ID3D12Heap needs to be created beforehand using ID3D12Device::CreateHeap. Then, the resource can be created as placed inside the heap at a specific offset.
-- Reserved, using function
ID3D12Device::CreateReservedResource. This library doesn't support them directly.
+- Committed, using function ID3D12Device::CreateCommittedResource. It creates the resource with its own memory heap, which is called an "implicit heap" and cannot be accessed directly.
+- Placed, using function ID3D12Device::CreatePlacedResource. A ID3D12Heap needs to be created beforehand using ID3D12Device::CreateHeap. Then, the resource can be created as placed inside the heap at a specific offset.
+- Reserved, using function ID3D12Device::CreateReservedResource. This library doesn't support them directly.
A naive solution would be to create all the resources as committed. It works, because in D3D12 there is no strict limit on the number of resources or heaps that can be created. However, there are certain advantages and disadvantages of using committed versus placed resources:
- The advantage of committed resources is that they are always created with a new heap, which is initialized with zeros. When a resource is created as placed, the memory may contain random data left by the resource previously allocated in that place. When the memory is not filled with zeros, while you don't properly clear it or otherwise initialize its content before use (which is required by D3D12), you may observe incorrect behavior. On the other hand, using committed resources and having every new resource filled with zeros can leave this kind of bugs undetected.
-- Manual eviction with
ID3D12Device::Evict and MakeResident functions work at the level of the entire heap, and so does ID3D12Device1::SetResidencyPriority, so creating resources as committed allows more fine-grained control over the eviction and residency priority of individual resources.
+- Manual eviction with ID3D12Device::Evict and MakeResident functions work at the level of the entire heap, and so does ID3D12Device1::SetResidencyPriority, so creating resources as committed allows more fine-grained control over the eviction and residency priority of individual resources.
- The advantage of placed resources is that they can be created in a region of a heap overlapping with some other resources. This approach is commonly called "aliasing". It can save memory, but it needs careful control over the resources that overlap in memory to make sure they are not used at the same time, there is an aliasing barrier issued between their usage, and the resource used after aliasing is correctly cleared every time. Committed resources don't offer this possibility, because every committed resource has its own exclusive memory heap. For more information, see chapter Resource aliasing (overlap).
When creating resources with the help of D3D12MA using function D3D12MA::Allocator::CreateResource, you typically don't need to care about all this. The library automatically makes the choice of creating the new resource as committed or placed. However, in cases when you need the information or the control over this choice between committed and placed, the library offers facilities to do that, described below.
@@ -303,18 +290,18 @@
UINT64 BlockSizeSize of a single heap (memory block) to be allocated as part of this pool, in bytes....Definition D3D12MemAlloc.h:933
You can request a new resource to be created as placed by using D3D12MA::ALLOCATION_FLAG_CAN_ALIAS. This is required especially if you plan to create another resource in the same region of memory, aliasing with your resource - hence the name of this flag.
Note D3D12MA::ALLOCATION_FLAG_CAN_ALIAS can be even combined with D3D12MA::ALLOCATION_FLAG_COMMITTED. In this case, the resource is not created as committed, but it is also not placed as part of a larger heap. What happens instead is that a new heap is created with the exact size required for the resource, and the resource is created in it, placed at offset 0.
-
+
Resource alignment
Certain types of resources require certain alignment in memory. An alignment is a requirement for the address or offset to the beginning of the resource to be a multiply of some value, which is always a power of 2. For committed resources, the problem is non-existent, because committed resources have their own implicit heaps where they are created at offset 0, which meets any alignment requirement. For placed resources, D3D12MA takes care of the alignment automatically.
-- Implementation detail
- Default alignment required MSAA textures is
D3D12_DEFAULT_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 4 MB. Default alignment required for buffers and other textures is D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB.
+- Implementation detail
- Default alignment required MSAA textures is D3D12_DEFAULT_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 4 MB. Default alignment required for buffers and other textures is D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB.
Because the alignment required for buffers is 64 KB, small buffers can waste a lot of memory in between when created as placed. When such small buffers are created as committed, some graphics drivers are able to pack them better. D3D12MA automatically takes advantage of this by preferring to create small buffers as committed. This heuristics is enabled by default. It is also a tradeoff - it can make the allocation of these buffers slower. It can be disabled for an individual resource by using D3D12MA::ALLOCATION_FLAG_STRATEGY_MIN_TIME and for the entire allocator by using D3D12MA::ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED.
-For certain textures that meet a complex set of requirements, special "small alignment" can be applied. Details can be found in Microsoft documentation of the D3D12_RESOURCE_DESC structure. For MSAA textures, the small alignment is D3D12_SMALL_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB. For other textures, the small alignment is D3D12_SMALL_RESOURCE_PLACEMENT_ALIGNMENT = 4 KB. D3D12MA uses this feature automatically. Detailed behavior can be disabled or controlled by predefining macro D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT.
-D3D12 also has a concept of alignment of the entire heap, passed through D3D12_HEAP_DESC::Alignment. This library automatically sets the alignment as small as possible. Unfortunately, any heap that has a chance of hosting an MSAA texture needs to have the alignment set to 4 MB. This problem can be overcome by passing D3D12MA::ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of the main allocator object and D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of any custom heap that supports textures, not only buffers. With those flags, the alignment of the heaps created by D3D12MA can be lower, but any MSAA textures are created as committed. You should always use these flags in your code unless you really need to create some MSAA textures as placed.
+For certain textures that meet a complex set of requirements, special "small alignment" can be applied. Details can be found in Microsoft documentation of the D3D12_RESOURCE_DESC structure. For MSAA textures, the small alignment is D3D12_SMALL_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB. For other textures, the small alignment is D3D12_SMALL_RESOURCE_PLACEMENT_ALIGNMENT = 4 KB. D3D12MA uses this feature automatically. Detailed behavior can be disabled or controlled by predefining macro D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT.
+D3D12 also has a concept of alignment of the entire heap, passed through D3D12_HEAP_DESC::Alignment. This library automatically sets the alignment as small as possible. Unfortunately, any heap that has a chance of hosting an MSAA texture needs to have the alignment set to 4 MB. This problem can be overcome by passing D3D12MA::ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of the main allocator object and D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of any custom heap that supports textures, not only buffers. With those flags, the alignment of the heaps created by D3D12MA can be lower, but any MSAA textures are created as committed. You should always use these flags in your code unless you really need to create some MSAA textures as placed.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/quick_start.html b/docs/html/quick_start.html
index f9219d2..4eba7e6 100644
--- a/docs/html/quick_start.html
+++ b/docs/html/quick_start.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Quick start
-
-
@@ -33,33 +31,22 @@
-
+
-
- Quick start
+ Quick start
-
+
Project setup and initialization
This is a small, standalone C++ library. It consists of 2 files: "D3D12MemAlloc.h" header file with public interface and "D3D12MemAlloc.cpp" with internal implementation. The only external dependencies are WinAPI, Direct3D 12, and parts of C/C++ standard library (but STL containers, exceptions, or RTTI are not used).
The library is developed and tested using Microsoft Visual Studio 2022, but it should work with other compilers as well. It is designed for 64-bit code.
To use the library in your project:
-(1.) Copy files D3D12MemAlloc.cpp, D3D12MemAlloc.h to your project.
-(2.) Make D3D12MemAlloc.cpp compiling as part of the project, as C++ code.
+(1.) Copy files D3D12MemAlloc.cpp, D3D12MemAlloc.h to your project.
+(2.) Make D3D12MemAlloc.cpp compiling as part of the project, as C++ code.
(3.) Include library header in each CPP file that needs to use the library.
#include "D3D12MemAlloc.h"
-(4.) Right after you created ID3D12Device, fill D3D12MA::ALLOCATOR_DESC structure and call function D3D12MA::CreateAllocator to create the main D3D12MA::Allocator object.
+
(4.) Right after you created ID3D12Device, fill D3D12MA::ALLOCATOR_DESC structure and call function D3D12MA::CreateAllocator to create the main D3D12MA::Allocator object.
Please note that all symbols of the library are declared inside D3D12MA namespace.
IDXGIAdapter* adapter = ...
ID3D12Device* device = ...
@@ -119,12 +106,12 @@
D3D12MA_API HRESULT CreateAllocator(const ALLOCATOR_DESC *pDesc, Allocator **ppAllocator)Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
(5.) Right before destroying the D3D12 device, destroy the allocator object.
allocator->Release();
-Objects of this library must be destroyed by calling Release method. They are somewhat compatible with COM: they implement IUnknown interface with its virtual methods: AddRef, Release, QueryInterface, and they are reference-counted internally. You can use smart pointers designed for COM with objects of this library - e.g. CComPtr or Microsoft::WRL::ComPtr. The reference counter is thread-safe. QueryInterface method supports only IUnknown, as classes of this library don't define their own GUIDs.
-
+
Objects of this library must be destroyed by calling Release method. They are somewhat compatible with COM: they implement IUnknown interface with its virtual methods: AddRef, Release, QueryInterface, and they are reference-counted internally. You can use smart pointers designed for COM with objects of this library - e.g. CComPtr or Microsoft::WRL::ComPtr. The reference counter is thread-safe. QueryInterface method supports only IUnknown, as classes of this library don't define their own GUIDs.
+
Creating resources
-To use the library for creating resources (textures and buffers), call method D3D12MA::Allocator::CreateResource in the place where you would previously call ID3D12Device::CreateCommittedResource.
-The function has similar syntax, but it expects structure D3D12MA::ALLOCATION_DESC to be passed along with D3D12_RESOURCE_DESC and other parameters for created resource. This structure describes parameters of the desired memory allocation, including choice of D3D12_HEAP_TYPE.
-The function returns a new object of type D3D12MA::Allocation. It represents allocated memory and can be queried for size, offset, ID3D12Heap. It also holds a reference to the ID3D12Resource, which can be accessed by calling D3D12MA::Allocation::GetResource().
+To use the library for creating resources (textures and buffers), call method D3D12MA::Allocator::CreateResource in the place where you would previously call ID3D12Device::CreateCommittedResource.
+The function has similar syntax, but it expects structure D3D12MA::ALLOCATION_DESC to be passed along with D3D12_RESOURCE_DESC and other parameters for created resource. This structure describes parameters of the desired memory allocation, including choice of D3D12_HEAP_TYPE.
+The function returns a new object of type D3D12MA::Allocation. It represents allocated memory and can be queried for size, offset, ID3D12Heap. It also holds a reference to the ID3D12Resource, which can be accessed by calling D3D12MA::Allocation::GetResource().
D3D12_RESOURCE_DESC resourceDesc = {};
resourceDesc.Dimension = D3D12_RESOURCE_DIMENSION_TEXTURE2D;
resourceDesc.Alignment = 0;
@@ -160,13 +147,13 @@
D3D12_HEAP_TYPE HeapTypeThe type of memory heap where the new allocation should be placed.Definition D3D12MemAlloc.h:347
You need to release the allocation object when no longer needed. This will also release the D3D12 resource.
allocation->Release();
-The advantage of using the allocator instead of creating committed resource, and the main purpose of this library, is that it can decide to allocate bigger memory heap internally using ID3D12Device::CreateHeap and place multiple resources in it, at different offsets, using ID3D12Device::CreatePlacedResource. The library manages its own collection of allocated memory blocks (heaps) and remembers which parts of them are occupied and which parts are free to be used for new resources.
-It is important to remember that resources created as placed don't have their memory initialized to zeros, but may contain garbage data, so they need to be fully initialized before usage, e.g. using Clear (ClearRenderTargetView), Discard (DiscardResource), or Copy (CopyResource).
-The library also automatically handles resource heap tier. When D3D12_FEATURE_DATA_D3D12_OPTIONS::ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1, resources of 3 types: buffers, textures that are render targets or depth-stencil, and other textures must be kept in separate heaps. When D3D12_RESOURCE_HEAP_TIER_2, they can be kept together. By using this library, you don't need to handle this manually.
-
+
The advantage of using the allocator instead of creating committed resource, and the main purpose of this library, is that it can decide to allocate bigger memory heap internally using ID3D12Device::CreateHeap and place multiple resources in it, at different offsets, using ID3D12Device::CreatePlacedResource. The library manages its own collection of allocated memory blocks (heaps) and remembers which parts of them are occupied and which parts are free to be used for new resources.
+It is important to remember that resources created as placed don't have their memory initialized to zeros, but may contain garbage data, so they need to be fully initialized before usage, e.g. using Clear (ClearRenderTargetView), Discard (DiscardResource), or Copy (CopyResource).
+The library also automatically handles resource heap tier. When D3D12_FEATURE_DATA_D3D12_OPTIONS::ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1, resources of 3 types: buffers, textures that are render targets or depth-stencil, and other textures must be kept in separate heaps. When D3D12_RESOURCE_HEAP_TIER_2, they can be kept together. By using this library, you don't need to handle this manually.
+
Resource reference counting
-ID3D12Resource and other interfaces of Direct3D 12 use COM, so they are reference-counted. Objects of this library are reference-counted as well. An object of type D3D12MA::Allocation remembers the resource (buffer or texture) that was created together with this memory allocation and holds a reference to the ID3D12Resource object. (Note this is a difference to Vulkan Memory Allocator, where a VmaAllocation object has no connection with the buffer or image that was created with it.) Thus, it is important to manage the resource reference counter properly.
-The simplest use case is shown in the code snippet above. When only D3D12MA::Allocation object is obtained from a function call like D3D12MA::Allocator::CreateResource, it remembers the ID3D12Resource that was created with it and holds a reference to it. The resource can be obtained by calling allocation->GetResource(), which doesn't increment the resource reference counter. Calling allocation->Release() will decrease the resource reference counter, which is 1 in this case, so the resource will be released.
+ID3D12Resource and other interfaces of Direct3D 12 use COM, so they are reference-counted. Objects of this library are reference-counted as well. An object of type D3D12MA::Allocation remembers the resource (buffer or texture) that was created together with this memory allocation and holds a reference to the ID3D12Resource object. (Note this is a difference to Vulkan Memory Allocator, where a VmaAllocation object has no connection with the buffer or image that was created with it.) Thus, it is important to manage the resource reference counter properly.
+The simplest use case is shown in the code snippet above. When only D3D12MA::Allocation object is obtained from a function call like D3D12MA::Allocator::CreateResource, it remembers the ID3D12Resource that was created with it and holds a reference to it. The resource can be obtained by calling allocation->GetResource(), which doesn't increment the resource reference counter. Calling allocation->Release() will decrease the resource reference counter, which is 1 in this case, so the resource will be released.
Second option is to retrieve a pointer to the resource along with D3D12MA::Allocation. Last parameters of the resource creation function can be used for this purpose.
D3D12MA::Allocation* allocation;
ID3D12Resource* resource;
@@ -179,15 +166,15 @@
IID_PPV_ARGS(&resource));
// Use resource...
-
In this case, returned pointer resource is equal to allocation->GetResource(), but the creation function additionally increases resource reference counter for the purpose of returning it from this call (it actually calls QueryInterface internally), so the resource will have the counter = 2. The resource then need to be released along with the allocation, in this particular order, to make sure the resource is destroyed before its memory heap can potentially be freed.
+In this case, returned pointer resource is equal to allocation->GetResource(), but the creation function additionally increases resource reference counter for the purpose of returning it from this call (it actually calls QueryInterface internally), so the resource will have the counter = 2. The resource then need to be released along with the allocation, in this particular order, to make sure the resource is destroyed before its memory heap can potentially be freed.
resource->Release();
allocation->Release();
-More advanced use cases are possible when we consider that an D3D12MA::Allocation object can just hold a reference to any resource. It can be changed by calling D3D12MA::Allocation::SetResource. This function releases the old resource and calls AddRef on the new one.
-Special care must be taken when performing defragmentation. The new resource created at the destination place should be set as pass.pMoves[i].pDstTmpAllocation->SetResource(newRes), but it is moved to the source allocation at end of the defragmentation pass, while the old resource accessible through pass.pMoves[i].pSrcAllocation->GetResource() is then released. For more information, see documentation chapter Defragmentation.
-
+
More advanced use cases are possible when we consider that an D3D12MA::Allocation object can just hold a reference to any resource. It can be changed by calling D3D12MA::Allocation::SetResource. This function releases the old resource and calls AddRef on the new one.
+Special care must be taken when performing defragmentation. The new resource created at the destination place should be set as pass.pMoves[i].pDstTmpAllocation->SetResource(newRes), but it is moved to the source allocation at end of the defragmentation pass, while the old resource accessible through pass.pMoves[i].pSrcAllocation->GetResource() is then released. For more information, see documentation chapter Defragmentation.
+
Mapping memory
-The process of getting regular CPU-side pointer to the memory of a resource in Direct3D is called "mapping". There are rules and restrictions to this process, as described in D3D12 documentation of ID3D12Resource::Map method.
-Mapping happens on the level of particular resources, not entire memory heaps, and so it is out of scope of this library. Just as the documentation of the Map function says:
+The process of getting regular CPU-side pointer to the memory of a resource in Direct3D is called "mapping". There are rules and restrictions to this process, as described in D3D12 documentation of ID3D12Resource::Map method.
+Mapping happens on the level of particular resources, not entire memory heaps, and so it is out of scope of this library. Just as the documentation of the Map function says:
- Returned pointer refers to data of particular subresource, not entire memory heap.
- You can map same resource multiple times. It is ref-counted internally.
@@ -196,7 +183,7 @@
- Unmapping may not be required before using written data - some heap types on some platforms support resources persistently mapped.
When using this library, you can map and use your resources normally without considering whether they are created as committed resources or placed resources in one large heap.
-Example for buffer created and filled in UPLOAD heap type:
+Example for buffer created and filled in UPLOAD heap type:
const UINT64 bufSize = 65536;
const float* bufData = ...;
@@ -233,17 +220,17 @@
memcpy(mappedPtr, bufData, bufSize);
resource->Unmap(0, NULL);
-
+
Helper structures
-
DirectX 12 Agility SDK offers a library of helpers in files "build\native\include\d3dx12\*.h". They include structures that help with complete and concise initialization of the core D3D12 *_DESC structures by using some basic C++ features (constructors, static methods, default parameters). They inherit from these structures, so they support implicit casting to them. For example, structure CD3DX12_RESOURCE_DESC can be used to conveniently fill in structure D3D12_RESOURCE_DESC.
-Similarly, this library provides a set of helper structures that aid in initialization of some of the *_DESC structures defined in the library. These are:
+DirectX 12 Agility SDK offers a library of helpers in files "build\native\include\d3dx12\*.h". They include structures that help with complete and concise initialization of the core D3D12 *_DESC structures by using some basic C++ features (constructors, static methods, default parameters). They inherit from these structures, so they support implicit casting to them. For example, structure CD3DX12_RESOURCE_DESC can be used to conveniently fill in structure D3D12_RESOURCE_DESC.
+Similarly, this library provides a set of helper structures that aid in initialization of some of the *_DESC structures defined in the library. These are:
- D3D12MA::CALLOCATION_DESC, which inherits from D3D12MA::ALLOCATION_DESC.
- D3D12MA::CPOOL_DESC, which inherits from D3D12MA::POOL_DESC.
- D3D12MA::CVIRTUAL_BLOCK_DESC, which inherits from D3D12MA::VIRTUAL_BLOCK_DESC.
- D3D12MA::CVIRTUAL_ALLOCATION_DESC, which inherits from D3D12MA::VIRTUAL_ALLOCATION_DESC.
-For example, when you want to create a buffer in the UPLAOD heap using minimal allocation time, you can use base structures:
+For example, when you want to create a buffer in the UPLAOD heap using minimal allocation time, you can use base structures:
D3D12MA::ALLOCATION_DESC allocDesc;
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_STRATEGY_MIN_TIME;
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
@@ -291,7 +278,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/resource_aliasing.html b/docs/html/resource_aliasing.html
index c89a007..1275544 100644
--- a/docs/html/resource_aliasing.html
+++ b/docs/html/resource_aliasing.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Resource aliasing (overlap)
-
-
@@ -33,33 +31,22 @@
-
+
-
- Resource aliasing (overlap)
+ Resource aliasing (overlap)
New explicit graphics APIs (Vulkan and Direct3D 12), thanks to manual memory management, give an opportunity to alias (overlap) multiple resources in the same region of memory - a feature not available in the old APIs (Direct3D 11, OpenGL). It can be useful to save video memory, but it must be used with caution.
@@ -171,18 +158,18 @@
Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.Definition D3D12MemAlloc.h:338
D3D12_HEAP_FLAGS ExtraHeapFlagsAdditional heap flags to be used when allocating memory.Definition D3D12MemAlloc.h:363
D3D12_HEAP_TYPE HeapTypeThe type of memory heap where the new allocation should be placed.Definition D3D12MemAlloc.h:347
-Remember that using resouces that alias in memory requires proper synchronization. You need to issue a special barrier of type D3D12_RESOURCE_BARRIER_TYPE_ALIASING. You also need to treat a resource after aliasing as uninitialized - containing garbage data. For example, if you use res1 and then want to use res2, you need to first initialize res2 using either Clear, Discard, or Copy to the entire resource.
+Remember that using resouces that alias in memory requires proper synchronization. You need to issue a special barrier of type D3D12_RESOURCE_BARRIER_TYPE_ALIASING. You also need to treat a resource after aliasing as uninitialized - containing garbage data. For example, if you use res1 and then want to use res2, you need to first initialize res2 using either Clear, Discard, or Copy to the entire resource.
Additional considerations:
- D3D12 also allows to interpret contents of memory between aliasing resources consistently in some cases, which is called "data inheritance". For details, see Microsoft documentation chapter "Memory Aliasing and Data Inheritance".
-- You can create more complex layout where different textures and buffers are bound at different offsets inside one large allocation. For example, one can imagine a big texture used in some render passes, aliasing with a set of many small buffers used in some further passes. To bind a resource at non-zero offset of an allocation, call D3D12MA::Allocator::CreateAliasingResource with appropriate value of
AllocationLocalOffset parameter.
-- Resources of the three categories: buffers, textures with
RENDER_TARGET or DEPTH_STENCIL flags, and all other textures, can be placed in the same memory only when allocator->GetD3D12Options().ResourceHeapTier >= D3D12_RESOURCE_HEAP_TIER_2. Otherwise they must be placed in different memory heap types, and thus aliasing them is not possible.
+- You can create more complex layout where different textures and buffers are bound at different offsets inside one large allocation. For example, one can imagine a big texture used in some render passes, aliasing with a set of many small buffers used in some further passes. To bind a resource at non-zero offset of an allocation, call D3D12MA::Allocator::CreateAliasingResource with appropriate value of AllocationLocalOffset parameter.
+- Resources of the three categories: buffers, textures with RENDER_TARGET or DEPTH_STENCIL flags, and all other textures, can be placed in the same memory only when allocator->GetD3D12Options().ResourceHeapTier >= D3D12_RESOURCE_HEAP_TIER_2. Otherwise they must be placed in different memory heap types, and thus aliasing them is not possible.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/search/pages_0.js b/docs/html/search/pages_0.js
index 6c4bc1e..4e13aaf 100644
--- a/docs/html/search/pages_0.js
+++ b/docs/html/search/pages_0.js
@@ -1,10 +1,23 @@
var searchData=
[
- ['algorithm_0',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
- ['aliasing_20overlap_1',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
- ['allocation_2',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
- ['allocation_20algorithm_3',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
- ['allocator_4',['D3D12 Memory Allocator',['../index.html',1,'']]],
- ['allocator_5',['Virtual allocator',['../virtual_allocator.html',1,'optimal_allocation']]],
- ['asked_20questions_6',['Frequently asked questions',['../faq.html',1,'index']]]
+ ['additional_20considerations_0',['Additional considerations',['../linear_algorithm.html#linear_algorithm_additional_considerations',1,'Additional considerations'],['../virtual_allocator.html#virtual_allocator_additional_considerations',1,'Additional considerations']]],
+ ['algorithm_1',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
+ ['aliasing_20overlap_2',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
+ ['alignment_3',['Resource alignment',['../optimal_allocation.html#optimal_allocation_resource_alignment',1,'']]],
+ ['alignment_20and_20units_4',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]],
+ ['allocating_20buffers_5',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]],
+ ['allocation_6',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
+ ['allocation_20algorithm_7',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
+ ['allocation_20parameters_8',['Allocation parameters',['../virtual_allocator.html#virtual_allocator_allocation_parameters',1,'']]],
+ ['allocation_20performance_9',['Allocation performance',['../optimal_allocation.html#optimal_allocation_allocation_Performance',1,'']]],
+ ['allocations_10',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]],
+ ['allocator_11',['D3D12 Memory Allocator',['../index.html',1,'']]],
+ ['allocator_12',['allocator',['../configuration.html#custom_memory_allocator',1,'Custom CPU memory allocator'],['../virtual_allocator.html',1,'Virtual allocator']]],
+ ['and_20benefits_13',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]],
+ ['and_20compatibility_14',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]],
+ ['and_20initialization_15',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]],
+ ['and_20units_16',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]],
+ ['asked_20questions_17',['Frequently asked questions',['../faq.html',1,'index']]],
+ ['at_20once_18',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]],
+ ['avoiding_20running_20out_20of_20memory_19',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]]
];
diff --git a/docs/html/search/pages_1.js b/docs/html/search/pages_1.js
index 91cb574..d34b057 100644
--- a/docs/html/search/pages_1.js
+++ b/docs/html/search/pages_1.js
@@ -1,6 +1,7 @@
var searchData=
[
- ['configuration_0',['Configuration',['../configuration.html',1,'index']]],
- ['considerations_1',['General considerations',['../general_considerations.html',1,'index']]],
- ['custom_20memory_20pools_2',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
+ ['benefits_0',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]],
+ ['block_1',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]],
+ ['buffer_2',['Ring buffer',['../linear_algorithm.html#linear_algorithm_ring_buffer',1,'']]],
+ ['buffers_3',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]]
];
diff --git a/docs/html/search/pages_10.js b/docs/html/search/pages_10.js
new file mode 100644
index 0000000..af3b029
--- /dev/null
+++ b/docs/html/search/pages_10.js
@@ -0,0 +1,13 @@
+var searchData=
+[
+ ['safety_0',['Thread safety',['../general_considerations.html#general_considerations_thread_safety',1,'']]],
+ ['setup_20and_20initialization_1',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]],
+ ['stack_2',['Stack',['../linear_algorithm.html#linear_algorithm_stack',1,'']]],
+ ['stack_3',['Double stack',['../linear_algorithm.html#linear_algorithm_double_stack',1,'']]],
+ ['start_4',['Quick start',['../quick_start.html',1,'index']]],
+ ['statistics_5',['Statistics',['../statistics.html',1,'Statistics'],['../virtual_allocator.html#virtual_allocator_statistics',1,'Statistics']]],
+ ['statistics_6',['Numeric statistics',['../statistics.html#statistics_numeric_statistics',1,'']]],
+ ['structures_7',['Helper structures',['../quick_start.html#quick_start_helper_structures',1,'']]],
+ ['sub_20allocating_20buffers_8',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]],
+ ['supported_9',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]]
+];
diff --git a/docs/html/search/pages_11.js b/docs/html/search/pages_11.js
new file mode 100644
index 0000000..ce665b6
--- /dev/null
+++ b/docs/html/search/pages_11.js
@@ -0,0 +1,5 @@
+var searchData=
+[
+ ['table_20of_20contents_0',['Table of contents',['../index.html#main_table_of_contents',1,'']]],
+ ['thread_20safety_1',['Thread safety',['../general_considerations.html#general_considerations_thread_safety',1,'']]]
+];
diff --git a/docs/html/search/pages_12.js b/docs/html/search/pages_12.js
new file mode 100644
index 0000000..32f0ad5
--- /dev/null
+++ b/docs/html/search/pages_12.js
@@ -0,0 +1,6 @@
+var searchData=
+[
+ ['units_0',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]],
+ ['upload_20heap_1',['GPU upload heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'']]],
+ ['usage_2',['Usage',['../custom_pools.html#custom_pools_usage',1,'']]]
+];
diff --git a/docs/html/search/pages_13.js b/docs/html/search/pages_13.js
new file mode 100644
index 0000000..aa04e5d
--- /dev/null
+++ b/docs/html/search/pages_13.js
@@ -0,0 +1,8 @@
+var searchData=
+[
+ ['versioning_20and_20compatibility_0',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]],
+ ['versus_20placed_20resources_1',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]],
+ ['virtual_20allocations_2',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]],
+ ['virtual_20allocator_3',['Virtual allocator',['../virtual_allocator.html',1,'optimal_allocation']]],
+ ['virtual_20block_4',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]]
+];
diff --git a/docs/html/search/pages_14.js b/docs/html/search/pages_14.js
new file mode 100644
index 0000000..8225a92
--- /dev/null
+++ b/docs/html/search/pages_14.js
@@ -0,0 +1,4 @@
+var searchData=
+[
+ ['web_20links_0',['Web links',['../index.html#main_see_also',1,'']]]
+];
diff --git a/docs/html/search/pages_2.js b/docs/html/search/pages_2.js
index 8aa1a38..7553f75 100644
--- a/docs/html/search/pages_2.js
+++ b/docs/html/search/pages_2.js
@@ -1,5 +1,14 @@
var searchData=
[
- ['d3d12_20memory_20allocator_0',['D3D12 Memory Allocator',['../index.html',1,'']]],
- ['defragmentation_1',['Defragmentation',['../defragmentation.html',1,'optimal_allocation']]]
+ ['committed_20versus_20placed_20resources_0',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]],
+ ['compatibility_1',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]],
+ ['configuration_2',['Configuration',['../configuration.html',1,'index']]],
+ ['considerations_3',['considerations',['../linear_algorithm.html#linear_algorithm_additional_considerations',1,'Additional considerations'],['../virtual_allocator.html#virtual_allocator_additional_considerations',1,'Additional considerations'],['../general_considerations.html',1,'General considerations']]],
+ ['contents_4',['Table of contents',['../index.html#main_table_of_contents',1,'']]],
+ ['counting_5',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]],
+ ['cpu_20memory_20allocator_6',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]],
+ ['creating_20resources_7',['Creating resources',['../quick_start.html#quick_start_creating_resources',1,'']]],
+ ['creating_20virtual_20block_8',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]],
+ ['custom_20cpu_20memory_20allocator_9',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]],
+ ['custom_20memory_20pools_10',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
];
diff --git a/docs/html/search/pages_3.js b/docs/html/search/pages_3.js
index 842b2bb..89d174b 100644
--- a/docs/html/search/pages_3.js
+++ b/docs/html/search/pages_3.js
@@ -1,4 +1,9 @@
var searchData=
[
- ['frequently_20asked_20questions_0',['Frequently asked questions',['../faq.html',1,'index']]]
+ ['d3d12_20memory_20allocator_0',['D3D12 Memory Allocator',['../index.html',1,'']]],
+ ['deallocation_1',['Deallocation',['../virtual_allocator.html#virtual_allocator_deallocation',1,'']]],
+ ['debug_20margins_2',['Debug margins',['../configuration.html#debug_margins',1,'']]],
+ ['defragmentation_3',['Defragmentation',['../defragmentation.html',1,'optimal_allocation']]],
+ ['double_20stack_4',['Double stack',['../linear_algorithm.html#linear_algorithm_double_stack',1,'']]],
+ ['dump_5',['JSON dump',['../statistics.html#statistics_json_dump',1,'']]]
];
diff --git a/docs/html/search/pages_4.js b/docs/html/search/pages_4.js
index 1aed57d..6f9860c 100644
--- a/docs/html/search/pages_4.js
+++ b/docs/html/search/pages_4.js
@@ -1,4 +1,7 @@
var searchData=
[
- ['general_20considerations_0',['General considerations',['../general_considerations.html',1,'index']]]
+ ['features_20and_20benefits_0',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]],
+ ['features_20not_20supported_1',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]],
+ ['free_20at_20once_2',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]],
+ ['frequently_20asked_20questions_3',['Frequently asked questions',['../faq.html',1,'index']]]
];
diff --git a/docs/html/search/pages_5.js b/docs/html/search/pages_5.js
index b965ff9..b85c57f 100644
--- a/docs/html/search/pages_5.js
+++ b/docs/html/search/pages_5.js
@@ -1,4 +1,5 @@
var searchData=
[
- ['linear_20allocation_20algorithm_0',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]]
+ ['general_20considerations_0',['General considerations',['../general_considerations.html',1,'index']]],
+ ['gpu_20upload_20heap_1',['GPU upload heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'']]]
];
diff --git a/docs/html/search/pages_6.js b/docs/html/search/pages_6.js
index 2fa4310..6386d6c 100644
--- a/docs/html/search/pages_6.js
+++ b/docs/html/search/pages_6.js
@@ -1,5 +1,5 @@
var searchData=
[
- ['memory_20allocator_0',['D3D12 Memory Allocator',['../index.html',1,'']]],
- ['memory_20pools_1',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
+ ['heap_0',['GPU upload heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'']]],
+ ['helper_20structures_1',['Helper structures',['../quick_start.html#quick_start_helper_structures',1,'']]]
];
diff --git a/docs/html/search/pages_7.js b/docs/html/search/pages_7.js
index 0c3cb7f..75d0639 100644
--- a/docs/html/search/pages_7.js
+++ b/docs/html/search/pages_7.js
@@ -1,5 +1,4 @@
var searchData=
[
- ['optimal_20resource_20allocation_0',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
- ['overlap_1',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]]
+ ['initialization_0',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]]
];
diff --git a/docs/html/search/pages_8.js b/docs/html/search/pages_8.js
index f4128dd..2f270a2 100644
--- a/docs/html/search/pages_8.js
+++ b/docs/html/search/pages_8.js
@@ -1,4 +1,4 @@
var searchData=
[
- ['pools_0',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
+ ['json_20dump_0',['JSON dump',['../statistics.html#statistics_json_dump',1,'']]]
];
diff --git a/docs/html/search/pages_9.js b/docs/html/search/pages_9.js
index c9afe7b..9cdb234 100644
--- a/docs/html/search/pages_9.js
+++ b/docs/html/search/pages_9.js
@@ -1,5 +1,5 @@
var searchData=
[
- ['questions_0',['Frequently asked questions',['../faq.html',1,'index']]],
- ['quick_20start_1',['Quick start',['../quick_start.html',1,'index']]]
+ ['linear_20allocation_20algorithm_0',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
+ ['links_1',['Web links',['../index.html#main_see_also',1,'']]]
];
diff --git a/docs/html/search/pages_a.js b/docs/html/search/pages_a.js
index 53f0a34..0ce8dfd 100644
--- a/docs/html/search/pages_a.js
+++ b/docs/html/search/pages_a.js
@@ -1,5 +1,10 @@
var searchData=
[
- ['resource_20aliasing_20overlap_0',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
- ['resource_20allocation_1',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]]
+ ['making_20virtual_20allocations_0',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]],
+ ['mapping_20memory_1',['Mapping memory',['../quick_start.html#quick_start_mapping_memory',1,'']]],
+ ['margins_2',['Debug margins',['../configuration.html#debug_margins',1,'']]],
+ ['memory_3',['memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'Avoiding running out of memory'],['../quick_start.html#quick_start_mapping_memory',1,'Mapping memory']]],
+ ['memory_20allocator_4',['D3D12 Memory Allocator',['../index.html',1,'']]],
+ ['memory_20allocator_5',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]],
+ ['memory_20pools_6',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
];
diff --git a/docs/html/search/pages_b.js b/docs/html/search/pages_b.js
index d4b7ec0..a1fc386 100644
--- a/docs/html/search/pages_b.js
+++ b/docs/html/search/pages_b.js
@@ -1,5 +1,5 @@
var searchData=
[
- ['start_0',['Quick start',['../quick_start.html',1,'index']]],
- ['statistics_1',['Statistics',['../statistics.html',1,'optimal_allocation']]]
+ ['not_20supported_0',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]],
+ ['numeric_20statistics_1',['Numeric statistics',['../statistics.html#statistics_numeric_statistics',1,'']]]
];
diff --git a/docs/html/search/pages_c.js b/docs/html/search/pages_c.js
index 6f1ceb8..2036541 100644
--- a/docs/html/search/pages_c.js
+++ b/docs/html/search/pages_c.js
@@ -1,4 +1,9 @@
var searchData=
[
- ['virtual_20allocator_0',['Virtual allocator',['../virtual_allocator.html',1,'optimal_allocation']]]
+ ['of_20contents_0',['Table of contents',['../index.html#main_table_of_contents',1,'']]],
+ ['of_20memory_1',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]],
+ ['once_2',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]],
+ ['optimal_20resource_20allocation_3',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
+ ['out_20of_20memory_4',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]],
+ ['overlap_5',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]]
];
diff --git a/docs/html/search/pages_d.js b/docs/html/search/pages_d.js
new file mode 100644
index 0000000..61cd771
--- /dev/null
+++ b/docs/html/search/pages_d.js
@@ -0,0 +1,9 @@
+var searchData=
+[
+ ['parameters_0',['Allocation parameters',['../virtual_allocator.html#virtual_allocator_allocation_parameters',1,'']]],
+ ['performance_1',['Allocation performance',['../optimal_allocation.html#optimal_allocation_allocation_Performance',1,'']]],
+ ['placed_20resources_2',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]],
+ ['pools_3',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]],
+ ['priority_4',['Residency priority',['../optimal_allocation.html#optimal_allocation_residency_priority',1,'']]],
+ ['project_20setup_20and_20initialization_5',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]]
+];
diff --git a/docs/html/search/pages_e.js b/docs/html/search/pages_e.js
new file mode 100644
index 0000000..c9afe7b
--- /dev/null
+++ b/docs/html/search/pages_e.js
@@ -0,0 +1,5 @@
+var searchData=
+[
+ ['questions_0',['Frequently asked questions',['../faq.html',1,'index']]],
+ ['quick_20start_1',['Quick start',['../quick_start.html',1,'index']]]
+];
diff --git a/docs/html/search/pages_f.js b/docs/html/search/pages_f.js
new file mode 100644
index 0000000..97e8dbf
--- /dev/null
+++ b/docs/html/search/pages_f.js
@@ -0,0 +1,12 @@
+var searchData=
+[
+ ['reference_20counting_0',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]],
+ ['residency_20priority_1',['Residency priority',['../optimal_allocation.html#optimal_allocation_residency_priority',1,'']]],
+ ['resource_20aliasing_20overlap_2',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
+ ['resource_20alignment_3',['Resource alignment',['../optimal_allocation.html#optimal_allocation_resource_alignment',1,'']]],
+ ['resource_20allocation_4',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
+ ['resource_20reference_20counting_5',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]],
+ ['resources_6',['resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'Committed versus placed resources'],['../quick_start.html#quick_start_creating_resources',1,'Creating resources']]],
+ ['ring_20buffer_7',['Ring buffer',['../linear_algorithm.html#linear_algorithm_ring_buffer',1,'']]],
+ ['running_20out_20of_20memory_8',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]]
+];
diff --git a/docs/html/search/search.css b/docs/html/search/search.css
index 19f76f9..956f31f 100644
--- a/docs/html/search/search.css
+++ b/docs/html/search/search.css
@@ -5,8 +5,8 @@
display: flex;
justify-content: center;
align-items: center;
- height: 36px;
- margin-right: 1em;
+ height: 43px;
+ margin-right: 0;
}
/*---------------- Search box styling */
@@ -27,43 +27,23 @@ dark-mode-toggle {
white-space : nowrap;
background: var(--search-background-color);
border-radius: 0.65em;
- box-shadow: var(--search-box-shadow);
+ border: 1px solid var(--search-box-border-color);
z-index: 102;
+ margin-right: 4px;
}
#MSearchBox .left {
display: inline-block;
vertical-align: middle;
- height: 1.4em;
-}
-
-#MSearchSelect {
- display: inline-block;
- vertical-align: middle;
- width: 20px;
- height: 19px;
- background-image: var(--search-magnification-select-image);
- margin: 0 0 0 0.3em;
- padding: 0;
+ height: 1.6em;
}
-#MSearchSelectExt {
- display: inline-block;
- vertical-align: middle;
- width: 10px;
- height: 19px;
- background-image: var(--search-magnification-image);
- margin: 0 0 0 0.5em;
- padding: 0;
-}
-
-
#MSearchField {
display: inline-block;
- vertical-align: middle;
+ vertical-align: top;
width: 7.5em;
- height: 19px;
- margin: 0 0.15em;
+ height: 22px;
+ margin: 0 0 0 0.15em;
padding: 0;
line-height: 1em;
border:none;
@@ -86,7 +66,7 @@ dark-mode-toggle {
display: inline-block;
vertical-align: middle;
width: 1.4em;
- height: 1.4em;
+ height: 1.6em;
}
#MSearchClose {
@@ -101,14 +81,100 @@ dark-mode-toggle {
}
#MSearchCloseImg {
- padding: 0.3em;
- margin: 0;
+ margin: 6px 0 0 4px;
+}
+
+.close-icon {
+ width: 11px;
+ height: 11px;
+ background-color: var(--search-close-icon-bg-color);
+ border-radius: 50%;
+ position: relative;
+ display: flex;
+ justify-content: center;
+ align-items: center;
+ box-sizing: content-box;
+}
+
+.close-icon:before,
+.close-icon:after {
+ content: '';
+ position: absolute;
+ width: 7px;
+ height: 1px;
+ background-color: var(--search-close-icon-fg-color);
+}
+
+.close-icon:before {
+ transform: rotate(45deg);
}
+.close-icon:after {
+ transform: rotate(-45deg);
+}
+
+
.MSearchBoxActive #MSearchField {
color: var(--search-active-color);
}
+.search-icon {
+ width: 20px;
+ height: 20px;
+ display: inline-block;
+ position: relative;
+ margin-left: 3px;
+}
+
+#MSearchSelectExt.search-icon {
+ width: 10px;
+}
+
+#MSearchSelectExt + input {
+ margin-left: 5px;
+}
+
+.search-icon::before, .search-icon::after {
+ content: '';
+ position: absolute;
+ border: 1.5px solid var(--search-foreground-color);
+ box-sizing: content-box;
+}
+
+.search-icon::before {
+ width: 6px;
+ height: 6px;
+ border-radius: 50%;
+ top: 7px;
+ left: 2px;
+ background: var(--search-background-color);
+}
+
+.search-icon::after {
+ border: 1px solid var(--search-foreground-color);
+ width: 0px;
+ height: 3px;
+ border-radius: 2px;
+ top: 15px;
+ left: 8px;
+ transform: rotate(-45deg);
+ transform-origin: top left;
+}
+
+.search-icon-dropdown {
+ content: '';
+ width: 0;
+ height: 0;
+ border-left: 3px solid transparent;
+ border-right: 3px solid transparent;
+ border-top: 3px solid var(--search-foreground-color);
+ top: 8px;
+ left: 15px;
+ transform: translateX(-50%);
+ position: absolute;
+}
+
+
/*---------------- Search filter selection */
@@ -119,15 +185,12 @@ dark-mode-toggle {
left: 0; top: 0;
border: 1px solid var(--search-filter-border-color);
background-color: var(--search-filter-background-color);
+ backdrop-filter: var(--search-filter-backdrop-filter);
+ -webkit-backdrop-filter: var(--search-filter-backdrop-filter);
z-index: 10001;
padding-top: 4px;
padding-bottom: 4px;
- -moz-border-radius: 4px;
- -webkit-border-top-left-radius: 4px;
- -webkit-border-top-right-radius: 4px;
- -webkit-border-bottom-left-radius: 4px;
- -webkit-border-bottom-right-radius: 4px;
- -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ border-radius: 4px;
}
.SelectItem {
@@ -176,18 +239,39 @@ iframe#MSearchResults {
height: 15em;
}
+@keyframes slideInSearchResults {
+ from {
+ opacity: 0;
+ transform: translate(0, 15px);
+ }
+
+ to {
+ opacity: 1;
+ transform: translate(0, 20px);
+ }
+}
+
#MSearchResultsWindow {
display: none;
position: absolute;
- left: 0; top: 0;
+ left: auto;
+ right: 4px;
+ top: 0;
border: 1px solid var(--search-results-border-color);
background-color: var(--search-results-background-color);
+ backdrop-filter: var(--search-results-backdrop-filter);
+ -webkit-backdrop-filter: var(--search-results-backdrop-filter);
z-index:10000;
width: 300px;
height: 400px;
overflow: auto;
+ border-radius: 8px;
+ transform: translate(0, 20px);
+ animation: ease-out 280ms slideInSearchResults;
+ box-shadow: 0 2px 8px 0 rgba(0,0,0,.075);
}
+
/* ----------------------------------- */
@@ -201,13 +285,13 @@ iframe#MSearchResults {
}
.SRPage .SREntry {
- font-size: 8pt;
- padding: 1px 5px;
+ font-size: 10pt;
+ padding: 2px 5px;
}
div.SRPage {
margin: 5px 2px;
- background-color: var(--search-results-background-color);
+ /*background-color: var(--search-results-background-color);*/
}
.SRChildren {
@@ -261,14 +345,17 @@ div.searchresults {
margin-right: 10px;
}
+#searchBoxPos1 dark-mode-toggle {
+ margin-top: 4px;
+}
+
/*---------------- External search page results */
.pages b {
- color: white;
+ color: var(--nav-foreground-color);
padding: 5px 5px 3px 5px;
- background-image: var(--nav-gradient-active-image-parent);
- background-repeat: repeat-x;
- text-shadow: 0 1px 1px #000000;
+ background-color: var(--nav-menu-active-bg);
+ border-radius: 4px;
}
.pages {
diff --git a/docs/html/search/search.js b/docs/html/search/search.js
index 666af01..dc14410 100644
--- a/docs/html/search/search.js
+++ b/docs/html/search/search.js
@@ -607,6 +607,12 @@ function createResults(resultsPath) {
elem.setAttribute('className',attr);
}
+ const decodeHtml = (html) => {
+ const txt = document.createElement("textarea");
+ txt.innerHTML = html;
+ return txt.value;
+ };
+
const results = document.getElementById("SRResults");
results.innerHTML = '';
searchData.forEach((elem,index) => {
@@ -620,10 +626,14 @@ function createResults(resultsPath) {
srLink.setAttribute('id','Item'+index);
setKeyActions(srLink,'return searchResults.Nav(event,'+index+')');
setClassAttr(srLink,'SRSymbol');
- srLink.innerHTML = elem[1][0];
+ srLink.innerHTML = decodeHtml(elem[1][0]);
srEntry.appendChild(srLink);
if (elem[1].length==2) { // single result
- srLink.setAttribute('href',resultsPath+elem[1][1][0]);
+ if (elem[1][1][0].startsWith('http://') || elem[1][1][0].startsWith('https://')) { // absolute path
+ srLink.setAttribute('href',elem[1][1][0]);
+ } else { // relative path
+ srLink.setAttribute('href',resultsPath+elem[1][1][0]);
+ }
srLink.setAttribute('onclick','searchBox.CloseResultsWindow()');
if (elem[1][1][1]) {
srLink.setAttribute('target','_parent');
@@ -632,7 +642,7 @@ function createResults(resultsPath) {
}
const srScope = document.createElement('span');
setClassAttr(srScope,'SRScope');
- srScope.innerHTML = elem[1][1][2];
+ srScope.innerHTML = decodeHtml(elem[1][1][2]);
srEntry.appendChild(srScope);
} else { // multiple results
srLink.setAttribute('href','javascript:searchResults.Toggle("SR_'+id+'")');
@@ -643,14 +653,18 @@ function createResults(resultsPath) {
srChild.setAttribute('id','Item'+index+'_c'+c);
setKeyActions(srChild,'return searchResults.NavChild(event,'+index+','+c+')');
setClassAttr(srChild,'SRScope');
- srChild.setAttribute('href',resultsPath+elem[1][c+1][0]);
+ if (elem[1][c+1][0].startsWith('http://') || elem[1][c+1][0].startsWith('https://')) { // absolute path
+ srChild.setAttribute('href',elem[1][c+1][0]);
+ } else { // relative path
+ srChild.setAttribute('href',resultsPath+elem[1][c+1][0]);
+ }
srChild.setAttribute('onclick','searchBox.CloseResultsWindow()');
if (elem[1][c+1][1]) {
srChild.setAttribute('target','_parent');
} else {
srChild.setAttribute('target','_blank');
}
- srChild.innerHTML = elem[1][c+1][2];
+ srChild.innerHTML = decodeHtml(elem[1][c+1][2]);
srChildren.appendChild(srChild);
}
srEntry.appendChild(srChildren);
diff --git a/docs/html/search/searchdata.js b/docs/html/search/searchdata.js
index 1b7813a..2029dc1 100644
--- a/docs/html/search/searchdata.js
+++ b/docs/html/search/searchdata.js
@@ -11,7 +11,7 @@ var indexSectionsWithContent =
8: "adpv",
9: "cd",
10: "d",
- 11: "acdfglmopqrsv"
+ 11: "abcdfghijlmnopqrstuvw"
};
var indexSectionNames =
diff --git a/docs/html/statistics.html b/docs/html/statistics.html
index f261c65..b9b1e29 100644
--- a/docs/html/statistics.html
+++ b/docs/html/statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Statistics
-
-
@@ -33,33 +31,22 @@
-
+
-
- Statistics
+ Statistics
This library contains several functions that return information about its internal state, especially the amount of memory allocated from D3D12.
-
+
Numeric statistics
If you need to obtain basic statistics about memory usage per memory segment group, together with current budget, you can call function D3D12MA::Allocator::GetBudget() and inspect structure D3D12MA::Budget. This is useful to keep track of memory usage and stay withing budget. Example:
D3D12MA::Budget localBudget;
@@ -112,8 +99,8 @@
UINT64 UsageBytesEstimated current memory usage of the program.Definition D3D12MemAlloc.h:486
You can query for more detailed statistics per heap type, memory segment group, and totals, including minimum and maximum allocation size and unused range size, by calling function D3D12MA::Allocator::CalculateStatistics() and inspecting structure D3D12MA::TotalStatistics. This function is slower though, as it has to traverse all the internal data structures, so it should be used only for debugging purposes.
You can query for statistics of a custom pool using function D3D12MA::Pool::GetStatistics() or D3D12MA::Pool::CalculateStatistics().
-You can query for information about a specific allocation using functions of the D3D12MA::Allocation class, e.g. GetSize(), GetOffset(), GetHeap().
-
+
You can query for information about a specific allocation using functions of the D3D12MA::Allocation class, e.g. GetSize(), GetOffset(), GetHeap().
+
JSON dump
You can dump internal state of the allocator to a string in JSON format using function D3D12MA::Allocator::BuildStatsString(). The result is guaranteed to be correct JSON. It uses Windows Unicode (UTF-16) encoding. Any strings provided by user (see D3D12MA::Allocation::SetName()) are copied as-is and properly escaped for JSON. It must be freed using function D3D12MA::Allocator::FreeStatsString().
The format of this JSON string is not part of official documentation of the library, but it will not change in backward-incompatible way without increasing library major version number and appropriate mention in changelog.
@@ -122,7 +109,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html
index 223cc58..f967c0c 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html
index bb90eaa..495fe3f 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::ALLOCATION_CALLBACKS Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
ALLOCATE_FUNC_PTR pAllocate Allocation function.
FREE_FUNC_PTR pFree Dellocation function.
void * pPrivateData Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
-Detailed Description
+Detailed Description
Custom callbacks to CPU memory allocation functions.
-Member Data Documentation
+Member Data Documentation
◆ pAllocate
@@ -159,7 +143,7 @@
-Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
+Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
@@ -169,7 +153,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 0dd1a39..f398da5 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -102,7 +89,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 5363747..d914ec6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,33 +90,28 @@
Inheritance diagram for D3D12MA::ALLOCATION_DESC:
-
-
-
+
Public Attributes
ALLOCATION_FLAGS Flags Flags for the allocation.
D3D12_HEAP_TYPE HeapType The type of memory heap where the new allocation should be placed.
D3D12_HEAP_FLAGS ExtraHeapFlags Additional heap flags to be used when allocating memory.
Pool * CustomPool Custom pool to place the new resource in. Optional.
void * pPrivateData Custom general-purpose pointer that will be stored in D3D12MA::Allocation.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.
-Member Data Documentation
+Member Data Documentation
◆ CustomPool
@@ -143,7 +125,7 @@
Custom pool to place the new resource in. Optional.
-When not null, the resource will be created inside specified custom pool. Members HeapType, ExtraHeapFlags are then ignored.
+When not null, the resource will be created inside specified custom pool. Members HeapType, ExtraHeapFlags are then ignored.
@@ -162,9 +144,9 @@ D3D12MA::Allocator::CreateResource(), you don't need to care. Necessary flag D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, or D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES is added automatically.
-- If you use D3D12MA::Allocator::AllocateMemory(), you should specify one of those
ALLOW_ONLY flags. Except when you validate that D3D12MA::Allocator::GetD3D12Options().ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1 - then you can leave it 0.
-- You can specify additional flags if needed. Then the memory will always be allocated as separate block using
D3D12Device::CreateCommittedResource or CreateHeap, not as part of an existing larget block.
+- If you use D3D12MA::Allocator::CreateResource(), you don't need to care. Necessary flag D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, or D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES is added automatically.
+- If you use D3D12MA::Allocator::AllocateMemory(), you should specify one of those ALLOW_ONLY flags. Except when you validate that D3D12MA::Allocator::GetD3D12Options().ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1 - then you can leave it 0.
+- You can specify additional flags if needed. Then the memory will always be allocated as separate block using D3D12Device::CreateCommittedResource or CreateHeap, not as part of an existing larget block.
When D3D12MA::ALLOCATION_DESC::CustomPool != NULL this member is ignored.
@@ -199,7 +181,7 @@
The type of memory heap where the new allocation should be placed.
-It must be one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK.
+It must be one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK.
When D3D12MA::ALLOCATION_DESC::CustomPool != NULL this member is ignored.
@@ -226,7 +208,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html
index ccc6e9d..cfc611c 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -102,7 +89,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html
index 8673896..33029a6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::ALLOCATOR_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
ALLOCATOR_FLAGS Flags Flags for the entire allocator.
ID3D12Device * pDevice UINT64 PreferredBlockSize Preferred size of a single ID3D12Heap block to be allocated.
Preferred size of a single ID3D12Heap block to be allocated.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
IDXGIAdapter * pAdapter
-Detailed Description
+Detailed Description
Parameters of created Allocator object. To be used with CreateAllocator().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -148,7 +130,7 @@
DXGI Adapter object that you use for D3D12 and this allocator.
-Allocator is doing AddRef/Release on this object.
+Allocator is doing AddRef/Release on this object.
@@ -181,7 +163,7 @@
Direct3D device object that the allocator should be attached to.
-Allocator is doing AddRef/Release on this object.
+Allocator is doing AddRef/Release on this object.
@@ -197,7 +179,7 @@
-Preferred size of a single ID3D12Heap block to be allocated.
+Preferred size of a single ID3D12Heap block to be allocated.
Set to 0 to use default, which is currently 64 MiB.
@@ -208,7 +190,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_budget-members.html b/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
index ddeda17..26e4bee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_budget.html b/docs/html/struct_d3_d12_m_a_1_1_budget.html
index 4798ab6..8e8f354 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_budget.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_budget.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Budget Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Statistics fetched from the library.
UINT64 UsageBytes Estimated current memory usage of the program.
UINT64 BudgetBytes Estimated amount of memory available to the program.
-Detailed Description
+Detailed Description
Statistics of current memory usage and available budget for a specific memory segment group.
These are fast to calculate. See function D3D12MA::Allocator::GetBudget().
-Member Data Documentation
+Member Data Documentation
◆ BudgetBytes
@@ -129,8 +113,8 @@
Estimated amount of memory available to the program.
-Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
-It might be different (most probably smaller) than memory capacity returned by D3D12MA::Allocator::GetMemoryCapacity() due to factors external to the program, decided by the operating system. Difference BudgetBytes - UsageBytes is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.
+Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
+It might be different (most probably smaller) than memory capacity returned by D3D12MA::Allocator::GetMemoryCapacity() due to factors external to the program, decided by the operating system. Difference BudgetBytes - UsageBytes is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.
@@ -163,8 +147,8 @@
Estimated current memory usage of the program.
-Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
-It might be different than BlockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipeline state objects, descriptor heaps, command lists, or heaps and resources allocated outside of this library, if any.
+Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
+It might be different than BlockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipeline state objects, descriptor heaps, command lists, or heaps and resources allocated outside of this library, if any.
@@ -174,7 +158,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 656581f..9423c7f 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 49c2950..cae7b08 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,49 +90,40 @@
Inheritance diagram for D3D12MA::CALLOCATION_DESC:
-
-
-
+
Public Member Functions
CALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CALLOCATION_DESC (const ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::ALLOCATION_DESC structure.
CALLOCATION_DESC (Pool *customPool, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of an allocation to be created in a specific custom pool.
CALLOCATION_DESC (D3D12_HEAP_TYPE heapType, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL, D3D12_HEAP_FLAGS extraHeapFlags=D3D12MA_RECOMMENDED_HEAP_FLAGS) noexcept Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::ALLOCATION_DESC Public Attributes inherited from D3D12MA::ALLOCATION_DESC ALLOCATION_FLAGS Flags Flags for the allocation.
D3D12_HEAP_TYPE HeapType The type of memory heap where the new allocation should be placed.
D3D12_HEAP_FLAGS ExtraHeapFlags Additional heap flags to be used when allocating memory.
Pool * CustomPool Custom pool to place the new resource in. Optional.
void * pPrivateData Custom general-purpose pointer that will be stored in D3D12MA::Allocation.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CALLOCATION_DESC() [1/4]
@@ -273,7 +251,7 @@
-Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
+Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
@@ -283,7 +261,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
index 1cb0dea..66262d0 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -110,7 +97,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
index fb6bf6f..37f7330 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CPOOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,61 +90,48 @@
Inheritance diagram for D3D12MA::CPOOL_DESC:
-
-
-
+
Public Member Functions
CPOOL_DESC ()=default Default constructor. Leaves the structure uninitialized.
CPOOL_DESC (const POOL_DESC &o) noexcept Constructor initializing from the base D3D12MA::POOL_DESC structure.
CPOOL_DESC (D3D12_HEAP_TYPE heapType, D3D12_HEAP_FLAGS heapFlags, POOL_FLAGS flags=D3D12MA_RECOMMENDED_POOL_FLAGS, UINT64 blockSize=0, UINT minBlockCount=0, UINT maxBlockCount=UINT_MAX, D3D12_RESIDENCY_PRIORITY residencyPriority=D3D12_RESIDENCY_PRIORITY_NORMAL) noexcept Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
CPOOL_DESC (const D3D12_HEAP_PROPERTIES heapProperties, D3D12_HEAP_FLAGS heapFlags, POOL_FLAGS flags=D3D12MA_RECOMMENDED_POOL_FLAGS, UINT64 blockSize=0, UINT minBlockCount=0, UINT maxBlockCount=UINT_MAX, D3D12_RESIDENCY_PRIORITY residencyPriority=D3D12_RESIDENCY_PRIORITY_NORMAL) noexcept Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::POOL_DESC Public Attributes inherited from D3D12MA::POOL_DESC POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CPOOL_DESC() [1/4]
@@ -264,7 +238,7 @@
-Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
+Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
@@ -320,7 +294,7 @@
-Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
+Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
@@ -330,7 +304,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 8eb5d11..da976da 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -104,7 +91,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index cb1fe74..714062b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,43 +90,36 @@
Inheritance diagram for D3D12MA::CVIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_ALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_ALLOCATION_DESC (const VIRTUAL_ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
CVIRTUAL_ALLOCATION_DESC (UINT64 size, UINT64 alignment, VIRTUAL_ALLOCATION_FLAGS flags=VIRTUAL_ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of a virtual allocation with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_ALLOCATION_DESC() [1/3]
@@ -241,7 +221,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index eeecc96..27af579 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index 78fbb71..e24e9a8 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,40 +90,34 @@
Inheritance diagram for D3D12MA::CVIRTUAL_BLOCK_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_BLOCK_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_BLOCK_DESC (const VIRTUAL_BLOCK_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_BLOCK_DESC structure.
CVIRTUAL_BLOCK_DESC (UINT64 size, VIRTUAL_BLOCK_FLAGS flags=VIRTUAL_BLOCK_FLAG_NONE, const ALLOCATION_CALLBACKS *allocationCallbacks=NULL) noexcept Constructor initializing description of a virtual block with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_BLOCK_DESC() [1/3]
@@ -233,7 +214,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
index 698ab11..69adefa 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
index c65cd1a..242a2ed 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_FLAGS Flags Flags.
UINT64 MaxBytesPerPass Maximum numbers of bytes that can be copied during single pass, while moving allocations to different places.
UINT32 MaxAllocationsPerPass Maximum number of allocations that can be moved during single pass to a different place.
-Detailed Description
+Detailed Description
Parameters for defragmentation.
To be used with functions Allocator::BeginDefragmentation() and Pool::BeginDefragmentation().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -172,7 +156,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
index 4fed39a..f20848d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
index 8a8bf70..87c182e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_MOVE Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_MOVE_OPERATION Operation Operation to be performed on the allocation by DefragmentationContext::EndPass(). Default value is DEFRAGMENTATION_MOVE_OPERATION_COPY. You can modify it.
Allocation * pSrcAllocation Allocation that should be moved.
Allocation * pDstTmpAllocation Temporary allocation pointing to destination memory that will replace pSrcAllocation.
Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Detailed Description
+Detailed Description
Single move of an allocation to be done for defragmentation.
-Member Data Documentation
+Member Data Documentation
◆ Operation
@@ -143,9 +127,9 @@
-Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
-- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make
pSrcAllocation point to this memory.
+Temporary allocation pointing to destination memory that will replace pSrcAllocation.
+Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
+- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make pSrcAllocation point to this memory.
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
index 28aefc6..3e0a1e4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -99,7 +86,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
index 1212826..6e37ac2 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,19 +87,17 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT32 MoveCount Number of elements in the pMoves array.
Number of elements in the pMoves array.
DEFRAGMENTATION_MOVE * pMoves Array of moves to be performed by the user in the current defragmentation pass.
-Detailed Description
+Detailed Description
Parameters for incremental defragmentation steps.
To be used with function DefragmentationContext::BeginPass().
-Member Data Documentation
+Member Data Documentation
◆ MoveCount
@@ -125,7 +110,7 @@
-Number of elements in the pMoves array.
+Number of elements in the pMoves array.
@@ -142,12 +127,12 @@
Array of moves to be performed by the user in the current defragmentation pass.
-Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
+Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
For each element, you should:
-- Create a new resource in the place pointed by
pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
-- Store new resource in
pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
-- Copy data from the
pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
+- Create a new resource in the place pointed by pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
+- Store new resource in pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
+- Copy data from the pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
- Make sure these commands finished executing on the GPU.
Only then you can finish defragmentation pass by calling DefragmentationContext::EndPass(). After this call, the allocation will point to the new place in memory.
@@ -162,7 +147,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
index 6723fa3..be2d910 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
index b7f806d..220d0bd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_STATS Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,24 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 BytesMoved Total number of bytes that have been copied while moving allocations to different places.
UINT64 BytesFreed Total number of bytes that have been released to the system by freeing empty heaps.
UINT32 AllocationsMoved Number of allocations that have been moved to different places.
UINT32 HeapsFreed Number of empty ID3D12Heap objects that have been released to the system.
Number of empty ID3D12Heap objects that have been released to the system.
-Detailed Description
+Detailed Description
Statistics returned for defragmentation process by function DefragmentationContext::GetStats().
-Member Data Documentation
+Member Data Documentation
◆ AllocationsMoved
@@ -178,7 +161,7 @@
-Number of empty ID3D12Heap objects that have been released to the system.
+Number of empty ID3D12Heap objects that have been released to the system.
@@ -188,7 +171,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
index 9167002..13c5446 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
index f4f534a..88fa33d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DetailedStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,35 +87,29 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Basic statistics.
UINT UnusedRangeCount Number of free ranges of memory between allocations.
UINT64 AllocationSizeMin Smallest allocation size. UINT64_MAX if there are 0 allocations.
Smallest allocation size. UINT64_MAX if there are 0 allocations.
UINT64 AllocationSizeMax Largest allocation size. 0 if there are 0 allocations.
UINT64 UnusedRangeSizeMin Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
UINT64 UnusedRangeSizeMax Largest empty range size. 0 if there are 0 empty ranges.
-Detailed Description
+Detailed Description
More detailed statistics than D3D12MA::Statistics.
These are slower to calculate. Use for debugging purposes. See functions: D3D12MA::Allocator::CalculateStatistics(), D3D12MA::Pool::CalculateStatistics().
Averages are not provided because they can be easily calculated as:
UINT64 AllocationSizeAvg = DetailedStats.Statistics.AllocationBytes / detailedStats.Statistics.AllocationCount;
UINT64 UnusedBytes = DetailedStats.Statistics.BlockBytes - DetailedStats.Statistics.AllocationBytes;
UINT64 UnusedRangeSizeAvg = UnusedBytes / DetailedStats.UnusedRangeCount;
- Member Data Documentation
+ Member Data Documentation
◆ AllocationSizeMax
@@ -157,7 +138,7 @@
-Smallest allocation size. UINT64_MAX if there are 0 allocations.
+Smallest allocation size. UINT64_MAX if there are 0 allocations.
@@ -221,7 +202,7 @@
-Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
+Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
@@ -231,7 +212,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
index 2ae0d33..654ade6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
index fcb0f64..d812aff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::POOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,45 +90,36 @@
Inheritance diagram for D3D12MA::POOL_DESC:
-
-
-
+
Public Attributes
POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool.
-Member Data Documentation
+Member Data Documentation
◆ BlockSize
@@ -189,7 +167,7 @@
Heap flags to be used when allocating heaps of this pool.
-It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
+It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
It is recommended to also add D3D12MA_RECOMMENDED_POOL_FLAGS. You can specify additional flags if needed.
@@ -207,7 +185,7 @@
The parameters of memory heap where allocations of this pool should be placed.
-In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
+In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
@@ -224,7 +202,7 @@
Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
-Set to 0 to use default, which is UINT64_MAX, which means no limit.
+Set to 0 to use default, which is UINT64_MAX, which means no limit.
Set to same value as D3D12MA::POOL_DESC::MinBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.
@@ -293,10 +271,10 @@
Residency priority to be set for all allocations made in this pool. Optional.
-Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
-Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
-This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
-There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
+Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
+Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
+This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
+There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
@@ -306,7 +284,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
index a970156..67b61fe 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
index b7e7c30..853c2ff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Statistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,21 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT BlockCount Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
UINT AllocationCount Number of D3D12MA::Allocation objects allocated.
UINT64 BlockBytes Number of bytes allocated in memory blocks.
UINT64 AllocationBytes Total number of bytes occupied by all D3D12MA::Allocation objects.
-Detailed Description
+Detailed Description
Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total.
These are fast to calculate. See functions: D3D12MA::Allocator::GetBudget(), D3D12MA::Pool::GetStatistics().
-Member Data Documentation
+Member Data Documentation
◆ AllocationBytes
@@ -132,7 +115,7 @@
Total number of bytes occupied by all D3D12MA::Allocation objects.
-Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
+Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
@@ -149,7 +132,7 @@
Number of D3D12MA::Allocation objects allocated.
-Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
+Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
@@ -181,7 +164,7 @@
-Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
+Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
-
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
ID3D12Device::CreateCommittedResource, but it may really call ID3D12Device::CreatePlacedResource to assign part of a larger, existing memory heap to the new resource, which is the main purpose of this whole library.ppvResource is null, you receive only ppAllocation object from this function. It holds pointer to ID3D12Resource that can be queried using function D3D12MA::Allocation::GetResource(). Reference count of the resource object is 1. It is automatically destroyed when you destroy the allocation object.ppvResource is not null, you receive pointer to the resource next to allocation object. Reference count of the resource object is then increased by calling QueryInterface, so you need to manually Release it along with the allocation.
-Similar to Allocator::CreateResource, but supports new structure D3D12_RESOURCE_DESC1.
-It internally uses ID3D12Device8::CreateCommittedResource2 or ID3D12Device8::CreatePlacedResource1.
-To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
+Similar to Allocator::CreateResource, but supports new structure D3D12_RESOURCE_DESC1.
+It internally uses ID3D12Device8::CreateCommittedResource2 or ID3D12Device8::CreatePlacedResource1.
+To work correctly, ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned.
@@ -648,8 +616,8 @@
Similar to Allocator::CreateResource2, but there are initial layout instead of state and castable formats list.
-It internally uses ID3D12Device10::CreateCommittedResource3 or ID3D12Device10::CreatePlacedResource2.
-To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
+It internally uses ID3D12Device10::CreateCommittedResource3 or ID3D12Device10::CreatePlacedResource2.
+To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
@@ -700,14 +668,14 @@ IsUMA() == FALSE (discrete graphics card):
-pLocalBudget returns the budget of the video memory.pNonLocalBudget returns the budget of the system memory available for D3D12 resources.- When IsUMA() == FALSE (discrete graphics card):
+- pLocalBudget returns the budget of the video memory.
+- pNonLocalBudget returns the budget of the system memory available for D3D12 resources.
-- When IsUMA()
== TRUE (integrated graphics chip):
-pLocalBudget returns the budget of the shared memory available for all D3D12 resources. All memory is considered "local".pNonLocalBudget is not applicable and returns zeros.- When IsUMA() == TRUE (integrated graphics chip):
+- pLocalBudget returns the budget of the shared memory available for all D3D12 resources. All memory is considered "local".
+- pNonLocalBudget is not applicable and returns zeros.
@@ -753,20 +721,20 @@ - Parameters
-
- memorySegmentGroup use DXGI_MEMORY_SEGMENT_GROUP_LOCAL or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL. memorySegmentGroup use DXGI_MEMORY_SEGMENT_GROUP_LOCAL or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL.
D3D12_RESOURCE_DESC1. ID3D12Device8::CreateCommittedResource2 or ID3D12Device8::CreatePlacedResource1.ID3D12Device8 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. Similar to Allocator::CreateResource2, but there are initial layout instead of state and castable formats list.
-It internally uses ID3D12Device10::CreateCommittedResource3 or ID3D12Device10::CreatePlacedResource2.
To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
It internally uses ID3D12Device10::CreateCommittedResource3 or ID3D12Device10::CreatePlacedResource2.
+To work correctly, ID3D12Device10 interface must be available in the current system. Otherwise, E_NOINTERFACE is returned. If you use pCastableFormats, ID3D12Device12 must albo be available.
@@ -700,14 +668,14 @@IsUMA() == FALSE (discrete graphics card):
-pLocalBudget returns the budget of the video memory.pNonLocalBudget returns the budget of the system memory available for D3D12 resources.- When IsUMA() == FALSE (discrete graphics card):
+- pLocalBudget returns the budget of the video memory.
+- pNonLocalBudget returns the budget of the system memory available for D3D12 resources.
-- When IsUMA()
== TRUE (integrated graphics chip):
-pLocalBudget returns the budget of the shared memory available for all D3D12 resources. All memory is considered "local".pNonLocalBudget is not applicable and returns zeros.- When IsUMA() == TRUE (integrated graphics chip):
+- pLocalBudget returns the budget of the shared memory available for all D3D12 resources. All memory is considered "local".
+- pNonLocalBudget is not applicable and returns zeros.
@@ -753,20 +721,20 @@ - Parameters
-
- memorySegmentGroup use DXGI_MEMORY_SEGMENT_GROUP_LOCAL or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL. memorySegmentGroup use DXGI_MEMORY_SEGMENT_GROUP_LOCAL or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL.
pLocalBudget returns the budget of the video memory.pNonLocalBudget returns the budget of the system memory available for D3D12 resources.-
+
- pLocalBudget returns the budget of the video memory. +
- pNonLocalBudget returns the budget of the system memory available for D3D12 resources.
== TRUE (integrated graphics chip):-
-
pLocalBudgetreturns the budget of the shared memory available for all D3D12 resources. All memory is considered "local".
-pNonLocalBudgetis not applicable and returns zeros.
+- When IsUMA() == TRUE (integrated graphics chip):
-
+
- pLocalBudget returns the budget of the shared memory available for all D3D12 resources. All memory is considered "local". +
- pNonLocalBudget is not applicable and returns zeros.
- Parameters
-
- memorySegmentGroup use DXGI_MEMORY_SEGMENT_GROUP_LOCAL or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL. memorySegmentGroup use DXGI_MEMORY_SEGMENT_GROUP_LOCAL or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL.
| memorySegmentGroup | use DXGI_MEMORY_SEGMENT_GROUP_LOCAL or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL. |
| memorySegmentGroup | use DXGI_MEMORY_SEGMENT_GROUP_LOCAL or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL. |
DXGI_ADAPTER_DESC. It is not recommended to use this number. You should preferably call GetBudget() and limit memory usage to D3D12MA::Budget::BudgetBytes instead.== FALSE (discrete graphics card):-
-
GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL)returns the size of the video memory.
-GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL)returns the size of the system memory available for D3D12 resources.
+- When IsUMA() == FALSE (discrete graphics card):
-
+
- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the video memory. +
- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) returns the size of the system memory available for D3D12 resources.
- - When IsUMA()
== TRUE(integrated graphics chip):-
-
GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL)returns the size of the shared memory available for all D3D12 resources. All memory is considered "local".
-GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL)is not applicable and returns 0.
+- When IsUMA() == TRUE (integrated graphics chip):
-
+
- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_LOCAL) returns the size of the shared memory available for all D3D12 resources. All memory is considered "local". +
- GetMemoryCapacity(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) is not applicable and returns 0.
-
Returns true if
+D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMAwas found to be true.Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMA was found to be true.
For more information about how to use it, see articles in Microsoft Docs articles:
- "UMA Optimizations: CPU Accessible Textures and Standard Swizzle" @@ -814,8 +782,8 @@
- "UMA Optimizations: CPU Accessible Textures and Standard Swizzle" @@ -870,7 +838,7 @@
- Returns
-
-
S_OKif no more moves are possible. Then you can omit call to DefragmentationContext::EndPass() and simply end whole defragmentation.
-S_FALSEif there are pending moves returned inpPassInfo. You need to perform them, call DefragmentationContext::EndPass(), and then preferably try another pass with DefragmentationContext::BeginPass().
+- S_OK if no more moves are possible. Then you can omit call to DefragmentationContext::EndPass() and simply end whole defragmentation. +
- S_FALSE if there are pending moves returned in pPassInfo. You need to perform them, call DefragmentationContext::EndPass(), and then preferably try another pass with DefragmentationContext::BeginPass().
@@ -174,11 +158,11 @@ - Returns
- Returns
S_OKif no more moves are possible orS_FALSEif more defragmentations are possible.
- - Returns
- Returns S_OK if no more moves are possible or S_FALSE if more defragmentations are possible.
- Allocation at
pPassInfo[i].pSrcAllocationthat hadpPassInfo[i].Operation ==DEFRAGMENTATION_MOVE_OPERATION_COPY (which is the default) will be pointing to the new destination place.
- - Allocation at
pPassInfo[i].pSrcAllocationthat hadpPassInfo[i].operation ==DEFRAGMENTATION_MOVE_OPERATION_DESTROY will be released.
+ - Allocation at pPassInfo[i].pSrcAllocation that had pPassInfo[i].Operation == DEFRAGMENTATION_MOVE_OPERATION_COPY (which is the default) will be pointing to the new destination place. +
- Allocation at pPassInfo[i].pSrcAllocation that had pPassInfo[i].operation == DEFRAGMENTATION_MOVE_OPERATION_DESTROY will be released.
- Returns
-
-
S_OKif defragmentation can begin.
-E_NOINTERFACEif defragmentation is not supported.
+- S_OK if defragmentation can begin. +
- E_NOINTERFACE if defragmentation is not supported.
- Returns
S_OKif allocation succeeded,E_OUTOFMEMORYif it failed.
-- Returns
- S_OK if allocation succeeded, E_OUTOFMEMORY if it failed.
- To keep some resources separate from others in memory.
- To keep track of memory usage of just a specific group of resources. Statistics can be queried using D3D12MA::Pool::CalculateStatistics. -
- To use specific size of a memory block (
ID3D12Heap). To set it, use member D3D12MA::POOL_DESC::BlockSize. When set to 0, the library uses automatically determined, variable block sizes.
+ - To use specific size of a memory block (ID3D12Heap). To set it, use member D3D12MA::POOL_DESC::BlockSize. When set to 0, the library uses automatically determined, variable block sizes.
- To reserve some minimum amount of memory allocated. To use it, set member D3D12MA::POOL_DESC::MinBlockCount.
- To limit maximum amount of memory allocated. To use it, set member D3D12MA::POOL_DESC::MaxBlockCount. -
- To use extended parameters of the D3D12 memory allocation. While resources created from default pools can only specify
D3D12_HEAP_TYPE_DEFAULT,UPLOAD,READBACK, a custom pool may use non-standardD3D12_HEAP_PROPERTIES(member D3D12MA::POOL_DESC::HeapProperties) andD3D12_HEAP_FLAGS(D3D12MA::POOL_DESC::HeapFlags), which is useful e.g. for cross-adapter sharing or UMA (see also D3D12MA::Allocator::IsUMA).
+ - To use extended parameters of the D3D12 memory allocation. While resources created from default pools can only specify D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK, a custom pool may use non-standard D3D12_HEAP_PROPERTIES (member D3D12MA::POOL_DESC::HeapProperties) and D3D12_HEAP_FLAGS (D3D12MA::POOL_DESC::HeapFlags), which is useful e.g. for cross-adapter sharing or UMA (see also D3D12MA::Allocator::IsUMA).
- D3D12MA::DefragmentationContext::BeginPass() function call:
- Calculates and returns the list of allocations to be moved in this pass. Note this can be a time-consuming process. -
- Reserves destination memory for them by creating temporary destination allocations that you can query for their
ID3D12Heap+ offset using methods like D3D12MA::Allocation::GetHeap().
+ - Reserves destination memory for them by creating temporary destination allocations that you can query for their ID3D12Heap + offset using methods like D3D12MA::Allocation::GetHeap().
- Inside the pass, you should:
-
@@ -179,40 +166,40 @@
- D3D12MA::DefragmentationContext::EndPass() function call:
- Frees the source memory reserved for the allocations that are moved.
- Modifies source D3D12MA::Allocation objects that are moved to point to the destination reserved memory and destination resource, while source resource is released. -
- Frees
ID3D12Heapblocks that became empty.
+ - Frees ID3D12Heap blocks that became empty.
- D3D12MA::DefragmentationContext::EndPass() function call:
- You should copy its data from the source to the destination place by calling e.g.
CopyResource().-
+
- You should copy its data from the source to the destination place by calling e.g. CopyResource().
- You need to make sure these commands finished executing before the source buffers/textures are released by D3D12MA::DefragmentationContext::EndPass().
- If a resource doesn't contain any meaningful data, e.g. it is a transient render-target texture to be cleared, filled, and used temporarily in each rendering frame, you can just recreate this texture without copying its data. -
- If the resource is in
D3D12_HEAP_TYPE_READBACKmemory, you can copy its data on the CPU usingmemcpy().
- - If you cannot move the allocation, you can set
pass.pMoves[i].Operationto D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This will cancel the move.-
+
- If the resource is in D3D12_HEAP_TYPE_READBACK memory, you can copy its data on the CPU using memcpy(). +
- If you cannot move the allocation, you can set pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This will cancel the move.
- D3D12MA::DefragmentationContext::EndPass() will then free the destination memory not the source memory of the allocation, leaving it unchanged.
- - If you decide the allocation is unimportant and can be destroyed instead of moved (e.g. it wasn't used for long time), you can set
pass.pMoves[i].Operationto D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY.-
+
- If you decide the allocation is unimportant and can be destroyed instead of moved (e.g. it wasn't used for long time), you can set pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY.
- D3D12MA::DefragmentationContext::EndPass() will then free both source and destination memory, and will destroy the source D3D12MA::Allocation object.
You can defragment a specific custom pool by calling D3D12MA::Pool::BeginDefragmentation or all the default pools by calling D3D12MA::Allocator::BeginDefragmentation (like in the example above).
-Defragmentation is always performed in each pool separately. Allocations are never moved between different heap types. The size of the destination memory reserved for a moved allocation is the same as the original one. Alignment of an allocation as it was determined using
+GetResourceAllocationInfo()is also respected after defragmentation. Buffers/textures should be recreated with the sameD3D12_RESOURCE_DESCparameters as the original ones.Defragmentation is always performed in each pool separately. Allocations are never moved between different heap types. The size of the destination memory reserved for a moved allocation is the same as the original one. Alignment of an allocation as it was determined using GetResourceAllocationInfo() is also respected after defragmentation. Buffers/textures should be recreated with the same D3D12_RESOURCE_DESC parameters as the original ones.
You can perform the defragmentation incrementally to limit the number of allocations and bytes to be moved in each pass, e.g. to call it in sync with render frames and not to experience too big hitches. See members: D3D12MA::DEFRAGMENTATION_DESC::MaxBytesPerPass, D3D12MA::DEFRAGMENTATION_DESC::MaxAllocationsPerPass.
Thread safety: It is safe to perform the defragmentation asynchronously to render frames and other Direct3D 12 and D3D12MA usage, possibly from multiple threads, with the exception that allocations returned in D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO::pMoves shouldn't be released until the defragmentation pass is ended. During the call to D3D12MA::DefragmentationContext::BeginPass(), any operations on the memory pool affected by the defragmentation are blocked by a mutex.
-What it means in practice is that you shouldn't free any allocations from the defragmented pool since the moment a call to
+BeginPassbegins. Otherwise, a thread performing theallocation->Release()would block for the timeBeginPassexecutes and then free the allocation when it finishes, while the allocation could have ended up on the list of allocations to move. A solution to freeing allocations during defragmentation is to find such allocation on the listpass.pMoves[i]and set its operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY instead of callingallocation->Release(), or simply deferring the release to the time after defragmentation finished.What it means in practice is that you shouldn't free any allocations from the defragmented pool since the moment a call to BeginPass begins. Otherwise, a thread performing the allocation->Release() would block for the time BeginPass executes and then free the allocation when it finishes, while the allocation could have ended up on the list of allocations to move. A solution to freeing allocations during defragmentation is to find such allocation on the list pass.pMoves[i] and set its operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY instead of calling allocation->Release(), or simply deferring the release to the time after defragmentation finished.
Mapping is out of scope of this library and so it is not preserved after an allocation is moved during defragmentation. You need to map the new resource yourself if needed.
- Note
- Defragmentation is not supported in custom pools created with D3D12MA::POOL_FLAG_ALGORITHM_LINEAR.
- If you decide the allocation is unimportant and can be destroyed instead of moved (e.g. it wasn't used for long time), you can set pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_DESTROY.
- You should copy its data from the source to the destination place by calling e.g. CopyResource().
- D3D12MA allocates large blocks of
ID3D12Heapmemory and sub-allocates parts of them to create your placed resources. Allocating a new block of GPU memory may be a time-consuming operation. Sub-allocating parts of a memory block requires implementing an allocation algorithm, which is a non-trivial task. D3D12MA does that, using an advanced and efficient algorithm that works well in various use cases.
+ - D3D12MA allocates large blocks of ID3D12Heap memory and sub-allocates parts of them to create your placed resources. Allocating a new block of GPU memory may be a time-consuming operation. Sub-allocating parts of a memory block requires implementing an allocation algorithm, which is a non-trivial task. D3D12MA does that, using an advanced and efficient algorithm that works well in various use cases.
- D3D12MA offers a simple API that allows creating placed buffers and textures within one function call like D3D12MA::Allocator::CreateResource.
- D3D12MA doesn't throw or catch any C++ exceptions. It reports errors by returning a
HRESULTvalue instead, just like DX12. If you don't use exceptions in your project, your code is not exception-safe, or even if you disable exception handling in the compiler options, you can still use D3D12MA.
- - D3D12MA doesn't use C++ run-time type information like
typeidordynamic_cast, so if you disable RTTI in the compiler options, you can still use the library.
- - D3D12MA uses only a limited subset of standard C and C++ library. It doesn't use STL containers like
std::vector,map, orstring, either in the public interface nor in the internal implementation. It implements its own containers instead.
- - If you don't use the default heap memory allocator through
malloc/freeornew/deletebut implement your own allocator instead, you can pass it to D3D12MA as D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks and the library will use your functions for every dynamic heap allocation made internally.
+ - D3D12MA doesn't throw or catch any C++ exceptions. It reports errors by returning a HRESULT value instead, just like DX12. If you don't use exceptions in your project, your code is not exception-safe, or even if you disable exception handling in the compiler options, you can still use D3D12MA. +
- D3D12MA doesn't use C++ run-time type information like typeid or dynamic_cast, so if you disable RTTI in the compiler options, you can still use the library. +
- D3D12MA uses only a limited subset of standard C and C++ library. It doesn't use STL containers like std::vector, map, or string, either in the public interface nor in the internal implementation. It implements its own containers instead. +
- If you don't use the default heap memory allocator through malloc/free or new/delete but implement your own allocator instead, you can pass it to D3D12MA as D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks and the library will use your functions for every dynamic heap allocation made internally.
- Enable D3D Debug Layer and make sure it is free from any errors. -
- Make sure
D3D12MA_ASSERTis defined to an implementation that can report a failure and not ignore it.
- - Try making your allocation using pure DX12 functions like
CreateCommittedResource()rather than D3D12MA and see if the bug persists.
+ - Make sure D3D12MA_ASSERT is defined to an implementation that can report a failure and not ignore it. +
- Try making your allocation using pure DX12 functions like CreateCommittedResource() rather than D3D12MA and see if the bug persists.
- Alignment : D3D12MA::VIRTUAL_ALLOCATION_DESC
- Allocate() : D3D12MA::VirtualBlock
- AllocateMemory() : D3D12MA::Allocator @@ -100,7 +87,7 @@
- BeginDefragmentation() : D3D12MA::Allocator, D3D12MA::Pool
- BeginPass() : D3D12MA::DefragmentationContext
- block : D3D12MA::Allocation @@ -114,7 +101,7 @@
- CalculateStatistics() : D3D12MA::Allocator, D3D12MA::Pool, D3D12MA::VirtualBlock
- CALLOCATION_DESC() : D3D12MA::CALLOCATION_DESC
- Clear() : D3D12MA::VirtualBlock @@ -134,25 +121,25 @@
- D3D12MA_DELETE : D3D12MA::Allocation, D3D12MA::Allocator, D3D12MA::DefragmentationContext, D3D12MA::Pool, D3D12MA::VirtualBlock
- EndPass() : D3D12MA::DefragmentationContext
- ExtraHeapFlags : D3D12MA::ALLOCATION_DESC
- Flags : D3D12MA::ALLOCATION_DESC, D3D12MA::ALLOCATOR_DESC, D3D12MA::DEFRAGMENTATION_DESC, D3D12MA::POOL_DESC, D3D12MA::VIRTUAL_ALLOCATION_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
- FreeAllocation() : D3D12MA::VirtualBlock
- FreeStatsString() : D3D12MA::Allocator, D3D12MA::VirtualBlock
- GetAlignment() : D3D12MA::Allocation
- GetAllocationInfo() : D3D12MA::VirtualBlock
- GetBudget() : D3D12MA::Allocator @@ -170,7 +157,7 @@
- heap : D3D12MA::Allocation
- HeapFlags : D3D12MA::POOL_DESC
- HeapProperties : D3D12MA::POOL_DESC @@ -179,7 +166,7 @@
- IsCacheCoherentUMA() : D3D12MA::Allocator
- IsEmpty() : D3D12MA::VirtualBlock
- IsGPUUploadHeapSupported() : D3D12MA::Allocator @@ -187,12 +174,12 @@
- list : D3D12MA::Allocation
- m_Committed : D3D12MA::Allocation
- m_Heap : D3D12MA::Allocation
- m_Placed : D3D12MA::Allocation @@ -206,18 +193,18 @@
- next : D3D12MA::Allocation
- Offset : D3D12MA::VIRTUAL_ALLOCATION_INFO
- Operation : D3D12MA::DEFRAGMENTATION_MOVE
- pAdapter : D3D12MA::ALLOCATOR_DESC
- pAllocate : D3D12MA::ALLOCATION_CALLBACKS
- pAllocationCallbacks : D3D12MA::ALLOCATOR_DESC, D3D12MA::VIRTUAL_BLOCK_DESC @@ -233,12 +220,12 @@
- ResidencyPriority : D3D12MA::POOL_DESC
- SetAllocationPrivateData() : D3D12MA::VirtualBlock
- SetCurrentFrameIndex() : D3D12MA::Allocator
- SetName() : D3D12MA::Allocation, D3D12MA::Pool @@ -249,12 +236,12 @@
- Total : D3D12MA::TotalStatistics
- UnusedRangeCount : D3D12MA::DetailedStatistics
- UnusedRangeSizeMax : D3D12MA::DetailedStatistics
- UnusedRangeSizeMin : D3D12MA::DetailedStatistics @@ -263,7 +250,7 @@
- Allocate() : D3D12MA::VirtualBlock
- AllocateMemory() : D3D12MA::Allocator
- BeginDefragmentation() : D3D12MA::Allocator, D3D12MA::Pool
- BeginPass() : D3D12MA::DefragmentationContext
- BuildStatsString() : D3D12MA::Allocator, D3D12MA::VirtualBlock
- CalculateStatistics() : D3D12MA::Allocator, D3D12MA::Pool, D3D12MA::VirtualBlock
- CALLOCATION_DESC() : D3D12MA::CALLOCATION_DESC
- Clear() : D3D12MA::VirtualBlock @@ -116,18 +103,18 @@
- EndPass() : D3D12MA::DefragmentationContext
- FreeAllocation() : D3D12MA::VirtualBlock
- FreeStatsString() : D3D12MA::Allocator, D3D12MA::VirtualBlock
- GetAlignment() : D3D12MA::Allocation
- GetAllocationInfo() : D3D12MA::VirtualBlock
- GetBudget() : D3D12MA::Allocator @@ -145,7 +132,7 @@
- IsCacheCoherentUMA() : D3D12MA::Allocator
- IsEmpty() : D3D12MA::VirtualBlock
- IsGPUUploadHeapSupported() : D3D12MA::Allocator @@ -153,7 +140,7 @@
- SetAllocationPrivateData() : D3D12MA::VirtualBlock
- SetCurrentFrameIndex() : D3D12MA::Allocator
- SetName() : D3D12MA::Allocation, D3D12MA::Pool @@ -163,7 +150,7 @@
- Alignment : D3D12MA::VIRTUAL_ALLOCATION_DESC
- AllocationBytes : D3D12MA::Statistics
- AllocationCount : D3D12MA::Statistics @@ -98,7 +85,7 @@
- block : D3D12MA::Allocation
- BlockBytes : D3D12MA::Statistics
- BlockCount : D3D12MA::Statistics @@ -109,22 +96,22 @@
- CustomPool : D3D12MA::ALLOCATION_DESC
- ExtraHeapFlags : D3D12MA::ALLOCATION_DESC
- Flags : D3D12MA::ALLOCATION_DESC, D3D12MA::ALLOCATOR_DESC, D3D12MA::DEFRAGMENTATION_DESC, D3D12MA::POOL_DESC, D3D12MA::VIRTUAL_ALLOCATION_DESC, D3D12MA::VIRTUAL_BLOCK_DESC
- heap : D3D12MA::Allocation
- HeapFlags : D3D12MA::POOL_DESC
- HeapProperties : D3D12MA::POOL_DESC @@ -133,12 +120,12 @@
- list : D3D12MA::Allocation
- m_Committed : D3D12MA::Allocation
- m_Heap : D3D12MA::Allocation
- m_Placed : D3D12MA::Allocation @@ -152,18 +139,18 @@
- next : D3D12MA::Allocation
- Offset : D3D12MA::VIRTUAL_ALLOCATION_INFO
- Operation : D3D12MA::DEFRAGMENTATION_MOVE
- pAdapter : D3D12MA::ALLOCATOR_DESC
- pAllocate : D3D12MA::ALLOCATION_CALLBACKS
- pAllocationCallbacks : D3D12MA::ALLOCATOR_DESC, D3D12MA::VIRTUAL_BLOCK_DESC @@ -179,23 +166,23 @@
- ResidencyPriority : D3D12MA::POOL_DESC
- Size : D3D12MA::VIRTUAL_ALLOCATION_DESC, D3D12MA::VIRTUAL_ALLOCATION_INFO, D3D12MA::VIRTUAL_BLOCK_DESC
- Stats : D3D12MA::Budget, D3D12MA::DetailedStatistics
- Total : D3D12MA::TotalStatistics
- UnusedRangeCount : D3D12MA::DetailedStatistics
- UnusedRangeSizeMax : D3D12MA::DetailedStatistics
- UnusedRangeSizeMin : D3D12MA::DetailedStatistics @@ -204,7 +191,7 @@
- The library has no global state, so separate D3D12MA::Allocator objects can be used independently. In typical applications there should be no need to create multiple such objects though - one per
ID3D12Deviceis enough.
+ - The library has no global state, so separate D3D12MA::Allocator objects can be used independently. In typical applications there should be no need to create multiple such objects though - one per ID3D12Device is enough.
- All calls to methods of D3D12MA::Allocator class are safe to be made from multiple threads simultaneously because they are synchronized internally when needed.
- When the allocator is created with D3D12MA::ALLOCATOR_FLAG_SINGLETHREADED, calls to methods of D3D12MA::Allocator class must be made from a single thread or synchronized by the user. Using this flag may improve performance.
- D3D12MA::VirtualBlock is not safe to be used from multiple threads simultaneously.
- Warning
- Backward compatiblity is considered on the level of C++ source code, not binary linkage. Adding new members to existing structures is treated as backward compatible if initializing the new members to binary zero results in the old behavior. You should always fully initialize all library structures to zeros and not rely on their exact binary size.
- Descriptor allocation. Although also called "heaps", objects that represent descriptors are separate part of the D3D12 API from buffers and textures. You can still use Virtual allocator to manage descriptors and their ranges inside a descriptor heap.
- Support for reserved (tiled) resources. We don't recommend using them. For more information, see [1]. -
- Support for
ID3D12Device::EvictandMakeResident. We don't recommend using them. You can call them on the D3D12 objects manually. Plese keep in mind, however, that eviction happens on the level of entireID3D12Heapmemory blocks and not individual buffers or textures which may be placed inside them.
+ - Support for ID3D12Device::Evict and MakeResident. We don't recommend using them. You can call them on the D3D12 objects manually. Plese keep in mind, however, that eviction happens on the level of entire ID3D12Heap memory blocks and not individual buffers or textures which may be placed inside them.
- Handling CPU memory allocation failures. When dynamically creating small C++ objects in CPU memory (not the GPU memory), allocation failures are not handled gracefully, because that would complicate code significantly and is usually not needed in desktop PC applications anyway. Success of an allocation is just checked with an assert.
- Code free of any compiler warnings. There are many preprocessor macros that make some variables unused, function parameters unreferenced, or conditional expressions constant in some configurations. The code of this library should not be bigger or more complicated just to silence these warnings. It is recommended to disable such warnings instead.
- This is a C++ library. Bindings or ports to any other programming languages are welcome as external projects but are not going to be included into this repository. @@ -125,7 +112,7 @@
- Frequently asked questions @@ -131,10 +118,10 @@
- Direct3D 12 Memory Allocator at GPUOpen.com - product page +
- Direct3D 12 Memory Allocator at GPUOpen.com - product page
- GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com - source code repository
- When used with functions like D3D12MA::Allocator::CreateResource, it will use
ID3D12Device::CreateCommittedResource, so the created allocation will contain a resource (D3D12MA::Allocation::GetResource()!= NULL) but will not have a heap (D3D12MA::Allocation::GetHeap()== NULL), as the heap is implicit.
- - When used with raw memory allocation like D3D12MA::Allocator::AllocateMemory, it will use
ID3D12Device::CreateHeap, so the created allocation will contain a heap (D3D12MA::Allocation::GetHeap()!= NULL) and its offset will always be 0.
+ - When used with functions like D3D12MA::Allocator::CreateResource, it will use ID3D12Device::CreateCommittedResource, so the created allocation will contain a resource (D3D12MA::Allocation::GetResource() != NULL) but will not have a heap (D3D12MA::Allocation::GetHeap() == NULL), as the heap is implicit. +
- When used with raw memory allocation like D3D12MA::Allocator::AllocateMemory, it will use ID3D12Device::CreateHeap, so the created allocation will contain a heap (D3D12MA::Allocation::GetHeap() != NULL) and its offset will always be 0.
- ALLOCATE_FUNC_PTR : D3D12MA
- ALLOCATION_FLAG_CAN_ALIAS : D3D12MA
- ALLOCATION_FLAG_COMMITTED : D3D12MA @@ -112,13 +99,13 @@
- DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FAST : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FULL : D3D12MA @@ -131,12 +118,12 @@
- ALLOCATION_FLAG_CAN_ALIAS : D3D12MA
- ALLOCATION_FLAG_COMMITTED : D3D12MA
- ALLOCATION_FLAG_NEVER_ALLOCATE : D3D12MA @@ -108,7 +95,7 @@
- DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FAST : D3D12MA
- DEFRAGMENTATION_FLAG_ALGORITHM_FULL : D3D12MA @@ -119,7 +106,7 @@
- The allocation (resource creation) function call can fail with
HRESULTvalue other thanS_OK.
+ - The allocation (resource creation) function call can fail with HRESULT value other than S_OK.
- The allocation may succeed, but take long time (even a significant fraction of a second).
- Some resources are automatically demoted from video memory to system memory, degrading the app performance.
- Even a crash of the entire graphics driver can happen, resulting in the D3D12 "device removal", which is usually catastrophic for the application. @@ -113,34 +100,34 @@
- Implementation detail
- DXGI interface offers function
IDXGIAdapter3::QueryVideoMemoryInfothat queries the current memory usage and budget. This library automatically makes use of it when available (when you use recent enough version of the DirectX SDK). If not, it falls back to estimating the usage and budget based on the total amount of the allocated memory and 80% of the full memory capacity, respectively. - Implementation detail
- DXGI interface offers function IDXGIAdapter3::QueryVideoMemoryInfo that queries the current memory usage and budget. This library automatically makes use of it when available (when you use recent enough version of the DirectX SDK). If not, it falls back to estimating the usage and budget based on the total amount of the allocated memory and 80% of the full memory capacity, respectively.
- Implementation detail
- Allocating large heaps and creating placed resources in them is one of the main features of this library. However, if allocating new such block would exceed the budget, it will automatically prefer creating the resource as committed to have exactly the right size, which can lower the chance of getting into trouble in case of over-commitment.
- Implementation detail
- The CPU performance overhead of using this library is low. It uses a high-quality allocation algorithm called Two-Level Segregated Fit (TLSF), which in most cases can find a free place for a new allocation in few steps. The library also doesn't perform too many CPU heap allocations. In may cases, the allocation happens with 0 new CPU heap allocations performed by the library. Even the creation of a D3D12MA::Allocation object itself doesn't typically feature an CPU allocation, because these objects are returned out of a dedicated memory pool.
- D3D12MA::ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED is used during the creation of the main allocator object. -
D3D12_HEAP_FLAG_CREATE_NOT_ZEROEDis passed to D3D12MA::POOL_DESC::HeapFlags during the creation of a custom pool.
+- D3D12_HEAP_FLAG_CREATE_NOT_ZEROED is passed to D3D12MA::POOL_DESC::HeapFlags during the creation of a custom pool.
D3D12_HEAP_TYPE_DEFAULT: Represents the video memory. It is available and fast to access for the GPU. It should be used for all resources that are written by the GPU (like render-target and depth-stencil textures, UAV) and resources that are frequently read by the GPU (like textures intended for sampling, vertex, index, and constant buffers).
-D3D12_HEAP_TYPE_UPLOAD: Represents the system memory that is uncached and write-combined. It can be mapped and accessed by the CPU code using a pointer. It supports only buffers, not textures. It is intended for "staging buffers" that are filled by the CPU code and then used as a source of copy operations to theDEFAULTheap. It can also be accessed directly by the GPU - shaders can read from buffers created in this memory.
-D3D12_HEAP_TYPE_READBACK: Represents the system memory that is cached. It is intended for buffers used as a destination of copy operations from theDEFAULTheap.
+- D3D12_HEAP_TYPE_DEFAULT: Represents the video memory. It is available and fast to access for the GPU. It should be used for all resources that are written by the GPU (like render-target and depth-stencil textures, UAV) and resources that are frequently read by the GPU (like textures intended for sampling, vertex, index, and constant buffers). +
- D3D12_HEAP_TYPE_UPLOAD: Represents the system memory that is uncached and write-combined. It can be mapped and accessed by the CPU code using a pointer. It supports only buffers, not textures. It is intended for "staging buffers" that are filled by the CPU code and then used as a source of copy operations to the DEFAULT heap. It can also be accessed directly by the GPU - shaders can read from buffers created in this memory. +
- D3D12_HEAP_TYPE_READBACK: Represents the system memory that is cached. It is intended for buffers used as a destination of copy operations from the DEFAULT heap.
- Supporting operating system.
- The feature needs to be enabled in the UEFI settings. It is typically called "Above 4G Decoding" and "Resizable Bar".
- They support mapping and direct access from the CPU code through a pointer. -
- The mapped memory is uncached and write-combined, so it should be only written sequentially (e.g., number-by-number or using
memcpy). It shouldn't be accessed randomly or read, because it is extremely slow for uncached memory.
+ - The mapped memory is uncached and write-combined, so it should be only written sequentially (e.g., number-by-number or using memcpy). It shouldn't be accessed randomly or read, because it is extremely slow for uncached memory.
- Only buffers are supported.
- Those buffers can be used as a source of copy operations or directly accessed by the GPU.
- As
D3D12_HEAP_TYPE_UPLOADuses the system memory, writes from the CPU code through a mapped pointer are faster, while copies or direct access from the GPU are slower because they need to go through PCIe.
- - As the new
D3D12_HEAP_TYPE_GPU_UPLOADuses the video memory, copies or direct access from the GPU are faster, while writes from the CPU code through a mapped pointer can be slower, because they need to go through PCIe. For maximum performance of copy operations from this heap, a graphics or compute queue should be used, not a copy queue.
+ - As D3D12_HEAP_TYPE_UPLOAD uses the system memory, writes from the CPU code through a mapped pointer are faster, while copies or direct access from the GPU are slower because they need to go through PCIe. +
- As the new D3D12_HEAP_TYPE_GPU_UPLOAD uses the video memory, copies or direct access from the GPU are faster, while writes from the CPU code through a mapped pointer can be slower, because they need to go through PCIe. For maximum performance of copy operations from this heap, a graphics or compute queue should be used, not a copy queue.
- Committed, using function
ID3D12Device::CreateCommittedResource. It creates the resource with its own memory heap, which is called an "implicit heap" and cannot be accessed directly.
- - Placed, using function
ID3D12Device::CreatePlacedResource. AID3D12Heapneeds to be created beforehand usingID3D12Device::CreateHeap. Then, the resource can be created as placed inside the heap at a specific offset.
- - Reserved, using function
ID3D12Device::CreateReservedResource. This library doesn't support them directly.
+ - Committed, using function ID3D12Device::CreateCommittedResource. It creates the resource with its own memory heap, which is called an "implicit heap" and cannot be accessed directly. +
- Placed, using function ID3D12Device::CreatePlacedResource. A ID3D12Heap needs to be created beforehand using ID3D12Device::CreateHeap. Then, the resource can be created as placed inside the heap at a specific offset. +
- Reserved, using function ID3D12Device::CreateReservedResource. This library doesn't support them directly.
Returns true if GPU Upload Heaps are supported on the current system.
-When true, you can use
-D3D12_HEAP_TYPE_GPU_UPLOAD.This flag is fetched from
+D3D12_FEATURE_D3D12_OPTIONS16::GPUUploadHeapSupported.When true, you can use D3D12_HEAP_TYPE_GPU_UPLOAD.
+This flag is fetched from D3D12_FEATURE_D3D12_OPTIONS16::GPUUploadHeapSupported.
@@ -834,7 +802,7 @@-
Returns true if
+D3D12_FEATURE_DATA_ARCHITECTURE1::UMAwas found to be true.Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::UMA was found to be true.
For more information about how to use it, see articles in Microsoft Docs articles:
-Generated by
1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html
index 4049a20..6cfb1dd 100644
--- a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List - - @@ -33,33 +31,22 @@ - + -@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html
index 405cb9f..7ab0038 100644
--- a/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html
+++ b/docs/html/class_d3_d12_m_a_1_1_defragmentation_context.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DefragmentationContext Class Reference - - @@ -33,33 +31,22 @@ - + -@@ -106,22 +93,19 @@
-
-+
Public Member Functions
HRESULT BeginPass (DEFRAGMENTATION_PASS_MOVE_INFO *pPassInfo) Starts single defragmentation pass. HRESULT EndPass (DEFRAGMENTATION_PASS_MOVE_INFO *pPassInfo) Ends single defragmentation pass. void GetStats (DEFRAGMENTATION_STATS *pStats) Returns statistics of the defragmentation performed so far. Detailed Description
+Detailed Description
Represents defragmentation process in progress.
You can create this object using Allocator::BeginDefragmentation (for default pools) or Pool::BeginDefragmentation (for a custom pool).
-Member Function Documentation
+Member Function Documentation
◆ BeginPass()
@@ -145,8 +129,8 @@Ends incremental defragmentation pass and commits all defragmentation moves from
+pPassInfo. After this call:Ends incremental defragmentation pass and commits all defragmentation moves from pPassInfo. After this call:
-
-
If no more moves are possible you can end whole defragmentation.
@@ -209,7 +193,7 @@-Generated by
1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_pool-members.html b/docs/html/class_d3_d12_m_a_1_1_pool-members.html
index e500fb5..9acf601 100644
--- a/docs/html/class_d3_d12_m_a_1_1_pool-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_pool-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List - - @@ -33,33 +31,22 @@ - + -@@ -104,7 +91,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_pool.html b/docs/html/class_d3_d12_m_a_1_1_pool.html
index 7aabe1c..07742d9 100644
--- a/docs/html/class_d3_d12_m_a_1_1_pool.html
+++ b/docs/html/class_d3_d12_m_a_1_1_pool.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Pool Class Reference - - @@ -33,33 +31,22 @@ - + -@@ -106,32 +93,26 @@
-
-+
Public Member Functions
POOL_DESC GetDesc () const Returns copy of parameters of the pool. void GetStatistics (Statistics *pStats) Retrieves basic statistics of the custom pool that are fast to calculate. void CalculateStatistics (DetailedStatistics *pStats) Retrieves detailed statistics of the custom pool that are slower to calculate. void SetName (LPCWSTR Name) Associates a name with the pool. This name is for use in debug diagnostics and tools. LPCWSTR GetName () const Returns the name associated with the pool object. HRESULT BeginDefragmentation (const DEFRAGMENTATION_DESC *pDesc, DefragmentationContext **ppContext) Begins defragmentation process of the current pool. Detailed Description
+Detailed Description
Custom memory pool.
Represents a separate set of heaps (memory blocks) that can be used to create D3D12MA::Allocation-s and resources in it. Usually there is no need to create custom pools - creating resources in default pool is sufficient.
To create custom pool, fill D3D12MA::POOL_DESC and call D3D12MA::Allocator::CreatePool.
-Member Function Documentation
+Member Function Documentation
◆ BeginDefragmentation()
@@ -160,8 +141,8 @@For more information about defragmentation, see documentation chapter: Defragmentation.
@@ -276,7 +257,7 @@Name can be NULL. @@ -286,7 +267,7 @@
-Generated by
1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html b/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html
index 190326b..1e40ead 100644
--- a/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html
+++ b/docs/html/class_d3_d12_m_a_1_1_virtual_block-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List - - @@ -33,33 +31,22 @@ - + -@@ -109,7 +96,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/class_d3_d12_m_a_1_1_virtual_block.html b/docs/html/class_d3_d12_m_a_1_1_virtual_block.html
index 5f6a3f2..0cb9114 100644
--- a/docs/html/class_d3_d12_m_a_1_1_virtual_block.html
+++ b/docs/html/class_d3_d12_m_a_1_1_virtual_block.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualBlock Class Reference - - @@ -33,33 +31,22 @@ - + -@@ -106,45 +93,35 @@
-
-+
Public Member Functions
BOOL IsEmpty () const Returns true if the block is empty - contains 0 allocations. void GetAllocationInfo (VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) const Returns information about an allocation - its offset, size and custom pointer. HRESULT Allocate (const VIRTUAL_ALLOCATION_DESC *pDesc, VirtualAllocation *pAllocation, UINT64 *pOffset) Creates new allocation. void FreeAllocation (VirtualAllocation allocation) Frees the allocation. void Clear () Frees all the allocations. void SetAllocationPrivateData (VirtualAllocation allocation, void *pPrivateData) Changes custom pointer for an allocation to a new value. void GetStatistics (Statistics *pStats) const Retrieves basic statistics of the virtual block that are fast to calculate. void CalculateStatistics (DetailedStatistics *pStats) const Retrieves detailed statistics of the virtual block that are slower to calculate. void BuildStatsString (WCHAR **ppStatsString) const Builds and returns statistics as a string in JSON format, including the list of allocations with their parameters. void FreeStatsString (WCHAR *pStatsString) const Frees memory of a string returned from VirtualBlock::BuildStatsString. Detailed Description
+Detailed Description
Represents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory.
This class allows to use the core algorithm of the library custom allocations e.g. CPU memory or sub-allocation regions inside a single GPU buffer.
-To create this object, fill in D3D12MA::VIRTUAL_BLOCK_DESC and call CreateVirtualBlock(). To destroy it, call its method
+VirtualBlock::Release(). You need to free all the allocations within this block or call Clear() before destroying it.To create this object, fill in D3D12MA::VIRTUAL_BLOCK_DESC and call CreateVirtualBlock(). To destroy it, call its method VirtualBlock::Release(). You need to free all the allocations within this block or call Clear() before destroying it.
This object is not thread-safe - should not be used from multiple threads simultaneously, must be synchronized externally.
-Member Function Documentation
+Member Function Documentation
◆ Allocate()
@@ -178,8 +155,8 @@If the allocation failed,
+pAllocation->AllocHandleis set to 0 andpOffset, if not null, is set toUINT64_MAX.If the allocation failed, pAllocation->AllocHandle is set to 0 and pOffset, if not null, is set to UINT64_MAX.
@@ -268,7 +245,7 @@Frees the allocation.
-Calling this function with
+allocation.AllocHandle == 0is correct and does nothing.Calling this function with allocation.AllocHandle == 0 is correct and does nothing.
@@ -387,7 +364,7 @@-Generated by
1.13.2
+Generated by 1.14.0
diff --git a/docs/html/classes.html b/docs/html/classes.html
index 3b8ddf2..e85eb86 100644
--- a/docs/html/classes.html
+++ b/docs/html/classes.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Class Index - - @@ -33,35 +31,24 @@ - +-- + -diff --git a/docs/html/configuration.html b/docs/html/configuration.html index 8eeaa50..65d7bdd 100644 --- a/docs/html/configuration.html +++ b/docs/html/configuration.html @@ -3,15 +3,13 @@ - +
-Generated by 1.13.2
+Generated by 1.14.0
D3D12 Memory Allocator: Configuration - - @@ -33,33 +31,22 @@- + --+ConfigurationConfiguration-diff --git a/docs/html/custom_pools.html b/docs/html/custom_pools.html index 9112b38..0bfd570 100644 --- a/docs/html/custom_pools.html +++ b/docs/html/custom_pools.html @@ -3,15 +3,13 @@ - +Please check file
-D3D12MemAlloc.cpplines between "Configuration Begin" and "Configuration End" to find macros that you can define to change the behavior of the library, primarily for debugging purposes.+
Please check file D3D12MemAlloc.cpp lines between "Configuration Begin" and "Configuration End" to find macros that you can define to change the behavior of the library, primarily for debugging purposes.
+Custom CPU memory allocator
-If you use custom allocator for CPU memory rather than default C++ operator
+newanddeleteormallocandfreefunctions, you can make this library using your allocator as well by filling structure D3D12MA::ALLOCATION_CALLBACKS and passing it as optional member D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks. Functions pointed there will be used by the library to make any CPU-side allocations. Example:If you use custom allocator for CPU memory rather than default C++ operator new and delete or malloc and free functions, you can make this library using your allocator as well by filling structure D3D12MA::ALLOCATION_CALLBACKS and passing it as optional member D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks. Functions pointed there will be used by the library to make any CPU-side allocations. Example:
#include <malloc.h>void* CustomAllocate(size_t Size, size_t Alignment, void* pPrivateData)@@ -133,11 +120,11 @@-ALLOCATOR_FLAGS FlagsFlags for the entire allocator.Definition D3D12MemAlloc.h:1126+
Debug margins
-By default, allocations are laid out in memory blocks next to each other if possible (considering required alignment returned by
+ID3D12Device::GetResourceAllocationInfo).By default, allocations are laid out in memory blocks next to each other if possible (considering required alignment returned by ID3D12Device::GetResourceAllocationInfo).
-Define macro
+D3D12MA_DEBUG_MARGINto some non-zero value (e.g. 16) inside "D3D12MemAlloc.cpp" to enforce specified number of bytes as a margin after every allocation.Define macro D3D12MA_DEBUG_MARGIN to some non-zero value (e.g. 16) inside "D3D12MemAlloc.cpp" to enforce specified number of bytes as a margin after every allocation.
If your bug goes away after enabling margins, it means it may be caused by memory being overwritten outside of allocation boundaries. It is not 100% certain though. Change in application behavior may also be caused by different order and distribution of allocations across memory blocks after margins are applied.
Margins work with all memory heap types.
@@ -149,7 +136,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
D3D12 Memory Allocator: Custom memory pools - - @@ -33,33 +31,22 @@-+Custom memory poolsCustom memory pools-A "pool" is a collection of memory blocks that share certain properties. Allocator creates 3 default pools: for
-D3D12_HEAP_TYPE_DEFAULT,UPLOAD,READBACK. A default pool automatically grows in size. Size of allocated blocks is also variable and managed automatically. Typical allocations are created in these pools. You can also create custom pools.+
A "pool" is a collection of memory blocks that share certain properties. Allocator creates 3 default pools: for D3D12_HEAP_TYPE_DEFAULT, UPLOAD, READBACK. A default pool automatically grows in size. Size of allocated blocks is also variable and managed automatically. Typical allocations are created in these pools. You can also create custom pools.
+Usage
To create a custom pool, fill in structure D3D12MA::POOL_DESC and call function D3D12MA::Allocator::CreatePool to obtain object D3D12MA::Pool. Example:
All allocations must be released before releasing the pool. The pool must be released before relasing the allocator.
alloc->Release();pool->Release();-+
Features and benefits
While it is recommended to use default pools whenever possible for simplicity and to give the allocator more opportunities for internal optimizations, custom pools may be useful in following cases:
New versions of this library support creating committed allocations in custom pools. It is supported only when D3D12MA::POOL_DESC::BlockSize = 0. To use this feature, set D3D12MA::ALLOCATION_DESC::CustomPool to the pointer to your custom pool and D3D12MA::ALLOCATION_DESC::Flags to D3D12MA::ALLOCATION_FLAG_COMMITTED. Example:
ALLOCATION_DESC allocDesc = {};@@ -136,12 +123,12 @@ID3D12Resource* res;hr = allocator->CreateResource(&allocDesc, &resDesc,D3D12_RESOURCE_STATE_GENERIC_READ, NULL, &alloc, IID_PPV_ARGS(&res));-This feature may seem unnecessary, but creating committed allocations from custom pools may be useful in some cases, e.g. to have separate memory usage statistics for some group of resources or to use extended allocation parameters, like custom
+D3D12_HEAP_PROPERTIES, which are available only in custom pools.This feature may seem unnecessary, but creating committed allocations from custom pools may be useful in some cases, e.g. to have separate memory usage statistics for some group of resources or to use extended allocation parameters, like custom D3D12_HEAP_PROPERTIES, which are available only in custom pools.
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/defragmentation.html b/docs/html/defragmentation.html
index d68a400..b82dbde 100644
--- a/docs/html/defragmentation.html
+++ b/docs/html/defragmentation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Defragmentation - - @@ -33,33 +31,22 @@ - + --+DefragmentationDefragmentationInterleaved allocations and deallocations of many objects of varying size can cause fragmentation over time, which can lead to a situation where the library is unable to find a continuous range of free memory for a new allocation despite there is enough free space, just scattered across many small free ranges between existing allocations.
-To mitigate this problem, you can use defragmentation feature. It doesn't happen automatically though and needs your cooperation, because D3D12MA is a low level library that only allocates memory. It cannot recreate buffers and textures in a new place as it doesn't remember the contents of
+D3D12_RESOURCE_DESCstructure. It cannot copy their contents as it doesn't record any commands to a command list.To mitigate this problem, you can use defragmentation feature. It doesn't happen automatically though and needs your cooperation, because D3D12MA is a low level library that only allocates memory. It cannot recreate buffers and textures in a new place as it doesn't remember the contents of D3D12_RESOURCE_DESC structure. It cannot copy their contents as it doesn't record any commands to a command list.
Example:
D3D12MA::DEFRAGMENTATION_DESC defragDesc = {};defragDesc.Flags = D3D12MA::DEFRAGMENTATION_FLAG_ALGORITHM_FAST;@@ -162,11 +149,11 @@Parameters for incremental defragmentation steps.Definition D3D12MemAlloc.h:768DEFRAGMENTATION_MOVE * pMovesArray of moves to be performed by the user in the current defragmentation pass.Definition D3D12MemAlloc.h:792-UINT32 MoveCountNumber of elements in the pMoves array.Definition D3D12MemAlloc.h:770Although functions like D3D12MA::Allocator::CreateResource() create an allocation and a buffer/texture at once, these are just a shortcut for allocating memory and creating a placed resource. Defragmentation works on memory allocations only. You must handle the rest manually. Defragmentation is an iterative process that should repreat "passes" as long as related functions return
+S_FALSEnotS_OK. In each pass:Although functions like D3D12MA::Allocator::CreateResource() create an allocation and a buffer/texture at once, these are just a shortcut for allocating memory and creating a placed resource. Defragmentation works on memory allocations only. You must handle the rest manually. Defragmentation is an iterative process that should repreat "passes" as long as related functions return S_FALSE not S_OK. In each pass:
Defragmentation algorithm tries to move all suitable allocations. You can, however, refuse to move some of them inside a defragmentation pass, by setting
+pass.pMoves[i].Operationto D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This is not recommended and may result in suboptimal packing of the allocations after defragmentation. If you cannot ensure any allocation can be moved, it is better to keep movable allocations separate in a custom pool.Defragmentation algorithm tries to move all suitable allocations. You can, however, refuse to move some of them inside a defragmentation pass, by setting pass.pMoves[i].Operation to D3D12MA::DEFRAGMENTATION_MOVE_OPERATION_IGNORE. This is not recommended and may result in suboptimal packing of the allocations after defragmentation. If you cannot ensure any allocation can be moved, it is better to keep movable allocations separate in a custom pool.
Inside a pass, for each allocation that should be moved:
-
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html b/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
index fa88354..6e6d46e 100644
--- a/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
+++ b/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: C:/Code/D3D12MemoryAllocator/REPO/include Directory Reference - - @@ -33,33 +31,22 @@ - + -@@ -92,15 +79,14 @@-
+
Files
D3D12MemAlloc.h D3D12MemAlloc.h
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/doxygen.css b/docs/html/doxygen.css
index 4947e24..5d2eecd 100644
--- a/docs/html/doxygen.css
+++ b/docs/html/doxygen.css
@@ -1,11 +1,12 @@
-/* The standard CSS for doxygen 1.13.2*/
+/* The standard CSS for doxygen 1.14.0*/
html {
/* page base colors */
--page-background-color: white;
--page-foreground-color: black;
--page-link-color: #3D578C;
---page-visited-link-color: #4665A2;
+--page-visited-link-color: #3D578C;
+--page-external-link-color: #334975;
/* index */
--index-odd-item-bg-color: #F8F9FC;
@@ -16,46 +17,50 @@ html {
/* header */
--header-background-color: #F9FAFC;
--header-separator-color: #C4CFE5;
---header-gradient-image: url('nav_h.png');
---group-header-separator-color: #879ECB;
+--group-header-separator-color: #D9E0EE;
--group-header-color: #354C7B;
--inherit-header-color: gray;
--footer-foreground-color: #2A3D61;
---footer-logo-width: 104px;
+--footer-logo-width: 75px;
--citation-label-color: #334975;
--glow-color: cyan;
--title-background-color: white;
---title-separator-color: #5373B4;
+--title-separator-color: #C4CFE5;
--directory-separator-color: #9CAFD4;
--separator-color: #4A6AAA;
--blockquote-background-color: #F7F8FB;
--blockquote-border-color: #9CAFD4;
---scrollbar-thumb-color: #9CAFD4;
+--scrollbar-thumb-color: #C4CFE5;
--scrollbar-background-color: #F9FAFC;
--icon-background-color: #728DC1;
--icon-foreground-color: white;
+/*
--icon-doc-image: url('doc.svg');
--icon-folder-open-image: url('folderopen.svg');
---icon-folder-closed-image: url('folderclosed.svg');
+--icon-folder-closed-image: url('folderclosed.svg');*/
+--icon-folder-open-fill-color: #C4CFE5;
+--icon-folder-fill-color: #D8DFEE;
+--icon-folder-border-color: #4665A2;
+--icon-doc-fill-color: #D8DFEE;
+--icon-doc-border-color: #4665A2;
/* brief member declaration list */
--memdecl-background-color: #F9FAFC;
--memdecl-separator-color: #DEE4F0;
--memdecl-foreground-color: #555;
--memdecl-template-color: #4665A2;
+--memdecl-border-color: #D5DDEC;
/* detailed member list */
--memdef-border-color: #A8B8D9;
--memdef-title-background-color: #E2E8F2;
---memdef-title-gradient-image: url('nav_f.png');
---memdef-proto-background-color: #DFE5F1;
+--memdef-proto-background-color: #EEF1F7;
--memdef-proto-text-color: #253555;
---memdef-proto-text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
--memdef-doc-background-color: white;
--memdef-param-name-color: #602020;
--memdef-template-color: #4665A2;
@@ -74,29 +79,34 @@ html {
/** navigation bar/tree/menu */
--nav-background-color: #F9FAFC;
--nav-foreground-color: #364D7C;
---nav-gradient-image: url('tab_b.png');
---nav-gradient-hover-image: url('tab_h.png');
---nav-gradient-active-image: url('tab_a.png');
---nav-gradient-active-image-parent: url("../tab_a.png");
---nav-separator-image: url('tab_s.png');
---nav-breadcrumb-image: url('bc_s.png');
---nav-breadcrumb-border-color: #C2CDE4;
---nav-splitbar-image: url('splitbar.png');
+--nav-border-color: #C4CFE5;
+--nav-breadcrumb-separator-color: #C4CFE5;
+--nav-breadcrumb-active-bg: #EEF1F7;
+--nav-breadcrumb-color: #354C7B;
+--nav-breadcrumb-border-color: #E1E7F2;
+--nav-splitbar-bg-color: #DCE2EF;
+--nav-splitbar-handle-color: #9CAFD4;
--nav-font-size-level1: 13px;
--nav-font-size-level2: 10px;
--nav-font-size-level3: 9px;
--nav-text-normal-color: #283A5D;
--nav-text-hover-color: white;
--nav-text-active-color: white;
---nav-text-normal-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
---nav-text-hover-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
---nav-text-active-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
--nav-menu-button-color: #364D7C;
--nav-menu-background-color: white;
--nav-menu-foreground-color: #555555;
+--nav-menu-active-bg: #DCE2EF;
+--nav-menu-active-color: #9CAFD4;
--nav-menu-toggle-color: rgba(255, 255, 255, 0.5);
---nav-arrow-color: #9CAFD4;
---nav-arrow-selected-color: #9CAFD4;
+--nav-arrow-color: #B6C4DF;
+--nav-arrow-selected-color: #90A5CE;
+
+/* sync icon */
+--sync-icon-border-color: #C4CFE5;
+--sync-icon-background-color: #F9FAFC;
+--sync-icon-selected-background-color: #EEF1F7;
+--sync-icon-color: #C4CFE5;
+--sync-icon-selected-color: #6884BD;
/* table of contents */
--toc-background-color: #F4F6FA;
@@ -107,18 +117,20 @@ html {
/** search field */
--search-background-color: white;
--search-foreground-color: #909090;
---search-magnification-image: url('mag.svg');
---search-magnification-select-image: url('mag_sel.svg');
--search-active-color: black;
---search-filter-background-color: #F9FAFC;
+--search-filter-background-color: rgba(255,255,255,.7);
+--search-filter-backdrop-filter: blur(4px);
--search-filter-foreground-color: black;
---search-filter-border-color: #90A5CE;
+--search-filter-border-color: rgba(150,150,150,.4);
--search-filter-highlight-text-color: white;
--search-filter-highlight-bg-color: #3D578C;
--search-results-foreground-color: #425E97;
---search-results-background-color: #EEF1F7;
---search-results-border-color: black;
---search-box-shadow: inset 0.5px 0.5px 3px 0px #555;
+--search-results-background-color: rgba(255,255,255,.8);
+--search-results-backdrop-filter: blur(4px);
+--search-results-border-color: rgba(150,150,150,.4);
+--search-box-border-color: #B6C4DF;
+--search-close-icon-bg-color: #A0A0A0;
+--search-close-icon-fg-color: white;
/** code fragments */
--code-keyword-color: #008000;
@@ -147,23 +159,21 @@ html {
--fragment-lineno-link-hover-bg-color: #C8C8C8;
--fragment-copy-ok-color: #2EC82E;
--tooltip-foreground-color: black;
---tooltip-background-color: white;
---tooltip-border-color: gray;
+--tooltip-background-color: rgba(255,255,255,0.8);
+--tooltip-arrow-background-color: white;
+--tooltip-border-color: rgba(150,150,150,0.7);
+--tooltip-backdrop-filter: blur(3px);
--tooltip-doc-color: grey;
--tooltip-declaration-color: #006318;
--tooltip-link-color: #4665A2;
---tooltip-shadow: 1px 1px 7px gray;
+--tooltip-shadow: 0 4px 8px 0 rgba(0,0,0,.25);
--fold-line-color: #808080;
---fold-minus-image: url('minus.svg');
---fold-plus-image: url('plus.svg');
---fold-minus-image-relpath: url('../../minus.svg');
---fold-plus-image-relpath: url('../../plus.svg');
/** font-family */
---font-family-normal: Roboto,sans-serif;
+--font-family-normal: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-monospace: 'JetBrains Mono',Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace,fixed;
--font-family-nav: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
---font-family-title: Tahoma,Arial,sans-serif;
+--font-family-title: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-toc: Verdana,'DejaVu Sans',Geneva,sans-serif;
--font-family-search: Arial,Verdana,sans-serif;
--font-family-icon: Arial,Helvetica;
@@ -201,7 +211,8 @@ html {
--page-background-color: black;
--page-foreground-color: #C9D1D9;
--page-link-color: #90A5CE;
---page-visited-link-color: #A3B4D7;
+--page-visited-link-color: #90A5CE;
+--page-external-link-color: #A3B4D7;
/* index */
--index-odd-item-bg-color: #0B101A;
@@ -212,8 +223,7 @@ html {
/* header */
--header-background-color: #070B11;
--header-separator-color: #141C2E;
---header-gradient-image: url('nav_hd.png');
---group-header-separator-color: #283A5D;
+--group-header-separator-color: #1D2A43;
--group-header-color: #90A5CE;
--inherit-header-color: #A0A0A0;
@@ -223,35 +233,36 @@ html {
--glow-color: cyan;
--title-background-color: #090D16;
---title-separator-color: #354C79;
+--title-separator-color: #212F4B;
--directory-separator-color: #283A5D;
--separator-color: #283A5D;
--blockquote-background-color: #101826;
--blockquote-border-color: #283A5D;
---scrollbar-thumb-color: #283A5D;
+--scrollbar-thumb-color: #2C3F65;
--scrollbar-background-color: #070B11;
--icon-background-color: #334975;
--icon-foreground-color: #C4CFE5;
---icon-doc-image: url('docd.svg');
---icon-folder-open-image: url('folderopend.svg');
---icon-folder-closed-image: url('folderclosedd.svg');
+--icon-folder-open-fill-color: #4665A2;
+--icon-folder-fill-color: #5373B4;
+--icon-folder-border-color: #C4CFE5;
+--icon-doc-fill-color: #6884BD;
+--icon-doc-border-color: #C4CFE5;
/* brief member declaration list */
--memdecl-background-color: #0B101A;
--memdecl-separator-color: #2C3F65;
--memdecl-foreground-color: #BBB;
--memdecl-template-color: #7C95C6;
+--memdecl-border-color: #233250;
/* detailed member list */
--memdef-border-color: #233250;
--memdef-title-background-color: #1B2840;
---memdef-title-gradient-image: url('nav_fd.png');
--memdef-proto-background-color: #19243A;
--memdef-proto-text-color: #9DB0D4;
---memdef-proto-text-shadow: 0px 1px 1px rgba(0, 0, 0, 0.9);
--memdef-doc-background-color: black;
--memdef-param-name-color: #D28757;
--memdef-template-color: #7C95C6;
@@ -270,29 +281,34 @@ html {
/** navigation bar/tree/menu */
--nav-background-color: #101826;
--nav-foreground-color: #364D7C;
---nav-gradient-image: url('tab_bd.png');
---nav-gradient-hover-image: url('tab_hd.png');
---nav-gradient-active-image: url('tab_ad.png');
---nav-gradient-active-image-parent: url("../tab_ad.png");
---nav-separator-image: url('tab_sd.png');
---nav-breadcrumb-image: url('bc_sd.png');
+--nav-border-color: #212F4B;
+--nav-breadcrumb-separator-color: #212F4B;
+--nav-breadcrumb-active-bg: #1D2A43;
+--nav-breadcrumb-color: #90A5CE;
--nav-breadcrumb-border-color: #2A3D61;
---nav-splitbar-image: url('splitbard.png');
+--nav-splitbar-bg-color: #283A5D;
+--nav-splitbar-handle-color: #4665A2;
--nav-font-size-level1: 13px;
--nav-font-size-level2: 10px;
--nav-font-size-level3: 9px;
--nav-text-normal-color: #B6C4DF;
--nav-text-hover-color: #DCE2EF;
--nav-text-active-color: #DCE2EF;
---nav-text-normal-shadow: 0px 1px 1px black;
---nav-text-hover-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
---nav-text-active-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
--nav-menu-button-color: #B6C4DF;
--nav-menu-background-color: #05070C;
--nav-menu-foreground-color: #BBBBBB;
+--nav-menu-active-bg: #1D2A43;
+--nav-menu-active-color: #C9D3E7;
--nav-menu-toggle-color: rgba(255, 255, 255, 0.2);
---nav-arrow-color: #334975;
---nav-arrow-selected-color: #90A5CE;
+--nav-arrow-color: #4665A2;
+--nav-arrow-selected-color: #6884BD;
+
+/* sync icon */
+--sync-icon-border-color: #212F4B;
+--sync-icon-background-color: #101826;
+--sync-icon-selected-background-color: #1D2A43;
+--sync-icon-color: #4665A2;
+--sync-icon-selected-color: #5373B4;
/* table of contents */
--toc-background-color: #151E30;
@@ -303,18 +319,20 @@ html {
/** search field */
--search-background-color: black;
--search-foreground-color: #C5C5C5;
---search-magnification-image: url('mag_d.svg');
---search-magnification-select-image: url('mag_seld.svg');
---search-active-color: #C5C5C5;
+--search-active-color: #F5F5F5;
--search-filter-background-color: #101826;
--search-filter-foreground-color: #90A5CE;
+--search-filter-backdrop-filter: none;
--search-filter-border-color: #7C95C6;
--search-filter-highlight-text-color: #BCC9E2;
--search-filter-highlight-bg-color: #283A5D;
---search-results-background-color: #101826;
+--search-results-background-color: black;
--search-results-foreground-color: #90A5CE;
---search-results-border-color: #7C95C6;
---search-box-shadow: inset 0.5px 0.5px 3px 0px #2F436C;
+--search-results-backdrop-filter: none;
+--search-results-border-color: #334975;
+--search-box-border-color: #334975;
+--search-close-icon-bg-color: #909090;
+--search-close-icon-fg-color: black;
/** code fragments */
--code-keyword-color: #CC99CD;
@@ -344,22 +362,20 @@ html {
--fragment-copy-ok-color: #0EA80E;
--tooltip-foreground-color: #C9D1D9;
--tooltip-background-color: #202020;
+--tooltip-arrow-background-color: #202020;
+--tooltip-backdrop-filter: none;
--tooltip-border-color: #C9D1D9;
--tooltip-doc-color: #D9E1E9;
--tooltip-declaration-color: #20C348;
--tooltip-link-color: #79C0FF;
--tooltip-shadow: none;
--fold-line-color: #808080;
---fold-minus-image: url('minusd.svg');
---fold-plus-image: url('plusd.svg');
---fold-minus-image-relpath: url('../../minusd.svg');
---fold-plus-image-relpath: url('../../plusd.svg');
/** font-family */
---font-family-normal: Roboto,sans-serif;
+--font-family-normal: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-monospace: 'JetBrains Mono',Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace,fixed;
--font-family-nav: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
---font-family-title: Tahoma,Arial,sans-serif;
+--font-family-title: system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
--font-family-toc: Verdana,'DejaVu Sans',Geneva,sans-serif;
--font-family-search: Arial,Verdana,sans-serif;
--font-family-icon: Arial,Helvetica;
@@ -389,8 +405,8 @@ html {
--invariant-color-text: #cceed5;
}}
body {
- background-color: var(--page-background-color);
- color: var(--page-foreground-color);
+ background-color: var(--page-background-color);
+ color: var(--page-foreground-color);
}
body, table, div, p, dl {
@@ -400,13 +416,22 @@ body, table, div, p, dl {
line-height: 22px;
}
+body.resizing {
+ user-select: none;
+ -webkit-user-select: none;
+}
+
+#doc-content {
+ scrollbar-width: thin;
+}
+
/* @group Heading Levels */
.title {
font-family: var(--font-family-normal);
line-height: 28px;
- font-size: 150%;
- font-weight: bold;
+ font-size: 160%;
+ font-weight: 400;
margin: 10px 2px;
}
@@ -415,7 +440,10 @@ h1.groupheader {
}
h2.groupheader {
- border-bottom: 1px solid var(--group-header-separator-color);
+ box-shadow: 12px 0 var(--page-background-color),
+ -12px 0 var(--page-background-color),
+ 12px 1px var(--group-header-separator-color),
+ -12px 1px var(--group-header-separator-color);
color: var(--group-header-color);
font-size: 150%;
font-weight: normal;
@@ -425,6 +453,13 @@ h2.groupheader {
width: 100%;
}
+td h2.groupheader {
+ box-shadow: 13px 0 var(--page-background-color),
+ -13px 0 var(--page-background-color),
+ 13px 1px var(--group-header-separator-color),
+ -13px 1px var(--group-header-separator-color);
+}
+
h3.groupheader {
font-size: 100%;
}
@@ -451,8 +486,8 @@ p.startli, p.startdd {
}
th p.starttd, th p.intertd, th p.endtd {
- font-size: 100%;
- font-weight: 700;
+ font-size: 100%;
+ font-weight: 700;
}
p.starttd {
@@ -497,9 +532,11 @@ h3.version {
}
div.navtab {
- padding-right: 15px;
+ margin-right: 6px;
+ padding-right: 6px;
text-align: right;
line-height: 110%;
+ background-color: var(--nav-background-color);
}
div.navtab table {
@@ -512,19 +549,10 @@ td.navtab {
}
td.navtabHL {
- background-image: var(--nav-gradient-active-image);
- background-repeat:repeat-x;
padding-right: 6px;
padding-left: 6px;
-}
-
-td.navtabHL a, td.navtabHL a:visited {
- color: var(--nav-text-hover-color);
- text-shadow: var(--nav-text-hover-shadow);
-}
-
-a.navtab {
- font-weight: bold;
+ border-radius: 0 6px 6px 0;
+ background-color: var(--nav-menu-active-bg);
}
div.qindex{
@@ -599,16 +627,11 @@ a {
color: var(--page-visited-link-color);
}
-a:hover {
+span.label a:hover {
text-decoration: none;
background: linear-gradient(to bottom, transparent 0,transparent calc(100% - 1px), currentColor 100%);
}
-a:hover > span.arrow {
- text-decoration: none;
- background : var(--nav-background-color);
-}
-
a.el {
font-weight: bold;
}
@@ -616,12 +639,12 @@ a.el {
a.elRef {
}
-a.code, a.code:visited, a.line, a.line:visited {
- color: var(--code-link-color);
+a.el, a.el:visited, a.code, a.code:visited, a.line, a.line:visited {
+ color: var(--page-link-color);
}
a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited {
- color: var(--code-external-link-color);
+ color: var(--page-external-link-color);
}
a.code.hl_class { /* style for links to class names in code snippets */ }
@@ -658,118 +681,124 @@ dl.el {
}
ul.check {
- list-style:none;
- text-indent: -16px;
- padding-left: 38px;
+ list-style:none;
+ text-indent: -16px;
+ padding-left: 38px;
}
li.unchecked:before {
- content: "\2610\A0";
+ content: "\2610\A0";
}
li.checked:before {
- content: "\2611\A0";
+ content: "\2611\A0";
}
ol {
- text-indent: 0px;
+ text-indent: 0px;
}
ul {
- text-indent: 0px;
- overflow: visible;
+ text-indent: 0px;
+ overflow: visible;
}
ul.multicol {
- -moz-column-gap: 1em;
- -webkit-column-gap: 1em;
- column-gap: 1em;
- -moz-column-count: 3;
- -webkit-column-count: 3;
- column-count: 3;
- list-style-type: none;
+ -moz-column-gap: 1em;
+ -webkit-column-gap: 1em;
+ column-gap: 1em;
+ -moz-column-count: 3;
+ -webkit-column-count: 3;
+ column-count: 3;
+ list-style-type: none;
}
#side-nav ul {
- overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */
+ overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */
}
#main-nav ul {
- overflow: visible; /* reset ul rule for the navigation bar drop down lists */
+ overflow: visible; /* reset ul rule for the navigation bar drop down lists */
}
.fragment {
- text-align: left;
- direction: ltr;
- overflow-x: auto;
- overflow-y: hidden;
- position: relative;
- min-height: 12px;
- margin: 10px 0px;
- padding: 10px 10px;
- border: 1px solid var(--fragment-border-color);
- border-radius: 4px;
- background-color: var(--fragment-background-color);
- color: var(--fragment-foreground-color);
+ text-align: left;
+ direction: ltr;
+ overflow-x: auto;
+ overflow-y: hidden;
+ position: relative;
+ min-height: 12px;
+ margin: 10px 0px;
+ padding: 10px 10px;
+ border: 1px solid var(--fragment-border-color);
+ border-radius: 4px;
+ background-color: var(--fragment-background-color);
+ color: var(--fragment-foreground-color);
}
pre.fragment {
- word-wrap: break-word;
- font-size: 10pt;
- line-height: 125%;
- font-family: var(--font-family-monospace);
+ word-wrap: break-word;
+ font-size: 10pt;
+ line-height: 125%;
+ font-family: var(--font-family-monospace);
+}
+
+span.tt {
+ white-space: pre;
+ font-family: var(--font-family-monospace);
}
.clipboard {
- width: 24px;
- height: 24px;
- right: 5px;
- top: 5px;
- opacity: 0;
- position: absolute;
- display: inline;
- overflow: hidden;
- justify-content: center;
- align-items: center;
- cursor: pointer;
+ width: 24px;
+ height: 24px;
+ right: 5px;
+ top: 5px;
+ opacity: 0;
+ position: absolute;
+ display: inline;
+ overflow: hidden;
+ justify-content: center;
+ align-items: center;
+ cursor: pointer;
}
.clipboard.success {
- border: 1px solid var(--fragment-foreground-color);
- border-radius: 4px;
+ border: 1px solid var(--fragment-foreground-color);
+ border-radius: 4px;
}
.fragment:hover .clipboard, .clipboard.success {
- opacity: .4;
+ opacity: .4;
}
.clipboard:hover, .clipboard.success {
- opacity: 1 !important;
+ opacity: 1 !important;
}
.clipboard:active:not([class~=success]) svg {
- transform: scale(.91);
+ transform: scale(.91);
}
.clipboard.success svg {
- fill: var(--fragment-copy-ok-color);
+ fill: var(--fragment-copy-ok-color);
}
.clipboard.success {
- border-color: var(--fragment-copy-ok-color);
+ border-color: var(--fragment-copy-ok-color);
}
div.line {
font-family: var(--font-family-monospace);
- font-size: 13px;
+ font-size: 13px;
min-height: 13px;
line-height: 1.2;
- text-wrap: unrestricted;
+ text-wrap: wrap;
+ word-break: break-all;
white-space: -moz-pre-wrap; /* Moz */
white-space: -pre-wrap; /* Opera 4-6 */
white-space: -o-pre-wrap; /* Opera 7 */
white-space: pre-wrap; /* CSS3 */
word-wrap: break-word; /* IE 5.5+ */
- text-indent: -53px;
- padding-left: 53px;
+ text-indent: -62px;
+ padding-left: 62px;
padding-bottom: 0px;
margin: 0px;
-webkit-transition-property: background-color, box-shadow;
@@ -785,8 +814,8 @@ div.line {
}
div.line:after {
- content:"\000A";
- white-space: pre;
+ content:"\000A";
+ white-space: pre;
}
div.line.glow {
@@ -795,26 +824,67 @@ div.line.glow {
}
span.fold {
- margin-left: 5px;
- margin-right: 1px;
- margin-top: 0px;
- margin-bottom: 0px;
- padding: 0px;
display: inline-block;
width: 12px;
height: 12px;
- background-repeat:no-repeat;
- background-position:center;
+ margin-left: 4px;
+ margin-right: 1px;
+}
+
+span.foldnone {
+ display: inline-block;
+ position: relative;
+ cursor: pointer;
+ user-select: none;
+}
+
+span.fold.plus, span.fold.minus {
+ width: 10px;
+ height: 10px;
+ background-color: var(--fragment-background-color);
+ position: relative;
+ border: 1px solid var(--fold-line-color);
+ margin-right: 1px;
+}
+
+span.fold.plus::before, span.fold.minus::before {
+ content: '';
+ position: absolute;
+ background-color: var(--fold-line-color);
+}
+
+span.fold.plus::before {
+ width: 2px;
+ height: 6px;
+ top: 2px;
+ left: 4px;
+}
+
+span.fold.plus::after {
+ content: '';
+ position: absolute;
+ width: 6px;
+ height: 2px;
+ top: 4px;
+ left: 2px;
+ background-color: var(--fold-line-color);
+}
+
+span.fold.minus::before {
+ width: 6px;
+ height: 2px;
+ top: 4px;
+ left: 2px;
}
span.lineno {
padding-right: 4px;
- margin-right: 9px;
+ margin-right: 9px;
text-align: right;
border-right: 2px solid var(--fragment-lineno-border-color);
color: var(--fragment-lineno-foreground-color);
background-color: var(--fragment-lineno-background-color);
- white-space: pre;
+ white-space: pre;
}
span.lineno a, span.lineno a:visited {
color: var(--fragment-lineno-link-fg-color);
@@ -836,18 +906,27 @@ span.lineno a:hover {
}
div.classindex ul {
- list-style: none;
- padding-left: 0;
+ list-style: none;
+ padding-left: 0;
}
div.classindex span.ai {
- display: inline-block;
+ display: inline-block;
}
div.groupHeader {
- margin-left: 16px;
- margin-top: 12px;
- font-weight: bold;
+ box-shadow: 13px 0 var(--page-background-color),
+ -13px 0 var(--page-background-color),
+ 13px 1px var(--group-header-separator-color),
+ -13px 1px var(--group-header-separator-color);
+ color: var(--group-header-color);
+ font-size: 110%;
+ font-weight: 500;
+ margin-left: 0px;
+ margin-top: 0em;
+ margin-bottom: 6px;
+ padding-top: 8px;
+ padding-bottom: 4px;
}
div.groupText {
@@ -857,13 +936,13 @@ div.groupText {
body {
color: var(--page-foreground-color);
- margin: 0;
+ margin: 0;
}
div.contents {
margin-top: 10px;
margin-left: 12px;
- margin-right: 8px;
+ margin-right: 12px;
}
p.formulaDsp {
@@ -883,9 +962,9 @@ img.formulaInl, img.inline {
div.center {
text-align: center;
- margin-top: 0px;
- margin-bottom: 0px;
- padding: 0px;
+ margin-top: 0px;
+ margin-bottom: 0px;
+ padding: 0px;
}
div.center img {
@@ -960,10 +1039,10 @@ span.vhdllogic {
}
blockquote {
- background-color: var(--blockquote-background-color);
- border-left: 2px solid var(--blockquote-border-color);
- margin: 0 24px 0 4px;
- padding: 0 12px 0 16px;
+ background-color: var(--blockquote-background-color);
+ border-left: 2px solid var(--blockquote-border-color);
+ margin: 0 24px 0 4px;
+ padding: 0 12px 0 16px;
}
/* @end */
@@ -985,9 +1064,14 @@ th.dirtab {
}
hr {
- height: 0px;
border: none;
- border-top: 1px solid var(--separator-color);
+ margin-top: 16px;
+ margin-bottom: 16px;
+ height: 1px;
+ box-shadow: 13px 0 var(--page-background-color),
+ -13px 0 var(--page-background-color),
+ 13px 1px var(--group-header-separator-color),
+ -13px 1px var(--group-header-separator-color);
}
hr.footer {
@@ -1002,14 +1086,6 @@ table.memberdecls {
}
.memberdecls td, .fieldtable tr {
- -webkit-transition-property: background-color, box-shadow;
- -webkit-transition-duration: 0.5s;
- -moz-transition-property: background-color, box-shadow;
- -moz-transition-duration: 0.5s;
- -ms-transition-property: background-color, box-shadow;
- -ms-transition-duration: 0.5s;
- -o-transition-property: background-color, box-shadow;
- -o-transition-duration: 0.5s;
transition-property: background-color, box-shadow;
transition-duration: 0.5s;
}
@@ -1019,13 +1095,23 @@ table.memberdecls {
box-shadow: 0 0 15px var(--glow-color);
}
+.memberdecls tr[class^='memitem'] {
+ font-family: var(--font-family-monospace);
+}
+
.mdescLeft, .mdescRight,
-.memItemLeft, .memItemRight,
-.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
+.memItemLeft, .memItemRight {
+ padding-top: 2px;
+ padding-bottom: 2px;
+}
+
+.memTemplParams {
+ padding-left: 10px;
+ padding-top: 5px;
+}
+
+.memItemLeft, .memItemRight, .memTemplParams {
background-color: var(--memdecl-background-color);
- border: none;
- margin: 4px;
- padding: 1px 0 0 8px;
}
.mdescLeft, .mdescRight {
@@ -1033,27 +1119,104 @@ table.memberdecls {
color: var(--memdecl-foreground-color);
}
-.memSeparator {
- border-bottom: 1px solid var(--memdecl-separator-color);
- line-height: 1px;
- margin: 0px;
- padding: 0px;
+tr[class^='memdesc'] {
+ box-shadow: inset 0px 1px 3px 0px rgba(0,0,0,.075);
}
-.memItemLeft, .memTemplItemLeft {
- white-space: nowrap;
+.mdescLeft {
+ border-left: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
}
-.memItemRight, .memTemplItemRight {
- width: 100%;
+.mdescRight {
+ border-right: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
}
.memTemplParams {
color: var(--memdecl-template-color);
- white-space: nowrap;
+ white-space: nowrap;
font-size: 80%;
+ border-left: 1px solid var(--memdecl-border-color);
+ border-right: 1px solid var(--memdecl-border-color);
+}
+
+td.ititle {
+ border: 1px solid var(--memdecl-border-color);
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+ padding-left: 10px;
+}
+
+tr:not(:first-child) > td.ititle {
+ border-top: 0;
+ border-radius: 0;
}
+.memItemLeft {
+ white-space: nowrap;
+ border-left: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
+ padding-left: 10px;
+ transition: none;
+}
+
+.memItemRight {
+ width: 100%;
+ border-right: 1px solid var(--memdecl-border-color);
+ border-bottom: 1px solid var(--memdecl-border-color);
+ padding-right: 10px;
+ transition: none;
+}
+
+tr.heading + tr[class^='memitem'] td.memItemLeft,
+tr.groupHeader + tr[class^='memitem'] td.memItemLeft,
+tr.inherit_header + tr[class^='memitem'] td.memItemLeft {
+ border-top: 1px solid var(--memdecl-border-color);
+ border-top-left-radius: 4px;
+}
+
+tr.heading + tr[class^='memitem'] td.memItemRight,
+tr.groupHeader + tr[class^='memitem'] td.memItemRight,
+tr.inherit_header + tr[class^='memitem'] td.memItemRight {
+ border-top: 1px solid var(--memdecl-border-color);
+ border-top-right-radius: 4px;
+}
+
+tr.heading + tr[class^='memitem'] td.memTemplParams,
+tr.heading + tr td.ititle,
+tr.groupHeader + tr[class^='memitem'] td.memTemplParams,
+tr.groupHeader + tr td.ititle,
+tr.inherit_header + tr[class^='memitem'] td.memTemplParams {
+ border-top: 1px solid var(--memdecl-border-color);
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+}
+
+table.memberdecls tr:last-child td.memItemLeft,
+table.memberdecls tr:last-child td.mdescLeft,
+table.memberdecls tr[class^='memitem']:has(+ tr.groupHeader) td.memItemLeft,
+table.memberdecls tr[class^='memitem']:has(+ tr.inherit_header) td.memItemLeft,
+table.memberdecls tr[class^='memdesc']:has(+ tr.groupHeader) td.mdescLeft,
+table.memberdecls tr[class^='memdesc']:has(+ tr.inherit_header) td.mdescLeft {
+ border-bottom-left-radius: 4px;
+}
+
+table.memberdecls tr:last-child td.memItemRight,
+table.memberdecls tr:last-child td.mdescRight,
+table.memberdecls tr[class^='memitem']:has(+ tr.groupHeader) td.memItemRight,
+table.memberdecls tr[class^='memitem']:has(+ tr.inherit_header) td.memItemRight,
+table.memberdecls tr[class^='memdesc']:has(+ tr.groupHeader) td.mdescRight,
+table.memberdecls tr[class^='memdesc']:has(+ tr.inherit_header) td.mdescRight {
+ border-bottom-right-radius: 4px;
+}
+
+tr.template .memItemLeft, tr.template .memItemRight {
+ border-top: none;
+ padding-top: 0;
+}
+
+
/* @end */
/* @group Member Details */
@@ -1068,24 +1231,43 @@ table.memberdecls {
border-top-right-radius: 4px;
border-top-left-radius: 4px;
margin-bottom: -1px;
- background-image: var(--memdef-title-gradient-image);
- background-repeat: repeat-x;
- background-color: var(--memdef-title-background-color);
+ background-color: var(--memdef-proto-background-color);
line-height: 1.25;
- font-weight: 300;
+ font-family: var(--font-family-monospace);
+ font-weight: 500;
+ font-size: 16px;
float:left;
+ box-shadow: 0 10px 0 -1px var(--memdef-proto-background-color),
+ 0 2px 8px 0 rgba(0,0,0,.075);
+ position: relative;
+}
+
+.memtitle:after {
+ content: '';
+ display: block;
+ background: var(--memdef-proto-background-color);
+ height: 10px;
+ bottom: -10px;
+ left: 0px;
+ right: -14px;
+ position: absolute;
+ border-top-right-radius: 6px;
}
.permalink
{
- font-size: 65%;
- display: inline-block;
- vertical-align: middle;
+ font-family: var(--font-family-monospace);
+ font-weight: 500;
+ line-height: 1.25;
+ font-size: 16px;
+ display: inline-block;
+ vertical-align: middle;
}
.memtemplate {
font-size: 80%;
color: var(--memdef-template-color);
+ font-family: var(--font-family-monospace);
font-weight: normal;
margin-left: 9px;
}
@@ -1098,22 +1280,21 @@ table.memberdecls {
padding: 0;
margin-bottom: 10px;
margin-right: 5px;
- -webkit-transition: box-shadow 0.5s linear;
- -moz-transition: box-shadow 0.5s linear;
- -ms-transition: box-shadow 0.5s linear;
- -o-transition: box-shadow 0.5s linear;
- transition: box-shadow 0.5s linear;
- display: table !important;
- width: 100%;
+ display: table !important;
+ width: 100%;
+ box-shadow: 0 2px 8px 0 rgba(0,0,0,.075);
+ border-radius: 4px;
}
.memitem.glow {
- box-shadow: 0 0 15px var(--glow-color);
+ box-shadow: 0 0 15px var(--glow-color);
}
.memname {
- font-weight: 400;
- margin-left: 6px;
+ font-family: var(--font-family-monospace);
+ font-size: 13px;
+ font-weight: 400;
+ margin-left: 6px;
}
.memname td {
@@ -1121,53 +1302,39 @@ table.memberdecls {
}
.memproto, dl.reflist dt {
- border-top: 1px solid var(--memdef-border-color);
- border-left: 1px solid var(--memdef-border-color);
- border-right: 1px solid var(--memdef-border-color);
- padding: 6px 0px 6px 0px;
- color: var(--memdef-proto-text-color);
- font-weight: bold;
- text-shadow: var(--memdef-proto-text-shadow);
- background-color: var(--memdef-proto-background-color);
- box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
- border-top-right-radius: 4px;
+ border-top: 1px solid var(--memdef-border-color);
+ border-left: 1px solid var(--memdef-border-color);
+ border-right: 1px solid var(--memdef-border-color);
+ padding: 6px 0px 6px 0px;
+ color: var(--memdef-proto-text-color);
+ font-weight: bold;
+ background-color: var(--memdef-proto-background-color);
+ border-top-right-radius: 4px;
+ border-bottom: 1px solid var(--memdef-border-color);
}
.overload {
- font-family: var(--font-family-monospace);
+ font-family: var(--font-family-monospace);
font-size: 65%;
}
.memdoc, dl.reflist dd {
- border-bottom: 1px solid var(--memdef-border-color);
- border-left: 1px solid var(--memdef-border-color);
- border-right: 1px solid var(--memdef-border-color);
- padding: 6px 10px 2px 10px;
- border-top-width: 0;
- background-image:url('nav_g.png');
- background-repeat:repeat-x;
- background-color: var(--memdef-doc-background-color);
- /* opera specific markup */
- border-bottom-left-radius: 4px;
- border-bottom-right-radius: 4px;
- box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
- /* firefox specific markup */
- -moz-border-radius-bottomleft: 4px;
- -moz-border-radius-bottomright: 4px;
- -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
- /* webkit specific markup */
- -webkit-border-bottom-left-radius: 4px;
- -webkit-border-bottom-right-radius: 4px;
- -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ border-bottom: 1px solid var(--memdef-border-color);
+ border-left: 1px solid var(--memdef-border-color);
+ border-right: 1px solid var(--memdef-border-color);
+ padding: 6px 10px 2px 10px;
+ border-top-width: 0;
+ border-bottom-left-radius: 4px;
+ border-bottom-right-radius: 4px;
}
dl.reflist dt {
- padding: 5px;
+ padding: 5px;
}
dl.reflist dd {
- margin: 0px 0px 10px 0px;
- padding: 5px;
+ margin: 0px 0px 10px 0px;
+ padding: 5px;
}
.paramkey {
@@ -1182,9 +1349,9 @@ dl.reflist dd {
.paramname {
white-space: nowrap;
- padding: 0px;
- padding-bottom: 1px;
- margin-left: 2px;
+ padding: 0px;
+ padding-bottom: 1px;
+ margin-left: 2px;
}
.paramname em {
@@ -1198,23 +1365,23 @@ dl.reflist dd {
}
.params, .retval, .exception, .tparams {
- margin-left: 0px;
- padding-left: 0px;
+ margin-left: 0px;
+ padding-left: 0px;
}
.params .paramname, .retval .paramname, .tparams .paramname, .exception .paramname {
- font-weight: bold;
- vertical-align: top;
+ font-weight: bold;
+ vertical-align: top;
}
.params .paramtype, .tparams .paramtype {
- font-style: italic;
- vertical-align: top;
+ font-style: italic;
+ vertical-align: top;
}
.params .paramdir, .tparams .paramdir {
- font-family: var(--font-family-monospace);
- vertical-align: top;
+ font-family: var(--font-family-monospace);
+ vertical-align: top;
}
table.mlabels {
@@ -1233,15 +1400,15 @@ td.mlabels-right {
}
span.mlabels {
- margin-left: 8px;
+ margin-left: 8px;
}
span.mlabel {
- background-color: var(--label-background-color);
- border-top:1px solid var(--label-left-top-border-color);
- border-left:1px solid var(--label-left-top-border-color);
- border-right:1px solid var(--label-right-bottom-border-color);
- border-bottom:1px solid var(--label-right-bottom-border-color);
+ background-color: var(--label-background-color);
+ border-top:1px solid var(--label-left-top-border-color);
+ border-left:1px solid var(--label-left-top-border-color);
+ border-right:1px solid var(--label-right-bottom-border-color);
+ border-bottom:1px solid var(--label-right-bottom-border-color);
text-shadow: none;
color: var(--label-foreground-color);
margin-right: 4px;
@@ -1259,39 +1426,37 @@ span.mlabel {
/* these are for tree view inside a (index) page */
div.directory {
- margin: 10px 0px;
- border-top: 1px solid var(--directory-separator-color);
- border-bottom: 1px solid var(--directory-separator-color);
- width: 100%;
+ margin: 10px 0px;
+ width: 100%;
}
.directory table {
- border-collapse:collapse;
+ border-collapse:collapse;
}
.directory td {
- margin: 0px;
- padding: 0px;
+ margin: 0px;
+ padding: 0px;
vertical-align: top;
}
.directory td.entry {
- white-space: nowrap;
- padding-right: 6px;
+ white-space: nowrap;
+ padding-right: 6px;
padding-top: 3px;
}
.directory td.entry a {
- outline:none;
+ outline:none;
}
.directory td.entry a img {
- border: none;
+ border: none;
}
.directory td.desc {
- width: 100%;
- padding-left: 6px;
+ width: 100%;
+ padding-left: 6px;
padding-right: 6px;
padding-top: 3px;
border-left: 1px solid rgba(0,0,0,0.05);
@@ -1312,90 +1477,178 @@ div.directory {
}
.directory .levels {
- white-space: nowrap;
- width: 100%;
- text-align: right;
- font-size: 9pt;
+ white-space: nowrap;
+ width: 100%;
+ text-align: right;
+ font-size: 9pt;
}
.directory .levels span {
- cursor: pointer;
- padding-left: 2px;
- padding-right: 2px;
+ cursor: pointer;
+ padding-left: 2px;
+ padding-right: 2px;
color: var(--page-link-color);
}
.arrow {
- color: var(--nav-arrow-color);
- -webkit-user-select: none;
- -khtml-user-select: none;
- -moz-user-select: none;
- -ms-user-select: none;
- user-select: none;
- cursor: pointer;
- font-size: 80%;
- display: inline-block;
- width: 16px;
- height: 22px;
+ color: var(--nav-background-color);
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ cursor: pointer;
+ font-size: 80%;
+ display: inline-block;
+ width: 16px;
+ height: 14px;
+ transition: opacity 0.3s ease;
+}
+
+span.arrowhead {
+ position: relative;
+ padding: 0;
+ margin: 0 0 0 2px;
+ display: inline-block;
+ width: 5px;
+ height: 5px;
+ border-right: 2px solid var(--nav-arrow-color);
+ border-bottom: 2px solid var(--nav-arrow-color);
+ transform: rotate(-45deg);
+ transition: transform 0.3s ease;
+}
+
+span.arrowhead.opened {
+ transform: rotate(45deg);
+}
+
+.selected span.arrowhead {
+ border-right: 2px solid var(--nav-arrow-selected-color);
+ border-bottom: 2px solid var(--nav-arrow-selected-color);
}
.icon {
- font-family: var(--font-family-icon);
- line-height: normal;
- font-weight: bold;
- font-size: 12px;
- height: 14px;
- width: 16px;
- display: inline-block;
- background-color: var(--icon-background-color);
- color: var(--icon-foreground-color);
- text-align: center;
- border-radius: 4px;
- margin-left: 2px;
- margin-right: 2px;
+ font-family: var(--font-family-icon);
+ line-height: normal;
+ font-weight: bold;
+ font-size: 12px;
+ height: 14px;
+ width: 16px;
+ display: inline-block;
+ background-color: var(--icon-background-color);
+ color: var(--icon-foreground-color);
+ text-align: center;
+ border-radius: 4px;
+ margin-left: 2px;
+ margin-right: 2px;
}
.icona {
- width: 24px;
- height: 22px;
- display: inline-block;
+ width: 24px;
+ height: 22px;
+ display: inline-block;
}
-.iconfopen {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:var(--icon-folder-open-image);
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
+.iconfolder {
+ width: 24px;
+ height: 18px;
+ margin-top: 6px;
+ vertical-align:top;
+ display: inline-block;
+ position: relative;
}
-.iconfclosed {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:var(--icon-folder-closed-image);
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
+.icondoc {
+ width: 24px;
+ height: 18px;
+ margin-top: 3px;
+ vertical-align:top;
+ display: inline-block;
+ position: relative;
}
-.icondoc {
- width: 24px;
- height: 18px;
- margin-bottom: 4px;
- background-image:var(--icon-doc-image);
- background-position: 0px -4px;
- background-repeat: repeat-y;
- vertical-align:top;
- display: inline-block;
+.folder-icon {
+ width: 16px;
+ height: 11px;
+ background-color: var(--icon-folder-fill-color);
+ border: 1px solid var(--icon-folder-border-color);
+ border-radius: 0 2px 2px 2px;
+ position: relative;
+ box-sizing: content-box;
+}
+
+.folder-icon::after {
+ content: '';
+ position: absolute;
+ top: 2px;
+ left: -1px;
+ width: 16px;
+ height: 7px;
+ background-color: var(--icon-folder-open-fill-color);
+ border: 1px solid var(--icon-folder-border-color);
+ border-radius: 7px 7px 2px 2px;
+ transform-origin: top left;
+ opacity: 0;
+ transition: all 0.3s linear;
+}
+
+.folder-icon::before {
+ content: '';
+ position: absolute;
+ top: -3px;
+ left: -1px;
+ width: 6px;
+ height: 2px;
+ background-color: var(--icon-folder-fill-color);
+ border-top: 1px solid var(--icon-folder-border-color);
+ border-left: 1px solid var(--icon-folder-border-color);
+ border-right: 1px solid var(--icon-folder-border-color);
+ border-radius: 2px 2px 0 0;
+}
+
+.folder-icon.open::after {
+ top: 3px;
+ opacity: 1;
+}
+
+.doc-icon {
+ left: 6px;
+ width: 12px;
+ height: 16px;
+ background-color: var(--icon-doc-border-color);
+ clip-path: polygon(0 0, 66% 0, 100% 25%, 100% 100%, 0 100%);
+ position: relative;
+ display: inline-block;
+}
+.doc-icon::before {
+ content: "";
+ left: 1px;
+ top: 1px;
+ width: 10px;
+ height: 14px;
+ background-color: var(--icon-doc-fill-color);
+ clip-path: polygon(0 0, 66% 0, 100% 25%, 100% 100%, 0 100%);
+ position: absolute;
+ box-sizing: border-box;
+}
+.doc-icon::after {
+ content: "";
+ left: 7px;
+ top: 0px;
+ width: 3px;
+ height: 3px;
+ background-color: transparent;
+ position: absolute;
+ border: 1px solid var(--icon-doc-border-color);
}
+
+
+
/* @end */
div.dynheader {
- margin-top: 8px;
+ margin-top: 8px;
-webkit-touch-callout: none;
-webkit-user-select: none;
-khtml-user-select: none;
@@ -1404,6 +1657,13 @@ div.dynheader {
user-select: none;
}
+span.dynarrow {
+ position: relative;
+ display: inline-block;
+ width: 12px;
+ bottom: 1px;
+}
+
address {
font-style: normal;
color: var(--footer-foreground-color);
@@ -1415,8 +1675,8 @@ table.doxtable caption {
table.doxtable {
border-collapse:collapse;
- margin-top: 4px;
- margin-bottom: 4px;
+ margin-top: 4px;
+ margin-bottom: 4px;
}
table.doxtable td, table.doxtable th {
@@ -1433,133 +1693,145 @@ table.doxtable th {
}
table.fieldtable {
- margin-bottom: 10px;
- border: 1px solid var(--memdef-border-color);
- border-spacing: 0px;
- border-radius: 4px;
- box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
+ margin-bottom: 10px;
+ border: 1px solid var(--memdef-border-color);
+ border-spacing: 0px;
+ border-radius: 4px;
+ box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
}
.fieldtable td, .fieldtable th {
- padding: 3px 7px 2px;
+ padding: 3px 7px 2px;
}
.fieldtable td.fieldtype, .fieldtable td.fieldname, .fieldtable td.fieldinit {
- white-space: nowrap;
- border-right: 1px solid var(--memdef-border-color);
- border-bottom: 1px solid var(--memdef-border-color);
- vertical-align: top;
+ white-space: nowrap;
+ border-right: 1px solid var(--memdef-border-color);
+ border-bottom: 1px solid var(--memdef-border-color);
+ vertical-align: top;
}
.fieldtable td.fieldname {
- padding-top: 3px;
+ padding-top: 3px;
}
.fieldtable td.fieldinit {
- padding-top: 3px;
- text-align: right;
+ padding-top: 3px;
+ text-align: right;
}
.fieldtable td.fielddoc {
- border-bottom: 1px solid var(--memdef-border-color);
+ border-bottom: 1px solid var(--memdef-border-color);
}
.fieldtable td.fielddoc p:first-child {
- margin-top: 0px;
+ margin-top: 0px;
}
.fieldtable td.fielddoc p:last-child {
- margin-bottom: 2px;
+ margin-bottom: 2px;
}
.fieldtable tr:last-child td {
- border-bottom: none;
+ border-bottom: none;
}
.fieldtable th {
- background-image: var(--memdef-title-gradient-image);
- background-repeat:repeat-x;
- background-color: var(--memdef-title-background-color);
- font-size: 90%;
- color: var(--memdef-proto-text-color);
- padding-bottom: 4px;
- padding-top: 5px;
- text-align:left;
- font-weight: 400;
- border-top-left-radius: 4px;
- border-top-right-radius: 4px;
- border-bottom: 1px solid var(--memdef-border-color);
-}
-
-
-.tabsearch {
- top: 0px;
- left: 10px;
- height: 36px;
- background-image: var(--nav-gradient-image);
- z-index: 101;
+ background-color: var(--memdef-title-background-color);
+ font-size: 90%;
+ color: var(--memdef-proto-text-color);
+ padding-bottom: 4px;
+ padding-top: 5px;
+ text-align:left;
+ font-weight: 400;
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+ border-bottom: 1px solid var(--memdef-border-color);
+}
+
+/* ----------- navigation breadcrumb styling ----------- */
+
+#nav-path ul {
+ height: 30px;
+ line-height: 30px;
+ color: var(--nav-text-normal-color);
overflow: hidden;
- font-size: 13px;
+ margin: 0px;
+ padding-left: 4px;
+ background-image: none;
+ background: var(--page-background-color);
+ border-bottom: 1px solid var(--nav-breadcrumb-separator-color);
+ font-size: var(--nav-font-size-level1);
+ font-family: var(--font-family-nav);
+ position: relative;
+ z-index: 100;
}
-.navpath ul
-{
- font-size: 11px;
- background-image: var(--nav-gradient-image);
- background-repeat:repeat-x;
- background-position: 0 -5px;
- height:30px;
- line-height:30px;
- color:var(--nav-text-normal-color);
- border:solid 1px var(--nav-breadcrumb-border-color);
- overflow:hidden;
- margin:0px;
- padding:0px;
-}
-
-.navpath li
-{
+#main-nav {
+ border-bottom: 1px solid var(--nav-border-color);
+}
+
+.navpath li {
list-style-type:none;
float:left;
+ color: var(--nav-foreground-color);
+}
+
+.navpath li.footer {
+ list-style-type:none;
+ float:right;
padding-left:10px;
padding-right:15px;
- background-image:var(--nav-breadcrumb-image);
+ background-image:none;
background-repeat:no-repeat;
background-position:right;
- color: var(--nav-foreground-color);
+ font-size: 8pt;
+ color: var(--footer-foreground-color);
}
-.navpath li.navelem a
-{
- height:32px;
- display:block;
- outline: none;
- color: var(--nav-text-normal-color);
- font-family: var(--font-family-nav);
- text-shadow: var(--nav-text-normal-shadow);
- text-decoration: none;
+#nav-path li.navelem {
+ background-image: none;
+ display: flex;
+ align-items: center;
+ padding-left: 15px;
}
-.navpath li.navelem a:hover
-{
- color: var(--nav-text-hover-color);
- text-shadow: var(--nav-text-hover-shadow);
+.navpath li.navelem a {
+ text-shadow: none;
+ display: inline-block;
+ color: var(--nav-breadcrumb-color);
+ position: relative;
+ top: 0px;
+ height: 30px;
+ margin-right: -20px;
}
-.navpath li.footer
-{
- list-style-type:none;
- float:right;
- padding-left:10px;
- padding-right:15px;
- background-image:none;
- background-repeat:no-repeat;
- background-position:right;
- color: var(--footer-foreground-color);
- font-size: 8pt;
+#nav-path li.navelem:after {
+ content: '';
+ display: inline-block;
+ position: relative;
+ top: 0;
+ right: -15px;
+ width: 30px;
+ height: 30px;
+ transform: scaleX(0.5) scale(0.707) rotate(45deg);
+ z-index: 10;
+ background: var(--page-background-color);
+ box-shadow: 2px -2px 0 2px var(--nav-breadcrumb-separator-color);
+ border-radius: 0 5px 0 50px;
+}
+
+#nav-path li.navelem:first-child {
+ margin-left: -6px;
}
+#nav-path li.navelem:hover,
+#nav-path li.navelem:hover:after {
+ background-color: var(--nav-breadcrumb-active-bg);
+}
+
+/* ---------------------- */
div.summary
{
@@ -1577,14 +1849,14 @@ div.summary a
table.classindex
{
- margin: 10px;
- white-space: nowrap;
- margin-left: 3%;
- margin-right: 3%;
- width: 94%;
- border: 0;
- border-spacing: 0;
- padding: 0;
+ margin: 10px;
+ white-space: nowrap;
+ margin-left: 3%;
+ margin-right: 3%;
+ width: 94%;
+ border: 0;
+ border-spacing: 0;
+ padding: 0;
}
div.ingroups
@@ -1601,10 +1873,8 @@ div.ingroups a
div.header
{
- background-image: var(--header-gradient-image);
- background-repeat:repeat-x;
- background-color: var(--header-background-color);
margin: 0px;
+ background-color: var(--header-background-color);
border-bottom: 1px solid var(--header-separator-color);
}
@@ -1613,168 +1883,105 @@ div.headertitle
padding: 5px 5px 5px 10px;
}
-.PageDocRTL-title div.headertitle {
- text-align: right;
- direction: rtl;
-}
-
dl {
- padding: 0 0 0 0;
-}
-
-/*
-
-dl.section {
- margin-left: 0px;
- padding-left: 0px;
-}
-
-dl.note {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #D0C000;
-}
-
-dl.warning, dl.attention, dl.important {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #FF0000;
-}
-
-dl.pre, dl.post, dl.invariant {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #00D000;
-}
-
-dl.deprecated {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #505050;
-}
-
-dl.todo {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #00C0E0;
-}
-
-dl.test {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #3030E0;
-}
-
-dl.bug {
- margin-left: -7px;
- padding-left: 3px;
- border-left: 4px solid;
- border-color: #C08050;
+ padding: 0 0 0 0;
}
-*/
-
dl.bug dt a, dl.deprecated dt a, dl.todo dt a, dl.test a {
- font-weight: bold !important;
+ font-weight: bold !important;
}
dl.warning, dl.attention, dl.important, dl.note, dl.deprecated, dl.bug,
dl.invariant, dl.pre, dl.post, dl.todo, dl.test, dl.remark {
- padding: 10px;
- margin: 10px 0px;
- overflow: hidden;
- margin-left: 0;
- border-radius: 4px;
+ padding: 10px;
+ margin: 10px 0px;
+ overflow: hidden;
+ margin-left: 0;
+ border-radius: 4px;
}
dl.section dd {
- margin-bottom: 2px;
+ margin-bottom: 2px;
}
dl.warning, dl.attention, dl.important {
- background: var(--warning-color-bg);
- border-left: 8px solid var(--warning-color-hl);
- color: var(--warning-color-text);
+ background: var(--warning-color-bg);
+ border-left: 8px solid var(--warning-color-hl);
+ color: var(--warning-color-text);
}
dl.warning dt, dl.attention dt, dl.important dt {
- color: var(--warning-color-hl);
+ color: var(--warning-color-hl);
}
dl.note, dl.remark {
- background: var(--note-color-bg);
- border-left: 8px solid var(--note-color-hl);
- color: var(--note-color-text);
+ background: var(--note-color-bg);
+ border-left: 8px solid var(--note-color-hl);
+ color: var(--note-color-text);
}
dl.note dt, dl.remark dt {
- color: var(--note-color-hl);
+ color: var(--note-color-hl);
}
dl.todo {
- background: var(--todo-color-bg);
- border-left: 8px solid var(--todo-color-hl);
- color: var(--todo-color-text);
+ background: var(--todo-color-bg);
+ border-left: 8px solid var(--todo-color-hl);
+ color: var(--todo-color-text);
}
dl.todo dt {
- color: var(--todo-color-hl);
+ color: var(--todo-color-hl);
}
dl.test {
- background: var(--test-color-bg);
- border-left: 8px solid var(--test-color-hl);
- color: var(--test-color-text);
+ background: var(--test-color-bg);
+ border-left: 8px solid var(--test-color-hl);
+ color: var(--test-color-text);
}
dl.test dt {
- color: var(--test-color-hl);
+ color: var(--test-color-hl);
}
dl.bug dt a {
- color: var(--bug-color-hl) !important;
+ color: var(--bug-color-hl) !important;
}
dl.bug {
- background: var(--bug-color-bg);
- border-left: 8px solid var(--bug-color-hl);
- color: var(--bug-color-text);
+ background: var(--bug-color-bg);
+ border-left: 8px solid var(--bug-color-hl);
+ color: var(--bug-color-text);
}
dl.bug dt a {
- color: var(--bug-color-hl) !important;
+ color: var(--bug-color-hl) !important;
}
dl.deprecated {
- background: var(--deprecated-color-bg);
- border-left: 8px solid var(--deprecated-color-hl);
- color: var(--deprecated-color-text);
+ background: var(--deprecated-color-bg);
+ border-left: 8px solid var(--deprecated-color-hl);
+ color: var(--deprecated-color-text);
}
dl.deprecated dt a {
- color: var(--deprecated-color-hl) !important;
+ color: var(--deprecated-color-hl) !important;
}
dl.note dd, dl.warning dd, dl.pre dd, dl.post dd,
dl.remark dd, dl.attention dd, dl.important dd, dl.invariant dd,
dl.bug dd, dl.deprecated dd, dl.todo dd, dl.test dd {
- margin-inline-start: 0px;
+ margin-inline-start: 0px;
}
dl.invariant, dl.pre, dl.post {
- background: var(--invariant-color-bg);
- border-left: 8px solid var(--invariant-color-hl);
- color: var(--invariant-color-text);
+ background: var(--invariant-color-bg);
+ border-left: 8px solid var(--invariant-color-hl);
+ color: var(--invariant-color-text);
}
dl.invariant dt, dl.pre dt, dl.post dt {
- color: var(--invariant-color-hl);
+ color: var(--invariant-color-hl);
}
@@ -1797,16 +2004,16 @@ dl.invariant dt, dl.pre dt, dl.post dt {
#projectalign
{
- vertical-align: middle;
- padding-left: 0.5em;
+ vertical-align: middle;
+ padding-left: 0.5em;
}
#projectname
{
font-size: 200%;
font-family: var(--font-family-title);
- margin: 0px;
- padding: 2px 0px;
+ margin: 0;
+ padding: 0;
}
#side-nav #projectname
@@ -1817,7 +2024,7 @@ dl.invariant dt, dl.pre dt, dl.post dt {
#projectbrief
{
font-size: 90%;
- font-family: var(--font-family-title);
+ font-family: var(--font-family-title);
margin: 0px;
padding: 0px;
}
@@ -1825,43 +2032,42 @@ dl.invariant dt, dl.pre dt, dl.post dt {
#projectnumber
{
font-size: 50%;
- font-family: 50% var(--font-family-title);
+ font-family: var(--font-family-title);
margin: 0px;
padding: 0px;
}
#titlearea
{
- padding: 0px;
+ padding: 0 0 0 5px;
margin: 0px;
- width: 100%;
border-bottom: 1px solid var(--title-separator-color);
background-color: var(--title-background-color);
}
.image
{
- text-align: center;
+ text-align: center;
}
.dotgraph
{
- text-align: center;
+ text-align: center;
}
.mscgraph
{
- text-align: center;
+ text-align: center;
}
.plantumlgraph
{
- text-align: center;
+ text-align: center;
}
.diagraph
{
- text-align: center;
+ text-align: center;
}
.caption
@@ -1870,67 +2076,67 @@ dl.invariant dt, dl.pre dt, dl.post dt {
}
dl.citelist {
- margin-bottom:50px;
+ margin-bottom:50px;
}
dl.citelist dt {
- color:var(--citation-label-color);
- float:left;
- font-weight:bold;
- margin-right:10px;
- padding:5px;
- text-align:right;
- width:52px;
+ color:var(--citation-label-color);
+ float:left;
+ font-weight:bold;
+ margin-right:10px;
+ padding:5px;
+ text-align:right;
+ width:52px;
}
dl.citelist dd {
- margin:2px 0 2px 72px;
- padding:5px 0;
+ margin:2px 0 2px 72px;
+ padding:5px 0;
}
div.toc {
- padding: 14px 25px;
- background-color: var(--toc-background-color);
- border: 1px solid var(--toc-border-color);
- border-radius: 7px 7px 7px 7px;
- float: right;
- height: auto;
- margin: 0 8px 10px 10px;
- width: 200px;
+ padding: 14px 25px;
+ background-color: var(--toc-background-color);
+ border: 1px solid var(--toc-border-color);
+ border-radius: 7px 7px 7px 7px;
+ float: right;
+ height: auto;
+ margin: 0 8px 10px 10px;
+ width: 200px;
}
div.toc li {
- background: var(--toc-down-arrow-image) no-repeat scroll 0 5px transparent;
- font: 10px/1.2 var(--font-family-toc);
- margin-top: 5px;
- padding-left: 10px;
- padding-top: 2px;
+ background: var(--toc-down-arrow-image) no-repeat scroll 0 5px transparent;
+ font: 10px/1.2 var(--font-family-toc);
+ margin-top: 5px;
+ padding-left: 10px;
+ padding-top: 2px;
}
div.toc h3 {
- font: bold 12px/1.2 var(--font-family-toc);
+ font: bold 12px/1.2 var(--font-family-toc);
color: var(--toc-header-color);
- border-bottom: 0 none;
- margin: 0;
+ border-bottom: 0 none;
+ margin: 0;
}
div.toc ul {
- list-style: none outside none;
- border: medium none;
- padding: 0px;
+ list-style: none outside none;
+ border: medium none;
+ padding: 0px;
}
div.toc li[class^='level'] {
- margin-left: 15px;
+ margin-left: 15px;
}
div.toc li.level1 {
- margin-left: 0px;
+ margin-left: 0px;
}
div.toc li.empty {
- background-image: none;
- margin-top: 0px;
+ background-image: none;
+ margin-top: 0px;
}
span.emoji {
@@ -1940,13 +2146,12 @@ span.emoji {
}
span.obfuscator {
- display: none;
+ display: none;
}
.inherit_header {
- font-weight: bold;
- color: var(--inherit-header-color);
- cursor: pointer;
+ font-weight: 400;
+ cursor: pointer;
-webkit-touch-callout: none;
-webkit-user-select: none;
-khtml-user-select: none;
@@ -1956,49 +2161,49 @@ span.obfuscator {
}
.inherit_header td {
- padding: 6px 0px 2px 5px;
+ padding: 6px 0 2px 0;
}
.inherit {
- display: none;
+ display: none;
}
tr.heading h2 {
- margin-top: 12px;
- margin-bottom: 4px;
+ margin-top: 12px;
+ margin-bottom: 12px;
}
/* tooltip related style info */
.ttc {
- position: absolute;
- display: none;
+ position: absolute;
+ display: none;
}
#powerTip {
cursor: default;
- /*white-space: nowrap;*/
- color: var(--tooltip-foreground-color);
+ color: var(--tooltip-foreground-color);
background-color: var(--tooltip-background-color);
+ backdrop-filter: var(--tooltip-backdrop-filter);
+ -webkit-backdrop-filter: var(--tooltip-backdrop-filter);
border: 1px solid var(--tooltip-border-color);
- border-radius: 4px 4px 4px 4px;
+ border-radius: 4px;
box-shadow: var(--tooltip-shadow);
display: none;
font-size: smaller;
max-width: 80%;
- opacity: 0.9;
padding: 1ex 1em 1em;
position: absolute;
z-index: 2147483647;
}
#powerTip div.ttdoc {
- color: var(--tooltip-doc-color);
+ color: var(--tooltip-doc-color);
font-style: italic;
}
#powerTip div.ttname a {
- font-weight: bold;
+ font-weight: bold;
}
#powerTip a {
@@ -2006,18 +2211,18 @@ tr.heading h2 {
}
#powerTip div.ttname {
- font-weight: bold;
+ font-weight: bold;
}
#powerTip div.ttdeci {
- color: var(--tooltip-declaration-color);
+ color: var(--tooltip-declaration-color);
}
#powerTip div {
- margin: 0px;
- padding: 0px;
- font-size: 12px;
- font-family: var(--font-family-tooltip);
+ margin: 0px;
+ padding: 0px;
+ font-size: 12px;
+ font-family: var(--font-family-tooltip);
line-height: 16px;
}
@@ -2063,7 +2268,7 @@ tr.heading h2 {
}
#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after {
- border-top-color: var(--tooltip-background-color);
+ border-top-color: var(--tooltip-arrow-background-color);
border-width: 10px;
margin: 0px -10px;
}
@@ -2091,7 +2296,7 @@ tr.heading h2 {
}
#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after {
- border-bottom-color: var(--tooltip-background-color);
+ border-bottom-color: var(--tooltip-arrow-background-color);
border-width: 10px;
margin: 0px -10px;
}
@@ -2148,29 +2353,29 @@ tr.heading h2 {
@media print
{
- #top { display: none; }
- #side-nav { display: none; }
- #nav-path { display: none; }
- body { overflow:visible; }
- h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
- .summary { display: none; }
- .memitem { page-break-inside: avoid; }
- #doc-content
- {
- margin-left:0 !important;
- height:auto !important;
- width:auto !important;
- overflow:inherit;
- display:inline;
- }
+ #top { display: none; }
+ #side-nav { display: none; }
+ #nav-path { display: none; }
+ body { overflow:visible; }
+ h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
+ .summary { display: none; }
+ .memitem { page-break-inside: avoid; }
+ #doc-content
+ {
+ margin-left:0 !important;
+ height:auto !important;
+ width:auto !important;
+ overflow:inherit;
+ display:inline;
+ }
}
/* @group Markdown */
table.markdownTable {
border-collapse:collapse;
- margin-top: 4px;
- margin-bottom: 4px;
+ margin-top: 4px;
+ margin-bottom: 4px;
}
table.markdownTable td, table.markdownTable th {
@@ -2203,11 +2408,11 @@ th.markdownTableHeadCenter, td.markdownTableBodyCenter {
tt, code, kbd
{
- display: inline-block;
+ display: inline-block;
}
tt, code, kbd
{
- vertical-align: top;
+ vertical-align: top;
}
/* @end */
@@ -2216,26 +2421,27 @@ u {
}
details>summary {
- list-style-type: none;
+ list-style-type: none;
}
details > summary::-webkit-details-marker {
- display: none;
+ display: none;
}
details>summary::before {
- content: "\25ba";
- padding-right:4px;
- font-size: 80%;
+ content: "\25ba";
+ padding-right:4px;
+ font-size: 80%;
}
details[open]>summary::before {
- content: "\25bc";
- padding-right:4px;
- font-size: 80%;
+ content: "\25bc";
+ padding-right:4px;
+ font-size: 80%;
}
-body {
+:root {
+ scrollbar-width: thin;
scrollbar-color: var(--scrollbar-thumb-color) var(--scrollbar-background-color);
}
diff --git a/docs/html/doxygen_crawl.html b/docs/html/doxygen_crawl.html
index 1a7784e..6b8ae0b 100644
--- a/docs/html/doxygen_crawl.html
+++ b/docs/html/doxygen_crawl.html
@@ -4,7 +4,7 @@
Validator / crawler helper - + diff --git a/docs/html/dynsections.js b/docs/html/dynsections.js index b05f4c8..0e15bd4 100644 --- a/docs/html/dynsections.js +++ b/docs/html/dynsections.js @@ -28,7 +28,6 @@ function toggleVisibility(linkObj) { } let dynsection = { - // helper function updateStripes : function() { $('table.directory tr'). @@ -44,15 +43,13 @@ let dynsection = { const trigger = $('#'+base+'-trigger'); const src=$(trigger).attr('src'); if (content.is(':visible')===true) { - content.hide(); + content.slideUp('fast'); summary.show(); - $(linkObj).addClass('closed').removeClass('opened'); - $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png'); + $(linkObj).find('.arrowhead').addClass('closed').removeClass('opened'); } else { - content.show(); + content.slideDown('fast'); summary.hide(); - $(linkObj).removeClass('closed').addClass('opened'); - $(trigger).attr('src',src.substring(0,src.length-10)+'open.png'); + $(linkObj).find('.arrowhead').removeClass('closed').addClass('opened'); } return false; }, @@ -63,12 +60,12 @@ let dynsection = { const i = $('#img'+this.id.substring(3)); const a = $('#arr'+this.id.substring(3)); if (lD3D12 Memory Allocator: Frequently asked questions - - @@ -33,33 +31,22 @@ - + -- +-+Frequently asked questionsFrequently asked questionsdiff --git a/docs/html/files.html b/docs/html/files.html index 0ccb6a5..5ce45bf 100644 --- a/docs/html/files.html +++ b/docs/html/files.html @@ -3,15 +3,13 @@ - +What is D3D12MA?
@@ -96,18 +83,18 @@What is the license of D3D12MA?
D3D12MA is licensed under MIT, which means it is open source and free software.
What is the purpose of D3D12MA?
-D3D12MA helps with handling one aspect of DX12 usage, which is GPU memory management - allocation of
+ID3D12Heapobjects and creation ofID3D12Resourceobjects - buffers and textures.D3D12MA helps with handling one aspect of DX12 usage, which is GPU memory management - allocation of ID3D12Heap objects and creation of ID3D12Resource objects - buffers and textures.
Do I need to use D3D12MA?
You don't need to, but it may be beneficial in many cases. DX12 is a complex and low-level API, so libraries like this that abstract certain aspects of the API and bring them to a higher level are useful. When developing any non-trivial graphics application, you may benefit from using a memory allocator. Using D3D12MA can save time compared to implementing your own.
-In DX12 you can create each resource separately with its own implicit memory heap by calling
+CreateCommittedResource, but this may not be the optimal solution. For more information, see Committed versus placed resources.In DX12 you can create each resource separately with its own implicit memory heap by calling CreateCommittedResource, but this may not be the optimal solution. For more information, see Committed versus placed resources.
When should I not use D3D12MA?
While D3D12MA is useful for many applications that use the DX12 API, there are cases when it may be a better choice not to use it. For example, if the application is very simple, e.g. serving as a sample or a learning exercise to help you understand or teach others the basics of DX12, and it creates only a small number of buffers and textures, then including D3D12MA may be an overkill. Developing your own memory allocator may also be a good learning exercise.
What are the benefits of using D3D12MA?
-
-
The library is doing much more under the hood. For example, it keeps buffers separate from textures when needed, respecting
+D3D12_RESOURCE_HEAP_TIER. It also makes use of the "small texture alignment" automatically, so you don't need to think about it.The library is doing much more under the hood. For example, it keeps buffers separate from textures when needed, respecting D3D12_RESOURCE_HEAP_TIER. It also makes use of the "small texture alignment" automatically, so you don't need to think about it.
Which version should I pick?
You can just pick the latest version from the "master" branch. It is kept in a good shape most of the time, compiling and working correctly, with no compatibility-breaking changes and no unfinished code.
If you want an even more stable version, you can pick the latest official release. Current code from the master branch is occasionally tagged as a release, with CHANGELOG carefully curated to enumerate all important changes since the previous version.
@@ -119,10 +106,10 @@I am not a fan of modern C++. Can I still use it?
Very likely yes. We acknowledge that many C++ developers, especially in the games industry, do not appreciate all the latest features that the language has to offer.
-
-
Is it available for other programming languages?
D3D12MA is a C++ library in similar style as DX12. Bindings to other programming languages are out of scope of this project, but they are welcome as external projects. Some of them are listed in README.md, "See also" section, including binding to C. Before using any of them, please check if they are still maintained and updated to use a recent version of D3D12MA.
@@ -132,7 +119,7 @@No! While D3D12MA is published by AMD, it works on any GPU that supports DX12, whether a discrete PC graphics card or a processor integrated graphics. It doesn't give AMD GPUs any advantage over any other GPUs.
What DirectX 12 versions are supported?
D3D12MA is updated to support latest versions of DirectX 12, as available through recent retail versions of the DirectX 12 Agility SDK. Support for new features added in the preview version of the Agility SDK is developed on separate branches until they are included in the retail version.
-The library also supports older versions down to the base DX12 shipping with Windows SDK. Features added by later versions of the Agility SDK are automatically enabled conditionally using
+#ifdefpreprocessor macros depending on the version of the SDK that you compile your project with.The library also supports older versions down to the base DX12 shipping with Windows SDK. Features added by later versions of the Agility SDK are automatically enabled conditionally using #ifdef preprocessor macros depending on the version of the SDK that you compile your project with.
Does it support other graphics APIs, like Vulkan(R)?
No, but we offer an equivalent library for Vulkan: Vulkan Memory Allocator. It uses the same core allocation algorithm. It also shares many features with D3D12MA, like the support for custom pools and virtual allocator. However, it is not identical in terms of the features supported. Its API also looks different, because while the interface of D3D12MA is similar in style to DX12, the interface of VMA is similar to Vulkan.
Is the library lightweight?
@@ -154,8 +141,8 @@If you want to report a suspected bug, you can also create a ticket the same way. Before doing this, please put some effort into the investigation of whether the bug is really in the library and not in your code or in the DX12 implementation (the GPU driver) on your platform:
I found some compilation warnings. How can we fix them?
Seeing compiler warnings may be annoying to some developers, but it is a design decision to not fix all of them. Due to the nature of the C++ language, certain preprocessor macros can make some variables unused, function parameters unreferenced, or conditional expressions constant in some configurations. The code of this library should not be bigger or more complicated just to silence these warnings. It is recommended to disable such warnings instead. For more information, see Features not supported.
@@ -164,7 +151,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
D3D12 Memory Allocator: File List - - @@ -33,35 +31,24 @@-diff --git a/docs/html/functions.html b/docs/html/functions.html index 0690bb7..e1beea4 100644 --- a/docs/html/functions.html +++ b/docs/html/functions.html @@ -3,15 +3,13 @@ - +Here is a list of all files with brief descriptions:[detail level 12]-
▼ include D3D12MemAlloc.h include D3D12MemAlloc.h
-Generated by 1.13.2
+Generated by 1.14.0
D3D12 Memory Allocator: Class Members - - @@ -33,35 +31,24 @@ - +-diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html index 23515d8..8f38cf0 100644 --- a/docs/html/functions_func.html +++ b/docs/html/functions_func.html @@ -3,15 +3,13 @@ - +Here is a list of all class members with links to the classes they belong to:-- a -
-
+
- a -
- a -
- b -
-
+
- b -
- b -
- c -
-
+
- c -
- c -
- d -
-
+
- d -
- e -
-
+
- e -
- f -
-
+
- f -
- g -
-
+
- g -
- g -
- h -
-
+
- h -
- h -
- i -
-
+
- i -
- i -
- l -
-
+
- l -
- m -
-
+
- m -
- m -
- n -
-
+
- n -
- o -
-
+
- o -
- p -
-
+
- p -
- p -
- r -
-
+
- r -
- s -
-
+
- s -
- s -
- t -
-
+
- t -
- u -
-
+
- u -
- u -
-Generated by 1.13.2
+Generated by 1.14.0
D3D12 Memory Allocator: Class Members - Functions - - @@ -33,35 +31,24 @@ - +-diff --git a/docs/html/functions_rela.html b/docs/html/functions_rela.html index b9d0728..f21eddd 100644 --- a/docs/html/functions_rela.html +++ b/docs/html/functions_rela.html @@ -3,15 +3,13 @@ - +Here is a list of all functions with links to the classes they belong to:-- a -
-
+
- a -
- b -
-
+
- b -
- c -
-
+
- c -
- c -
- e -
-
+
- e -
- f -
-
+
- f -
- g -
-
+
- g -
- g -
- i -
-
+
- i -
- i -
- s -
-
+
- s -
- s -
-Generated by 1.13.2
+Generated by 1.14.0
D3D12 Memory Allocator: Class Members - Related Symbols - - @@ -33,35 +31,24 @@ - +-- +diff --git a/docs/html/functions_vars.html b/docs/html/functions_vars.html index f63ab83..fe4ed5f 100644 --- a/docs/html/functions_vars.html +++ b/docs/html/functions_vars.html @@ -3,15 +3,13 @@ - +
-Generated by 1.13.2
+Generated by 1.14.0
D3D12 Memory Allocator: Class Members - Variables - - @@ -33,35 +31,24 @@-diff --git a/docs/html/general_considerations.html b/docs/html/general_considerations.html index ef3888a..05a30ff 100644 --- a/docs/html/general_considerations.html +++ b/docs/html/general_considerations.html @@ -3,15 +3,13 @@ - +Here is a list of all variables with links to the classes they belong to:-- a -
-
+
- a -
- a -
- b -
-
+
- b -
- b -
- c -
-
+
- c -
- e -
-
+
- e -
- f -
-
+
- f -
- h -
-
+
- h -
- h -
- l -
-
+
- l -
- m -
-
+
- m -
- m -
- n -
-
+
- n -
- o -
-
+
- o -
- p -
-
+
- p -
- p -
- r -
-
+
- r -
- s -
-
+
- s -
- t -
-
+
- t -
- u -
-
+
- u -
- u -
-Generated by 1.13.2
+Generated by 1.14.0
D3D12 Memory Allocator: General considerations - - @@ -33,33 +31,22 @@ - + --+General considerationsGeneral considerations-- +diff --git a/docs/html/globals.html b/docs/html/globals.html index 00f8dbd..27989c1 100644 --- a/docs/html/globals.html +++ b/docs/html/globals.html @@ -3,15 +3,13 @@ - ++
Thread safety
-
-
+
Versioning and compatibility
The library uses Semantic Versioning, which means version numbers follow convention: Major.Minor.Patch (e.g. 2.3.0), where:
-
@@ -109,13 +96,13 @@
<
All changes between official releases are documented in file "CHANGELOG.md".
+
Features not supported
Features deliberately excluded from the scope of this library:
-Generated by 1.13.2
+Generated by 1.14.0
D3D12 Memory Allocator: File Members - - @@ -33,35 +31,24 @@-- +diff --git a/docs/html/globals_defs.html b/docs/html/globals_defs.html index feb2e5c..00db10d 100644 --- a/docs/html/globals_defs.html +++ b/docs/html/globals_defs.html @@ -3,15 +3,13 @@ - +
-Generated by 1.13.2
+Generated by 1.14.0
D3D12 Memory Allocator: File Members - - @@ -33,35 +31,24 @@-- +diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html index 292f556..5785855 100644 --- a/docs/html/hierarchy.html +++ b/docs/html/hierarchy.html @@ -3,15 +3,13 @@ - +
-Generated by 1.13.2
+Generated by 1.14.0
D3D12 Memory Allocator: Class Hierarchy - - @@ -33,35 +31,24 @@-diff --git a/docs/html/index.html b/docs/html/index.html index e005026..d7434ba 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -3,15 +3,13 @@ - +This inheritance list is sorted roughly, but not completely, alphabetically:[detail level 12]
@@ -120,7 +107,7 @@CD3D12MA::ALLOCATION_CALLBACKS Custom callbacks to CPU memory allocation functions ▼CD3D12MA::ALLOCATION_DESC Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource CD3D12MA::ALLOCATION_DESC Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource CD3D12MA::CALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure CD3D12MA::ALLOCATOR_DESC Parameters of created Allocator object. To be used with CreateAllocator() CD3D12MA::Budget Statistics of current memory usage and available budget for a specific memory segment group CD3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Parameters for incremental defragmentation steps CD3D12MA::DEFRAGMENTATION_STATS Statistics returned for defragmentation process by function DefragmentationContext::GetStats() CD3D12MA::DetailedStatistics More detailed statistics than D3D12MA::Statistics ▼CIUnknownImpl CIUnknownImpl CD3D12MA::Allocation Represents single memory allocation CD3D12MA::Allocator Represents main object of this library initialized for particular ID3D12DeviceCD3D12MA::Allocator Represents main object of this library initialized for particular ID3D12Device CD3D12MA::DefragmentationContext Represents defragmentation process in progress CD3D12MA::Pool Custom memory pool CD3D12MA::VirtualBlock Represents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory ▼CD3D12MA::POOL_DESC Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool CD3D12MA::POOL_DESC Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool CD3D12MA::CPOOL_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure CD3D12MA::Statistics Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total CD3D12MA::TotalStatistics General statistics from current state of the allocator - total memory usage across all memory heaps and segments ▼CD3D12MA::VIRTUAL_ALLOCATION_DESC Parameters of created virtual allocation to be passed to VirtualBlock::Allocate() CD3D12MA::VIRTUAL_ALLOCATION_DESC Parameters of created virtual allocation to be passed to VirtualBlock::Allocate() CD3D12MA::CVIRTUAL_ALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure CD3D12MA::VIRTUAL_ALLOCATION_INFO Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo() ▼CD3D12MA::VIRTUAL_BLOCK_DESC Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock() CD3D12MA::VIRTUAL_BLOCK_DESC Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock() CD3D12MA::CVIRTUAL_BLOCK_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure CD3D12MA::VirtualAllocation Represents single memory allocation done inside VirtualBlock
-Generated by 1.13.2
+Generated by 1.14.0
D3D12 Memory Allocator: D3D12 Memory Allocator - - @@ -33,35 +31,24 @@ - +-D3D12 Memory Allocator-@@ -142,7 +129,7 @@Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved.
-
License: MITDocumentation of all members: D3D12MemAlloc.h
-+
Documentation of all members: D3D12MemAlloc.h
+Table of contents
+
Web links
-
-
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/linear_algorithm.html b/docs/html/linear_algorithm.html
index 25d5301..0bc59b0 100644
--- a/docs/html/linear_algorithm.html
+++ b/docs/html/linear_algorithm.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Linear allocation algorithm - - @@ -33,33 +31,22 @@ - + -diff --git a/docs/html/menu.js b/docs/html/menu.js index 0fd1e99..15f9c52 100644 --- a/docs/html/menu.js +++ b/docs/html/menu.js @@ -49,7 +49,7 @@ function initMenu(relPath,searchEnabled,serverSide,searchPage,search,treeview) { searchBoxHtml='-+Linear allocation algorithmLinear allocation algorithmEach D3D12 memory block managed by this library has accompanying metadata that keeps track of used and unused regions. By default, the metadata structure and algorithm tries to find best place for new allocations among free regions to optimize memory usage. This way you can allocate and free objects in any order.
@@ -96,17 +83,17 @@Sometimes there is a need to use simpler, linear allocation algorithm. You can create custom pool that uses such algorithm by adding flag D3D12MA::POOL_FLAG_ALGORITHM_LINEAR to D3D12MA::POOL_DESC::Flags while creating D3D12MA::Pool object. Then an alternative metadata management is used. It always creates new allocations after last one and doesn't reuse free regions after allocations freed in the middle. It results in better allocation performance and less memory consumed by metadata.
With this one flag, you can create a custom pool that can be used in many ways: free-at-once, stack, double stack, and ring buffer. See below for details. You don't need to specify explicitly which of these options you are going to use - it is detected automatically.
-+
Free-at-once
-In a pool that uses linear algorithm, you still need to free all the allocations individually by calling
+allocation->Release(). You can free them in any order. New allocations are always made after last one - free space in the middle is not reused. However, when you release all the allocation and the pool becomes empty, allocation starts from the beginning again. This way you can use linear algorithm to speed up creation of allocations that you are going to release all at once.In a pool that uses linear algorithm, you still need to free all the allocations individually by calling allocation->Release(). You can free them in any order. New allocations are always made after last one - free space in the middle is not reused. However, when you release all the allocation and the pool becomes empty, allocation starts from the beginning again. This way you can use linear algorithm to speed up creation of allocations that you are going to release all at once.
This mode is also available for pools created with D3D12MA::POOL_DESC::MaxBlockCount value that allows multiple memory blocks.
-+
Stack
When you free an allocation that was created last, its space can be reused. Thanks to this, if you always release allocations in the order opposite to their creation (LIFO - Last In First Out), you can achieve behavior of a stack.
This mode is also available for pools created with D3D12MA::POOL_DESC::MaxBlockCount value that allows multiple memory blocks.
-+
Double stack
The space reserved by a custom pool with linear algorithm may be used by two stacks:
-
@@ -116,20 +103,20 @@
To make allocation from the upper stack, add flag D3D12MA::ALLOCATION_FLAG_UPPER_ADDRESS to D3D12MA::ALLOCATION_DESC::Flags.
Double stack is available only in pools with one memory block - D3D12MA::POOL_DESC::MaxBlockCount must be 1. Otherwise behavior is undefined.
-When the two stacks' ends meet so there is not enough space between them for a new allocation, such allocation fails with usual
-E_OUTOFMEMORYerror.+
When the two stacks' ends meet so there is not enough space between them for a new allocation, such allocation fails with usual E_OUTOFMEMORY error.
+Ring buffer
When you free some allocations from the beginning and there is not enough free space for a new one at the end of a pool, allocator's "cursor" wraps around to the beginning and starts allocation there. Thanks to this, if you always release allocations in the same order as you created them (FIFO - First In First Out), you can achieve behavior of a ring buffer / queue.
Ring buffer is available only in pools with one memory block - D3D12MA::POOL_DESC::MaxBlockCount must be 1. Otherwise behavior is undefined.
-+
Additional considerations
Linear algorithm can also be used with Virtual allocator. See flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR.
-Generated by 1.13.2
+Generated by 1.14.0
'+ '- + -'+ ''); $('#main-nav').append(makeTree(menudata,relPath)); $('#main-nav').children(':first').addClass('sm sm-dox').attr('id','main-menu'); - if (searchBoxHtml) { - $('#main-menu').append(''); - } + $('#main-menu').append(''); const $mainMenuState = $('#main-menu-state'); let prevWidth = 0; if ($mainMenuState.length) { diff --git a/docs/html/namespace_d3_d12_m_a.html b/docs/html/namespace_d3_d12_m_a.html index e770fdc..b4ae5de 100644 --- a/docs/html/namespace_d3_d12_m_a.html +++ b/docs/html/namespace_d3_d12_m_a.html @@ -3,15 +3,13 @@ - +D3D12 Memory Allocator: D3D12MA Namespace Reference - - @@ -33,33 +31,22 @@--
+
Classes
class Allocation class Allocation Represents single memory allocation. More... struct ALLOCATION_CALLBACKS struct ALLOCATION_CALLBACKS Custom callbacks to CPU memory allocation functions. More... struct ALLOCATION_DESC struct ALLOCATION_DESC Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource. More... class Allocator Represents main object of this library initialized for particular ID3D12Device. More...struct ALLOCATOR_DESC class Allocator Represents main object of this library initialized for particular ID3D12Device. More... struct ALLOCATOR_DESC Parameters of created Allocator object. To be used with CreateAllocator(). More... struct Budget struct Budget Statistics of current memory usage and available budget for a specific memory segment group. More... struct CALLOCATION_DESC struct CALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure. More... struct CPOOL_DESC struct CPOOL_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure. More... struct CVIRTUAL_ALLOCATION_DESC struct CVIRTUAL_ALLOCATION_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure. More... struct CVIRTUAL_BLOCK_DESC struct CVIRTUAL_BLOCK_DESC Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure. More... struct DEFRAGMENTATION_DESC struct DEFRAGMENTATION_DESC Parameters for defragmentation. More... struct DEFRAGMENTATION_MOVE struct DEFRAGMENTATION_MOVE Single move of an allocation to be done for defragmentation. More... struct DEFRAGMENTATION_PASS_MOVE_INFO struct DEFRAGMENTATION_PASS_MOVE_INFO Parameters for incremental defragmentation steps. More... struct DEFRAGMENTATION_STATS struct DEFRAGMENTATION_STATS Statistics returned for defragmentation process by function DefragmentationContext::GetStats(). More... class DefragmentationContext class DefragmentationContext Represents defragmentation process in progress. More... struct DetailedStatistics struct DetailedStatistics More detailed statistics than D3D12MA::Statistics. More... class Pool class Pool Custom memory pool. More... struct POOL_DESC struct POOL_DESC Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool. More... struct Statistics struct Statistics Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total. More... struct TotalStatistics struct TotalStatistics General statistics from current state of the allocator - total memory usage across all memory heaps and segments. More... struct VIRTUAL_ALLOCATION_DESC struct VIRTUAL_ALLOCATION_DESC Parameters of created virtual allocation to be passed to VirtualBlock::Allocate(). More... struct VIRTUAL_ALLOCATION_INFO struct VIRTUAL_ALLOCATION_INFO Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo(). More... struct VIRTUAL_BLOCK_DESC struct VIRTUAL_BLOCK_DESC Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock(). More... struct VirtualAllocation struct VirtualAllocation Represents single memory allocation done inside VirtualBlock. More... class VirtualBlock class VirtualBlock Represents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory. More... -
+
Typedefs
typedef UINT64 AllocHandle Unique identifier of single allocation done inside the memory heap. using ALLOCATE_FUNC_PTR = void* (*)(size_t Size, size_t Alignment, void* pPrivateData) Pointer to custom callback function that allocates CPU memory. using FREE_FUNC_PTR = void (*)(void* pMemory, void* pPrivateData) Pointer to custom callback function that deallocates CPU memory. -
+
Enumerations
enum ALLOCATION_FLAGS {
ALLOCATION_FLAG_NONE = 0 @@ -203,20 +162,17 @@
}Bit flags to be used with ALLOCATION_DESC::Flags. More... enum DEFRAGMENTATION_FLAGS { DEFRAGMENTATION_FLAG_ALGORITHM_FAST = 0x1 , DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED = 0x2 , DEFRAGMENTATION_FLAG_ALGORITHM_FULL = 0x4 , DEFRAGMENTATION_FLAG_ALGORITHM_MASK } Flags to be passed as DEFRAGMENTATION_DESC::Flags. More... enum DEFRAGMENTATION_MOVE_OPERATION { DEFRAGMENTATION_MOVE_OPERATION_COPY = 0 , DEFRAGMENTATION_MOVE_OPERATION_IGNORE = 1 , DEFRAGMENTATION_MOVE_OPERATION_DESTROY = 2 } Operation performed on single defragmentation move. More... enum POOL_FLAGS {
POOL_FLAG_NONE = 0 , POOL_FLAG_ALGORITHM_LINEAR = 0x1 @@ -227,7 +183,6 @@
}Bit flags to be used with POOL_DESC::Flags. More... enum ALLOCATOR_FLAGS {
ALLOCATOR_FLAG_NONE = 0 , ALLOCATOR_FLAG_SINGLETHREADED = 0x1 @@ -239,13 +194,11 @@
}Bit flags to be used with ALLOCATOR_DESC::Flags. More... enum VIRTUAL_BLOCK_FLAGS { VIRTUAL_BLOCK_FLAG_NONE = 0 , VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR = POOL_FLAG_ALGORITHM_LINEAR , VIRTUAL_BLOCK_FLAG_ALGORITHM_MASK = POOL_FLAG_ALGORITHM_MASK } Bit flags to be used with VIRTUAL_BLOCK_DESC::Flags. More... enum VIRTUAL_ALLOCATION_FLAGS {
VIRTUAL_ALLOCATION_FLAG_NONE = 0 , VIRTUAL_ALLOCATION_FLAG_UPPER_ADDRESS = ALLOCATION_FLAG_UPPER_ADDRESS @@ -257,18 +210,15 @@
}Bit flags to be used with VIRTUAL_ALLOCATION_DESC::Flags. More... -
-+
Functions
D3D12MA_API HRESULT CreateAllocator (const ALLOCATOR_DESC *pDesc, Allocator **ppAllocator) Creates new main D3D12MA::Allocator object and returns it through ppAllocator.Creates new main D3D12MA::Allocator object and returns it through ppAllocator. D3D12MA_API HRESULT CreateVirtualBlock (const VIRTUAL_BLOCK_DESC *pDesc, VirtualBlock **ppVirtualBlock) Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock. Typedef Documentation
+Typedef Documentation
◆ ALLOCATE_FUNC_PTR
@@ -314,11 +264,11 @@Pointer to custom callback function that deallocates CPU memory.
-
+pMemory = nullshould be accepted and ignored.pMemory = null should be accepted and ignored.
Enumeration Type Documentation
+Enumeration Type Documentation
◆ ALLOCATION_FLAGS
@@ -338,21 +288,21 @@ALLOCATION_FLAG_COMMITTED
Set this flag if the allocation should have its own dedicated memory allocation (committed resource with implicit heap).
Use it for special, big resources, like fullscreen textures used as render targets.
-
-
ALLOCATION_FLAG_NEVER_ALLOCATE Set this flag to only try to allocate from existing memory heaps and never create new such heap.
-If new allocation cannot be placed in any of the existing heaps, allocation fails with
+E_OUTOFMEMORYerror.If new allocation cannot be placed in any of the existing heaps, allocation fails with E_OUTOFMEMORY error.
You should not use D3D12MA::ALLOCATION_FLAG_COMMITTED and D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE at the same time. It makes no sense.
ALLOCATION_FLAG_WITHIN_BUDGET Create allocation only if additional memory required for it, if any, won't exceed memory budget. Otherwise return
+E_OUTOFMEMORY.ALLOCATION_FLAG_WITHIN_BUDGET Create allocation only if additional memory required for it, if any, won't exceed memory budget. Otherwise return E_OUTOFMEMORY.
ALLOCATION_FLAG_UPPER_ADDRESS Allocation will be created from upper stack in a double stack pool.
This flag is only allowed for custom pools created with POOL_FLAG_ALGORITHM_LINEAR flag.
ALLOCATION_FLAG_CAN_ALIAS Set this flag if the allocated memory will have aliasing resources.
-Use this when calling D3D12MA::Allocator::CreateResource() and similar to guarantee creation of explicit heap for desired allocation and prevent it from using
+CreateCommittedResource, so that new allocation object will always haveallocation->GetHeap() != NULL.Use this when calling D3D12MA::Allocator::CreateResource() and similar to guarantee creation of explicit heap for desired allocation and prevent it from using CreateCommittedResource, so that new allocation object will always have allocation->GetHeap() != NULL.
ALLOCATION_FLAG_STRATEGY_MIN_MEMORY Allocation strategy that chooses smallest possible free range for the allocation to minimize memory usage and fragmentation, possibly at the expense of allocation time.
ALLOCATION_FLAG_STRATEGY_FIRST_FIT
Alias to ALLOCATION_FLAG_STRATEGY_MIN_TIME.
ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only
+STRATEGYbits from entire set of flags.ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
ALLOCATOR_FLAG_ALWAYS_COMMITTED
Every allocation will be created as a committed resource - will have its own memory block.
Affects both default pools and custom pools. To be used for debugging purposes only. There is also an equivalent flag for custom pools: D3D12MA::POOL_FLAG_ALWAYS_COMMITTED.
ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED Heaps created for the default pools will be created with flag
+D3D12_HEAP_FLAG_CREATE_NOT_ZEROED, allowing for their memory to be not zeroed by the system if possible, which can speed up allocation.ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED Heaps created for the default pools will be created with flag D3D12_HEAP_FLAG_CREATE_NOT_ZEROED, allowing for their memory to be not zeroed by the system if possible, which can speed up allocation.
Only affects default pools. To use the flag with Custom memory pools, you need to add it manually:
poolDesc.heapFlags |= D3D12_HEAP_FLAG_CREATE_NOT_ZEROED;-Only avaiable if
+ID3D12Device8is present. Otherwise, the flag is ignored.Only avaiable if ID3D12Device8 is present. Otherwise, the flag is ignored.
ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED Optimization, allocate MSAA textures as committed resources always.
Specify this flag to create MSAA textures with implicit heaps, as if they were created with flag D3D12MA::ALLOCATION_FLAG_COMMITTED. Usage of this flags enables all default pools to create its heaps on smaller alignment not suitable for MSAA textures.
@@ -424,11 +374,11 @@Enumerator DEFRAGMENTATION_FLAG_ALGORITHM_FAST Use simple but fast algorithm for defragmentation. May not achieve best results but will require least time to compute and least allocations to copy.
DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED Default defragmentation algorithm, applied also when no
+ALGORITHMflag is specified. Offers a balance between defragmentation quality and the amount of allocations and bytes that need to be moved.DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED Default defragmentation algorithm, applied also when no ALGORITHM flag is specified. Offers a balance between defragmentation quality and the amount of allocations and bytes that need to be moved.
DEFRAGMENTATION_FLAG_ALGORITHM_FULL Perform full defragmentation of memory. Can result in notably more time to compute and allocations to copy, but will achieve best memory packing.
DEFRAGMENTATION_FLAG_ALGORITHM_MASK A bit mask to extract only
+ALGORITHMbits from entire set of flags.DEFRAGMENTATION_FLAG_ALGORITHM_MASK A bit mask to extract only ALGORITHM bits from entire set of flags.
-
Enumerator DEFRAGMENTATION_MOVE_OPERATION_COPY Resource has been recreated at
+pDstTmpAllocation, data has been copied, old resource has been destroyed.pSrcAllocationwill be changed to point to the new place. This is the default value set by DefragmentationContext::BeginPass().Enumerator DEFRAGMENTATION_MOVE_OPERATION_COPY Resource has been recreated at pDstTmpAllocation, data has been copied, old resource has been destroyed. pSrcAllocation will be changed to point to the new place. This is the default value set by DefragmentationContext::BeginPass().
DEFRAGMENTATION_MOVE_OPERATION_IGNORE Set this value if you cannot move the allocation. New place reserved at
+pDstTmpAllocationwill be freed.pSrcAllocationwill remain unchanged.DEFRAGMENTATION_MOVE_OPERATION_IGNORE Set this value if you cannot move the allocation. New place reserved at pDstTmpAllocation will be freed. pSrcAllocation will remain unchanged.
DEFRAGMENTATION_MOVE_OPERATION_DESTROY Set this value if you decide to abandon the allocation and you destroyed the resource. New place reserved
+pDstTmpAllocationwill be freed, along withpSrcAllocation.DEFRAGMENTATION_MOVE_OPERATION_DESTROY Set this value if you decide to abandon the allocation and you destroyed the resource. New place reserved pDstTmpAllocation will be freed, along with pSrcAllocation.
VIRTUAL_ALLOCATION_FLAG_STRATEGY_MIN_OFFSET
Allocation strategy that chooses always the lowest offset in available space. This is not the most efficient strategy but achieves highly packed data.
VIRTUAL_ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only
+STRATEGYbits from entire set of flags.VIRTUAL_ALLOCATION_FLAG_STRATEGY_MASK A bit mask to extract only STRATEGY bits from entire set of flags.
These strategy flags are binary compatible with equivalent flags in ALLOCATION_FLAGS.
Function Documentation
+Function Documentation
◆ CreateAllocator()
@@ -567,8 +517,8 @@-
Creates new main D3D12MA::Allocator object and returns it through
-ppAllocator.You normally only need to call it once and keep a single Allocator object for your
+ID3D12Device.Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
+You normally only need to call it once and keep a single Allocator object for your ID3D12Device.
@@ -591,7 +541,7 @@-
Creates new D3D12MA::VirtualBlock object and returns it through
+ppVirtualBlock.Creates new D3D12MA::VirtualBlock object and returns it through ppVirtualBlock.
Note you don't need to create D3D12MA::Allocator to use virtual blocks.
@@ -599,7 +549,7 @@-Generated by
1.13.2
+Generated by 1.14.0
diff --git a/docs/html/namespacemembers.html b/docs/html/namespacemembers.html
index 6881ab0..4cadc29 100644
--- a/docs/html/namespacemembers.html
+++ b/docs/html/namespacemembers.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Namespace Members - - @@ -33,35 +31,24 @@ - +-diff --git a/docs/html/namespacemembers_enum.html b/docs/html/namespacemembers_enum.html index 5723a6b..90ffd55 100644 --- a/docs/html/namespacemembers_enum.html +++ b/docs/html/namespacemembers_enum.html @@ -3,15 +3,13 @@ - +Here is a list of all namespace members with links to the namespace documentation for each member:-- a -
-
+
- a -
- a -
- c -
-
+
- c -
-- d -
-
+
- d -
- d -
- f -
-Generated by 1.13.2
+Generated by 1.14.0
D3D12 Memory Allocator: Namespace Members - - @@ -33,35 +31,24 @@ - +-- +diff --git a/docs/html/namespacemembers_eval.html b/docs/html/namespacemembers_eval.html index 365527c..4a4922b 100644 --- a/docs/html/namespacemembers_eval.html +++ b/docs/html/namespacemembers_eval.html @@ -3,15 +3,13 @@ - +
-Generated by 1.13.2
+Generated by 1.14.0
D3D12 Memory Allocator: Namespace Members - - @@ -33,35 +31,24 @@-diff --git a/docs/html/namespacemembers_func.html b/docs/html/namespacemembers_func.html index 02a9cdd..c8a70c7 100644 --- a/docs/html/namespacemembers_func.html +++ b/docs/html/namespacemembers_func.html @@ -3,15 +3,13 @@ - +Here is a list of all namespace enum values with links to the namespace documentation for each enum value:-- a -
-
+
- a -
- a -
- d -
-
+
- d -
- d -
- p -
-Generated by 1.13.2
+Generated by 1.14.0
D3D12 Memory Allocator: Namespace Members - - @@ -33,35 +31,24 @@ - +-- +diff --git a/docs/html/namespacemembers_type.html b/docs/html/namespacemembers_type.html index b56e9c4..e9561e2 100644 --- a/docs/html/namespacemembers_type.html +++ b/docs/html/namespacemembers_type.html @@ -3,15 +3,13 @@ - +
-Generated by 1.13.2
+Generated by 1.14.0
D3D12 Memory Allocator: Namespace Members - - @@ -33,35 +31,24 @@-- +diff --git a/docs/html/namespaces.html b/docs/html/namespaces.html index fe8ddce..acd9768 100644 --- a/docs/html/namespaces.html +++ b/docs/html/namespaces.html @@ -3,15 +3,13 @@ - +
-Generated by 1.13.2
+Generated by 1.14.0
D3D12 Memory Allocator: Namespace List - - @@ -33,35 +31,24 @@-- + -diff --git a/docs/html/navtree.css b/docs/html/navtree.css index 69211d4..0ea3a07 100644 --- a/docs/html/navtree.css +++ b/docs/html/navtree.css @@ -11,8 +11,8 @@ #nav-tree li { white-space:nowrap; - margin:0px; - padding:0px; + margin:0; + padding:0; } #nav-tree .plus { @@ -20,15 +20,10 @@ } #nav-tree .selected { - background-image: url('tab_a.png'); - background-repeat:repeat-x; - color: var(--nav-text-active-color); - text-shadow: var(--nav-text-active-shadow); -} - -#nav-tree .selected .arrow { - color: var(--nav-arrow-selected-color); - text-shadow: none; + position: relative; + background-color: var(--nav-menu-active-bg); + border-radius: 0 6px 6px 0; + /*margin-right: 5px;*/ } #nav-tree img { @@ -48,6 +43,7 @@ margin:0px; padding:0px; font: 12px var(--font-family-nav); + line-height: 22px; } #nav-tree .label a { @@ -56,7 +52,7 @@ #nav-tree .selected a { text-decoration:none; - color:var(--nav-text-active-color); + color:var(--page-link-color); } #nav-tree .children_ul { @@ -65,8 +61,9 @@ } #nav-tree .item { - margin:0px; - padding:0px; + margin: 0 6px 0 -5px; + padding: 0 0 0 5px; + height: 22px; } #nav-tree { @@ -89,7 +86,6 @@ display:block; position: absolute; left: 0px; - width: $width; overflow : hidden; } @@ -98,15 +94,31 @@ } .ui-resizable-e { - background-image:var(--nav-splitbar-image); - background-size:100%; - background-repeat:repeat-y; - background-attachment: scroll; - cursor:ew-resize; + transition: opacity 0.5s ease; + background-color: var(--nav-splitbar-bg-color); + opacity:0; + cursor:col-resize; height:100%; right:0; top:0; width:6px; + position: relative; +} + +.ui-resizable-e:after { + content: ''; + display: block; + top: 50%; + left: 1px; + width: 2px; + height: 15px; + border-left: 1px solid var(--nav-splitbar-handle-color); + border-right: 1px solid var(--nav-splitbar-handle-color); + position: absolute; +} + +.ui-resizable-e:hover { + opacity: 1; } .ui-resizable-handle { @@ -121,24 +133,97 @@ } #nav-tree { - background-repeat:repeat-x; background-color: var(--nav-background-color); -webkit-overflow-scrolling : touch; /* iOS 5+ */ + scrollbar-width: thin; + border-right: 1px solid var(--nav-border-color); + padding-left: 5px; } #nav-sync { position:absolute; - top:5px; - right:24px; - z-index:0; + top:0px; + right:0px; + z-index:1; } #nav-sync img { opacity:0.3; } -#nav-sync img:hover { - opacity:0.9; +div.nav-sync-icon { + position: relative; + width: 24px; + height: 17px; + left: -6px; + top: -1px; + opacity: 0.7; + display: inline-block; + background-color: var(--sync-icon-background-color); + border: 1px solid var(--sync-icon-border-color); + box-sizing: content-box; +} + +div.nav-sync-icon:hover { + background-color: var(--sync-icon-selected-background-color); + opacity: 1.0; +} + +div.nav-sync-icon.active:after { + content: ''; + background-color: var(--sync-icon-background-color); + border-top: 2px solid var(--sync-icon-color); + position: absolute; + width: 16px; + height: 0px; + top: 7px; + left: 4px; +} + +div.nav-sync-icon.active:hover:after { + border-top: 2px solid var(--sync-icon-selected-color); +} + +span.sync-icon-left { + position: absolute; + padding: 0; + margin: 0; + top: 3px; + left: 4px; + display: inline-block; + width: 8px; + height: 8px; + border-left: 2px solid var(--sync-icon-color); + border-top: 2px solid var(--sync-icon-color); + transform: rotate(-45deg); +} + +span.sync-icon-right { + position: absolute; + padding: 0; + margin: 0; + top: 3px; + left: 10px; + display: inline-block; + width: 8px; + height: 8px; + border-right: 2px solid var(--sync-icon-color); + border-bottom: 2px solid var(--sync-icon-color); + transform: rotate(-45deg); +} + +div.nav-sync-icon:hover span.sync-icon-left { + border-left: 2px solid var(--sync-icon-selected-color); + border-top: 2px solid var(--sync-icon-selected-color); +} + +div.nav-sync-icon:hover span.sync-icon-right { + border-right: 2px solid var(--sync-icon-selected-color); + border-bottom: 2px solid var(--sync-icon-selected-color); +} + +#nav-path ul { + border-top: 1px solid var(--nav-breadcrumb-separator-color); } @media print @@ -147,3 +232,96 @@ div.ui-resizable-handle { display: none; position: relative; } } +/*---------------------------*/ +#container { + display: grid; + grid-template-columns: auto auto; + overflow: hidden; +} + +#page-nav { + background: var(--nav-background-color); + display: block; + width: 250px; + box-sizing: content-box; + position: relative; + border-left: 1px solid var(--nav-border-color); +} + +#page-nav-tree { + display: inline-block; +} + +#page-nav-resize-handle { + transition: opacity 0.5s ease; + background-color: var(--nav-splitbar-bg-color); + opacity:0; + cursor:col-resize; + height:100%; + right:0; + top:0; + width:6px; + position: relative; + z-index: 1; + user-select: none; +} + +#page-nav-resize-handle:after { + content: ''; + display: block; + top: 50%; + left: 1px; + width: 2px; + height: 15px; + border-left: 1px solid var(--nav-splitbar-handle-color); + border-right: 1px solid var(--nav-splitbar-handle-color); + position: absolute; +} + +#page-nav-resize-handle.dragging, +#page-nav-resize-handle:hover { + opacity: 1; +} + +#page-nav-contents { + padding: 0; + margin: 0; + display: block; + top: 0; + left: 0; + height: 100%; + width: 100%; + position: absolute; + overflow: auto; + scrollbar-width: thin; + -webkit-overflow-scrolling : touch; /* iOS 5+ */ +} + +ul.page-outline, +ul.page-outline ul { + text-indent: 0; + list-style: none outside none; + padding: 0 0 0 4px; +} + +ul.page-outline { + margin: 0 4px 4px 6px; +} + +ul.page-outline div.item { + font: 12px var(--font-family-nav); + line-height: 22px; +} + +ul.page-outline li { + white-space: nowrap; +} + +ul.page-outline li.vis { + background-color: var(--nav-breadcrumb-active-bg); +} + +#container.resizing { + cursor: col-resize; + user-select: none; +} diff --git a/docs/html/optimal_allocation.html b/docs/html/optimal_allocation.html index 627471c..88f3e62 100644 --- a/docs/html/optimal_allocation.html +++ b/docs/html/optimal_allocation.html @@ -3,15 +3,13 @@ - +
-Generated by 1.13.2
+Generated by 1.14.0
D3D12 Memory Allocator: Optimal resource allocation - - @@ -33,33 +31,22 @@-+Optimal resource allocationOptimal resource allocationThis library tries to automatically make optimal choices for the resources you create, so you don't need to care about them. There are some advanced features of Direct3D 12 that you may use to optimize your memory management. There are also some settings in D3D12MA that you may change to alter its default behavior. This page provides miscellaneous advice about features of D3D12 and D3D12MA that are non-essential, but may improve the stability or performance of your app.
-+
Avoiding running out of memory
When trying to allocate more memory than available in the current heap (e.g., video memory on the graphics card, system memory), one of few bad things can happen:
-
-
Statistics of current memory usage and available budget for a specific memory segment group.Definition D3D12MemAlloc.h:474UINT64 BudgetBytesEstimated amount of memory available to the program.Definition D3D12MemAlloc.h:497-UINT64 UsageBytesEstimated current memory usage of the program.Definition D3D12MemAlloc.h:486When creating non-essential resources, you can use D3D12MA::ALLOCATION_FLAG_WITHIN_BUDGET. Then, in case the allocation would exceed the budget, the library will return failure from the function without attempting to allocate the actual D3D12 memory.
-It may also be a good idea to support failed resource creation. For non-essential resources, when function D3D12MA::Allocator::CreateResource fails with a result other than
-S_OK, it is worth implementing some way of recovery instead of terminating or crashing the entire app.+
It may also be a good idea to support failed resource creation. For non-essential resources, when function D3D12MA::Allocator::CreateResource fails with a result other than S_OK, it is worth implementing some way of recovery instead of terminating or crashing the entire app.
+Allocation performance
Creating D3D12 resources (buffers and textures) can be a time-consuming operation. The duration can be unpredictable, spanning from a small fraction of a millisecond to a significant fraction of a second. Thus, it is recommended to allocate all the memory and create all the resources needed upfront rather than doing it during application runtime. For example, a video game can try to create its resources on startup or when loading a new level. Of course, is is not always possible. For example, open-world games may require loading and unloading some graphical assets in the background (often called "streaming").
-Creating and releasing D3D12 resources on a separate thread in the background may help. Both
-ID3D12Deviceand D3D12MA::Allocator objects are thread-safe, synchronized internally. However, cases were observed where resource creation calls likeID3D12Device::CreateCommittedResourcewere blocking other D3D12 calls likeExecuteCommandListsorPresentsomewhere inside the graphics driver, so hitches can happen even when using multithreading.The most expensive part is typically the allocation of a new D3D12 memory heap. This library tackles this problem by automatically allocating large heaps (64 MB by default) and creating resources as placed inside of them. When a new requested resource can be placed in a free space of an existing heap and doesn't require allocating a new heap, this operation is typically much faster, as it only requires creating a new
-ID3D12Resourceobject and not allocating new memory. This is the main benefit of using D3D12MA compared to the naive approach of using Direct3D 12 directly and creating each resource as committed withCreateCommittedResource, which would result in a separate allocation of an implicit heap every time.When a large number of small buffers needs to be created, the overhead of creating even just separate
+ID3D12Resourceobjects can be significant. It can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs. This library can also help with it. See section "Sub-allocating buffers" below.Creating and releasing D3D12 resources on a separate thread in the background may help. Both ID3D12Device and D3D12MA::Allocator objects are thread-safe, synchronized internally. However, cases were observed where resource creation calls like ID3D12Device::CreateCommittedResource were blocking other D3D12 calls like ExecuteCommandLists or Present somewhere inside the graphics driver, so hitches can happen even when using multithreading.
+The most expensive part is typically the allocation of a new D3D12 memory heap. This library tackles this problem by automatically allocating large heaps (64 MB by default) and creating resources as placed inside of them. When a new requested resource can be placed in a free space of an existing heap and doesn't require allocating a new heap, this operation is typically much faster, as it only requires creating a new ID3D12Resource object and not allocating new memory. This is the main benefit of using D3D12MA compared to the naive approach of using Direct3D 12 directly and creating each resource as committed with CreateCommittedResource, which would result in a separate allocation of an implicit heap every time.
+When a large number of small buffers needs to be created, the overhead of creating even just separate ID3D12Resource objects can be significant. It can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs. This library can also help with it. See section "Sub-allocating buffers" below.
Another reason for the slowness of D3D12 memory allocation is the guarantee that the newly allocated memory is filled with zeros. When creating and destroying resources placed in an existing heap, this overhead is not present, and the memory is not zeroed - it may contain random data left by the resource previously allocated in that place. In recent versions of the DirectX 12 SDK, clearing the memory of the newly created D3D12 heaps can also be disabled for the improved performance. D3D12MA can use this feature when:
It is recommended to always use these flags. The downside is that when the memory is not filled with zeros, while you don't properly clear it or otherwise initialize its content before use (which is required by D3D12), you may observe incorrect behavior. This problem mostly affects render-target and depth-stencil textures.
When an allocation needs to be made in a performance-critical code, you can use D3D12MA::ALLOCATION_FLAG_STRATEGY_MIN_TIME. In influences multiple heuristics inside the library to prefer faster allocation at the expense of possibly less optimal placement in the memory.
If the resource to be created is non-essential, while the performance is paramount, you can also use D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE. It will create the resource only if it can be placed inside and existing memory heap and return failure from the function if a new heap would need to be allocated, which should guarantee good performance of such function call.
-+
Sub-allocating buffers
-When a large number of small buffers needs to be created, the overhead of creating separate
+ID3D12Resourceobjects can be significant. It can also cause a significant waste of memory, as placed buffers need to be aligned toD3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT= 64 KB by default. These problems can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs.When a large number of small buffers needs to be created, the overhead of creating separate ID3D12Resource objects can be significant. It can also cause a significant waste of memory, as placed buffers need to be aligned to D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB by default. These problems can be avoided by creating one or few larger buffers and manually sub-allocating parts of them for specific needs.
It requires implementing a custom allocator for the data inside the buffer and using offsets to individual regions. When all the regions can be allocated linearly and freed all at once, implementing such allocator is trivial. When every region has the same size, implementing an allocator is also quite simple when using a "free list" algorithm. However, when regions can have different sizes and can be allocated and freed in random order, it requires a full allocation algorithm. D3D12MA can help with it by exposing its core allocation algorithm for custom usages. For more details and example code, see chapter: Virtual allocator. It can be used for all the cases mentioned above without too much performance overhead, because the D3D12MA::VirtualAllocation object is just a lightweight handle.
-When sub-allocating a buffer, you need to remember to explicitly request proper alignment required for each region. For example, data used as a constant buffer must be aligned to
-D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT= 256 B.+
When sub-allocating a buffer, you need to remember to explicitly request proper alignment required for each region. For example, data used as a constant buffer must be aligned to D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT = 256 B.
+Residency priority
When too much video memory is allocated, one of the things that can happen is the system demoting some heaps to the system memory. Moving data between memory pools or reaching out directly to the system memory through PCI Express bus can have large performance overhead, which can slow down the application, or even make the game unplayable any more. Unfortunately, it is not possible to fully control or prevent this demotion. Best thing to do is avoiding memory over-commitment. For more information, see section "Avoiding running out of memory" above.
-Recent versions of DirectX 12 SDK offer function
+ID3D12Device1::SetResidencyPrioritythat sets a hint about the priority of a resource - how important it is to stay resident in the video memory. Setting the priority happens at the level of an entire memory heap. D3D12MA offers an interface to set this priority in form of D3D12MA::POOL_DESC::ResidencyPriority parameter. It affects all allocations made out of the custom pool created with it, both placed inside large heaps and created as committed.Recent versions of DirectX 12 SDK offer function ID3D12Device1::SetResidencyPriority that sets a hint about the priority of a resource - how important it is to stay resident in the video memory. Setting the priority happens at the level of an entire memory heap. D3D12MA offers an interface to set this priority in form of D3D12MA::POOL_DESC::ResidencyPriority parameter. It affects all allocations made out of the custom pool created with it, both placed inside large heaps and created as committed.
It is recommended to create a custom pool for the purpose of using high residency priority of all resources that are critical for the performance, especially those that are written by the GPU, like render-target, depth-stencil textures, UAV textures and buffers. It is also worth creating them as committed, so that each one will have its own implicit heap. This can minimize the chance that an entire large heap is demoted to system memory, degrading performance of all the resources placed in it.
Example:
D3D12MA::CPOOL_DESC poolDesc = D3D12MA::CPOOL_DESC{@@ -175,14 +162,14 @@D3D12_RESIDENCY_PRIORITY priority = D3D12_RESIDENCY_PRIORITY_HIGH;device1->SetResidencyPriority(1, &res, &priority);-ID3D12Resource * GetResource() constReturns D3D12 resource associated with this object.Definition D3D12MemAlloc.h:552Note this is not the same as explicit eviction controlled using
-ID3D12Device::EvictandMakeResidentfunctions. Resources evicted explicitly are illegal to access until they are made resident again, while the demotion described here happens automatically and only slows down the execution.+
Note this is not the same as explicit eviction controlled using ID3D12Device::Evict and MakeResident functions. Resources evicted explicitly are illegal to access until they are made resident again, while the demotion described here happens automatically and only slows down the execution.
+GPU upload heap
Direct3D 12 offers a fixed set of memory heap types:
-
-
Note that in systems with a discrete graphics card, access to system memory is fast from the CPU code (like the C++ code mapping D3D12 buffers and accessing them through a pointer), while access to the video memory is fast from the GPU code (like shaders reading and writing buffers and textures). Any copy operation or direct access between these memory heap types happens through PCI Express bus, which can be relatively slow.
Modern systems offer a feature called Resizable BAR (ReBAR) that gives the CPU direct access to the full video memory. To be available, this feature needs to be supported by the whole hardware-software environment, including:
@@ -192,20 +179,20 @@Recent versions of DirectX 12 SDK give access to this feature in form of a new, 4th memory pool:
+D3D12_HEAP_TYPE_GPU_UPLOAD. Resources created in it behave logically similar to theD3D12_HEAP_TYPE_UPLOADheap:Recent versions of DirectX 12 SDK give access to this feature in form of a new, 4th memory pool: D3D12_HEAP_TYPE_GPU_UPLOAD. Resources created in it behave logically similar to the D3D12_HEAP_TYPE_UPLOAD heap:
The main difference is that resources created in the new
+D3D12_HEAP_TYPE_GPU_UPLOADare placed in the video memory, while resources created in the oldD3D12_HEAP_TYPE_UPLOADare placed in the system memory. This implies which budgets are consumed by new resources allocated in those heaps. This also implies which operations involve transferring data through the PCI Express bus.The main difference is that resources created in the new D3D12_HEAP_TYPE_GPU_UPLOAD are placed in the video memory, while resources created in the old D3D12_HEAP_TYPE_UPLOAD are placed in the system memory. This implies which budgets are consumed by new resources allocated in those heaps. This also implies which operations involve transferring data through the PCI Express bus.
-
-
GPU Upload Heap can be used for performance optimization of some resources that need to be written by the CPU and read by the GPU. It can be beneficial especially for resources that need to change frequently (often called "dynamic").
-D3D12MA supports GPU upload heap when recent enough version of DirectX 12 SDK is used and when the current system supports it. The support can be queried using function D3D12MA::Allocator::IsGPUUploadHeapSupported(). When it returns
+TRUE, you can create resources usingD3D12_HEAP_TYPE_GPU_UPLOAD. You can also just try creating such resource. Example:D3D12MA supports GPU upload heap when recent enough version of DirectX 12 SDK is used and when the current system supports it. The support can be queried using function D3D12MA::Allocator::IsGPUUploadHeapSupported(). When it returns TRUE, you can create resources using D3D12_HEAP_TYPE_GPU_UPLOAD. You can also just try creating such resource. Example:
D3D12MA::CALLOCATION_DESC allocDesc = D3D12MA::CALLOCATION_DESC{D3D12_HEAP_TYPE_GPU_UPLOAD }; // !!!@@ -240,13 +227,13 @@else// Some other error code e.g., out of memory...-D3D12_HEAP_TYPE HeapTypeThe type of memory heap where the new allocation should be placed.Definition D3D12MemAlloc.h:347+
Committed versus placed resources
When using D3D12 API directly, there are 3 ways of creating resources:
-
-
A naive solution would be to create all the resources as committed. It works, because in D3D12 there is no strict limit on the number of resources or heaps that can be created. However, there are certain advantages and disadvantages of using committed versus placed resources:
- The advantage of committed resources is that they are always created with a new heap, which is initialized with zeros. When a resource is created as placed, the memory may contain random data left by the resource previously allocated in that place. When the memory is not filled with zeros, while you don't properly clear it or otherwise initialize its content before use (which is required by D3D12), you may observe incorrect behavior. On the other hand, using committed resources and having every new resource filled with zeros can leave this kind of bugs undetected. -
- Manual eviction with
ID3D12Device::EvictandMakeResidentfunctions work at the level of the entire heap, and so doesID3D12Device1::SetResidencyPriority, so creating resources as committed allows more fine-grained control over the eviction and residency priority of individual resources.
+ - Manual eviction with ID3D12Device::Evict and MakeResident functions work at the level of the entire heap, and so does ID3D12Device1::SetResidencyPriority, so creating resources as committed allows more fine-grained control over the eviction and residency priority of individual resources.
- The advantage of placed resources is that they can be created in a region of a heap overlapping with some other resources. This approach is commonly called "aliasing". It can save memory, but it needs careful control over the resources that overlap in memory to make sure they are not used at the same time, there is an aliasing barrier issued between their usage, and the resource used after aliasing is correctly cleared every time. Committed resources don't offer this possibility, because every committed resource has its own exclusive memory heap. For more information, see chapter Resource aliasing (overlap).
When creating resources with the help of D3D12MA using function D3D12MA::Allocator::CreateResource, you typically don't need to care about all this. The library automatically makes the choice of creating the new resource as committed or placed. However, in cases when you need the information or the control over this choice between committed and placed, the library offers facilities to do that, described below.
@@ -303,18 +290,18 @@
UINT64 BlockSizeSize of a single heap (memory block) to be allocated as part of this pool, in bytes....Definition D3D12MemAlloc.h:933
You can request a new resource to be created as placed by using D3D12MA::ALLOCATION_FLAG_CAN_ALIAS. This is required especially if you plan to create another resource in the same region of memory, aliasing with your resource - hence the name of this flag.
Note D3D12MA::ALLOCATION_FLAG_CAN_ALIAS can be even combined with D3D12MA::ALLOCATION_FLAG_COMMITTED. In this case, the resource is not created as committed, but it is also not placed as part of a larger heap. What happens instead is that a new heap is created with the exact size required for the resource, and the resource is created in it, placed at offset 0.
-
+
Resource alignment
Certain types of resources require certain alignment in memory. An alignment is a requirement for the address or offset to the beginning of the resource to be a multiply of some value, which is always a power of 2. For committed resources, the problem is non-existent, because committed resources have their own implicit heaps where they are created at offset 0, which meets any alignment requirement. For placed resources, D3D12MA takes care of the alignment automatically.
-- Implementation detail
- Default alignment required MSAA textures is
D3D12_DEFAULT_MSAA_RESOURCE_PLACEMENT_ALIGNMENT= 4 MB. Default alignment required for buffers and other textures isD3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT= 64 KB.
- Implementation detail
- Default alignment required MSAA textures is D3D12_DEFAULT_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 4 MB. Default alignment required for buffers and other textures is D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB.
Because the alignment required for buffers is 64 KB, small buffers can waste a lot of memory in between when created as placed. When such small buffers are created as committed, some graphics drivers are able to pack them better. D3D12MA automatically takes advantage of this by preferring to create small buffers as committed. This heuristics is enabled by default. It is also a tradeoff - it can make the allocation of these buffers slower. It can be disabled for an individual resource by using D3D12MA::ALLOCATION_FLAG_STRATEGY_MIN_TIME and for the entire allocator by using D3D12MA::ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED.
-For certain textures that meet a complex set of requirements, special "small alignment" can be applied. Details can be found in Microsoft documentation of the D3D12_RESOURCE_DESC structure. For MSAA textures, the small alignment is D3D12_SMALL_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB. For other textures, the small alignment is D3D12_SMALL_RESOURCE_PLACEMENT_ALIGNMENT = 4 KB. D3D12MA uses this feature automatically. Detailed behavior can be disabled or controlled by predefining macro D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT.
D3D12 also has a concept of alignment of the entire heap, passed through D3D12_HEAP_DESC::Alignment. This library automatically sets the alignment as small as possible. Unfortunately, any heap that has a chance of hosting an MSAA texture needs to have the alignment set to 4 MB. This problem can be overcome by passing D3D12MA::ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of the main allocator object and D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of any custom heap that supports textures, not only buffers. With those flags, the alignment of the heaps created by D3D12MA can be lower, but any MSAA textures are created as committed. You should always use these flags in your code unless you really need to create some MSAA textures as placed.
For certain textures that meet a complex set of requirements, special "small alignment" can be applied. Details can be found in Microsoft documentation of the D3D12_RESOURCE_DESC structure. For MSAA textures, the small alignment is D3D12_SMALL_MSAA_RESOURCE_PLACEMENT_ALIGNMENT = 64 KB. For other textures, the small alignment is D3D12_SMALL_RESOURCE_PLACEMENT_ALIGNMENT = 4 KB. D3D12MA uses this feature automatically. Detailed behavior can be disabled or controlled by predefining macro D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT.
+D3D12 also has a concept of alignment of the entire heap, passed through D3D12_HEAP_DESC::Alignment. This library automatically sets the alignment as small as possible. Unfortunately, any heap that has a chance of hosting an MSAA texture needs to have the alignment set to 4 MB. This problem can be overcome by passing D3D12MA::ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of the main allocator object and D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of any custom heap that supports textures, not only buffers. With those flags, the alignment of the heaps created by D3D12MA can be lower, but any MSAA textures are created as committed. You should always use these flags in your code unless you really need to create some MSAA textures as placed.
-Generated by
1.13.2
+Generated by 1.14.0
diff --git a/docs/html/quick_start.html b/docs/html/quick_start.html
index f9219d2..4eba7e6 100644
--- a/docs/html/quick_start.html
+++ b/docs/html/quick_start.html
@@ -3,15 +3,13 @@
-
+
+
Project setup and initialization
This is a small, standalone C++ library. It consists of 2 files: "D3D12MemAlloc.h" header file with public interface and "D3D12MemAlloc.cpp" with internal implementation. The only external dependencies are WinAPI, Direct3D 12, and parts of C/C++ standard library (but STL containers, exceptions, or RTTI are not used).
The library is developed and tested using Microsoft Visual Studio 2022, but it should work with other compilers as well. It is designed for 64-bit code.
To use the library in your project:
-(1.) Copy files D3D12MemAlloc.cpp, D3D12MemAlloc.h to your project.
-(2.) Make D3D12MemAlloc.cpp compiling as part of the project, as C++ code.
+(1.) Copy files D3D12MemAlloc.cpp, D3D12MemAlloc.h to your project.
+(2.) Make D3D12MemAlloc.cpp compiling as part of the project, as C++ code.
(3.) Include library header in each CPP file that needs to use the library.
#include "D3D12MemAlloc.h"
-(4.) Right after you created ID3D12Device, fill D3D12MA::ALLOCATOR_DESC structure and call function D3D12MA::CreateAllocator to create the main D3D12MA::Allocator object.
+
Project setup and initialization
This is a small, standalone C++ library. It consists of 2 files: "D3D12MemAlloc.h" header file with public interface and "D3D12MemAlloc.cpp" with internal implementation. The only external dependencies are WinAPI, Direct3D 12, and parts of C/C++ standard library (but STL containers, exceptions, or RTTI are not used).
The library is developed and tested using Microsoft Visual Studio 2022, but it should work with other compilers as well. It is designed for 64-bit code.
To use the library in your project:
-(1.) Copy files D3D12MemAlloc.cpp, D3D12MemAlloc.h to your project.
(2.) Make D3D12MemAlloc.cpp compiling as part of the project, as C++ code.
(1.) Copy files D3D12MemAlloc.cpp, D3D12MemAlloc.h to your project.
+(2.) Make D3D12MemAlloc.cpp compiling as part of the project, as C++ code.
(3.) Include library header in each CPP file that needs to use the library.
(4.) Right after you created ID3D12Device, fill D3D12MA::ALLOCATOR_DESC structure and call function D3D12MA::CreateAllocator to create the main D3D12MA::Allocator object.
(4.) Right after you created ID3D12Device, fill D3D12MA::ALLOCATOR_DESC structure and call function D3D12MA::CreateAllocator to create the main D3D12MA::Allocator object.
Please note that all symbols of the library are declared inside D3D12MA namespace.
(5.) Right before destroying the D3D12 device, destroy the allocator object.
Objects of this library must be destroyed by calling Release method. They are somewhat compatible with COM: they implement IUnknown interface with its virtual methods: AddRef, Release, QueryInterface, and they are reference-counted internally. You can use smart pointers designed for COM with objects of this library - e.g. CComPtr or Microsoft::WRL::ComPtr. The reference counter is thread-safe. QueryInterface method supports only IUnknown, as classes of this library don't define their own GUIDs.
+
Objects of this library must be destroyed by calling Release method. They are somewhat compatible with COM: they implement IUnknown interface with its virtual methods: AddRef, Release, QueryInterface, and they are reference-counted internally. You can use smart pointers designed for COM with objects of this library - e.g. CComPtr or Microsoft::WRL::ComPtr. The reference counter is thread-safe. QueryInterface method supports only IUnknown, as classes of this library don't define their own GUIDs.
+Creating resources
-To use the library for creating resources (textures and buffers), call method D3D12MA::Allocator::CreateResource in the place where you would previously call ID3D12Device::CreateCommittedResource.
The function has similar syntax, but it expects structure D3D12MA::ALLOCATION_DESC to be passed along with D3D12_RESOURCE_DESC and other parameters for created resource. This structure describes parameters of the desired memory allocation, including choice of D3D12_HEAP_TYPE.
The function returns a new object of type D3D12MA::Allocation. It represents allocated memory and can be queried for size, offset, ID3D12Heap. It also holds a reference to the ID3D12Resource, which can be accessed by calling D3D12MA::Allocation::GetResource().
To use the library for creating resources (textures and buffers), call method D3D12MA::Allocator::CreateResource in the place where you would previously call ID3D12Device::CreateCommittedResource.
+The function has similar syntax, but it expects structure D3D12MA::ALLOCATION_DESC to be passed along with D3D12_RESOURCE_DESC and other parameters for created resource. This structure describes parameters of the desired memory allocation, including choice of D3D12_HEAP_TYPE.
+The function returns a new object of type D3D12MA::Allocation. It represents allocated memory and can be queried for size, offset, ID3D12Heap. It also holds a reference to the ID3D12Resource, which can be accessed by calling D3D12MA::Allocation::GetResource().
D3D12_HEAP_TYPE HeapTypeThe type of memory heap where the new allocation should be placed.Definition D3D12MemAlloc.h:347
You need to release the allocation object when no longer needed. This will also release the D3D12 resource.
The advantage of using the allocator instead of creating committed resource, and the main purpose of this library, is that it can decide to allocate bigger memory heap internally using ID3D12Device::CreateHeap and place multiple resources in it, at different offsets, using ID3D12Device::CreatePlacedResource. The library manages its own collection of allocated memory blocks (heaps) and remembers which parts of them are occupied and which parts are free to be used for new resources.
It is important to remember that resources created as placed don't have their memory initialized to zeros, but may contain garbage data, so they need to be fully initialized before usage, e.g. using Clear (ClearRenderTargetView), Discard (DiscardResource), or Copy (CopyResource).
The library also automatically handles resource heap tier. When D3D12_FEATURE_DATA_D3D12_OPTIONS::ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1, resources of 3 types: buffers, textures that are render targets or depth-stencil, and other textures must be kept in separate heaps. When D3D12_RESOURCE_HEAP_TIER_2, they can be kept together. By using this library, you don't need to handle this manually.
+
The advantage of using the allocator instead of creating committed resource, and the main purpose of this library, is that it can decide to allocate bigger memory heap internally using ID3D12Device::CreateHeap and place multiple resources in it, at different offsets, using ID3D12Device::CreatePlacedResource. The library manages its own collection of allocated memory blocks (heaps) and remembers which parts of them are occupied and which parts are free to be used for new resources.
+It is important to remember that resources created as placed don't have their memory initialized to zeros, but may contain garbage data, so they need to be fully initialized before usage, e.g. using Clear (ClearRenderTargetView), Discard (DiscardResource), or Copy (CopyResource).
+The library also automatically handles resource heap tier. When D3D12_FEATURE_DATA_D3D12_OPTIONS::ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1, resources of 3 types: buffers, textures that are render targets or depth-stencil, and other textures must be kept in separate heaps. When D3D12_RESOURCE_HEAP_TIER_2, they can be kept together. By using this library, you don't need to handle this manually.
+Resource reference counting
-ID3D12Resource and other interfaces of Direct3D 12 use COM, so they are reference-counted. Objects of this library are reference-counted as well. An object of type D3D12MA::Allocation remembers the resource (buffer or texture) that was created together with this memory allocation and holds a reference to the ID3D12Resource object. (Note this is a difference to Vulkan Memory Allocator, where a VmaAllocation object has no connection with the buffer or image that was created with it.) Thus, it is important to manage the resource reference counter properly.
The simplest use case is shown in the code snippet above. When only D3D12MA::Allocation object is obtained from a function call like D3D12MA::Allocator::CreateResource, it remembers the ID3D12Resource that was created with it and holds a reference to it. The resource can be obtained by calling allocation->GetResource(), which doesn't increment the resource reference counter. Calling allocation->Release() will decrease the resource reference counter, which is 1 in this case, so the resource will be released.
ID3D12Resource and other interfaces of Direct3D 12 use COM, so they are reference-counted. Objects of this library are reference-counted as well. An object of type D3D12MA::Allocation remembers the resource (buffer or texture) that was created together with this memory allocation and holds a reference to the ID3D12Resource object. (Note this is a difference to Vulkan Memory Allocator, where a VmaAllocation object has no connection with the buffer or image that was created with it.) Thus, it is important to manage the resource reference counter properly.
+The simplest use case is shown in the code snippet above. When only D3D12MA::Allocation object is obtained from a function call like D3D12MA::Allocator::CreateResource, it remembers the ID3D12Resource that was created with it and holds a reference to it. The resource can be obtained by calling allocation->GetResource(), which doesn't increment the resource reference counter. Calling allocation->Release() will decrease the resource reference counter, which is 1 in this case, so the resource will be released.
Second option is to retrieve a pointer to the resource along with D3D12MA::Allocation. Last parameters of the resource creation function can be used for this purpose.
IID_PPV_ARGS(&resource));
// Use resource...
-
In this case, returned pointer resource is equal to allocation->GetResource(), but the creation function additionally increases resource reference counter for the purpose of returning it from this call (it actually calls QueryInterface internally), so the resource will have the counter = 2. The resource then need to be released along with the allocation, in this particular order, to make sure the resource is destroyed before its memory heap can potentially be freed.
In this case, returned pointer resource is equal to allocation->GetResource(), but the creation function additionally increases resource reference counter for the purpose of returning it from this call (it actually calls QueryInterface internally), so the resource will have the counter = 2. The resource then need to be released along with the allocation, in this particular order, to make sure the resource is destroyed before its memory heap can potentially be freed.
More advanced use cases are possible when we consider that an D3D12MA::Allocation object can just hold a reference to any resource. It can be changed by calling D3D12MA::Allocation::SetResource. This function releases the old resource and calls AddRef on the new one.
Special care must be taken when performing defragmentation. The new resource created at the destination place should be set as pass.pMoves[i].pDstTmpAllocation->SetResource(newRes), but it is moved to the source allocation at end of the defragmentation pass, while the old resource accessible through pass.pMoves[i].pSrcAllocation->GetResource() is then released. For more information, see documentation chapter Defragmentation.
+
More advanced use cases are possible when we consider that an D3D12MA::Allocation object can just hold a reference to any resource. It can be changed by calling D3D12MA::Allocation::SetResource. This function releases the old resource and calls AddRef on the new one.
+Special care must be taken when performing defragmentation. The new resource created at the destination place should be set as pass.pMoves[i].pDstTmpAllocation->SetResource(newRes), but it is moved to the source allocation at end of the defragmentation pass, while the old resource accessible through pass.pMoves[i].pSrcAllocation->GetResource() is then released. For more information, see documentation chapter Defragmentation.
+Mapping memory
-The process of getting regular CPU-side pointer to the memory of a resource in Direct3D is called "mapping". There are rules and restrictions to this process, as described in D3D12 documentation of ID3D12Resource::Map method.
Mapping happens on the level of particular resources, not entire memory heaps, and so it is out of scope of this library. Just as the documentation of the Map function says:
The process of getting regular CPU-side pointer to the memory of a resource in Direct3D is called "mapping". There are rules and restrictions to this process, as described in D3D12 documentation of ID3D12Resource::Map method.
+Mapping happens on the level of particular resources, not entire memory heaps, and so it is out of scope of this library. Just as the documentation of the Map function says:
- Returned pointer refers to data of particular subresource, not entire memory heap.
- You can map same resource multiple times. It is ref-counted internally. @@ -196,7 +183,7 @@
- Unmapping may not be required before using written data - some heap types on some platforms support resources persistently mapped.
When using this library, you can map and use your resources normally without considering whether they are created as committed resources or placed resources in one large heap.
-Example for buffer created and filled in UPLOAD heap type:
Example for buffer created and filled in UPLOAD heap type:
memcpy(mappedPtr, bufData, bufSize);
resource->Unmap(0, NULL);
-
+
Helper structures
-
DirectX 12 Agility SDK offers a library of helpers in files "build\native\include\d3dx12\*.h". They include structures that help with complete and concise initialization of the core D3D12 *_DESC structures by using some basic C++ features (constructors, static methods, default parameters). They inherit from these structures, so they support implicit casting to them. For example, structure CD3DX12_RESOURCE_DESC can be used to conveniently fill in structure D3D12_RESOURCE_DESC.
Similarly, this library provides a set of helper structures that aid in initialization of some of the *_DESC structures defined in the library. These are:
DirectX 12 Agility SDK offers a library of helpers in files "build\native\include\d3dx12\*.h". They include structures that help with complete and concise initialization of the core D3D12 *_DESC structures by using some basic C++ features (constructors, static methods, default parameters). They inherit from these structures, so they support implicit casting to them. For example, structure CD3DX12_RESOURCE_DESC can be used to conveniently fill in structure D3D12_RESOURCE_DESC.
+Similarly, this library provides a set of helper structures that aid in initialization of some of the *_DESC structures defined in the library. These are:
- D3D12MA::CALLOCATION_DESC, which inherits from D3D12MA::ALLOCATION_DESC.
- D3D12MA::CPOOL_DESC, which inherits from D3D12MA::POOL_DESC.
- D3D12MA::CVIRTUAL_BLOCK_DESC, which inherits from D3D12MA::VIRTUAL_BLOCK_DESC.
- D3D12MA::CVIRTUAL_ALLOCATION_DESC, which inherits from D3D12MA::VIRTUAL_ALLOCATION_DESC.
For example, when you want to create a buffer in the UPLAOD heap using minimal allocation time, you can use base structures:
For example, when you want to create a buffer in the UPLAOD heap using minimal allocation time, you can use base structures:
-Generated by
1.13.2
+Generated by 1.14.0
diff --git a/docs/html/resource_aliasing.html b/docs/html/resource_aliasing.html
index c89a007..1275544 100644
--- a/docs/html/resource_aliasing.html
+++ b/docs/html/resource_aliasing.html
@@ -3,15 +3,13 @@
-
+
New explicit graphics APIs (Vulkan and Direct3D 12), thanks to manual memory management, give an opportunity to alias (overlap) multiple resources in the same region of memory - a feature not available in the old APIs (Direct3D 11, OpenGL). It can be useful to save video memory, but it must be used with caution.
@@ -171,18 +158,18 @@Remember that using resouces that alias in memory requires proper synchronization. You need to issue a special barrier of type D3D12_RESOURCE_BARRIER_TYPE_ALIASING. You also need to treat a resource after aliasing as uninitialized - containing garbage data. For example, if you use res1 and then want to use res2, you need to first initialize res2 using either Clear, Discard, or Copy to the entire resource.
Remember that using resouces that alias in memory requires proper synchronization. You need to issue a special barrier of type D3D12_RESOURCE_BARRIER_TYPE_ALIASING. You also need to treat a resource after aliasing as uninitialized - containing garbage data. For example, if you use res1 and then want to use res2, you need to first initialize res2 using either Clear, Discard, or Copy to the entire resource.
Additional considerations:
- D3D12 also allows to interpret contents of memory between aliasing resources consistently in some cases, which is called "data inheritance". For details, see Microsoft documentation chapter "Memory Aliasing and Data Inheritance". -
- You can create more complex layout where different textures and buffers are bound at different offsets inside one large allocation. For example, one can imagine a big texture used in some render passes, aliasing with a set of many small buffers used in some further passes. To bind a resource at non-zero offset of an allocation, call D3D12MA::Allocator::CreateAliasingResource with appropriate value of
AllocationLocalOffsetparameter.
- - Resources of the three categories: buffers, textures with
RENDER_TARGETorDEPTH_STENCILflags, and all other textures, can be placed in the same memory only whenallocator->GetD3D12Options().ResourceHeapTier >= D3D12_RESOURCE_HEAP_TIER_2. Otherwise they must be placed in different memory heap types, and thus aliasing them is not possible.
+ - You can create more complex layout where different textures and buffers are bound at different offsets inside one large allocation. For example, one can imagine a big texture used in some render passes, aliasing with a set of many small buffers used in some further passes. To bind a resource at non-zero offset of an allocation, call D3D12MA::Allocator::CreateAliasingResource with appropriate value of AllocationLocalOffset parameter. +
- Resources of the three categories: buffers, textures with RENDER_TARGET or DEPTH_STENCIL flags, and all other textures, can be placed in the same memory only when allocator->GetD3D12Options().ResourceHeapTier >= D3D12_RESOURCE_HEAP_TIER_2. Otherwise they must be placed in different memory heap types, and thus aliasing them is not possible.
-Generated by
1.13.2
+Generated by 1.14.0
diff --git a/docs/html/search/pages_0.js b/docs/html/search/pages_0.js
index 6c4bc1e..4e13aaf 100644
--- a/docs/html/search/pages_0.js
+++ b/docs/html/search/pages_0.js
@@ -1,10 +1,23 @@
var searchData=
[
- ['algorithm_0',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
- ['aliasing_20overlap_1',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
- ['allocation_2',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
- ['allocation_20algorithm_3',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
- ['allocator_4',['D3D12 Memory Allocator',['../index.html',1,'']]],
- ['allocator_5',['Virtual allocator',['../virtual_allocator.html',1,'optimal_allocation']]],
- ['asked_20questions_6',['Frequently asked questions',['../faq.html',1,'index']]]
+ ['additional_20considerations_0',['Additional considerations',['../linear_algorithm.html#linear_algorithm_additional_considerations',1,'Additional considerations'],['../virtual_allocator.html#virtual_allocator_additional_considerations',1,'Additional considerations']]],
+ ['algorithm_1',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
+ ['aliasing_20overlap_2',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
+ ['alignment_3',['Resource alignment',['../optimal_allocation.html#optimal_allocation_resource_alignment',1,'']]],
+ ['alignment_20and_20units_4',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]],
+ ['allocating_20buffers_5',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]],
+ ['allocation_6',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
+ ['allocation_20algorithm_7',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
+ ['allocation_20parameters_8',['Allocation parameters',['../virtual_allocator.html#virtual_allocator_allocation_parameters',1,'']]],
+ ['allocation_20performance_9',['Allocation performance',['../optimal_allocation.html#optimal_allocation_allocation_Performance',1,'']]],
+ ['allocations_10',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]],
+ ['allocator_11',['D3D12 Memory Allocator',['../index.html',1,'']]],
+ ['allocator_12',['allocator',['../configuration.html#custom_memory_allocator',1,'Custom CPU memory allocator'],['../virtual_allocator.html',1,'Virtual allocator']]],
+ ['and_20benefits_13',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]],
+ ['and_20compatibility_14',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]],
+ ['and_20initialization_15',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]],
+ ['and_20units_16',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]],
+ ['asked_20questions_17',['Frequently asked questions',['../faq.html',1,'index']]],
+ ['at_20once_18',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]],
+ ['avoiding_20running_20out_20of_20memory_19',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]]
];
diff --git a/docs/html/search/pages_1.js b/docs/html/search/pages_1.js
index 91cb574..d34b057 100644
--- a/docs/html/search/pages_1.js
+++ b/docs/html/search/pages_1.js
@@ -1,6 +1,7 @@
var searchData=
[
- ['configuration_0',['Configuration',['../configuration.html',1,'index']]],
- ['considerations_1',['General considerations',['../general_considerations.html',1,'index']]],
- ['custom_20memory_20pools_2',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
+ ['benefits_0',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]],
+ ['block_1',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]],
+ ['buffer_2',['Ring buffer',['../linear_algorithm.html#linear_algorithm_ring_buffer',1,'']]],
+ ['buffers_3',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]]
];
diff --git a/docs/html/search/pages_10.js b/docs/html/search/pages_10.js
new file mode 100644
index 0000000..af3b029
--- /dev/null
+++ b/docs/html/search/pages_10.js
@@ -0,0 +1,13 @@
+var searchData=
+[
+ ['safety_0',['Thread safety',['../general_considerations.html#general_considerations_thread_safety',1,'']]],
+ ['setup_20and_20initialization_1',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]],
+ ['stack_2',['Stack',['../linear_algorithm.html#linear_algorithm_stack',1,'']]],
+ ['stack_3',['Double stack',['../linear_algorithm.html#linear_algorithm_double_stack',1,'']]],
+ ['start_4',['Quick start',['../quick_start.html',1,'index']]],
+ ['statistics_5',['Statistics',['../statistics.html',1,'Statistics'],['../virtual_allocator.html#virtual_allocator_statistics',1,'Statistics']]],
+ ['statistics_6',['Numeric statistics',['../statistics.html#statistics_numeric_statistics',1,'']]],
+ ['structures_7',['Helper structures',['../quick_start.html#quick_start_helper_structures',1,'']]],
+ ['sub_20allocating_20buffers_8',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]],
+ ['supported_9',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]]
+];
diff --git a/docs/html/search/pages_11.js b/docs/html/search/pages_11.js
new file mode 100644
index 0000000..ce665b6
--- /dev/null
+++ b/docs/html/search/pages_11.js
@@ -0,0 +1,5 @@
+var searchData=
+[
+ ['table_20of_20contents_0',['Table of contents',['../index.html#main_table_of_contents',1,'']]],
+ ['thread_20safety_1',['Thread safety',['../general_considerations.html#general_considerations_thread_safety',1,'']]]
+];
diff --git a/docs/html/search/pages_12.js b/docs/html/search/pages_12.js
new file mode 100644
index 0000000..32f0ad5
--- /dev/null
+++ b/docs/html/search/pages_12.js
@@ -0,0 +1,6 @@
+var searchData=
+[
+ ['units_0',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]],
+ ['upload_20heap_1',['GPU upload heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'']]],
+ ['usage_2',['Usage',['../custom_pools.html#custom_pools_usage',1,'']]]
+];
diff --git a/docs/html/search/pages_13.js b/docs/html/search/pages_13.js
new file mode 100644
index 0000000..aa04e5d
--- /dev/null
+++ b/docs/html/search/pages_13.js
@@ -0,0 +1,8 @@
+var searchData=
+[
+ ['versioning_20and_20compatibility_0',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]],
+ ['versus_20placed_20resources_1',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]],
+ ['virtual_20allocations_2',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]],
+ ['virtual_20allocator_3',['Virtual allocator',['../virtual_allocator.html',1,'optimal_allocation']]],
+ ['virtual_20block_4',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]]
+];
diff --git a/docs/html/search/pages_14.js b/docs/html/search/pages_14.js
new file mode 100644
index 0000000..8225a92
--- /dev/null
+++ b/docs/html/search/pages_14.js
@@ -0,0 +1,4 @@
+var searchData=
+[
+ ['web_20links_0',['Web links',['../index.html#main_see_also',1,'']]]
+];
diff --git a/docs/html/search/pages_2.js b/docs/html/search/pages_2.js
index 8aa1a38..7553f75 100644
--- a/docs/html/search/pages_2.js
+++ b/docs/html/search/pages_2.js
@@ -1,5 +1,14 @@
var searchData=
[
- ['d3d12_20memory_20allocator_0',['D3D12 Memory Allocator',['../index.html',1,'']]],
- ['defragmentation_1',['Defragmentation',['../defragmentation.html',1,'optimal_allocation']]]
+ ['committed_20versus_20placed_20resources_0',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]],
+ ['compatibility_1',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]],
+ ['configuration_2',['Configuration',['../configuration.html',1,'index']]],
+ ['considerations_3',['considerations',['../linear_algorithm.html#linear_algorithm_additional_considerations',1,'Additional considerations'],['../virtual_allocator.html#virtual_allocator_additional_considerations',1,'Additional considerations'],['../general_considerations.html',1,'General considerations']]],
+ ['contents_4',['Table of contents',['../index.html#main_table_of_contents',1,'']]],
+ ['counting_5',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]],
+ ['cpu_20memory_20allocator_6',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]],
+ ['creating_20resources_7',['Creating resources',['../quick_start.html#quick_start_creating_resources',1,'']]],
+ ['creating_20virtual_20block_8',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]],
+ ['custom_20cpu_20memory_20allocator_9',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]],
+ ['custom_20memory_20pools_10',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
];
diff --git a/docs/html/search/pages_3.js b/docs/html/search/pages_3.js
index 842b2bb..89d174b 100644
--- a/docs/html/search/pages_3.js
+++ b/docs/html/search/pages_3.js
@@ -1,4 +1,9 @@
var searchData=
[
- ['frequently_20asked_20questions_0',['Frequently asked questions',['../faq.html',1,'index']]]
+ ['d3d12_20memory_20allocator_0',['D3D12 Memory Allocator',['../index.html',1,'']]],
+ ['deallocation_1',['Deallocation',['../virtual_allocator.html#virtual_allocator_deallocation',1,'']]],
+ ['debug_20margins_2',['Debug margins',['../configuration.html#debug_margins',1,'']]],
+ ['defragmentation_3',['Defragmentation',['../defragmentation.html',1,'optimal_allocation']]],
+ ['double_20stack_4',['Double stack',['../linear_algorithm.html#linear_algorithm_double_stack',1,'']]],
+ ['dump_5',['JSON dump',['../statistics.html#statistics_json_dump',1,'']]]
];
diff --git a/docs/html/search/pages_4.js b/docs/html/search/pages_4.js
index 1aed57d..6f9860c 100644
--- a/docs/html/search/pages_4.js
+++ b/docs/html/search/pages_4.js
@@ -1,4 +1,7 @@
var searchData=
[
- ['general_20considerations_0',['General considerations',['../general_considerations.html',1,'index']]]
+ ['features_20and_20benefits_0',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]],
+ ['features_20not_20supported_1',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]],
+ ['free_20at_20once_2',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]],
+ ['frequently_20asked_20questions_3',['Frequently asked questions',['../faq.html',1,'index']]]
];
diff --git a/docs/html/search/pages_5.js b/docs/html/search/pages_5.js
index b965ff9..b85c57f 100644
--- a/docs/html/search/pages_5.js
+++ b/docs/html/search/pages_5.js
@@ -1,4 +1,5 @@
var searchData=
[
- ['linear_20allocation_20algorithm_0',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]]
+ ['general_20considerations_0',['General considerations',['../general_considerations.html',1,'index']]],
+ ['gpu_20upload_20heap_1',['GPU upload heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'']]]
];
diff --git a/docs/html/search/pages_6.js b/docs/html/search/pages_6.js
index 2fa4310..6386d6c 100644
--- a/docs/html/search/pages_6.js
+++ b/docs/html/search/pages_6.js
@@ -1,5 +1,5 @@
var searchData=
[
- ['memory_20allocator_0',['D3D12 Memory Allocator',['../index.html',1,'']]],
- ['memory_20pools_1',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
+ ['heap_0',['GPU upload heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'']]],
+ ['helper_20structures_1',['Helper structures',['../quick_start.html#quick_start_helper_structures',1,'']]]
];
diff --git a/docs/html/search/pages_7.js b/docs/html/search/pages_7.js
index 0c3cb7f..75d0639 100644
--- a/docs/html/search/pages_7.js
+++ b/docs/html/search/pages_7.js
@@ -1,5 +1,4 @@
var searchData=
[
- ['optimal_20resource_20allocation_0',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
- ['overlap_1',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]]
+ ['initialization_0',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]]
];
diff --git a/docs/html/search/pages_8.js b/docs/html/search/pages_8.js
index f4128dd..2f270a2 100644
--- a/docs/html/search/pages_8.js
+++ b/docs/html/search/pages_8.js
@@ -1,4 +1,4 @@
var searchData=
[
- ['pools_0',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
+ ['json_20dump_0',['JSON dump',['../statistics.html#statistics_json_dump',1,'']]]
];
diff --git a/docs/html/search/pages_9.js b/docs/html/search/pages_9.js
index c9afe7b..9cdb234 100644
--- a/docs/html/search/pages_9.js
+++ b/docs/html/search/pages_9.js
@@ -1,5 +1,5 @@
var searchData=
[
- ['questions_0',['Frequently asked questions',['../faq.html',1,'index']]],
- ['quick_20start_1',['Quick start',['../quick_start.html',1,'index']]]
+ ['linear_20allocation_20algorithm_0',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]],
+ ['links_1',['Web links',['../index.html#main_see_also',1,'']]]
];
diff --git a/docs/html/search/pages_a.js b/docs/html/search/pages_a.js
index 53f0a34..0ce8dfd 100644
--- a/docs/html/search/pages_a.js
+++ b/docs/html/search/pages_a.js
@@ -1,5 +1,10 @@
var searchData=
[
- ['resource_20aliasing_20overlap_0',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
- ['resource_20allocation_1',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]]
+ ['making_20virtual_20allocations_0',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]],
+ ['mapping_20memory_1',['Mapping memory',['../quick_start.html#quick_start_mapping_memory',1,'']]],
+ ['margins_2',['Debug margins',['../configuration.html#debug_margins',1,'']]],
+ ['memory_3',['memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'Avoiding running out of memory'],['../quick_start.html#quick_start_mapping_memory',1,'Mapping memory']]],
+ ['memory_20allocator_4',['D3D12 Memory Allocator',['../index.html',1,'']]],
+ ['memory_20allocator_5',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]],
+ ['memory_20pools_6',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]]
];
diff --git a/docs/html/search/pages_b.js b/docs/html/search/pages_b.js
index d4b7ec0..a1fc386 100644
--- a/docs/html/search/pages_b.js
+++ b/docs/html/search/pages_b.js
@@ -1,5 +1,5 @@
var searchData=
[
- ['start_0',['Quick start',['../quick_start.html',1,'index']]],
- ['statistics_1',['Statistics',['../statistics.html',1,'optimal_allocation']]]
+ ['not_20supported_0',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]],
+ ['numeric_20statistics_1',['Numeric statistics',['../statistics.html#statistics_numeric_statistics',1,'']]]
];
diff --git a/docs/html/search/pages_c.js b/docs/html/search/pages_c.js
index 6f1ceb8..2036541 100644
--- a/docs/html/search/pages_c.js
+++ b/docs/html/search/pages_c.js
@@ -1,4 +1,9 @@
var searchData=
[
- ['virtual_20allocator_0',['Virtual allocator',['../virtual_allocator.html',1,'optimal_allocation']]]
+ ['of_20contents_0',['Table of contents',['../index.html#main_table_of_contents',1,'']]],
+ ['of_20memory_1',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]],
+ ['once_2',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]],
+ ['optimal_20resource_20allocation_3',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
+ ['out_20of_20memory_4',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]],
+ ['overlap_5',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]]
];
diff --git a/docs/html/search/pages_d.js b/docs/html/search/pages_d.js
new file mode 100644
index 0000000..61cd771
--- /dev/null
+++ b/docs/html/search/pages_d.js
@@ -0,0 +1,9 @@
+var searchData=
+[
+ ['parameters_0',['Allocation parameters',['../virtual_allocator.html#virtual_allocator_allocation_parameters',1,'']]],
+ ['performance_1',['Allocation performance',['../optimal_allocation.html#optimal_allocation_allocation_Performance',1,'']]],
+ ['placed_20resources_2',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]],
+ ['pools_3',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]],
+ ['priority_4',['Residency priority',['../optimal_allocation.html#optimal_allocation_residency_priority',1,'']]],
+ ['project_20setup_20and_20initialization_5',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]]
+];
diff --git a/docs/html/search/pages_e.js b/docs/html/search/pages_e.js
new file mode 100644
index 0000000..c9afe7b
--- /dev/null
+++ b/docs/html/search/pages_e.js
@@ -0,0 +1,5 @@
+var searchData=
+[
+ ['questions_0',['Frequently asked questions',['../faq.html',1,'index']]],
+ ['quick_20start_1',['Quick start',['../quick_start.html',1,'index']]]
+];
diff --git a/docs/html/search/pages_f.js b/docs/html/search/pages_f.js
new file mode 100644
index 0000000..97e8dbf
--- /dev/null
+++ b/docs/html/search/pages_f.js
@@ -0,0 +1,12 @@
+var searchData=
+[
+ ['reference_20counting_0',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]],
+ ['residency_20priority_1',['Residency priority',['../optimal_allocation.html#optimal_allocation_residency_priority',1,'']]],
+ ['resource_20aliasing_20overlap_2',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]],
+ ['resource_20alignment_3',['Resource alignment',['../optimal_allocation.html#optimal_allocation_resource_alignment',1,'']]],
+ ['resource_20allocation_4',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]],
+ ['resource_20reference_20counting_5',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]],
+ ['resources_6',['resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'Committed versus placed resources'],['../quick_start.html#quick_start_creating_resources',1,'Creating resources']]],
+ ['ring_20buffer_7',['Ring buffer',['../linear_algorithm.html#linear_algorithm_ring_buffer',1,'']]],
+ ['running_20out_20of_20memory_8',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]]
+];
diff --git a/docs/html/search/search.css b/docs/html/search/search.css
index 19f76f9..956f31f 100644
--- a/docs/html/search/search.css
+++ b/docs/html/search/search.css
@@ -5,8 +5,8 @@
display: flex;
justify-content: center;
align-items: center;
- height: 36px;
- margin-right: 1em;
+ height: 43px;
+ margin-right: 0;
}
/*---------------- Search box styling */
@@ -27,43 +27,23 @@ dark-mode-toggle {
white-space : nowrap;
background: var(--search-background-color);
border-radius: 0.65em;
- box-shadow: var(--search-box-shadow);
+ border: 1px solid var(--search-box-border-color);
z-index: 102;
+ margin-right: 4px;
}
#MSearchBox .left {
display: inline-block;
vertical-align: middle;
- height: 1.4em;
-}
-
-#MSearchSelect {
- display: inline-block;
- vertical-align: middle;
- width: 20px;
- height: 19px;
- background-image: var(--search-magnification-select-image);
- margin: 0 0 0 0.3em;
- padding: 0;
+ height: 1.6em;
}
-#MSearchSelectExt {
- display: inline-block;
- vertical-align: middle;
- width: 10px;
- height: 19px;
- background-image: var(--search-magnification-image);
- margin: 0 0 0 0.5em;
- padding: 0;
-}
-
-
#MSearchField {
display: inline-block;
- vertical-align: middle;
+ vertical-align: top;
width: 7.5em;
- height: 19px;
- margin: 0 0.15em;
+ height: 22px;
+ margin: 0 0 0 0.15em;
padding: 0;
line-height: 1em;
border:none;
@@ -86,7 +66,7 @@ dark-mode-toggle {
display: inline-block;
vertical-align: middle;
width: 1.4em;
- height: 1.4em;
+ height: 1.6em;
}
#MSearchClose {
@@ -101,14 +81,100 @@ dark-mode-toggle {
}
#MSearchCloseImg {
- padding: 0.3em;
- margin: 0;
+ margin: 6px 0 0 4px;
+}
+
+.close-icon {
+ width: 11px;
+ height: 11px;
+ background-color: var(--search-close-icon-bg-color);
+ border-radius: 50%;
+ position: relative;
+ display: flex;
+ justify-content: center;
+ align-items: center;
+ box-sizing: content-box;
+}
+
+.close-icon:before,
+.close-icon:after {
+ content: '';
+ position: absolute;
+ width: 7px;
+ height: 1px;
+ background-color: var(--search-close-icon-fg-color);
+}
+
+.close-icon:before {
+ transform: rotate(45deg);
}
+.close-icon:after {
+ transform: rotate(-45deg);
+}
+
+
.MSearchBoxActive #MSearchField {
color: var(--search-active-color);
}
+.search-icon {
+ width: 20px;
+ height: 20px;
+ display: inline-block;
+ position: relative;
+ margin-left: 3px;
+}
+
+#MSearchSelectExt.search-icon {
+ width: 10px;
+}
+
+#MSearchSelectExt + input {
+ margin-left: 5px;
+}
+
+.search-icon::before, .search-icon::after {
+ content: '';
+ position: absolute;
+ border: 1.5px solid var(--search-foreground-color);
+ box-sizing: content-box;
+}
+
+.search-icon::before {
+ width: 6px;
+ height: 6px;
+ border-radius: 50%;
+ top: 7px;
+ left: 2px;
+ background: var(--search-background-color);
+}
+
+.search-icon::after {
+ border: 1px solid var(--search-foreground-color);
+ width: 0px;
+ height: 3px;
+ border-radius: 2px;
+ top: 15px;
+ left: 8px;
+ transform: rotate(-45deg);
+ transform-origin: top left;
+}
+
+.search-icon-dropdown {
+ content: '';
+ width: 0;
+ height: 0;
+ border-left: 3px solid transparent;
+ border-right: 3px solid transparent;
+ border-top: 3px solid var(--search-foreground-color);
+ top: 8px;
+ left: 15px;
+ transform: translateX(-50%);
+ position: absolute;
+}
+
+
/*---------------- Search filter selection */
@@ -119,15 +185,12 @@ dark-mode-toggle {
left: 0; top: 0;
border: 1px solid var(--search-filter-border-color);
background-color: var(--search-filter-background-color);
+ backdrop-filter: var(--search-filter-backdrop-filter);
+ -webkit-backdrop-filter: var(--search-filter-backdrop-filter);
z-index: 10001;
padding-top: 4px;
padding-bottom: 4px;
- -moz-border-radius: 4px;
- -webkit-border-top-left-radius: 4px;
- -webkit-border-top-right-radius: 4px;
- -webkit-border-bottom-left-radius: 4px;
- -webkit-border-bottom-right-radius: 4px;
- -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ border-radius: 4px;
}
.SelectItem {
@@ -176,18 +239,39 @@ iframe#MSearchResults {
height: 15em;
}
+@keyframes slideInSearchResults {
+ from {
+ opacity: 0;
+ transform: translate(0, 15px);
+ }
+
+ to {
+ opacity: 1;
+ transform: translate(0, 20px);
+ }
+}
+
#MSearchResultsWindow {
display: none;
position: absolute;
- left: 0; top: 0;
+ left: auto;
+ right: 4px;
+ top: 0;
border: 1px solid var(--search-results-border-color);
background-color: var(--search-results-background-color);
+ backdrop-filter: var(--search-results-backdrop-filter);
+ -webkit-backdrop-filter: var(--search-results-backdrop-filter);
z-index:10000;
width: 300px;
height: 400px;
overflow: auto;
+ border-radius: 8px;
+ transform: translate(0, 20px);
+ animation: ease-out 280ms slideInSearchResults;
+ box-shadow: 0 2px 8px 0 rgba(0,0,0,.075);
}
+
/* ----------------------------------- */
@@ -201,13 +285,13 @@ iframe#MSearchResults {
}
.SRPage .SREntry {
- font-size: 8pt;
- padding: 1px 5px;
+ font-size: 10pt;
+ padding: 2px 5px;
}
div.SRPage {
margin: 5px 2px;
- background-color: var(--search-results-background-color);
+ /*background-color: var(--search-results-background-color);*/
}
.SRChildren {
@@ -261,14 +345,17 @@ div.searchresults {
margin-right: 10px;
}
+#searchBoxPos1 dark-mode-toggle {
+ margin-top: 4px;
+}
+
/*---------------- External search page results */
.pages b {
- color: white;
+ color: var(--nav-foreground-color);
padding: 5px 5px 3px 5px;
- background-image: var(--nav-gradient-active-image-parent);
- background-repeat: repeat-x;
- text-shadow: 0 1px 1px #000000;
+ background-color: var(--nav-menu-active-bg);
+ border-radius: 4px;
}
.pages {
diff --git a/docs/html/search/search.js b/docs/html/search/search.js
index 666af01..dc14410 100644
--- a/docs/html/search/search.js
+++ b/docs/html/search/search.js
@@ -607,6 +607,12 @@ function createResults(resultsPath) {
elem.setAttribute('className',attr);
}
+ const decodeHtml = (html) => {
+ const txt = document.createElement("textarea");
+ txt.innerHTML = html;
+ return txt.value;
+ };
+
const results = document.getElementById("SRResults");
results.innerHTML = '';
searchData.forEach((elem,index) => {
@@ -620,10 +626,14 @@ function createResults(resultsPath) {
srLink.setAttribute('id','Item'+index);
setKeyActions(srLink,'return searchResults.Nav(event,'+index+')');
setClassAttr(srLink,'SRSymbol');
- srLink.innerHTML = elem[1][0];
+ srLink.innerHTML = decodeHtml(elem[1][0]);
srEntry.appendChild(srLink);
if (elem[1].length==2) { // single result
- srLink.setAttribute('href',resultsPath+elem[1][1][0]);
+ if (elem[1][1][0].startsWith('http://') || elem[1][1][0].startsWith('https://')) { // absolute path
+ srLink.setAttribute('href',elem[1][1][0]);
+ } else { // relative path
+ srLink.setAttribute('href',resultsPath+elem[1][1][0]);
+ }
srLink.setAttribute('onclick','searchBox.CloseResultsWindow()');
if (elem[1][1][1]) {
srLink.setAttribute('target','_parent');
@@ -632,7 +642,7 @@ function createResults(resultsPath) {
}
const srScope = document.createElement('span');
setClassAttr(srScope,'SRScope');
- srScope.innerHTML = elem[1][1][2];
+ srScope.innerHTML = decodeHtml(elem[1][1][2]);
srEntry.appendChild(srScope);
} else { // multiple results
srLink.setAttribute('href','javascript:searchResults.Toggle("SR_'+id+'")');
@@ -643,14 +653,18 @@ function createResults(resultsPath) {
srChild.setAttribute('id','Item'+index+'_c'+c);
setKeyActions(srChild,'return searchResults.NavChild(event,'+index+','+c+')');
setClassAttr(srChild,'SRScope');
- srChild.setAttribute('href',resultsPath+elem[1][c+1][0]);
+ if (elem[1][c+1][0].startsWith('http://') || elem[1][c+1][0].startsWith('https://')) { // absolute path
+ srChild.setAttribute('href',elem[1][c+1][0]);
+ } else { // relative path
+ srChild.setAttribute('href',resultsPath+elem[1][c+1][0]);
+ }
srChild.setAttribute('onclick','searchBox.CloseResultsWindow()');
if (elem[1][c+1][1]) {
srChild.setAttribute('target','_parent');
} else {
srChild.setAttribute('target','_blank');
}
- srChild.innerHTML = elem[1][c+1][2];
+ srChild.innerHTML = decodeHtml(elem[1][c+1][2]);
srChildren.appendChild(srChild);
}
srEntry.appendChild(srChildren);
diff --git a/docs/html/search/searchdata.js b/docs/html/search/searchdata.js
index 1b7813a..2029dc1 100644
--- a/docs/html/search/searchdata.js
+++ b/docs/html/search/searchdata.js
@@ -11,7 +11,7 @@ var indexSectionsWithContent =
8: "adpv",
9: "cd",
10: "d",
- 11: "acdfglmopqrsv"
+ 11: "abcdfghijlmnopqrstuvw"
};
var indexSectionNames =
diff --git a/docs/html/statistics.html b/docs/html/statistics.html
index f261c65..b9b1e29 100644
--- a/docs/html/statistics.html
+++ b/docs/html/statistics.html
@@ -3,15 +3,13 @@
-
+
This library contains several functions that return information about its internal state, especially the amount of memory allocated from D3D12.
-
+
Numeric statistics
If you need to obtain basic statistics about memory usage per memory segment group, together with current budget, you can call function D3D12MA::Allocator::GetBudget() and inspect structure D3D12MA::Budget. This is useful to keep track of memory usage and stay withing budget. Example:
UINT64 UsageBytesEstimated current memory usage of the program.Definition D3D12MemAlloc.h:486
You can query for more detailed statistics per heap type, memory segment group, and totals, including minimum and maximum allocation size and unused range size, by calling function D3D12MA::Allocator::CalculateStatistics() and inspecting structure D3D12MA::TotalStatistics. This function is slower though, as it has to traverse all the internal data structures, so it should be used only for debugging purposes.
You can query for statistics of a custom pool using function D3D12MA::Pool::GetStatistics() or D3D12MA::Pool::CalculateStatistics().
-You can query for information about a specific allocation using functions of the D3D12MA::Allocation class, e.g. GetSize(), GetOffset(), GetHeap().
+
You can query for information about a specific allocation using functions of the D3D12MA::Allocation class, e.g. GetSize(), GetOffset(), GetHeap().
+JSON dump
You can dump internal state of the allocator to a string in JSON format using function D3D12MA::Allocator::BuildStatsString(). The result is guaranteed to be correct JSON. It uses Windows Unicode (UTF-16) encoding. Any strings provided by user (see D3D12MA::Allocation::SetName()) are copied as-is and properly escaped for JSON. It must be freed using function D3D12MA::Allocator::FreeStatsString().
The format of this JSON string is not part of official documentation of the library, but it will not change in backward-incompatible way without increasing library major version number and appropriate mention in changelog.
@@ -122,7 +109,7 @@-Generated by
1.13.2
+Generated by 1.14.0
-Generated by
1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html
index bb90eaa..495fe3f 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html
@@ -3,15 +3,13 @@
-
+
#include <D3D12MemAlloc.h>
+Public AttributesALLOCATE_FUNC_PTR | pAllocate | | FREE_FUNC_PTR | pFree | | | Custom data that will be passed to allocation and deallocation functions as pUserData parameter. | | |||||||||||||||
pUserData parameter. Detailed Description
+Detailed Description
Custom callbacks to CPU memory allocation functions.
-Member Data Documentation
+Member Data Documentation
◆ pAllocate
@@ -159,7 +143,7 @@
-Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
+Custom data that will be passed to allocation and deallocation functions as pUserData parameter.
@@ -169,7 +153,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 0dd1a39..f398da5 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -102,7 +89,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 5363747..d914ec6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,33 +90,28 @@
Inheritance diagram for D3D12MA::ALLOCATION_DESC:
-
-
-
+
Public Attributes
ALLOCATION_FLAGS Flags Flags for the allocation.
D3D12_HEAP_TYPE HeapType The type of memory heap where the new allocation should be placed.
D3D12_HEAP_FLAGS ExtraHeapFlags Additional heap flags to be used when allocating memory.
Pool * CustomPool Custom pool to place the new resource in. Optional.
void * pPrivateData Custom general-purpose pointer that will be stored in D3D12MA::Allocation.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.
-Member Data Documentation
+Member Data Documentation
◆ CustomPool
@@ -143,7 +125,7 @@
Custom pool to place the new resource in. Optional.
-When not null, the resource will be created inside specified custom pool. Members HeapType, ExtraHeapFlags are then ignored.
+When not null, the resource will be created inside specified custom pool. Members HeapType, ExtraHeapFlags are then ignored.
@@ -162,9 +144,9 @@ D3D12MA::Allocator::CreateResource(), you don't need to care. Necessary flag D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, or D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES is added automatically.
pUserData parameter. 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 0dd1a39..f398da5 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
-Generated by
1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 5363747..d914ec6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
-
+Public AttributesALLOCATION_FLAGS | Flags | | D3D12_HEAP_TYPE | HeapType | | D3D12_HEAP_FLAGS | ExtraHeapFlags | | Pool * | CustomPool | | void * | pPrivateData | | | ||||||||||||||||||
Detailed Description
+Detailed Description
Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.
-Member Data Documentation
+Member Data Documentation
◆ CustomPool
@@ -143,7 +125,7 @@
Custom pool to place the new resource in. Optional.
-When not null, the resource will be created inside specified custom pool. Members HeapType, ExtraHeapFlags are then ignored.
+When not null, the resource will be created inside specified custom pool. Members HeapType, ExtraHeapFlags are then ignored.
@@ -162,9 +144,9 @@ D3D12MA::Allocator::CreateResource(), you don't need to care. Necessary flag D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, or D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES is added automatically.
HeapType, ExtraHeapFlags are then ignored. D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, or D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES is added automatically.ALLOW_ONLY flags. Except when you validate that D3D12MA::Allocator::GetD3D12Options().ResourceHeapTier == D3D12_RESOURCE_HEAP_TIER_1 - then you can leave it 0.D3D12Device::CreateCommittedResource or CreateHeap, not as part of an existing larget block.The type of memory heap where the new allocation should be placed.
-It must be one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK.
It must be one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK.
When D3D12MA::ALLOCATION_DESC::CustomPool != NULL this member is ignored.
@@ -226,7 +208,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html
index ccc6e9d..cfc611c 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -102,7 +89,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html
index 8673896..33029a6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::ALLOCATOR_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
ALLOCATOR_FLAGS Flags Flags for the entire allocator.
ID3D12Device * pDevice UINT64 PreferredBlockSize Preferred size of a single ID3D12Heap block to be allocated.
Preferred size of a single ID3D12Heap block to be allocated.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
IDXGIAdapter * pAdapter
-Detailed Description
+Detailed Description
Parameters of created Allocator object. To be used with CreateAllocator().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -148,7 +130,7 @@
DXGI Adapter object that you use for D3D12 and this allocator.
-Allocator is doing AddRef/Release on this object.
+Allocator is doing AddRef/Release on this object.
@@ -181,7 +163,7 @@
Direct3D device object that the allocator should be attached to.
-Allocator is doing AddRef/Release on this object.
+Allocator is doing AddRef/Release on this object.
@@ -197,7 +179,7 @@
-Preferred size of a single ID3D12Heap block to be allocated.
+Preferred size of a single ID3D12Heap block to be allocated.
Set to 0 to use default, which is currently 64 MiB.
@@ -208,7 +190,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_budget-members.html b/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
index ddeda17..26e4bee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_budget.html b/docs/html/struct_d3_d12_m_a_1_1_budget.html
index 4798ab6..8e8f354 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_budget.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_budget.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Budget Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Statistics fetched from the library.
UINT64 UsageBytes Estimated current memory usage of the program.
UINT64 BudgetBytes Estimated amount of memory available to the program.
-Detailed Description
+Detailed Description
Statistics of current memory usage and available budget for a specific memory segment group.
These are fast to calculate. See function D3D12MA::Allocator::GetBudget().
-Member Data Documentation
+Member Data Documentation
◆ BudgetBytes
@@ -129,8 +113,8 @@
Estimated amount of memory available to the program.
-Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
-It might be different (most probably smaller) than memory capacity returned by D3D12MA::Allocator::GetMemoryCapacity() due to factors external to the program, decided by the operating system. Difference BudgetBytes - UsageBytes is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.
+Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
+It might be different (most probably smaller) than memory capacity returned by D3D12MA::Allocator::GetMemoryCapacity() due to factors external to the program, decided by the operating system. Difference BudgetBytes - UsageBytes is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.
@@ -163,8 +147,8 @@
Estimated current memory usage of the program.
-Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
-It might be different than BlockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipeline state objects, descriptor heaps, command lists, or heaps and resources allocated outside of this library, if any.
+Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
+It might be different than BlockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipeline state objects, descriptor heaps, command lists, or heaps and resources allocated outside of this library, if any.
@@ -174,7 +158,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 656581f..9423c7f 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 49c2950..cae7b08 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,49 +90,40 @@
Inheritance diagram for D3D12MA::CALLOCATION_DESC:
-
-
-
+
Public Member Functions
CALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CALLOCATION_DESC (const ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::ALLOCATION_DESC structure.
CALLOCATION_DESC (Pool *customPool, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of an allocation to be created in a specific custom pool.
CALLOCATION_DESC (D3D12_HEAP_TYPE heapType, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL, D3D12_HEAP_FLAGS extraHeapFlags=D3D12MA_RECOMMENDED_HEAP_FLAGS) noexcept Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::ALLOCATION_DESC Public Attributes inherited from D3D12MA::ALLOCATION_DESC ALLOCATION_FLAGS Flags Flags for the allocation.
D3D12_HEAP_TYPE HeapType The type of memory heap where the new allocation should be placed.
D3D12_HEAP_FLAGS ExtraHeapFlags Additional heap flags to be used when allocating memory.
Pool * CustomPool Custom pool to place the new resource in. Optional.
void * pPrivateData Custom general-purpose pointer that will be stored in D3D12MA::Allocation.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CALLOCATION_DESC() [1/4]
@@ -273,7 +251,7 @@
-Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
+Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
@@ -283,7 +261,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
index 1cb0dea..66262d0 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -110,7 +97,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
index fb6bf6f..37f7330 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CPOOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,61 +90,48 @@
Inheritance diagram for D3D12MA::CPOOL_DESC:
-
-
-
+
Public Member Functions
CPOOL_DESC ()=default Default constructor. Leaves the structure uninitialized.
CPOOL_DESC (const POOL_DESC &o) noexcept Constructor initializing from the base D3D12MA::POOL_DESC structure.
CPOOL_DESC (D3D12_HEAP_TYPE heapType, D3D12_HEAP_FLAGS heapFlags, POOL_FLAGS flags=D3D12MA_RECOMMENDED_POOL_FLAGS, UINT64 blockSize=0, UINT minBlockCount=0, UINT maxBlockCount=UINT_MAX, D3D12_RESIDENCY_PRIORITY residencyPriority=D3D12_RESIDENCY_PRIORITY_NORMAL) noexcept Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
CPOOL_DESC (const D3D12_HEAP_PROPERTIES heapProperties, D3D12_HEAP_FLAGS heapFlags, POOL_FLAGS flags=D3D12MA_RECOMMENDED_POOL_FLAGS, UINT64 blockSize=0, UINT minBlockCount=0, UINT maxBlockCount=UINT_MAX, D3D12_RESIDENCY_PRIORITY residencyPriority=D3D12_RESIDENCY_PRIORITY_NORMAL) noexcept Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::POOL_DESC Public Attributes inherited from D3D12MA::POOL_DESC POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CPOOL_DESC() [1/4]
@@ -264,7 +238,7 @@
-Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
+Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
@@ -320,7 +294,7 @@
-Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
+Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
@@ -330,7 +304,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 8eb5d11..da976da 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -104,7 +91,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index cb1fe74..714062b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,43 +90,36 @@
Inheritance diagram for D3D12MA::CVIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_ALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_ALLOCATION_DESC (const VIRTUAL_ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
CVIRTUAL_ALLOCATION_DESC (UINT64 size, UINT64 alignment, VIRTUAL_ALLOCATION_FLAGS flags=VIRTUAL_ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of a virtual allocation with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_ALLOCATION_DESC() [1/3]
@@ -241,7 +221,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index eeecc96..27af579 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index 78fbb71..e24e9a8 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,40 +90,34 @@
Inheritance diagram for D3D12MA::CVIRTUAL_BLOCK_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_BLOCK_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_BLOCK_DESC (const VIRTUAL_BLOCK_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_BLOCK_DESC structure.
CVIRTUAL_BLOCK_DESC (UINT64 size, VIRTUAL_BLOCK_FLAGS flags=VIRTUAL_BLOCK_FLAG_NONE, const ALLOCATION_CALLBACKS *allocationCallbacks=NULL) noexcept Constructor initializing description of a virtual block with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_BLOCK_DESC() [1/3]
@@ -233,7 +214,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
index 698ab11..69adefa 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
index c65cd1a..242a2ed 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_FLAGS Flags Flags.
UINT64 MaxBytesPerPass Maximum numbers of bytes that can be copied during single pass, while moving allocations to different places.
UINT32 MaxAllocationsPerPass Maximum number of allocations that can be moved during single pass to a different place.
-Detailed Description
+Detailed Description
Parameters for defragmentation.
To be used with functions Allocator::BeginDefragmentation() and Pool::BeginDefragmentation().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -172,7 +156,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
index 4fed39a..f20848d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
index 8a8bf70..87c182e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_MOVE Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_MOVE_OPERATION Operation Operation to be performed on the allocation by DefragmentationContext::EndPass(). Default value is DEFRAGMENTATION_MOVE_OPERATION_COPY. You can modify it.
Allocation * pSrcAllocation Allocation that should be moved.
Allocation * pDstTmpAllocation Temporary allocation pointing to destination memory that will replace pSrcAllocation.
Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Detailed Description
+Detailed Description
Single move of an allocation to be done for defragmentation.
-Member Data Documentation
+Member Data Documentation
◆ Operation
@@ -143,9 +127,9 @@
-Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
-- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make
pSrcAllocation point to this memory.
+Temporary allocation pointing to destination memory that will replace pSrcAllocation.
+Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
+- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make pSrcAllocation point to this memory.
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
index 28aefc6..3e0a1e4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -99,7 +86,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
index 1212826..6e37ac2 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,19 +87,17 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT32 MoveCount Number of elements in the pMoves array.
Number of elements in the pMoves array.
DEFRAGMENTATION_MOVE * pMoves Array of moves to be performed by the user in the current defragmentation pass.
-Detailed Description
+Detailed Description
Parameters for incremental defragmentation steps.
To be used with function DefragmentationContext::BeginPass().
-Member Data Documentation
+Member Data Documentation
◆ MoveCount
@@ -125,7 +110,7 @@
-Number of elements in the pMoves array.
+Number of elements in the pMoves array.
@@ -142,12 +127,12 @@
Array of moves to be performed by the user in the current defragmentation pass.
-Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
+Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
For each element, you should:
-- Create a new resource in the place pointed by
pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
-- Store new resource in
pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
-- Copy data from the
pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
+- Create a new resource in the place pointed by pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
+- Store new resource in pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
+- Copy data from the pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
- Make sure these commands finished executing on the GPU.
Only then you can finish defragmentation pass by calling DefragmentationContext::EndPass(). After this call, the allocation will point to the new place in memory.
@@ -162,7 +147,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
index 6723fa3..be2d910 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
index b7f806d..220d0bd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_STATS Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,24 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 BytesMoved Total number of bytes that have been copied while moving allocations to different places.
UINT64 BytesFreed Total number of bytes that have been released to the system by freeing empty heaps.
UINT32 AllocationsMoved Number of allocations that have been moved to different places.
UINT32 HeapsFreed Number of empty ID3D12Heap objects that have been released to the system.
Number of empty ID3D12Heap objects that have been released to the system.
-Detailed Description
+Detailed Description
Statistics returned for defragmentation process by function DefragmentationContext::GetStats().
-Member Data Documentation
+Member Data Documentation
◆ AllocationsMoved
@@ -178,7 +161,7 @@
-Number of empty ID3D12Heap objects that have been released to the system.
+Number of empty ID3D12Heap objects that have been released to the system.
@@ -188,7 +171,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
index 9167002..13c5446 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
index f4f534a..88fa33d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DetailedStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,35 +87,29 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Basic statistics.
UINT UnusedRangeCount Number of free ranges of memory between allocations.
UINT64 AllocationSizeMin Smallest allocation size. UINT64_MAX if there are 0 allocations.
Smallest allocation size. UINT64_MAX if there are 0 allocations.
UINT64 AllocationSizeMax Largest allocation size. 0 if there are 0 allocations.
UINT64 UnusedRangeSizeMin Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
UINT64 UnusedRangeSizeMax Largest empty range size. 0 if there are 0 empty ranges.
-Detailed Description
+Detailed Description
More detailed statistics than D3D12MA::Statistics.
These are slower to calculate. Use for debugging purposes. See functions: D3D12MA::Allocator::CalculateStatistics(), D3D12MA::Pool::CalculateStatistics().
Averages are not provided because they can be easily calculated as:
UINT64 AllocationSizeAvg = DetailedStats.Statistics.AllocationBytes / detailedStats.Statistics.AllocationCount;
UINT64 UnusedBytes = DetailedStats.Statistics.BlockBytes - DetailedStats.Statistics.AllocationBytes;
UINT64 UnusedRangeSizeAvg = UnusedBytes / DetailedStats.UnusedRangeCount;
- Member Data Documentation
+ Member Data Documentation
◆ AllocationSizeMax
@@ -157,7 +138,7 @@
-Smallest allocation size. UINT64_MAX if there are 0 allocations.
+Smallest allocation size. UINT64_MAX if there are 0 allocations.
@@ -221,7 +202,7 @@
-Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
+Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
@@ -231,7 +212,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
index 2ae0d33..654ade6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
index fcb0f64..d812aff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::POOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,45 +90,36 @@
Inheritance diagram for D3D12MA::POOL_DESC:
-
-
-
+
Public Attributes
POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool.
-Member Data Documentation
+Member Data Documentation
◆ BlockSize
@@ -189,7 +167,7 @@
Heap flags to be used when allocating heaps of this pool.
-It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
+It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
It is recommended to also add D3D12MA_RECOMMENDED_POOL_FLAGS. You can specify additional flags if needed.
@@ -207,7 +185,7 @@
The parameters of memory heap where allocations of this pool should be placed.
-In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
+In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
@@ -224,7 +202,7 @@
Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
-Set to 0 to use default, which is UINT64_MAX, which means no limit.
+Set to 0 to use default, which is UINT64_MAX, which means no limit.
Set to same value as D3D12MA::POOL_DESC::MinBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.
@@ -293,10 +271,10 @@
Residency priority to be set for all allocations made in this pool. Optional.
-Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
-Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
-This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
-There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
+Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
+Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
+This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
+There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
@@ -306,7 +284,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
index a970156..67b61fe 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
index b7e7c30..853c2ff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Statistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,21 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT BlockCount Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
UINT AllocationCount Number of D3D12MA::Allocation objects allocated.
UINT64 BlockBytes Number of bytes allocated in memory blocks.
UINT64 AllocationBytes Total number of bytes occupied by all D3D12MA::Allocation objects.
-Detailed Description
+Detailed Description
Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total.
These are fast to calculate. See functions: D3D12MA::Allocator::GetBudget(), D3D12MA::Pool::GetStatistics().
-Member Data Documentation
+Member Data Documentation
◆ AllocationBytes
@@ -132,7 +115,7 @@
Total number of bytes occupied by all D3D12MA::Allocation objects.
-Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
+Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
@@ -149,7 +132,7 @@
Number of D3D12MA::Allocation objects allocated.
-Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
+Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
@@ -181,7 +164,7 @@
-Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
+Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
-
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
#include <D3D12MemAlloc.h>
+Public AttributesALLOCATOR_FLAGS | Flags | | | | Preferred size of a single ID3D12Heap block to be allocated. | const ALLOCATION_CALLBACKS * | pAllocationCallbacks | | | | |||||||||||||||||||||
ID3D12Heap block to be allocated. Detailed Description
+Detailed Description
Parameters of created Allocator object. To be used with CreateAllocator().
-Member Data Documentation
+DXGI Adapter object that you use for D3D12 and this allocator.
-Allocator is doing AddRef/Release on this object.
Allocator is doing AddRef/Release on this object.
@@ -181,7 +163,7 @@
Direct3D device object that the allocator should be attached to.
-Allocator is doing AddRef/Release on this object.
+Allocator is doing AddRef/Release on this object.
@@ -197,7 +179,7 @@
-Preferred size of a single ID3D12Heap block to be allocated.
+Preferred size of a single ID3D12Heap block to be allocated.
Set to 0 to use default, which is currently 64 MiB.
@@ -208,7 +190,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_budget-members.html b/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
index ddeda17..26e4bee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_budget.html b/docs/html/struct_d3_d12_m_a_1_1_budget.html
index 4798ab6..8e8f354 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_budget.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_budget.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Budget Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Statistics fetched from the library.
UINT64 UsageBytes Estimated current memory usage of the program.
UINT64 BudgetBytes Estimated amount of memory available to the program.
-Detailed Description
+Detailed Description
Statistics of current memory usage and available budget for a specific memory segment group.
These are fast to calculate. See function D3D12MA::Allocator::GetBudget().
-Member Data Documentation
+Member Data Documentation
◆ BudgetBytes
@@ -129,8 +113,8 @@
Estimated amount of memory available to the program.
-Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
-It might be different (most probably smaller) than memory capacity returned by D3D12MA::Allocator::GetMemoryCapacity() due to factors external to the program, decided by the operating system. Difference BudgetBytes - UsageBytes is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.
+Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
+It might be different (most probably smaller) than memory capacity returned by D3D12MA::Allocator::GetMemoryCapacity() due to factors external to the program, decided by the operating system. Difference BudgetBytes - UsageBytes is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.
@@ -163,8 +147,8 @@
Estimated current memory usage of the program.
-Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
-It might be different than BlockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipeline state objects, descriptor heaps, command lists, or heaps and resources allocated outside of this library, if any.
+Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
+It might be different than BlockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipeline state objects, descriptor heaps, command lists, or heaps and resources allocated outside of this library, if any.
@@ -174,7 +158,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 656581f..9423c7f 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 49c2950..cae7b08 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,49 +90,40 @@
Inheritance diagram for D3D12MA::CALLOCATION_DESC:
-
-
-
+
Public Member Functions
CALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CALLOCATION_DESC (const ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::ALLOCATION_DESC structure.
CALLOCATION_DESC (Pool *customPool, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of an allocation to be created in a specific custom pool.
CALLOCATION_DESC (D3D12_HEAP_TYPE heapType, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL, D3D12_HEAP_FLAGS extraHeapFlags=D3D12MA_RECOMMENDED_HEAP_FLAGS) noexcept Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::ALLOCATION_DESC Public Attributes inherited from D3D12MA::ALLOCATION_DESC ALLOCATION_FLAGS Flags Flags for the allocation.
D3D12_HEAP_TYPE HeapType The type of memory heap where the new allocation should be placed.
D3D12_HEAP_FLAGS ExtraHeapFlags Additional heap flags to be used when allocating memory.
Pool * CustomPool Custom pool to place the new resource in. Optional.
void * pPrivateData Custom general-purpose pointer that will be stored in D3D12MA::Allocation.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CALLOCATION_DESC() [1/4]
@@ -273,7 +251,7 @@
-Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
+Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
@@ -283,7 +261,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
index 1cb0dea..66262d0 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -110,7 +97,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
index fb6bf6f..37f7330 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CPOOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,61 +90,48 @@
Inheritance diagram for D3D12MA::CPOOL_DESC:
-
-
-
+
Public Member Functions
CPOOL_DESC ()=default Default constructor. Leaves the structure uninitialized.
CPOOL_DESC (const POOL_DESC &o) noexcept Constructor initializing from the base D3D12MA::POOL_DESC structure.
CPOOL_DESC (D3D12_HEAP_TYPE heapType, D3D12_HEAP_FLAGS heapFlags, POOL_FLAGS flags=D3D12MA_RECOMMENDED_POOL_FLAGS, UINT64 blockSize=0, UINT minBlockCount=0, UINT maxBlockCount=UINT_MAX, D3D12_RESIDENCY_PRIORITY residencyPriority=D3D12_RESIDENCY_PRIORITY_NORMAL) noexcept Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
CPOOL_DESC (const D3D12_HEAP_PROPERTIES heapProperties, D3D12_HEAP_FLAGS heapFlags, POOL_FLAGS flags=D3D12MA_RECOMMENDED_POOL_FLAGS, UINT64 blockSize=0, UINT minBlockCount=0, UINT maxBlockCount=UINT_MAX, D3D12_RESIDENCY_PRIORITY residencyPriority=D3D12_RESIDENCY_PRIORITY_NORMAL) noexcept Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::POOL_DESC Public Attributes inherited from D3D12MA::POOL_DESC POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CPOOL_DESC() [1/4]
@@ -264,7 +238,7 @@
-Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
+Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
@@ -320,7 +294,7 @@
-Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
+Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
@@ -330,7 +304,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 8eb5d11..da976da 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -104,7 +91,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index cb1fe74..714062b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,43 +90,36 @@
Inheritance diagram for D3D12MA::CVIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_ALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_ALLOCATION_DESC (const VIRTUAL_ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
CVIRTUAL_ALLOCATION_DESC (UINT64 size, UINT64 alignment, VIRTUAL_ALLOCATION_FLAGS flags=VIRTUAL_ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of a virtual allocation with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_ALLOCATION_DESC() [1/3]
@@ -241,7 +221,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index eeecc96..27af579 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index 78fbb71..e24e9a8 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,40 +90,34 @@
Inheritance diagram for D3D12MA::CVIRTUAL_BLOCK_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_BLOCK_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_BLOCK_DESC (const VIRTUAL_BLOCK_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_BLOCK_DESC structure.
CVIRTUAL_BLOCK_DESC (UINT64 size, VIRTUAL_BLOCK_FLAGS flags=VIRTUAL_BLOCK_FLAG_NONE, const ALLOCATION_CALLBACKS *allocationCallbacks=NULL) noexcept Constructor initializing description of a virtual block with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_BLOCK_DESC() [1/3]
@@ -233,7 +214,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
index 698ab11..69adefa 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
index c65cd1a..242a2ed 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_FLAGS Flags Flags.
UINT64 MaxBytesPerPass Maximum numbers of bytes that can be copied during single pass, while moving allocations to different places.
UINT32 MaxAllocationsPerPass Maximum number of allocations that can be moved during single pass to a different place.
-Detailed Description
+Detailed Description
Parameters for defragmentation.
To be used with functions Allocator::BeginDefragmentation() and Pool::BeginDefragmentation().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -172,7 +156,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
index 4fed39a..f20848d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
index 8a8bf70..87c182e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_MOVE Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_MOVE_OPERATION Operation Operation to be performed on the allocation by DefragmentationContext::EndPass(). Default value is DEFRAGMENTATION_MOVE_OPERATION_COPY. You can modify it.
Allocation * pSrcAllocation Allocation that should be moved.
Allocation * pDstTmpAllocation Temporary allocation pointing to destination memory that will replace pSrcAllocation.
Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Detailed Description
+Detailed Description
Single move of an allocation to be done for defragmentation.
-Member Data Documentation
+Member Data Documentation
◆ Operation
@@ -143,9 +127,9 @@
-Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
-- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make
pSrcAllocation point to this memory.
+Temporary allocation pointing to destination memory that will replace pSrcAllocation.
+Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
+- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make pSrcAllocation point to this memory.
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
index 28aefc6..3e0a1e4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -99,7 +86,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
index 1212826..6e37ac2 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,19 +87,17 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT32 MoveCount Number of elements in the pMoves array.
Number of elements in the pMoves array.
DEFRAGMENTATION_MOVE * pMoves Array of moves to be performed by the user in the current defragmentation pass.
-Detailed Description
+Detailed Description
Parameters for incremental defragmentation steps.
To be used with function DefragmentationContext::BeginPass().
-Member Data Documentation
+Member Data Documentation
◆ MoveCount
@@ -125,7 +110,7 @@
-Number of elements in the pMoves array.
+Number of elements in the pMoves array.
@@ -142,12 +127,12 @@
Array of moves to be performed by the user in the current defragmentation pass.
-Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
+Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
For each element, you should:
-- Create a new resource in the place pointed by
pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
-- Store new resource in
pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
-- Copy data from the
pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
+- Create a new resource in the place pointed by pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
+- Store new resource in pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
+- Copy data from the pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
- Make sure these commands finished executing on the GPU.
Only then you can finish defragmentation pass by calling DefragmentationContext::EndPass(). After this call, the allocation will point to the new place in memory.
@@ -162,7 +147,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
index 6723fa3..be2d910 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
index b7f806d..220d0bd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_STATS Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,24 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 BytesMoved Total number of bytes that have been copied while moving allocations to different places.
UINT64 BytesFreed Total number of bytes that have been released to the system by freeing empty heaps.
UINT32 AllocationsMoved Number of allocations that have been moved to different places.
UINT32 HeapsFreed Number of empty ID3D12Heap objects that have been released to the system.
Number of empty ID3D12Heap objects that have been released to the system.
-Detailed Description
+Detailed Description
Statistics returned for defragmentation process by function DefragmentationContext::GetStats().
-Member Data Documentation
+Member Data Documentation
◆ AllocationsMoved
@@ -178,7 +161,7 @@
-Number of empty ID3D12Heap objects that have been released to the system.
+Number of empty ID3D12Heap objects that have been released to the system.
@@ -188,7 +171,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
index 9167002..13c5446 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
index f4f534a..88fa33d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DetailedStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,35 +87,29 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Basic statistics.
UINT UnusedRangeCount Number of free ranges of memory between allocations.
UINT64 AllocationSizeMin Smallest allocation size. UINT64_MAX if there are 0 allocations.
Smallest allocation size. UINT64_MAX if there are 0 allocations.
UINT64 AllocationSizeMax Largest allocation size. 0 if there are 0 allocations.
UINT64 UnusedRangeSizeMin Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
UINT64 UnusedRangeSizeMax Largest empty range size. 0 if there are 0 empty ranges.
-Detailed Description
+Detailed Description
More detailed statistics than D3D12MA::Statistics.
These are slower to calculate. Use for debugging purposes. See functions: D3D12MA::Allocator::CalculateStatistics(), D3D12MA::Pool::CalculateStatistics().
Averages are not provided because they can be easily calculated as:
UINT64 AllocationSizeAvg = DetailedStats.Statistics.AllocationBytes / detailedStats.Statistics.AllocationCount;
UINT64 UnusedBytes = DetailedStats.Statistics.BlockBytes - DetailedStats.Statistics.AllocationBytes;
UINT64 UnusedRangeSizeAvg = UnusedBytes / DetailedStats.UnusedRangeCount;
- Member Data Documentation
+ Member Data Documentation
◆ AllocationSizeMax
@@ -157,7 +138,7 @@
-Smallest allocation size. UINT64_MAX if there are 0 allocations.
+Smallest allocation size. UINT64_MAX if there are 0 allocations.
@@ -221,7 +202,7 @@
-Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
+Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
@@ -231,7 +212,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
index 2ae0d33..654ade6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
index fcb0f64..d812aff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::POOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,45 +90,36 @@
Inheritance diagram for D3D12MA::POOL_DESC:
-
-
-
+
Public Attributes
POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool.
-Member Data Documentation
+Member Data Documentation
◆ BlockSize
@@ -189,7 +167,7 @@
Heap flags to be used when allocating heaps of this pool.
-It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
+It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
It is recommended to also add D3D12MA_RECOMMENDED_POOL_FLAGS. You can specify additional flags if needed.
@@ -207,7 +185,7 @@
The parameters of memory heap where allocations of this pool should be placed.
-In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
+In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
@@ -224,7 +202,7 @@
Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
-Set to 0 to use default, which is UINT64_MAX, which means no limit.
+Set to 0 to use default, which is UINT64_MAX, which means no limit.
Set to same value as D3D12MA::POOL_DESC::MinBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.
@@ -293,10 +271,10 @@
Residency priority to be set for all allocations made in this pool. Optional.
-Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
-Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
-This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
-There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
+Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
+Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
+This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
+There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
@@ -306,7 +284,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
index a970156..67b61fe 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
index b7e7c30..853c2ff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Statistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,21 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT BlockCount Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
UINT AllocationCount Number of D3D12MA::Allocation objects allocated.
UINT64 BlockBytes Number of bytes allocated in memory blocks.
UINT64 AllocationBytes Total number of bytes occupied by all D3D12MA::Allocation objects.
-Detailed Description
+Detailed Description
Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total.
These are fast to calculate. See functions: D3D12MA::Allocator::GetBudget(), D3D12MA::Pool::GetStatistics().
-Member Data Documentation
+Member Data Documentation
◆ AllocationBytes
@@ -132,7 +115,7 @@
Total number of bytes occupied by all D3D12MA::Allocation objects.
-Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
+Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
@@ -149,7 +132,7 @@
Number of D3D12MA::Allocation objects allocated.
-Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
+Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
@@ -181,7 +164,7 @@
-Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
+Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
-
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
AddRef/Release on this object. Preferred size of a single ID3D12Heap block to be allocated.
Preferred size of a single ID3D12Heap block to be allocated.
Set to 0 to use default, which is currently 64 MiB.
@@ -208,7 +190,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_budget-members.html b/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
index ddeda17..26e4bee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_budget-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_budget.html b/docs/html/struct_d3_d12_m_a_1_1_budget.html
index 4798ab6..8e8f354 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_budget.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_budget.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Budget Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Statistics fetched from the library.
UINT64 UsageBytes Estimated current memory usage of the program.
UINT64 BudgetBytes Estimated amount of memory available to the program.
-Detailed Description
+Detailed Description
Statistics of current memory usage and available budget for a specific memory segment group.
These are fast to calculate. See function D3D12MA::Allocator::GetBudget().
-Member Data Documentation
+Member Data Documentation
◆ BudgetBytes
@@ -129,8 +113,8 @@
Estimated amount of memory available to the program.
-Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
-It might be different (most probably smaller) than memory capacity returned by D3D12MA::Allocator::GetMemoryCapacity() due to factors external to the program, decided by the operating system. Difference BudgetBytes - UsageBytes is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.
+Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
+It might be different (most probably smaller) than memory capacity returned by D3D12MA::Allocator::GetMemoryCapacity() due to factors external to the program, decided by the operating system. Difference BudgetBytes - UsageBytes is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.
@@ -163,8 +147,8 @@
Estimated current memory usage of the program.
-Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
-It might be different than BlockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipeline state objects, descriptor heaps, command lists, or heaps and resources allocated outside of this library, if any.
+Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
+It might be different than BlockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipeline state objects, descriptor heaps, command lists, or heaps and resources allocated outside of this library, if any.
@@ -174,7 +158,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 656581f..9423c7f 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 49c2950..cae7b08 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,49 +90,40 @@
Inheritance diagram for D3D12MA::CALLOCATION_DESC:
-
-
-
+
Public Member Functions
CALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CALLOCATION_DESC (const ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::ALLOCATION_DESC structure.
CALLOCATION_DESC (Pool *customPool, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of an allocation to be created in a specific custom pool.
CALLOCATION_DESC (D3D12_HEAP_TYPE heapType, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL, D3D12_HEAP_FLAGS extraHeapFlags=D3D12MA_RECOMMENDED_HEAP_FLAGS) noexcept Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::ALLOCATION_DESC Public Attributes inherited from D3D12MA::ALLOCATION_DESC ALLOCATION_FLAGS Flags Flags for the allocation.
D3D12_HEAP_TYPE HeapType The type of memory heap where the new allocation should be placed.
D3D12_HEAP_FLAGS ExtraHeapFlags Additional heap flags to be used when allocating memory.
Pool * CustomPool Custom pool to place the new resource in. Optional.
void * pPrivateData Custom general-purpose pointer that will be stored in D3D12MA::Allocation.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CALLOCATION_DESC() [1/4]
@@ -273,7 +251,7 @@
-Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
+Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
@@ -283,7 +261,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
index 1cb0dea..66262d0 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -110,7 +97,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
index fb6bf6f..37f7330 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CPOOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,61 +90,48 @@
Inheritance diagram for D3D12MA::CPOOL_DESC:
-
-
-
+
Public Member Functions
CPOOL_DESC ()=default Default constructor. Leaves the structure uninitialized.
CPOOL_DESC (const POOL_DESC &o) noexcept Constructor initializing from the base D3D12MA::POOL_DESC structure.
CPOOL_DESC (D3D12_HEAP_TYPE heapType, D3D12_HEAP_FLAGS heapFlags, POOL_FLAGS flags=D3D12MA_RECOMMENDED_POOL_FLAGS, UINT64 blockSize=0, UINT minBlockCount=0, UINT maxBlockCount=UINT_MAX, D3D12_RESIDENCY_PRIORITY residencyPriority=D3D12_RESIDENCY_PRIORITY_NORMAL) noexcept Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
CPOOL_DESC (const D3D12_HEAP_PROPERTIES heapProperties, D3D12_HEAP_FLAGS heapFlags, POOL_FLAGS flags=D3D12MA_RECOMMENDED_POOL_FLAGS, UINT64 blockSize=0, UINT minBlockCount=0, UINT maxBlockCount=UINT_MAX, D3D12_RESIDENCY_PRIORITY residencyPriority=D3D12_RESIDENCY_PRIORITY_NORMAL) noexcept Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::POOL_DESC Public Attributes inherited from D3D12MA::POOL_DESC POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CPOOL_DESC() [1/4]
@@ -264,7 +238,7 @@
-Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
+Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
@@ -320,7 +294,7 @@
-Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
+Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
@@ -330,7 +304,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 8eb5d11..da976da 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -104,7 +91,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index cb1fe74..714062b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,43 +90,36 @@
Inheritance diagram for D3D12MA::CVIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_ALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_ALLOCATION_DESC (const VIRTUAL_ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
CVIRTUAL_ALLOCATION_DESC (UINT64 size, UINT64 alignment, VIRTUAL_ALLOCATION_FLAGS flags=VIRTUAL_ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of a virtual allocation with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_ALLOCATION_DESC() [1/3]
@@ -241,7 +221,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index eeecc96..27af579 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index 78fbb71..e24e9a8 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,40 +90,34 @@
Inheritance diagram for D3D12MA::CVIRTUAL_BLOCK_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_BLOCK_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_BLOCK_DESC (const VIRTUAL_BLOCK_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_BLOCK_DESC structure.
CVIRTUAL_BLOCK_DESC (UINT64 size, VIRTUAL_BLOCK_FLAGS flags=VIRTUAL_BLOCK_FLAG_NONE, const ALLOCATION_CALLBACKS *allocationCallbacks=NULL) noexcept Constructor initializing description of a virtual block with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_BLOCK_DESC() [1/3]
@@ -233,7 +214,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
index 698ab11..69adefa 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
index c65cd1a..242a2ed 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_FLAGS Flags Flags.
UINT64 MaxBytesPerPass Maximum numbers of bytes that can be copied during single pass, while moving allocations to different places.
UINT32 MaxAllocationsPerPass Maximum number of allocations that can be moved during single pass to a different place.
-Detailed Description
+Detailed Description
Parameters for defragmentation.
To be used with functions Allocator::BeginDefragmentation() and Pool::BeginDefragmentation().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -172,7 +156,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
index 4fed39a..f20848d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
index 8a8bf70..87c182e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_MOVE Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_MOVE_OPERATION Operation Operation to be performed on the allocation by DefragmentationContext::EndPass(). Default value is DEFRAGMENTATION_MOVE_OPERATION_COPY. You can modify it.
Allocation * pSrcAllocation Allocation that should be moved.
Allocation * pDstTmpAllocation Temporary allocation pointing to destination memory that will replace pSrcAllocation.
Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Detailed Description
+Detailed Description
Single move of an allocation to be done for defragmentation.
-Member Data Documentation
+Member Data Documentation
◆ Operation
@@ -143,9 +127,9 @@
-Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
-- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make
pSrcAllocation point to this memory.
+Temporary allocation pointing to destination memory that will replace pSrcAllocation.
+Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
+- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make pSrcAllocation point to this memory.
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
index 28aefc6..3e0a1e4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -99,7 +86,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
index 1212826..6e37ac2 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,19 +87,17 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT32 MoveCount Number of elements in the pMoves array.
Number of elements in the pMoves array.
DEFRAGMENTATION_MOVE * pMoves Array of moves to be performed by the user in the current defragmentation pass.
-Detailed Description
+Detailed Description
Parameters for incremental defragmentation steps.
To be used with function DefragmentationContext::BeginPass().
-Member Data Documentation
+Member Data Documentation
◆ MoveCount
@@ -125,7 +110,7 @@
-Number of elements in the pMoves array.
+Number of elements in the pMoves array.
@@ -142,12 +127,12 @@
Array of moves to be performed by the user in the current defragmentation pass.
-Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
+Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
For each element, you should:
-- Create a new resource in the place pointed by
pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
-- Store new resource in
pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
-- Copy data from the
pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
+- Create a new resource in the place pointed by pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
+- Store new resource in pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
+- Copy data from the pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
- Make sure these commands finished executing on the GPU.
Only then you can finish defragmentation pass by calling DefragmentationContext::EndPass(). After this call, the allocation will point to the new place in memory.
@@ -162,7 +147,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
index 6723fa3..be2d910 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
index b7f806d..220d0bd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_STATS Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,24 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 BytesMoved Total number of bytes that have been copied while moving allocations to different places.
UINT64 BytesFreed Total number of bytes that have been released to the system by freeing empty heaps.
UINT32 AllocationsMoved Number of allocations that have been moved to different places.
UINT32 HeapsFreed Number of empty ID3D12Heap objects that have been released to the system.
Number of empty ID3D12Heap objects that have been released to the system.
-Detailed Description
+Detailed Description
Statistics returned for defragmentation process by function DefragmentationContext::GetStats().
-Member Data Documentation
+Member Data Documentation
◆ AllocationsMoved
@@ -178,7 +161,7 @@
-Number of empty ID3D12Heap objects that have been released to the system.
+Number of empty ID3D12Heap objects that have been released to the system.
@@ -188,7 +171,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
index 9167002..13c5446 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
index f4f534a..88fa33d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DetailedStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,35 +87,29 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Basic statistics.
UINT UnusedRangeCount Number of free ranges of memory between allocations.
UINT64 AllocationSizeMin Smallest allocation size. UINT64_MAX if there are 0 allocations.
Smallest allocation size. UINT64_MAX if there are 0 allocations.
UINT64 AllocationSizeMax Largest allocation size. 0 if there are 0 allocations.
UINT64 UnusedRangeSizeMin Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
UINT64 UnusedRangeSizeMax Largest empty range size. 0 if there are 0 empty ranges.
-Detailed Description
+Detailed Description
More detailed statistics than D3D12MA::Statistics.
These are slower to calculate. Use for debugging purposes. See functions: D3D12MA::Allocator::CalculateStatistics(), D3D12MA::Pool::CalculateStatistics().
Averages are not provided because they can be easily calculated as:
UINT64 AllocationSizeAvg = DetailedStats.Statistics.AllocationBytes / detailedStats.Statistics.AllocationCount;
UINT64 UnusedBytes = DetailedStats.Statistics.BlockBytes - DetailedStats.Statistics.AllocationBytes;
UINT64 UnusedRangeSizeAvg = UnusedBytes / DetailedStats.UnusedRangeCount;
- Member Data Documentation
+ Member Data Documentation
◆ AllocationSizeMax
@@ -157,7 +138,7 @@
-Smallest allocation size. UINT64_MAX if there are 0 allocations.
+Smallest allocation size. UINT64_MAX if there are 0 allocations.
@@ -221,7 +202,7 @@
-Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
+Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
@@ -231,7 +212,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
index 2ae0d33..654ade6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
index fcb0f64..d812aff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::POOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,45 +90,36 @@
Inheritance diagram for D3D12MA::POOL_DESC:
-
-
-
+
Public Attributes
POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool.
-Member Data Documentation
+Member Data Documentation
◆ BlockSize
@@ -189,7 +167,7 @@
Heap flags to be used when allocating heaps of this pool.
-It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
+It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
It is recommended to also add D3D12MA_RECOMMENDED_POOL_FLAGS. You can specify additional flags if needed.
@@ -207,7 +185,7 @@
The parameters of memory heap where allocations of this pool should be placed.
-In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
+In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
@@ -224,7 +202,7 @@
Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
-Set to 0 to use default, which is UINT64_MAX, which means no limit.
+Set to 0 to use default, which is UINT64_MAX, which means no limit.
Set to same value as D3D12MA::POOL_DESC::MinBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.
@@ -293,10 +271,10 @@
Residency priority to be set for all allocations made in this pool. Optional.
-Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
-Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
-This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
-There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
+Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
+Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
+This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
+There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
@@ -306,7 +284,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
index a970156..67b61fe 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
index b7e7c30..853c2ff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Statistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,21 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT BlockCount Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
UINT AllocationCount Number of D3D12MA::Allocation objects allocated.
UINT64 BlockBytes Number of bytes allocated in memory blocks.
UINT64 AllocationBytes Total number of bytes occupied by all D3D12MA::Allocation objects.
-Detailed Description
+Detailed Description
Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total.
These are fast to calculate. See functions: D3D12MA::Allocator::GetBudget(), D3D12MA::Pool::GetStatistics().
-Member Data Documentation
+Member Data Documentation
◆ AllocationBytes
@@ -132,7 +115,7 @@
Total number of bytes occupied by all D3D12MA::Allocation objects.
-Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
+Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
@@ -149,7 +132,7 @@
Number of D3D12MA::Allocation objects allocated.
-Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
+Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
@@ -181,7 +164,7 @@
-Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
+Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
-
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
#include <D3D12MemAlloc.h>
+Public AttributesStatistics | Stats | | UINT64 | UsageBytes | | UINT64 | BudgetBytes | | | ||||||||||||
Detailed Description
+Detailed Description
Statistics of current memory usage and available budget for a specific memory segment group.
These are fast to calculate. See function D3D12MA::Allocator::GetBudget().
-Member Data Documentation
+Estimated amount of memory available to the program.
-Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
It might be different (most probably smaller) than memory capacity returned by D3D12MA::Allocator::GetMemoryCapacity() due to factors external to the program, decided by the operating system. Difference BudgetBytes - UsageBytes is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.
Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
+It might be different (most probably smaller) than memory capacity returned by D3D12MA::Allocator::GetMemoryCapacity() due to factors external to the program, decided by the operating system. Difference BudgetBytes - UsageBytes is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.
@@ -163,8 +147,8 @@
Estimated current memory usage of the program.
-Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
-It might be different than BlockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipeline state objects, descriptor heaps, command lists, or heaps and resources allocated outside of this library, if any.
+Fetched from system using IDXGIAdapter3::QueryVideoMemoryInfo if possible.
+It might be different than BlockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipeline state objects, descriptor heaps, command lists, or heaps and resources allocated outside of this library, if any.
@@ -174,7 +158,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 656581f..9423c7f 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 49c2950..cae7b08 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,49 +90,40 @@
Inheritance diagram for D3D12MA::CALLOCATION_DESC:
-
-
-
+
Public Member Functions
CALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CALLOCATION_DESC (const ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::ALLOCATION_DESC structure.
CALLOCATION_DESC (Pool *customPool, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of an allocation to be created in a specific custom pool.
CALLOCATION_DESC (D3D12_HEAP_TYPE heapType, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL, D3D12_HEAP_FLAGS extraHeapFlags=D3D12MA_RECOMMENDED_HEAP_FLAGS) noexcept Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::ALLOCATION_DESC Public Attributes inherited from D3D12MA::ALLOCATION_DESC ALLOCATION_FLAGS Flags Flags for the allocation.
D3D12_HEAP_TYPE HeapType The type of memory heap where the new allocation should be placed.
D3D12_HEAP_FLAGS ExtraHeapFlags Additional heap flags to be used when allocating memory.
Pool * CustomPool Custom pool to place the new resource in. Optional.
void * pPrivateData Custom general-purpose pointer that will be stored in D3D12MA::Allocation.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CALLOCATION_DESC() [1/4]
@@ -273,7 +251,7 @@
-Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
+Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
@@ -283,7 +261,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
index 1cb0dea..66262d0 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -110,7 +97,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
index fb6bf6f..37f7330 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CPOOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,61 +90,48 @@
Inheritance diagram for D3D12MA::CPOOL_DESC:
-
-
-
+
Public Member Functions
CPOOL_DESC ()=default Default constructor. Leaves the structure uninitialized.
CPOOL_DESC (const POOL_DESC &o) noexcept Constructor initializing from the base D3D12MA::POOL_DESC structure.
CPOOL_DESC (D3D12_HEAP_TYPE heapType, D3D12_HEAP_FLAGS heapFlags, POOL_FLAGS flags=D3D12MA_RECOMMENDED_POOL_FLAGS, UINT64 blockSize=0, UINT minBlockCount=0, UINT maxBlockCount=UINT_MAX, D3D12_RESIDENCY_PRIORITY residencyPriority=D3D12_RESIDENCY_PRIORITY_NORMAL) noexcept Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
CPOOL_DESC (const D3D12_HEAP_PROPERTIES heapProperties, D3D12_HEAP_FLAGS heapFlags, POOL_FLAGS flags=D3D12MA_RECOMMENDED_POOL_FLAGS, UINT64 blockSize=0, UINT minBlockCount=0, UINT maxBlockCount=UINT_MAX, D3D12_RESIDENCY_PRIORITY residencyPriority=D3D12_RESIDENCY_PRIORITY_NORMAL) noexcept Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::POOL_DESC Public Attributes inherited from D3D12MA::POOL_DESC POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CPOOL_DESC() [1/4]
@@ -264,7 +238,7 @@
-Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
+Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
@@ -320,7 +294,7 @@
-Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
+Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
@@ -330,7 +304,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 8eb5d11..da976da 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -104,7 +91,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index cb1fe74..714062b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,43 +90,36 @@
Inheritance diagram for D3D12MA::CVIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_ALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_ALLOCATION_DESC (const VIRTUAL_ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
CVIRTUAL_ALLOCATION_DESC (UINT64 size, UINT64 alignment, VIRTUAL_ALLOCATION_FLAGS flags=VIRTUAL_ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of a virtual allocation with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_ALLOCATION_DESC() [1/3]
@@ -241,7 +221,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index eeecc96..27af579 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index 78fbb71..e24e9a8 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,40 +90,34 @@
Inheritance diagram for D3D12MA::CVIRTUAL_BLOCK_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_BLOCK_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_BLOCK_DESC (const VIRTUAL_BLOCK_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_BLOCK_DESC structure.
CVIRTUAL_BLOCK_DESC (UINT64 size, VIRTUAL_BLOCK_FLAGS flags=VIRTUAL_BLOCK_FLAG_NONE, const ALLOCATION_CALLBACKS *allocationCallbacks=NULL) noexcept Constructor initializing description of a virtual block with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_BLOCK_DESC() [1/3]
@@ -233,7 +214,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
index 698ab11..69adefa 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
index c65cd1a..242a2ed 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_FLAGS Flags Flags.
UINT64 MaxBytesPerPass Maximum numbers of bytes that can be copied during single pass, while moving allocations to different places.
UINT32 MaxAllocationsPerPass Maximum number of allocations that can be moved during single pass to a different place.
-Detailed Description
+Detailed Description
Parameters for defragmentation.
To be used with functions Allocator::BeginDefragmentation() and Pool::BeginDefragmentation().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -172,7 +156,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
index 4fed39a..f20848d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
index 8a8bf70..87c182e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_MOVE Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_MOVE_OPERATION Operation Operation to be performed on the allocation by DefragmentationContext::EndPass(). Default value is DEFRAGMENTATION_MOVE_OPERATION_COPY. You can modify it.
Allocation * pSrcAllocation Allocation that should be moved.
Allocation * pDstTmpAllocation Temporary allocation pointing to destination memory that will replace pSrcAllocation.
Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Detailed Description
+Detailed Description
Single move of an allocation to be done for defragmentation.
-Member Data Documentation
+Member Data Documentation
◆ Operation
@@ -143,9 +127,9 @@
-Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
-- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make
pSrcAllocation point to this memory.
+Temporary allocation pointing to destination memory that will replace pSrcAllocation.
+Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
+- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make pSrcAllocation point to this memory.
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
index 28aefc6..3e0a1e4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -99,7 +86,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
index 1212826..6e37ac2 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,19 +87,17 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT32 MoveCount Number of elements in the pMoves array.
Number of elements in the pMoves array.
DEFRAGMENTATION_MOVE * pMoves Array of moves to be performed by the user in the current defragmentation pass.
-Detailed Description
+Detailed Description
Parameters for incremental defragmentation steps.
To be used with function DefragmentationContext::BeginPass().
-Member Data Documentation
+Member Data Documentation
◆ MoveCount
@@ -125,7 +110,7 @@
-Number of elements in the pMoves array.
+Number of elements in the pMoves array.
@@ -142,12 +127,12 @@
Array of moves to be performed by the user in the current defragmentation pass.
-Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
+Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
For each element, you should:
-- Create a new resource in the place pointed by
pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
-- Store new resource in
pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
-- Copy data from the
pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
+- Create a new resource in the place pointed by pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
+- Store new resource in pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
+- Copy data from the pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
- Make sure these commands finished executing on the GPU.
Only then you can finish defragmentation pass by calling DefragmentationContext::EndPass(). After this call, the allocation will point to the new place in memory.
@@ -162,7 +147,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
index 6723fa3..be2d910 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
index b7f806d..220d0bd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_STATS Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,24 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 BytesMoved Total number of bytes that have been copied while moving allocations to different places.
UINT64 BytesFreed Total number of bytes that have been released to the system by freeing empty heaps.
UINT32 AllocationsMoved Number of allocations that have been moved to different places.
UINT32 HeapsFreed Number of empty ID3D12Heap objects that have been released to the system.
Number of empty ID3D12Heap objects that have been released to the system.
-Detailed Description
+Detailed Description
Statistics returned for defragmentation process by function DefragmentationContext::GetStats().
-Member Data Documentation
+Member Data Documentation
◆ AllocationsMoved
@@ -178,7 +161,7 @@
-Number of empty ID3D12Heap objects that have been released to the system.
+Number of empty ID3D12Heap objects that have been released to the system.
@@ -188,7 +171,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
index 9167002..13c5446 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
index f4f534a..88fa33d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DetailedStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,35 +87,29 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Basic statistics.
UINT UnusedRangeCount Number of free ranges of memory between allocations.
UINT64 AllocationSizeMin Smallest allocation size. UINT64_MAX if there are 0 allocations.
Smallest allocation size. UINT64_MAX if there are 0 allocations.
UINT64 AllocationSizeMax Largest allocation size. 0 if there are 0 allocations.
UINT64 UnusedRangeSizeMin Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
UINT64 UnusedRangeSizeMax Largest empty range size. 0 if there are 0 empty ranges.
-Detailed Description
+Detailed Description
More detailed statistics than D3D12MA::Statistics.
These are slower to calculate. Use for debugging purposes. See functions: D3D12MA::Allocator::CalculateStatistics(), D3D12MA::Pool::CalculateStatistics().
Averages are not provided because they can be easily calculated as:
UINT64 AllocationSizeAvg = DetailedStats.Statistics.AllocationBytes / detailedStats.Statistics.AllocationCount;
UINT64 UnusedBytes = DetailedStats.Statistics.BlockBytes - DetailedStats.Statistics.AllocationBytes;
UINT64 UnusedRangeSizeAvg = UnusedBytes / DetailedStats.UnusedRangeCount;
- Member Data Documentation
+ Member Data Documentation
◆ AllocationSizeMax
@@ -157,7 +138,7 @@
-Smallest allocation size. UINT64_MAX if there are 0 allocations.
+Smallest allocation size. UINT64_MAX if there are 0 allocations.
@@ -221,7 +202,7 @@
-Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
+Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
@@ -231,7 +212,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
index 2ae0d33..654ade6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
index fcb0f64..d812aff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::POOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,45 +90,36 @@
Inheritance diagram for D3D12MA::POOL_DESC:
-
-
-
+
Public Attributes
POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool.
-Member Data Documentation
+Member Data Documentation
◆ BlockSize
@@ -189,7 +167,7 @@
Heap flags to be used when allocating heaps of this pool.
-It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
+It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
It is recommended to also add D3D12MA_RECOMMENDED_POOL_FLAGS. You can specify additional flags if needed.
@@ -207,7 +185,7 @@
The parameters of memory heap where allocations of this pool should be placed.
-In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
+In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
@@ -224,7 +202,7 @@
Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
-Set to 0 to use default, which is UINT64_MAX, which means no limit.
+Set to 0 to use default, which is UINT64_MAX, which means no limit.
Set to same value as D3D12MA::POOL_DESC::MinBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.
@@ -293,10 +271,10 @@
Residency priority to be set for all allocations made in this pool. Optional.
-Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
-Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
-This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
-There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
+Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
+Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
+This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
+There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
@@ -306,7 +284,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
index a970156..67b61fe 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
index b7e7c30..853c2ff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Statistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,21 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT BlockCount Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
UINT AllocationCount Number of D3D12MA::Allocation objects allocated.
UINT64 BlockBytes Number of bytes allocated in memory blocks.
UINT64 AllocationBytes Total number of bytes occupied by all D3D12MA::Allocation objects.
-Detailed Description
+Detailed Description
Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total.
These are fast to calculate. See functions: D3D12MA::Allocator::GetBudget(), D3D12MA::Pool::GetStatistics().
-Member Data Documentation
+Member Data Documentation
◆ AllocationBytes
@@ -132,7 +115,7 @@
Total number of bytes occupied by all D3D12MA::Allocation objects.
-Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
+Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
@@ -149,7 +132,7 @@
Number of D3D12MA::Allocation objects allocated.
-Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
+Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
@@ -181,7 +164,7 @@
-Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
+Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
-
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
IDXGIAdapter3::QueryVideoMemoryInfo if possible.BlockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipeline state objects, descriptor heaps, command lists, or heaps and resources allocated outside of this library, if any. 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 656581f..9423c7f 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
-Generated by
1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 49c2950..cae7b08 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
-
+Public Member Functions | CALLOCATION_DESC ()=default | | | CALLOCATION_DESC (const ALLOCATION_DESC &o) noexcept | | | CALLOCATION_DESC (Pool *customPool, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept | | | Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE. | | ||||||||||||||||||
D3D12_HEAP_TYPE.
+Additional Inherited Members Public Attributes inherited from D3D12MA::ALLOCATION_DESC | Flags for the allocation. | | The type of memory heap where the new allocation should be placed. | | Additional heap flags to be used when allocating memory. | | Custom pool to place the new resource in. Optional. | | Custom general-purpose pointer that will be stored in D3D12MA::Allocation. | | Public Attributes inherited from D3D12MA::ALLOCATION_DESC | ALLOCATION_FLAGS | Flags | D3D12_HEAP_TYPE | HeapType | D3D12_HEAP_FLAGS | ExtraHeapFlags | Pool * | CustomPool | void * | pPrivateData | ||||||||||||||||
Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CALLOCATION_DESC() [1/4]
@@ -273,7 +251,7 @@
-Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
+Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.
@@ -283,7 +261,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
index 1cb0dea..66262d0 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -110,7 +97,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
index fb6bf6f..37f7330 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CPOOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,61 +90,48 @@
Inheritance diagram for D3D12MA::CPOOL_DESC:
-
-
-
+
Public Member Functions
CPOOL_DESC ()=default Default constructor. Leaves the structure uninitialized.
CPOOL_DESC (const POOL_DESC &o) noexcept Constructor initializing from the base D3D12MA::POOL_DESC structure.
CPOOL_DESC (D3D12_HEAP_TYPE heapType, D3D12_HEAP_FLAGS heapFlags, POOL_FLAGS flags=D3D12MA_RECOMMENDED_POOL_FLAGS, UINT64 blockSize=0, UINT minBlockCount=0, UINT maxBlockCount=UINT_MAX, D3D12_RESIDENCY_PRIORITY residencyPriority=D3D12_RESIDENCY_PRIORITY_NORMAL) noexcept Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
CPOOL_DESC (const D3D12_HEAP_PROPERTIES heapProperties, D3D12_HEAP_FLAGS heapFlags, POOL_FLAGS flags=D3D12MA_RECOMMENDED_POOL_FLAGS, UINT64 blockSize=0, UINT minBlockCount=0, UINT maxBlockCount=UINT_MAX, D3D12_RESIDENCY_PRIORITY residencyPriority=D3D12_RESIDENCY_PRIORITY_NORMAL) noexcept Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::POOL_DESC Public Attributes inherited from D3D12MA::POOL_DESC POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CPOOL_DESC() [1/4]
@@ -264,7 +238,7 @@
-Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
+Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
@@ -320,7 +294,7 @@
-Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
+Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
@@ -330,7 +304,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 8eb5d11..da976da 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -104,7 +91,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index cb1fe74..714062b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,43 +90,36 @@
Inheritance diagram for D3D12MA::CVIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_ALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_ALLOCATION_DESC (const VIRTUAL_ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
CVIRTUAL_ALLOCATION_DESC (UINT64 size, UINT64 alignment, VIRTUAL_ALLOCATION_FLAGS flags=VIRTUAL_ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of a virtual allocation with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_ALLOCATION_DESC() [1/3]
@@ -241,7 +221,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index eeecc96..27af579 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index 78fbb71..e24e9a8 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,40 +90,34 @@
Inheritance diagram for D3D12MA::CVIRTUAL_BLOCK_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_BLOCK_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_BLOCK_DESC (const VIRTUAL_BLOCK_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_BLOCK_DESC structure.
CVIRTUAL_BLOCK_DESC (UINT64 size, VIRTUAL_BLOCK_FLAGS flags=VIRTUAL_BLOCK_FLAG_NONE, const ALLOCATION_CALLBACKS *allocationCallbacks=NULL) noexcept Constructor initializing description of a virtual block with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_BLOCK_DESC() [1/3]
@@ -233,7 +214,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
index 698ab11..69adefa 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
index c65cd1a..242a2ed 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_FLAGS Flags Flags.
UINT64 MaxBytesPerPass Maximum numbers of bytes that can be copied during single pass, while moving allocations to different places.
UINT32 MaxAllocationsPerPass Maximum number of allocations that can be moved during single pass to a different place.
-Detailed Description
+Detailed Description
Parameters for defragmentation.
To be used with functions Allocator::BeginDefragmentation() and Pool::BeginDefragmentation().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -172,7 +156,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
index 4fed39a..f20848d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
index 8a8bf70..87c182e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_MOVE Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_MOVE_OPERATION Operation Operation to be performed on the allocation by DefragmentationContext::EndPass(). Default value is DEFRAGMENTATION_MOVE_OPERATION_COPY. You can modify it.
Allocation * pSrcAllocation Allocation that should be moved.
Allocation * pDstTmpAllocation Temporary allocation pointing to destination memory that will replace pSrcAllocation.
Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Detailed Description
+Detailed Description
Single move of an allocation to be done for defragmentation.
-Member Data Documentation
+Member Data Documentation
◆ Operation
@@ -143,9 +127,9 @@
-Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
-- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make
pSrcAllocation point to this memory.
+Temporary allocation pointing to destination memory that will replace pSrcAllocation.
+Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
+- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make pSrcAllocation point to this memory.
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
index 28aefc6..3e0a1e4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -99,7 +86,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
index 1212826..6e37ac2 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,19 +87,17 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT32 MoveCount Number of elements in the pMoves array.
Number of elements in the pMoves array.
DEFRAGMENTATION_MOVE * pMoves Array of moves to be performed by the user in the current defragmentation pass.
-Detailed Description
+Detailed Description
Parameters for incremental defragmentation steps.
To be used with function DefragmentationContext::BeginPass().
-Member Data Documentation
+Member Data Documentation
◆ MoveCount
@@ -125,7 +110,7 @@
-Number of elements in the pMoves array.
+Number of elements in the pMoves array.
@@ -142,12 +127,12 @@
Array of moves to be performed by the user in the current defragmentation pass.
-Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
+Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
For each element, you should:
-- Create a new resource in the place pointed by
pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
-- Store new resource in
pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
-- Copy data from the
pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
+- Create a new resource in the place pointed by pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
+- Store new resource in pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
+- Copy data from the pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
- Make sure these commands finished executing on the GPU.
Only then you can finish defragmentation pass by calling DefragmentationContext::EndPass(). After this call, the allocation will point to the new place in memory.
@@ -162,7 +147,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
index 6723fa3..be2d910 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
index b7f806d..220d0bd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_STATS Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,24 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 BytesMoved Total number of bytes that have been copied while moving allocations to different places.
UINT64 BytesFreed Total number of bytes that have been released to the system by freeing empty heaps.
UINT32 AllocationsMoved Number of allocations that have been moved to different places.
UINT32 HeapsFreed Number of empty ID3D12Heap objects that have been released to the system.
Number of empty ID3D12Heap objects that have been released to the system.
-Detailed Description
+Detailed Description
Statistics returned for defragmentation process by function DefragmentationContext::GetStats().
-Member Data Documentation
+Member Data Documentation
◆ AllocationsMoved
@@ -178,7 +161,7 @@
-Number of empty ID3D12Heap objects that have been released to the system.
+Number of empty ID3D12Heap objects that have been released to the system.
@@ -188,7 +171,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
index 9167002..13c5446 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
index f4f534a..88fa33d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DetailedStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,35 +87,29 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Basic statistics.
UINT UnusedRangeCount Number of free ranges of memory between allocations.
UINT64 AllocationSizeMin Smallest allocation size. UINT64_MAX if there are 0 allocations.
Smallest allocation size. UINT64_MAX if there are 0 allocations.
UINT64 AllocationSizeMax Largest allocation size. 0 if there are 0 allocations.
UINT64 UnusedRangeSizeMin Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
UINT64 UnusedRangeSizeMax Largest empty range size. 0 if there are 0 empty ranges.
-Detailed Description
+Detailed Description
More detailed statistics than D3D12MA::Statistics.
These are slower to calculate. Use for debugging purposes. See functions: D3D12MA::Allocator::CalculateStatistics(), D3D12MA::Pool::CalculateStatistics().
Averages are not provided because they can be easily calculated as:
UINT64 AllocationSizeAvg = DetailedStats.Statistics.AllocationBytes / detailedStats.Statistics.AllocationCount;
UINT64 UnusedBytes = DetailedStats.Statistics.BlockBytes - DetailedStats.Statistics.AllocationBytes;
UINT64 UnusedRangeSizeAvg = UnusedBytes / DetailedStats.UnusedRangeCount;
- Member Data Documentation
+ Member Data Documentation
◆ AllocationSizeMax
@@ -157,7 +138,7 @@
-Smallest allocation size. UINT64_MAX if there are 0 allocations.
+Smallest allocation size. UINT64_MAX if there are 0 allocations.
@@ -221,7 +202,7 @@
-Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
+Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
@@ -231,7 +212,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
index 2ae0d33..654ade6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
index fcb0f64..d812aff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::POOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,45 +90,36 @@
Inheritance diagram for D3D12MA::POOL_DESC:
-
-
-
+
Public Attributes
POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool.
-Member Data Documentation
+Member Data Documentation
◆ BlockSize
@@ -189,7 +167,7 @@
Heap flags to be used when allocating heaps of this pool.
-It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
+It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
It is recommended to also add D3D12MA_RECOMMENDED_POOL_FLAGS. You can specify additional flags if needed.
@@ -207,7 +185,7 @@
The parameters of memory heap where allocations of this pool should be placed.
-In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
+In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
@@ -224,7 +202,7 @@
Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
-Set to 0 to use default, which is UINT64_MAX, which means no limit.
+Set to 0 to use default, which is UINT64_MAX, which means no limit.
Set to same value as D3D12MA::POOL_DESC::MinBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.
@@ -293,10 +271,10 @@
Residency priority to be set for all allocations made in this pool. Optional.
-Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
-Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
-This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
-There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
+Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
+Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
+This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
+There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
@@ -306,7 +284,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
index a970156..67b61fe 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
index b7e7c30..853c2ff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Statistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,21 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT BlockCount Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
UINT AllocationCount Number of D3D12MA::Allocation objects allocated.
UINT64 BlockBytes Number of bytes allocated in memory blocks.
UINT64 AllocationBytes Total number of bytes occupied by all D3D12MA::Allocation objects.
-Detailed Description
+Detailed Description
Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total.
These are fast to calculate. See functions: D3D12MA::Allocator::GetBudget(), D3D12MA::Pool::GetStatistics().
-Member Data Documentation
+Member Data Documentation
◆ AllocationBytes
@@ -132,7 +115,7 @@
Total number of bytes occupied by all D3D12MA::Allocation objects.
-Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
+Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
@@ -149,7 +132,7 @@
Number of D3D12MA::Allocation objects allocated.
-Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
+Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
@@ -181,7 +164,7 @@
-Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
+Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
-
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
D3D12_HEAP_TYPE. 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
index 1cb0dea..66262d0 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
-Generated by
1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
index fb6bf6f..37f7330 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
-
+Public Member Functions | CPOOL_DESC ()=default | | | CPOOL_DESC (const POOL_DESC &o) noexcept | | | Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE. | | Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES. | | |||||||||||||||||||||
D3D12_HEAP_TYPE. D3D12_HEAP_PROPERTIES.
+Additional Inherited Members Public Attributes inherited from D3D12MA::POOL_DESC | Flags for the heap. | | The parameters of memory heap where allocations of this pool should be placed. | | Heap flags to be used when allocating heaps of this pool. | | Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional. | | Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional. | | Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional. | | Additional minimum alignment to be used for all allocations created from this pool. Can be 0. | | Additional parameter allowing pool to create resources with passed protected session. | | Residency priority to be set for all allocations made in this pool. Optional. | | Public Attributes inherited from D3D12MA::POOL_DESC | POOL_FLAGS | Flags | D3D12_HEAP_PROPERTIES | HeapProperties | D3D12_HEAP_FLAGS | HeapFlags | UINT64 | BlockSize | UINT | MinBlockCount | UINT | MaxBlockCount | UINT64 | MinAllocationAlignment | ID3D12ProtectedResourceSession * | pProtectedSession | D3D12_RESIDENCY_PRIORITY | ResidencyPriority | ||||||||||||||||||||||||
Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CPOOL_DESC() [1/4]
@@ -264,7 +238,7 @@
-Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
+Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.
@@ -320,7 +294,7 @@
-Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
+Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
@@ -330,7 +304,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 8eb5d11..da976da 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -104,7 +91,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index cb1fe74..714062b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,43 +90,36 @@
Inheritance diagram for D3D12MA::CVIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_ALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_ALLOCATION_DESC (const VIRTUAL_ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
CVIRTUAL_ALLOCATION_DESC (UINT64 size, UINT64 alignment, VIRTUAL_ALLOCATION_FLAGS flags=VIRTUAL_ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of a virtual allocation with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_ALLOCATION_DESC() [1/3]
@@ -241,7 +221,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index eeecc96..27af579 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index 78fbb71..e24e9a8 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,40 +90,34 @@
Inheritance diagram for D3D12MA::CVIRTUAL_BLOCK_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_BLOCK_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_BLOCK_DESC (const VIRTUAL_BLOCK_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_BLOCK_DESC structure.
CVIRTUAL_BLOCK_DESC (UINT64 size, VIRTUAL_BLOCK_FLAGS flags=VIRTUAL_BLOCK_FLAG_NONE, const ALLOCATION_CALLBACKS *allocationCallbacks=NULL) noexcept Constructor initializing description of a virtual block with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_BLOCK_DESC() [1/3]
@@ -233,7 +214,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
index 698ab11..69adefa 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
index c65cd1a..242a2ed 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_FLAGS Flags Flags.
UINT64 MaxBytesPerPass Maximum numbers of bytes that can be copied during single pass, while moving allocations to different places.
UINT32 MaxAllocationsPerPass Maximum number of allocations that can be moved during single pass to a different place.
-Detailed Description
+Detailed Description
Parameters for defragmentation.
To be used with functions Allocator::BeginDefragmentation() and Pool::BeginDefragmentation().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -172,7 +156,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
index 4fed39a..f20848d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
index 8a8bf70..87c182e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_MOVE Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_MOVE_OPERATION Operation Operation to be performed on the allocation by DefragmentationContext::EndPass(). Default value is DEFRAGMENTATION_MOVE_OPERATION_COPY. You can modify it.
Allocation * pSrcAllocation Allocation that should be moved.
Allocation * pDstTmpAllocation Temporary allocation pointing to destination memory that will replace pSrcAllocation.
Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Detailed Description
+Detailed Description
Single move of an allocation to be done for defragmentation.
-Member Data Documentation
+Member Data Documentation
◆ Operation
@@ -143,9 +127,9 @@
-Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
-- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make
pSrcAllocation point to this memory.
+Temporary allocation pointing to destination memory that will replace pSrcAllocation.
+Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
+- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make pSrcAllocation point to this memory.
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
index 28aefc6..3e0a1e4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -99,7 +86,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
index 1212826..6e37ac2 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,19 +87,17 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT32 MoveCount Number of elements in the pMoves array.
Number of elements in the pMoves array.
DEFRAGMENTATION_MOVE * pMoves Array of moves to be performed by the user in the current defragmentation pass.
-Detailed Description
+Detailed Description
Parameters for incremental defragmentation steps.
To be used with function DefragmentationContext::BeginPass().
-Member Data Documentation
+Member Data Documentation
◆ MoveCount
@@ -125,7 +110,7 @@
-Number of elements in the pMoves array.
+Number of elements in the pMoves array.
@@ -142,12 +127,12 @@
Array of moves to be performed by the user in the current defragmentation pass.
-Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
+Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
For each element, you should:
-- Create a new resource in the place pointed by
pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
-- Store new resource in
pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
-- Copy data from the
pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
+- Create a new resource in the place pointed by pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
+- Store new resource in pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
+- Copy data from the pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
- Make sure these commands finished executing on the GPU.
Only then you can finish defragmentation pass by calling DefragmentationContext::EndPass(). After this call, the allocation will point to the new place in memory.
@@ -162,7 +147,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
index 6723fa3..be2d910 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
index b7f806d..220d0bd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_STATS Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,24 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 BytesMoved Total number of bytes that have been copied while moving allocations to different places.
UINT64 BytesFreed Total number of bytes that have been released to the system by freeing empty heaps.
UINT32 AllocationsMoved Number of allocations that have been moved to different places.
UINT32 HeapsFreed Number of empty ID3D12Heap objects that have been released to the system.
Number of empty ID3D12Heap objects that have been released to the system.
-Detailed Description
+Detailed Description
Statistics returned for defragmentation process by function DefragmentationContext::GetStats().
-Member Data Documentation
+Member Data Documentation
◆ AllocationsMoved
@@ -178,7 +161,7 @@
-Number of empty ID3D12Heap objects that have been released to the system.
+Number of empty ID3D12Heap objects that have been released to the system.
@@ -188,7 +171,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
index 9167002..13c5446 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
index f4f534a..88fa33d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DetailedStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,35 +87,29 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Basic statistics.
UINT UnusedRangeCount Number of free ranges of memory between allocations.
UINT64 AllocationSizeMin Smallest allocation size. UINT64_MAX if there are 0 allocations.
Smallest allocation size. UINT64_MAX if there are 0 allocations.
UINT64 AllocationSizeMax Largest allocation size. 0 if there are 0 allocations.
UINT64 UnusedRangeSizeMin Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
UINT64 UnusedRangeSizeMax Largest empty range size. 0 if there are 0 empty ranges.
-Detailed Description
+Detailed Description
More detailed statistics than D3D12MA::Statistics.
These are slower to calculate. Use for debugging purposes. See functions: D3D12MA::Allocator::CalculateStatistics(), D3D12MA::Pool::CalculateStatistics().
Averages are not provided because they can be easily calculated as:
UINT64 AllocationSizeAvg = DetailedStats.Statistics.AllocationBytes / detailedStats.Statistics.AllocationCount;
UINT64 UnusedBytes = DetailedStats.Statistics.BlockBytes - DetailedStats.Statistics.AllocationBytes;
UINT64 UnusedRangeSizeAvg = UnusedBytes / DetailedStats.UnusedRangeCount;
- Member Data Documentation
+ Member Data Documentation
◆ AllocationSizeMax
@@ -157,7 +138,7 @@
-Smallest allocation size. UINT64_MAX if there are 0 allocations.
+Smallest allocation size. UINT64_MAX if there are 0 allocations.
@@ -221,7 +202,7 @@
-Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
+Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
@@ -231,7 +212,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
index 2ae0d33..654ade6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
index fcb0f64..d812aff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::POOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,45 +90,36 @@
Inheritance diagram for D3D12MA::POOL_DESC:
-
-
-
+
Public Attributes
POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool.
-Member Data Documentation
+Member Data Documentation
◆ BlockSize
@@ -189,7 +167,7 @@
Heap flags to be used when allocating heaps of this pool.
-It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
+It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
It is recommended to also add D3D12MA_RECOMMENDED_POOL_FLAGS. You can specify additional flags if needed.
@@ -207,7 +185,7 @@
The parameters of memory heap where allocations of this pool should be placed.
-In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
+In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
@@ -224,7 +202,7 @@
Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
-Set to 0 to use default, which is UINT64_MAX, which means no limit.
+Set to 0 to use default, which is UINT64_MAX, which means no limit.
Set to same value as D3D12MA::POOL_DESC::MinBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.
@@ -293,10 +271,10 @@
Residency priority to be set for all allocations made in this pool. Optional.
-Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
-Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
-This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
-There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
+Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
+Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
+This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
+There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
@@ -306,7 +284,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
index a970156..67b61fe 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
index b7e7c30..853c2ff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Statistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,21 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT BlockCount Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
UINT AllocationCount Number of D3D12MA::Allocation objects allocated.
UINT64 BlockBytes Number of bytes allocated in memory blocks.
UINT64 AllocationBytes Total number of bytes occupied by all D3D12MA::Allocation objects.
-Detailed Description
+Detailed Description
Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total.
These are fast to calculate. See functions: D3D12MA::Allocator::GetBudget(), D3D12MA::Pool::GetStatistics().
-Member Data Documentation
+Member Data Documentation
◆ AllocationBytes
@@ -132,7 +115,7 @@
Total number of bytes occupied by all D3D12MA::Allocation objects.
-Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
+Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
@@ -149,7 +132,7 @@
Number of D3D12MA::Allocation objects allocated.
-Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
+Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
@@ -181,7 +164,7 @@
-Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
+Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
-
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
D3D12_HEAP_TYPE. Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.
@@ -330,7 +304,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index 8eb5d11..da976da 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -104,7 +91,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index cb1fe74..714062b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,43 +90,36 @@
Inheritance diagram for D3D12MA::CVIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_ALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_ALLOCATION_DESC (const VIRTUAL_ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
CVIRTUAL_ALLOCATION_DESC (UINT64 size, UINT64 alignment, VIRTUAL_ALLOCATION_FLAGS flags=VIRTUAL_ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of a virtual allocation with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_ALLOCATION_DESC() [1/3]
@@ -241,7 +221,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index eeecc96..27af579 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index 78fbb71..e24e9a8 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::CVIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,40 +90,34 @@
Inheritance diagram for D3D12MA::CVIRTUAL_BLOCK_DESC:
-
-
-
+
Public Member Functions
CVIRTUAL_BLOCK_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_BLOCK_DESC (const VIRTUAL_BLOCK_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_BLOCK_DESC structure.
CVIRTUAL_BLOCK_DESC (UINT64 size, VIRTUAL_BLOCK_FLAGS flags=VIRTUAL_BLOCK_FLAG_NONE, const ALLOCATION_CALLBACKS *allocationCallbacks=NULL) noexcept Constructor initializing description of a virtual block with given parameters.
-
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_BLOCK_DESC() [1/3]
@@ -233,7 +214,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
index 698ab11..69adefa 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
index c65cd1a..242a2ed 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_FLAGS Flags Flags.
UINT64 MaxBytesPerPass Maximum numbers of bytes that can be copied during single pass, while moving allocations to different places.
UINT32 MaxAllocationsPerPass Maximum number of allocations that can be moved during single pass to a different place.
-Detailed Description
+Detailed Description
Parameters for defragmentation.
To be used with functions Allocator::BeginDefragmentation() and Pool::BeginDefragmentation().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -172,7 +156,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
index 4fed39a..f20848d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
index 8a8bf70..87c182e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_MOVE Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_MOVE_OPERATION Operation Operation to be performed on the allocation by DefragmentationContext::EndPass(). Default value is DEFRAGMENTATION_MOVE_OPERATION_COPY. You can modify it.
Allocation * pSrcAllocation Allocation that should be moved.
Allocation * pDstTmpAllocation Temporary allocation pointing to destination memory that will replace pSrcAllocation.
Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Detailed Description
+Detailed Description
Single move of an allocation to be done for defragmentation.
-Member Data Documentation
+Member Data Documentation
◆ Operation
@@ -143,9 +127,9 @@
-Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
-- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make
pSrcAllocation point to this memory.
+Temporary allocation pointing to destination memory that will replace pSrcAllocation.
+Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
+- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make pSrcAllocation point to this memory.
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
index 28aefc6..3e0a1e4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -99,7 +86,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
index 1212826..6e37ac2 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,19 +87,17 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT32 MoveCount Number of elements in the pMoves array.
Number of elements in the pMoves array.
DEFRAGMENTATION_MOVE * pMoves Array of moves to be performed by the user in the current defragmentation pass.
-Detailed Description
+Detailed Description
Parameters for incremental defragmentation steps.
To be used with function DefragmentationContext::BeginPass().
-Member Data Documentation
+Member Data Documentation
◆ MoveCount
@@ -125,7 +110,7 @@
-Number of elements in the pMoves array.
+Number of elements in the pMoves array.
@@ -142,12 +127,12 @@
Array of moves to be performed by the user in the current defragmentation pass.
-Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
+Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
For each element, you should:
-- Create a new resource in the place pointed by
pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
-- Store new resource in
pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
-- Copy data from the
pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
+- Create a new resource in the place pointed by pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
+- Store new resource in pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
+- Copy data from the pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
- Make sure these commands finished executing on the GPU.
Only then you can finish defragmentation pass by calling DefragmentationContext::EndPass(). After this call, the allocation will point to the new place in memory.
@@ -162,7 +147,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
index 6723fa3..be2d910 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
index b7f806d..220d0bd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_STATS Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,24 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 BytesMoved Total number of bytes that have been copied while moving allocations to different places.
UINT64 BytesFreed Total number of bytes that have been released to the system by freeing empty heaps.
UINT32 AllocationsMoved Number of allocations that have been moved to different places.
UINT32 HeapsFreed Number of empty ID3D12Heap objects that have been released to the system.
Number of empty ID3D12Heap objects that have been released to the system.
-Detailed Description
+Detailed Description
Statistics returned for defragmentation process by function DefragmentationContext::GetStats().
-Member Data Documentation
+Member Data Documentation
◆ AllocationsMoved
@@ -178,7 +161,7 @@
-Number of empty ID3D12Heap objects that have been released to the system.
+Number of empty ID3D12Heap objects that have been released to the system.
@@ -188,7 +171,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
index 9167002..13c5446 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
index f4f534a..88fa33d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DetailedStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,35 +87,29 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Basic statistics.
UINT UnusedRangeCount Number of free ranges of memory between allocations.
UINT64 AllocationSizeMin Smallest allocation size. UINT64_MAX if there are 0 allocations.
Smallest allocation size. UINT64_MAX if there are 0 allocations.
UINT64 AllocationSizeMax Largest allocation size. 0 if there are 0 allocations.
UINT64 UnusedRangeSizeMin Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
UINT64 UnusedRangeSizeMax Largest empty range size. 0 if there are 0 empty ranges.
-Detailed Description
+Detailed Description
More detailed statistics than D3D12MA::Statistics.
These are slower to calculate. Use for debugging purposes. See functions: D3D12MA::Allocator::CalculateStatistics(), D3D12MA::Pool::CalculateStatistics().
Averages are not provided because they can be easily calculated as:
UINT64 AllocationSizeAvg = DetailedStats.Statistics.AllocationBytes / detailedStats.Statistics.AllocationCount;
UINT64 UnusedBytes = DetailedStats.Statistics.BlockBytes - DetailedStats.Statistics.AllocationBytes;
UINT64 UnusedRangeSizeAvg = UnusedBytes / DetailedStats.UnusedRangeCount;
- Member Data Documentation
+ Member Data Documentation
◆ AllocationSizeMax
@@ -157,7 +138,7 @@
-Smallest allocation size. UINT64_MAX if there are 0 allocations.
+Smallest allocation size. UINT64_MAX if there are 0 allocations.
@@ -221,7 +202,7 @@
-Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
+Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
@@ -231,7 +212,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
index 2ae0d33..654ade6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
index fcb0f64..d812aff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::POOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,45 +90,36 @@
Inheritance diagram for D3D12MA::POOL_DESC:
-
-
-
+
Public Attributes
POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool.
-Member Data Documentation
+Member Data Documentation
◆ BlockSize
@@ -189,7 +167,7 @@
Heap flags to be used when allocating heaps of this pool.
-It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
+It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
It is recommended to also add D3D12MA_RECOMMENDED_POOL_FLAGS. You can specify additional flags if needed.
@@ -207,7 +185,7 @@
The parameters of memory heap where allocations of this pool should be placed.
-In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
+In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
@@ -224,7 +202,7 @@
Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
-Set to 0 to use default, which is UINT64_MAX, which means no limit.
+Set to 0 to use default, which is UINT64_MAX, which means no limit.
Set to same value as D3D12MA::POOL_DESC::MinBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.
@@ -293,10 +271,10 @@
Residency priority to be set for all allocations made in this pool. Optional.
-Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
-Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
-This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
-There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
+Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
+Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
+This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
+There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
@@ -306,7 +284,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
index a970156..67b61fe 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
index b7e7c30..853c2ff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Statistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,21 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT BlockCount Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
UINT AllocationCount Number of D3D12MA::Allocation objects allocated.
UINT64 BlockBytes Number of bytes allocated in memory blocks.
UINT64 AllocationBytes Total number of bytes occupied by all D3D12MA::Allocation objects.
-Detailed Description
+Detailed Description
Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total.
These are fast to calculate. See functions: D3D12MA::Allocator::GetBudget(), D3D12MA::Pool::GetStatistics().
-Member Data Documentation
+Member Data Documentation
◆ AllocationBytes
@@ -132,7 +115,7 @@
Total number of bytes occupied by all D3D12MA::Allocation objects.
-Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
+Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
@@ -149,7 +132,7 @@
Number of D3D12MA::Allocation objects allocated.
-Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
+Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
@@ -181,7 +164,7 @@
-Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
+Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
-
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
-
+
Public Member Functions
CVIRTUAL_ALLOCATION_DESC ()=default Default constructor. Leaves the structure uninitialized.
CVIRTUAL_ALLOCATION_DESC (const VIRTUAL_ALLOCATION_DESC &o) noexcept Constructor initializing from the base D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
CVIRTUAL_ALLOCATION_DESC (UINT64 size, UINT64 alignment, VIRTUAL_ALLOCATION_FLAGS flags=VIRTUAL_ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept Constructor initializing description of a virtual allocation with given parameters.
Public Member Functions
+
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESC VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
Additional Inherited Members
Public Attributes inherited from D3D12MA::VIRTUAL_ALLOCATION_DESCHelper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure.
- 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index eeecc96..27af579 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
-Generated by
1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index 78fbb71..e24e9a8 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
-
+Public Member Functions | CVIRTUAL_BLOCK_DESC ()=default | | | CVIRTUAL_BLOCK_DESC (const VIRTUAL_BLOCK_DESC &o) noexcept | | | CVIRTUAL_BLOCK_DESC (UINT64 size, VIRTUAL_BLOCK_FLAGS flags=VIRTUAL_BLOCK_FLAG_NONE, const ALLOCATION_CALLBACKS *allocationCallbacks=NULL) noexcept | | | ||||||||||||
+Additional Inherited Members Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC | Flags. | | Total size of the block. | | Custom CPU memory allocation callbacks. Optional. | | Public Attributes inherited from D3D12MA::VIRTUAL_BLOCK_DESC | VIRTUAL_BLOCK_FLAGS | Flags | UINT64 | Size | const ALLOCATION_CALLBACKS * | pAllocationCallbacks | ||||||||||||
Detailed Description
+Detailed Description
Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure.
-Constructor & Destructor Documentation
+Constructor & Destructor Documentation
◆ CVIRTUAL_BLOCK_DESC() [1/3]
@@ -233,7 +214,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
index 698ab11..69adefa 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
index c65cd1a..242a2ed 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_FLAGS Flags Flags.
UINT64 MaxBytesPerPass Maximum numbers of bytes that can be copied during single pass, while moving allocations to different places.
UINT32 MaxAllocationsPerPass Maximum number of allocations that can be moved during single pass to a different place.
-Detailed Description
+Detailed Description
Parameters for defragmentation.
To be used with functions Allocator::BeginDefragmentation() and Pool::BeginDefragmentation().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -172,7 +156,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
index 4fed39a..f20848d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
index 8a8bf70..87c182e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_MOVE Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DEFRAGMENTATION_MOVE_OPERATION Operation Operation to be performed on the allocation by DefragmentationContext::EndPass(). Default value is DEFRAGMENTATION_MOVE_OPERATION_COPY. You can modify it.
Allocation * pSrcAllocation Allocation that should be moved.
Allocation * pDstTmpAllocation Temporary allocation pointing to destination memory that will replace pSrcAllocation.
Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Detailed Description
+Detailed Description
Single move of an allocation to be done for defragmentation.
-Member Data Documentation
+Member Data Documentation
◆ Operation
@@ -143,9 +127,9 @@
-Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
-- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make
pSrcAllocation point to this memory.
+Temporary allocation pointing to destination memory that will replace pSrcAllocation.
+Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
+- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make pSrcAllocation point to this memory.
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
index 28aefc6..3e0a1e4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -99,7 +86,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
index 1212826..6e37ac2 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,19 +87,17 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT32 MoveCount Number of elements in the pMoves array.
Number of elements in the pMoves array.
DEFRAGMENTATION_MOVE * pMoves Array of moves to be performed by the user in the current defragmentation pass.
-Detailed Description
+Detailed Description
Parameters for incremental defragmentation steps.
To be used with function DefragmentationContext::BeginPass().
-Member Data Documentation
+Member Data Documentation
◆ MoveCount
@@ -125,7 +110,7 @@
-Number of elements in the pMoves array.
+Number of elements in the pMoves array.
@@ -142,12 +127,12 @@
Array of moves to be performed by the user in the current defragmentation pass.
-Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
+Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
For each element, you should:
-- Create a new resource in the place pointed by
pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
-- Store new resource in
pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
-- Copy data from the
pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
+- Create a new resource in the place pointed by pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
+- Store new resource in pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
+- Copy data from the pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
- Make sure these commands finished executing on the GPU.
Only then you can finish defragmentation pass by calling DefragmentationContext::EndPass(). After this call, the allocation will point to the new place in memory.
@@ -162,7 +147,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
index 6723fa3..be2d910 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
index b7f806d..220d0bd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_STATS Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,24 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 BytesMoved Total number of bytes that have been copied while moving allocations to different places.
UINT64 BytesFreed Total number of bytes that have been released to the system by freeing empty heaps.
UINT32 AllocationsMoved Number of allocations that have been moved to different places.
UINT32 HeapsFreed Number of empty ID3D12Heap objects that have been released to the system.
Number of empty ID3D12Heap objects that have been released to the system.
-Detailed Description
+Detailed Description
Statistics returned for defragmentation process by function DefragmentationContext::GetStats().
-Member Data Documentation
+Member Data Documentation
◆ AllocationsMoved
@@ -178,7 +161,7 @@
-Number of empty ID3D12Heap objects that have been released to the system.
+Number of empty ID3D12Heap objects that have been released to the system.
@@ -188,7 +171,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
index 9167002..13c5446 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
index f4f534a..88fa33d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DetailedStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,35 +87,29 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Basic statistics.
UINT UnusedRangeCount Number of free ranges of memory between allocations.
UINT64 AllocationSizeMin Smallest allocation size. UINT64_MAX if there are 0 allocations.
Smallest allocation size. UINT64_MAX if there are 0 allocations.
UINT64 AllocationSizeMax Largest allocation size. 0 if there are 0 allocations.
UINT64 UnusedRangeSizeMin Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
UINT64 UnusedRangeSizeMax Largest empty range size. 0 if there are 0 empty ranges.
-Detailed Description
+Detailed Description
More detailed statistics than D3D12MA::Statistics.
These are slower to calculate. Use for debugging purposes. See functions: D3D12MA::Allocator::CalculateStatistics(), D3D12MA::Pool::CalculateStatistics().
Averages are not provided because they can be easily calculated as:
UINT64 AllocationSizeAvg = DetailedStats.Statistics.AllocationBytes / detailedStats.Statistics.AllocationCount;
UINT64 UnusedBytes = DetailedStats.Statistics.BlockBytes - DetailedStats.Statistics.AllocationBytes;
UINT64 UnusedRangeSizeAvg = UnusedBytes / DetailedStats.UnusedRangeCount;
- Member Data Documentation
+ Member Data Documentation
◆ AllocationSizeMax
@@ -157,7 +138,7 @@
-Smallest allocation size. UINT64_MAX if there are 0 allocations.
+Smallest allocation size. UINT64_MAX if there are 0 allocations.
@@ -221,7 +202,7 @@
-Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
+Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
@@ -231,7 +212,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
index 2ae0d33..654ade6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
index fcb0f64..d812aff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::POOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,45 +90,36 @@
Inheritance diagram for D3D12MA::POOL_DESC:
-
-
-
+
Public Attributes
POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool.
-Member Data Documentation
+Member Data Documentation
◆ BlockSize
@@ -189,7 +167,7 @@
Heap flags to be used when allocating heaps of this pool.
-It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
+It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
It is recommended to also add D3D12MA_RECOMMENDED_POOL_FLAGS. You can specify additional flags if needed.
@@ -207,7 +185,7 @@
The parameters of memory heap where allocations of this pool should be placed.
-In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
+In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
@@ -224,7 +202,7 @@
Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
-Set to 0 to use default, which is UINT64_MAX, which means no limit.
+Set to 0 to use default, which is UINT64_MAX, which means no limit.
Set to same value as D3D12MA::POOL_DESC::MinBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.
@@ -293,10 +271,10 @@
Residency priority to be set for all allocations made in this pool. Optional.
-Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
-Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
-This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
-There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
+Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
+Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
+This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
+There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
@@ -306,7 +284,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
index a970156..67b61fe 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
index b7e7c30..853c2ff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Statistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,21 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT BlockCount Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
UINT AllocationCount Number of D3D12MA::Allocation objects allocated.
UINT64 BlockBytes Number of bytes allocated in memory blocks.
UINT64 AllocationBytes Total number of bytes occupied by all D3D12MA::Allocation objects.
-Detailed Description
+Detailed Description
Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total.
These are fast to calculate. See functions: D3D12MA::Allocator::GetBudget(), D3D12MA::Pool::GetStatistics().
-Member Data Documentation
+Member Data Documentation
◆ AllocationBytes
@@ -132,7 +115,7 @@
Total number of bytes occupied by all D3D12MA::Allocation objects.
-Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
+Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
@@ -149,7 +132,7 @@
Number of D3D12MA::Allocation objects allocated.
-Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
+Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
@@ -181,7 +164,7 @@
-Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
+Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
-
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
#include <D3D12MemAlloc.h>
+Public AttributesDEFRAGMENTATION_FLAGS | Flags | | UINT64 | MaxBytesPerPass | | UINT32 | MaxAllocationsPerPass | | | ||||||||||||
Detailed Description
+Detailed Description
Parameters for defragmentation.
To be used with functions Allocator::BeginDefragmentation() and Pool::BeginDefragmentation().
-Member Data Documentation
+ 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
index 4fed39a..f20848d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html
@@ -3,15 +3,13 @@
-
+
-Generated by
1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
index 8a8bf70..87c182e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html
@@ -3,15 +3,13 @@
-
+
#include <D3D12MemAlloc.h>
+Public AttributesDEFRAGMENTATION_MOVE_OPERATION | Operation | | Allocation * | pSrcAllocation | | | Temporary allocation pointing to destination memory that will replace pSrcAllocation. | | |||||||||||||||
pSrcAllocation. Detailed Description
+Detailed Description
Single move of an allocation to be done for defragmentation.
-Member Data Documentation
+Member Data Documentation
◆ Operation
@@ -143,9 +127,9 @@
-Temporary allocation pointing to destination memory that will replace pSrcAllocation.
-Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
-- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make
pSrcAllocation point to this memory.
+Temporary allocation pointing to destination memory that will replace pSrcAllocation.
+Use it to retrieve new ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().
+- Warning
- Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for storing newly created resource. DefragmentationContext::EndPass() will destroy it and make pSrcAllocation point to this memory.
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
index 28aefc6..3e0a1e4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -99,7 +86,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
index 1212826..6e37ac2 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,19 +87,17 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT32 MoveCount Number of elements in the pMoves array.
Number of elements in the pMoves array.
DEFRAGMENTATION_MOVE * pMoves Array of moves to be performed by the user in the current defragmentation pass.
-Detailed Description
+Detailed Description
Parameters for incremental defragmentation steps.
To be used with function DefragmentationContext::BeginPass().
-Member Data Documentation
+Member Data Documentation
◆ MoveCount
@@ -125,7 +110,7 @@
-Number of elements in the pMoves array.
+Number of elements in the pMoves array.
@@ -142,12 +127,12 @@
Array of moves to be performed by the user in the current defragmentation pass.
-Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
+Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
For each element, you should:
-- Create a new resource in the place pointed by
pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
-- Store new resource in
pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
-- Copy data from the
pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
+- Create a new resource in the place pointed by pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
+- Store new resource in pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
+- Copy data from the pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
- Make sure these commands finished executing on the GPU.
Only then you can finish defragmentation pass by calling DefragmentationContext::EndPass(). After this call, the allocation will point to the new place in memory.
@@ -162,7 +147,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
index 6723fa3..be2d910 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
index b7f806d..220d0bd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_STATS Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,24 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 BytesMoved Total number of bytes that have been copied while moving allocations to different places.
UINT64 BytesFreed Total number of bytes that have been released to the system by freeing empty heaps.
UINT32 AllocationsMoved Number of allocations that have been moved to different places.
UINT32 HeapsFreed Number of empty ID3D12Heap objects that have been released to the system.
Number of empty ID3D12Heap objects that have been released to the system.
-Detailed Description
+Detailed Description
Statistics returned for defragmentation process by function DefragmentationContext::GetStats().
-Member Data Documentation
+Member Data Documentation
◆ AllocationsMoved
@@ -178,7 +161,7 @@
-Number of empty ID3D12Heap objects that have been released to the system.
+Number of empty ID3D12Heap objects that have been released to the system.
@@ -188,7 +171,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
index 9167002..13c5446 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
index f4f534a..88fa33d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DetailedStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,35 +87,29 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Basic statistics.
UINT UnusedRangeCount Number of free ranges of memory between allocations.
UINT64 AllocationSizeMin Smallest allocation size. UINT64_MAX if there are 0 allocations.
Smallest allocation size. UINT64_MAX if there are 0 allocations.
UINT64 AllocationSizeMax Largest allocation size. 0 if there are 0 allocations.
UINT64 UnusedRangeSizeMin Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
UINT64 UnusedRangeSizeMax Largest empty range size. 0 if there are 0 empty ranges.
-Detailed Description
+Detailed Description
More detailed statistics than D3D12MA::Statistics.
These are slower to calculate. Use for debugging purposes. See functions: D3D12MA::Allocator::CalculateStatistics(), D3D12MA::Pool::CalculateStatistics().
Averages are not provided because they can be easily calculated as:
UINT64 AllocationSizeAvg = DetailedStats.Statistics.AllocationBytes / detailedStats.Statistics.AllocationCount;
UINT64 UnusedBytes = DetailedStats.Statistics.BlockBytes - DetailedStats.Statistics.AllocationBytes;
UINT64 UnusedRangeSizeAvg = UnusedBytes / DetailedStats.UnusedRangeCount;
- Member Data Documentation
+ Member Data Documentation
◆ AllocationSizeMax
@@ -157,7 +138,7 @@
-Smallest allocation size. UINT64_MAX if there are 0 allocations.
+Smallest allocation size. UINT64_MAX if there are 0 allocations.
@@ -221,7 +202,7 @@
-Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
+Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
@@ -231,7 +212,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
index 2ae0d33..654ade6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
index fcb0f64..d812aff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::POOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,45 +90,36 @@
Inheritance diagram for D3D12MA::POOL_DESC:
-
-
-
+
Public Attributes
POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool.
-Member Data Documentation
+Member Data Documentation
◆ BlockSize
@@ -189,7 +167,7 @@
Heap flags to be used when allocating heaps of this pool.
-It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
+It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
It is recommended to also add D3D12MA_RECOMMENDED_POOL_FLAGS. You can specify additional flags if needed.
@@ -207,7 +185,7 @@
The parameters of memory heap where allocations of this pool should be placed.
-In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
+In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
@@ -224,7 +202,7 @@
Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
-Set to 0 to use default, which is UINT64_MAX, which means no limit.
+Set to 0 to use default, which is UINT64_MAX, which means no limit.
Set to same value as D3D12MA::POOL_DESC::MinBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.
@@ -293,10 +271,10 @@
Residency priority to be set for all allocations made in this pool. Optional.
-Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
-Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
-This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
-There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
+Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
+Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
+This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
+There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
@@ -306,7 +284,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
index a970156..67b61fe 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
index b7e7c30..853c2ff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Statistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,21 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT BlockCount Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
UINT AllocationCount Number of D3D12MA::Allocation objects allocated.
UINT64 BlockBytes Number of bytes allocated in memory blocks.
UINT64 AllocationBytes Total number of bytes occupied by all D3D12MA::Allocation objects.
-Detailed Description
+Detailed Description
Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total.
These are fast to calculate. See functions: D3D12MA::Allocator::GetBudget(), D3D12MA::Pool::GetStatistics().
-Member Data Documentation
+Member Data Documentation
◆ AllocationBytes
@@ -132,7 +115,7 @@
Total number of bytes occupied by all D3D12MA::Allocation objects.
-Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
+Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
@@ -149,7 +132,7 @@
Number of D3D12MA::Allocation objects allocated.
-Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
+Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
@@ -181,7 +164,7 @@
-Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
+Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
-
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
pSrcAllocation. ID3D12Heap and offset to create new ID3D12Resource and then store it here via Allocation::SetResource().pSrcAllocation point to this memory. 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
index 28aefc6..3e0a1e4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
-Generated by
1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
index 1212826..6e37ac2 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
#include <D3D12MemAlloc.h>
+Public Attributes | Number of elements in the pMoves array. | DEFRAGMENTATION_MOVE * | pMoves | | | ||||||||||||
pMoves array. Detailed Description
+Detailed Description
Parameters for incremental defragmentation steps.
To be used with function DefragmentationContext::BeginPass().
-Member Data Documentation
+Member Data Documentation
◆ MoveCount
@@ -125,7 +110,7 @@
-Number of elements in the pMoves array.
+Number of elements in the pMoves array.
@@ -142,12 +127,12 @@
Array of moves to be performed by the user in the current defragmentation pass.
-Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
+Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
For each element, you should:
-- Create a new resource in the place pointed by
pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
-- Store new resource in
pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
-- Copy data from the
pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
+- Create a new resource in the place pointed by pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset().
+- Store new resource in pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation.
+- Copy data from the pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
- Make sure these commands finished executing on the GPU.
Only then you can finish defragmentation pass by calling DefragmentationContext::EndPass(). After this call, the allocation will point to the new place in memory.
@@ -162,7 +147,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
index 6723fa3..be2d910 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
index b7f806d..220d0bd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_STATS Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,24 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 BytesMoved Total number of bytes that have been copied while moving allocations to different places.
UINT64 BytesFreed Total number of bytes that have been released to the system by freeing empty heaps.
UINT32 AllocationsMoved Number of allocations that have been moved to different places.
UINT32 HeapsFreed Number of empty ID3D12Heap objects that have been released to the system.
Number of empty ID3D12Heap objects that have been released to the system.
-Detailed Description
+Detailed Description
Statistics returned for defragmentation process by function DefragmentationContext::GetStats().
-Member Data Documentation
+Member Data Documentation
◆ AllocationsMoved
@@ -178,7 +161,7 @@
-Number of empty ID3D12Heap objects that have been released to the system.
+Number of empty ID3D12Heap objects that have been released to the system.
@@ -188,7 +171,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
index 9167002..13c5446 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
index f4f534a..88fa33d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DetailedStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,35 +87,29 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Basic statistics.
UINT UnusedRangeCount Number of free ranges of memory between allocations.
UINT64 AllocationSizeMin Smallest allocation size. UINT64_MAX if there are 0 allocations.
Smallest allocation size. UINT64_MAX if there are 0 allocations.
UINT64 AllocationSizeMax Largest allocation size. 0 if there are 0 allocations.
UINT64 UnusedRangeSizeMin Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
UINT64 UnusedRangeSizeMax Largest empty range size. 0 if there are 0 empty ranges.
-Detailed Description
+Detailed Description
More detailed statistics than D3D12MA::Statistics.
These are slower to calculate. Use for debugging purposes. See functions: D3D12MA::Allocator::CalculateStatistics(), D3D12MA::Pool::CalculateStatistics().
Averages are not provided because they can be easily calculated as:
UINT64 AllocationSizeAvg = DetailedStats.Statistics.AllocationBytes / detailedStats.Statistics.AllocationCount;
UINT64 UnusedBytes = DetailedStats.Statistics.BlockBytes - DetailedStats.Statistics.AllocationBytes;
UINT64 UnusedRangeSizeAvg = UnusedBytes / DetailedStats.UnusedRangeCount;
- Member Data Documentation
+ Member Data Documentation
◆ AllocationSizeMax
@@ -157,7 +138,7 @@
-Smallest allocation size. UINT64_MAX if there are 0 allocations.
+Smallest allocation size. UINT64_MAX if there are 0 allocations.
@@ -221,7 +202,7 @@
-Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
+Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
@@ -231,7 +212,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
index 2ae0d33..654ade6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
index fcb0f64..d812aff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::POOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,45 +90,36 @@
Inheritance diagram for D3D12MA::POOL_DESC:
-
-
-
+
Public Attributes
POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool.
-Member Data Documentation
+Member Data Documentation
◆ BlockSize
@@ -189,7 +167,7 @@
Heap flags to be used when allocating heaps of this pool.
-It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
+It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
It is recommended to also add D3D12MA_RECOMMENDED_POOL_FLAGS. You can specify additional flags if needed.
@@ -207,7 +185,7 @@
The parameters of memory heap where allocations of this pool should be placed.
-In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
+In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
@@ -224,7 +202,7 @@
Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
-Set to 0 to use default, which is UINT64_MAX, which means no limit.
+Set to 0 to use default, which is UINT64_MAX, which means no limit.
Set to same value as D3D12MA::POOL_DESC::MinBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.
@@ -293,10 +271,10 @@
Residency priority to be set for all allocations made in this pool. Optional.
-Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
-Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
-This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
-There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
+Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
+Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
+This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
+There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
@@ -306,7 +284,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
index a970156..67b61fe 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
index b7e7c30..853c2ff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Statistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,21 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT BlockCount Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
UINT AllocationCount Number of D3D12MA::Allocation objects allocated.
UINT64 BlockBytes Number of bytes allocated in memory blocks.
UINT64 AllocationBytes Total number of bytes occupied by all D3D12MA::Allocation objects.
-Detailed Description
+Detailed Description
Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total.
These are fast to calculate. See functions: D3D12MA::Allocator::GetBudget(), D3D12MA::Pool::GetStatistics().
-Member Data Documentation
+Member Data Documentation
◆ AllocationBytes
@@ -132,7 +115,7 @@
Total number of bytes occupied by all D3D12MA::Allocation objects.
-Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
+Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
@@ -149,7 +132,7 @@
Number of D3D12MA::Allocation objects allocated.
-Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
+Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
@@ -181,7 +164,7 @@
-Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
+Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
-
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
pMoves array. Array of moves to be performed by the user in the current defragmentation pass.
-Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
Pointer to an array of MoveCount elements, owned by D3D12MA, created in DefragmentationContext::BeginPass(), destroyed in DefragmentationContext::EndPass().
For each element, you should:
-
-
- Create a new resource in the place pointed by
pMoves[i].pDstTmpAllocation->GetHeap()+pMoves[i].pDstTmpAllocation->GetOffset().
- - Store new resource in
pMoves[i].pDstTmpAllocationby using Allocation::SetResource(). It will later replace old resource frompMoves[i].pSrcAllocation.
- - Copy data from the
pMoves[i].pSrcAllocatione.g. usingD3D12GraphicsCommandList::CopyResource.
+ - Create a new resource in the place pointed by pMoves[i].pDstTmpAllocation->GetHeap() + pMoves[i].pDstTmpAllocation->GetOffset(). +
- Store new resource in pMoves[i].pDstTmpAllocation by using Allocation::SetResource(). It will later replace old resource from pMoves[i].pSrcAllocation. +
- Copy data from the pMoves[i].pSrcAllocation e.g. using D3D12GraphicsCommandList::CopyResource.
- Make sure these commands finished executing on the GPU.
Only then you can finish defragmentation pass by calling DefragmentationContext::EndPass(). After this call, the allocation will point to the new place in memory.
@@ -162,7 +147,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
index 6723fa3..be2d910 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
index b7f806d..220d0bd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_d_e_f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_STATS Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,24 +87,20 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 BytesMoved Total number of bytes that have been copied while moving allocations to different places.
UINT64 BytesFreed Total number of bytes that have been released to the system by freeing empty heaps.
UINT32 AllocationsMoved Number of allocations that have been moved to different places.
UINT32 HeapsFreed Number of empty ID3D12Heap objects that have been released to the system.
Number of empty ID3D12Heap objects that have been released to the system.
-Detailed Description
+Detailed Description
Statistics returned for defragmentation process by function DefragmentationContext::GetStats().
-Member Data Documentation
+Member Data Documentation
◆ AllocationsMoved
@@ -178,7 +161,7 @@
-Number of empty ID3D12Heap objects that have been released to the system.
+Number of empty ID3D12Heap objects that have been released to the system.
@@ -188,7 +171,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
index 9167002..13c5446 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
index f4f534a..88fa33d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DetailedStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,35 +87,29 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Basic statistics.
UINT UnusedRangeCount Number of free ranges of memory between allocations.
UINT64 AllocationSizeMin Smallest allocation size. UINT64_MAX if there are 0 allocations.
Smallest allocation size. UINT64_MAX if there are 0 allocations.
UINT64 AllocationSizeMax Largest allocation size. 0 if there are 0 allocations.
UINT64 UnusedRangeSizeMin Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
UINT64 UnusedRangeSizeMax Largest empty range size. 0 if there are 0 empty ranges.
-Detailed Description
+Detailed Description
More detailed statistics than D3D12MA::Statistics.
These are slower to calculate. Use for debugging purposes. See functions: D3D12MA::Allocator::CalculateStatistics(), D3D12MA::Pool::CalculateStatistics().
Averages are not provided because they can be easily calculated as:
UINT64 AllocationSizeAvg = DetailedStats.Statistics.AllocationBytes / detailedStats.Statistics.AllocationCount;
UINT64 UnusedBytes = DetailedStats.Statistics.BlockBytes - DetailedStats.Statistics.AllocationBytes;
UINT64 UnusedRangeSizeAvg = UnusedBytes / DetailedStats.UnusedRangeCount;
- Member Data Documentation
+ Member Data Documentation
◆ AllocationSizeMax
@@ -157,7 +138,7 @@
-Smallest allocation size. UINT64_MAX if there are 0 allocations.
+Smallest allocation size. UINT64_MAX if there are 0 allocations.
@@ -221,7 +202,7 @@
-Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
+Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
@@ -231,7 +212,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
index 2ae0d33..654ade6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
index fcb0f64..d812aff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::POOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,45 +90,36 @@
Inheritance diagram for D3D12MA::POOL_DESC:
-
-
-
+
Public Attributes
POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool.
-Member Data Documentation
+Member Data Documentation
◆ BlockSize
@@ -189,7 +167,7 @@
Heap flags to be used when allocating heaps of this pool.
-It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
+It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
It is recommended to also add D3D12MA_RECOMMENDED_POOL_FLAGS. You can specify additional flags if needed.
@@ -207,7 +185,7 @@
The parameters of memory heap where allocations of this pool should be placed.
-In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
+In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
@@ -224,7 +202,7 @@
Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
-Set to 0 to use default, which is UINT64_MAX, which means no limit.
+Set to 0 to use default, which is UINT64_MAX, which means no limit.
Set to same value as D3D12MA::POOL_DESC::MinBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.
@@ -293,10 +271,10 @@
Residency priority to be set for all allocations made in this pool. Optional.
-Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
-Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
-This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
-There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
+Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
+Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
+This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
+There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
@@ -306,7 +284,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
index a970156..67b61fe 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
index b7e7c30..853c2ff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Statistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,21 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT BlockCount Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
UINT AllocationCount Number of D3D12MA::Allocation objects allocated.
UINT64 BlockBytes Number of bytes allocated in memory blocks.
UINT64 AllocationBytes Total number of bytes occupied by all D3D12MA::Allocation objects.
-Detailed Description
+Detailed Description
Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total.
These are fast to calculate. See functions: D3D12MA::Allocator::GetBudget(), D3D12MA::Pool::GetStatistics().
-Member Data Documentation
+Member Data Documentation
◆ AllocationBytes
@@ -132,7 +115,7 @@
Total number of bytes occupied by all D3D12MA::Allocation objects.
-Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
+Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
@@ -149,7 +132,7 @@
Number of D3D12MA::Allocation objects allocated.
-Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
+Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
@@ -181,7 +164,7 @@
-Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
+Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
-
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
#include <D3D12MemAlloc.h>
+Public AttributesUINT64 | BytesMoved | | UINT64 | BytesFreed | | UINT32 | AllocationsMoved | | | Number of empty ID3D12Heap objects that have been released to the system. | | ||||||||||||||||||
ID3D12Heap objects that have been released to the system. Detailed Description
+Detailed Description
Statistics returned for defragmentation process by function DefragmentationContext::GetStats().
-Member Data Documentation
+Number of empty ID3D12Heap objects that have been released to the system.
Number of empty ID3D12Heap objects that have been released to the system.
@@ -188,7 +171,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
index 9167002..13c5446 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,7 +90,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
index f4f534a..88fa33d 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_detailed_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::DetailedStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,35 +87,29 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
Statistics Stats Basic statistics.
UINT UnusedRangeCount Number of free ranges of memory between allocations.
UINT64 AllocationSizeMin Smallest allocation size. UINT64_MAX if there are 0 allocations.
Smallest allocation size. UINT64_MAX if there are 0 allocations.
UINT64 AllocationSizeMax Largest allocation size. 0 if there are 0 allocations.
UINT64 UnusedRangeSizeMin Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
UINT64 UnusedRangeSizeMax Largest empty range size. 0 if there are 0 empty ranges.
-Detailed Description
+Detailed Description
More detailed statistics than D3D12MA::Statistics.
These are slower to calculate. Use for debugging purposes. See functions: D3D12MA::Allocator::CalculateStatistics(), D3D12MA::Pool::CalculateStatistics().
Averages are not provided because they can be easily calculated as:
UINT64 AllocationSizeAvg = DetailedStats.Statistics.AllocationBytes / detailedStats.Statistics.AllocationCount;
UINT64 UnusedBytes = DetailedStats.Statistics.BlockBytes - DetailedStats.Statistics.AllocationBytes;
UINT64 UnusedRangeSizeAvg = UnusedBytes / DetailedStats.UnusedRangeCount;
- Member Data Documentation
+ Member Data Documentation
◆ AllocationSizeMax
@@ -157,7 +138,7 @@
-Smallest allocation size. UINT64_MAX if there are 0 allocations.
+Smallest allocation size. UINT64_MAX if there are 0 allocations.
@@ -221,7 +202,7 @@
-Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
+Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
@@ -231,7 +212,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
index 2ae0d33..654ade6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
index fcb0f64..d812aff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::POOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,45 +90,36 @@
Inheritance diagram for D3D12MA::POOL_DESC:
-
-
-
+
Public Attributes
POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool.
-Member Data Documentation
+Member Data Documentation
◆ BlockSize
@@ -189,7 +167,7 @@
Heap flags to be used when allocating heaps of this pool.
-It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
+It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
It is recommended to also add D3D12MA_RECOMMENDED_POOL_FLAGS. You can specify additional flags if needed.
@@ -207,7 +185,7 @@
The parameters of memory heap where allocations of this pool should be placed.
-In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
+In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
@@ -224,7 +202,7 @@
Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
-Set to 0 to use default, which is UINT64_MAX, which means no limit.
+Set to 0 to use default, which is UINT64_MAX, which means no limit.
Set to same value as D3D12MA::POOL_DESC::MinBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.
@@ -293,10 +271,10 @@
Residency priority to be set for all allocations made in this pool. Optional.
-Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
-Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
-This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
-There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
+Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
+Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
+This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
+There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
@@ -306,7 +284,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
index a970156..67b61fe 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
index b7e7c30..853c2ff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Statistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,21 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT BlockCount Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
UINT AllocationCount Number of D3D12MA::Allocation objects allocated.
UINT64 BlockBytes Number of bytes allocated in memory blocks.
UINT64 AllocationBytes Total number of bytes occupied by all D3D12MA::Allocation objects.
-Detailed Description
+Detailed Description
Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total.
These are fast to calculate. See functions: D3D12MA::Allocator::GetBudget(), D3D12MA::Pool::GetStatistics().
-Member Data Documentation
+Member Data Documentation
◆ AllocationBytes
@@ -132,7 +115,7 @@
Total number of bytes occupied by all D3D12MA::Allocation objects.
-Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
+Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
@@ -149,7 +132,7 @@
Number of D3D12MA::Allocation objects allocated.
-Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
+Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
@@ -181,7 +164,7 @@
-Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
+Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
-
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
#include <D3D12MemAlloc.h>
+Public AttributesStatistics | Stats | | UINT | UnusedRangeCount | | | Smallest allocation size. UINT64_MAX if there are 0 allocations. | UINT64 | AllocationSizeMax | | | Smallest empty range size. UINT64_MAX if there are 0 empty ranges. | UINT64 | UnusedRangeSizeMax | | | |||||||||||||||||||||||||||
UINT64_MAX if there are 0 allocations. UINT64_MAX if there are 0 empty ranges. Detailed Description
+Detailed Description
More detailed statistics than D3D12MA::Statistics.
These are slower to calculate. Use for debugging purposes. See functions: D3D12MA::Allocator::CalculateStatistics(), D3D12MA::Pool::CalculateStatistics().
Averages are not provided because they can be easily calculated as:
Member Data Documentation
+Smallest allocation size. UINT64_MAX if there are 0 allocations.
Smallest allocation size. UINT64_MAX if there are 0 allocations.
@@ -221,7 +202,7 @@
-Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
+Smallest empty range size. UINT64_MAX if there are 0 empty ranges.
@@ -231,7 +212,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
index 2ae0d33..654ade6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -106,7 +93,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
index fcb0f64..d812aff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::POOL_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,45 +90,36 @@
Inheritance diagram for D3D12MA::POOL_DESC:
-
-
-
+
Public Attributes
POOL_FLAGS Flags Flags for the heap.
D3D12_HEAP_PROPERTIES HeapProperties The parameters of memory heap where allocations of this pool should be placed.
D3D12_HEAP_FLAGS HeapFlags Heap flags to be used when allocating heaps of this pool.
UINT64 BlockSize Size of a single heap (memory block) to be allocated as part of this pool, in bytes. Optional.
UINT MinBlockCount Minimum number of heaps (memory blocks) to be always allocated in this pool, even if they stay empty. Optional.
UINT MaxBlockCount Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
UINT64 MinAllocationAlignment Additional minimum alignment to be used for all allocations created from this pool. Can be 0.
ID3D12ProtectedResourceSession * pProtectedSession Additional parameter allowing pool to create resources with passed protected session.
D3D12_RESIDENCY_PRIORITY ResidencyPriority Residency priority to be set for all allocations made in this pool. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool.
-Member Data Documentation
+Member Data Documentation
◆ BlockSize
@@ -189,7 +167,7 @@
Heap flags to be used when allocating heaps of this pool.
-It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
+It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
It is recommended to also add D3D12MA_RECOMMENDED_POOL_FLAGS. You can specify additional flags if needed.
@@ -207,7 +185,7 @@
The parameters of memory heap where allocations of this pool should be placed.
-In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
+In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
@@ -224,7 +202,7 @@
Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
-Set to 0 to use default, which is UINT64_MAX, which means no limit.
+Set to 0 to use default, which is UINT64_MAX, which means no limit.
Set to same value as D3D12MA::POOL_DESC::MinBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.
@@ -293,10 +271,10 @@
Residency priority to be set for all allocations made in this pool. Optional.
-Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
-Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
-This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
-There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
+Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
+Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
+This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
+There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
@@ -306,7 +284,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
index a970156..67b61fe 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
index b7e7c30..853c2ff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Statistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,21 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT BlockCount Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
UINT AllocationCount Number of D3D12MA::Allocation objects allocated.
UINT64 BlockBytes Number of bytes allocated in memory blocks.
UINT64 AllocationBytes Total number of bytes occupied by all D3D12MA::Allocation objects.
-Detailed Description
+Detailed Description
Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total.
These are fast to calculate. See functions: D3D12MA::Allocator::GetBudget(), D3D12MA::Pool::GetStatistics().
-Member Data Documentation
+Member Data Documentation
◆ AllocationBytes
@@ -132,7 +115,7 @@
Total number of bytes occupied by all D3D12MA::Allocation objects.
-Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
+Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
@@ -149,7 +132,7 @@
Number of D3D12MA::Allocation objects allocated.
-Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
+Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
@@ -181,7 +164,7 @@
-Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
+Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
-
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
UINT64_MAX if there are 0 empty ranges. 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
index 2ae0d33..654ade6 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
-Generated by
1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
index fcb0f64..d812aff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
-
+Public AttributesPOOL_FLAGS | Flags | | D3D12_HEAP_PROPERTIES | HeapProperties | | D3D12_HEAP_FLAGS | HeapFlags | | UINT64 | BlockSize | | UINT | MinBlockCount | | UINT | MaxBlockCount | | UINT64 | MinAllocationAlignment | | ID3D12ProtectedResourceSession * | pProtectedSession | | D3D12_RESIDENCY_PRIORITY | ResidencyPriority | | | ||||||||||||||||||||||||||||||
Detailed Description
+Detailed Description
Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool.
-Member Data Documentation
+Member Data Documentation
◆ BlockSize
@@ -189,7 +167,7 @@
Heap flags to be used when allocating heaps of this pool.
-It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
+It should contain one of these values, depending on type of resources you are going to create in this heap: D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.
It is recommended to also add D3D12MA_RECOMMENDED_POOL_FLAGS. You can specify additional flags if needed.
@@ -207,7 +185,7 @@
The parameters of memory heap where allocations of this pool should be placed.
-In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
+In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
@@ -224,7 +202,7 @@
Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
-Set to 0 to use default, which is UINT64_MAX, which means no limit.
+Set to 0 to use default, which is UINT64_MAX, which means no limit.
Set to same value as D3D12MA::POOL_DESC::MinBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.
@@ -293,10 +271,10 @@
Residency priority to be set for all allocations made in this pool. Optional.
-Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
-Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
-This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
-There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
+Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
+Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
+This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
+There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
@@ -306,7 +284,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
index a970156..67b61fe 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
index b7e7c30..853c2ff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Statistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,21 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT BlockCount Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
UINT AllocationCount Number of D3D12MA::Allocation objects allocated.
UINT64 BlockBytes Number of bytes allocated in memory blocks.
UINT64 AllocationBytes Total number of bytes occupied by all D3D12MA::Allocation objects.
-Detailed Description
+Detailed Description
Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total.
These are fast to calculate. See functions: D3D12MA::Allocator::GetBudget(), D3D12MA::Pool::GetStatistics().
-Member Data Documentation
+Member Data Documentation
◆ AllocationBytes
@@ -132,7 +115,7 @@
Total number of bytes occupied by all D3D12MA::Allocation objects.
-Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
+Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
@@ -149,7 +132,7 @@
Number of D3D12MA::Allocation objects allocated.
-Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
+Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
@@ -181,7 +164,7 @@
-Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
+Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
-
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS, D3D12_HEAP_FLAG_ALLOW_ONLY_NON_RT_DS_TEXTURES, D3D12_HEAP_FLAG_ALLOW_ONLY_RT_DS_TEXTURES. Except if ResourceHeapTier = 2, then it may be D3D12_HEAP_FLAG_ALLOW_ALL_BUFFERS_AND_TEXTURES = 0.The parameters of memory heap where allocations of this pool should be placed.
-In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
In the simplest case, just fill it with zeros and set Type to one of: D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK. Additional parameters can be used e.g. to utilize UMA.
@@ -224,7 +202,7 @@
Maximum number of heaps (memory blocks) that can be allocated in this pool. Optional.
-Set to 0 to use default, which is UINT64_MAX, which means no limit.
+Set to 0 to use default, which is UINT64_MAX, which means no limit.
Set to same value as D3D12MA::POOL_DESC::MinBlockCount to have fixed amount of memory allocated throughout whole lifetime of this pool.
@@ -293,10 +271,10 @@
Residency priority to be set for all allocations made in this pool. Optional.
-Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
-Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
-This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
-There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
+Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
+Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
+This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
+There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
@@ -306,7 +284,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
index a970156..67b61fe 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
index b7e7c30..853c2ff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Statistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,21 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT BlockCount Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
UINT AllocationCount Number of D3D12MA::Allocation objects allocated.
UINT64 BlockBytes Number of bytes allocated in memory blocks.
UINT64 AllocationBytes Total number of bytes occupied by all D3D12MA::Allocation objects.
-Detailed Description
+Detailed Description
Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total.
These are fast to calculate. See functions: D3D12MA::Allocator::GetBudget(), D3D12MA::Pool::GetStatistics().
-Member Data Documentation
+Member Data Documentation
◆ AllocationBytes
@@ -132,7 +115,7 @@
Total number of bytes occupied by all D3D12MA::Allocation objects.
-Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
+Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
@@ -149,7 +132,7 @@
Number of D3D12MA::Allocation objects allocated.
-Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
+Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
@@ -181,7 +164,7 @@
-Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
+Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
-
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
UINT64_MAX, which means no limit.Residency priority to be set for all allocations made in this pool. Optional.
-Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
Set this parameter to one of the possible enum values e.g. D3D12_RESIDENCY_PRIORITY_HIGH to apply specific residency priority to all allocations made in this pool: ID3D12Heap memory blocks used to sub-allocate for placed resources, as well as committed resources or heaps created when D3D12MA::ALLOCATION_FLAG_COMMITTED is used. This can increase/decrease chance that the memory will be pushed out from VRAM to system RAM when the system runs out of memory, which is invisible to the developer using D3D12 API while it can degrade performance.
+Priority is set using function ID3D12Device1::SetResidencyPriority. It is performed only when ID3D12Device1 interface is defined and successfully obtained. Otherwise, this parameter is ignored.
+This parameter is optional. If you set it to D3D12_RESIDENCY_PRIORITY(0), residency priority will not be set for allocations made in this pool.
+There is no equivalent parameter for allocations made in default pools. If you want to set residency priority for such allocation, you need to do it manually: allocate with D3D12MA::ALLOCATION_FLAG_COMMITTED and call ID3D12Device1::SetResidencyPriority, passing allocation->GetResource().
@@ -306,7 +284,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
index a970156..67b61fe 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
index b7e7c30..853c2ff 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::Statistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,25 +87,21 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT BlockCount Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
UINT AllocationCount Number of D3D12MA::Allocation objects allocated.
UINT64 BlockBytes Number of bytes allocated in memory blocks.
UINT64 AllocationBytes Total number of bytes occupied by all D3D12MA::Allocation objects.
-Detailed Description
+Detailed Description
Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total.
These are fast to calculate. See functions: D3D12MA::Allocator::GetBudget(), D3D12MA::Pool::GetStatistics().
-Member Data Documentation
+Member Data Documentation
◆ AllocationBytes
@@ -132,7 +115,7 @@
Total number of bytes occupied by all D3D12MA::Allocation objects.
-Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
+Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
@@ -149,7 +132,7 @@
Number of D3D12MA::Allocation objects allocated.
-Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
+Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
@@ -181,7 +164,7 @@
-Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
+Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
-
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
#include <D3D12MemAlloc.h>
+Public Attributes | Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources. | UINT | AllocationCount | | UINT64 | BlockBytes | | UINT64 | AllocationBytes | | | ||||||||||||||||||
ID3D12Heap objects and committed resources. Detailed Description
+Detailed Description
Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total.
These are fast to calculate. See functions: D3D12MA::Allocator::GetBudget(), D3D12MA::Pool::GetStatistics().
-Member Data Documentation
+Total number of bytes occupied by all D3D12MA::Allocation objects.
-Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
Always less or equal than BlockBytes. Difference (BlockBytes - AllocationBytes) is the amount of memory allocated from D3D12 but unused by any D3D12MA::Allocation.
@@ -149,7 +132,7 @@
Number of D3D12MA::Allocation objects allocated.
-Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
+Committed allocations have their own blocks, so each one adds 1 to AllocationCount as well as BlockCount.
@@ -181,7 +164,7 @@
-Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
+Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
-
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
AllocationCount as well as BlockCount. Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
Number of D3D12 memory blocks allocated - ID3D12Heap objects and committed resources.
@@ -191,7 +174,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
index d4b0bc7..b49ebb7 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
index fe591a9..494e68e 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_total_statistics.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,22 +87,19 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
DetailedStatistics HeapType [5] One element for each type of heap located at the following indices:
DetailedStatistics MemorySegmentGroup [2] One element for each memory segment group located at the following indices:
DetailedStatistics Total Total statistics from all memory allocated from D3D12.
-Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+Member Data Documentation
◆ HeapType
@@ -130,11 +114,11 @@ D3D12_HEAP_TYPE_DEFAULT
+
1 = D3D12_HEAP_TYPE_UPLOAD
+2 = D3D12_HEAP_TYPE_READBACK
+3 = D3D12_HEAP_TYPE_CUSTOM
+4 = D3D12_HEAP_TYPE_GPU_UPLOAD
@@ -153,19 +137,19 @@ DXGI_MEMORY_SEGMENT_GROUP_LOCAL
+
1 = DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL
Meaning of these segment groups is:
-- When
IsUMA() == FALSE (discrete graphics card):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).- When IsUMA() == FALSE (discrete graphics card):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
-- When
IsUMA() == TRUE (integrated graphics chip):
-DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0. - When IsUMA() == TRUE (integrated graphics chip):
+- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources.
+- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
@@ -194,7 +178,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,30 +90,26 @@
Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
-
-
-
+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation.
UINT64 Size Size of the allocation.
UINT64 Alignment Required alignment of the allocation.
void * pPrivateData Custom pointer to be associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,21 +87,18 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
UINT64 Offset Offset of the allocation.
UINT64 Size Size of the allocation.
void * pPrivateData Custom pointer associated with the allocation.
-Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -103,27 +90,24 @@
Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
-
-
-
+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags.
UINT64 Size Total size of the block.
const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional.
-Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference
-
-
@@ -33,33 +31,22 @@
-
+
-
@@ -100,15 +87,14 @@
#include <D3D12MemAlloc.h>
-
+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid.
-Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator
-
-
@@ -33,33 +31,22 @@
-
+
-
- Virtual allocator
+ Virtual allocator
-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
-
+As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+
Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528
UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535
Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503
-
+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
+When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);
block->Release();
void FreeAllocation(VirtualAllocation allocation)Frees the allocation.
-
+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
+You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData
{
std::string m_AllocName;
@@ -161,7 +148,7 @@
block->FreeAllocation(alloc);
void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.
-
+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};
@@ -172,13 +159,13 @@
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540
-
Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
+Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
-
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;
@@ -191,7 +178,7 @@
UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389
More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-
+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );
#include <D3D12MemAlloc.h>
+Public AttributesDetailedStatistics | HeapType [5] | | DetailedStatistics | MemorySegmentGroup [2] | | DetailedStatistics | Total | | | ||||||||||||
Detailed Description
+Detailed Description
General statistics from current state of the allocator - total memory usage across all memory heaps and segments.
These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().
-Member Data Documentation
+IsUMA() == FALSE (discrete graphics card):-
-
DXGI_MEMORY_SEGMENT_GROUP_LOCAL(index 0) represents GPU memory (resources allocated inD3D12_HEAP_TYPE_DEFAULT,D3D12_HEAP_TYPE_GPU_UPLOADorD3D12_MEMORY_POOL_L1).
-DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL(index 1) represents system memory (resources allocated inD3D12_HEAP_TYPE_UPLOAD,D3D12_HEAP_TYPE_READBACK, orD3D12_MEMORY_POOL_L0).
+- When IsUMA() == FALSE (discrete graphics card):
-
+
- DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1). +
- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
- - When
IsUMA() == TRUE(integrated graphics chip):-
-
DXGI_MEMORY_SEGMENT_GROUP_LOCAL= (index 0) represents memory shared for all the resources.
-DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL= (index 1) is unused and always 0.
+- When IsUMA() == TRUE (integrated graphics chip):
-
+
- DXGI_MEMORY_SEGMENT_GROUP_LOCAL = (index 0) represents memory shared for all the resources. +
- DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL = (index 1) is unused and always 0.
-Generated by
1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
index bad0230..518ddc4 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List - - @@ -33,33 +31,22 @@ - + -@@ -101,7 +88,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
index 35506ef..9b284fd 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference - - @@ -33,33 +31,22 @@ - + -@@ -103,30 +90,26 @@ Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:-
- -
-+
Public Attributes
VIRTUAL_ALLOCATION_FLAGS Flags Flags for the virtual allocation. UINT64 Size Size of the allocation. UINT64 Alignment Required alignment of the allocation. void * pPrivateData Custom pointer to be associated with the allocation. Detailed Description
+Detailed Description
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
-Member Data Documentation
+Member Data Documentation
◆ Alignment
@@ -200,7 +183,7 @@-Generated by
1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
index 30bb269..26f3491 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List - - @@ -33,33 +31,22 @@ - + -@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
index 8b597eb..61a862b 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference - - @@ -33,33 +31,22 @@ - + -@@ -100,21 +87,18 @@#include <D3D12MemAlloc.h>-
-+
Public Attributes
UINT64 Offset Offset of the allocation. UINT64 Size Size of the allocation. void * pPrivateData Custom pointer associated with the allocation. Detailed Description
+Detailed Description
Parameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo().
-Member Data Documentation
+Member Data Documentation
◆ Offset
@@ -171,7 +155,7 @@-Generated by
1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
index a0a0898..fdfa9ee 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List - - @@ -33,33 +31,22 @@ - + -@@ -100,7 +87,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
index d1bdd87..0d23d65 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference - - @@ -33,33 +31,22 @@ - + -@@ -103,27 +90,24 @@ Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:-
- -
-+
Public Attributes
VIRTUAL_BLOCK_FLAGS Flags Flags. UINT64 Size Total size of the block. const ALLOCATION_CALLBACKS * pAllocationCallbacks Custom CPU memory allocation callbacks. Optional. Detailed Description
+Detailed Description
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
-Member Data Documentation
+Member Data Documentation
◆ Flags
@@ -180,7 +164,7 @@-Generated by
1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
index 2610ac3..a219f48 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation-members.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Member List - - @@ -33,33 +31,22 @@ - + -@@ -98,7 +85,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
index f075e13..893aa1a 100644
--- a/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
+++ b/docs/html/struct_d3_d12_m_a_1_1_virtual_allocation.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference - - @@ -33,33 +31,22 @@ - + -@@ -100,15 +87,14 @@#include <D3D12MemAlloc.h>-
-+
Public Attributes
AllocHandle AllocHandle Unique idenitfier of current allocation. 0 means null/invalid. Detailed Description
+Detailed Description
Represents single memory allocation done inside VirtualBlock.
-Member Data Documentation
+Member Data Documentation
◆ AllocHandle
@@ -131,7 +117,7 @@-Generated by
1.13.2
+Generated by 1.14.0
diff --git a/docs/html/tabs.css b/docs/html/tabs.css
index 7fa4268..84f33ae 100644
--- a/docs/html/tabs.css
+++ b/docs/html/tabs.css
@@ -1 +1 @@
-.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
+.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-color:var(--nav-menu-background-color)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;line-height:36px;text-decoration:none;color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-color:var(--nav-menu-background-color);line-height:36px}.sm-dox a span.sub-arrow{top:15px;right:10px;box-sizing:content-box;padding:0;margin:0;display:inline-block;width:5px;height:5px;background-color:var(--nav-menu-background-color);border-right:2px solid var(--nav-arrow-color);border-bottom:2px solid var(--nav-arrow-color);transform:rotate(45deg);-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 6px}.sm-dox a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px !important}.sm-dox a:hover span.sub-arrow{background-color:var(--nav-menu-active-bg);border-right:2px solid var(--nav-arrow-selected-color);border-bottom:2px solid var(--nav-arrow-selected-color)}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0;padding:3px}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{transform:rotate(-45deg)}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important}.sm-dox ul a:hover{background-color:var(--nav-menu-active-bg);border-radius:5px}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:6px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:6px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}}
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html
index 52b7874..43cc74b 100644
--- a/docs/html/virtual_allocator.html
+++ b/docs/html/virtual_allocator.html
@@ -3,15 +3,13 @@
-
+
D3D12 Memory Allocator: Virtual allocator - - @@ -33,33 +31,22 @@ - + --+Virtual allocatorVirtual allocator-As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a
-ID3D12DescriptorHeap.+
As an extra feature, the core allocation algorithm of the library is exposed through a simple and convenient API of "virtual allocator". It doesn't allocate any real GPU memory. It just keeps track of used and free regions of a "virtual block". You can use it to allocate your own memory or other objects, even completely unrelated to D3D12. A common use case is sub-allocation of pieces of one large GPU buffer. Another suggested use case is allocating descriptors in a ID3D12DescriptorHeap.
+Creating virtual block
To use this functionality, there is no main "allocator" object. You don't need to have D3D12MA::Allocator object created. All you need to do is to create a separate D3D12MA::VirtualBlock object for each block of memory you want to be managed by the allocator:
+
Making virtual allocations
D3D12MA::VirtualBlock object contains internal data structure that keeps track of free and occupied regions using the same code as the main D3D12 memory allocator. A single allocation is identified by a lightweight structure D3D12MA::VirtualAllocation. You will also likely want to know the offset at which the allocation was made in the block.
In order to make an allocation:
@@ -135,17 +122,17 @@Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().Definition D3D12MemAlloc.h:1528UINT64 SizeSize of the allocation.Definition D3D12MemAlloc.h:1535-Represents single memory allocation done inside VirtualBlock.Definition D3D12MemAlloc.h:503+
Deallocation
When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.
-When whole block is no longer needed, the block object can be released by calling
+block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to callblock->FreeAllocationfor each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.When whole block is no longer needed, the block object can be released by calling block->Release(). All allocations must be freed before the block is destroyed, which is checked internally by an assert. However, if you don't want to call block->FreeAllocation for each allocation, you can use D3D12MA::VirtualBlock::Clear to free them all at once - a feature not available in normal D3D12 memory allocator.
Example:
block->FreeAllocation(alloc);block->Release();-void FreeAllocation(VirtualAllocation allocation)Frees the allocation.+
Allocation parameters
-You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is
+NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:You can attach a custom pointer to each allocation by using D3D12MA::VirtualBlock::SetAllocationPrivateData. Its default value is NULL. It can be used to store any data that needs to be associated with that allocation - e.g. an index, a handle, or a pointer to some larger data structure containing more information. Example:
struct CustomAllocData{std::string m_AllocName;@@ -161,7 +148,7 @@block->FreeAllocation(alloc);-void GetAllocationInfo(VirtualAllocation allocation, VIRTUAL_ALLOCATION_INFO *pInfo) constReturns information about an allocation - its offset, size and custom pointer.+
Alignment and units
It feels natural to express sizes and offsets in bytes. If an offset of an allocation needs to be aligned to a multiply of some number (e.g. 4 bytes), you can fill optional member D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment to request it. Example:
D3D12MA::VIRTUAL_ALLOCATION_DESC allocDesc = {};@@ -172,13 +159,13 @@UINT64 allocOffset;hr = block->Allocate(&allocDesc, &alloc, &allocOffset);-UINT64 AlignmentRequired alignment of the allocation.Definition D3D12MemAlloc.h:1540Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or
+sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:Alignments of different allocations made from one block may vary. However, if all alignments and sizes are always multiply of some size e.g. 4 B or sizeof(MyDataStruct), you can express all sizes, alignments, and offsets in multiples of that size instead of individual bytes. It might be more convenient, but you need to make sure to use this new unit consistently in all the places:
- D3D12MA::VIRTUAL_BLOCK_DESC::Size
- D3D12MA::VIRTUAL_ALLOCATION_DESC::Size and D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
- Using offset returned by D3D12MA::VirtualBlock::Allocate and D3D12MA::VIRTUAL_ALLOCATION_INFO::Offset
+
Statistics
You can obtain brief statistics of a virtual block using D3D12MA::VirtualBlock::GetStatistics(). The function fills structure D3D12MA::Statistics - same as used by the normal D3D12 memory allocator. Example:
D3D12MA::Statistics stats;@@ -191,7 +178,7 @@UINT AllocationCountNumber of D3D12MA::Allocation objects allocated.Definition D3D12MemAlloc.h:389More detailed statistics can be obtained using function D3D12MA::VirtualBlock::CalculateStatistics(), but they are slower to calculate.
You can also request a full list of allocations and free regions as a string in JSON format by calling D3D12MA::VirtualBlock::BuildStatsString. Returned string must be later freed using D3D12MA::VirtualBlock::FreeStatsString. The format of this string may differ from the one returned by the main D3D12 allocator, but it is similar.
-+
Additional considerations
Alternative, linear algorithm can be used with virtual allocator - see flag D3D12MA::VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR and documentation: Linear allocation algorithm.
Note that the "virtual allocator" functionality is implemented on a level of individual memory blocks. Keeping track of a whole collection of blocks, allocating new ones when out of free space, deleting empty ones, and deciding which one to try first for a new allocation must be implemented by the user.
@@ -199,7 +186,7 @@
-Generated by 1.13.2
+Generated by 1.14.0
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h
index bde66a4..d3a258a 100644
--- a/include/D3D12MemAlloc.h
+++ b/include/D3D12MemAlloc.h
@@ -24,7 +24,7 @@
/** \mainpage D3D12 Memory Allocator
-Version 3.0.1 (2025-05-08)
+Version 3.0.2 (2025-XX-XX)
Copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT
@@ -64,7 +64,7 @@ Documentation of all members: D3D12MemAlloc.h
\section main_see_also Web links
-- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page
+- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/d3d12-memory-allocator/) - product page
- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository
*/
diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp
index fa53586..e637874 100644
--- a/src/D3D12MemAlloc.cpp
+++ b/src/D3D12MemAlloc.cpp
@@ -7793,7 +7793,9 @@ HRESULT AllocatorPimpl::GetResourceAllocationInfo(
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT
if (inOutResourceDesc.Alignment == 0 &&
- inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D &&
+ (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE1D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE2D ||
+ inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_TEXTURE3D) &&
(inOutResourceDesc.Flags & (D3D12_RESOURCE_FLAG_ALLOW_RENDER_TARGET | D3D12_RESOURCE_FLAG_ALLOW_DEPTH_STENCIL)) == 0
#if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT == 1
&& CanUseSmallAlignment(inOutResourceDesc)
diff --git a/src/Tests.cpp b/src/Tests.cpp
index 27a9408..152b23a 100644
--- a/src/Tests.cpp
+++ b/src/Tests.cpp
@@ -481,32 +481,27 @@ static void TestJson(const TestContext& ctx)
// Select different heaps
for (UINT8 heapType = 0; heapType < 5; ++heapType)
{
- D3D12_RESOURCE_STATES state;
+ D3D12_RESOURCE_STATES state = D3D12_RESOURCE_STATE_COMMON;
D3D12_CPU_PAGE_PROPERTY cpuPageType = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
D3D12_MEMORY_POOL memoryPool = D3D12_MEMORY_POOL_UNKNOWN;
switch (heapType)
{
case 0:
allocDesc.HeapType = D3D12_HEAP_TYPE_DEFAULT;
- state = D3D12_RESOURCE_STATE_COMMON;
break;
case 1:
allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
break;
case 2:
allocDesc.HeapType = D3D12_HEAP_TYPE_READBACK;
- state = D3D12_RESOURCE_STATE_COPY_DEST;
break;
case 3:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_COMMON;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_NOT_AVAILABLE;
memoryPool = ctx.allocator->IsUMA() ? D3D12_MEMORY_POOL_L0 : D3D12_MEMORY_POOL_L1;
break;
case 4:
allocDesc.HeapType = D3D12_HEAP_TYPE_CUSTOM;
- state = D3D12_RESOURCE_STATE_GENERIC_READ;
cpuPageType = D3D12_CPU_PAGE_PROPERTY_WRITE_COMBINE;
memoryPool = D3D12_MEMORY_POOL_L0;
break;
@@ -676,7 +671,7 @@ static void TestCommittedResourcesAndJson(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDesc,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resources[i].allocation,
__uuidof(ID3D12Resource),
@@ -1187,7 +1182,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// Default parameters
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NONE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
ID3D12Heap* const defaultAllocHeap = alloc->GetHeap();
const UINT64 defaultAllocOffset = alloc->GetOffset();
@@ -1198,7 +1193,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
if(poolTypeI != 2)
{
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_COMMITTED;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetOffset() == 0); // Committed
CHECK_BOOL(alloc->GetHeap() == nullptr); // Committed
@@ -1208,7 +1203,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #1
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
CHECK_BOOL(SUCCEEDED(hr) && alloc && alloc->GetResource());
CHECK_BOOL(alloc->GetHeap() == defaultAllocHeap); // Same memory block as default one.
CHECK_BOOL(alloc->GetOffset() != defaultAllocOffset);
@@ -1217,7 +1212,7 @@ static void TestPoolsAndAllocationParameters(const TestContext& ctx)
// NEVER_ALLOCATE #2. Should fail in pool2 as it has no space.
allocDesc.Flags = D3D12MA::ALLOCATION_FLAG_NEVER_ALLOCATE;
- hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &alloc, IID_NULL, nullptr);
+ hr = ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &alloc, IID_NULL, nullptr);
if(poolTypeI == 2)
CHECK_BOOL(FAILED(hr));
else
@@ -2075,7 +2070,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescUpload,
&resourceDesc,
- D3D12_RESOURCE_STATE_GENERIC_READ,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesUpload[i].allocation,
IID_PPV_ARGS(&resourcesUpload[i].resource)) );
@@ -2083,7 +2078,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescDefault,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesDefault[i].allocation,
IID_PPV_ARGS(&resourcesDefault[i].resource)) );
@@ -2091,7 +2086,7 @@ static void TestTransfer(const TestContext& ctx)
CHECK_HR( ctx.allocator->CreateResource(
&allocDescReadback,
&resourceDesc,
- D3D12_RESOURCE_STATE_COPY_DEST,
+ D3D12_RESOURCE_STATE_COMMON,
NULL,
&resourcesReadback[i].allocation,
IID_PPV_ARGS(&resourcesReadback[i].resource)) );