From cdf948baa433bab65a3b60f6edd394e7637d8ec6 Mon Sep 17 00:00:00 2001 From: Adam Sawicki Date: Fri, 31 Jan 2025 18:00:36 +0100 Subject: [PATCH 01/10] Added support for resource tight alignment Added macro D3D12MA_TIGHT_ALIGNMENT_SUPPORTED, flag ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT, function Allocator::IsTightAlignmentSupported. --- include/D3D12MemAlloc.h | 11 ++++++++ src/CMakeLists.txt | 8 ++++++ src/D3D12MemAlloc.cpp | 48 +++++++++++++++++++++++++++++--- src/D3D12Sample.cpp | 10 +++++-- src/Tests.cpp | 61 +++++++++++++++++++++++++++++++++++++++++ 5 files changed, 131 insertions(+), 7 deletions(-) diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h index 2dc31c7..737e6ae 100644 --- a/include/D3D12MemAlloc.h +++ b/include/D3D12MemAlloc.h @@ -1053,6 +1053,8 @@ enum ALLOCATOR_FLAGS It can also be disabled for a single allocation by using #ALLOCATION_FLAG_STRATEGY_MIN_TIME. */ ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED = 0x10, + /** TODO document... */ + ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT = 0x20, }; /// \brief Parameters of created Allocator object. To be used with CreateAllocator(). @@ -1127,6 +1129,15 @@ class D3D12MA_API Allocator : public IUnknownImpl `#define D3D12MA_OPTIONS16_SUPPORTED 1` is needed for the compilation of this library. Otherwise the flag is always false. */ BOOL IsGPUUploadHeapSupported() const; + /** \brief Returns true if resource tight alignment is supported on the current system. + When supported, it is automatically used by the library, unless + #ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT flag was specified on allocator creation. + + This flag is fetched from `D3D12_FEATURE_DATA_TIGHT_ALIGNMENT::SupportTier`. + + `#define D3D12MA_TIGHT_ALIGNMENT_SUPPORTED 1` is needed for the compilation of this library. Otherwise the flag is always false. + */ + BOOL IsTightAlignmentSupported() const; /** \brief Returns total amount of memory of specific segment group, in bytes. \param memorySegmentGroup use `DXGI_MEMORY_SEGMENT_GROUP_LOCAL` or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL`. diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 23e0941..6134ea3 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -198,3 +198,11 @@ if(D3D12MA_OPTIONS16_SUPPORTED) target_compile_definitions(D3D12Sample PRIVATE D3D12MA_OPTIONS16_SUPPORTED=1) endif() endif() + +option(D3D12MA_TIGHT_ALIGNMENT_SUPPORTED "Set if using Agility SDK 1.716.0-preview or newer that defines D3D12_FEATURE_DATA_TIGHT_ALIGNMENT." OFF) +if(D3D12MA_TIGHT_ALIGNMENT_SUPPORTED) + target_compile_definitions(D3D12MemoryAllocator PRIVATE D3D12MA_TIGHT_ALIGNMENT_SUPPORTED=1) + if(${D3D12MA_BUILD_SAMPLE} AND ${WIN32}) + target_compile_definitions(D3D12Sample PRIVATE D3D12MA_TIGHT_ALIGNMENT_SUPPORTED=1) + endif() +endif() diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp index 6962f0b..7eb79f0 100644 --- a/src/D3D12MemAlloc.cpp +++ b/src/D3D12MemAlloc.cpp @@ -5911,6 +5911,8 @@ class AllocatorPimpl BOOL IsCacheCoherentUMA() const { return m_D3D12Architecture.CacheCoherentUMA; } bool SupportsResourceHeapTier2() const { return m_D3D12Options.ResourceHeapTier >= D3D12_RESOURCE_HEAP_TIER_2; } bool IsGPUUploadHeapSupported() const { return m_GPUUploadHeapSupported != FALSE; } + bool IsTightAlignmentSupported() const { return m_TightAlignmentSupported != FALSE; } + bool IsTightAlignmentEnabled() const { return IsTightAlignmentSupported() && m_UseTightAlignment; } bool UseMutex() const { return m_UseMutex; } AllocationObjectAllocator& GetAllocationObjectAllocator() { return m_AllocationObjectAllocator; } UINT GetCurrentFrameIndex() const { return m_CurrentFrameIndex.load(); } @@ -5998,6 +6000,7 @@ class AllocatorPimpl const bool m_AlwaysCommitted; const bool m_MsaaAlwaysCommitted; const bool m_PreferSmallBuffersCommitted; + const bool m_UseTightAlignment; bool m_DefaultPoolsNotZeroed = false; ID3D12Device* m_Device; // AddRef #ifdef __ID3D12Device1_INTERFACE_DEFINED__ @@ -6022,6 +6025,7 @@ class AllocatorPimpl DXGI_ADAPTER_DESC m_AdapterDesc; D3D12_FEATURE_DATA_D3D12_OPTIONS m_D3D12Options; BOOL m_GPUUploadHeapSupported = FALSE; + BOOL m_TightAlignmentSupported = FALSE; D3D12_FEATURE_DATA_ARCHITECTURE m_D3D12Architecture; AllocationObjectAllocator m_AllocationObjectAllocator; @@ -6089,7 +6093,8 @@ AllocatorPimpl::AllocatorPimpl(const ALLOCATION_CALLBACKS& allocationCallbacks, : m_UseMutex((desc.Flags & ALLOCATOR_FLAG_SINGLETHREADED) == 0), m_AlwaysCommitted((desc.Flags & ALLOCATOR_FLAG_ALWAYS_COMMITTED) != 0), m_MsaaAlwaysCommitted((desc.Flags & ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED) != 0), - m_PreferSmallBuffersCommitted((desc.Flags & ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED) == 0), + m_PreferSmallBuffersCommitted((desc.Flags& ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED) == 0), + m_UseTightAlignment((desc.Flags & ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT) == 0), m_Device(desc.pDevice), m_Adapter(desc.pAdapter), m_PreferredBlockSize(desc.PreferredBlockSize != 0 ? desc.PreferredBlockSize : D3D12MA_DEFAULT_BLOCK_SIZE), @@ -6177,6 +6182,20 @@ HRESULT AllocatorPimpl::Init(const ALLOCATOR_DESC& desc) } #endif + // You must define macro `#define D3D12MA_TIGHT_ALIGNMENT_SUPPORTED 1` to enable resource tight alignment! + // Unfortunately there is no way to programmatically check if the included defines D3D12_FEATURE_DATA_TIGHT_ALIGNMENT or not. + // Main interfaces have respective macros like __ID3D12Device4_INTERFACE_DEFINED__, but structures like this do not. +#if D3D12MA_TIGHT_ALIGNMENT_SUPPORTED + { + D3D12_FEATURE_DATA_TIGHT_ALIGNMENT tightAlignment = {}; + hr = m_Device->CheckFeatureSupport(D3D12_FEATURE_D3D12_TIGHT_ALIGNMENT, &tightAlignment, sizeof(tightAlignment)); + if (SUCCEEDED(hr)) + { + m_TightAlignmentSupported = tightAlignment.SupportTier >= D3D12_TIGHT_ALIGNMENT_TIER_1; + } + } +#endif + hr = m_Device->CheckFeatureSupport(D3D12_FEATURE_ARCHITECTURE, &m_D3D12Architecture, sizeof(m_D3D12Architecture)); if (FAILED(hr)) { @@ -6861,6 +6880,9 @@ void AllocatorPimpl::BuildStatsString(WCHAR** ppStatsString, BOOL detailedMap) json.WriteString(L"GPUUploadHeapSupported"); json.WriteBool(m_GPUUploadHeapSupported != FALSE); + + json.WriteString(L"TightAlignmentSupported"); + json.WriteBool(m_TightAlignmentSupported != FALSE); } json.EndObject(); } @@ -7623,8 +7645,19 @@ template D3D12_RESOURCE_ALLOCATION_INFO AllocatorPimpl::GetResourceAllocationInfo(D3D12_RESOURCE_DESC_T& inOutResourceDesc) const { #ifdef __ID3D12Device1_INTERFACE_DEFINED__ - /* Optional optimization: Microsoft documentation says: - https://docs.microsoft.com/en-us/windows/win32/api/d3d12/nf-d3d12-id3d12device-getresourceallocationinfo + +#if D3D12MA_TIGHT_ALIGNMENT_SUPPORTED + if (IsTightAlignmentEnabled() && + // Don't allow USE_TIGHT_ALIGNMENT together with ALLOW_CROSS_ADAPTER as there is a D3D Debug Layer error: + // D3D12 ERROR: ID3D12Device::GetResourceAllocationInfo: D3D12_RESOURCE_DESC::Flag D3D12_RESOURCE_FLAG_USE_TIGHT_ALIGNMENT will be ignored since D3D12_RESOURCE_FLAG_ALLOW_CROSS_ADAPTER is set. [ STATE_CREATION ERROR #599: CREATERESOURCE_INVALIDMISCFLAGS] + (inOutResourceDesc.Flags & D3D12_RESOURCE_FLAG_ALLOW_CROSS_ADAPTER) == 0) + { + inOutResourceDesc.Flags |= D3D12_RESOURCE_FLAG_USE_TIGHT_ALIGNMENT; + } +#endif // #if D3D12MA_TIGHT_ALIGNMENT_SUPPORTED + + /* Optional optimization: Microsoft documentation of the ID3D12Device:: + GetResourceAllocationInfo function says: Your application can forgo using GetResourceAllocationInfo for buffer resources (D3D12_RESOURCE_DIMENSION_BUFFER). Buffers have the same size on all adapters, @@ -7632,12 +7665,14 @@ D3D12_RESOURCE_ALLOCATION_INFO AllocatorPimpl::GetResourceAllocationInfo(D3D12_R D3D12_RESOURCE_DESC::Width. */ if (inOutResourceDesc.Alignment == 0 && - inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_BUFFER) + inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_BUFFER && + !IsTightAlignmentEnabled()) { return { AlignUp(inOutResourceDesc.Width, D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT), // SizeInBytes D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT }; // Alignment } + #endif // #ifdef __ID3D12Device1_INTERFACE_DEFINED__ #if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT @@ -9552,6 +9587,11 @@ BOOL Allocator::IsGPUUploadHeapSupported() const return m_Pimpl->IsGPUUploadHeapSupported(); } +BOOL Allocator::IsTightAlignmentSupported() const +{ + return m_Pimpl->IsTightAlignmentSupported(); +} + UINT64 Allocator::GetMemoryCapacity(UINT memorySegmentGroup) const { return m_Pimpl->GetMemoryCapacity(memorySegmentGroup); diff --git a/src/D3D12Sample.cpp b/src/D3D12Sample.cpp index e39e3fe..ea88ee9 100644 --- a/src/D3D12Sample.cpp +++ b/src/D3D12Sample.cpp @@ -438,6 +438,11 @@ inline UINT64 UpdateSubresources( UINT* pNumRows = reinterpret_cast(pRowSizesInBytes + NumSubresources); D3D12_RESOURCE_DESC Desc = pDestinationResource->GetDesc(); + + // Needed because of the D3D Debug Layer error: + // D3D12 ERROR: ID3D12Device::GetCopyableFootprints: D3D12_RESOURCE_DESC::Alignment is invalid. The value is 16. When D3D12_RESOURCE_DESC::Flag bit for D3D12_RESOURCE_FLAG_USE_TIGHT_ALIGNMENT is set, Alignment must be 0. [ STATE_CREATION ERROR #721: CREATERESOURCE_INVALIDALIGNMENT] + Desc.Alignment = 0; + ID3D12Device* pDevice; pDestinationResource->GetDevice(__uuidof(*pDevice), reinterpret_cast(&pDevice)); pDevice->GetCopyableFootprints(&Desc, FirstSubresource, NumSubresources, IntermediateOffset, pLayouts, pNumRows, pRowSizesInBytes, &RequiredSize); @@ -1052,8 +1057,7 @@ static void InitD3D() // initializes direct3d 12 CHECK_HR( g_Allocator->CreateResource( &vertexBufferAllocDesc, &vertexBufferResourceDesc, // resource description for a buffer - D3D12_RESOURCE_STATE_COPY_DEST, // we will start this heap in the copy destination state since we will copy data - // from the upload heap to this heap + D3D12_RESOURCE_STATE_COMMON, nullptr, // optimized clear value must be null for this type of resource. used for render targets and depth/stencil buffers &g_VertexBufferAllocation, IID_PPV_ARGS(&vertexBufferPtr)) ); @@ -1165,7 +1169,7 @@ static void InitD3D() // initializes direct3d 12 CHECK_HR( g_Allocator->CreateResource( &indexBufferAllocDesc, &indexBufferResourceDesc, // resource description for a buffer - D3D12_RESOURCE_STATE_COPY_DEST, // start in the copy destination state + D3D12_RESOURCE_STATE_COMMON, nullptr, // optimized clear value must be null for this type of resource &g_IndexBufferAllocation, IID_PPV_ARGS(&g_IndexBuffer)) ); diff --git a/src/Tests.cpp b/src/Tests.cpp index bd065eb..40388f9 100644 --- a/src/Tests.cpp +++ b/src/Tests.cpp @@ -51,6 +51,17 @@ static constexpr UINT64 MEGABYTE = 1024 * KILOBYTE; static constexpr CONFIG_TYPE ConfigType = CONFIG_TYPE_AVERAGE; static const char* FREE_ORDER_NAMES[] = { "FORWARD", "BACKWARD", "RANDOM", }; +// Indexes match enum D3D12_HEAP_TYPE. +static const WCHAR* const HEAP_TYPE_NAMES[] = +{ + L"", + L"DEFAULT", + L"UPLOAD", + L"READBACK", + L"CUSTOM", + L"GPU_UPLOAD", +}; + static void CurrentTimeToStr(std::string& out) { time_t rawTime; time(&rawTime); @@ -2990,6 +3001,55 @@ static void TestGPUUploadHeap(const TestContext& ctx) #endif } +static void TestTightAlignment(const TestContext& ctx) +{ +#if D3D12MA_TIGHT_ALIGNMENT_SUPPORTED + using namespace D3D12MA; + + wprintf(L"Test resource tight alignment\n"); + + if(!ctx.allocator->IsTightAlignmentSupported()) + { + wprintf(L" Skipped due to tight alignment not supported.\n"); + return; + } + + // Use a custom heap to make sure our small buffers are not created as committed. + POOL_DESC poolDesc = {}; + poolDesc.BlockSize = 1024 * 1024; + poolDesc.MinBlockCount = poolDesc.MaxBlockCount = 1; + + D3D12_RESOURCE_DESC resDesc; + FillResourceDescForBuffer(resDesc, 16); + + const D3D12_HEAP_TYPE heapTypes[] = { D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD }; + for (auto heapType : heapTypes) + { + poolDesc.HeapProperties.Type = heapType; + ComPtr pool; + CHECK_HR(ctx.allocator->CreatePool(&poolDesc, &pool)); + + ALLOCATION_DESC allocDesc = {}; + allocDesc.CustomPool = pool.Get(); + + ComPtr allocs[2] = {}; + + for (size_t i = 0; i < _countof(allocs); ++i) + { + CHECK_HR(ctx.allocator->CreateResource(&allocDesc, &resDesc, + D3D12_RESOURCE_STATE_COMMON, NULL, &allocs[i], IID_NULL, NULL)); + CHECK_BOOL(allocs[i] && allocs[i]->GetResource()); + } + + // Print the offset of the 2nd buffer. + wprintf(L" In D3D12_HEAP_TYPE_%s, a %llu B buffer was aligned to %llu B.\n", + HEAP_TYPE_NAMES[(size_t)heapType], + resDesc.Width, + allocs[1]->GetOffset()); + } +#endif +} + static void TestVirtualBlocks(const TestContext& ctx) { wprintf(L"Test virtual blocks\n"); @@ -4257,6 +4317,7 @@ static void TestGroupBasics(const TestContext& ctx) #endif TestGPUUploadHeap(ctx); + TestTightAlignment(ctx); FILE* file; fopen_s(&file, "Results.csv", "w"); From 1063339a51139ee321d9c4136d8ce44a1af05068 Mon Sep 17 00:00:00 2001 From: Adam Sawicki Date: Sun, 2 Feb 2025 17:03:12 +0100 Subject: [PATCH 02/10] Disabled preference for creating small buffers as committed when tight alignment is used --- include/D3D12MemAlloc.h | 5 +++++ src/D3D12MemAlloc.cpp | 10 +++++++++- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h index 737e6ae..bb102da 100644 --- a/include/D3D12MemAlloc.h +++ b/include/D3D12MemAlloc.h @@ -1051,6 +1051,11 @@ enum ALLOCATOR_FLAGS which may take longer than creating placed resources in existing heaps. Passing this flag will disable this committed preference globally for the allocator. It can also be disabled for a single allocation by using #ALLOCATION_FLAG_STRATEGY_MIN_TIME. + + If the tight resource alignment feature is used by the library (which happens automatically whenever supported, + unless you use flag #ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT), then small buffers are not preferred as committed. + Long story short, you don't need to specify any of these flags. + The library chooses the most optimal method automatically. */ ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED = 0x10, /** TODO document... */ diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp index 7eb79f0..d67ac34 100644 --- a/src/D3D12MemAlloc.cpp +++ b/src/D3D12MemAlloc.cpp @@ -5999,7 +5999,7 @@ class AllocatorPimpl const bool m_UseMutex; const bool m_AlwaysCommitted; const bool m_MsaaAlwaysCommitted; - const bool m_PreferSmallBuffersCommitted; + bool m_PreferSmallBuffersCommitted; const bool m_UseTightAlignment; bool m_DefaultPoolsNotZeroed = false; ID3D12Device* m_Device; // AddRef @@ -6192,6 +6192,14 @@ HRESULT AllocatorPimpl::Init(const ALLOCATOR_DESC& desc) if (SUCCEEDED(hr)) { m_TightAlignmentSupported = tightAlignment.SupportTier >= D3D12_TIGHT_ALIGNMENT_TIER_1; + + // If tight alignment is supported (checked by the code above) and wasn't disabled by the developer + // (with ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT), disable the preference for creating small buffers as committed, + // as if ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED was specified. + if (IsTightAlignmentEnabled()) + { + m_PreferSmallBuffersCommitted = false; + } } } #endif From 42bfb6b6fb7caf1a0c37196caa1e357f8b138af1 Mon Sep 17 00:00:00 2001 From: Adam Sawicki Date: Wed, 26 Feb 2025 13:07:53 +0100 Subject: [PATCH 03/10] Align buffers to 256 B at least Because this is the alignment required for constant buffers. --- src/D3D12MemAlloc.cpp | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp index d67ac34..976e872 100644 --- a/src/D3D12MemAlloc.cpp +++ b/src/D3D12MemAlloc.cpp @@ -7710,7 +7710,15 @@ D3D12_RESOURCE_ALLOCATION_INFO AllocatorPimpl::GetResourceAllocationInfo(D3D12_R } #endif // #if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT - return GetResourceAllocationInfoNative(inOutResourceDesc); + D3D12_RESOURCE_ALLOCATION_INFO resAllocInfo = GetResourceAllocationInfoNative(inOutResourceDesc); + + // Align up to 256 B because this is the alignment required for constant buffers. + if (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_BUFFER) + { + resAllocInfo.Alignment = D3D12MA_MAX(resAllocInfo.Alignment, (UINT64)D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT); + } + + return resAllocInfo; } bool AllocatorPimpl::NewAllocationWithinBudget(D3D12_HEAP_TYPE heapType, UINT64 size) From 619c795fba2e5c53506d51a20b4e4d2b10f62298 Mon Sep 17 00:00:00 2001 From: Adam Sawicki Date: Wed, 26 Feb 2025 14:04:10 +0100 Subject: [PATCH 04/10] Removed macros D3D12MA_OPTIONS16_SUPPORTED, D3D12MA_TIGHT_ALIGNMENT_SUPPORTED from the public interface Also removed them from the Cmake script. They are now automatically determined based on D3D12_PREVIEW_SDK_VERSION, D3D12_SDK_VERSION macro. Also made fixes in tests. --- include/D3D12MemAlloc.h | 4 ---- src/CMakeLists.txt | 16 ---------------- src/D3D12MemAlloc.cpp | 28 +++++++++++++++++++--------- src/Doxyfile | 4 +++- src/Tests.cpp | 27 +++++++++++++++++++++++---- 5 files changed, 45 insertions(+), 34 deletions(-) diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h index bb102da..23c8f70 100644 --- a/include/D3D12MemAlloc.h +++ b/include/D3D12MemAlloc.h @@ -1130,8 +1130,6 @@ class D3D12MA_API Allocator : public IUnknownImpl When true, you can use `D3D12_HEAP_TYPE_GPU_UPLOAD`. This flag is fetched from `D3D12_FEATURE_D3D12_OPTIONS16::GPUUploadHeapSupported`. - - `#define D3D12MA_OPTIONS16_SUPPORTED 1` is needed for the compilation of this library. Otherwise the flag is always false. */ BOOL IsGPUUploadHeapSupported() const; /** \brief Returns true if resource tight alignment is supported on the current system. @@ -1139,8 +1137,6 @@ class D3D12MA_API Allocator : public IUnknownImpl #ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT flag was specified on allocator creation. This flag is fetched from `D3D12_FEATURE_DATA_TIGHT_ALIGNMENT::SupportTier`. - - `#define D3D12MA_TIGHT_ALIGNMENT_SUPPORTED 1` is needed for the compilation of this library. Otherwise the flag is always false. */ BOOL IsTightAlignmentSupported() const; /** \brief Returns total amount of memory of specific segment group, in bytes. diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 6134ea3..327ec7c 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -190,19 +190,3 @@ if(D3D12MA_AGILITY_SDK_DIRECTORY) else() message(STATUS "DX12 Agility SDK not used.") endif() - -option(D3D12MA_OPTIONS16_SUPPORTED "Set if using Agility SDK 1.710.0-preview or newer that defines D3D12_FEATURE_DATA_D3D12_OPTIONS16." OFF) -if(D3D12MA_OPTIONS16_SUPPORTED) - target_compile_definitions(D3D12MemoryAllocator PRIVATE D3D12MA_OPTIONS16_SUPPORTED=1) - if(${D3D12MA_BUILD_SAMPLE} AND ${WIN32}) - target_compile_definitions(D3D12Sample PRIVATE D3D12MA_OPTIONS16_SUPPORTED=1) - endif() -endif() - -option(D3D12MA_TIGHT_ALIGNMENT_SUPPORTED "Set if using Agility SDK 1.716.0-preview or newer that defines D3D12_FEATURE_DATA_TIGHT_ALIGNMENT." OFF) -if(D3D12MA_TIGHT_ALIGNMENT_SUPPORTED) - target_compile_definitions(D3D12MemoryAllocator PRIVATE D3D12MA_TIGHT_ALIGNMENT_SUPPORTED=1) - if(${D3D12MA_BUILD_SAMPLE} AND ${WIN32}) - target_compile_definitions(D3D12Sample PRIVATE D3D12MA_TIGHT_ALIGNMENT_SUPPORTED=1) - endif() -endif() diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp index 976e872..0d358ea 100644 --- a/src/D3D12MemAlloc.cpp +++ b/src/D3D12MemAlloc.cpp @@ -107,6 +107,22 @@ especially to test compatibility with D3D12_RESOURCE_HEAP_TIER_1 on modern GPUs. #define D3D12MA_DEFAULT_BLOCK_SIZE (64ull * 1024 * 1024) #endif +#ifndef D3D12MA_TIGHT_ALIGNMENT_SUPPORTED + #if D3D12_PREVIEW_SDK_VERSION >= 716 + #define D3D12MA_TIGHT_ALIGNMENT_SUPPORTED 1 + #else + #define D3D12MA_TIGHT_ALIGNMENT_SUPPORTED 0 + #endif +#endif + +#ifndef D3D12MA_OPTIONS16_SUPPORTED + #if D3D12_SDK_VERSION >= 610 + #define D3D12MA_OPTIONS16_SUPPORTED 1 + #else + #define D3D12MA_OPTIONS16_SUPPORTED 0 + #endif +#endif + #ifndef D3D12MA_DEBUG_LOG #define D3D12MA_DEBUG_LOG(format, ...) /* @@ -6168,9 +6184,6 @@ HRESULT AllocatorPimpl::Init(const ALLOCATOR_DESC& desc) m_D3D12Options.ResourceHeapTier = (D3D12MA_FORCE_RESOURCE_HEAP_TIER); #endif -// You must define this macro to like `#define D3D12MA_OPTIONS16_SUPPORTED 1` to enable GPU Upload Heaps! -// Unfortunately there is no way to programmatically check if the included defines D3D12_FEATURE_DATA_D3D12_OPTIONS16 or not. -// Main interfaces have respective macros like __ID3D12Device4_INTERFACE_DEFINED__, but structures like this do not. #if D3D12MA_OPTIONS16_SUPPORTED { D3D12_FEATURE_DATA_D3D12_OPTIONS16 options16 = {}; @@ -6180,11 +6193,8 @@ HRESULT AllocatorPimpl::Init(const ALLOCATOR_DESC& desc) m_GPUUploadHeapSupported = options16.GPUUploadHeapSupported; } } -#endif +#endif // #if D3D12MA_OPTIONS16_SUPPORTED - // You must define macro `#define D3D12MA_TIGHT_ALIGNMENT_SUPPORTED 1` to enable resource tight alignment! - // Unfortunately there is no way to programmatically check if the included defines D3D12_FEATURE_DATA_TIGHT_ALIGNMENT or not. - // Main interfaces have respective macros like __ID3D12Device4_INTERFACE_DEFINED__, but structures like this do not. #if D3D12MA_TIGHT_ALIGNMENT_SUPPORTED { D3D12_FEATURE_DATA_TIGHT_ALIGNMENT tightAlignment = {}; @@ -6202,7 +6212,7 @@ HRESULT AllocatorPimpl::Init(const ALLOCATOR_DESC& desc) } } } -#endif +#endif // #if D3D12MA_TIGHT_ALIGNMENT_SUPPORTED hr = m_Device->CheckFeatureSupport(D3D12_FEATURE_ARCHITECTURE, &m_D3D12Architecture, sizeof(m_D3D12Architecture)); if (FAILED(hr)) @@ -7427,7 +7437,7 @@ HRESULT AllocatorPimpl::CalcAllocationParams(const ALLOCATION_DESC& allocDesc, U outPreferCommitted = false; D3D12MA_ASSERT((allocDesc.HeapType != D3D12_HEAP_TYPE_GPU_UPLOAD_COPY || IsGPUUploadHeapSupported()) && - "Trying to allocate from D3D12_HEAP_TYPE_GPU_UPLOAD while GPUUploadHeapSupported == FALSE or D3D12MA_OPTIONS16_SUPPORTED macro was not defined when compiling D3D12MA library."); + "Trying to allocate from D3D12_HEAP_TYPE_GPU_UPLOAD while GPUUploadHeapSupported == FALSE."); bool msaaAlwaysCommitted; if (allocDesc.CustomPool != NULL) diff --git a/src/Doxyfile b/src/Doxyfile index a93bdbb..e9cc11b 100644 --- a/src/Doxyfile +++ b/src/Doxyfile @@ -42,7 +42,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "Direct3D 12 Memory Allocator" +PROJECT_NAME = "D3D12 Memory Allocator" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version @@ -2372,6 +2372,8 @@ PREDEFINED = __ID3D12Device1_INTERFACE_DEFINED__ \ __ID3D12Device4_INTERFACE_DEFINED__ \ __ID3D12Device8_INTERFACE_DEFINED__ \ __ID3D12Device10_INTERFACE_DEFINED__ \ + D3D12_PREVIEW_SDK_VERSION=716 \ + D3D12_SDK_VERSION=716 \ protected=private # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this diff --git a/src/Tests.cpp b/src/Tests.cpp index 40388f9..f52419a 100644 --- a/src/Tests.cpp +++ b/src/Tests.cpp @@ -51,6 +51,8 @@ static constexpr UINT64 MEGABYTE = 1024 * KILOBYTE; static constexpr CONFIG_TYPE ConfigType = CONFIG_TYPE_AVERAGE; static const char* FREE_ORDER_NAMES[] = { "FORWARD", "BACKWARD", "RANDOM", }; +constexpr D3D12_RESOURCE_FLAGS D3D12_RESOURCE_FLAG_USE_TIGHT_ALIGNMENT_COPY = (D3D12_RESOURCE_FLAGS)0x400; + // Indexes match enum D3D12_HEAP_TYPE. static const WCHAR* const HEAP_TYPE_NAMES[] = { @@ -204,6 +206,10 @@ static void FillAllocationsDataGPU(const TestContext& ctx, const ComPtrGetResource()->GetDesc(); if (resDesc.Dimension == D3D12_RESOURCE_DIMENSION_BUFFER) { + // Fix for D3D12 ERROR: ID3D12Device::CreatePlacedResource: D3D12_RESOURCE_DESC::Alignment is invalid. The value is 8. When D3D12_RESOURCE_DESC::Flag bit for D3D12_RESOURCE_FLAG_USE_TIGHT_ALIGNMENT is set, Alignment must be 0. [ STATE_CREATION ERROR #721: CREATERESOURCE_INVALIDALIGNMENT] + if ((resDesc.Flags & D3D12_RESOURCE_FLAG_USE_TIGHT_ALIGNMENT_COPY) != 0) + resDesc.Alignment = 0; + ComPtr uploadAlloc; CHECK_HR(ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_GENERIC_READ, nullptr, &uploadAlloc, IID_NULL, nullptr)); @@ -296,6 +302,10 @@ static void ValidateAllocationsDataGPU(const TestContext& ctx, const ComPtrGetResource()->GetDesc(); if (resDesc.Dimension == D3D12_RESOURCE_DIMENSION_BUFFER) { + // Fix for D3D12 ERROR: ID3D12Device::CreatePlacedResource: D3D12_RESOURCE_DESC::Alignment is invalid. The value is 8. When D3D12_RESOURCE_DESC::Flag bit for D3D12_RESOURCE_FLAG_USE_TIGHT_ALIGNMENT is set, Alignment must be 0. [ STATE_CREATION ERROR #721: CREATERESOURCE_INVALIDALIGNMENT] + if ((resDesc.Flags & D3D12_RESOURCE_FLAG_USE_TIGHT_ALIGNMENT_COPY) != 0) + resDesc.Alignment = 0; + ComPtr downloadAlloc; CHECK_HR(ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COPY_DEST, nullptr, &downloadAlloc, IID_NULL, nullptr)); @@ -762,7 +772,13 @@ static void TestSmallBuffers(const TestContext& ctx) CHECK_HR(ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &resWithAlloc.allocation, IID_PPV_ARGS(&resWithAlloc.resource))); CHECK_BOOL(resWithAlloc.allocation && resWithAlloc.allocation->GetResource()); - CHECK_BOOL(!resWithAlloc.allocation->GetHeap()); // Expected to be committed. + // May or may not be committed, depending on the PREFER_SMALL_BUFFERS_COMMITTED + // and TIGHT_ALIGNMENT settings. + const bool isCommitted = resWithAlloc.allocation->GetHeap() == NULL; + if (isCommitted) + wprintf(L" Small buffer %llu B inside a custom pool was created as committed.\n", resDesc.Width); + else + wprintf(L" Small buffer %llu B inside a custom pool was created as placed.\n", resDesc.Width); } // Test 3: NEVER_ALLOCATE. @@ -2857,7 +2873,7 @@ static void TestDevice10(const TestContext& ctx) static void TestGPUUploadHeap(const TestContext& ctx) { -#if D3D12MA_OPTIONS16_SUPPORTED +#if D3D12_SDK_VERSION >= 610 using namespace D3D12MA; wprintf(L"Test GPU Upload Heap\n"); @@ -3003,7 +3019,6 @@ static void TestGPUUploadHeap(const TestContext& ctx) static void TestTightAlignment(const TestContext& ctx) { -#if D3D12MA_TIGHT_ALIGNMENT_SUPPORTED using namespace D3D12MA; wprintf(L"Test resource tight alignment\n"); @@ -3047,7 +3062,6 @@ static void TestTightAlignment(const TestContext& ctx) resDesc.Width, allocs[1]->GetOffset()); } -#endif } static void TestVirtualBlocks(const TestContext& ctx) @@ -3418,6 +3432,11 @@ static void ProcessDefragmentationPass(const TestContext& ctx, D3D12MA::DEFRAGME const bool isDefaultHeap = stepInfo.pMoves[i].pSrcAllocation->GetHeap()->GetDesc().Properties.Type == D3D12_HEAP_TYPE_DEFAULT; // Create new resource D3D12_RESOURCE_DESC desc = stepInfo.pMoves[i].pSrcAllocation->GetResource()->GetDesc(); + + // Fix for D3D12 ERROR: ID3D12Device::CreatePlacedResource: D3D12_RESOURCE_DESC::Alignment is invalid. The value is 8. When D3D12_RESOURCE_DESC::Flag bit for D3D12_RESOURCE_FLAG_USE_TIGHT_ALIGNMENT is set, Alignment must be 0. [ STATE_CREATION ERROR #721: CREATERESOURCE_INVALIDALIGNMENT] + if ((desc.Flags & D3D12_RESOURCE_FLAG_USE_TIGHT_ALIGNMENT_COPY) != 0) + desc.Alignment = 0; + ComPtr dstRes; CHECK_HR(ctx.device->CreatePlacedResource(stepInfo.pMoves[i].pDstTmpAllocation->GetHeap(), stepInfo.pMoves[i].pDstTmpAllocation->GetOffset(), &desc, From 3ca443a8ae328391099b8e5d7b5c1c3759e2a676 Mon Sep 17 00:00:00 2001 From: Adam Sawicki Date: Fri, 28 Feb 2025 13:47:16 +0100 Subject: [PATCH 05/10] Added documentation chapter "Optimal resource allocation" Also other fixes in the documentation. Updated Doxyfile to the new Doxygen version. Regenerated the docs. --- docs/html/_d3_d12_mem_alloc_8h.html | 13 +- docs/html/annotated.html | 4 +- ...ass_d3_d12_m_a_1_1_allocation-members.html | 4 +- .../html/class_d3_d12_m_a_1_1_allocation.html | 4 +- ...lass_d3_d12_m_a_1_1_allocator-members.html | 9 +- docs/html/class_d3_d12_m_a_1_1_allocator.html | 32 +- ...a_1_1_defragmentation_context-members.html | 4 +- ...3_d12_m_a_1_1_defragmentation_context.html | 4 +- .../class_d3_d12_m_a_1_1_pool-members.html | 4 +- docs/html/class_d3_d12_m_a_1_1_pool.html | 4 +- ..._d3_d12_m_a_1_1_virtual_block-members.html | 4 +- .../class_d3_d12_m_a_1_1_virtual_block.html | 4 +- docs/html/classes.html | 4 +- docs/html/configuration.html | 20 +- docs/html/custom_pools.html | 8 +- docs/html/defragmentation.html | 26 +- .../dir_d44c64559bbebec7f509842c48db8b23.html | 4 +- docs/html/doxygen_crawl.html | 10 + docs/html/files.html | 4 +- docs/html/functions.html | 5 +- docs/html/functions_func.html | 5 +- docs/html/functions_rela.html | 4 +- docs/html/functions_vars.html | 4 +- docs/html/general_considerations.html | 4 +- docs/html/globals.html | 4 +- docs/html/globals_defs.html | 4 +- docs/html/hierarchy.html | 4 +- docs/html/index.html | 20 +- docs/html/linear_algorithm.html | 4 +- docs/html/namespace_d3_d12_m_a.html | 11 +- docs/html/namespacemembers.html | 5 +- docs/html/namespacemembers_enum.html | 4 +- docs/html/namespacemembers_eval.html | 5 +- docs/html/namespacemembers_func.html | 4 +- docs/html/namespacemembers_type.html | 4 +- docs/html/namespaces.html | 4 +- docs/html/optimal_allocation.html | 343 ++++++++ docs/html/quick_start.html | 41 +- docs/html/resource_aliasing.html | 14 +- docs/html/search/all_0.js | 99 +-- docs/html/search/all_1.js | 7 +- docs/html/search/all_10.js | 14 +- docs/html/search/all_11.js | 28 +- docs/html/search/all_13.js | 5 +- docs/html/search/all_14.js | 39 +- docs/html/search/all_15.js | 2 +- docs/html/search/all_2.js | 41 +- docs/html/search/all_3.js | 2 +- docs/html/search/all_6.js | 3 +- docs/html/search/all_7.js | 2 +- docs/html/search/all_8.js | 3 +- docs/html/search/all_a.js | 3 +- docs/html/search/all_b.js | 4 +- docs/html/search/all_d.js | 11 +- docs/html/search/all_e.js | 35 +- docs/html/search/enumvalues_0.js | 7 +- docs/html/search/functions_6.js | 3 +- docs/html/search/pages_0.js | 9 +- docs/html/search/pages_1.js | 2 +- docs/html/search/pages_2.js | 2 +- docs/html/search/pages_5.js | 2 +- docs/html/search/pages_6.js | 3 +- docs/html/search/pages_7.js | 2 +- docs/html/search/pages_9.js | 3 +- docs/html/search/pages_a.js | 2 +- docs/html/search/pages_b.js | 2 +- docs/html/search/searchdata.js | 2 +- docs/html/statistics.html | 12 +- ...a_t_i_o_n___c_a_l_l_b_a_c_k_s-members.html | 4 +- ...l_l_o_c_a_t_i_o_n___c_a_l_l_b_a_c_k_s.html | 4 +- ...a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html | 4 +- ...m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html | 4 +- ...1_a_l_l_o_c_a_t_o_r___d_e_s_c-members.html | 4 +- ...2_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html | 4 +- .../struct_d3_d12_m_a_1_1_budget-members.html | 4 +- docs/html/struct_d3_d12_m_a_1_1_budget.html | 4 +- ...g_m_e_n_t_a_t_i_o_n___d_e_s_c-members.html | 4 +- ...e_f_r_a_g_m_e_n_t_a_t_i_o_n___d_e_s_c.html | 4 +- ...g_m_e_n_t_a_t_i_o_n___m_o_v_e-members.html | 4 +- ...e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html | 4 +- ...__p_a_s_s___m_o_v_e___i_n_f_o-members.html | 4 +- ...t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html | 4 +- ...m_e_n_t_a_t_i_o_n___s_t_a_t_s-members.html | 4 +- ...f_r_a_g_m_e_n_t_a_t_i_o_n___s_t_a_t_s.html | 4 +- ...2_m_a_1_1_detailed_statistics-members.html | 4 +- ...ct_d3_d12_m_a_1_1_detailed_statistics.html | 4 +- ...d12_m_a_1_1_p_o_o_l___d_e_s_c-members.html | 4 +- ...ruct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html | 4 +- ...uct_d3_d12_m_a_1_1_statistics-members.html | 4 +- .../struct_d3_d12_m_a_1_1_statistics.html | 4 +- ..._d12_m_a_1_1_total_statistics-members.html | 4 +- ...truct_d3_d12_m_a_1_1_total_statistics.html | 4 +- ...a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html | 4 +- ...u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html | 4 +- ...a_l_l_o_c_a_t_i_o_n___i_n_f_o-members.html | 4 +- ...u_a_l___a_l_l_o_c_a_t_i_o_n___i_n_f_o.html | 4 +- ...t_u_a_l___b_l_o_c_k___d_e_s_c-members.html | 4 +- ...1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html | 4 +- ...12_m_a_1_1_virtual_allocation-members.html | 4 +- ...uct_d3_d12_m_a_1_1_virtual_allocation.html | 4 +- docs/html/virtual_allocator.html | 28 +- include/D3D12MemAlloc.h | 558 ++++++++++++- src/D3D12MemAlloc.cpp | 2 +- src/Doxyfile | 730 +++++++++++------- 104 files changed, 1778 insertions(+), 676 deletions(-) create mode 100644 docs/html/optimal_allocation.html diff --git a/docs/html/_d3_d12_mem_alloc_8h.html b/docs/html/_d3_d12_mem_alloc_8h.html index 05320f0..6df7c0d 100644 --- a/docs/html/_d3_d12_mem_alloc_8h.html +++ b/docs/html/_d3_d12_mem_alloc_8h.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D:/PROJECTS/D3D12 Memory Allocator/REPO/include/D3D12MemAlloc.h File Reference +D3D12 Memory Allocator: D:/PROJECTS/D3D12 Memory Allocator/REPO/include/D3D12MemAlloc.h File Reference @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
@@ -177,6 +177,7 @@ #define D3D12MA_DXGI_1_4   0   #define D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT   1 + 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.
  @@ -299,6 +301,13 @@

+

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.
    • +
+ diff --git a/docs/html/annotated.html b/docs/html/annotated.html index 7e00073..6810191 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Class List +D3D12 Memory Allocator: Class List @@ -25,7 +25,7 @@

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 95e5051..65c9dc6 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Member List +D3D12 Memory Allocator: Member List @@ -25,7 +25,7 @@ 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 7e17b43..33f9020 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D3D12MA::Allocation Class Reference +D3D12 Memory Allocator: D3D12MA::Allocation Class Reference @@ -25,7 +25,7 @@ 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 423ebc5..7edcd19 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Member List +D3D12 Memory Allocator: Member List @@ -25,7 +25,7 @@ @@ -113,8 +113,9 @@ - - + + +

@@ -240,6 +241,7 @@ ,
  D3D12MA::ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED = 0x8 , D3D12MA::ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED = 0x10 +, D3D12MA::ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT = 0x20
}

 Bit flags to be used with ALLOCATOR_DESC::Flags. More...
-
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
-
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
-
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
-
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
GetMemoryCapacity(UINT memorySegmentGroup) constD3D12MA::Allocator
IsCacheCoherentUMA() constD3D12MA::Allocator
IsGPUUploadHeapSupported() constD3D12MA::Allocator
IsUMA() constD3D12MA::Allocator
SetCurrentFrameIndex(UINT frameIndex)D3D12MA::Allocator
IsTightAlignmentSupported() constD3D12MA::Allocator
IsUMA() constD3D12MA::Allocator
SetCurrentFrameIndex(UINT frameIndex)D3D12MA::Allocator
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 5d13c83..dfd6550 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D3D12MA::Allocator Class Reference +D3D12 Memory Allocator: D3D12MA::Allocator Class Reference @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
@@ -120,6 +120,9 @@ BOOL IsGPUUploadHeapSupported () const  Returns true if GPU Upload Heaps are supported on the current system.
  +BOOL IsTightAlignmentSupported () const + Returns true if resource tight alignment is supported on the current system. When supported, it is automatically used by the library, unless ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT flag was specified on allocator creation.
+  UINT64 GetMemoryCapacity (UINT memorySegmentGroup) const  Returns total amount of memory of specific segment group, in bytes.
  @@ -753,7 +756,7 @@

Parameters
- +
memorySegmentGroupuse DXGI_MEMORY_SEGMENT_GROUP_LOCAL or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL`.
memorySegmentGroupuse DXGI_MEMORY_SEGMENT_GROUP_LOCAL or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL.
@@ -815,8 +818,27 @@

+

◆ IsTightAlignmentSupported()

+ +
+
+ + + + + + + +
BOOL D3D12MA::Allocator::IsTightAlignmentSupported () const
+
+ +

Returns true if resource tight alignment is supported on the current system. When supported, it is automatically used by the library, unless ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT flag was specified on allocator creation.

+

This flag is fetched from D3D12_FEATURE_DATA_TIGHT_ALIGNMENT::SupportTier.

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 71df82b..fcd4c40 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Member List +D3D12 Memory Allocator: Member List @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 41f9fb7..19b83c9 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D3D12MA::DefragmentationContext Class Reference +D3D12 Memory Allocator: D3D12MA::DefragmentationContext Class Reference @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 63a614b..f90127f 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Member List +D3D12 Memory Allocator: Member List @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 e971eb3..2f28606 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D3D12MA::Pool Class Reference +D3D12 Memory Allocator: D3D12MA::Pool Class Reference @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 ce7ed03..4f3596e 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Member List +D3D12 Memory Allocator: Member List @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 1ebc4ac..3b2426d 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D3D12MA::VirtualBlock Class Reference +D3D12 Memory Allocator: D3D12MA::VirtualBlock Class Reference @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
diff --git a/docs/html/classes.html b/docs/html/classes.html index 15cc068..5794267 100644 --- a/docs/html/classes.html +++ b/docs/html/classes.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Class Index +D3D12 Memory Allocator: Class Index @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
diff --git a/docs/html/configuration.html b/docs/html/configuration.html index 4820d1d..3c35991 100644 --- a/docs/html/configuration.html +++ b/docs/html/configuration.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Configuration +D3D12 Memory Allocator: Configuration @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
@@ -123,15 +123,15 @@

D3D12MA::Allocator* allocator;
HRESULT hr = D3D12MA::CreateAllocator(&allocatorDesc, &allocator);
-
D3D12MA::Allocator
Represents main object of this library initialized for particular ID3D12Device.
Definition D3D12MemAlloc.h:1099
+
D3D12MA::Allocator
Represents main object of this library initialized for particular ID3D12Device.
Definition D3D12MemAlloc.h:1118
D3D12MA::CreateAllocator
D3D12MA_API HRESULT CreateAllocator(const ALLOCATOR_DESC *pDesc, Allocator **ppAllocator)
Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
-
D3D12MA::ALLOCATION_CALLBACKS
Custom callbacks to CPU memory allocation functions.
Definition D3D12MemAlloc.h:209
-
D3D12MA::ALLOCATION_CALLBACKS::pFree
FREE_FUNC_PTR pFree
Dellocation function.
Definition D3D12MemAlloc.h:213
-
D3D12MA::ALLOCATION_CALLBACKS::pAllocate
ALLOCATE_FUNC_PTR pAllocate
Allocation function.
Definition D3D12MemAlloc.h:211
-
D3D12MA::ALLOCATOR_DESC
Parameters of created Allocator object. To be used with CreateAllocator().
Definition D3D12MemAlloc.h:1060
-
D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks
const ALLOCATION_CALLBACKS * pAllocationCallbacks
Custom CPU memory allocation callbacks. Optional.
Definition D3D12MemAlloc.h:1080
-
D3D12MA::ALLOCATOR_DESC::pAdapter
IDXGIAdapter * pAdapter
Definition D3D12MemAlloc.h:1086
-
D3D12MA::ALLOCATOR_DESC::pDevice
ID3D12Device * pDevice
Definition D3D12MemAlloc.h:1068
+
D3D12MA::ALLOCATION_CALLBACKS
Custom callbacks to CPU memory allocation functions.
Definition D3D12MemAlloc.h:217
+
D3D12MA::ALLOCATION_CALLBACKS::pFree
FREE_FUNC_PTR pFree
Dellocation function.
Definition D3D12MemAlloc.h:221
+
D3D12MA::ALLOCATION_CALLBACKS::pAllocate
ALLOCATE_FUNC_PTR pAllocate
Allocation function.
Definition D3D12MemAlloc.h:219
+
D3D12MA::ALLOCATOR_DESC
Parameters of created Allocator object. To be used with CreateAllocator().
Definition D3D12MemAlloc.h:1079
+
D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks
const ALLOCATION_CALLBACKS * pAllocationCallbacks
Custom CPU memory allocation callbacks. Optional.
Definition D3D12MemAlloc.h:1099
+
D3D12MA::ALLOCATOR_DESC::pAdapter
IDXGIAdapter * pAdapter
Definition D3D12MemAlloc.h:1105
+
D3D12MA::ALLOCATOR_DESC::pDevice
ID3D12Device * pDevice
Definition D3D12MemAlloc.h:1087

Debug margins

By default, allocations are laid out in memory blocks next to each other if possible (considering required alignment returned by ID3D12Device::GetResourceAllocationInfo).

diff --git a/docs/html/custom_pools.html b/docs/html/custom_pools.html index 0495016..c5079f7 100644 --- a/docs/html/custom_pools.html +++ b/docs/html/custom_pools.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Custom memory pools +D3D12 Memory Allocator: Custom memory pools @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
@@ -83,7 +83,7 @@
@@ -103,7 +103,7 @@

Pool* pool;
HRESULT hr = allocator->CreatePool(&poolDesc, &pool);
-
D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED
@ POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED
Optimization, allocate MSAA textures as committed resources always.
Definition D3D12MemAlloc.h:842
+
D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED
@ POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED
Optimization, allocate MSAA textures as committed resources always.
Definition D3D12MemAlloc.h:850

To allocate resources out of a custom pool, only set member D3D12MA::ALLOCATION_DESC::CustomPool. Example:

ALLOCATION_DESC allocDesc = {};
allocDesc.CustomPool = pool;
diff --git a/docs/html/defragmentation.html b/docs/html/defragmentation.html index c51751c..95d5ca1 100644 --- a/docs/html/defragmentation.html +++ b/docs/html/defragmentation.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Defragmentation +D3D12 Memory Allocator: Defragmentation @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
@@ -83,7 +83,7 @@
@@ -149,19 +149,19 @@
defragCtx->Release();
D3D12MA::Allocation::SetResource
void SetResource(ID3D12Resource *pResource)
Releases the resource currently pointed by the allocation (if any), sets it to new one,...
D3D12MA::Allocation::GetOffset
UINT64 GetOffset() const
Returns offset in bytes from the start of memory heap.
-
D3D12MA::Allocation::GetResource
ID3D12Resource * GetResource() const
Returns D3D12 resource associated with this object.
Definition D3D12MemAlloc.h:512
+
D3D12MA::Allocation::GetResource
ID3D12Resource * GetResource() const
Returns D3D12 resource associated with this object.
Definition D3D12MemAlloc.h:520
D3D12MA::Allocation::GetHeap
ID3D12Heap * GetHeap() const
Returns memory heap that the resource is created in.
-
D3D12MA::DefragmentationContext
Represents defragmentation process in progress.
Definition D3D12MemAlloc.h:768
+
D3D12MA::DefragmentationContext
Represents defragmentation process in progress.
Definition D3D12MemAlloc.h:776
D3D12MA::DefragmentationContext::BeginPass
HRESULT BeginPass(DEFRAGMENTATION_PASS_MOVE_INFO *pPassInfo)
Starts single defragmentation pass.
D3D12MA::DefragmentationContext::EndPass
HRESULT EndPass(DEFRAGMENTATION_PASS_MOVE_INFO *pPassInfo)
Ends single defragmentation pass.
-
D3D12MA::DEFRAGMENTATION_FLAG_ALGORITHM_FAST
@ DEFRAGMENTATION_FLAG_ALGORITHM_FAST
Definition D3D12MemAlloc.h:648
-
D3D12MA::DEFRAGMENTATION_DESC
Parameters for defragmentation.
Definition D3D12MemAlloc.h:670
-
D3D12MA::DEFRAGMENTATION_DESC::Flags
DEFRAGMENTATION_FLAGS Flags
Flags.
Definition D3D12MemAlloc.h:672
-
D3D12MA::DEFRAGMENTATION_MOVE::pSrcAllocation
Allocation * pSrcAllocation
Allocation that should be moved.
Definition D3D12MemAlloc.h:706
-
D3D12MA::DEFRAGMENTATION_MOVE::pDstTmpAllocation
Allocation * pDstTmpAllocation
Temporary allocation pointing to destination memory that will replace pSrcAllocation.
Definition D3D12MemAlloc.h:714
-
D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO
Parameters for incremental defragmentation steps.
Definition D3D12MemAlloc.h:722
-
D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO::pMoves
DEFRAGMENTATION_MOVE * pMoves
Array of moves to be performed by the user in the current defragmentation pass.
Definition D3D12MemAlloc.h:746
-
D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO::MoveCount
UINT32 MoveCount
Number of elements in the pMoves array.
Definition D3D12MemAlloc.h:724
+
D3D12MA::DEFRAGMENTATION_FLAG_ALGORITHM_FAST
@ DEFRAGMENTATION_FLAG_ALGORITHM_FAST
Definition D3D12MemAlloc.h:656
+
D3D12MA::DEFRAGMENTATION_DESC
Parameters for defragmentation.
Definition D3D12MemAlloc.h:678
+
D3D12MA::DEFRAGMENTATION_DESC::Flags
DEFRAGMENTATION_FLAGS Flags
Flags.
Definition D3D12MemAlloc.h:680
+
D3D12MA::DEFRAGMENTATION_MOVE::pSrcAllocation
Allocation * pSrcAllocation
Allocation that should be moved.
Definition D3D12MemAlloc.h:714
+
D3D12MA::DEFRAGMENTATION_MOVE::pDstTmpAllocation
Allocation * pDstTmpAllocation
Temporary allocation pointing to destination memory that will replace pSrcAllocation.
Definition D3D12MemAlloc.h:722
+
D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO
Parameters for incremental defragmentation steps.
Definition D3D12MemAlloc.h:730
+
D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO::pMoves
DEFRAGMENTATION_MOVE * pMoves
Array of moves to be performed by the user in the current defragmentation pass.
Definition D3D12MemAlloc.h:754
+
D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO::MoveCount
UINT32 MoveCount
Number of elements in the pMoves array.
Definition D3D12MemAlloc.h:732

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:

  1. D3D12MA::DefragmentationContext::BeginPass() function call:
      diff --git a/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html b/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html index 38f9628..3c08bf3 100644 --- a/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html +++ b/docs/html/dir_d44c64559bbebec7f509842c48db8b23.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D:/PROJECTS/D3D12 Memory Allocator/REPO/include Directory Reference +D3D12 Memory Allocator: D:/PROJECTS/D3D12 Memory Allocator/REPO/include Directory Reference @@ -25,7 +25,7 @@ -
      Direct3D 12 Memory Allocator +
      D3D12 Memory Allocator
      diff --git a/docs/html/doxygen_crawl.html b/docs/html/doxygen_crawl.html index 9c3b721..fc67b01 100644 --- a/docs/html/doxygen_crawl.html +++ b/docs/html/doxygen_crawl.html @@ -50,6 +50,7 @@ + @@ -181,6 +182,7 @@ + @@ -188,6 +190,14 @@ + + + + + + + + diff --git a/docs/html/files.html b/docs/html/files.html index 36c9955..28558a5 100644 --- a/docs/html/files.html +++ b/docs/html/files.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: File List +D3D12 Memory Allocator: File List @@ -25,7 +25,7 @@ -
      Direct3D 12 Memory Allocator +
      D3D12 Memory Allocator
      diff --git a/docs/html/functions.html b/docs/html/functions.html index 64a07fd..2238de9 100644 --- a/docs/html/functions.html +++ b/docs/html/functions.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Class Members +D3D12 Memory Allocator: Class Members @@ -25,7 +25,7 @@ -
      Direct3D 12 Memory Allocator +
      D3D12 Memory Allocator
      @@ -179,6 +179,7 @@

      - i -

      diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html index 7251365..83ac449 100644 --- a/docs/html/functions_func.html +++ b/docs/html/functions_func.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Class Members - Functions +D3D12 Memory Allocator: Class Members - Functions @@ -25,7 +25,7 @@ -
      Direct3D 12 Memory Allocator +
      D3D12 Memory Allocator
      @@ -145,6 +145,7 @@

      - i -

      diff --git a/docs/html/functions_rela.html b/docs/html/functions_rela.html index 517d838..cbd5b47 100644 --- a/docs/html/functions_rela.html +++ b/docs/html/functions_rela.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Class Members - Related Symbols +D3D12 Memory Allocator: Class Members - Related Symbols @@ -25,7 +25,7 @@ -
      Direct3D 12 Memory Allocator +
      D3D12 Memory Allocator
      diff --git a/docs/html/functions_vars.html b/docs/html/functions_vars.html index a09deae..ed87ba0 100644 --- a/docs/html/functions_vars.html +++ b/docs/html/functions_vars.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Class Members - Variables +D3D12 Memory Allocator: Class Members - Variables @@ -25,7 +25,7 @@ -
      Direct3D 12 Memory Allocator +
      D3D12 Memory Allocator
      diff --git a/docs/html/general_considerations.html b/docs/html/general_considerations.html index ee4137b..a7bdf9a 100644 --- a/docs/html/general_considerations.html +++ b/docs/html/general_considerations.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: General considerations +D3D12 Memory Allocator: General considerations @@ -25,7 +25,7 @@ -
      Direct3D 12 Memory Allocator +
      D3D12 Memory Allocator
      diff --git a/docs/html/globals.html b/docs/html/globals.html index b075da5..2ebbaba 100644 --- a/docs/html/globals.html +++ b/docs/html/globals.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: File Members +D3D12 Memory Allocator: File Members @@ -25,7 +25,7 @@ -
      Direct3D 12 Memory Allocator +
      D3D12 Memory Allocator
      diff --git a/docs/html/globals_defs.html b/docs/html/globals_defs.html index 037a217..e09e7de 100644 --- a/docs/html/globals_defs.html +++ b/docs/html/globals_defs.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: File Members +D3D12 Memory Allocator: File Members @@ -25,7 +25,7 @@ -
      Direct3D 12 Memory Allocator +
      D3D12 Memory Allocator
      diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html index 211b00d..0f059c3 100644 --- a/docs/html/hierarchy.html +++ b/docs/html/hierarchy.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Class Hierarchy +D3D12 Memory Allocator: Class Hierarchy @@ -25,7 +25,7 @@ -
      Direct3D 12 Memory Allocator +
      D3D12 Memory Allocator
      diff --git a/docs/html/index.html b/docs/html/index.html index fb4fbdf..fcd9bdc 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D3D12 Memory Allocator +D3D12 Memory Allocator: D3D12 Memory Allocator @@ -25,7 +25,7 @@ -
      Direct3D 12 Memory Allocator +
      D3D12 Memory Allocator
      @@ -102,6 +102,16 @@

  2. Custom memory pools
    3. +
  3. Optimal resource allocation +
  4. Defragmentation
  5. Statistics
  6. Resource aliasing (overlap)
    7. @@ -120,10 +130,10 @@

    -See also

    +Web links

diff --git a/docs/html/linear_algorithm.html b/docs/html/linear_algorithm.html index ab1c83f..8281445 100644 --- a/docs/html/linear_algorithm.html +++ b/docs/html/linear_algorithm.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Linear allocation algorithm +D3D12 Memory Allocator: Linear allocation algorithm @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
diff --git a/docs/html/namespace_d3_d12_m_a.html b/docs/html/namespace_d3_d12_m_a.html index 6b44315..0d3ce28 100644 --- a/docs/html/namespace_d3_d12_m_a.html +++ b/docs/html/namespace_d3_d12_m_a.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D3D12MA Namespace Reference +D3D12 Memory Allocator: D3D12MA Namespace Reference @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
@@ -220,6 +220,7 @@ ,
  ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED = 0x8 , ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED = 0x10 +, ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT = 0x20
}  Bit flags to be used with ALLOCATOR_DESC::Flags. More...
@@ -384,7 +385,11 @@

D3D12MA::ALLOCATION_FLAG_COMMITTED. Usage of this flags enables all default pools to create its heaps on smaller alignment not suitable for MSAA textures.

ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED 

Disable optimization that prefers creating small buffers as committed to avoid 64 KB alignment.

-

By default, the library prefers creating small buffers <= 32 KB as committed, because drivers tend to pack them better, while placed buffers require 64 KB alignment. This, however, may decrease performance, as creating committed resources involves allocation of implicit heaps, which may take longer than creating placed resources in existing heaps. Passing this flag will disable this committed preference globally for the allocator. It can also be disabled for a single allocation by using ALLOCATION_FLAG_STRATEGY_MIN_TIME.

+

By default, the library prefers creating small buffers <= 32 KB as committed, because drivers tend to pack them better, while placed buffers require 64 KB alignment. This, however, may decrease performance, as creating committed resources involves allocation of implicit heaps, which may take longer than creating placed resources in existing heaps. Passing this flag will disable this committed preference globally for the allocator. It can also be disabled for a single allocation by using ALLOCATION_FLAG_STRATEGY_MIN_TIME.

+

If the tight resource alignment feature is used by the library (which happens automatically whenever supported, unless you use flag ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT), then small buffers are not preferred as committed. Long story short, you don't need to specify any of these flags. The library chooses the most optimal method automatically.

+ +ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT 

Disables the use of the tight alignment feature even when it is supported on the current system. By default, the feature is used whenever available.

+

Support can be checked by D3D12MA::Allocator::IsTightAlignmentSupported() regardless of using this flag.

diff --git a/docs/html/namespacemembers.html b/docs/html/namespacemembers.html index 09c52ac..b1783f8 100644 --- a/docs/html/namespacemembers.html +++ b/docs/html/namespacemembers.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Namespace Members +D3D12 Memory Allocator: Namespace Members @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
@@ -104,6 +104,7 @@

- a -

  • ALLOCATOR_FLAG_ALWAYS_COMMITTED : D3D12MA
  • ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED : D3D12MA
  • ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED : D3D12MA
    • +
  • ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT : D3D12MA
  • ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED : D3D12MA
  • ALLOCATOR_FLAG_NONE : D3D12MA
  • ALLOCATOR_FLAG_SINGLETHREADED : D3D12MA
    • diff --git a/docs/html/namespacemembers_enum.html b/docs/html/namespacemembers_enum.html index a7af29f..dda1cbc 100644 --- a/docs/html/namespacemembers_enum.html +++ b/docs/html/namespacemembers_enum.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Namespace Members +D3D12 Memory Allocator: Namespace Members @@ -25,7 +25,7 @@ -
    Direct3D 12 Memory Allocator +
    D3D12 Memory Allocator
    diff --git a/docs/html/namespacemembers_eval.html b/docs/html/namespacemembers_eval.html index 2c9740a..088763a 100644 --- a/docs/html/namespacemembers_eval.html +++ b/docs/html/namespacemembers_eval.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Namespace Members +D3D12 Memory Allocator: Namespace Members @@ -25,7 +25,7 @@ -
    Direct3D 12 Memory Allocator +
    D3D12 Memory Allocator
    @@ -102,6 +102,7 @@

    - a -

    • ALLOCATOR_FLAG_ALWAYS_COMMITTED : D3D12MA
    • ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED : D3D12MA
    • ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED : D3D12MA
      • +
    • ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT : D3D12MA
    • ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED : D3D12MA
    • ALLOCATOR_FLAG_NONE : D3D12MA
    • ALLOCATOR_FLAG_SINGLETHREADED : D3D12MA
      • diff --git a/docs/html/namespacemembers_func.html b/docs/html/namespacemembers_func.html index 5ad85ea..ef39b20 100644 --- a/docs/html/namespacemembers_func.html +++ b/docs/html/namespacemembers_func.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Namespace Members +D3D12 Memory Allocator: Namespace Members @@ -25,7 +25,7 @@ -
      Direct3D 12 Memory Allocator +
      D3D12 Memory Allocator
      diff --git a/docs/html/namespacemembers_type.html b/docs/html/namespacemembers_type.html index cfeedab..47e74d5 100644 --- a/docs/html/namespacemembers_type.html +++ b/docs/html/namespacemembers_type.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Namespace Members +D3D12 Memory Allocator: Namespace Members @@ -25,7 +25,7 @@ -
      Direct3D 12 Memory Allocator +
      D3D12 Memory Allocator
      diff --git a/docs/html/namespaces.html b/docs/html/namespaces.html index ad83084..3e69317 100644 --- a/docs/html/namespaces.html +++ b/docs/html/namespaces.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Namespace List +D3D12 Memory Allocator: Namespace List @@ -25,7 +25,7 @@ -
      Direct3D 12 Memory Allocator +
      D3D12 Memory Allocator
      diff --git a/docs/html/optimal_allocation.html b/docs/html/optimal_allocation.html new file mode 100644 index 0000000..db28324 --- /dev/null +++ b/docs/html/optimal_allocation.html @@ -0,0 +1,343 @@ + + + + + + + +D3D12 Memory Allocator: Optimal resource allocation + + + + + + + + + + + + + +
      +
      + + + + + + +
      +
      D3D12 Memory Allocator +
      +
      +
      + + + + + + + + + + +
      +
      + + +
      +
      +
      +
      +
      +
      Loading...
      +
      Searching...
      +
      No Matches
      +
      +
      +
      +
      + + +
      +
      +
      +
      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 may succeed, but take long time (even a significant fraction of a second).
        • +
      • Some resources are automatically evicted 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.
        • +
      +

      Unfortunately, there is no way to be 100% protected against memory overcommitment. The best approach is to avoid allocating too much memory.

      +

      The full capacity of the memory can be queried using function D3D12MA::Allocator::GetMemoryCapacity. However, it is not recommended, because the amount of memory available to the application is typically smaller than the full capacity, as some portion of it is reserved by the operating system or used by other processes.

      +

      Because of this, the recommended way of fetching the memory budget available to the application is using function D3D12MA::Allocator::GetBudget. Preventing value D3D12MA::Budget::UsageBytes from exceeding the D3D12MA::Budget::BudgetBytes is probably the best we can do in trying to avoid the consequences of over-commitment. For more information, see also: Statistics.

      +

      Example:

      +
      D3D12MA::Budget videoMemBudget = {};
      +
      allocator->GetBudget(&videoMemBudget, NULL);
      +
      +
      UINT64 freeBytes = videoMemBudget.BudgetBytes - videoMemBudget.UsageBytes;
      +
      gameStreamingSystem->SetAvailableFreeMemory(freeBytes);
      +
      D3D12MA::Budget
      Statistics of current memory usage and available budget for a specific memory segment group.
      Definition D3D12MemAlloc.h:442
      +
      D3D12MA::Budget::BudgetBytes
      UINT64 BudgetBytes
      Estimated amount of memory available to the program.
      Definition D3D12MemAlloc.h:465
      +
      D3D12MA::Budget::UsageBytes
      UINT64 UsageBytes
      Estimated current memory usage of the program.
      Definition D3D12MemAlloc.h:454
      +
      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.

      +

      +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.

      +
      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:

      + +

      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.

      +

      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.

      +

      +Residency priority

      +

      When too much video memory is allocated, one of the things that can happen is the system evicting 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 eviction. 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.

      +

      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 evicted to system memory, degrading performance of all the resources placed in it.

      +

      Example:

      +
      D3D12MA::POOL_DESC poolDesc = {};
      +
      poolDesc.HeapProperties.Type = D3D12_HEAP_TYPE_DEFAULT;
      +
      poolDesc.HeapFlags = D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS | D3D12_HEAP_FLAG_CREATE_NOT_ZEROED;
      +
      poolDesc.ResidencyPriority = D3D12_RESIDENCY_PRIORITY_HIGH; // !!!
      +
      +
      D3D12MA::Pool* pool;
      +
      HRESULT hr = allocator->CreatePool(&poolDesc, &pool);
      +
      // Check hr...
      +
      +
      D3D12MA::ALLOCATION_DESC allocDesc = {};
      +
      allocDesc.CustomPool = pool;
      +
      allocDesc.Flags = ALLOCATION_FLAG_COMMITTED; // !!!
      +
      +
      D3D12_RESOURCE_DESC resDesc = {};
      +
      resDesc.Dimension = D3D12_RESOURCE_DIMENSION_BUFFER;
      +
      resDesc.Alignment = 0;
      +
      resDesc.Width = 1048576; // Requested buffer size.
      +
      resDesc.Height = 1;
      +
      resDesc.DepthOrArraySize = 1;
      +
      resDesc.MipLevels = 1;
      +
      resDesc.Format = DXGI_FORMAT_UNKNOWN;
      +
      resDesc.SampleDesc.Count = 1;
      +
      resDesc.SampleDesc.Quality = 0;
      +
      resDesc.Layout = D3D12_TEXTURE_LAYOUT_ROW_MAJOR;
      +
      resDesc.Flags = D3D12_RESOURCE_FLAG_ALLOW_UNORDERED_ACCESS;
      +
      +
      D3D12MA::Allocation* alloc;
      +
      hr = allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON,
      +
      NULL, &alloc, IID_NULL, NULL);
      +
      // Check hr...
      +
      D3D12MA::Allocation
      Represents single memory allocation.
      Definition D3D12MemAlloc.h:491
      +
      D3D12MA::Pool
      Custom memory pool.
      Definition D3D12MemAlloc.h:943
      +
      D3D12MA::ALLOCATION_DESC
      Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.
      Definition D3D12MemAlloc.h:307
      +
      D3D12MA::ALLOCATION_DESC::Flags
      ALLOCATION_FLAGS Flags
      Flags.
      Definition D3D12MemAlloc.h:309
      +
      D3D12MA::ALLOCATION_DESC::CustomPool
      Pool * CustomPool
      Custom pool to place the new resource in. Optional.
      Definition D3D12MemAlloc.h:337
      +
      D3D12MA::POOL_DESC
      Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool.
      Definition D3D12MemAlloc.h:858
      +
      D3D12MA::POOL_DESC::HeapProperties
      D3D12_HEAP_PROPERTIES HeapProperties
      The parameters of memory heap where allocations of this pool should be placed.
      Definition D3D12MemAlloc.h:866
      +
      D3D12MA::POOL_DESC::ResidencyPriority
      D3D12_RESIDENCY_PRIORITY ResidencyPriority
      Residency priority to be set for all allocations made in this pool. Optional.
      Definition D3D12MemAlloc.h:931
      +
      D3D12MA::POOL_DESC::HeapFlags
      D3D12_HEAP_FLAGS HeapFlags
      Heap flags to be used when allocating heaps of this pool.
      Definition D3D12MemAlloc.h:877
      +

      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 eviction 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.
        • +
      +

      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:

      +
        +
      • Supporting motherboard and its UEFI.
        • +
      • Supporting graphics card and its graphics driver.
        • +
      • 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:

      +
        +
      • 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.
        • +
      • 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.

      +
        +
      • 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.

      +

      Example:

      +
      // Fast path for data upload.
      +
      if(allocator->IsGPUUploadHeapSupported())
      +
      {
      +
      D3D12MA::ALLOCATION_DESC allocDesc = {};
      +
      allocDesc.HeapType = D3D12_HEAP_TYPE_GPU_UPLOAD; // !!!
      +
      +
      D3D12_RESOURCE_DESC resDesc = {};
      +
      resDesc.Dimension = D3D12_RESOURCE_DIMENSION_BUFFER;
      +
      resDesc.Alignment = 0;
      +
      resDesc.Width = 1048576; // Requested buffer size.
      +
      resDesc.Height = 1;
      +
      resDesc.DepthOrArraySize = 1;
      +
      resDesc.MipLevels = 1;
      +
      resDesc.Format = DXGI_FORMAT_UNKNOWN;
      +
      resDesc.SampleDesc.Count = 1;
      +
      resDesc.SampleDesc.Quality = 0;
      +
      resDesc.Layout = D3D12_TEXTURE_LAYOUT_ROW_MAJOR;
      +
      resDesc.Flags = D3D12_RESOURCE_FLAG_NONE;
      +
      +
      D3D12MA::Allocation* alloc;
      +
      ID3D12Resource* res;
      +
      hr = allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON,
      +
      NULL, &alloc, IID_PPV_ARGS(&res));
      +
      // Check hr...
      +
      +
      D3D12_RANGE emptyRange = {0, 0};
      +
      void* mappedPtr = NULL;
      +
      hr = res->Map(0, &emptyRange, &mappedPtr);
      +
      memcpy(mappedPtr, srcData, 1048576);
      +
      res->Unmap(0, NULL); // Optional. You can leave it persistently mapped.
      +
      +
      D3D12_GPU_VIRTUAL_ADDRESS gpuva = res->GetGPUVirtualAddress();
      +
      // Use gpuva to access the buffer on the GPU...
      +
      D3D12MA::ALLOCATION_DESC::HeapType
      D3D12_HEAP_TYPE HeapType
      The type of memory heap where the new allocation should be placed.
      Definition D3D12MemAlloc.h:316
      +

      +Committed versus placed resources

      +

      When using D3D12 API directly, there are 3 ways of creating resources:

      +
        +
      1. 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.
        2. +
      2. 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.
        3. +
      3. Reserved, using function ID3D12Device::CreateReservedResource. This library doesn't support them directly.
        4. +
      +

      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 biggest advantage of using placed resources is the allocation performance. Once a heap is allocated, creating and releasing resources placed in it can be much faster than creating them as committed, which would involve allocating a new heap for each resource.
          +
        • Using large number of small heaps can put an extra burden on the software stack, including D3D12 runtime, graphics driver, operating system, and developer tools like Radeon Memory Visualizer (RMV).
          • +
        +
        • +
      • The advantage of committed resources is that their implicit heaps have exactly the right size, while creating resources as placed inside larger heaps can lead to some memory wasted because:
          +
        • Some part of the allocated heap memory is unused.
          • +
        • After placed resources of various sizes are created and released in random order, gaps between remaining resources can be too small to fit new allocations. This is also known as "fragmentation". A solution to this problem is implementing Defragmentation.
          • +
        • The alignment required by placed resources can leave gaps between them, while the driver can pack individual committed resources better. For details, see section "Resource alignment" below.
          • +
        +
        • +
      • 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.
        • +
      • 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.

      +
      Implementation detail
      D3D12MA creates large heaps (default size is 64 MB) and creates resources as placed in them. However, it may decide that it is required or preferred to create the specific resource as committed for many reasons, including: +
      +

      You can check whether an allocation was created as a committed resource by checking if its heap is null. Committed resources have an implicit heap that is not directly accessible.

      +
      bool isCommitted = allocation->GetHeap() == NULL;
      +

      You can request a new resource to be created as committed by using D3D12MA::ALLOCATION_FLAG_COMMITTED. Note that committed resources can also be created out of Custom memory pools.

      +

      You can also request all resources to be created as committed globally for the entire allocator by using D3D12MA::ALLOCATOR_FLAG_ALWAYS_COMMITTED. However, this contradicts the main purpose of using this library. It can also prevent certain other features of the library to be used. This flag should be used only for debugging purposes.

      +

      You can create a custom pool with an explicit block size by specifying non-zero D3D12MA::POOL_DESC::BlockSize. When doing this, all resources created in such pool are placed in those blocks (heaps) and never created as committed. Example:

      +
      D3D12MA::POOL_DESC poolDesc = {};
      +
      poolDesc.HeapFlags = D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS | D3D12_HEAP_FLAG_CREATE_NOT_ZEROED;
      +
      poolDesc.HeapProperties.Type = D3D12_HEAP_TYPE_DEFAULT;
      +
      poolDesc.BlockSize = 100llu * 1024 * 1024; // 100 MB. Explicit BlockSize guarantees placed.
      +
      +
      D3D12MA::Pool* pool;
      +
      HRESULT hr = allocator->CreatePool(&poolDesc, &pool);
      +
      // Check hr...
      +
      +
      D3D12MA::ALLOCATION_DESC allocDesc = {};
      +
      allocDesc.CustomPool = pool;
      +
      +
      D3D12_RESOURCE_DESC resDesc = {};
      +
      resDesc.Dimension = D3D12_RESOURCE_DIMENSION_BUFFER;
      +
      resDesc.Alignment = 0;
      +
      resDesc.Width = 90llu * 1024 * 1024; // 90 MB
      +
      resDesc.Height = 1;
      +
      resDesc.DepthOrArraySize = 1;
      +
      resDesc.MipLevels = 1;
      +
      resDesc.Format = DXGI_FORMAT_UNKNOWN;
      +
      resDesc.SampleDesc.Count = 1;
      +
      resDesc.SampleDesc.Quality = 0;
      +
      resDesc.Layout = D3D12_TEXTURE_LAYOUT_ROW_MAJOR;
      +
      resDesc.Flags = D3D12_RESOURCE_FLAG_NONE;
      +
      +
      D3D12MA::Allocation* alloc;
      +
      ID3D12Resource* res;
      +
      hr = allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON,
      +
      NULL, &alloc, IID_PPV_ARGS(&res));
      +
      // Check hr...
      +
      +
      // Even a large buffer like this, filling 90% of the block, was created as placed!
      +
      assert(alloc->GetHeap() != NULL);
      +
      D3D12MA::Allocation::GetHeap
      ID3D12Heap * GetHeap() const
      Returns memory heap that the resource is created in.
      +
      D3D12MA::POOL_DESC::BlockSize
      UINT64 BlockSize
      Size of a single heap (memory block) to be allocated as part of this pool, in bytes....
      Definition D3D12MemAlloc.h:884
      +

      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.
      +

      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.

      +

      With DirectX 12 Agility SDK 1.716.0-preview, Microsoft added a new feature called "tight alignment". Note this is a separate feature than the "small alignment" described earlier. When using this new SDK and a compatible graphics driver, the API exposes support for this new feature. Then, a new flag D3D12_RESOURCE_FLAG_USE_TIGHT_ALIGNMENT can be added when creating a resource. D3D12 can then return the alignment required for the resource smaller than the default ones described above. This library automatically makes use of the tight alignment feature when available and adds that new resource flag. When the tight alignment is enabled, the heuristics that creates small buffers as committed described above is deactivated, as it is no longer needed.

      +

      You can check if the tight alignment it is available in the current system by calling D3D12MA::Allocator::IsTightAlignmentSupported(). You can tell the library to not use it by specifying D3D12MA::ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT. Typically, you don't need to do any of those.

      +

      The library automatically aligns all buffers to at least 256 B, even when the system supports smaller alignment. This is the alignment required for constant buffers, expressed by D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT constant.

      +
      +
      + +
      +Generated by doxygen 1.13.0 +
      +
      + + diff --git a/docs/html/quick_start.html b/docs/html/quick_start.html index defde2b..0c6893d 100644 --- a/docs/html/quick_start.html +++ b/docs/html/quick_start.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Quick start +D3D12 Memory Allocator: Quick start @@ -25,7 +25,7 @@ -
      Direct3D 12 Memory Allocator +
      D3D12 Memory Allocator
      @@ -93,8 +93,8 @@

      Project setup and initialization

      -

      This is a small, standalone C++ library. It consists of a pair 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 2019, but it should work with other compilers as well. It is designed for 64-bit code.

      +

      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.

      @@ -115,18 +115,18 @@
      D3D12MA::Allocator* allocator;
      HRESULT hr = D3D12MA::CreateAllocator(&allocatorDesc, &allocator);
      -
      D3D12MA::Allocator
      Represents main object of this library initialized for particular ID3D12Device.
      Definition D3D12MemAlloc.h:1099
      +
      D3D12MA::Allocator
      Represents main object of this library initialized for particular ID3D12Device.
      Definition D3D12MemAlloc.h:1118
      D3D12MA::CreateAllocator
      D3D12MA_API HRESULT CreateAllocator(const ALLOCATOR_DESC *pDesc, Allocator **ppAllocator)
      Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
      -
      D3D12MA::ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED
      @ ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED
      Optimization, allocate MSAA textures as committed resources always.
      Definition D3D12MemAlloc.h:1045
      -
      D3D12MA::ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED
      @ ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED
      Definition D3D12MemAlloc.h:1037
      -
      D3D12MA::ALLOCATOR_DESC
      Parameters of created Allocator object. To be used with CreateAllocator().
      Definition D3D12MemAlloc.h:1060
      -
      D3D12MA::ALLOCATOR_DESC::pAdapter
      IDXGIAdapter * pAdapter
      Definition D3D12MemAlloc.h:1086
      -
      D3D12MA::ALLOCATOR_DESC::Flags
      ALLOCATOR_FLAGS Flags
      Flags.
      Definition D3D12MemAlloc.h:1062
      -
      D3D12MA::ALLOCATOR_DESC::pDevice
      ID3D12Device * pDevice
      Definition D3D12MemAlloc.h:1068
      +
      D3D12MA::ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED
      @ ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED
      Optimization, allocate MSAA textures as committed resources always.
      Definition D3D12MemAlloc.h:1053
      +
      D3D12MA::ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED
      @ ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED
      Definition D3D12MemAlloc.h:1045
      +
      D3D12MA::ALLOCATOR_DESC
      Parameters of created Allocator object. To be used with CreateAllocator().
      Definition D3D12MemAlloc.h:1079
      +
      D3D12MA::ALLOCATOR_DESC::pAdapter
      IDXGIAdapter * pAdapter
      Definition D3D12MemAlloc.h:1105
      +
      D3D12MA::ALLOCATOR_DESC::Flags
      ALLOCATOR_FLAGS Flags
      Flags.
      Definition D3D12MemAlloc.h:1081
      +
      D3D12MA::ALLOCATOR_DESC::pDevice
      ID3D12Device * pDevice
      Definition D3D12MemAlloc.h:1087

      (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.

      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.

      +

      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.

      @@ -157,19 +157,19 @@
      IID_NULL, NULL);
      // Use allocation->GetResource()...
      -
      D3D12MA::Allocation
      Represents single memory allocation.
      Definition D3D12MemAlloc.h:483
      +
      D3D12MA::Allocation
      Represents single memory allocation.
      Definition D3D12MemAlloc.h:491
      D3D12MA::Allocator::CreateResource
      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 functi...
      -
      D3D12MA::ALLOCATION_DESC
      Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.
      Definition D3D12MemAlloc.h:299
      -
      D3D12MA::ALLOCATION_DESC::HeapType
      D3D12_HEAP_TYPE HeapType
      The type of memory heap where the new allocation should be placed.
      Definition D3D12MemAlloc.h:308
      +
      D3D12MA::ALLOCATION_DESC
      Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.
      Definition D3D12MemAlloc.h:307
      +
      D3D12MA::ALLOCATION_DESC::HeapType
      D3D12_HEAP_TYPE HeapType
      The type of memory heap where the new allocation should be placed.
      Definition D3D12MemAlloc.h:316

      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 equals 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.

      +

      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.

      +

      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;
      @@ -229,8 +229,9 @@

      &allocation,
      IID_PPV_ARGS(&resource));
      +
      D3D12_RANGE emptyRange = {0, 0};
      void* mappedPtr;
      -
      hr = resource->Map(0, NULL, &mappedPtr);
      +
      hr = resource->Map(0, &emptyRange, &mappedPtr);
      memcpy(mappedPtr, bufData, bufSize);
      diff --git a/docs/html/resource_aliasing.html b/docs/html/resource_aliasing.html index c081b31..0e7d15d 100644 --- a/docs/html/resource_aliasing.html +++ b/docs/html/resource_aliasing.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Resource aliasing (overlap) +D3D12 Memory Allocator: Resource aliasing (overlap) @@ -25,7 +25,7 @@ -
      Direct3D 12 Memory Allocator +
      D3D12 Memory Allocator
      @@ -83,7 +83,7 @@

    @@ -166,11 +166,11 @@
    res2->Release();
    res1->Release();
    alloc->Release();
    -
    D3D12MA::Allocation
    Represents single memory allocation.
    Definition D3D12MemAlloc.h:483
    +
    D3D12MA::Allocation
    Represents single memory allocation.
    Definition D3D12MemAlloc.h:491
    D3D12MA::Allocation::GetHeap
    ID3D12Heap * GetHeap() const
    Returns memory heap that the resource is created in.
    -
    D3D12MA::ALLOCATION_DESC
    Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.
    Definition D3D12MemAlloc.h:299
    -
    D3D12MA::ALLOCATION_DESC::ExtraHeapFlags
    D3D12_HEAP_FLAGS ExtraHeapFlags
    Additional heap flags to be used when allocating memory.
    Definition D3D12MemAlloc.h:324
    -
    D3D12MA::ALLOCATION_DESC::HeapType
    D3D12_HEAP_TYPE HeapType
    The type of memory heap where the new allocation should be placed.
    Definition D3D12MemAlloc.h:308
    +
    D3D12MA::ALLOCATION_DESC
    Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.
    Definition D3D12MemAlloc.h:307
    +
    D3D12MA::ALLOCATION_DESC::ExtraHeapFlags
    D3D12_HEAP_FLAGS ExtraHeapFlags
    Additional heap flags to be used when allocating memory.
    Definition D3D12MemAlloc.h:332
    +
    D3D12MA::ALLOCATION_DESC::HeapType
    D3D12_HEAP_TYPE HeapType
    The type of memory heap where the new allocation should be placed.
    Definition D3D12MemAlloc.h:316

    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:

      diff --git a/docs/html/search/all_0.js b/docs/html/search/all_0.js index 11958ca..444f245 100644 --- a/docs/html/search/all_0.js +++ b/docs/html/search/all_0.js @@ -2,52 +2,57 @@ var searchData= [ ['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,'index']]], + ['aliasing_20overlap_2',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]], ['alignment_3',['Alignment',['../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#aaa95e62f2f399339a09dcbb312a42de0',1,'D3D12MA::VIRTUAL_ALLOCATION_DESC']]], - ['alignment_20and_20units_4',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]], - ['allocate_5',['Allocate',['../class_d3_d12_m_a_1_1_virtual_block.html#a9281daf76e888ea1bd5247d5732e8179',1,'D3D12MA::VirtualBlock']]], - ['allocate_5ffunc_5fptr_6',['ALLOCATE_FUNC_PTR',['../namespace_d3_d12_m_a.html#ad998d40b4601b84dbc538694b1faf4d5',1,'D3D12MA']]], - ['allocatememory_7',['AllocateMemory',['../class_d3_d12_m_a_1_1_allocator.html#acb8a10a5ea30171ce60128286aec5ee2',1,'D3D12MA::Allocator']]], - ['allocation_8',['Allocation',['../class_d3_d12_m_a_1_1_allocation.html',1,'D3D12MA']]], - ['allocation_20algorithm_9',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]], - ['allocation_20parameters_10',['Allocation parameters',['../virtual_allocator.html#virtual_allocator_allocation_parameters',1,'']]], - ['allocation_5fcallbacks_11',['ALLOCATION_CALLBACKS',['../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',1,'D3D12MA']]], - ['allocation_5fdesc_12',['ALLOCATION_DESC',['../struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html',1,'D3D12MA']]], - ['allocation_5fflag_5fcan_5falias_13',['ALLOCATION_FLAG_CAN_ALIAS',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645ea4d6808f27de6d0ae57014ec1f4d54326',1,'D3D12MA']]], - ['allocation_5fflag_5fcommitted_14',['ALLOCATION_FLAG_COMMITTED',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645ea661a5472dba3dcecc5a2cc92afd25675',1,'D3D12MA']]], - ['allocation_5fflag_5fnever_5fallocate_15',['ALLOCATION_FLAG_NEVER_ALLOCATE',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645ea9a52c6ae694eadcd20896091e77c0628',1,'D3D12MA']]], - ['allocation_5fflag_5fnone_16',['ALLOCATION_FLAG_NONE',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645ea0bf578b096d6ea73cea86b031541733e',1,'D3D12MA']]], - ['allocation_5fflag_5fstrategy_5fbest_5ffit_17',['ALLOCATION_FLAG_STRATEGY_BEST_FIT',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645eaaeed6a77f0fe7f33459df593cea44c35',1,'D3D12MA']]], - ['allocation_5fflag_5fstrategy_5ffirst_5ffit_18',['ALLOCATION_FLAG_STRATEGY_FIRST_FIT',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645ea103ff3115f3c2126779c25be435bf6aa',1,'D3D12MA']]], - ['allocation_5fflag_5fstrategy_5fmask_19',['ALLOCATION_FLAG_STRATEGY_MASK',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645ea3e29297ad3c6cf9d9bb61b6d27a13ab3',1,'D3D12MA']]], - ['allocation_5fflag_5fstrategy_5fmin_5fmemory_20',['ALLOCATION_FLAG_STRATEGY_MIN_MEMORY',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645ea4b4fa95bb0daf6a80add7fb292aa63ae',1,'D3D12MA']]], - ['allocation_5fflag_5fstrategy_5fmin_5foffset_21',['ALLOCATION_FLAG_STRATEGY_MIN_OFFSET',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645eac30b62e36906b3c6e97b8b1d2ad8709d',1,'D3D12MA']]], - ['allocation_5fflag_5fstrategy_5fmin_5ftime_22',['ALLOCATION_FLAG_STRATEGY_MIN_TIME',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645eaa3ded8847563c24b4522af0586dbd2cb',1,'D3D12MA']]], - ['allocation_5fflag_5fupper_5faddress_23',['ALLOCATION_FLAG_UPPER_ADDRESS',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645eafb0e2dacce691336e717550a1df72474',1,'D3D12MA']]], - ['allocation_5fflag_5fwithin_5fbudget_24',['ALLOCATION_FLAG_WITHIN_BUDGET',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645eab374417c1f22a833ead268a6c21424e6',1,'D3D12MA']]], - ['allocation_5fflags_25',['ALLOCATION_FLAGS',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645e',1,'D3D12MA']]], - ['allocationbytes_26',['AllocationBytes',['../struct_d3_d12_m_a_1_1_statistics.html#a53cfe3d241124b5a8e8058871a4b50e8',1,'D3D12MA::Statistics']]], - ['allocationcount_27',['AllocationCount',['../struct_d3_d12_m_a_1_1_statistics.html#aef88ac53531db43a8888ad2be4a06c68',1,'D3D12MA::Statistics']]], - ['allocations_28',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]], - ['allocationsizemax_29',['AllocationSizeMax',['../struct_d3_d12_m_a_1_1_detailed_statistics.html#a2f47015bebf9a30ce221aef88fe11991',1,'D3D12MA::DetailedStatistics']]], - ['allocationsizemin_30',['AllocationSizeMin',['../struct_d3_d12_m_a_1_1_detailed_statistics.html#a187e5562265c3daa87c15d54f1396a6a',1,'D3D12MA::DetailedStatistics']]], - ['allocationsmoved_31',['AllocationsMoved',['../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#a708fa1b14c35da8d5d6abd4a457ef0c2',1,'D3D12MA::DEFRAGMENTATION_STATS']]], - ['allocator_32',['Allocator',['../class_d3_d12_m_a_1_1_allocator.html',1,'D3D12MA::Allocator'],['../index.html',1,'D3D12 Memory Allocator']]], - ['allocator_33',['allocator',['../configuration.html#custom_memory_allocator',1,'Custom CPU memory allocator'],['../virtual_allocator.html',1,'Virtual allocator']]], - ['allocator_5fdesc_34',['ALLOCATOR_DESC',['../struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html',1,'D3D12MA']]], - ['allocator_5fflag_5falways_5fcommitted_35',['ALLOCATOR_FLAG_ALWAYS_COMMITTED',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916a068863dc0538ff4ea153b046b31e94fb',1,'D3D12MA']]], - ['allocator_5fflag_5fdefault_5fpools_5fnot_5fzeroed_36',['ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916ae7dc7ab9168148281ebfe1586f554335',1,'D3D12MA']]], - ['allocator_5fflag_5fdont_5fprefer_5fsmall_5fbuffers_5fcommitted_37',['ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916a15c1ba5fbc182ac927b3011e23e74a72',1,'D3D12MA']]], - ['allocator_5fflag_5fmsaa_5ftextures_5falways_5fcommitted_38',['ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916adfbfd20d716f2a46f74d6226056fef1e',1,'D3D12MA']]], - ['allocator_5fflag_5fnone_39',['ALLOCATOR_FLAG_NONE',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916a2fb30967b492c27823a80b5de3aea26f',1,'D3D12MA']]], - ['allocator_5fflag_5fsinglethreaded_40',['ALLOCATOR_FLAG_SINGLETHREADED',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916a1b06bb21df006f76a9ed1bc41838bc52',1,'D3D12MA']]], - ['allocator_5fflags_41',['ALLOCATOR_FLAGS',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916',1,'D3D12MA']]], - ['allochandle_42',['AllocHandle',['../struct_d3_d12_m_a_1_1_virtual_allocation.html#a5d3166cf1f284fbbea4d0b169c4dba13',1,'D3D12MA::VirtualAllocation::AllocHandle'],['../namespace_d3_d12_m_a.html#a15e349adce86a40e0417d405aef1af80',1,'D3D12MA::AllocHandle']]], - ['allochandle_43',['allocHandle',['../class_d3_d12_m_a_1_1_allocation.html#a5c38846905b1ca0ff228c6081f2fc20c',1,'D3D12MA::Allocation']]], - ['also_44',['See also',['../index.html#main_see_also',1,'']]], - ['and_20benefits_45',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]], - ['and_20compatibility_46',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]], - ['and_20initialization_47',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]], - ['and_20units_48',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]], - ['at_20once_49',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]] + ['alignment_4',['Resource alignment',['../optimal_allocation.html#optimal_allocation_resource_alignment',1,'']]], + ['alignment_20and_20units_5',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]], + ['allocate_6',['Allocate',['../class_d3_d12_m_a_1_1_virtual_block.html#a9281daf76e888ea1bd5247d5732e8179',1,'D3D12MA::VirtualBlock']]], + ['allocate_5ffunc_5fptr_7',['ALLOCATE_FUNC_PTR',['../namespace_d3_d12_m_a.html#ad998d40b4601b84dbc538694b1faf4d5',1,'D3D12MA']]], + ['allocatememory_8',['AllocateMemory',['../class_d3_d12_m_a_1_1_allocator.html#acb8a10a5ea30171ce60128286aec5ee2',1,'D3D12MA::Allocator']]], + ['allocating_20buffers_9',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]], + ['allocation_10',['Allocation',['../class_d3_d12_m_a_1_1_allocation.html',1,'D3D12MA']]], + ['allocation_11',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]], + ['allocation_20algorithm_12',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]], + ['allocation_20parameters_13',['Allocation parameters',['../virtual_allocator.html#virtual_allocator_allocation_parameters',1,'']]], + ['allocation_20performance_14',['Allocation performance',['../optimal_allocation.html#optimal_allocation_allocation_Performance',1,'']]], + ['allocation_5fcallbacks_15',['ALLOCATION_CALLBACKS',['../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',1,'D3D12MA']]], + ['allocation_5fdesc_16',['ALLOCATION_DESC',['../struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html',1,'D3D12MA']]], + ['allocation_5fflag_5fcan_5falias_17',['ALLOCATION_FLAG_CAN_ALIAS',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645ea4d6808f27de6d0ae57014ec1f4d54326',1,'D3D12MA']]], + ['allocation_5fflag_5fcommitted_18',['ALLOCATION_FLAG_COMMITTED',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645ea661a5472dba3dcecc5a2cc92afd25675',1,'D3D12MA']]], + ['allocation_5fflag_5fnever_5fallocate_19',['ALLOCATION_FLAG_NEVER_ALLOCATE',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645ea9a52c6ae694eadcd20896091e77c0628',1,'D3D12MA']]], + ['allocation_5fflag_5fnone_20',['ALLOCATION_FLAG_NONE',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645ea0bf578b096d6ea73cea86b031541733e',1,'D3D12MA']]], + ['allocation_5fflag_5fstrategy_5fbest_5ffit_21',['ALLOCATION_FLAG_STRATEGY_BEST_FIT',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645eaaeed6a77f0fe7f33459df593cea44c35',1,'D3D12MA']]], + ['allocation_5fflag_5fstrategy_5ffirst_5ffit_22',['ALLOCATION_FLAG_STRATEGY_FIRST_FIT',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645ea103ff3115f3c2126779c25be435bf6aa',1,'D3D12MA']]], + ['allocation_5fflag_5fstrategy_5fmask_23',['ALLOCATION_FLAG_STRATEGY_MASK',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645ea3e29297ad3c6cf9d9bb61b6d27a13ab3',1,'D3D12MA']]], + ['allocation_5fflag_5fstrategy_5fmin_5fmemory_24',['ALLOCATION_FLAG_STRATEGY_MIN_MEMORY',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645ea4b4fa95bb0daf6a80add7fb292aa63ae',1,'D3D12MA']]], + ['allocation_5fflag_5fstrategy_5fmin_5foffset_25',['ALLOCATION_FLAG_STRATEGY_MIN_OFFSET',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645eac30b62e36906b3c6e97b8b1d2ad8709d',1,'D3D12MA']]], + ['allocation_5fflag_5fstrategy_5fmin_5ftime_26',['ALLOCATION_FLAG_STRATEGY_MIN_TIME',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645eaa3ded8847563c24b4522af0586dbd2cb',1,'D3D12MA']]], + ['allocation_5fflag_5fupper_5faddress_27',['ALLOCATION_FLAG_UPPER_ADDRESS',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645eafb0e2dacce691336e717550a1df72474',1,'D3D12MA']]], + ['allocation_5fflag_5fwithin_5fbudget_28',['ALLOCATION_FLAG_WITHIN_BUDGET',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645eab374417c1f22a833ead268a6c21424e6',1,'D3D12MA']]], + ['allocation_5fflags_29',['ALLOCATION_FLAGS',['../namespace_d3_d12_m_a.html#abbad31a7e0b3d09d77f3fb704b77645e',1,'D3D12MA']]], + ['allocationbytes_30',['AllocationBytes',['../struct_d3_d12_m_a_1_1_statistics.html#a53cfe3d241124b5a8e8058871a4b50e8',1,'D3D12MA::Statistics']]], + ['allocationcount_31',['AllocationCount',['../struct_d3_d12_m_a_1_1_statistics.html#aef88ac53531db43a8888ad2be4a06c68',1,'D3D12MA::Statistics']]], + ['allocations_32',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]], + ['allocationsizemax_33',['AllocationSizeMax',['../struct_d3_d12_m_a_1_1_detailed_statistics.html#a2f47015bebf9a30ce221aef88fe11991',1,'D3D12MA::DetailedStatistics']]], + ['allocationsizemin_34',['AllocationSizeMin',['../struct_d3_d12_m_a_1_1_detailed_statistics.html#a187e5562265c3daa87c15d54f1396a6a',1,'D3D12MA::DetailedStatistics']]], + ['allocationsmoved_35',['AllocationsMoved',['../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#a708fa1b14c35da8d5d6abd4a457ef0c2',1,'D3D12MA::DEFRAGMENTATION_STATS']]], + ['allocator_36',['Allocator',['../class_d3_d12_m_a_1_1_allocator.html',1,'D3D12MA::Allocator'],['../index.html',1,'D3D12 Memory Allocator']]], + ['allocator_37',['allocator',['../configuration.html#custom_memory_allocator',1,'Custom CPU memory allocator'],['../virtual_allocator.html',1,'Virtual allocator']]], + ['allocator_5fdesc_38',['ALLOCATOR_DESC',['../struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html',1,'D3D12MA']]], + ['allocator_5fflag_5falways_5fcommitted_39',['ALLOCATOR_FLAG_ALWAYS_COMMITTED',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916a068863dc0538ff4ea153b046b31e94fb',1,'D3D12MA']]], + ['allocator_5fflag_5fdefault_5fpools_5fnot_5fzeroed_40',['ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916ae7dc7ab9168148281ebfe1586f554335',1,'D3D12MA']]], + ['allocator_5fflag_5fdont_5fprefer_5fsmall_5fbuffers_5fcommitted_41',['ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916a15c1ba5fbc182ac927b3011e23e74a72',1,'D3D12MA']]], + ['allocator_5fflag_5fdont_5fuse_5ftight_5falignment_42',['ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916af13bc700d7b799c856c6516acac12fed',1,'D3D12MA']]], + ['allocator_5fflag_5fmsaa_5ftextures_5falways_5fcommitted_43',['ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916adfbfd20d716f2a46f74d6226056fef1e',1,'D3D12MA']]], + ['allocator_5fflag_5fnone_44',['ALLOCATOR_FLAG_NONE',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916a2fb30967b492c27823a80b5de3aea26f',1,'D3D12MA']]], + ['allocator_5fflag_5fsinglethreaded_45',['ALLOCATOR_FLAG_SINGLETHREADED',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916a1b06bb21df006f76a9ed1bc41838bc52',1,'D3D12MA']]], + ['allocator_5fflags_46',['ALLOCATOR_FLAGS',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916',1,'D3D12MA']]], + ['allochandle_47',['AllocHandle',['../struct_d3_d12_m_a_1_1_virtual_allocation.html#a5d3166cf1f284fbbea4d0b169c4dba13',1,'D3D12MA::VirtualAllocation::AllocHandle'],['../namespace_d3_d12_m_a.html#a15e349adce86a40e0417d405aef1af80',1,'D3D12MA::AllocHandle']]], + ['allochandle_48',['allocHandle',['../class_d3_d12_m_a_1_1_allocation.html#a5c38846905b1ca0ff228c6081f2fc20c',1,'D3D12MA::Allocation']]], + ['and_20benefits_49',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]], + ['and_20compatibility_50',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]], + ['and_20initialization_51',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]], + ['and_20units_52',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]], + ['at_20once_53',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]], + ['avoiding_20running_20out_20of_20memory_54',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]] ]; diff --git a/docs/html/search/all_1.js b/docs/html/search/all_1.js index 5521b1c..ee3352b 100644 --- a/docs/html/search/all_1.js +++ b/docs/html/search/all_1.js @@ -10,7 +10,8 @@ var searchData= ['budget_7',['Budget',['../struct_d3_d12_m_a_1_1_budget.html',1,'D3D12MA']]], ['budgetbytes_8',['BudgetBytes',['../struct_d3_d12_m_a_1_1_budget.html#a326515f08d89ee2e31dcfdd5c1e8ac71',1,'D3D12MA::Budget']]], ['buffer_9',['Ring buffer',['../linear_algorithm.html#linear_algorithm_ring_buffer',1,'']]], - ['buildstatsstring_10',['BuildStatsString',['../class_d3_d12_m_a_1_1_allocator.html#a29716b3084916abed7793bf2ec4b65db',1,'D3D12MA::Allocator::BuildStatsString()'],['../class_d3_d12_m_a_1_1_virtual_block.html#a828a27070bfa762cae796d4c8f2ef703',1,'D3D12MA::VirtualBlock::BuildStatsString()']]], - ['bytesfreed_11',['BytesFreed',['../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#a7ed1bf228f39989ff3419ce3f50002c9',1,'D3D12MA::DEFRAGMENTATION_STATS']]], - ['bytesmoved_12',['BytesMoved',['../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#adc4c36df302a6b320443a4a33a3e31c8',1,'D3D12MA::DEFRAGMENTATION_STATS']]] + ['buffers_10',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]], + ['buildstatsstring_11',['BuildStatsString',['../class_d3_d12_m_a_1_1_allocator.html#a29716b3084916abed7793bf2ec4b65db',1,'D3D12MA::Allocator::BuildStatsString()'],['../class_d3_d12_m_a_1_1_virtual_block.html#a828a27070bfa762cae796d4c8f2ef703',1,'D3D12MA::VirtualBlock::BuildStatsString()']]], + ['bytesfreed_12',['BytesFreed',['../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#a7ed1bf228f39989ff3419ce3f50002c9',1,'D3D12MA::DEFRAGMENTATION_STATS']]], + ['bytesmoved_13',['BytesMoved',['../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#adc4c36df302a6b320443a4a33a3e31c8',1,'D3D12MA::DEFRAGMENTATION_STATS']]] ]; diff --git a/docs/html/search/all_10.js b/docs/html/search/all_10.js index 82fd414..2b0b15b 100644 --- a/docs/html/search/all_10.js +++ b/docs/html/search/all_10.js @@ -1,9 +1,13 @@ var searchData= [ ['reference_20counting_0',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]], - ['residencypriority_1',['ResidencyPriority',['../struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html#a2e6074af8c8ff7b957fe8d4b5036a5e6',1,'D3D12MA::POOL_DESC']]], - ['resource_20aliasing_20overlap_2',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'index']]], - ['resource_20reference_20counting_3',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]], - ['resources_4',['Creating resources',['../quick_start.html#quick_start_creating_resources',1,'']]], - ['ring_20buffer_5',['Ring buffer',['../linear_algorithm.html#linear_algorithm_ring_buffer',1,'']]] + ['residency_20priority_1',['Residency priority',['../optimal_allocation.html#optimal_allocation_residency_priority',1,'']]], + ['residencypriority_2',['ResidencyPriority',['../struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html#a2e6074af8c8ff7b957fe8d4b5036a5e6',1,'D3D12MA::POOL_DESC']]], + ['resource_20aliasing_20overlap_3',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]], + ['resource_20alignment_4',['Resource alignment',['../optimal_allocation.html#optimal_allocation_resource_alignment',1,'']]], + ['resource_20allocation_5',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]], + ['resource_20reference_20counting_6',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]], + ['resources_7',['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_8',['Ring buffer',['../linear_algorithm.html#linear_algorithm_ring_buffer',1,'']]], + ['running_20out_20of_20memory_9',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]] ]; diff --git a/docs/html/search/all_11.js b/docs/html/search/all_11.js index ffbf836..b8c1d11 100644 --- a/docs/html/search/all_11.js +++ b/docs/html/search/all_11.js @@ -1,19 +1,19 @@ var searchData= [ ['safety_0',['Thread safety',['../general_considerations.html#general_considerations_thread_safety',1,'']]], - ['see_20also_1',['See also',['../index.html#main_see_also',1,'']]], - ['setallocationprivatedata_2',['SetAllocationPrivateData',['../class_d3_d12_m_a_1_1_virtual_block.html#ab96e34500b75a83a09d73b4585669114',1,'D3D12MA::VirtualBlock']]], - ['setcurrentframeindex_3',['SetCurrentFrameIndex',['../class_d3_d12_m_a_1_1_allocator.html#a468ba0c93121eaaee402b08775f1dd11',1,'D3D12MA::Allocator']]], - ['setname_4',['SetName',['../class_d3_d12_m_a_1_1_allocation.html#af9e643276b577aa7f21937f75d4b82ac',1,'D3D12MA::Allocation::SetName()'],['../class_d3_d12_m_a_1_1_pool.html#a20617cfec0461cf8c2b92115b5140c5b',1,'D3D12MA::Pool::SetName()']]], - ['setprivatedata_5',['SetPrivateData',['../class_d3_d12_m_a_1_1_allocation.html#a6f209094455dd876b6d9f84076ee1436',1,'D3D12MA::Allocation']]], - ['setresource_6',['SetResource',['../class_d3_d12_m_a_1_1_allocation.html#a414a088c22bae0f29b1038f5f9346d14',1,'D3D12MA::Allocation']]], - ['setup_20and_20initialization_7',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]], - ['size_8',['Size',['../struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html#ac56491679f276a5a9956ed99bc4654e4',1,'D3D12MA::VIRTUAL_BLOCK_DESC::Size'],['../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#a976b649e45abdd0769da0d79acde4bac',1,'D3D12MA::VIRTUAL_ALLOCATION_DESC::Size'],['../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#ac265159500190e35ebef8e4784c73a09',1,'D3D12MA::VIRTUAL_ALLOCATION_INFO::Size']]], - ['stack_9',['Stack',['../linear_algorithm.html#linear_algorithm_stack',1,'']]], - ['stack_10',['Double stack',['../linear_algorithm.html#linear_algorithm_double_stack',1,'']]], - ['start_11',['Quick start',['../quick_start.html',1,'index']]], - ['statistics_12',['Statistics',['../struct_d3_d12_m_a_1_1_statistics.html',1,'D3D12MA::Statistics'],['../statistics.html',1,'Statistics'],['../virtual_allocator.html#virtual_allocator_statistics',1,'Statistics']]], - ['statistics_13',['Numeric statistics',['../statistics.html#statistics_numeric_statistics',1,'']]], - ['stats_14',['Stats',['../struct_d3_d12_m_a_1_1_detailed_statistics.html#a2490d4a08a5d47c87a699001dfc8737f',1,'D3D12MA::DetailedStatistics::Stats'],['../struct_d3_d12_m_a_1_1_budget.html#a1255508930766db238cfb1312b15f1cf',1,'D3D12MA::Budget::Stats']]], + ['setallocationprivatedata_1',['SetAllocationPrivateData',['../class_d3_d12_m_a_1_1_virtual_block.html#ab96e34500b75a83a09d73b4585669114',1,'D3D12MA::VirtualBlock']]], + ['setcurrentframeindex_2',['SetCurrentFrameIndex',['../class_d3_d12_m_a_1_1_allocator.html#a468ba0c93121eaaee402b08775f1dd11',1,'D3D12MA::Allocator']]], + ['setname_3',['SetName',['../class_d3_d12_m_a_1_1_allocation.html#af9e643276b577aa7f21937f75d4b82ac',1,'D3D12MA::Allocation::SetName()'],['../class_d3_d12_m_a_1_1_pool.html#a20617cfec0461cf8c2b92115b5140c5b',1,'D3D12MA::Pool::SetName()']]], + ['setprivatedata_4',['SetPrivateData',['../class_d3_d12_m_a_1_1_allocation.html#a6f209094455dd876b6d9f84076ee1436',1,'D3D12MA::Allocation']]], + ['setresource_5',['SetResource',['../class_d3_d12_m_a_1_1_allocation.html#a414a088c22bae0f29b1038f5f9346d14',1,'D3D12MA::Allocation']]], + ['setup_20and_20initialization_6',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]], + ['size_7',['Size',['../struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html#ac56491679f276a5a9956ed99bc4654e4',1,'D3D12MA::VIRTUAL_BLOCK_DESC::Size'],['../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#a976b649e45abdd0769da0d79acde4bac',1,'D3D12MA::VIRTUAL_ALLOCATION_DESC::Size'],['../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#ac265159500190e35ebef8e4784c73a09',1,'D3D12MA::VIRTUAL_ALLOCATION_INFO::Size']]], + ['stack_8',['Stack',['../linear_algorithm.html#linear_algorithm_stack',1,'']]], + ['stack_9',['Double stack',['../linear_algorithm.html#linear_algorithm_double_stack',1,'']]], + ['start_10',['Quick start',['../quick_start.html',1,'index']]], + ['statistics_11',['Statistics',['../struct_d3_d12_m_a_1_1_statistics.html',1,'D3D12MA::Statistics'],['../statistics.html',1,'Statistics'],['../virtual_allocator.html#virtual_allocator_statistics',1,'Statistics']]], + ['statistics_12',['Numeric statistics',['../statistics.html#statistics_numeric_statistics',1,'']]], + ['stats_13',['Stats',['../struct_d3_d12_m_a_1_1_detailed_statistics.html#a2490d4a08a5d47c87a699001dfc8737f',1,'D3D12MA::DetailedStatistics::Stats'],['../struct_d3_d12_m_a_1_1_budget.html#a1255508930766db238cfb1312b15f1cf',1,'D3D12MA::Budget::Stats']]], + ['sub_20allocating_20buffers_14',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]], ['supported_15',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]] ]; diff --git a/docs/html/search/all_13.js b/docs/html/search/all_13.js index 0e32fe4..686619a 100644 --- a/docs/html/search/all_13.js +++ b/docs/html/search/all_13.js @@ -4,6 +4,7 @@ var searchData= ['unusedrangecount_1',['UnusedRangeCount',['../struct_d3_d12_m_a_1_1_detailed_statistics.html#aff1aaecbb86eedfdb15c1b11987ac0d9',1,'D3D12MA::DetailedStatistics']]], ['unusedrangesizemax_2',['UnusedRangeSizeMax',['../struct_d3_d12_m_a_1_1_detailed_statistics.html#a5fae01864d6e6595cb9c416a9f365e7c',1,'D3D12MA::DetailedStatistics']]], ['unusedrangesizemin_3',['UnusedRangeSizeMin',['../struct_d3_d12_m_a_1_1_detailed_statistics.html#ac13f6cb1737f0d906e55182385f38b70',1,'D3D12MA::DetailedStatistics']]], - ['usage_4',['Usage',['../custom_pools.html#custom_pools_usage',1,'']]], - ['usagebytes_5',['UsageBytes',['../struct_d3_d12_m_a_1_1_budget.html#a77a8c9e32d6602f95b7d1c285cddd253',1,'D3D12MA::Budget']]] + ['upload_20heap_4',['GPU upload heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'']]], + ['usage_5',['Usage',['../custom_pools.html#custom_pools_usage',1,'']]], + ['usagebytes_6',['UsageBytes',['../struct_d3_d12_m_a_1_1_budget.html#a77a8c9e32d6602f95b7d1c285cddd253',1,'D3D12MA::Budget']]] ]; diff --git a/docs/html/search/all_14.js b/docs/html/search/all_14.js index 34f8bda..8c2726a 100644 --- a/docs/html/search/all_14.js +++ b/docs/html/search/all_14.js @@ -1,23 +1,24 @@ var searchData= [ ['versioning_20and_20compatibility_0',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]], - ['virtual_20allocations_1',['Making virtual allocations',['../virtual_allocator.html#virtual_allocator_making_virtual_allocations',1,'']]], - ['virtual_20allocator_2',['Virtual allocator',['../virtual_allocator.html',1,'index']]], - ['virtual_20block_3',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]], - ['virtual_5fallocation_5fdesc_4',['VIRTUAL_ALLOCATION_DESC',['../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',1,'D3D12MA']]], - ['virtual_5fallocation_5fflag_5fnone_5',['VIRTUAL_ALLOCATION_FLAG_NONE',['../namespace_d3_d12_m_a.html#a7e4152ccaf661f5398b24a23cbe9ae72a03576295004dec9dc8f99a895d232027',1,'D3D12MA']]], - ['virtual_5fallocation_5fflag_5fstrategy_5fmask_6',['VIRTUAL_ALLOCATION_FLAG_STRATEGY_MASK',['../namespace_d3_d12_m_a.html#a7e4152ccaf661f5398b24a23cbe9ae72a6a78fdd4c16ef443e9353622caf7efb9',1,'D3D12MA']]], - ['virtual_5fallocation_5fflag_5fstrategy_5fmin_5fmemory_7',['VIRTUAL_ALLOCATION_FLAG_STRATEGY_MIN_MEMORY',['../namespace_d3_d12_m_a.html#a7e4152ccaf661f5398b24a23cbe9ae72affe589cb8817363fed0d207c3a5f2ad9',1,'D3D12MA']]], - ['virtual_5fallocation_5fflag_5fstrategy_5fmin_5foffset_8',['VIRTUAL_ALLOCATION_FLAG_STRATEGY_MIN_OFFSET',['../namespace_d3_d12_m_a.html#a7e4152ccaf661f5398b24a23cbe9ae72abd8063a364dba797e928b6aaa85dd5f0',1,'D3D12MA']]], - ['virtual_5fallocation_5fflag_5fstrategy_5fmin_5ftime_9',['VIRTUAL_ALLOCATION_FLAG_STRATEGY_MIN_TIME',['../namespace_d3_d12_m_a.html#a7e4152ccaf661f5398b24a23cbe9ae72ae37ebe327c9d46b5ad68e5a95c888efe',1,'D3D12MA']]], - ['virtual_5fallocation_5fflag_5fupper_5faddress_10',['VIRTUAL_ALLOCATION_FLAG_UPPER_ADDRESS',['../namespace_d3_d12_m_a.html#a7e4152ccaf661f5398b24a23cbe9ae72a86beebcb80a1a10cb5525e2c9ed1435e',1,'D3D12MA']]], - ['virtual_5fallocation_5fflags_11',['VIRTUAL_ALLOCATION_FLAGS',['../namespace_d3_d12_m_a.html#a7e4152ccaf661f5398b24a23cbe9ae72',1,'D3D12MA']]], - ['virtual_5fallocation_5finfo_12',['VIRTUAL_ALLOCATION_INFO',['../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',1,'D3D12MA']]], - ['virtual_5fblock_5fdesc_13',['VIRTUAL_BLOCK_DESC',['../struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html',1,'D3D12MA']]], - ['virtual_5fblock_5fflag_5falgorithm_5flinear_14',['VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR',['../namespace_d3_d12_m_a.html#a578329923a103be086ac52e3bed2085dabd9968af113acc9a756254ab9f1dc13d',1,'D3D12MA']]], - ['virtual_5fblock_5fflag_5falgorithm_5fmask_15',['VIRTUAL_BLOCK_FLAG_ALGORITHM_MASK',['../namespace_d3_d12_m_a.html#a578329923a103be086ac52e3bed2085da0fee243cbf2902a68123ac85caa21e3e',1,'D3D12MA']]], - ['virtual_5fblock_5fflag_5fnone_16',['VIRTUAL_BLOCK_FLAG_NONE',['../namespace_d3_d12_m_a.html#a578329923a103be086ac52e3bed2085dafc882884f8bacd5cab3087567df8c53d',1,'D3D12MA']]], - ['virtual_5fblock_5fflags_17',['VIRTUAL_BLOCK_FLAGS',['../namespace_d3_d12_m_a.html#a578329923a103be086ac52e3bed2085d',1,'D3D12MA']]], - ['virtualallocation_18',['VirtualAllocation',['../struct_d3_d12_m_a_1_1_virtual_allocation.html',1,'D3D12MA']]], - ['virtualblock_19',['VirtualBlock',['../class_d3_d12_m_a_1_1_virtual_block.html',1,'D3D12MA']]] + ['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,'']]], + ['virtual_5fallocation_5fdesc_5',['VIRTUAL_ALLOCATION_DESC',['../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',1,'D3D12MA']]], + ['virtual_5fallocation_5fflag_5fnone_6',['VIRTUAL_ALLOCATION_FLAG_NONE',['../namespace_d3_d12_m_a.html#a7e4152ccaf661f5398b24a23cbe9ae72a03576295004dec9dc8f99a895d232027',1,'D3D12MA']]], + ['virtual_5fallocation_5fflag_5fstrategy_5fmask_7',['VIRTUAL_ALLOCATION_FLAG_STRATEGY_MASK',['../namespace_d3_d12_m_a.html#a7e4152ccaf661f5398b24a23cbe9ae72a6a78fdd4c16ef443e9353622caf7efb9',1,'D3D12MA']]], + ['virtual_5fallocation_5fflag_5fstrategy_5fmin_5fmemory_8',['VIRTUAL_ALLOCATION_FLAG_STRATEGY_MIN_MEMORY',['../namespace_d3_d12_m_a.html#a7e4152ccaf661f5398b24a23cbe9ae72affe589cb8817363fed0d207c3a5f2ad9',1,'D3D12MA']]], + ['virtual_5fallocation_5fflag_5fstrategy_5fmin_5foffset_9',['VIRTUAL_ALLOCATION_FLAG_STRATEGY_MIN_OFFSET',['../namespace_d3_d12_m_a.html#a7e4152ccaf661f5398b24a23cbe9ae72abd8063a364dba797e928b6aaa85dd5f0',1,'D3D12MA']]], + ['virtual_5fallocation_5fflag_5fstrategy_5fmin_5ftime_10',['VIRTUAL_ALLOCATION_FLAG_STRATEGY_MIN_TIME',['../namespace_d3_d12_m_a.html#a7e4152ccaf661f5398b24a23cbe9ae72ae37ebe327c9d46b5ad68e5a95c888efe',1,'D3D12MA']]], + ['virtual_5fallocation_5fflag_5fupper_5faddress_11',['VIRTUAL_ALLOCATION_FLAG_UPPER_ADDRESS',['../namespace_d3_d12_m_a.html#a7e4152ccaf661f5398b24a23cbe9ae72a86beebcb80a1a10cb5525e2c9ed1435e',1,'D3D12MA']]], + ['virtual_5fallocation_5fflags_12',['VIRTUAL_ALLOCATION_FLAGS',['../namespace_d3_d12_m_a.html#a7e4152ccaf661f5398b24a23cbe9ae72',1,'D3D12MA']]], + ['virtual_5fallocation_5finfo_13',['VIRTUAL_ALLOCATION_INFO',['../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',1,'D3D12MA']]], + ['virtual_5fblock_5fdesc_14',['VIRTUAL_BLOCK_DESC',['../struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html',1,'D3D12MA']]], + ['virtual_5fblock_5fflag_5falgorithm_5flinear_15',['VIRTUAL_BLOCK_FLAG_ALGORITHM_LINEAR',['../namespace_d3_d12_m_a.html#a578329923a103be086ac52e3bed2085dabd9968af113acc9a756254ab9f1dc13d',1,'D3D12MA']]], + ['virtual_5fblock_5fflag_5falgorithm_5fmask_16',['VIRTUAL_BLOCK_FLAG_ALGORITHM_MASK',['../namespace_d3_d12_m_a.html#a578329923a103be086ac52e3bed2085da0fee243cbf2902a68123ac85caa21e3e',1,'D3D12MA']]], + ['virtual_5fblock_5fflag_5fnone_17',['VIRTUAL_BLOCK_FLAG_NONE',['../namespace_d3_d12_m_a.html#a578329923a103be086ac52e3bed2085dafc882884f8bacd5cab3087567df8c53d',1,'D3D12MA']]], + ['virtual_5fblock_5fflags_18',['VIRTUAL_BLOCK_FLAGS',['../namespace_d3_d12_m_a.html#a578329923a103be086ac52e3bed2085d',1,'D3D12MA']]], + ['virtualallocation_19',['VirtualAllocation',['../struct_d3_d12_m_a_1_1_virtual_allocation.html',1,'D3D12MA']]], + ['virtualblock_20',['VirtualBlock',['../class_d3_d12_m_a_1_1_virtual_block.html',1,'D3D12MA']]] ]; diff --git a/docs/html/search/all_15.js b/docs/html/search/all_15.js index 2b2e0c6..8225a92 100644 --- a/docs/html/search/all_15.js +++ b/docs/html/search/all_15.js @@ -1,4 +1,4 @@ var searchData= [ - ['waszeroinitialized_0',['WasZeroInitialized',['../class_d3_d12_m_a_1_1_allocation.html#a1b1ef2717beed503fcb3cb7e6a171762',1,'D3D12MA::Allocation']]] + ['web_20links_0',['Web links',['../index.html#main_see_also',1,'']]] ]; diff --git a/docs/html/search/all_2.js b/docs/html/search/all_2.js index 6a38c14..6a8b92b 100644 --- a/docs/html/search/all_2.js +++ b/docs/html/search/all_2.js @@ -2,24 +2,25 @@ var searchData= [ ['calculatestatistics_0',['CalculateStatistics',['../class_d3_d12_m_a_1_1_pool.html#ad07999ac5dc8f0c63187afd45d551910',1,'D3D12MA::Pool::CalculateStatistics()'],['../class_d3_d12_m_a_1_1_allocator.html#a99db00df909963573a976c203b107d22',1,'D3D12MA::Allocator::CalculateStatistics()'],['../class_d3_d12_m_a_1_1_virtual_block.html#a614a82247ce6cf29c38895e16eb971d9',1,'D3D12MA::VirtualBlock::CalculateStatistics(DetailedStatistics *pStats) const']]], ['clear_1',['Clear',['../class_d3_d12_m_a_1_1_virtual_block.html#ae22b18c0b7c31b44c1d740f886369189',1,'D3D12MA::VirtualBlock']]], - ['compatibility_2',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]], - ['configuration_3',['Configuration',['../configuration.html',1,'index']]], - ['considerations_4',['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_5',['Table of contents',['../index.html#main_table_of_contents',1,'']]], - ['counting_6',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]], - ['cpu_20memory_20allocator_7',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]], - ['createaliasingresource_8',['CreateAliasingResource',['../class_d3_d12_m_a_1_1_allocator.html#ab45536f92410aedb7be44ea36b1b4717',1,'D3D12MA::Allocator']]], - ['createaliasingresource1_9',['CreateAliasingResource1',['../class_d3_d12_m_a_1_1_allocator.html#ad3b83cc5707cb4ed92bc277069c4ddd6',1,'D3D12MA::Allocator']]], - ['createaliasingresource2_10',['CreateAliasingResource2',['../class_d3_d12_m_a_1_1_allocator.html#a562cbaa71cbd333cade09cd67ed82453',1,'D3D12MA::Allocator']]], - ['createallocator_11',['CreateAllocator',['../class_d3_d12_m_a_1_1_allocator.html#a6e114ef3b4a791a3bf2e3109a3971559',1,'D3D12MA::Allocator::CreateAllocator()'],['../namespace_d3_d12_m_a.html#ab7a1cd1683986d75ce1488b0920f4cb0',1,'D3D12MA::CreateAllocator()']]], - ['createpool_12',['CreatePool',['../class_d3_d12_m_a_1_1_allocator.html#aac7b1f6bf53cbf4c4ce2264cb72ca515',1,'D3D12MA::Allocator']]], - ['createresource_13',['CreateResource',['../class_d3_d12_m_a_1_1_allocator.html#aa37d6b9fe8ea0864f7a35b9d68e8345a',1,'D3D12MA::Allocator']]], - ['createresource2_14',['CreateResource2',['../class_d3_d12_m_a_1_1_allocator.html#a7a1c79c79a7a573c438aa45c4a531b96',1,'D3D12MA::Allocator']]], - ['createresource3_15',['CreateResource3',['../class_d3_d12_m_a_1_1_allocator.html#a323b2af320b01d0fdecfc515c75db747',1,'D3D12MA::Allocator']]], - ['createvirtualblock_16',['CreateVirtualBlock',['../class_d3_d12_m_a_1_1_virtual_block.html#ae5650809a150e3283abd307c88ee45bb',1,'D3D12MA::VirtualBlock::CreateVirtualBlock()'],['../namespace_d3_d12_m_a.html#ab024647ae85ee63e2fa2c1c4beac6d98',1,'D3D12MA::CreateVirtualBlock()']]], - ['creating_20resources_17',['Creating resources',['../quick_start.html#quick_start_creating_resources',1,'']]], - ['creating_20virtual_20block_18',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]], - ['custom_20cpu_20memory_20allocator_19',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]], - ['custom_20memory_20pools_20',['Custom memory pools',['../custom_pools.html',1,'index']]], - ['custompool_21',['CustomPool',['../struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html#ab06b85f3cf3254f855b29264477e3934',1,'D3D12MA::ALLOCATION_DESC']]] + ['committed_20versus_20placed_20resources_2',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]], + ['compatibility_3',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]], + ['configuration_4',['Configuration',['../configuration.html',1,'index']]], + ['considerations_5',['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_6',['Table of contents',['../index.html#main_table_of_contents',1,'']]], + ['counting_7',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]], + ['cpu_20memory_20allocator_8',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]], + ['createaliasingresource_9',['CreateAliasingResource',['../class_d3_d12_m_a_1_1_allocator.html#ab45536f92410aedb7be44ea36b1b4717',1,'D3D12MA::Allocator']]], + ['createaliasingresource1_10',['CreateAliasingResource1',['../class_d3_d12_m_a_1_1_allocator.html#ad3b83cc5707cb4ed92bc277069c4ddd6',1,'D3D12MA::Allocator']]], + ['createaliasingresource2_11',['CreateAliasingResource2',['../class_d3_d12_m_a_1_1_allocator.html#a562cbaa71cbd333cade09cd67ed82453',1,'D3D12MA::Allocator']]], + ['createallocator_12',['CreateAllocator',['../class_d3_d12_m_a_1_1_allocator.html#a6e114ef3b4a791a3bf2e3109a3971559',1,'D3D12MA::Allocator::CreateAllocator()'],['../namespace_d3_d12_m_a.html#ab7a1cd1683986d75ce1488b0920f4cb0',1,'D3D12MA::CreateAllocator()']]], + ['createpool_13',['CreatePool',['../class_d3_d12_m_a_1_1_allocator.html#aac7b1f6bf53cbf4c4ce2264cb72ca515',1,'D3D12MA::Allocator']]], + ['createresource_14',['CreateResource',['../class_d3_d12_m_a_1_1_allocator.html#aa37d6b9fe8ea0864f7a35b9d68e8345a',1,'D3D12MA::Allocator']]], + ['createresource2_15',['CreateResource2',['../class_d3_d12_m_a_1_1_allocator.html#a7a1c79c79a7a573c438aa45c4a531b96',1,'D3D12MA::Allocator']]], + ['createresource3_16',['CreateResource3',['../class_d3_d12_m_a_1_1_allocator.html#a323b2af320b01d0fdecfc515c75db747',1,'D3D12MA::Allocator']]], + ['createvirtualblock_17',['CreateVirtualBlock',['../class_d3_d12_m_a_1_1_virtual_block.html#ae5650809a150e3283abd307c88ee45bb',1,'D3D12MA::VirtualBlock::CreateVirtualBlock()'],['../namespace_d3_d12_m_a.html#ab024647ae85ee63e2fa2c1c4beac6d98',1,'D3D12MA::CreateVirtualBlock()']]], + ['creating_20resources_18',['Creating resources',['../quick_start.html#quick_start_creating_resources',1,'']]], + ['creating_20virtual_20block_19',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]], + ['custom_20cpu_20memory_20allocator_20',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]], + ['custom_20memory_20pools_21',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]], + ['custompool_22',['CustomPool',['../struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html#ab06b85f3cf3254f855b29264477e3934',1,'D3D12MA::ALLOCATION_DESC']]] ]; diff --git a/docs/html/search/all_3.js b/docs/html/search/all_3.js index 9f6d57e..89ce51f 100644 --- a/docs/html/search/all_3.js +++ b/docs/html/search/all_3.js @@ -8,7 +8,7 @@ var searchData= ['d3d12memalloc_2eh_5',['D3D12MemAlloc.h',['../_d3_d12_mem_alloc_8h.html',1,'']]], ['deallocation_6',['Deallocation',['../virtual_allocator.html#virtual_allocator_deallocation',1,'']]], ['debug_20margins_7',['Debug margins',['../configuration.html#debug_margins',1,'']]], - ['defragmentation_8',['Defragmentation',['../defragmentation.html',1,'index']]], + ['defragmentation_8',['Defragmentation',['../defragmentation.html',1,'optimal_allocation']]], ['defragmentation_5fdesc_9',['DEFRAGMENTATION_DESC',['../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',1,'D3D12MA']]], ['defragmentation_5fflag_5falgorithm_5fbalanced_10',['DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED',['../namespace_d3_d12_m_a.html#ab433989212ee6736bf9d63c5bc565df4ace3a84861ed6a1b8066fa9c12c7e89b9',1,'D3D12MA']]], ['defragmentation_5fflag_5falgorithm_5ffast_11',['DEFRAGMENTATION_FLAG_ALGORITHM_FAST',['../namespace_d3_d12_m_a.html#ab433989212ee6736bf9d63c5bc565df4a9d0301a81136ca79e3ba52542c6d2e13',1,'D3D12MA']]], diff --git a/docs/html/search/all_6.js b/docs/html/search/all_6.js index 41abad4..1cb73ca 100644 --- a/docs/html/search/all_6.js +++ b/docs/html/search/all_6.js @@ -14,5 +14,6 @@ var searchData= ['getresource_11',['GetResource',['../class_d3_d12_m_a_1_1_allocation.html#ad00308118252f82d8f803c623c67bf18',1,'D3D12MA::Allocation']]], ['getsize_12',['GetSize',['../class_d3_d12_m_a_1_1_allocation.html#a92c2fb6f22b28817eb83a59407d7dd30',1,'D3D12MA::Allocation']]], ['getstatistics_13',['GetStatistics',['../class_d3_d12_m_a_1_1_pool.html#aa9d849dc4667314b2a53eddf02f5af91',1,'D3D12MA::Pool::GetStatistics()'],['../class_d3_d12_m_a_1_1_virtual_block.html#a0f1dda0e019e218b021f64987a74b110',1,'D3D12MA::VirtualBlock::GetStatistics()']]], - ['getstats_14',['GetStats',['../class_d3_d12_m_a_1_1_defragmentation_context.html#a1c21c26f47dcbf8f4e562063a3e25f38',1,'D3D12MA::DefragmentationContext']]] + ['getstats_14',['GetStats',['../class_d3_d12_m_a_1_1_defragmentation_context.html#a1c21c26f47dcbf8f4e562063a3e25f38',1,'D3D12MA::DefragmentationContext']]], + ['gpu_20upload_20heap_15',['GPU upload heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'']]] ]; diff --git a/docs/html/search/all_7.js b/docs/html/search/all_7.js index ebf5e92..67caa90 100644 --- a/docs/html/search/all_7.js +++ b/docs/html/search/all_7.js @@ -1,6 +1,6 @@ var searchData= [ - ['heap_0',['heap',['../class_d3_d12_m_a_1_1_allocation.html#a4e7380aabcac5b0a1cd833c5c84459c6',1,'D3D12MA::Allocation']]], + ['heap_0',['heap',['../optimal_allocation.html#optimal_allocation_gpu_upload_heap',1,'GPU upload heap'],['../class_d3_d12_m_a_1_1_allocation.html#a4e7380aabcac5b0a1cd833c5c84459c6',1,'D3D12MA::Allocation::heap']]], ['heapflags_1',['HeapFlags',['../struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html#a3795956e4fbfe7c3a23546e02e5d28dc',1,'D3D12MA::POOL_DESC']]], ['heapproperties_2',['HeapProperties',['../struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html#a06e06813bcb5206e9f7a8b0564bf1d6a',1,'D3D12MA::POOL_DESC']]], ['heapsfreed_3',['HeapsFreed',['../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#aecc6120afcf75028c9850f8d475b727d',1,'D3D12MA::DEFRAGMENTATION_STATS']]], diff --git a/docs/html/search/all_8.js b/docs/html/search/all_8.js index 90457e4..aca0ae9 100644 --- a/docs/html/search/all_8.js +++ b/docs/html/search/all_8.js @@ -4,5 +4,6 @@ var searchData= ['iscachecoherentuma_1',['IsCacheCoherentUMA',['../class_d3_d12_m_a_1_1_allocator.html#a08210561b92c4bd7ede9dd7beba4bb80',1,'D3D12MA::Allocator']]], ['isempty_2',['IsEmpty',['../class_d3_d12_m_a_1_1_virtual_block.html#a7b23fd2da6f0343095fb14b31395678b',1,'D3D12MA::VirtualBlock']]], ['isgpuuploadheapsupported_3',['IsGPUUploadHeapSupported',['../class_d3_d12_m_a_1_1_allocator.html#a3f3fd1e88cf2cd02257fe272e08a273c',1,'D3D12MA::Allocator']]], - ['isuma_4',['IsUMA',['../class_d3_d12_m_a_1_1_allocator.html#a9e742884bd45dd7f01193d13fcd05af0',1,'D3D12MA::Allocator']]] + ['istightalignmentsupported_4',['IsTightAlignmentSupported',['../class_d3_d12_m_a_1_1_allocator.html#a3f5aa191cebdca7c1932da4723cfc03e',1,'D3D12MA::Allocator']]], + ['isuma_5',['IsUMA',['../class_d3_d12_m_a_1_1_allocator.html#a9e742884bd45dd7f01193d13fcd05af0',1,'D3D12MA::Allocator']]] ]; diff --git a/docs/html/search/all_a.js b/docs/html/search/all_a.js index 2625931..c6c926d 100644 --- a/docs/html/search/all_a.js +++ b/docs/html/search/all_a.js @@ -1,5 +1,6 @@ var searchData= [ ['linear_20allocation_20algorithm_0',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]], - ['list_1',['list',['../class_d3_d12_m_a_1_1_allocation.html#ab1f59d849add2cdbfbebf4eb98db5c97',1,'D3D12MA::Allocation']]] + ['links_1',['Web links',['../index.html#main_see_also',1,'']]], + ['list_2',['list',['../class_d3_d12_m_a_1_1_allocation.html#ab1f59d849add2cdbfbebf4eb98db5c97',1,'D3D12MA::Allocation']]] ]; diff --git a/docs/html/search/all_b.js b/docs/html/search/all_b.js index 2e87b5f..c68bb1a 100644 --- a/docs/html/search/all_b.js +++ b/docs/html/search/all_b.js @@ -9,10 +9,10 @@ var searchData= ['maxallocationsperpass_6',['MaxAllocationsPerPass',['../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#a83bfb404f387863eafdd6703483aed89',1,'D3D12MA::DEFRAGMENTATION_DESC']]], ['maxblockcount_7',['MaxBlockCount',['../struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html#abbce3a99f253928f9c3c09fa16015f9e',1,'D3D12MA::POOL_DESC']]], ['maxbytesperpass_8',['MaxBytesPerPass',['../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#ad8d224e0687a35898970d0a5688c6343',1,'D3D12MA::DEFRAGMENTATION_DESC']]], - ['memory_9',['Mapping memory',['../quick_start.html#quick_start_mapping_memory',1,'']]], + ['memory_9',['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_10',['D3D12 Memory Allocator',['../index.html',1,'']]], ['memory_20allocator_11',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]], - ['memory_20pools_12',['Custom memory pools',['../custom_pools.html',1,'index']]], + ['memory_20pools_12',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]], ['memorysegmentgroup_13',['MemorySegmentGroup',['../struct_d3_d12_m_a_1_1_total_statistics.html#aed7d22d5cd773aa896bc4c786c7f3650',1,'D3D12MA::TotalStatistics']]], ['minallocationalignment_14',['MinAllocationAlignment',['../struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html#a0a6283eeb1f3f99d8c4ae264aec7f749',1,'D3D12MA::POOL_DESC']]], ['minblockcount_15',['MinBlockCount',['../struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html#a6f10db3911a3bea1becfc9a0dfa5bac8',1,'D3D12MA::POOL_DESC']]], diff --git a/docs/html/search/all_d.js b/docs/html/search/all_d.js index cbdc6e2..e475b21 100644 --- a/docs/html/search/all_d.js +++ b/docs/html/search/all_d.js @@ -1,8 +1,11 @@ var searchData= [ ['of_20contents_0',['Table of contents',['../index.html#main_table_of_contents',1,'']]], - ['offset_1',['Offset',['../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#aa125871ef3fcc8af81fc831cd386dc2e',1,'D3D12MA::VIRTUAL_ALLOCATION_INFO']]], - ['once_2',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]], - ['operation_3',['Operation',['../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#a5ba8d6894267ae59df4efb9972af5d81',1,'D3D12MA::DEFRAGMENTATION_MOVE']]], - ['overlap_4',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'index']]] + ['of_20memory_1',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]], + ['offset_2',['Offset',['../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#aa125871ef3fcc8af81fc831cd386dc2e',1,'D3D12MA::VIRTUAL_ALLOCATION_INFO']]], + ['once_3',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]], + ['operation_4',['Operation',['../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#a5ba8d6894267ae59df4efb9972af5d81',1,'D3D12MA::DEFRAGMENTATION_MOVE']]], + ['optimal_20resource_20allocation_5',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]], + ['out_20of_20memory_6',['Avoiding running out of memory',['../optimal_allocation.html#optimal_allocation_avoiding_running_out_of_memory',1,'']]], + ['overlap_7',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]] ]; diff --git a/docs/html/search/all_e.js b/docs/html/search/all_e.js index cc987fd..115c5cc 100644 --- a/docs/html/search/all_e.js +++ b/docs/html/search/all_e.js @@ -6,20 +6,23 @@ var searchData= ['parameters_3',['Allocation parameters',['../virtual_allocator.html#virtual_allocator_allocation_parameters',1,'']]], ['pdevice_4',['pDevice',['../struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html#ada1bf21205065b3aa0284b5a9ee1cb3c',1,'D3D12MA::ALLOCATOR_DESC']]], ['pdsttmpallocation_5',['pDstTmpAllocation',['../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#aec0c7f51ccc870c6a88af7c7390d8eda',1,'D3D12MA::DEFRAGMENTATION_MOVE']]], - ['pfree_6',['pFree',['../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#a114e6c4d63d6b020e01f526a975d6849',1,'D3D12MA::ALLOCATION_CALLBACKS']]], - ['pmoves_7',['pMoves',['../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#a719fbdaae54251759605c41baeb24dc4',1,'D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO']]], - ['pool_8',['Pool',['../class_d3_d12_m_a_1_1_pool.html',1,'D3D12MA']]], - ['pool_5fdesc_9',['POOL_DESC',['../struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html',1,'D3D12MA']]], - ['pool_5fflag_5falgorithm_5flinear_10',['POOL_FLAG_ALGORITHM_LINEAR',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1aa37a0103f511954ea42a1d0bba286b6a',1,'D3D12MA']]], - ['pool_5fflag_5falgorithm_5fmask_11',['POOL_FLAG_ALGORITHM_MASK',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1aec9d4939b8cc5438545b9df840b5f5f7',1,'D3D12MA']]], - ['pool_5fflag_5fmsaa_5ftextures_5falways_5fcommitted_12',['POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1acc379a89755438c0f76667783b778baa',1,'D3D12MA']]], - ['pool_5fflag_5fnone_13',['POOL_FLAG_NONE',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1a5d8dc91add3423140809a550c7224d02',1,'D3D12MA']]], - ['pool_5fflags_14',['POOL_FLAGS',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1',1,'D3D12MA']]], - ['pools_15',['Custom memory pools',['../custom_pools.html',1,'index']]], - ['pprivatedata_16',['pPrivateData',['../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#a98173cc9e239a84c2ce369854966e1e3',1,'D3D12MA::ALLOCATION_CALLBACKS::pPrivateData'],['../struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html#ac638dd987f1326e2fdab91892d994d35',1,'D3D12MA::ALLOCATION_DESC::pPrivateData'],['../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#aa1281297154e3823e98a7cc7e23b5d6b',1,'D3D12MA::VIRTUAL_ALLOCATION_DESC::pPrivateData'],['../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#a05c258ea40ea47667ddcc395b13a47a5',1,'D3D12MA::VIRTUAL_ALLOCATION_INFO::pPrivateData']]], - ['pprotectedsession_17',['pProtectedSession',['../struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html#a475840ec05c19732c8d5aa8bb27270f4',1,'D3D12MA::POOL_DESC']]], - ['preferredblocksize_18',['PreferredBlockSize',['../struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html#a97149c9559deae943c2cfa49aeeff8a6',1,'D3D12MA::ALLOCATOR_DESC']]], - ['prev_19',['prev',['../class_d3_d12_m_a_1_1_allocation.html#adc3ac89758a915a409e047f9b89aa160',1,'D3D12MA::Allocation']]], - ['project_20setup_20and_20initialization_20',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]], - ['psrcallocation_21',['pSrcAllocation',['../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#a4946b874c958a71c21fac25b515cf5f7',1,'D3D12MA::DEFRAGMENTATION_MOVE']]] + ['performance_6',['Allocation performance',['../optimal_allocation.html#optimal_allocation_allocation_Performance',1,'']]], + ['pfree_7',['pFree',['../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#a114e6c4d63d6b020e01f526a975d6849',1,'D3D12MA::ALLOCATION_CALLBACKS']]], + ['placed_20resources_8',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]], + ['pmoves_9',['pMoves',['../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#a719fbdaae54251759605c41baeb24dc4',1,'D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO']]], + ['pool_10',['Pool',['../class_d3_d12_m_a_1_1_pool.html',1,'D3D12MA']]], + ['pool_5fdesc_11',['POOL_DESC',['../struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html',1,'D3D12MA']]], + ['pool_5fflag_5falgorithm_5flinear_12',['POOL_FLAG_ALGORITHM_LINEAR',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1aa37a0103f511954ea42a1d0bba286b6a',1,'D3D12MA']]], + ['pool_5fflag_5falgorithm_5fmask_13',['POOL_FLAG_ALGORITHM_MASK',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1aec9d4939b8cc5438545b9df840b5f5f7',1,'D3D12MA']]], + ['pool_5fflag_5fmsaa_5ftextures_5falways_5fcommitted_14',['POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1acc379a89755438c0f76667783b778baa',1,'D3D12MA']]], + ['pool_5fflag_5fnone_15',['POOL_FLAG_NONE',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1a5d8dc91add3423140809a550c7224d02',1,'D3D12MA']]], + ['pool_5fflags_16',['POOL_FLAGS',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1',1,'D3D12MA']]], + ['pools_17',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]], + ['pprivatedata_18',['pPrivateData',['../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#a98173cc9e239a84c2ce369854966e1e3',1,'D3D12MA::ALLOCATION_CALLBACKS::pPrivateData'],['../struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html#ac638dd987f1326e2fdab91892d994d35',1,'D3D12MA::ALLOCATION_DESC::pPrivateData'],['../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#aa1281297154e3823e98a7cc7e23b5d6b',1,'D3D12MA::VIRTUAL_ALLOCATION_DESC::pPrivateData'],['../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#a05c258ea40ea47667ddcc395b13a47a5',1,'D3D12MA::VIRTUAL_ALLOCATION_INFO::pPrivateData']]], + ['pprotectedsession_19',['pProtectedSession',['../struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html#a475840ec05c19732c8d5aa8bb27270f4',1,'D3D12MA::POOL_DESC']]], + ['preferredblocksize_20',['PreferredBlockSize',['../struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html#a97149c9559deae943c2cfa49aeeff8a6',1,'D3D12MA::ALLOCATOR_DESC']]], + ['prev_21',['prev',['../class_d3_d12_m_a_1_1_allocation.html#adc3ac89758a915a409e047f9b89aa160',1,'D3D12MA::Allocation']]], + ['priority_22',['Residency priority',['../optimal_allocation.html#optimal_allocation_residency_priority',1,'']]], + ['project_20setup_20and_20initialization_23',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]], + ['psrcallocation_24',['pSrcAllocation',['../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#a4946b874c958a71c21fac25b515cf5f7',1,'D3D12MA::DEFRAGMENTATION_MOVE']]] ]; diff --git a/docs/html/search/enumvalues_0.js b/docs/html/search/enumvalues_0.js index ac4eaeb..3fcb12f 100644 --- a/docs/html/search/enumvalues_0.js +++ b/docs/html/search/enumvalues_0.js @@ -15,7 +15,8 @@ var searchData= ['allocator_5fflag_5falways_5fcommitted_12',['ALLOCATOR_FLAG_ALWAYS_COMMITTED',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916a068863dc0538ff4ea153b046b31e94fb',1,'D3D12MA']]], ['allocator_5fflag_5fdefault_5fpools_5fnot_5fzeroed_13',['ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916ae7dc7ab9168148281ebfe1586f554335',1,'D3D12MA']]], ['allocator_5fflag_5fdont_5fprefer_5fsmall_5fbuffers_5fcommitted_14',['ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916a15c1ba5fbc182ac927b3011e23e74a72',1,'D3D12MA']]], - ['allocator_5fflag_5fmsaa_5ftextures_5falways_5fcommitted_15',['ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916adfbfd20d716f2a46f74d6226056fef1e',1,'D3D12MA']]], - ['allocator_5fflag_5fnone_16',['ALLOCATOR_FLAG_NONE',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916a2fb30967b492c27823a80b5de3aea26f',1,'D3D12MA']]], - ['allocator_5fflag_5fsinglethreaded_17',['ALLOCATOR_FLAG_SINGLETHREADED',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916a1b06bb21df006f76a9ed1bc41838bc52',1,'D3D12MA']]] + ['allocator_5fflag_5fdont_5fuse_5ftight_5falignment_15',['ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916af13bc700d7b799c856c6516acac12fed',1,'D3D12MA']]], + ['allocator_5fflag_5fmsaa_5ftextures_5falways_5fcommitted_16',['ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916adfbfd20d716f2a46f74d6226056fef1e',1,'D3D12MA']]], + ['allocator_5fflag_5fnone_17',['ALLOCATOR_FLAG_NONE',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916a2fb30967b492c27823a80b5de3aea26f',1,'D3D12MA']]], + ['allocator_5fflag_5fsinglethreaded_18',['ALLOCATOR_FLAG_SINGLETHREADED',['../namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916a1b06bb21df006f76a9ed1bc41838bc52',1,'D3D12MA']]] ]; diff --git a/docs/html/search/functions_6.js b/docs/html/search/functions_6.js index 22c80f9..538639e 100644 --- a/docs/html/search/functions_6.js +++ b/docs/html/search/functions_6.js @@ -3,5 +3,6 @@ var searchData= ['iscachecoherentuma_0',['IsCacheCoherentUMA',['../class_d3_d12_m_a_1_1_allocator.html#a08210561b92c4bd7ede9dd7beba4bb80',1,'D3D12MA::Allocator']]], ['isempty_1',['IsEmpty',['../class_d3_d12_m_a_1_1_virtual_block.html#a7b23fd2da6f0343095fb14b31395678b',1,'D3D12MA::VirtualBlock']]], ['isgpuuploadheapsupported_2',['IsGPUUploadHeapSupported',['../class_d3_d12_m_a_1_1_allocator.html#a3f3fd1e88cf2cd02257fe272e08a273c',1,'D3D12MA::Allocator']]], - ['isuma_3',['IsUMA',['../class_d3_d12_m_a_1_1_allocator.html#a9e742884bd45dd7f01193d13fcd05af0',1,'D3D12MA::Allocator']]] + ['istightalignmentsupported_3',['IsTightAlignmentSupported',['../class_d3_d12_m_a_1_1_allocator.html#a3f5aa191cebdca7c1932da4723cfc03e',1,'D3D12MA::Allocator']]], + ['isuma_4',['IsUMA',['../class_d3_d12_m_a_1_1_allocator.html#a9e742884bd45dd7f01193d13fcd05af0',1,'D3D12MA::Allocator']]] ]; diff --git a/docs/html/search/pages_0.js b/docs/html/search/pages_0.js index 4393e44..45dc28f 100644 --- a/docs/html/search/pages_0.js +++ b/docs/html/search/pages_0.js @@ -1,8 +1,9 @@ var searchData= [ ['algorithm_0',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]], - ['aliasing_20overlap_1',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'index']]], - ['allocation_20algorithm_2',['Linear allocation algorithm',['../linear_algorithm.html',1,'index']]], - ['allocator_3',['D3D12 Memory Allocator',['../index.html',1,'']]], - ['allocator_4',['Virtual allocator',['../virtual_allocator.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']]] ]; diff --git a/docs/html/search/pages_1.js b/docs/html/search/pages_1.js index 31224a0..91cb574 100644 --- a/docs/html/search/pages_1.js +++ b/docs/html/search/pages_1.js @@ -2,5 +2,5 @@ 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,'index']]] + ['custom_20memory_20pools_2',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]] ]; diff --git a/docs/html/search/pages_2.js b/docs/html/search/pages_2.js index 2de3a05..8aa1a38 100644 --- a/docs/html/search/pages_2.js +++ b/docs/html/search/pages_2.js @@ -1,5 +1,5 @@ var searchData= [ ['d3d12_20memory_20allocator_0',['D3D12 Memory Allocator',['../index.html',1,'']]], - ['defragmentation_1',['Defragmentation',['../defragmentation.html',1,'index']]] + ['defragmentation_1',['Defragmentation',['../defragmentation.html',1,'optimal_allocation']]] ]; diff --git a/docs/html/search/pages_5.js b/docs/html/search/pages_5.js index f2b8cf1..2fa4310 100644 --- a/docs/html/search/pages_5.js +++ b/docs/html/search/pages_5.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,'index']]] + ['memory_20pools_1',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]] ]; diff --git a/docs/html/search/pages_6.js b/docs/html/search/pages_6.js index 4418e57..0c3cb7f 100644 --- a/docs/html/search/pages_6.js +++ b/docs/html/search/pages_6.js @@ -1,4 +1,5 @@ var searchData= [ - ['overlap_0',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'index']]] + ['optimal_20resource_20allocation_0',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]], + ['overlap_1',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]] ]; diff --git a/docs/html/search/pages_7.js b/docs/html/search/pages_7.js index 5076607..f4128dd 100644 --- a/docs/html/search/pages_7.js +++ b/docs/html/search/pages_7.js @@ -1,4 +1,4 @@ var searchData= [ - ['pools_0',['Custom memory pools',['../custom_pools.html',1,'index']]] + ['pools_0',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]] ]; diff --git a/docs/html/search/pages_9.js b/docs/html/search/pages_9.js index b448c1c..53f0a34 100644 --- a/docs/html/search/pages_9.js +++ b/docs/html/search/pages_9.js @@ -1,4 +1,5 @@ var searchData= [ - ['resource_20aliasing_20overlap_0',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'index']]] + ['resource_20aliasing_20overlap_0',['Resource aliasing (overlap)',['../resource_aliasing.html',1,'optimal_allocation']]], + ['resource_20allocation_1',['Optimal resource allocation',['../optimal_allocation.html',1,'index']]] ]; diff --git a/docs/html/search/pages_a.js b/docs/html/search/pages_a.js index 1cea77e..d4b7ec0 100644 --- a/docs/html/search/pages_a.js +++ b/docs/html/search/pages_a.js @@ -1,5 +1,5 @@ var searchData= [ ['start_0',['Quick start',['../quick_start.html',1,'index']]], - ['statistics_1',['Statistics',['../statistics.html',1,'index']]] + ['statistics_1',['Statistics',['../statistics.html',1,'optimal_allocation']]] ]; diff --git a/docs/html/search/pages_b.js b/docs/html/search/pages_b.js index f91f65a..6f1ceb8 100644 --- a/docs/html/search/pages_b.js +++ b/docs/html/search/pages_b.js @@ -1,4 +1,4 @@ var searchData= [ - ['virtual_20allocator_0',['Virtual allocator',['../virtual_allocator.html',1,'index']]] + ['virtual_20allocator_0',['Virtual allocator',['../virtual_allocator.html',1,'optimal_allocation']]] ]; diff --git a/docs/html/search/searchdata.js b/docs/html/search/searchdata.js index 9eb6f9b..5304a71 100644 --- a/docs/html/search/searchdata.js +++ b/docs/html/search/searchdata.js @@ -1,6 +1,6 @@ var indexSectionsWithContent = { - 0: "abcdefghijlmnopqrstuv", + 0: "abcdefghijlmnopqrstuvw", 1: "abdpstv", 2: "d", 3: "d", diff --git a/docs/html/statistics.html b/docs/html/statistics.html index ec896c4..8c1997d 100644 --- a/docs/html/statistics.html +++ b/docs/html/statistics.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Statistics +D3D12 Memory Allocator: Statistics @@ -25,7 +25,7 @@ -
      Direct3D 12 Memory Allocator +
      D3D12 Memory Allocator
      @@ -83,7 +83,7 @@

@@ -107,9 +107,9 @@

printf("D3D12 reports total usage %llu B with budget %llu B.\n",
localBudget.UsageBytes,
localBudget.BudgetBytes);
-
D3D12MA::Budget
Statistics of current memory usage and available budget for a specific memory segment group.
Definition D3D12MemAlloc.h:434
-
D3D12MA::Budget::BudgetBytes
UINT64 BudgetBytes
Estimated amount of memory available to the program.
Definition D3D12MemAlloc.h:457
-
D3D12MA::Budget::UsageBytes
UINT64 UsageBytes
Estimated current memory usage of the program.
Definition D3D12MemAlloc.h:446
+
D3D12MA::Budget
Statistics of current memory usage and available budget for a specific memory segment group.
Definition D3D12MemAlloc.h:442
+
D3D12MA::Budget::BudgetBytes
UINT64 BudgetBytes
Estimated amount of memory available to the program.
Definition D3D12MemAlloc.h:465
+
D3D12MA::Budget::UsageBytes
UINT64 UsageBytes
Estimated current memory usage of the program.
Definition D3D12MemAlloc.h:454

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().

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 0638382..374e731 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Member List +D3D12 Memory Allocator: Member List @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 c9aa47c..7d0fc80 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D3D12MA::ALLOCATION_CALLBACKS Struct Reference +D3D12 Memory Allocator: D3D12MA::ALLOCATION_CALLBACKS Struct Reference @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 2e9dab3..22bd372 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Member List +D3D12 Memory Allocator: Member List @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 4964128..e2b588b 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D3D12MA::ALLOCATION_DESC Struct Reference +D3D12 Memory Allocator: D3D12MA::ALLOCATION_DESC Struct Reference @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 5d00ca2..bfc67a0 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Member List +D3D12 Memory Allocator: Member List @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 6b172a0..f07cfd0 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D3D12MA::ALLOCATOR_DESC Struct Reference +D3D12 Memory Allocator: D3D12MA::ALLOCATOR_DESC Struct Reference @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 2f6f6be..f052559 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Member List +D3D12 Memory Allocator: Member List @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 e140631..b024dac 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D3D12MA::Budget Struct Reference +D3D12 Memory Allocator: D3D12MA::Budget Struct Reference @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 64d9214..b888785 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Member List +D3D12 Memory Allocator: Member List @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 3797be5..67371c8 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D3D12MA::DEFRAGMENTATION_DESC Struct Reference +D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_DESC Struct Reference @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 3c30170..8ce715b 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Member List +D3D12 Memory Allocator: Member List @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 b464912..590f089 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D3D12MA::DEFRAGMENTATION_MOVE Struct Reference +D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_MOVE Struct Reference @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 11efa00..832d30b 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Member List +D3D12 Memory Allocator: Member List @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 34970b6..10bf5ff 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Struct Reference +D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO Struct Reference @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 a1318da..9a5009a 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Member List +D3D12 Memory Allocator: Member List @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 62a8d18..fddde49 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D3D12MA::DEFRAGMENTATION_STATS Struct Reference +D3D12 Memory Allocator: D3D12MA::DEFRAGMENTATION_STATS Struct Reference @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 61dcb7a..0d2d352 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Member List +D3D12 Memory Allocator: Member List @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 4087d88..19ec5b0 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D3D12MA::DetailedStatistics Struct Reference +D3D12 Memory Allocator: D3D12MA::DetailedStatistics Struct Reference @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 7cbcc9d..a7f2195 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Member List +D3D12 Memory Allocator: Member List @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 0e76732..9e3c17b 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D3D12MA::POOL_DESC Struct Reference +D3D12 Memory Allocator: D3D12MA::POOL_DESC Struct Reference @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 ca3a0ed..ca272f5 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Member List +D3D12 Memory Allocator: Member List @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 a4f7263..29edc35 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D3D12MA::Statistics Struct Reference +D3D12 Memory Allocator: D3D12MA::Statistics Struct Reference @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 4cb062f..98553a5 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Member List +D3D12 Memory Allocator: Member List @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 ec2445f..354268a 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference +D3D12 Memory Allocator: D3D12MA::TotalStatistics Struct Reference @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 c1344d3..4a8fcc5 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Member List +D3D12 Memory Allocator: Member List @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 300a972..8187a44 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference +D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_DESC Struct Reference @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 11abd13..b30e7c4 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Member List +D3D12 Memory Allocator: Member List @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 940de6d..360aa26 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference +D3D12 Memory Allocator: D3D12MA::VIRTUAL_ALLOCATION_INFO Struct Reference @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 6d94986..107067b 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Member List +D3D12 Memory Allocator: Member List @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 3a8f82a..c95a5bb 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference +D3D12 Memory Allocator: D3D12MA::VIRTUAL_BLOCK_DESC Struct Reference @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 ffad3d7..50eb3e5 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Member List +D3D12 Memory Allocator: Member List @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
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 f718024..f772034 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 @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference +D3D12 Memory Allocator: D3D12MA::VirtualAllocation Struct Reference @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html index fa267e4..be6fde7 100644 --- a/docs/html/virtual_allocator.html +++ b/docs/html/virtual_allocator.html @@ -5,7 +5,7 @@ -Direct3D 12 Memory Allocator: Virtual allocator +D3D12 Memory Allocator: Virtual allocator @@ -25,7 +25,7 @@ -
Direct3D 12 Memory Allocator +
D3D12 Memory Allocator
@@ -83,7 +83,7 @@
@@ -91,7 +91,7 @@
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.

+

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:

@@ -105,9 +105,9 @@

D3D12MA::VirtualBlock *block;
HRESULT hr = CreateVirtualBlock(&blockDesc, &block);
-
D3D12MA::VirtualBlock
Represents pure allocation algorithm and a data structure with allocations in some memory block,...
Definition D3D12MemAlloc.h:1513
-
D3D12MA::VIRTUAL_BLOCK_DESC
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
Definition D3D12MemAlloc.h:1419
-
D3D12MA::VIRTUAL_BLOCK_DESC::Size
UINT64 Size
Total size of the block.
Definition D3D12MemAlloc.h:1427
+
D3D12MA::VirtualBlock
Represents pure allocation algorithm and a data structure with allocations in some memory block,...
Definition D3D12MemAlloc.h:1537
+
D3D12MA::VIRTUAL_BLOCK_DESC
Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
Definition D3D12MemAlloc.h:1443
+
D3D12MA::VIRTUAL_BLOCK_DESC::Size
UINT64 Size
Total size of the block.
Definition D3D12MemAlloc.h:1451

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.

@@ -132,9 +132,9 @@

// Allocation failed - no space for it could be found. Handle this error!
}
D3D12MA::VirtualBlock::Allocate
HRESULT Allocate(const VIRTUAL_ALLOCATION_DESC *pDesc, VirtualAllocation *pAllocation, UINT64 *pOffset)
Creates new allocation.
-
D3D12MA::VIRTUAL_ALLOCATION_DESC
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
Definition D3D12MemAlloc.h:1464
-
D3D12MA::VIRTUAL_ALLOCATION_DESC::Size
UINT64 Size
Size of the allocation.
Definition D3D12MemAlloc.h:1471
-
D3D12MA::VirtualAllocation
Represents single memory allocation done inside VirtualBlock.
Definition D3D12MemAlloc.h:463
+
D3D12MA::VIRTUAL_ALLOCATION_DESC
Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
Definition D3D12MemAlloc.h:1488
+
D3D12MA::VIRTUAL_ALLOCATION_DESC::Size
UINT64 Size
Size of the allocation.
Definition D3D12MemAlloc.h:1495
+
D3D12MA::VirtualAllocation
Represents single memory allocation done inside VirtualBlock.
Definition D3D12MemAlloc.h:471

Deallocation

When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.

@@ -171,7 +171,7 @@

D3D12MA::VirtualAllocation alloc;
UINT64 allocOffset;
hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
-
D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
UINT64 Alignment
Required alignment of the allocation.
Definition D3D12MemAlloc.h:1476
+
D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
UINT64 Alignment
Required alignment of the allocation.
Definition D3D12MemAlloc.h:1500

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:

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.

diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h index 23c8f70..c56d393 100644 --- a/include/D3D12MemAlloc.h +++ b/include/D3D12MemAlloc.h @@ -39,6 +39,14 @@ Documentation of all members: D3D12MemAlloc.h - [Resource reference counting](@ref quick_start_resource_reference_counting) - [Mapping memory](@ref quick_start_mapping_memory) - \subpage custom_pools +- \subpage optimal_allocation + - [Avoiding running out of memory](@ref optimal_allocation_avoiding_running_out_of_memory) + - [Allocation performance](@ref optimal_allocation_allocation_Performance) + - [Sub-allocating buffers](@ref optimal_allocation_suballocating_buffers) + - [Residency priority](@ref optimal_allocation_residency_priority) + - [GPU upload heap](@ref optimal_allocation_gpu_upload_heap) + - [Committed versus placed resources](@ref optimal_allocation_committed_vs_placed) + - [Resource alignment](@ref optimal_allocation_resource_alignment) - \subpage defragmentation - \subpage statistics - \subpage resource_aliasing @@ -52,10 +60,10 @@ Documentation of all members: D3D12MemAlloc.h - [Versioning and compatibility](@ref general_considerations_versioning_and_compatibility) - [Features not supported](@ref general_considerations_features_not_supported) -\section main_see_also See also +\section main_see_also Web links -- [Product page on GPUOpen](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) -- [Source repository on GitHub](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) +- [Direct3D 12 Memory Allocator at GPUOpen.com](https://gpuopen.com/gaming-product/d3d12-memory-allocator/) - product page +- [GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator at GitHub.com](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator) - source code repository */ // If using this library on a platform different than Windows PC or want to use different version of DXGI, @@ -83,24 +91,24 @@ Documentation of all members: D3D12MemAlloc.h #endif #endif -/* -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 4K and their size a multiply of 4K instead of 64K. - -#define D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT 0 - Disables small texture alignment. -#define D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT 1 - 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. -*/ #ifndef D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT + /** \brief + 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 1 #endif @@ -1058,7 +1066,11 @@ enum ALLOCATOR_FLAGS The library chooses the most optimal method automatically. */ ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED = 0x10, - /** TODO document... */ + /** Disables the use of the tight alignment feature even when it is supported on the current system. + By default, the feature is used whenever available. + + Support can be checked by D3D12MA::Allocator::IsTightAlignmentSupported() regardless of using this flag. + */ ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT = 0x20, }; @@ -1141,7 +1153,7 @@ class D3D12MA_API Allocator : public IUnknownImpl BOOL IsTightAlignmentSupported() const; /** \brief Returns total amount of memory of specific segment group, in bytes. - \param memorySegmentGroup use `DXGI_MEMORY_SEGMENT_GROUP_LOCAL` or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL`. + \param 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. @@ -1615,13 +1627,13 @@ DEFINE_ENUM_FLAG_OPERATORS(D3D12MA::VIRTUAL_ALLOCATION_FLAGS); \section quick_start_project_setup Project setup and initialization -This is a small, standalone C++ library. It consists of a pair of 2 files: +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 2019, but it +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: @@ -1659,6 +1671,10 @@ HRESULT hr = D3D12MA::CreateAllocator(&allocatorDesc, &allocator); (5.) Right before destroying the D3D12 device, destroy the allocator object. +\code +allocator->Release(); +\endcode + 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. @@ -1666,10 +1682,6 @@ You can use smart pointers designed for COM with objects of this library - e.g. The reference counter is thread-safe. `QueryInterface` method supports only `IUnknown`, as classes of this library don't define their own GUIDs. -\code -allocator->Release(); -\endcode - \section quick_start_creating_resources Creating resources @@ -1732,10 +1744,10 @@ 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`). +or Copy (`CopyResource`). The library also automatically handles resource heap tier. -When `D3D12_FEATURE_DATA_D3D12_OPTIONS::ResourceHeapTier` equals `D3D12_RESOURCE_HEAP_TIER_1`, +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 @@ -1758,7 +1770,7 @@ When only D3D12MA::Allocation object is obtained from a function call like D3D12 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, +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. @@ -1852,8 +1864,9 @@ HRESULT hr = allocator->CreateResource( &allocation, IID_PPV_ARGS(&resource)); +D3D12_RANGE emptyRange = {0, 0}; void* mappedPtr; -hr = resource->Map(0, NULL, &mappedPtr); +hr = resource->Map(0, &emptyRange, &mappedPtr); memcpy(mappedPtr, bufData, bufSize); @@ -1945,6 +1958,486 @@ in some cases, e.g. to have separate memory usage statistics for some group of r extended allocation parameters, like custom `D3D12_HEAP_PROPERTIES`, which are available only in custom pools. +\page optimal_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. + +\section optimal_allocation_avoiding_running_out_of_memory 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 may succeed, but take long time (even a significant fraction of a second). +- Some resources are automatically evicted 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. + +Unfortunately, there is no way to be 100% protected against memory overcommitment. +The best approach is to avoid allocating too much memory. + +The full capacity of the memory can be queried using function D3D12MA::Allocator::GetMemoryCapacity. +However, it is not recommended, because the amount of memory available to the application +is typically smaller than the full capacity, as some portion of it is reserved by the operating system +or used by other processes. + +Because of this, the recommended way of fetching the **memory budget** available to the application +is using function D3D12MA::Allocator::GetBudget. +Preventing value D3D12MA::Budget::UsageBytes from exceeding the D3D12MA::Budget::BudgetBytes +is probably the best we can do in trying to avoid the consequences of over-commitment. +For more information, see also: \subpage statistics. + +Example: + +\code +D3D12MA::Budget videoMemBudget = {}; +allocator->GetBudget(&videoMemBudget, NULL); + +UINT64 freeBytes = videoMemBudget.BudgetBytes - videoMemBudget.UsageBytes; +gameStreamingSystem->SetAvailableFreeMemory(freeBytes); +\endcode + +\par 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. + +\par 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. + +\section optimal_allocation_allocation_Performance 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. + +\par 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. + +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. + +\section optimal_allocation_suballocating_buffers 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. + +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: \subpage 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. + +\section optimal_allocation_residency_priority Residency priority + +When too much video memory is allocated, one of the things that can happen is the system +evicting 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 eviction. +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. + +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 evicted to system memory, degrading performance +of all the resources placed in it. + +Example: + +\code +D3D12MA::POOL_DESC poolDesc = {}; +poolDesc.HeapProperties.Type = D3D12_HEAP_TYPE_DEFAULT; +poolDesc.HeapFlags = D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS | D3D12_HEAP_FLAG_CREATE_NOT_ZEROED; +poolDesc.ResidencyPriority = D3D12_RESIDENCY_PRIORITY_HIGH; // !!! + +D3D12MA::Pool* pool; +HRESULT hr = allocator->CreatePool(&poolDesc, &pool); +// Check hr... + +D3D12MA::ALLOCATION_DESC allocDesc = {}; +allocDesc.CustomPool = pool; +allocDesc.Flags = ALLOCATION_FLAG_COMMITTED; // !!! + +D3D12_RESOURCE_DESC resDesc = {}; +resDesc.Dimension = D3D12_RESOURCE_DIMENSION_BUFFER; +resDesc.Alignment = 0; +resDesc.Width = 1048576; // Requested buffer size. +resDesc.Height = 1; +resDesc.DepthOrArraySize = 1; +resDesc.MipLevels = 1; +resDesc.Format = DXGI_FORMAT_UNKNOWN; +resDesc.SampleDesc.Count = 1; +resDesc.SampleDesc.Quality = 0; +resDesc.Layout = D3D12_TEXTURE_LAYOUT_ROW_MAJOR; +resDesc.Flags = D3D12_RESOURCE_FLAG_ALLOW_UNORDERED_ACCESS; + +D3D12MA::Allocation* alloc; +hr = allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, + NULL, &alloc, IID_NULL, NULL); +// Check hr... +\endcode + +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 eviction described here happens automatically and only slows down the execution. + +\section optimal_allocation_gpu_upload_heap 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. + +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: + +- Supporting motherboard and its UEFI. +- Supporting graphics card and its graphics driver. +- 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: + +- 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. +- 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. + +- 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`. + +Example: + +\code +// Fast path for data upload. +if(allocator->IsGPUUploadHeapSupported()) +{ + D3D12MA::ALLOCATION_DESC allocDesc = {}; + allocDesc.HeapType = D3D12_HEAP_TYPE_GPU_UPLOAD; // !!! + + D3D12_RESOURCE_DESC resDesc = {}; + resDesc.Dimension = D3D12_RESOURCE_DIMENSION_BUFFER; + resDesc.Alignment = 0; + resDesc.Width = 1048576; // Requested buffer size. + resDesc.Height = 1; + resDesc.DepthOrArraySize = 1; + resDesc.MipLevels = 1; + resDesc.Format = DXGI_FORMAT_UNKNOWN; + resDesc.SampleDesc.Count = 1; + resDesc.SampleDesc.Quality = 0; + resDesc.Layout = D3D12_TEXTURE_LAYOUT_ROW_MAJOR; + resDesc.Flags = D3D12_RESOURCE_FLAG_NONE; + + D3D12MA::Allocation* alloc; + ID3D12Resource* res; + hr = allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, + NULL, &alloc, IID_PPV_ARGS(&res)); + // Check hr... + + D3D12_RANGE emptyRange = {0, 0}; + void* mappedPtr = NULL; + hr = res->Map(0, &emptyRange, &mappedPtr); + memcpy(mappedPtr, srcData, 1048576); + res->Unmap(0, NULL); // Optional. You can leave it persistently mapped. + + D3D12_GPU_VIRTUAL_ADDRESS gpuva = res->GetGPUVirtualAddress(); + // Use gpuva to access the buffer on the GPU... +\endcode + +\section optimal_allocation_committed_vs_placed Committed versus placed resources + +When using D3D12 API directly, there are 3 ways of creating resources: + +1. **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. +2. **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. +3. **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 biggest advantage of using placed resources is the allocation performance. + Once a heap is allocated, creating and releasing resources placed in it can be much faster than + creating them as committed, which would involve allocating a new heap for each resource. + - Using large number of small heaps can put an extra burden on the software stack, + including D3D12 runtime, graphics driver, operating system, and developer tools like Radeon Memory Visualizer (RMV). +- The advantage of committed resources is that their implicit heaps have exactly the right size, + while creating resources as placed inside larger heaps can lead to some memory wasted because: + - Some part of the allocated heap memory is unused. + - After placed resources of various sizes are created and released in random order, + gaps between remaining resources can be too small to fit new allocations. + This is also known as "fragmentation". A solution to this problem is implementing \subpage defragmentation. + - The alignment required by placed resources can leave gaps between them, while the driver can pack individual committed resources better. + For details, see section "Resource alignment" below. +- 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. +- 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 \subpage resource_aliasing. + +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. + +\par Implementation detail +%D3D12MA creates large heaps (default size is 64 MB) and creates resources as placed in them. +However, it may decide that it is required or preferred to create the specific resource as committed for many reasons, including: +- When the resource is large (larger than half of the default heap size). +- When allocating an entire new heap would exceed the current budget or when we are already over the budget. +- When the resource is a very small buffer. Placed buffers need to be aligned to 64 KB by default, + while creating them as committed can allow the driver to pack them better. + This heuristics 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. +- When the resource uses non-standard flags specified via D3D12MA::ALLOCATION_DESC::ExtraHeapFlags. + +You can check whether an allocation was created as a committed resource by checking if its heap is null. +Committed resources have an implicit heap that is not directly accessible. + +\code +bool isCommitted = allocation->GetHeap() == NULL; +\endcode + +You can request a new resource to be created as committed by using D3D12MA::ALLOCATION_FLAG_COMMITTED. +Note that committed resources can also be created out of \subpage custom_pools. + +You can also request all resources to be created as committed globally for the entire allocator +by using D3D12MA::ALLOCATOR_FLAG_ALWAYS_COMMITTED. +However, this contradicts the main purpose of using this library. +It can also prevent certain other features of the library to be used. +This flag should be used only for debugging purposes. + +You can create a custom pool with an explicit block size by specifying non-zero D3D12MA::POOL_DESC::BlockSize. +When doing this, all **resources created in such pool are placed** in those blocks (heaps) and never created as committed. +Example: + +\code +D3D12MA::POOL_DESC poolDesc = {}; +poolDesc.HeapFlags = D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS | D3D12_HEAP_FLAG_CREATE_NOT_ZEROED; +poolDesc.HeapProperties.Type = D3D12_HEAP_TYPE_DEFAULT; +poolDesc.BlockSize = 100llu * 1024 * 1024; // 100 MB. Explicit BlockSize guarantees placed. + +D3D12MA::Pool* pool; +HRESULT hr = allocator->CreatePool(&poolDesc, &pool); +// Check hr... + +D3D12MA::ALLOCATION_DESC allocDesc = {}; +allocDesc.CustomPool = pool; + +D3D12_RESOURCE_DESC resDesc = {}; +resDesc.Dimension = D3D12_RESOURCE_DIMENSION_BUFFER; +resDesc.Alignment = 0; +resDesc.Width = 90llu * 1024 * 1024; // 90 MB +resDesc.Height = 1; +resDesc.DepthOrArraySize = 1; +resDesc.MipLevels = 1; +resDesc.Format = DXGI_FORMAT_UNKNOWN; +resDesc.SampleDesc.Count = 1; +resDesc.SampleDesc.Quality = 0; +resDesc.Layout = D3D12_TEXTURE_LAYOUT_ROW_MAJOR; +resDesc.Flags = D3D12_RESOURCE_FLAG_NONE; + +D3D12MA::Allocation* alloc; +ID3D12Resource* res; +hr = allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, + NULL, &alloc, IID_PPV_ARGS(&res)); +// Check hr... + +// Even a large buffer like this, filling 90% of the block, was created as placed! +assert(alloc->GetHeap() != NULL); +\endcode + +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. + +\section optimal_allocation_resource_alignment 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. + +\par 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. + +With DirectX 12 Agility SDK 1.716.0-preview, Microsoft added a new feature called **"tight alignment"**. +Note this is a separate feature than the "small alignment" described earlier. +When using this new SDK and a compatible graphics driver, the API exposes support for this new feature. +Then, a new flag `D3D12_RESOURCE_FLAG_USE_TIGHT_ALIGNMENT` can be added when creating a resource. +D3D12 can then return the alignment required for the resource smaller than the default ones described above. +This library automatically makes use of the tight alignment feature when available and adds that new resource flag. +When the tight alignment is enabled, the heuristics that creates small buffers as committed described above is deactivated, +as it is no longer needed. + +You can check if the tight alignment it is available in the current system by calling D3D12MA::Allocator::IsTightAlignmentSupported(). +You can tell the library to not use it by specifying D3D12MA::ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT. +Typically, you don't need to do any of those. + +The library automatically aligns all buffers to at least 256 B, even when the system supports smaller alignment. +This is the alignment required for constant buffers, expressed by `D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT` constant. + \page defragmentation Defragmentation Interleaved allocations and deallocations of many objects of varying size can @@ -2363,6 +2856,7 @@ As an extra feature, the core allocation algorithm of the library is exposed thr 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`. \section virtual_allocator_creating_virtual_block Creating virtual block diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp index 0d358ea..26415b0 100644 --- a/src/D3D12MemAlloc.cpp +++ b/src/D3D12MemAlloc.cpp @@ -108,7 +108,7 @@ especially to test compatibility with D3D12_RESOURCE_HEAP_TIER_1 on modern GPUs. #endif #ifndef D3D12MA_TIGHT_ALIGNMENT_SUPPORTED - #if D3D12_PREVIEW_SDK_VERSION >= 716 + #if D3D12_PREVIEW_SDK_VERSION >= 716 // TODO: Change after the feature ships in the retail Agility SDK. #define D3D12MA_TIGHT_ALIGNMENT_SUPPORTED 1 #else #define D3D12MA_TIGHT_ALIGNMENT_SUPPORTED 0 diff --git a/src/Doxyfile b/src/Doxyfile index e9cc11b..a411ab1 100644 --- a/src/Doxyfile +++ b/src/Doxyfile @@ -1,7 +1,7 @@ -# Doxyfile 1.9.6 +# Doxyfile 1.13.0 # This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. +# Doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. @@ -15,10 +15,10 @@ # # Note: # -# Use doxygen to compare the used configuration file with the template +# Use Doxygen to compare the used configuration file with the template # configuration file: # doxygen -x [configFile] -# Use doxygen to compare the used configuration file with the template +# Use Doxygen to compare the used configuration file with the template # configuration file without replacing the environment variables or CMake type # replacement variables: # doxygen -x_noenv [configFile] @@ -51,7 +51,7 @@ PROJECT_NAME = "D3D12 Memory Allocator" PROJECT_NUMBER = # Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a +# for a project that appears at the top of each page and should give viewers a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = @@ -63,18 +63,24 @@ PROJECT_BRIEF = PROJECT_LOGO = +# With the PROJECT_ICON tag one can specify an icon that is included in the tabs +# when the HTML document is shown. Doxygen will copy the logo to the output +# directory. + +PROJECT_ICON = + # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where doxygen was started. If +# entered, it will be relative to the location where Doxygen was started. If # left blank the current directory will be used. OUTPUT_DIRECTORY = @CMAKE_SOURCE_DIR@/docs -# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 +# If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096 # sub-directories (in 2 levels) under the output directory of each output format # and will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes +# option can be useful when feeding Doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise cause # performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to # control the number of sub-directories. # The default value is: NO. @@ -92,7 +98,7 @@ CREATE_SUBDIRS = NO CREATE_SUBDIRS_LEVEL = 8 -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# If the ALLOW_UNICODE_NAMES tag is set to YES, Doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode # U+3044. @@ -101,7 +107,7 @@ CREATE_SUBDIRS_LEVEL = 8 ALLOW_UNICODE_NAMES = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this +# documentation generated by Doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, # Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English @@ -115,14 +121,14 @@ ALLOW_UNICODE_NAMES = NO OUTPUT_LANGUAGE = English -# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# If the BRIEF_MEMBER_DESC tag is set to YES, Doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES -# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# If the REPEAT_BRIEF tag is set to YES, Doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the @@ -153,13 +159,13 @@ ABBREVIATE_BRIEF = "The $name class" \ the # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief +# Doxygen will generate a detailed section even if there is only a brief # description. # The default value is: NO. ALWAYS_DETAILED_SEC = NO -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# If the INLINE_INHERITED_MEMB tag is set to YES, Doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. @@ -167,7 +173,7 @@ ALWAYS_DETAILED_SEC = NO INLINE_INHERITED_MEMB = NO -# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# If the FULL_PATH_NAMES tag is set to YES, Doxygen will prepend the full path # before files name in the file list and in the header files. If set to NO the # shortest path that makes the file name unique will be used # The default value is: YES. @@ -177,11 +183,11 @@ FULL_PATH_NAMES = YES # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. # Stripping is only done if one of the specified strings matches the left-hand # part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to +# If left blank the directory from which Doxygen is run is used as the path to # strip. # # Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. +# will be relative from the directory where Doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = @@ -195,41 +201,42 @@ STRIP_FROM_PATH = STRIP_FROM_INC_PATH = -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't +# If the SHORT_NAMES tag is set to YES, Doxygen will generate much shorter (but +# less readable) file names. This can be useful if your file system doesn't # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. SHORT_NAMES = NO -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen will interpret the +# first line (until the first dot, question mark or exclamation mark) of a +# Javadoc-style comment as the brief description. If set to NO, the Javadoc- +# style will behave just like regular Qt-style comments (thus requiring an +# explicit @brief command for a brief description.) # The default value is: NO. JAVADOC_AUTOBRIEF = NO -# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# If the JAVADOC_BANNER tag is set to YES then Doxygen will interpret a line # such as # /*************** # as being the beginning of a Javadoc-style comment "banner". If set to NO, the # Javadoc-style will behave just like regular comments and it will not be -# interpreted by doxygen. +# interpreted by Doxygen. # The default value is: NO. JAVADOC_BANNER = NO -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will interpret the first +# line (until the first dot, question mark or exclamation mark) of a Qt-style +# comment as the brief description. If set to NO, the Qt-style will behave just +# like regular Qt-style comments (thus requiring an explicit \brief command for +# a brief description.) # The default value is: NO. QT_AUTOBRIEF = NO -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen treat a # multi-line C++ special comment block (i.e. a block of //! or /// comments) as # a brief description. This used to be the default behavior. The new default is # to treat a multi-line C++ comment block as a detailed description. Set this @@ -241,10 +248,10 @@ QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO -# By default Python docstrings are displayed as preformatted text and doxygen's +# By default Python docstrings are displayed as preformatted text and Doxygen's # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the -# doxygen's special commands can be used and the contents of the docstring -# documentation blocks is shown as doxygen documentation. +# Doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as Doxygen documentation. # The default value is: YES. PYTHON_DOCSTRING = YES @@ -255,7 +262,7 @@ PYTHON_DOCSTRING = YES INHERIT_DOCS = YES -# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# If the SEPARATE_MEMBER_PAGES tag is set to YES then Doxygen will produce a new # page for each member. If set to NO, the documentation of a member will be part # of the file/class/namespace that contains it. # The default value is: NO. @@ -325,30 +332,30 @@ OPTIMIZE_OUTPUT_SLICE = NO # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# language is one of the parsers supported by Doxygen: IDL, Java, JavaScript, # Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, # VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser # tries to guess whether the code is fixed or free formatted code, this is the -# default for Fortran type files). For instance to make doxygen treat .inc files +# default for Fortran type files). For instance to make Doxygen treat .inc files # as Fortran files (default is PHP), and .f files as C (default is Fortran), # use: inc=Fortran f=C. # # Note: For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. When specifying no_extension you should add +# the files are not read by Doxygen. When specifying no_extension you should add # * to the FILE_PATTERNS. # # Note see also the list of default file extension mappings. EXTENSION_MAPPING = -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# If the MARKDOWN_SUPPORT tag is enabled then Doxygen pre-processes all comments # according to the Markdown format, which allows for more readable # documentation. See https://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you can -# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# The output of markdown processing is further processed by Doxygen, so you can +# mix Doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. # The default value is: YES. @@ -358,25 +365,45 @@ MARKDOWN_SUPPORT = YES # to that level are automatically included in the table of contents, even if # they do not have an id attribute. # Note: This feature currently applies only to Markdown headings. -# Minimum value: 0, maximum value: 99, default value: 5. +# Minimum value: 0, maximum value: 99, default value: 6. # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. TOC_INCLUDE_HEADINGS = 0 -# When enabled doxygen tries to link words that correspond to documented +# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to +# generate identifiers for the Markdown headings. Note: Every identifier is +# unique. +# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a +# sequence number starting at 0 and GITHUB use the lower case version of title +# with any whitespace replaced by '-' and punctuation characters removed. +# The default value is: DOXYGEN. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +MARKDOWN_ID_STYLE = DOXYGEN + +# When enabled Doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by putting a % sign in front of the word or -# globally by setting AUTOLINK_SUPPORT to NO. +# globally by setting AUTOLINK_SUPPORT to NO. Words listed in the +# AUTOLINK_IGNORE_WORDS tag are excluded from automatic linking. # The default value is: YES. AUTOLINK_SUPPORT = YES +# This tag specifies a list of words that, when matching the start of a word in +# the documentation, will suppress auto links generation, if it is enabled via +# AUTOLINK_SUPPORT. This list does not affect affect links explicitly created +# using \# or the \link or commands. +# This tag requires that the tag AUTOLINK_SUPPORT is set to YES. + +AUTOLINK_IGNORE_WORDS = + # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should set this -# tag to YES in order to let doxygen match functions declarations and +# tag to YES in order to let Doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. +# versus func(std::string) {}). This also makes the inheritance and +# collaboration diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = NO @@ -388,16 +415,16 @@ BUILTIN_STL_SUPPORT = NO CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. +# https://www.riverbankcomputing.com/software) sources only. Doxygen will parse +# them like normal C++ but will assume all classes use public instead of private +# inheritance when no explicit protection keyword is present. # The default value is: NO. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. +# Doxygen to replace the get and set methods by a property in the documentation. # This will only work if the methods are indeed getting or setting a simple # type. If this is not the case, or you want to show the methods anyway, you # should set this option to NO. @@ -406,7 +433,7 @@ SIP_SUPPORT = NO IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES then doxygen will reuse the documentation of the first +# tag is set to YES then Doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. # The default value is: NO. @@ -464,18 +491,18 @@ TYPEDEF_HIDES_STRUCT = NO # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be # an expensive process and often the same symbol appears multiple times in the -# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small -# doxygen will become slower. If the cache is too large, memory is wasted. The +# code, Doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# Doxygen will become slower. If the cache is too large, memory is wasted. The # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 -# symbols. At the end of a run doxygen will report the cache usage and suggest +# symbols. At the end of a run Doxygen will report the cache usage and suggest # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 -# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use -# during processing. When set to 0 doxygen will based this on the number of +# The NUM_PROC_THREADS specifies the number of threads Doxygen is allowed to use +# during processing. When set to 0 Doxygen will based this on the number of # cores available in the system. You can set it explicitly to a value larger # than 0 to get more control over the balance between CPU load and processing # speed. At this moment only the input processing can be done using multiple @@ -487,11 +514,19 @@ LOOKUP_CACHE_SIZE = 0 NUM_PROC_THREADS = 1 +# If the TIMESTAMP tag is set different from NO then each generated page will +# contain the date or date and time when the page was generated. Setting this to +# NO can help when comparing the output of multiple runs. +# Possible values are: YES, NO, DATETIME and DATE. +# The default value is: NO. + +TIMESTAMP = NO + #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- -# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# If the EXTRACT_ALL tag is set to YES, Doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. @@ -557,7 +592,7 @@ EXTRACT_ANON_NSPACES = NO RESOLVE_UNNAMED_PARAMS = YES -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation # section is generated. This option has no effect if EXTRACT_ALL is enabled. @@ -565,7 +600,7 @@ RESOLVE_UNNAMED_PARAMS = YES HIDE_UNDOC_MEMBERS = NO -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO, these classes will be included in the various overviews. This option # will also hide undocumented C++ concepts if enabled. This option has no effect @@ -574,14 +609,22 @@ HIDE_UNDOC_MEMBERS = NO HIDE_UNDOC_CLASSES = NO -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# If the HIDE_UNDOC_NAMESPACES tag is set to YES, Doxygen will hide all +# undocumented namespaces that are normally visible in the namespace hierarchy. +# If set to NO, these namespaces will be included in the various overviews. This +# option has no effect if EXTRACT_ALL is enabled. +# The default value is: YES. + +HIDE_UNDOC_NAMESPACES = YES + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all friend # declarations. If set to NO, these declarations will be included in the # documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = YES -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any # documentation blocks found inside the body of a function. If set to NO, these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. @@ -595,7 +638,7 @@ HIDE_IN_BODY_DOCS = NO INTERNAL_DOCS = NO -# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# With the correct setting of option CASE_SENSE_NAMES Doxygen will better be # able to match the capabilities of the underlying filesystem. In case the # filesystem is case sensitive (i.e. it supports files in the same directory # whose names only differ in casing), the option must be set to YES to properly @@ -604,7 +647,7 @@ INTERNAL_DOCS = NO # output files written for symbols that only differ in casing, such as for two # classes, one named CLASS and the other named Class, and to also support # references to files without having to specify the exact matching casing. On -# Windows (including Cygwin) and MacOS, users should typically set this option +# Windows (including Cygwin) and macOS, users should typically set this option # to NO, whereas on Linux or other Unix flavors it should typically be set to # YES. # Possible values are: SYSTEM, NO and YES. @@ -612,14 +655,14 @@ INTERNAL_DOCS = NO CASE_SENSE_NAMES = NO -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# If the HIDE_SCOPE_NAMES tag is set to NO then Doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES, the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO -# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then Doxygen will # append additional text to a page's title, such as Class Reference. If set to # YES the compound reference will be hidden. # The default value is: NO. @@ -632,7 +675,7 @@ HIDE_COMPOUND_REFERENCE= NO SHOW_HEADERFILE = YES -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# If the SHOW_INCLUDE_FILES tag is set to YES then Doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. @@ -645,7 +688,7 @@ SHOW_INCLUDE_FILES = YES SHOW_GROUPED_MEMB_INC = NO -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen will list include # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. @@ -657,14 +700,14 @@ FORCE_LOCAL_INCLUDES = NO INLINE_INFO = YES -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# If the SORT_MEMBER_DOCS tag is set to YES then Doxygen will sort the # (detailed) documentation of file and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = YES -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# If the SORT_BRIEF_DOCS tag is set to YES then Doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. @@ -672,7 +715,7 @@ SORT_MEMBER_DOCS = YES SORT_BRIEF_DOCS = NO -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then Doxygen will sort the # (brief and detailed) documentation of class members so that constructors and # destructors are listed first. If set to NO the constructors will appear in the # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. @@ -684,7 +727,7 @@ SORT_BRIEF_DOCS = NO SORT_MEMBERS_CTORS_1ST = NO -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# If the SORT_GROUP_NAMES tag is set to YES then Doxygen will sort the hierarchy # of group names into alphabetical order. If set to NO the group names will # appear in their defined order. # The default value is: NO. @@ -701,11 +744,11 @@ SORT_GROUP_NAMES = NO SORT_BY_SCOPE_NAME = NO -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# If the STRICT_PROTO_MATCHING option is enabled and Doxygen fails to do proper # type resolution of all parameters of a function it will reject a match between # the prototype and the implementation of a member function even if there is # only one candidate or it is obvious which candidate to choose by doing a -# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# simple string match. By disabling STRICT_PROTO_MATCHING Doxygen will still # accept a match between prototype and implementation in such cases. # The default value is: NO. @@ -775,25 +818,25 @@ SHOW_FILES = YES SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from +# Doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file +# by Doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated +# by Doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can +# that represents Doxygen's defaults, run Doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml # will be used as the name of the layout file. See also section "Changing the # layout of pages" for information. # -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# Note that if you run Doxygen from a directory containing a file called +# DoxygenLayout.xml, Doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = @@ -808,19 +851,35 @@ LAYOUT_FILE = CITE_BIB_FILES = +# The EXTERNAL_TOOL_PATH tag can be used to extend the search path (PATH +# environment variable) so that external tools such as latex and gs can be +# found. +# Note: Directories specified with EXTERNAL_TOOL_PATH are added in front of the +# path already specified by the PATH variable, and are added in the order +# specified. +# Note: This option is particularly useful for macOS version 14 (Sonoma) and +# higher, when running Doxygen from Doxywizard, because in this case any user- +# defined changes to the PATH are ignored. A typical example on macOS is to set +# EXTERNAL_TOOL_PATH = /Library/TeX/texbin /usr/local/bin +# together with the standard path, the full search path used by doxygen when +# launching external tools will then become +# PATH=/Library/TeX/texbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin + +EXTERNAL_TOOL_PATH = + #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the +# standard output by Doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# generated to standard error (stderr) by Doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. @@ -828,14 +887,14 @@ QUIET = NO WARNINGS = YES -# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# If the WARN_IF_UNDOCUMENTED tag is set to YES then Doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: YES. WARN_IF_UNDOCUMENTED = YES -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# If the WARN_IF_DOC_ERROR tag is set to YES, Doxygen will generate warnings for # potential errors in the documentation, such as documenting some parameters in # a documented function twice, or documenting parameters that don't exist or # using markup commands wrongly. @@ -843,8 +902,8 @@ WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES -# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete -# function parameter documentation. If set to NO, doxygen will accept that some +# If WARN_IF_INCOMPLETE_DOC is set to YES, Doxygen will warn about incomplete +# function parameter documentation. If set to NO, Doxygen will accept that some # parameters have no documentation without warning. # The default value is: YES. @@ -852,7 +911,7 @@ WARN_IF_INCOMPLETE_DOC = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return -# value. If set to NO, doxygen will only warn about wrong parameter +# value. If set to NO, Doxygen will only warn about wrong parameter # documentation, but not about the absence of documentation. If EXTRACT_ALL is # set to YES then this flag will automatically be disabled. See also # WARN_IF_INCOMPLETE_DOC @@ -860,24 +919,31 @@ WARN_IF_INCOMPLETE_DOC = YES WARN_NO_PARAMDOC = NO -# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about -# undocumented enumeration values. If set to NO, doxygen will accept +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, Doxygen will warn about +# undocumented enumeration values. If set to NO, Doxygen will accept # undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: NO. WARN_IF_UNDOC_ENUM_VAL = NO -# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# If the WARN_AS_ERROR tag is set to YES then Doxygen will immediately stop when # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS -# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but -# at the end of the doxygen process doxygen will return with a non-zero status. -# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# then Doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the Doxygen process Doxygen will return with a non-zero status. +# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then Doxygen behaves +# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined Doxygen will not +# write the warning messages in between other messages but write them at the end +# of a run, in case a WARN_LOGFILE is defined the warning messages will be +# besides being in the defined file also be shown at the end of a run, unless +# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case +# the behavior will remain as with the setting FAIL_ON_WARNINGS. +# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. # The default value is: NO. WARN_AS_ERROR = NO -# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# The WARN_FORMAT tag determines the format of the warning messages that Doxygen # can produce. The string should contain the $file, $line, and $text tags, which # will be replaced by the file and line number from which the warning originated # and the warning text. Optionally the format may contain $version, which will @@ -890,7 +956,7 @@ WARN_FORMAT = "$file:$line: $text" # In the $text part of the WARN_FORMAT command it is possible that a reference # to a more specific place is given. To make it easier to jump to this place -# (outside of doxygen) the user can define a custom "cut" / "paste" string. +# (outside of Doxygen) the user can define a custom "cut" / "paste" string. # Example: # WARN_LINE_FORMAT = "'vi $file +$line'" # See also: WARN_FORMAT @@ -920,7 +986,7 @@ WARN_LOGFILE = INPUT = "@CMAKE_SOURCE_DIR@/include/D3D12MemAlloc.h" # This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: # https://www.gnu.org/software/libiconv/) for the list of possible encodings. @@ -930,12 +996,12 @@ INPUT = "@CMAKE_SOURCE_DIR@/include/D3D12MemAlloc.h" INPUT_ENCODING = UTF-8 # This tag can be used to specify the character encoding of the source files -# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify +# that Doxygen parses. The INPUT_FILE_ENCODING tag can be used to specify # character encoding on a per file pattern basis. Doxygen will compare the file # name with each pattern and apply the encoding instead of the default -# INPUT_ENCODING) if there is a match. The character encodings are a list of the -# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding -# "INPUT_ENCODING" for further information on supported encodings. +# INPUT_ENCODING if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). +# See also: INPUT_ENCODING for further information on supported encodings. INPUT_FILE_ENCODING = @@ -945,17 +1011,17 @@ INPUT_FILE_ENCODING = # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not -# read by doxygen. +# read by Doxygen. # # Note the list of default checked file patterns might differ from the list of # default file extension mappings. # -# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, -# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, -# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, -# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C -# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, -# *.vhdl, *.ucf, *.qsf and *.ice. +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, +# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, +# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, +# *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to +# be provided as Doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. FILE_PATTERNS = *.c \ *.cc \ @@ -1012,7 +1078,7 @@ RECURSIVE = NO # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. # -# Note that relative paths are relative to the directory from which doxygen is +# Note that relative paths are relative to the directory from which Doxygen is # run. EXCLUDE = @@ -1038,9 +1104,6 @@ EXCLUDE_PATTERNS = # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # ANamespace::AClass, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = @@ -1070,7 +1133,7 @@ EXAMPLE_RECURSIVE = NO IMAGE_PATH = -# The INPUT_FILTER tag can be used to specify a program that doxygen should +# The INPUT_FILTER tag can be used to specify a program that Doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command: # @@ -1085,14 +1148,14 @@ IMAGE_PATH = # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. # -# Note that doxygen will use the data processed and written to standard output +# Note that Doxygen will use the data processed and written to standard output # for further processing, therefore nothing else, like debug statements or used # commands (so in case of a Windows batch file always use @echo OFF), should be # written to standard output. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. +# properly processed by Doxygen. INPUT_FILTER = @@ -1105,7 +1168,7 @@ INPUT_FILTER = # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. +# properly processed by Doxygen. FILTER_PATTERNS = @@ -1127,10 +1190,19 @@ FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. +# and want to reuse the introduction page also for the Doxygen output. USE_MDFILE_AS_MAINPAGE = +# If the IMPLICIT_DIR_DOCS tag is set to YES, any README.md file found in sub- +# directories of the project's root, is used as the documentation for that sub- +# directory, except when the README.md starts with a \dir, \page or \mainpage +# command. If set to NO, the README.md file needs to start with an explicit \dir +# command in order to be used as directory documentation. +# The default value is: YES. + +IMPLICIT_DIR_DOCS = YES + # The Fortran standard specifies that for fixed formatted Fortran code all # characters from position 72 are to be considered as comment. A common # extension is to allow longer lines before the automatic comment starts. The @@ -1154,12 +1226,13 @@ FORTRAN_COMMENT_AFTER = 72 SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. +# multi-line macros, enums or list initialized variables directly into the +# documentation. # The default value is: NO. INLINE_SOURCES = NO -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct Doxygen to hide any # special comment blocks from generated source code fragments. Normal C, C++ and # Fortran comments will always remain visible. # The default value is: YES. @@ -1197,7 +1270,7 @@ REFERENCES_LINK_SOURCE = YES SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# point to the HTML generated by the htags(1) tool instead of Doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system # (see https://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. @@ -1211,14 +1284,14 @@ SOURCE_TOOLTIPS = YES # Doxygen will invoke htags (and that will in turn invoke gtags), so these # tools must be available from the command line (i.e. in the search path). # -# The result: instead of the source browser generated by doxygen, the links to +# The result: instead of the source browser generated by Doxygen, the links to # source code will now point to the output of htags. # The default value is: NO. # This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# If the VERBATIM_HEADERS tag is set the YES then Doxygen will generate a # verbatim copy of the header file for each class for which an include is # specified. Set to NO to disable this. # See also: Section \class. @@ -1226,19 +1299,19 @@ USE_HTAGS = NO VERBATIM_HEADERS = NO -# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# If the CLANG_ASSISTED_PARSING tag is set to YES then Doxygen will use the # clang parser (see: # http://clang.llvm.org/) for more accurate parsing at the cost of reduced # performance. This can be particularly helpful with template rich C++ code for -# which doxygen's built-in parser lacks the necessary type information. -# Note: The availability of this option depends on whether or not doxygen was +# which Doxygen's built-in parser lacks the necessary type information. +# Note: The availability of this option depends on whether or not Doxygen was # generated with the -Duse_libclang=ON option for CMake. # The default value is: NO. CLANG_ASSISTED_PARSING = NO # If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS -# tag is set to YES then doxygen will add the directory of each input to the +# tag is set to YES then Doxygen will add the directory of each input to the # include path. # The default value is: YES. # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. @@ -1247,7 +1320,7 @@ CLANG_ADD_INC_PATHS = YES # If clang assisted parsing is enabled you can provide the compiler with command # line options that you would normally use when invoking the compiler. Note that -# the include paths will already be set by doxygen for the files and directories +# the include paths will already be set by Doxygen for the files and directories # specified with INPUT and INCLUDE_PATH. # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. @@ -1261,7 +1334,7 @@ CLANG_OPTIONS = # specifying the -p option to a clang tool, such as clang-check. These options # will then be passed to the parser. Any options specified with CLANG_OPTIONS # will be added as well. -# Note: The availability of this option depends on whether or not doxygen was +# Note: The availability of this option depends on whether or not Doxygen was # generated with the -Duse_libclang=ON option for CMake. CLANG_DATABASE_PATH = @@ -1290,7 +1363,7 @@ IGNORE_PREFIX = # Configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# If the GENERATE_HTML tag is set to YES, Doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES @@ -1311,40 +1384,40 @@ HTML_OUTPUT = html HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a +# each generated HTML page. If the tag is left blank Doxygen will generate a # standard header. # # To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. +# that Doxygen needs, which is dependent on the configuration options used (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally +# for information on how to generate the default header that Doxygen normally # uses. # Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description +# default header when upgrading to a newer version of Doxygen. For a description # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard +# generated HTML page. If the tag is left blank Doxygen will generate a standard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. +# that Doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. +# the HTML output. If left blank Doxygen will generate a default style sheet. # See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. +# sheet that Doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future become # obsolete. @@ -1354,7 +1427,7 @@ HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. +# created by Doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefore more robust against future updates. # Doxygen will copy the style sheet files to the output directory. @@ -1382,11 +1455,11 @@ HTML_EXTRA_FILES = # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output # should be rendered with a dark or light theme. -# Possible values are: LIGHT always generate light mode output, DARK always -# generate dark mode output, AUTO_LIGHT automatically set the mode according to -# the user preference, use light mode if no preference is set (the default), -# AUTO_DARK automatically set the mode according to the user preference, use -# dark mode if no preference is set and TOGGLE allow to user to switch between +# Possible values are: LIGHT always generates light mode output, DARK always +# generates dark mode output, AUTO_LIGHT automatically sets the mode according +# to the user preference, uses light mode if no preference is set (the default), +# AUTO_DARK automatically sets the mode according to the user preference, uses +# dark mode if no preference is set and TOGGLE allows a user to switch between # light and dark mode via a button. # The default value is: AUTO_LIGHT. # This tag requires that the tag GENERATE_HTML is set to YES. @@ -1423,15 +1496,6 @@ HTML_COLORSTYLE_SAT = 100 HTML_COLORSTYLE_GAMMA = 80 -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to YES can help to show when doxygen was last run and thus if the -# documentation is up to date. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = NO - # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML # documentation will contain a main index with vertical navigation menus that # are dynamically created via JavaScript. If disabled, the navigation index will @@ -1451,6 +1515,33 @@ HTML_DYNAMIC_MENUS = YES HTML_DYNAMIC_SECTIONS = NO +# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be +# dynamically folded and expanded in the generated HTML source code. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_CODE_FOLDING = YES + +# If the HTML_COPY_CLIPBOARD tag is set to YES then Doxygen will show an icon in +# the top right corner of code and text fragments that allows the user to copy +# its content to the clipboard. Note this only works if supported by the browser +# and the web page is served via a secure context (see: +# https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file: +# protocol. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COPY_CLIPBOARD = YES + +# Doxygen stores a couple of settings persistently in the browser (via e.g. +# cookies). By default these settings apply to all HTML pages generated by +# Doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store +# the settings under a project specific key, such that the user preferences will +# be stored separately. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_PROJECT_COOKIE = + # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand # and collapse entries dynamically later on. Doxygen will expand the tree to @@ -1468,7 +1559,7 @@ HTML_INDEX_NUM_ENTRIES = 100 # generated that can be used as input for Apple's Xcode 3 integrated development # environment (see: # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To -# create a documentation set, doxygen will generate a Makefile in the HTML +# create a documentation set, Doxygen will generate a Makefile in the HTML # output directory. Running make will produce the docset in that directory and # running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at @@ -1516,18 +1607,18 @@ DOCSET_PUBLISHER_ID = org.doxygen.Publisher DOCSET_PUBLISHER_NAME = Publisher -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# If the GENERATE_HTMLHELP tag is set to YES then Doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # on Windows. In the beginning of 2021 Microsoft took the original page, with -# a.o. the download links, offline the HTML help workshop was already many years -# in maintenance mode). You can download the HTML help workshop from the web -# archives at Installation executable (see: +# a.o. the download links, offline (the HTML help workshop was already many +# years in maintenance mode). You can download the HTML help workshop from the +# web archives at Installation executable (see: # http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). # # The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# generated by Doxygen into a single compiled HTML file (.chm). Compiled HTML # files are now used as the Windows 98 help format, and will replace the old # Windows help format (.hlp) on all Windows platforms in the future. Compressed # HTML files also contain an index, a table of contents, and you can search for @@ -1547,7 +1638,7 @@ CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path # including file name) of the HTML help compiler (hhc.exe). If non-empty, -# doxygen will try to run the HTML help compiler on the generated index.hhp. +# Doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. @@ -1581,6 +1672,16 @@ BINARY_TOC = NO TOC_EXPAND = NO +# The SITEMAP_URL tag is used to specify the full URL of the place where the +# generated documentation will be placed on the server by the user during the +# deployment of the documentation. The generated sitemap is called sitemap.xml +# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL +# is specified no sitemap is generated. For information about the sitemap +# protocol see https://www.sitemaps.org +# This tag requires that the tag GENERATE_HTML is set to YES. + +SITEMAP_URL = + # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help @@ -1639,7 +1740,7 @@ QHP_CUST_FILTER_ATTRS = QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location (absolute path -# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# including file name) of Qt's qhelpgenerator. If non-empty Doxygen will try to # run qhelpgenerator on the generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. @@ -1671,7 +1772,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project # of each HTML page. A value of NO enables the index and the value YES disables # it. Since the tabs in the index contain the same information as the navigation # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. +# The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO @@ -1684,11 +1785,11 @@ DISABLE_INDEX = NO # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can # further fine tune the look of the index (see "Fine-tuning the output"). As an -# example, the default style sheet generated by doxygen has an example that +# example, the default style sheet generated by Doxygen has an example that # shows how to put an image at the root of the tree instead of the PROJECT_NAME. # Since the tree basically has the same information as the tab index, you could # consider setting DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. +# The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = NO @@ -1706,7 +1807,7 @@ GENERATE_TREEVIEW = NO FULL_SIDEBAR = NO # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# doxygen will group on one line in the generated HTML documentation. +# Doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. @@ -1715,6 +1816,12 @@ FULL_SIDEBAR = NO ENUM_VALUES_PER_LINE = 4 +# When the SHOW_ENUM_VALUES tag is set doxygen will show the specified +# enumeration values besides the enumeration mnemonics. +# The default value is: NO. + +SHOW_ENUM_VALUES = NO + # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. # Minimum value: 0, maximum value: 1500, default value: 250. @@ -1722,21 +1829,21 @@ ENUM_VALUES_PER_LINE = 4 TREEVIEW_WIDTH = 250 -# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# If the EXT_LINKS_IN_WINDOW option is set to YES, Doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO -# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email +# If the OBFUSCATE_EMAILS tag is set to YES, Doxygen will obfuscate email # addresses. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. OBFUSCATE_EMAILS = YES -# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# If the HTML_FORMULA_FORMAT option is set to svg, Doxygen will use the pdf2svg # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see # https://inkscape.org) to generate formulas as SVG images instead of PNGs for # the HTML output. These images will generally look nicer at scaled resolutions. @@ -1749,7 +1856,7 @@ HTML_FORMULA_FORMAT = png # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful -# doxygen run you need to manually remove any form_*.png images from the HTML +# Doxygen run you need to manually remove any form_*.png images from the HTML # output directory to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. @@ -1793,7 +1900,7 @@ MATHJAX_VERSION = MathJax_2 # Possible values are: HTML-CSS (which is slower, but has the best # compatibility. This is the name for Mathjax version 2, for MathJax version 3 # this will be translated into chtml), NativeMML (i.e. MathML. Only supported -# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# for MathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This # is the name for Mathjax version 3, for MathJax version 2 this will be # translated into HTML-CSS) and SVG. # The default value is: HTML-CSS. @@ -1827,7 +1934,7 @@ MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest MATHJAX_EXTENSIONS = -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# The MATHJAX_CODEFILE tag can be used to specify a file with JavaScript pieces # of code that will be used on startup of the MathJax code. See the MathJax site # (see: # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an @@ -1836,12 +1943,12 @@ MATHJAX_EXTENSIONS = MATHJAX_CODEFILE = -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and +# When the SEARCHENGINE tag is enabled Doxygen will generate a search box for +# the HTML output. The underlying search engine uses JavaScript and DHTML and # should work on any modern browser. Note that when using HTML help # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) # there is already a search function so this one should typically be disabled. -# For large projects the javascript based search engine can be slow, then +# For large projects the JavaScript based search engine can be slow, then # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to # search using the keyboard; to jump to the search box use + S # (what the is depends on the OS and browser, but it is typically @@ -1860,7 +1967,7 @@ SEARCHENGINE = YES # When the SERVER_BASED_SEARCH tag is enabled the search engine will be # implemented using a web server instead of a web client using JavaScript. There # are two flavors of web server based searching depending on the EXTERNAL_SEARCH -# setting. When disabled, doxygen will generate a PHP script for searching and +# setting. When disabled, Doxygen will generate a PHP script for searching and # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing # and searching needs to be provided by external tools. See the section # "External Indexing and Searching" for details. @@ -1869,7 +1976,7 @@ SEARCHENGINE = YES SERVER_BASED_SEARCH = NO -# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP +# When EXTERNAL_SEARCH tag is enabled Doxygen will no longer generate the PHP # script for searching. Instead the search results are written to an XML file # which needs to be processed by an external indexer. Doxygen will invoke an # external search engine pointed to by the SEARCHENGINE_URL option to obtain the @@ -1914,7 +2021,7 @@ SEARCHDATA_FILE = searchdata.xml EXTERNAL_SEARCH_ID = -# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through Doxygen # projects other than the one defined by this configuration file, but that are # all added to the same external search index. Each project needs to have a # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of @@ -1928,7 +2035,7 @@ EXTRA_SEARCH_MAPPINGS = # Configuration options related to the LaTeX output #--------------------------------------------------------------------------- -# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. +# If the GENERATE_LATEX tag is set to YES, Doxygen will generate LaTeX output. # The default value is: YES. GENERATE_LATEX = NO @@ -1973,7 +2080,7 @@ MAKEINDEX_CMD_NAME = makeindex LATEX_MAKEINDEX_CMD = makeindex -# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX +# If the COMPACT_LATEX tag is set to YES, Doxygen generates more compact LaTeX # documents. This may be useful for small projects and may help to save some # trees in general. # The default value is: NO. @@ -2004,15 +2111,15 @@ EXTRA_PACKAGES = # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for # the generated LaTeX document. The header should contain everything until the -# first chapter. If it is left blank doxygen will generate a standard header. It +# first chapter. If it is left blank Doxygen will generate a standard header. It # is highly recommended to start with a default header using # doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty # and then modify the file new_header.tex. See also section "Doxygen usage" for -# information on how to generate the default header that doxygen normally uses. +# information on how to generate the default header that Doxygen normally uses. # # Note: Only use a user-defined header if you know what you are doing! # Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. The following +# default header when upgrading to a newer version of Doxygen. The following # commands have a special meaning inside the header (and footer): For a # description of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_LATEX is set to YES. @@ -2021,10 +2128,10 @@ LATEX_HEADER = # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for # the generated LaTeX document. The footer should contain everything after the -# last chapter. If it is left blank doxygen will generate a standard footer. See +# last chapter. If it is left blank Doxygen will generate a standard footer. See # LATEX_HEADER for more information on how to generate a default footer and what # special commands can be used inside the footer. See also section "Doxygen -# usage" for information on how to generate the default footer that doxygen +# usage" for information on how to generate the default footer that Doxygen # normally uses. Note: Only use a user-defined footer if you know what you are # doing! # This tag requires that the tag GENERATE_LATEX is set to YES. @@ -2033,7 +2140,7 @@ LATEX_FOOTER = # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined # LaTeX style sheets that are included after the standard style sheets created -# by doxygen. Using this option one can overrule certain style aspects. Doxygen +# by Doxygen. Using this option one can overrule certain style aspects. Doxygen # will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the @@ -2059,7 +2166,7 @@ LATEX_EXTRA_FILES = PDF_HYPERLINKS = YES -# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as +# If the USE_PDFLATEX tag is set to YES, Doxygen will use the engine as # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX # files. Set this option to YES, to get a higher quality PDF documentation. # @@ -2069,15 +2176,22 @@ PDF_HYPERLINKS = YES USE_PDFLATEX = YES -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode -# command to the generated LaTeX files. This will instruct LaTeX to keep running -# if errors occur, instead of asking the user for help. +# The LATEX_BATCHMODE tag signals the behavior of LaTeX in case of an error. +# Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch +# mode nothing is printed on the terminal, errors are scrolled as if is +# hit at every error; missing files that TeX tries to input or request from +# keyboard input (\read on a not open input stream) cause the job to abort, +# NON_STOP In nonstop mode the diagnostic message will appear on the terminal, +# but there is no possibility of user interaction just like in batch mode, +# SCROLL In scroll mode, TeX will stop only for missing files to input or if +# keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at +# each error, asking for user intervention. # The default value is: NO. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_BATCHMODE = NO -# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the +# If the LATEX_HIDE_INDICES tag is set to YES then Doxygen will not include the # index chapters (such as File Index, Compound Index, etc.) in the output. # The default value is: NO. # This tag requires that the tag GENERATE_LATEX is set to YES. @@ -2087,19 +2201,11 @@ LATEX_HIDE_INDICES = NO # The LATEX_BIB_STYLE tag can be used to specify the style to use for the # bibliography, e.g. plainnat, or ieeetr. See # https://en.wikipedia.org/wiki/BibTeX and \cite for more info. -# The default value is: plain. +# The default value is: plainnat. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_BIB_STYLE = plain -# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated -# page will contain the date and time when the page was generated. Setting this -# to NO can help when comparing the output of multiple runs. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_TIMESTAMP = NO - # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) # path from which the emoji images will be read. If a relative path is entered, # it will be relative to the LATEX_OUTPUT directory. If left blank the @@ -2112,7 +2218,7 @@ LATEX_EMOJI_DIRECTORY = # Configuration options related to the RTF output #--------------------------------------------------------------------------- -# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The +# If the GENERATE_RTF tag is set to YES, Doxygen will generate RTF output. The # RTF output is optimized for Word 97 and may not look too pretty with other RTF # readers/editors. # The default value is: NO. @@ -2127,7 +2233,7 @@ GENERATE_RTF = NO RTF_OUTPUT = rtf -# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF +# If the COMPACT_RTF tag is set to YES, Doxygen generates more compact RTF # documents. This may be useful for small projects and may help to save some # trees in general. # The default value is: NO. @@ -2147,28 +2253,36 @@ COMPACT_RTF = NO RTF_HYPERLINKS = NO -# Load stylesheet definitions from file. Syntax is similar to doxygen's +# Load stylesheet definitions from file. Syntax is similar to Doxygen's # configuration file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. # # See also section "Doxygen usage" for information on how to generate the -# default style sheet that doxygen normally uses. +# default style sheet that Doxygen normally uses. # This tag requires that the tag GENERATE_RTF is set to YES. RTF_STYLESHEET_FILE = # Set optional variables used in the generation of an RTF document. Syntax is -# similar to doxygen's configuration file. A template extensions file can be +# similar to Doxygen's configuration file. A template extensions file can be # generated using doxygen -e rtf extensionFile. # This tag requires that the tag GENERATE_RTF is set to YES. RTF_EXTENSIONS_FILE = +# The RTF_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the RTF_OUTPUT output directory. +# Note that the files will be copied as-is; there are no commands or markers +# available. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_EXTRA_FILES = + #--------------------------------------------------------------------------- # Configuration options related to the man page output #--------------------------------------------------------------------------- -# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for +# If the GENERATE_MAN tag is set to YES, Doxygen will generate man pages for # classes and files. # The default value is: NO. @@ -2199,7 +2313,7 @@ MAN_EXTENSION = .3 MAN_SUBDIR = -# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, then it # will generate one additional man file for each entity documented in the real # man page(s). These additional files only source the real man page, but without # them the man command would be unable to find the correct page. @@ -2212,7 +2326,7 @@ MAN_LINKS = NO # Configuration options related to the XML output #--------------------------------------------------------------------------- -# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that +# If the GENERATE_XML tag is set to YES, Doxygen will generate an XML file that # captures the structure of the code including all documentation. # The default value is: NO. @@ -2226,7 +2340,7 @@ GENERATE_XML = NO XML_OUTPUT = xml -# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program +# If the XML_PROGRAMLISTING tag is set to YES, Doxygen will dump the program # listings (including syntax highlighting and cross-referencing information) to # the XML output. Note that enabling this will significantly increase the size # of the XML output. @@ -2235,7 +2349,7 @@ XML_OUTPUT = xml XML_PROGRAMLISTING = YES -# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include +# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, Doxygen will include # namespace members in file scope as well, matching the HTML output. # The default value is: NO. # This tag requires that the tag GENERATE_XML is set to YES. @@ -2246,7 +2360,7 @@ XML_NS_MEMB_FILE_SCOPE = NO # Configuration options related to the DOCBOOK output #--------------------------------------------------------------------------- -# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files +# If the GENERATE_DOCBOOK tag is set to YES, Doxygen will generate Docbook files # that can be used to generate PDF. # The default value is: NO. @@ -2264,19 +2378,45 @@ DOCBOOK_OUTPUT = docbook # Configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- -# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an -# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures +# If the GENERATE_AUTOGEN_DEF tag is set to YES, Doxygen will generate an +# AutoGen Definitions (see https://autogen.sourceforge.net/) file that captures # the structure of the code including all documentation. Note that this feature # is still experimental and incomplete at the moment. # The default value is: NO. GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# Configuration options related to Sqlite3 output +#--------------------------------------------------------------------------- + +# If the GENERATE_SQLITE3 tag is set to YES Doxygen will generate a Sqlite3 +# database with symbols found by Doxygen stored in tables. +# The default value is: NO. + +GENERATE_SQLITE3 = NO + +# The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be +# put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put +# in front of it. +# The default directory is: sqlite3. +# This tag requires that the tag GENERATE_SQLITE3 is set to YES. + +SQLITE3_OUTPUT = sqlite3 + +# The SQLITE3_RECREATE_DB tag is set to YES, the existing doxygen_sqlite3.db +# database file will be recreated with each Doxygen run. If set to NO, Doxygen +# will warn if a database file is already found and not modify it. +# The default value is: YES. +# This tag requires that the tag GENERATE_SQLITE3 is set to YES. + +SQLITE3_RECREATE_DB = YES + #--------------------------------------------------------------------------- # Configuration options related to the Perl module output #--------------------------------------------------------------------------- -# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module +# If the GENERATE_PERLMOD tag is set to YES, Doxygen will generate a Perl module # file that captures the structure of the code including all documentation. # # Note that this feature is still experimental and incomplete at the moment. @@ -2284,7 +2424,7 @@ GENERATE_AUTOGEN_DEF = NO GENERATE_PERLMOD = NO -# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary +# If the PERLMOD_LATEX tag is set to YES, Doxygen will generate the necessary # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI # output from the Perl module output. # The default value is: NO. @@ -2314,13 +2454,13 @@ PERLMOD_MAKEVAR_PREFIX = # Configuration options related to the preprocessor #--------------------------------------------------------------------------- -# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all +# If the ENABLE_PREPROCESSING tag is set to YES, Doxygen will evaluate all # C-preprocessor directives found in the sources and include files. # The default value is: YES. ENABLE_PREPROCESSING = YES -# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names +# If the MACRO_EXPANSION tag is set to YES, Doxygen will expand all macro names # in the source code. If set to NO, only conditional compilation will be # performed. Macro expansion can be done in a controlled way by setting # EXPAND_ONLY_PREDEF to YES. @@ -2385,7 +2525,7 @@ PREDEFINED = __ID3D12Device1_INTERFACE_DEFINED__ \ EXPAND_AS_DEFINED = -# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will +# If the SKIP_FUNCTION_MACROS tag is set to YES then Doxygen's preprocessor will # remove all references to function-like macros that are alone on a line, have # an all uppercase name, and do not end with a semicolon. Such function macros # are typically used for boiler-plate code, and will confuse the parser if not @@ -2409,26 +2549,26 @@ SKIP_FUNCTION_MACROS = YES # section "Linking to external documentation" for more information about the use # of tag files. # Note: Each tag file must have a unique name (where the name does NOT include -# the path). If a tag file is not located in the directory in which doxygen is +# the path). If a tag file is not located in the directory in which Doxygen is # run, you must also specify the path to the tagfile here. TAGFILES = -# When a file name is specified after GENERATE_TAGFILE, doxygen will create a +# When a file name is specified after GENERATE_TAGFILE, Doxygen will create a # tag file that is based on the input files it reads. See section "Linking to # external documentation" for more information about the usage of tag files. GENERATE_TAGFILE = -# If the ALLEXTERNALS tag is set to YES, all external class will be listed in -# the class index. If set to NO, only the inherited external classes will be -# listed. +# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces +# will be listed in the class and namespace index. If set to NO, only the +# inherited external classes will be listed. # The default value is: NO. ALLEXTERNALS = NO # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will be +# in the topic index. If set to NO, only the current project's groups will be # listed. # The default value is: YES. @@ -2442,33 +2582,26 @@ EXTERNAL_GROUPS = YES EXTERNAL_PAGES = YES #--------------------------------------------------------------------------- -# Configuration options related to the dot tool +# Configuration options related to diagram generator tools #--------------------------------------------------------------------------- -# You can include diagrams made with dia in doxygen documentation. Doxygen will -# then run dia to produce the diagram and insert it in the documentation. The -# DIA_PATH tag allows you to specify the directory where the dia binary resides. -# If left empty dia is assumed to be found in the default search path. - -DIA_PATH = - # If set to YES the inheritance and collaboration graphs will hide inheritance # and usage relations if the target is undocumented or is not a class. # The default value is: YES. HIDE_UNDOC_RELATIONS = YES -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# If you set the HAVE_DOT tag to YES then Doxygen will assume the dot tool is # available from the path. This tool is part of Graphviz (see: -# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent +# https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent # Bell Labs. The other options in this section have no effect if this option is # set to NO # The default value is: NO. HAVE_DOT = NO -# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed -# to run in parallel. When set to 0 doxygen will base this on the number of +# The DOT_NUM_THREADS specifies the number of dot invocations Doxygen is allowed +# to run in parallel. When set to 0 Doxygen will base this on the number of # processors available in the system. You can set it explicitly to a value # larger than 0 to get control over the balance between CPU load and processing # speed. @@ -2479,7 +2612,7 @@ DOT_NUM_THREADS = 0 # DOT_COMMON_ATTR is common attributes for nodes, edges and labels of # subgraphs. When you want a differently looking font in the dot files that -# doxygen generates you can specify fontname, fontcolor and fontsize attributes. +# Doxygen generates you can specify fontname, fontcolor and fontsize attributes. # For details please see Node, # Edge and Graph Attributes specification You need to make sure dot is able # to find the font, which can be done by putting it in a standard location or by @@ -2513,35 +2646,47 @@ DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" DOT_FONTPATH = -# If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a -# graph for each documented class showing the direct and indirect inheritance -# relations. In case HAVE_DOT is set as well dot will be used to draw the graph, -# otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set -# to TEXT the direct and indirect inheritance relations will be shown as texts / -# links. -# Possible values are: NO, YES, TEXT and GRAPH. +# If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then Doxygen will +# generate a graph for each documented class showing the direct and indirect +# inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and +# HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case +# the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the +# CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used. +# If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance +# relations will be shown as texts / links. Explicit enabling an inheritance +# graph or choosing a different representation for an inheritance graph of a +# specific class, can be accomplished by means of the command \inheritancegraph. +# Disabling an inheritance graph can be accomplished by means of the command +# \hideinheritancegraph. +# Possible values are: NO, YES, TEXT, GRAPH and BUILTIN. # The default value is: YES. CLASS_GRAPH = YES -# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a +# If the COLLABORATION_GRAPH tag is set to YES then Doxygen will generate a # graph for each documented class showing the direct and indirect implementation # dependencies (inheritance, containment, and class references variables) of the -# class with other documented classes. +# class with other documented classes. Explicit enabling a collaboration graph, +# when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the +# command \collaborationgraph. Disabling a collaboration graph can be +# accomplished by means of the command \hidecollaborationgraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. COLLABORATION_GRAPH = YES -# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for -# groups, showing the direct groups dependencies. See also the chapter Grouping -# in the manual. +# If the GROUP_GRAPHS tag is set to YES then Doxygen will generate a graph for +# groups, showing the direct groups dependencies. Explicit enabling a group +# dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means +# of the command \groupgraph. Disabling a directory graph can be accomplished by +# means of the command \hidegroupgraph. See also the chapter Grouping in the +# manual. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. GROUP_GRAPHS = YES -# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and +# If the UML_LOOK tag is set to YES, Doxygen will generate inheritance and # collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. # The default value is: NO. @@ -2562,10 +2707,10 @@ UML_LOOK = NO UML_LIMIT_NUM_FIELDS = 10 -# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and +# If the DOT_UML_DETAILS tag is set to NO, Doxygen will show attributes and # methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS -# tag is set to YES, doxygen will add type and arguments for attributes and -# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen +# tag is set to YES, Doxygen will add type and arguments for attributes and +# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, Doxygen # will not generate fields with class member information in the UML graphs. The # class diagrams will look similar to the default class diagrams but using UML # notation for the relationships. @@ -2577,8 +2722,8 @@ DOT_UML_DETAILS = NO # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters # to display on a single line. If the actual line length exceeds this threshold -# significantly it will wrapped across multiple lines. Some heuristics are apply -# to avoid ugly line breaks. +# significantly it will be wrapped across multiple lines. Some heuristics are +# applied to avoid ugly line breaks. # Minimum value: 0, maximum value: 1000, default value: 17. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2593,24 +2738,29 @@ DOT_WRAP_THRESHOLD = 17 TEMPLATE_RELATIONS = NO # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to -# YES then doxygen will generate a graph for each documented file showing the +# YES then Doxygen will generate a graph for each documented file showing the # direct and indirect include dependencies of the file with other documented -# files. +# files. Explicit enabling an include graph, when INCLUDE_GRAPH is is set to NO, +# can be accomplished by means of the command \includegraph. Disabling an +# include graph can be accomplished by means of the command \hideincludegraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. INCLUDE_GRAPH = YES # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are -# set to YES then doxygen will generate a graph for each documented file showing +# set to YES then Doxygen will generate a graph for each documented file showing # the direct and indirect include dependencies of the file with other documented -# files. +# files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set +# to NO, can be accomplished by means of the command \includedbygraph. Disabling +# an included by graph can be accomplished by means of the command +# \hideincludedbygraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. INCLUDED_BY_GRAPH = YES -# If the CALL_GRAPH tag is set to YES then doxygen will generate a call +# If the CALL_GRAPH tag is set to YES then Doxygen will generate a call # dependency graph for every global function or class method. # # Note that enabling this option will significantly increase the time of a run. @@ -2622,7 +2772,7 @@ INCLUDED_BY_GRAPH = YES CALL_GRAPH = NO -# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller +# If the CALLER_GRAPH tag is set to YES then Doxygen will generate a caller # dependency graph for every global function or class method. # # Note that enabling this option will significantly increase the time of a run. @@ -2634,17 +2784,20 @@ CALL_GRAPH = NO CALLER_GRAPH = NO -# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical +# If the GRAPHICAL_HIERARCHY tag is set to YES then Doxygen will graphical # hierarchy of all classes instead of a textual one. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. GRAPHICAL_HIERARCHY = YES -# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the +# If the DIRECTORY_GRAPH tag is set to YES then Doxygen will show the # dependencies a directory has on other directories in a graphical way. The # dependency relations are determined by the #include relations between the -# files in the directories. +# files in the directories. Explicit enabling a directory graph, when +# DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command +# \directorygraph. Disabling a directory graph can be accomplished by means of +# the command \hidedirectorygraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2660,7 +2813,7 @@ DIR_GRAPH_MAX_DEPTH = 1 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. For an explanation of the image formats see the section # output formats in the documentation of the dot tool (Graphviz (see: -# http://www.graphviz.org/)). +# https://www.graphviz.org/)). # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order # to make the SVG files visible in IE 9+ (other browsers do not have this # requirement). @@ -2697,11 +2850,12 @@ DOT_PATH = DOTFILE_DIRS = -# The MSCFILE_DIRS tag can be used to specify one or more directories that -# contain msc files that are included in the documentation (see the \mscfile -# command). +# You can include diagrams made with dia in Doxygen documentation. Doxygen will +# then run dia to produce the diagram and insert it in the documentation. The +# DIA_PATH tag allows you to specify the directory where the dia binary resides. +# If left empty dia is assumed to be found in the default search path. -MSCFILE_DIRS = +DIA_PATH = # The DIAFILE_DIRS tag can be used to specify one or more directories that # contain dia files that are included in the documentation (see the \diafile @@ -2709,7 +2863,7 @@ MSCFILE_DIRS = DIAFILE_DIRS = -# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the +# When using PlantUML, the PLANTUML_JAR_PATH tag should be used to specify the # path where java can find the plantuml.jar file or to the filename of jar file # to be used. If left blank, it is assumed PlantUML is not used or called during # a preprocessing step. Doxygen will generate a warning when it encounters a @@ -2717,20 +2871,26 @@ DIAFILE_DIRS = PLANTUML_JAR_PATH = -# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a -# configuration file for plantuml. +# When using PlantUML, the PLANTUML_CFG_FILE tag can be used to specify a +# configuration file for PlantUML. PLANTUML_CFG_FILE = -# When using plantuml, the specified paths are searched for files specified by -# the !include statement in a plantuml block. +# When using PlantUML, the specified paths are searched for files specified by +# the !include statement in a PlantUML block. PLANTUML_INCLUDE_PATH = +# The PLANTUMLFILE_DIRS tag can be used to specify one or more directories that +# contain PlantUml files that are included in the documentation (see the +# \plantumlfile command). + +PLANTUMLFILE_DIRS = + # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes # that will be shown in the graph. If the number of nodes in a graph becomes -# larger than this value, doxygen will truncate the graph, which is visualized -# by representing a node as a red box. Note that doxygen if the number of direct +# larger than this value, Doxygen will truncate the graph, which is visualized +# by representing a node as a red box. Note that if the number of direct # children of the root node in a graph is already larger than # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. @@ -2760,17 +2920,17 @@ MAX_DOT_GRAPH_DEPTH = 0 DOT_MULTI_TARGETS = NO -# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page +# If the GENERATE_LEGEND tag is set to YES Doxygen will generate a legend page # explaining the meaning of the various boxes and arrows in the dot generated # graphs. -# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal +# Note: This tag requires that UML_LOOK isn't set, i.e. the Doxygen internal # graphical representation for inheritance and collaboration diagrams is used. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. GENERATE_LEGEND = YES -# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate +# If the DOT_CLEANUP tag is set to YES, Doxygen will remove the intermediate # files that are used to generate the various graphs. # # Note: This setting is not only used for dot files but also for msc temporary @@ -2778,3 +2938,19 @@ GENERATE_LEGEND = YES # The default value is: YES. DOT_CLEANUP = YES + +# You can define message sequence charts within Doxygen comments using the \msc +# command. If the MSCGEN_TOOL tag is left empty (the default), then Doxygen will +# use a built-in version of mscgen tool to produce the charts. Alternatively, +# the MSCGEN_TOOL tag can also specify the name an external tool. For instance, +# specifying prog as the value, Doxygen will call the tool as prog -T +# -o . The external tool should support +# output file formats "png", "eps", "svg", and "ismap". + +MSCGEN_TOOL = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the \mscfile +# command). + +MSCFILE_DIRS = From ae78428abc8d0d787d72993a841d7ae45fe203ec Mon Sep 17 00:00:00 2001 From: Adam Sawicki Date: Sat, 1 Mar 2025 10:32:35 +0100 Subject: [PATCH 06/10] Improvements in documentation "Resource alignment" --- include/D3D12MemAlloc.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h index c56d393..e843de5 100644 --- a/include/D3D12MemAlloc.h +++ b/include/D3D12MemAlloc.h @@ -2435,8 +2435,10 @@ You can check if the tight alignment it is available in the current system by ca You can tell the library to not use it by specifying D3D12MA::ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT. Typically, you don't need to do any of those. +\par Implementation detail The library automatically aligns all buffers to at least 256 B, even when the system supports smaller alignment. This is the alignment required for constant buffers, expressed by `D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT` constant. +It is also enough to be aligned to cache line size of conteporary GPUs, which may have positive impact on the performance. \page defragmentation Defragmentation From af45c943920679bd95d216849e84c9001a5341f9 Mon Sep 17 00:00:00 2001 From: Adam Sawicki Date: Mon, 10 Mar 2025 17:00:14 +0100 Subject: [PATCH 07/10] Improved TestSmallBuffers to test whether a small buffer was created as committed Which is expected unless tight alignment is enabled. --- src/Tests.cpp | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/src/Tests.cpp b/src/Tests.cpp index ff267b9..7455b52 100644 --- a/src/Tests.cpp +++ b/src/Tests.cpp @@ -778,13 +778,9 @@ static void TestSmallBuffers(const TestContext& ctx) CHECK_HR(ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &resWithAlloc.allocation, IID_PPV_ARGS(&resWithAlloc.resource))); CHECK_BOOL(resWithAlloc.allocation && resWithAlloc.allocation->GetResource()); - // May or may not be committed, depending on the PREFER_SMALL_BUFFERS_COMMITTED - // and TIGHT_ALIGNMENT settings. + // Expected to be committed unless tight alignment is supported. const bool isCommitted = resWithAlloc.allocation->GetHeap() == NULL; - if (isCommitted) - wprintf(L" Small buffer %llu B inside a custom pool was created as committed.\n", resDesc.Width); - else - wprintf(L" Small buffer %llu B inside a custom pool was created as placed.\n", resDesc.Width); + CHECK_BOOL(isCommitted != (ctx.allocator->IsTightAlignmentSupported() != FALSE)); } // Test 3: NEVER_ALLOCATE. From 3863df4c562e67f365929d9d576beb6d7bc6b7bf Mon Sep 17 00:00:00 2001 From: Adam Sawicki Date: Mon, 10 Mar 2025 17:14:03 +0100 Subject: [PATCH 08/10] Minor improvements in documentation of macros --- include/D3D12MemAlloc.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h index 0db5532..dd40743 100644 --- a/include/D3D12MemAlloc.h +++ b/include/D3D12MemAlloc.h @@ -85,7 +85,7 @@ Documentation of all members: D3D12MemAlloc.h #ifndef D3D12MA_DXGI_1_4 #ifdef __IDXGIAdapter3_INTERFACE_DEFINED__ - /// 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). #define D3D12MA_DXGI_1_4 1 #else #define D3D12MA_DXGI_1_4 0 @@ -94,6 +94,7 @@ Documentation of all members: D3D12MemAlloc.h #ifndef D3D12MA_CREATE_NOT_ZEROED_AVAILABLE #ifdef __ID3D12Device8_INTERFACE_DEFINED__ + /// This macro is defined to 0 or 1 automatically. Define it to 0 to disable support for `D3D12_HEAP_FLAG_CREATE_NOT_ZEROED`. #define D3D12MA_CREATE_NOT_ZEROED_AVAILABLE 1 #else #define D3D12MA_CREATE_NOT_ZEROED_AVAILABLE 0 @@ -128,9 +129,9 @@ Documentation of all members: D3D12MemAlloc.h #ifndef D3D12MA_RECOMMENDED_HEAP_FLAGS #if D3D12MA_CREATE_NOT_ZEROED_AVAILABLE - /// Set of flags recommended for use in D3D12MA::POOL_DESC::HeapFlags for optimal performance. #define D3D12MA_RECOMMENDED_HEAP_FLAGS (D3D12_HEAP_FLAG_CREATE_NOT_ZEROED) #else + /// Set of flags recommended for use in D3D12MA::POOL_DESC::HeapFlags for optimal performance. #define D3D12MA_RECOMMENDED_HEAP_FLAGS (D3D12_HEAP_FLAG_NONE) #endif #endif From 3ac09897532ef582815174cf6924f90752d347a3 Mon Sep 17 00:00:00 2001 From: Adam Sawicki Date: Mon, 10 Mar 2025 17:49:25 +0100 Subject: [PATCH 09/10] Custom pools with specific MinAllocationAlignment don't impose minimum 256B Added macro D3D12MA_DEFAULT_ALIGNMENT. Improvements in TestTightAlignment. Reverted "Removed mention of tight alignment from docs on this branch". Rebuilt the docs. --- docs/html/_d3_d12_mem_alloc_8h.html | 103 +++++- docs/html/annotated.html | 34 +- .../html/class_d3_d12_m_a_1_1_allocation.html | 5 +- docs/html/class_d3_d12_m_a_1_1_allocator.html | 5 +- docs/html/classes.html | 13 +- docs/html/configuration.html | 25 +- docs/html/custom_pools.html | 10 +- docs/html/defragmentation.html | 24 +- docs/html/doxygen_crawl.html | 28 ++ docs/html/functions.html | 4 + docs/html/functions_func.html | 4 + docs/html/globals.html | 4 + docs/html/globals_defs.html | 4 + docs/html/hierarchy.html | 40 ++- docs/html/index.html | 1 + docs/html/linear_algorithm.html | 4 +- docs/html/namespace_d3_d12_m_a.html | 50 ++- docs/html/namespacemembers.html | 1 + docs/html/namespacemembers_eval.html | 1 + docs/html/optimal_allocation.html | 143 ++++---- docs/html/quick_start.html | 93 +++-- docs/html/resource_aliasing.html | 8 +- docs/html/search/all_11.js | 5 +- docs/html/search/all_2.js | 50 +-- docs/html/search/all_3.js | 52 +-- docs/html/search/all_7.js | 3 +- docs/html/search/all_e.js | 23 +- docs/html/search/classes_2.js | 10 +- docs/html/search/classes_3.js | 8 +- docs/html/search/classes_4.js | 3 +- docs/html/search/classes_5.js | 2 +- docs/html/search/classes_6.js | 6 +- docs/html/search/classes_7.js | 8 + docs/html/search/defines_0.js | 8 +- docs/html/search/enumvalues_2.js | 5 +- docs/html/search/functions_2.js | 26 +- docs/html/search/searchdata.js | 2 +- docs/html/statistics.html | 6 +- ...m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html | 15 +- ..._m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.png | Bin 0 -> 783 bytes ...2_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html | 5 +- ...a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html | 113 ++++++ ...a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html | 290 +++++++++++++++ ..._a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.png | Bin 0 -> 778 bytes ...2_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html | 117 ++++++ ...ct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html | 337 ++++++++++++++++++ ...uct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.png | Bin 0 -> 650 bytes ...a_l_l_o_c_a_t_i_o_n___d_e_s_c-members.html | 111 ++++++ ...u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html | 248 +++++++++++++ ..._u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.png | Bin 0 -> 927 bytes ...t_u_a_l___b_l_o_c_k___d_e_s_c-members.html | 110 ++++++ ...c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html | 240 +++++++++++++ ..._c_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.png | Bin 0 -> 828 bytes ...e_f_r_a_g_m_e_n_t_a_t_i_o_n___m_o_v_e.html | 2 +- ...t_i_o_n___p_a_s_s___m_o_v_e___i_n_f_o.html | 2 +- ...ruct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html | 16 +- ...truct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.png | Bin 0 -> 658 bytes ...u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.html | 13 +- ..._u_a_l___a_l_l_o_c_a_t_i_o_n___d_e_s_c.png | Bin 0 -> 933 bytes ...1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html | 9 + ..._1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.png | Bin 0 -> 836 bytes docs/html/virtual_allocator.html | 20 +- include/D3D12MemAlloc.h | 17 + src/D3D12MemAlloc.cpp | 26 +- src/Tests.cpp | 44 ++- 65 files changed, 2211 insertions(+), 345 deletions(-) create mode 100644 docs/html/search/classes_7.js create mode 100644 docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.png create mode 100644 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 create mode 100644 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 create mode 100644 docs/html/struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.png create mode 100644 docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c-members.html create mode 100644 docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html create mode 100644 docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.png create mode 100644 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 create mode 100644 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 create mode 100644 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.png create mode 100644 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 create mode 100644 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 create mode 100644 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.png create mode 100644 docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.png create mode 100644 docs/html/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.png create mode 100644 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.png diff --git a/docs/html/_d3_d12_mem_alloc_8h.html b/docs/html/_d3_d12_mem_alloc_8h.html index 6df7c0d..e2a104f 100644 --- a/docs/html/_d3_d12_mem_alloc_8h.html +++ b/docs/html/_d3_d12_mem_alloc_8h.html @@ -166,6 +166,18 @@ class  D3D12MA::VirtualBlock  Represents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory. More...
  +struct  D3D12MA::CALLOCATION_DESC + Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure. More...
+  +struct  D3D12MA::CPOOL_DESC + Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure. More...
+  +struct  D3D12MA::CVIRTUAL_BLOCK_DESC + Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure. More...
+  +struct  D3D12MA::CVIRTUAL_ALLOCATION_DESC + Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure. More...
+  @@ -174,11 +186,24 @@

Namespaces

- + + + + + + + + + + + + + +

Macros

#define D3D12MA_DXGI_1_4   0
#define D3D12MA_DXGI_1_4   1
 Define this macro to 0 to disable usage of DXGI 1.4 (which is used for IDXGIAdapter3 and query for memory budget).
 
#define D3D12MA_CREATE_NOT_ZEROED_AVAILABLE   1
 This macro is defined to 0 or 1 automatically. Define it to 0 to disable support for D3D12_HEAP_FLAG_CREATE_NOT_ZEROED.
 
#define D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT   1
 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_RECOMMENDED_ALLOCATOR_FLAGS   (ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED | ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED)
 Set of flags recommended for use in D3D12MA::ALLOCATOR_DESC::Flags for optimal performance.
 
#define D3D12MA_RECOMMENDED_HEAP_FLAGS   (D3D12_HEAP_FLAG_NONE)
 Set of flags recommended for use in D3D12MA::POOL_DESC::HeapFlags for optimal performance.
 
#define D3D12MA_RECOMMENDED_POOL_FLAGS   (POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED)
 Set of flags recommended for use in D3D12MA::POOL_DESC::Flags for optimal performance.
 
@@ -226,10 +251,14 @@ } - @@ -275,6 +304,22 @@

Typedefs

 Operation performed on single defragmentation move. More...
 
enum  D3D12MA::POOL_FLAGS { D3D12MA::POOL_FLAG_NONE = 0 +
enum  D3D12MA::POOL_FLAGS {
+  D3D12MA::POOL_FLAG_NONE = 0 , D3D12MA::POOL_FLAG_ALGORITHM_LINEAR = 0x1 , D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED = 0x2 -, D3D12MA::POOL_FLAG_ALGORITHM_MASK = POOL_FLAG_ALGORITHM_LINEAR +, D3D12MA::POOL_FLAG_ALWAYS_COMMITTED = 0x4 +,
+  D3D12MA::POOL_FLAG_ALGORITHM_MASK = POOL_FLAG_ALGORITHM_LINEAR +
}
 Bit flags to be used with POOL_DESC::Flags. More...
 
 

Macro Definition Documentation

+ +

◆ D3D12MA_CREATE_NOT_ZEROED_AVAILABLE

+ +
+
+ + + + +
#define D3D12MA_CREATE_NOT_ZEROED_AVAILABLE   1
+
+ +

This macro is defined to 0 or 1 automatically. Define it to 0 to disable support for D3D12_HEAP_FLAG_CREATE_NOT_ZEROED.

+ +
+

◆ D3D12MA_DXGI_1_4

@@ -282,11 +327,61 @@

- +
#define D3D12MA_DXGI_1_4   0#define D3D12MA_DXGI_1_4   1

+

Define this macro to 0 to disable usage of DXGI 1.4 (which is used for IDXGIAdapter3 and query for memory budget).

+ +
+
+ +

◆ D3D12MA_RECOMMENDED_ALLOCATOR_FLAGS

+ +
+
+ + + + +
#define D3D12MA_RECOMMENDED_ALLOCATOR_FLAGS   (ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED | ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED)
+
+ +

Set of flags recommended for use in D3D12MA::ALLOCATOR_DESC::Flags for optimal performance.

+ +
+
+ +

◆ D3D12MA_RECOMMENDED_HEAP_FLAGS

+ +
+
+ + + + +
#define D3D12MA_RECOMMENDED_HEAP_FLAGS   (D3D12_HEAP_FLAG_NONE)
+
+ +

Set of flags recommended for use in D3D12MA::POOL_DESC::HeapFlags for optimal performance.

+ +
+
+ +

◆ D3D12MA_RECOMMENDED_POOL_FLAGS

+ +
+
+ + + + +
#define D3D12MA_RECOMMENDED_POOL_FLAGS   (POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED)
+
+ +

Set of flags recommended for use in D3D12MA::POOL_DESC::Flags for optimal performance.

+
diff --git a/docs/html/annotated.html b/docs/html/annotated.html index 6810191..fc89b6d 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -96,21 +96,25 @@  CAllocatorRepresents main object of this library initialized for particular ID3D12Device  CALLOCATOR_DESCParameters of created Allocator object. To be used with CreateAllocator()  CBudgetStatistics of current memory usage and available budget for a specific memory segment group - CDEFRAGMENTATION_DESCParameters for defragmentation - CDEFRAGMENTATION_MOVESingle move of an allocation to be done for defragmentation - CDEFRAGMENTATION_PASS_MOVE_INFOParameters for incremental defragmentation steps - CDEFRAGMENTATION_STATSStatistics returned for defragmentation process by function DefragmentationContext::GetStats() - CDefragmentationContextRepresents defragmentation process in progress - CDetailedStatisticsMore detailed statistics than D3D12MA::Statistics - CPoolCustom memory pool - CPOOL_DESCParameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool - CStatisticsCalculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total - CTotalStatisticsGeneral statistics from current state of the allocator - total memory usage across all memory heaps and segments - CVIRTUAL_ALLOCATION_DESCParameters of created virtual allocation to be passed to VirtualBlock::Allocate() - CVIRTUAL_ALLOCATION_INFOParameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo() - CVIRTUAL_BLOCK_DESCParameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock() - CVirtualAllocationRepresents single memory allocation done inside VirtualBlock - CVirtualBlockRepresents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory + CCALLOCATION_DESCHelper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure + CCPOOL_DESCHelper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure + CCVIRTUAL_ALLOCATION_DESCHelper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure + CCVIRTUAL_BLOCK_DESCHelper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure + CDEFRAGMENTATION_DESCParameters for defragmentation + CDEFRAGMENTATION_MOVESingle move of an allocation to be done for defragmentation + CDEFRAGMENTATION_PASS_MOVE_INFOParameters for incremental defragmentation steps + CDEFRAGMENTATION_STATSStatistics returned for defragmentation process by function DefragmentationContext::GetStats() + CDefragmentationContextRepresents defragmentation process in progress + CDetailedStatisticsMore detailed statistics than D3D12MA::Statistics + CPoolCustom memory pool + CPOOL_DESCParameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool + CStatisticsCalculated statistics of memory usage e.g. in a specific memory heap type, memory segment group, custom pool, or total + CTotalStatisticsGeneral statistics from current state of the allocator - total memory usage across all memory heaps and segments + CVIRTUAL_ALLOCATION_DESCParameters of created virtual allocation to be passed to VirtualBlock::Allocate() + CVIRTUAL_ALLOCATION_INFOParameters of an existing virtual allocation, returned by VirtualBlock::GetAllocationInfo() + CVIRTUAL_BLOCK_DESCParameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock() + CVirtualAllocationRepresents single memory allocation done inside VirtualBlock + CVirtualBlockRepresents pure allocation algorithm and a data structure with allocations in some memory block, without actually allocating any GPU memory
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 33f9020..62d1bd6 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 @@ -121,7 +121,7 @@  Returns D3D12 resource associated with this object.
  void SetResource (ID3D12Resource *pResource) - Releases the resource currently pointed by the allocation (if any), sets it to new one, incrementing its reference counter (if not null).
+ 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.
@@ -393,7 +393,8 @@

-

Releases the resource currently pointed by the allocation (if any), sets it to new one, incrementing its reference counter (if not null).

+

Releases the resource currently pointed by the allocation (if not null), sets it to new one, incrementing its reference counter (if not null).

+
Warning
This is an advanced feature that should be used only in special cases, e.g. during Defragmentation. Typically, an allocation object should reference the resource that was created together with it. If you swap it to another resource of different size, Statistics and budgets can be calculated incorrectly.

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 dfd6550..444329c 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 @@ -121,7 +121,7 @@  Returns true if GPU Upload Heaps are supported on the current system.
  BOOL IsTightAlignmentSupported () const - Returns true if resource tight alignment is supported on the current system. When supported, it is automatically used by the library, unless ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT flag was specified on allocator creation.
+ Returns true if resource tight alignment is supported on the current system. When supported, it is automatically used by the library, unless ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT flag was specified on allocator creation. This flag is fetched from D3D12_FEATURE_DATA_TIGHT_ALIGNMENT::SupportTier.
  UINT64 GetMemoryCapacity (UINT memorySegmentGroup) const  Returns total amount of memory of specific segment group, in bytes.
@@ -837,8 +837,7 @@

-

Returns true if resource tight alignment is supported on the current system. When supported, it is automatically used by the library, unless ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT flag was specified on allocator creation.

-

This flag is fetched from D3D12_FEATURE_DATA_TIGHT_ALIGNMENT::SupportTier.

+

Returns true if resource tight alignment is supported on the current system. When supported, it is automatically used by the library, unless ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT flag was specified on allocator creation. This flag is fetched from D3D12_FEATURE_DATA_TIGHT_ALIGNMENT::SupportTier.

diff --git a/docs/html/classes.html b/docs/html/classes.html index 5794267..c86eb6b 100644 --- a/docs/html/classes.html +++ b/docs/html/classes.html @@ -87,7 +87,7 @@
Class Index
-
A | B | D | P | S | T | V
+
A | B | C | D | P | S | T | V
A
@@ -96,18 +96,21 @@
B
Budget (D3D12MA)
+
C
+
CALLOCATION_DESC (D3D12MA)
CPOOL_DESC (D3D12MA)
CVIRTUAL_ALLOCATION_DESC (D3D12MA)
CVIRTUAL_BLOCK_DESC (D3D12MA)
+
D
DEFRAGMENTATION_DESC (D3D12MA)
DEFRAGMENTATION_MOVE (D3D12MA)
DEFRAGMENTATION_PASS_MOVE_INFO (D3D12MA)
DEFRAGMENTATION_STATS (D3D12MA)
DefragmentationContext (D3D12MA)
DetailedStatistics (D3D12MA)
-
+
P
Pool (D3D12MA)
POOL_DESC (D3D12MA)
-
+
S
Statistics (D3D12MA)
-
+
T
TotalStatistics (D3D12MA)
-
+
V
VIRTUAL_ALLOCATION_DESC (D3D12MA)
VIRTUAL_ALLOCATION_INFO (D3D12MA)
VIRTUAL_BLOCK_DESC (D3D12MA)
VirtualAllocation (D3D12MA)
VirtualBlock (D3D12MA)
diff --git a/docs/html/configuration.html b/docs/html/configuration.html index 3c35991..fedbf3b 100644 --- a/docs/html/configuration.html +++ b/docs/html/configuration.html @@ -110,28 +110,29 @@

_aligned_free(pMemory);
}
-
(...)
+
...
-
D3D12MA::ALLOCATION_CALLBACKS allocationCallbacks = {};
-
allocationCallbacks.pAllocate = &CustomAllocate;
-
allocationCallbacks.pFree = &CustomFree;
+
D3D12MA::ALLOCATION_CALLBACKS allocationCallbacks = {};
+
allocationCallbacks.pAllocate = &CustomAllocate;
+
allocationCallbacks.pFree = &CustomFree;
D3D12MA::ALLOCATOR_DESC allocatorDesc = {};
allocatorDesc.pDevice = device;
allocatorDesc.pAdapter = adapter;
+
allocatorDesc.Flags = D3D12MA_RECOMMENDED_ALLOCATOR_FLAGS;
allocatorDesc.pAllocationCallbacks = &allocationCallbacks;
D3D12MA::Allocator* allocator;
HRESULT hr = D3D12MA::CreateAllocator(&allocatorDesc, &allocator);
-
D3D12MA::Allocator
Represents main object of this library initialized for particular ID3D12Device.
Definition D3D12MemAlloc.h:1118
+
// Check hr...
+
D3D12MA_RECOMMENDED_ALLOCATOR_FLAGS
#define D3D12MA_RECOMMENDED_ALLOCATOR_FLAGS
Set of flags recommended for use in D3D12MA::ALLOCATOR_DESC::Flags for optimal performance.
Definition D3D12MemAlloc.h:127
+
D3D12MA::Allocator
Represents main object of this library initialized for particular ID3D12Device.
Definition D3D12MemAlloc.h:1173
D3D12MA::CreateAllocator
D3D12MA_API HRESULT CreateAllocator(const ALLOCATOR_DESC *pDesc, Allocator **ppAllocator)
Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
-
D3D12MA::ALLOCATION_CALLBACKS
Custom callbacks to CPU memory allocation functions.
Definition D3D12MemAlloc.h:217
-
D3D12MA::ALLOCATION_CALLBACKS::pFree
FREE_FUNC_PTR pFree
Dellocation function.
Definition D3D12MemAlloc.h:221
-
D3D12MA::ALLOCATION_CALLBACKS::pAllocate
ALLOCATE_FUNC_PTR pAllocate
Allocation function.
Definition D3D12MemAlloc.h:219
-
D3D12MA::ALLOCATOR_DESC
Parameters of created Allocator object. To be used with CreateAllocator().
Definition D3D12MemAlloc.h:1079
-
D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks
const ALLOCATION_CALLBACKS * pAllocationCallbacks
Custom CPU memory allocation callbacks. Optional.
Definition D3D12MemAlloc.h:1099
-
D3D12MA::ALLOCATOR_DESC::pAdapter
IDXGIAdapter * pAdapter
Definition D3D12MemAlloc.h:1105
-
D3D12MA::ALLOCATOR_DESC::pDevice
ID3D12Device * pDevice
Definition D3D12MemAlloc.h:1087
+
D3D12MA::ALLOCATOR_DESC
Parameters of created Allocator object. To be used with CreateAllocator().
Definition D3D12MemAlloc.h:1131
+
D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks
const ALLOCATION_CALLBACKS * pAllocationCallbacks
Custom CPU memory allocation callbacks. Optional.
Definition D3D12MemAlloc.h:1154
+
D3D12MA::ALLOCATOR_DESC::pAdapter
IDXGIAdapter * pAdapter
Definition D3D12MemAlloc.h:1160
+
D3D12MA::ALLOCATOR_DESC::Flags
ALLOCATOR_FLAGS Flags
Flags for the entire allocator.
Definition D3D12MemAlloc.h:1136
+
D3D12MA::ALLOCATOR_DESC::pDevice
ID3D12Device * pDevice
Definition D3D12MemAlloc.h:1142

Debug margins

By default, allocations are laid out in memory blocks next to each other if possible (considering required alignment returned by ID3D12Device::GetResourceAllocationInfo).

diff --git a/docs/html/custom_pools.html b/docs/html/custom_pools.html index c5079f7..70c1d27 100644 --- a/docs/html/custom_pools.html +++ b/docs/html/custom_pools.html @@ -97,13 +97,13 @@

To create a custom pool, fill in structure D3D12MA::POOL_DESC and call function D3D12MA::Allocator::CreatePool to obtain object D3D12MA::Pool. Example:

POOL_DESC poolDesc = {};
poolDesc.HeapProperties.Type = D3D12_HEAP_TYPE_DEFAULT;
-
// These flags are optional but recommended.
-
poolDesc.Flags = D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED;
-
poolDesc.HeapFlags = D3D12_HEAP_FLAG_CREATE_NOT_ZEROED;
+
poolDesc.Flags = D3D12MA_RECOMMENDED_POOL_FLAGS;
+
poolDesc.HeapFlags = D3D12MA_RECOMMENDED_HEAP_FLAGS | D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS;
Pool* pool;
HRESULT hr = allocator->CreatePool(&poolDesc, &pool);
-
D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED
@ POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED
Optimization, allocate MSAA textures as committed resources always.
Definition D3D12MemAlloc.h:850
+
D3D12MA_RECOMMENDED_POOL_FLAGS
#define D3D12MA_RECOMMENDED_POOL_FLAGS
Set of flags recommended for use in D3D12MA::POOL_DESC::Flags for optimal performance.
Definition D3D12MemAlloc.h:141
+
D3D12MA_RECOMMENDED_HEAP_FLAGS
#define D3D12MA_RECOMMENDED_HEAP_FLAGS
Set of flags recommended for use in D3D12MA::POOL_DESC::HeapFlags for optimal performance.
Definition D3D12MemAlloc.h:135

To allocate resources out of a custom pool, only set member D3D12MA::ALLOCATION_DESC::CustomPool. Example:

ALLOCATION_DESC allocDesc = {};
allocDesc.CustomPool = pool;
@@ -126,7 +126,7 @@

  • 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).
    • -

    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:

    +

    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 = {};
    allocDesc.CustomPool = pool;
    allocDesc.Flags = ALLOCATION_FLAG_COMMITTED;
    diff --git a/docs/html/defragmentation.html b/docs/html/defragmentation.html index 95d5ca1..c0331fc 100644 --- a/docs/html/defragmentation.html +++ b/docs/html/defragmentation.html @@ -147,21 +147,21 @@
    }
    defragCtx->Release();
    -
    D3D12MA::Allocation::SetResource
    void SetResource(ID3D12Resource *pResource)
    Releases the resource currently pointed by the allocation (if any), sets it to new one,...
    +
    D3D12MA::Allocation::SetResource
    void SetResource(ID3D12Resource *pResource)
    Releases the resource currently pointed by the allocation (if not null), sets it to new one,...
    D3D12MA::Allocation::GetOffset
    UINT64 GetOffset() const
    Returns offset in bytes from the start of memory heap.
    -
    D3D12MA::Allocation::GetResource
    ID3D12Resource * GetResource() const
    Returns D3D12 resource associated with this object.
    Definition D3D12MemAlloc.h:520
    +
    D3D12MA::Allocation::GetResource
    ID3D12Resource * GetResource() const
    Returns D3D12 resource associated with this object.
    Definition D3D12MemAlloc.h:551
    D3D12MA::Allocation::GetHeap
    ID3D12Heap * GetHeap() const
    Returns memory heap that the resource is created in.
    -
    D3D12MA::DefragmentationContext
    Represents defragmentation process in progress.
    Definition D3D12MemAlloc.h:776
    +
    D3D12MA::DefragmentationContext
    Represents defragmentation process in progress.
    Definition D3D12MemAlloc.h:813
    D3D12MA::DefragmentationContext::BeginPass
    HRESULT BeginPass(DEFRAGMENTATION_PASS_MOVE_INFO *pPassInfo)
    Starts single defragmentation pass.
    D3D12MA::DefragmentationContext::EndPass
    HRESULT EndPass(DEFRAGMENTATION_PASS_MOVE_INFO *pPassInfo)
    Ends single defragmentation pass.
    -
    D3D12MA::DEFRAGMENTATION_FLAG_ALGORITHM_FAST
    @ DEFRAGMENTATION_FLAG_ALGORITHM_FAST
    Definition D3D12MemAlloc.h:656
    -
    D3D12MA::DEFRAGMENTATION_DESC
    Parameters for defragmentation.
    Definition D3D12MemAlloc.h:678
    -
    D3D12MA::DEFRAGMENTATION_DESC::Flags
    DEFRAGMENTATION_FLAGS Flags
    Flags.
    Definition D3D12MemAlloc.h:680
    -
    D3D12MA::DEFRAGMENTATION_MOVE::pSrcAllocation
    Allocation * pSrcAllocation
    Allocation that should be moved.
    Definition D3D12MemAlloc.h:714
    -
    D3D12MA::DEFRAGMENTATION_MOVE::pDstTmpAllocation
    Allocation * pDstTmpAllocation
    Temporary allocation pointing to destination memory that will replace pSrcAllocation.
    Definition D3D12MemAlloc.h:722
    -
    D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO
    Parameters for incremental defragmentation steps.
    Definition D3D12MemAlloc.h:730
    -
    D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO::pMoves
    DEFRAGMENTATION_MOVE * pMoves
    Array of moves to be performed by the user in the current defragmentation pass.
    Definition D3D12MemAlloc.h:754
    -
    D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO::MoveCount
    UINT32 MoveCount
    Number of elements in the pMoves array.
    Definition D3D12MemAlloc.h:732
    +
    D3D12MA::DEFRAGMENTATION_FLAG_ALGORITHM_FAST
    @ DEFRAGMENTATION_FLAG_ALGORITHM_FAST
    Definition D3D12MemAlloc.h:693
    +
    D3D12MA::DEFRAGMENTATION_DESC
    Parameters for defragmentation.
    Definition D3D12MemAlloc.h:715
    +
    D3D12MA::DEFRAGMENTATION_DESC::Flags
    DEFRAGMENTATION_FLAGS Flags
    Flags.
    Definition D3D12MemAlloc.h:717
    +
    D3D12MA::DEFRAGMENTATION_MOVE::pSrcAllocation
    Allocation * pSrcAllocation
    Allocation that should be moved.
    Definition D3D12MemAlloc.h:751
    +
    D3D12MA::DEFRAGMENTATION_MOVE::pDstTmpAllocation
    Allocation * pDstTmpAllocation
    Temporary allocation pointing to destination memory that will replace pSrcAllocation.
    Definition D3D12MemAlloc.h:759
    +
    D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO
    Parameters for incremental defragmentation steps.
    Definition D3D12MemAlloc.h:767
    +
    D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO::pMoves
    DEFRAGMENTATION_MOVE * pMoves
    Array of moves to be performed by the user in the current defragmentation pass.
    Definition D3D12MemAlloc.h:791
    +
    D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO::MoveCount
    UINT32 MoveCount
    Number of elements in the pMoves array.
    Definition D3D12MemAlloc.h:769

    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:

    1. D3D12MA::DefragmentationContext::BeginPass() function call:
        @@ -207,7 +207,7 @@

        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.

        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.
        +
        Note
        Defragmentation is not supported in custom pools created with D3D12MA::POOL_FLAG_ALGORITHM_LINEAR.

    diff --git a/docs/html/doxygen_crawl.html b/docs/html/doxygen_crawl.html index fc67b01..452274d 100644 --- a/docs/html/doxygen_crawl.html +++ b/docs/html/doxygen_crawl.html @@ -9,7 +9,11 @@ + + + + @@ -151,6 +155,7 @@ + @@ -200,6 +205,7 @@ + @@ -231,6 +237,28 @@ + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/html/functions.html b/docs/html/functions.html index 2238de9..309f60a 100644 --- a/docs/html/functions.html +++ b/docs/html/functions.html @@ -116,7 +116,9 @@

    - b -

      - c -

      • CalculateStatistics() : D3D12MA::Allocator, D3D12MA::Pool, D3D12MA::VirtualBlock
        • +
      • CALLOCATION_DESC() : D3D12MA::CALLOCATION_DESC
      • Clear() : D3D12MA::VirtualBlock
        • +
      • CPOOL_DESC() : D3D12MA::CPOOL_DESC
      • CreateAliasingResource() : D3D12MA::Allocator
      • CreateAliasingResource1() : D3D12MA::Allocator
      • CreateAliasingResource2() : D3D12MA::Allocator
        • @@ -127,6 +129,8 @@

        - c -

        diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html index 83ac449..c4aff9d 100644 --- a/docs/html/functions_func.html +++ b/docs/html/functions_func.html @@ -101,7 +101,9 @@

        - b -

        -

        To make allocation from the upper stack, add flag D3D12MA::ALLOCATION_FLAG_UPPER_ADDRESS to D3D12MA::ALLOCATION_DESC::Flags.

        +

        To make allocation from the upper stack, add flag D3D12MA::ALLOCATION_FLAG_UPPER_ADDRESS to D3D12MA::ALLOCATION_DESC::Flags.

        Double stack

        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.

        diff --git a/docs/html/namespace_d3_d12_m_a.html b/docs/html/namespace_d3_d12_m_a.html index 0d3ce28..d8a809d 100644 --- a/docs/html/namespace_d3_d12_m_a.html +++ b/docs/html/namespace_d3_d12_m_a.html @@ -113,6 +113,18 @@ struct  Budget  Statistics of current memory usage and available budget for a specific memory segment group. More...
          +struct  CALLOCATION_DESC + Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure. More...
        +  +struct  CPOOL_DESC + Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure. More...
        +  +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 + Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure. More...
        +  struct  DEFRAGMENTATION_DESC  Parameters for defragmentation. More...
          @@ -205,10 +217,14 @@ }  Operation performed on single defragmentation move. More...
          -enum  POOL_FLAGS { POOL_FLAG_NONE = 0 +enum  POOL_FLAGS {
        +  POOL_FLAG_NONE = 0 , POOL_FLAG_ALGORITHM_LINEAR = 0x1 , POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED = 0x2 -, POOL_FLAG_ALGORITHM_MASK = POOL_FLAG_ALGORITHM_LINEAR +, POOL_FLAG_ALWAYS_COMMITTED = 0x4 +,
        +  POOL_FLAG_ALGORITHM_MASK = POOL_FLAG_ALGORITHM_LINEAR +
        }  Bit flags to be used with POOL_DESC::Flags. More...
          @@ -316,7 +332,7 @@

        -

        Bit flags to be used with ALLOCATION_DESC::Flags.

        +

        Bit flags to be used with ALLOCATION_DESC::Flags.

        @@ -334,7 +350,7 @@

        ALLOCATION_FLAG_WITHIN_BUDGET 

        Enumerator
        ALLOCATION_FLAG_NONE 

        Zero.

        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.

        +

        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.

        @@ -367,24 +383,26 @@

        -

        Bit flags to be used with ALLOCATOR_DESC::Flags.

        +

        Bit flags to be used with ALLOCATOR_DESC::Flags.

        - - - @@ -457,16 +475,20 @@

        -

        Bit flags to be used with POOL_DESC::Flags.

        +

        Bit flags to be used with POOL_DESC::Flags.

        Enumerator
        ALLOCATOR_FLAG_NONE 

        Zero.

        ALLOCATOR_FLAG_SINGLETHREADED 

        Allocator and all objects created from it will not be synchronized internally, so you must guarantee they are used from only one thread at a time or synchronized by you.

        Using this flag may increase performance because internal mutexes are not used.

        ALLOCATOR_FLAG_ALWAYS_COMMITTED 

        Every allocation will have its own memory block. To be used for debugging purposes.

        +
        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.

        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.

        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.

        +
        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.

        +

        You should always use this flag unless you really need to create some MSAA textures as placed.

        ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED 

        Disable optimization that prefers creating small buffers as committed to avoid 64 KB alignment.

        +
        ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED 

        Disable optimization that prefers creating small buffers as committed to avoid 64 KB alignment.

        By default, the library prefers creating small buffers <= 32 KB as committed, because drivers tend to pack them better, while placed buffers require 64 KB alignment. This, however, may decrease performance, as creating committed resources involves allocation of implicit heaps, which may take longer than creating placed resources in existing heaps. Passing this flag will disable this committed preference globally for the allocator. It can also be disabled for a single allocation by using ALLOCATION_FLAG_STRATEGY_MIN_TIME.

        If the tight resource alignment feature is used by the library (which happens automatically whenever supported, unless you use flag ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT), then small buffers are not preferred as committed. Long story short, you don't need to specify any of these flags. The library chooses the most optimal method automatically.

        - - +
        Enumerator
        POOL_FLAG_NONE 

        Zero.

        POOL_FLAG_ALGORITHM_LINEAR 

        Enables alternative, linear allocation algorithm in this pool.

        +
        POOL_FLAG_ALGORITHM_LINEAR 

        Enables alternative, linear allocation algorithm in this pool.

        Specify this flag to enable linear allocation algorithm, which always creates new allocations after last one and doesn't reuse space from allocations freed in between. It trades memory consumption for simplified algorithm and data structure, which has better performance and uses less memory for metadata.

        By using this flag, you can achieve behavior of free-at-once, stack, ring buffer, and double stack. For details, see documentation chapter Linear allocation algorithm.

        POOL_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 pool to create its heaps on smaller alignment not suitable for MSAA textures.

        +
        POOL_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 pool to create its heaps on smaller alignment not suitable for MSAA textures.

        +

        You should always use this flag unless you really need to create some MSAA textures in this pool as placed.

        +
        POOL_FLAG_ALWAYS_COMMITTED 

        Every allocation made in this pool will be created as a committed resource - will have its own memory block.

        +

        There is also an equivalent flag for the entire allocator: D3D12MA::ALLOCATOR_FLAG_ALWAYS_COMMITTED.

        POOL_FLAG_ALGORITHM_MASK 
        @@ -485,7 +507,7 @@

        -

        Bit flags to be used with VIRTUAL_ALLOCATION_DESC::Flags.

        +

        Bit flags to be used with VIRTUAL_ALLOCATION_DESC::Flags.

        diff --git a/docs/html/namespacemembers.html b/docs/html/namespacemembers.html index b1783f8..2364be1 100644 --- a/docs/html/namespacemembers.html +++ b/docs/html/namespacemembers.html @@ -140,6 +140,7 @@

        - f -

          - p -

          • POOL_FLAG_ALGORITHM_LINEAR : D3D12MA
          • POOL_FLAG_ALGORITHM_MASK : D3D12MA
            • +
          • POOL_FLAG_ALWAYS_COMMITTED : D3D12MA
          • POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED : D3D12MA
          • POOL_FLAG_NONE : D3D12MA
          • POOL_FLAGS : D3D12MA
            • diff --git a/docs/html/namespacemembers_eval.html b/docs/html/namespacemembers_eval.html index 088763a..de9620b 100644 --- a/docs/html/namespacemembers_eval.html +++ b/docs/html/namespacemembers_eval.html @@ -123,6 +123,7 @@

            - d -

              - p -

              • POOL_FLAG_ALGORITHM_LINEAR : D3D12MA
              • POOL_FLAG_ALGORITHM_MASK : D3D12MA
                • +
              • POOL_FLAG_ALWAYS_COMMITTED : D3D12MA
              • POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED : D3D12MA
              • POOL_FLAG_NONE : D3D12MA
              diff --git a/docs/html/optimal_allocation.html b/docs/html/optimal_allocation.html index db28324..39a2821 100644 --- a/docs/html/optimal_allocation.html +++ b/docs/html/optimal_allocation.html @@ -98,7 +98,7 @@

            • 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 evicted from video memory to system memory, degrading the app performance.
              • +
            • 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.

            Unfortunately, there is no way to be 100% protected against memory overcommitment. The best approach is to avoid allocating too much memory.

            @@ -110,9 +110,9 @@

            UINT64 freeBytes = videoMemBudget.BudgetBytes - videoMemBudget.UsageBytes;
            gameStreamingSystem->SetAvailableFreeMemory(freeBytes);
            -
            D3D12MA::Budget
            Statistics of current memory usage and available budget for a specific memory segment group.
            Definition D3D12MemAlloc.h:442
            -
            D3D12MA::Budget::BudgetBytes
            UINT64 BudgetBytes
            Estimated amount of memory available to the program.
            Definition D3D12MemAlloc.h:465
            -
            D3D12MA::Budget::UsageBytes
            UINT64 UsageBytes
            Estimated current memory usage of the program.
            Definition D3D12MemAlloc.h:454
            +
            D3D12MA::Budget
            Statistics of current memory usage and available budget for a specific memory segment group.
            Definition D3D12MemAlloc.h:473
            +
            D3D12MA::Budget::BudgetBytes
            UINT64 BudgetBytes
            Estimated amount of memory available to the program.
            Definition D3D12MemAlloc.h:496
            +
            D3D12MA::Budget::UsageBytes
            UINT64 UsageBytes
            Estimated current memory usage of the program.
            Definition D3D12MemAlloc.h:485
            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.

            @@ -139,50 +139,43 @@

            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 evicting 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 eviction. Best thing to do is avoiding memory over-commitment. For more information, see section "Avoiding running out of memory" above.

            +

            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.

            -

            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 evicted to system memory, degrading performance of all the resources placed in it.

            +

            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::POOL_DESC poolDesc = {};
            -
            poolDesc.HeapProperties.Type = D3D12_HEAP_TYPE_DEFAULT;
            -
            poolDesc.HeapFlags = D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS | D3D12_HEAP_FLAG_CREATE_NOT_ZEROED;
            +
            D3D12MA::CPOOL_DESC poolDesc = D3D12MA::CPOOL_DESC{
            +
            D3D12_HEAP_TYPE_DEFAULT,
            +
            D3D12MA_RECOMMENDED_HEAP_FLAGS | D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS };
            poolDesc.ResidencyPriority = D3D12_RESIDENCY_PRIORITY_HIGH; // !!!
            D3D12MA::Pool* pool;
            HRESULT hr = allocator->CreatePool(&poolDesc, &pool);
            // Check hr...
            -
            D3D12MA::ALLOCATION_DESC allocDesc = {};
            -
            allocDesc.CustomPool = pool;
            -
            allocDesc.Flags = ALLOCATION_FLAG_COMMITTED; // !!!
            +
            D3D12MA::CALLOCATION_DESC allocDesc = D3D12MA::CALLOCATION_DESC{
            +
            pool,
            +
            ALLOCATION_FLAG_COMMITTED }; // !!!
            -
            D3D12_RESOURCE_DESC resDesc = {};
            -
            resDesc.Dimension = D3D12_RESOURCE_DIMENSION_BUFFER;
            -
            resDesc.Alignment = 0;
            -
            resDesc.Width = 1048576; // Requested buffer size.
            -
            resDesc.Height = 1;
            -
            resDesc.DepthOrArraySize = 1;
            -
            resDesc.MipLevels = 1;
            -
            resDesc.Format = DXGI_FORMAT_UNKNOWN;
            -
            resDesc.SampleDesc.Count = 1;
            -
            resDesc.SampleDesc.Quality = 0;
            -
            resDesc.Layout = D3D12_TEXTURE_LAYOUT_ROW_MAJOR;
            -
            resDesc.Flags = D3D12_RESOURCE_FLAG_ALLOW_UNORDERED_ACCESS;
            +
            CD3DX12_RESOURCE_DESC resDesc = CD3DX12_RESOURCE_DESC::Buffer(
            +
            1048576); // Requested buffer size.
            D3D12MA::Allocation* alloc;
            hr = allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON,
            NULL, &alloc, IID_NULL, NULL);
            // Check hr...
            -
            D3D12MA::Allocation
            Represents single memory allocation.
            Definition D3D12MemAlloc.h:491
            -
            D3D12MA::Pool
            Custom memory pool.
            Definition D3D12MemAlloc.h:943
            -
            D3D12MA::ALLOCATION_DESC
            Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.
            Definition D3D12MemAlloc.h:307
            -
            D3D12MA::ALLOCATION_DESC::Flags
            ALLOCATION_FLAGS Flags
            Flags.
            Definition D3D12MemAlloc.h:309
            -
            D3D12MA::ALLOCATION_DESC::CustomPool
            Pool * CustomPool
            Custom pool to place the new resource in. Optional.
            Definition D3D12MemAlloc.h:337
            -
            D3D12MA::POOL_DESC
            Parameters of created D3D12MA::Pool object. To be used with D3D12MA::Allocator::CreatePool.
            Definition D3D12MemAlloc.h:858
            -
            D3D12MA::POOL_DESC::HeapProperties
            D3D12_HEAP_PROPERTIES HeapProperties
            The parameters of memory heap where allocations of this pool should be placed.
            Definition D3D12MemAlloc.h:866
            -
            D3D12MA::POOL_DESC::ResidencyPriority
            D3D12_RESIDENCY_PRIORITY ResidencyPriority
            Residency priority to be set for all allocations made in this pool. Optional.
            Definition D3D12MemAlloc.h:931
            -
            D3D12MA::POOL_DESC::HeapFlags
            D3D12_HEAP_FLAGS HeapFlags
            Heap flags to be used when allocating heaps of this pool.
            Definition D3D12MemAlloc.h:877
            -

            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 eviction described here happens automatically and only slows down the execution.

            +
            D3D12MA_RECOMMENDED_HEAP_FLAGS
            #define D3D12MA_RECOMMENDED_HEAP_FLAGS
            Set of flags recommended for use in D3D12MA::POOL_DESC::HeapFlags for optimal performance.
            Definition D3D12MemAlloc.h:135
            +
            D3D12MA::Allocation
            Represents single memory allocation.
            Definition D3D12MemAlloc.h:522
            +
            D3D12MA::Pool
            Custom memory pool.
            Definition D3D12MemAlloc.h:991
            +
            D3D12MA::CALLOCATION_DESC
            Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC...
            Definition D3D12MemAlloc.h:1673
            +
            D3D12MA::CPOOL_DESC
            Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC struc...
            Definition D3D12MemAlloc.h:1709
            +
            D3D12MA::POOL_DESC::ResidencyPriority
            D3D12_RESIDENCY_PRIORITY ResidencyPriority
            Residency priority to be set for all allocations made in this pool. Optional.
            Definition D3D12MemAlloc.h:979
            +

            When you have a committed allocation created, you can also set the residency priority of its resource using the D3D12 function:

            +
            D3D12MA::Allocation* committedAlloc = ...
            +
            ID3D12Pageable* res = committedAlloc->GetResource();
            +
            D3D12_RESIDENCY_PRIORITY priority = D3D12_RESIDENCY_PRIORITY_HIGH;
            +
            device1->SetResidencyPriority(1, &res, &priority);
            +
            D3D12MA::Allocation::GetResource
            ID3D12Resource * GetResource() const
            Returns D3D12 resource associated with this object.
            Definition D3D12MemAlloc.h:551
            +

            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:

            @@ -212,32 +205,20 @@

          • 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.

          -

          Example:

          -
          // Fast path for data upload.
          -
          if(allocator->IsGPUUploadHeapSupported())
          -
          {
          -
          D3D12MA::ALLOCATION_DESC allocDesc = {};
          -
          allocDesc.HeapType = D3D12_HEAP_TYPE_GPU_UPLOAD; // !!!
          +

          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 }; // !!!
          -
          D3D12_RESOURCE_DESC resDesc = {};
          -
          resDesc.Dimension = D3D12_RESOURCE_DIMENSION_BUFFER;
          -
          resDesc.Alignment = 0;
          -
          resDesc.Width = 1048576; // Requested buffer size.
          -
          resDesc.Height = 1;
          -
          resDesc.DepthOrArraySize = 1;
          -
          resDesc.MipLevels = 1;
          -
          resDesc.Format = DXGI_FORMAT_UNKNOWN;
          -
          resDesc.SampleDesc.Count = 1;
          -
          resDesc.SampleDesc.Quality = 0;
          -
          resDesc.Layout = D3D12_TEXTURE_LAYOUT_ROW_MAJOR;
          -
          resDesc.Flags = D3D12_RESOURCE_FLAG_NONE;
          +
          CD3DX12_RESOURCE_DESC resDesc = CD3DX12_RESOURCE_DESC::Buffer(
          +
          1048576); // Requested buffer size.
          -
          D3D12MA::Allocation* alloc;
          -
          ID3D12Resource* res;
          -
          hr = allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON,
          -
          NULL, &alloc, IID_PPV_ARGS(&res));
          -
          // Check hr...
          +
          D3D12MA::Allocation* alloc;
          +
          ID3D12Resource* res;
          +
          hr = allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON,
          +
          NULL, &alloc, IID_PPV_ARGS(&res));
          +
          if(SUCCEEDED(hr))
          +
          {
          +
          // Fast path for data upload.
          D3D12_RANGE emptyRange = {0, 0};
          void* mappedPtr = NULL;
          @@ -247,7 +228,18 @@

          D3D12_GPU_VIRTUAL_ADDRESS gpuva = res->GetGPUVirtualAddress();
          // Use gpuva to access the buffer on the GPU...
          -
          D3D12MA::ALLOCATION_DESC::HeapType
          D3D12_HEAP_TYPE HeapType
          The type of memory heap where the new allocation should be placed.
          Definition D3D12MemAlloc.h:316
          +
          }
          +
          else if(hr == E_NOTIMPL)
          +
          {
          +
          // GPU Upload Heap not supported in this system.
          +
          // Fall back to creating a staging buffer in UPLOAD and another copy in DEFAULT.
          +
          +
          allocDesc.HeapType = D3D12_HEAP_TYPE_UPLOAD;
          +
          // ...
          +
          }
          +
          else
          +
          // Some other error code e.g., out of memory...
          +
          D3D12MA::ALLOCATION_DESC::HeapType
          D3D12_HEAP_TYPE HeapType
          The type of memory heap where the new allocation should be placed.
          Definition D3D12MemAlloc.h:346

          Committed versus placed resources

          When using D3D12 API directly, there are 3 ways of creating resources:

          @@ -276,7 +268,7 @@

          Implementation detail
          D3D12MA creates large heaps (default size is 64 MB) and creates resources as placed in them. However, it may decide that it is required or preferred to create the specific resource as committed for many reasons, including:
          @@ -285,30 +277,19 @@

          You can request a new resource to be created as committed by using D3D12MA::ALLOCATION_FLAG_COMMITTED. Note that committed resources can also be created out of Custom memory pools.

          You can also request all resources to be created as committed globally for the entire allocator by using D3D12MA::ALLOCATOR_FLAG_ALWAYS_COMMITTED. However, this contradicts the main purpose of using this library. It can also prevent certain other features of the library to be used. This flag should be used only for debugging purposes.

          You can create a custom pool with an explicit block size by specifying non-zero D3D12MA::POOL_DESC::BlockSize. When doing this, all resources created in such pool are placed in those blocks (heaps) and never created as committed. Example:

          -
          D3D12MA::POOL_DESC poolDesc = {};
          -
          poolDesc.HeapFlags = D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS | D3D12_HEAP_FLAG_CREATE_NOT_ZEROED;
          -
          poolDesc.HeapProperties.Type = D3D12_HEAP_TYPE_DEFAULT;
          +
          D3D12MA::CPOOL_DESC poolDesc = D3D12MA::CPOOL_DESC{
          +
          D3D12_HEAP_TYPE_DEFAULT,
          +
          D3D12MA_RECOMMENDED_HEAP_FLAGS | D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS };
          poolDesc.BlockSize = 100llu * 1024 * 1024; // 100 MB. Explicit BlockSize guarantees placed.
          D3D12MA::Pool* pool;
          HRESULT hr = allocator->CreatePool(&poolDesc, &pool);
          // Check hr...
          -
          D3D12MA::ALLOCATION_DESC allocDesc = {};
          -
          allocDesc.CustomPool = pool;
          +
          D3D12MA::CALLOCATION_DESC allocDesc = D3D12MA::CALLOCATION_DESC{ pool };
          -
          D3D12_RESOURCE_DESC resDesc = {};
          -
          resDesc.Dimension = D3D12_RESOURCE_DIMENSION_BUFFER;
          -
          resDesc.Alignment = 0;
          -
          resDesc.Width = 90llu * 1024 * 1024; // 90 MB
          -
          resDesc.Height = 1;
          -
          resDesc.DepthOrArraySize = 1;
          -
          resDesc.MipLevels = 1;
          -
          resDesc.Format = DXGI_FORMAT_UNKNOWN;
          -
          resDesc.SampleDesc.Count = 1;
          -
          resDesc.SampleDesc.Quality = 0;
          -
          resDesc.Layout = D3D12_TEXTURE_LAYOUT_ROW_MAJOR;
          -
          resDesc.Flags = D3D12_RESOURCE_FLAG_NONE;
          +
          CD3DX12_RESOURCE_DESC resDesc = CD3DX12_RESOURCE_DESC::Buffer(
          +
          90llu * 1024 * 1024); // 90 MB
          D3D12MA::Allocation* alloc;
          ID3D12Resource* res;
          @@ -319,19 +300,19 @@

          // Even a large buffer like this, filling 90% of the block, was created as placed!
          assert(alloc->GetHeap() != NULL);
          D3D12MA::Allocation::GetHeap
          ID3D12Heap * GetHeap() const
          Returns memory heap that the resource is created in.
          -
          D3D12MA::POOL_DESC::BlockSize
          UINT64 BlockSize
          Size of a single heap (memory block) to be allocated as part of this pool, in bytes....
          Definition D3D12MemAlloc.h:884
          +
          D3D12MA::POOL_DESC::BlockSize
          UINT64 BlockSize
          Size of a single heap (memory block) to be allocated as part of this pool, in bytes....
          Definition D3D12MemAlloc.h:932

          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.
          -

          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.

          +

          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.

          +

          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.

          With DirectX 12 Agility SDK 1.716.0-preview, Microsoft added a new feature called "tight alignment". Note this is a separate feature than the "small alignment" described earlier. When using this new SDK and a compatible graphics driver, the API exposes support for this new feature. Then, a new flag D3D12_RESOURCE_FLAG_USE_TIGHT_ALIGNMENT can be added when creating a resource. D3D12 can then return the alignment required for the resource smaller than the default ones described above. This library automatically makes use of the tight alignment feature when available and adds that new resource flag. When the tight alignment is enabled, the heuristics that creates small buffers as committed described above is deactivated, as it is no longer needed.

          You can check if the tight alignment it is available in the current system by calling D3D12MA::Allocator::IsTightAlignmentSupported(). You can tell the library to not use it by specifying D3D12MA::ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT. Typically, you don't need to do any of those.

          -

          The library automatically aligns all buffers to at least 256 B, even when the system supports smaller alignment. This is the alignment required for constant buffers, expressed by D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT constant.

          +

          The library automatically aligns all buffers to at least 256 B, even when the system supports smaller alignment. This is the alignment required for constant buffers, expressed by D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT constant. You can override this logic for Custom memory pools with a specific D3D12MA::POOL_DESC::MinAllocationAlignment.

          diff --git a/docs/html/quick_start.html b/docs/html/quick_start.html index 0c6893d..c4ad33b 100644 --- a/docs/html/quick_start.html +++ b/docs/html/quick_start.html @@ -103,26 +103,20 @@

          (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 = (...)
          +
          IDXGIAdapter* adapter = ...
          +
          ID3D12Device* device = ...
          -
          D3D12MA::ALLOCATOR_DESC allocatorDesc = {};
          -
          allocatorDesc.pDevice = device;
          -
          allocatorDesc.pAdapter = adapter;
          -
          // These flags are optional but recommended.
          -
          allocatorDesc.Flags = D3D12MA::ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED |
          -
          D3D12MA::ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED;
          +
          D3D12MA::ALLOCATOR_DESC allocatorDesc = {};
          +
          allocatorDesc.pDevice = device;
          +
          allocatorDesc.pAdapter = adapter;
          +
          allocatorDesc.Flags = D3D12MA_RECOMMENDED_ALLOCATOR_FLAGS;
          D3D12MA::Allocator* allocator;
          HRESULT hr = D3D12MA::CreateAllocator(&allocatorDesc, &allocator);
          -
          D3D12MA::Allocator
          Represents main object of this library initialized for particular ID3D12Device.
          Definition D3D12MemAlloc.h:1118
          +
          // Check hr...
          +
          D3D12MA_RECOMMENDED_ALLOCATOR_FLAGS
          #define D3D12MA_RECOMMENDED_ALLOCATOR_FLAGS
          Set of flags recommended for use in D3D12MA::ALLOCATOR_DESC::Flags for optimal performance.
          Definition D3D12MemAlloc.h:127
          +
          D3D12MA::Allocator
          Represents main object of this library initialized for particular ID3D12Device.
          Definition D3D12MemAlloc.h:1173
          D3D12MA::CreateAllocator
          D3D12MA_API HRESULT CreateAllocator(const ALLOCATOR_DESC *pDesc, Allocator **ppAllocator)
          Creates new main D3D12MA::Allocator object and returns it through ppAllocator.
          -
          D3D12MA::ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED
          @ ALLOCATOR_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED
          Optimization, allocate MSAA textures as committed resources always.
          Definition D3D12MemAlloc.h:1053
          -
          D3D12MA::ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED
          @ ALLOCATOR_FLAG_DEFAULT_POOLS_NOT_ZEROED
          Definition D3D12MemAlloc.h:1045
          -
          D3D12MA::ALLOCATOR_DESC
          Parameters of created Allocator object. To be used with CreateAllocator().
          Definition D3D12MemAlloc.h:1079
          -
          D3D12MA::ALLOCATOR_DESC::pAdapter
          IDXGIAdapter * pAdapter
          Definition D3D12MemAlloc.h:1105
          -
          D3D12MA::ALLOCATOR_DESC::Flags
          ALLOCATOR_FLAGS Flags
          Flags.
          Definition D3D12MemAlloc.h:1081
          -
          D3D12MA::ALLOCATOR_DESC::pDevice
          ID3D12Device * pDevice
          Definition D3D12MemAlloc.h:1087

          (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.

          @@ -155,12 +149,15 @@

          NULL,
          &allocation,
          IID_NULL, NULL);
          +
          // Check hr...
          -
          // Use allocation->GetResource()...
          -
          D3D12MA::Allocation
          Represents single memory allocation.
          Definition D3D12MemAlloc.h:491
          +
          ID3D12Resource* res = allocation->GetResource();
          +
          // Use res...
          +
          D3D12MA::Allocation
          Represents single memory allocation.
          Definition D3D12MemAlloc.h:522
          +
          D3D12MA::Allocation::GetResource
          ID3D12Resource * GetResource() const
          Returns D3D12 resource associated with this object.
          Definition D3D12MemAlloc.h:551
          D3D12MA::Allocator::CreateResource
          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 functi...
          -
          D3D12MA::ALLOCATION_DESC
          Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.
          Definition D3D12MemAlloc.h:307
          -
          D3D12MA::ALLOCATION_DESC::HeapType
          D3D12_HEAP_TYPE HeapType
          The type of memory heap where the new allocation should be placed.
          Definition D3D12MemAlloc.h:316
          +
          D3D12MA::ALLOCATION_DESC
          Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.
          Definition D3D12MemAlloc.h:337
          +
          D3D12MA::ALLOCATION_DESC::HeapType
          D3D12_HEAP_TYPE HeapType
          The type of memory heap where the new allocation should be placed.
          Definition D3D12MemAlloc.h:346

          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.

          @@ -185,7 +182,7 @@

          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.

          +

          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

          @@ -201,7 +198,7 @@

          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:

          const UINT64 bufSize = 65536;
          -
          const float* bufData = (...);
          +
          const float* bufData = ...;
          D3D12_RESOURCE_DESC resourceDesc = {};
          resourceDesc.Dimension = D3D12_RESOURCE_DIMENSION_BUFFER;
          @@ -236,6 +233,60 @@

          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:

          + +

          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;
          +
          allocDesc.ExtraHeapFlags = D3D12_HEAP_FLAG_NONE;
          +
          allocDesc.CustomPool = NULL;
          +
          allocDesc.pPrivateData = NULL;
          +
          +
          D3D12_RESOURCE_DESC resDesc;
          +
          resDesc.Dimension = D3D12_RESOURCE_DIMENSION_BUFFER;
          +
          resDesc.Alignment = 0;
          +
          resDesc.Width = myBufSize;
          +
          resDesc.Height = 1;
          +
          resDesc.DepthOrArraySize = 1;
          +
          resDesc.MipLevels = 1;
          +
          resDesc.Format = DXGI_FORMAT_UNKNOWN;
          +
          resDesc.SampleDesc.Count = 1;
          +
          resDesc.SampleDesc.Quality = 0;
          +
          resDesc.Layout = D3D12_TEXTURE_LAYOUT_ROW_MAJOR;
          +
          resDesc.Flags = D3D12_RESOURCE_FLAG_NONE;
          +
          +
          D3D12MA::Allocation* alloc;
          +
          ID3D12Resource* res;
          +
          HRESULT hr = allocator->CreateResource(&allocDesc, &resDesc,
          +
          D3D12_RESOURCE_STATE_COMMON, NULL, &alloc, IID_PPV_ARGS(&res));
          +
          // Check hr...
          +
          D3D12MA::ALLOCATION_FLAG_STRATEGY_MIN_TIME
          @ ALLOCATION_FLAG_STRATEGY_MIN_TIME
          Definition D3D12MemAlloc.h:315
          +
          D3D12MA::ALLOCATION_DESC::Flags
          ALLOCATION_FLAGS Flags
          Flags for the allocation.
          Definition D3D12MemAlloc.h:339
          +
          D3D12MA::ALLOCATION_DESC::ExtraHeapFlags
          D3D12_HEAP_FLAGS ExtraHeapFlags
          Additional heap flags to be used when allocating memory.
          Definition D3D12MemAlloc.h:362
          +
          D3D12MA::ALLOCATION_DESC::CustomPool
          Pool * CustomPool
          Custom pool to place the new resource in. Optional.
          Definition D3D12MemAlloc.h:368
          +
          D3D12MA::ALLOCATION_DESC::pPrivateData
          void * pPrivateData
          Custom general-purpose pointer that will be stored in D3D12MA::Allocation.
          Definition D3D12MemAlloc.h:370
          +

          Or you can use helper structs from both D3X12 library and this library to make the code shorter:

          +
          D3D12MA::CALLOCATION_DESC allocDesc = D3D12MA::CALLOCATION_DESC{
          +
          D3D12_HEAP_TYPE_UPLOAD,
          +
          D3D12MA::ALLOCATION_FLAG_STRATEGY_MIN_TIME };
          +
          +
          CD3DX12_RESOURCE_DESC resDesc = CD3DX12_RESOURCE_DESC::Buffer(myBufSize);
          +
          +
          D3D12MA::Allocation* alloc;
          +
          ID3D12Resource* res;
          +
          HRESULT hr = allocator->CreateResource(&allocDesc, &resDesc,
          +
          D3D12_RESOURCE_STATE_COMMON, NULL, &alloc, IID_PPV_ARGS(&res));
          +
          // Check hr...
          +
          D3D12MA::CALLOCATION_DESC
          Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC...
          Definition D3D12MemAlloc.h:1673
          diff --git a/docs/html/resource_aliasing.html b/docs/html/resource_aliasing.html index 0e7d15d..f24db13 100644 --- a/docs/html/resource_aliasing.html +++ b/docs/html/resource_aliasing.html @@ -166,11 +166,11 @@
          res2->Release();
          res1->Release();
          alloc->Release();
          -
          D3D12MA::Allocation
          Represents single memory allocation.
          Definition D3D12MemAlloc.h:491
          +
          D3D12MA::Allocation
          Represents single memory allocation.
          Definition D3D12MemAlloc.h:522
          D3D12MA::Allocation::GetHeap
          ID3D12Heap * GetHeap() const
          Returns memory heap that the resource is created in.
          -
          D3D12MA::ALLOCATION_DESC
          Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.
          Definition D3D12MemAlloc.h:307
          -
          D3D12MA::ALLOCATION_DESC::ExtraHeapFlags
          D3D12_HEAP_FLAGS ExtraHeapFlags
          Additional heap flags to be used when allocating memory.
          Definition D3D12MemAlloc.h:332
          -
          D3D12MA::ALLOCATION_DESC::HeapType
          D3D12_HEAP_TYPE HeapType
          The type of memory heap where the new allocation should be placed.
          Definition D3D12MemAlloc.h:316
          +
          D3D12MA::ALLOCATION_DESC
          Parameters of created D3D12MA::Allocation object. To be used with Allocator::CreateResource.
          Definition D3D12MemAlloc.h:337
          +
          D3D12MA::ALLOCATION_DESC::ExtraHeapFlags
          D3D12_HEAP_FLAGS ExtraHeapFlags
          Additional heap flags to be used when allocating memory.
          Definition D3D12MemAlloc.h:362
          +
          D3D12MA::ALLOCATION_DESC::HeapType
          D3D12_HEAP_TYPE HeapType
          The type of memory heap where the new allocation should be placed.
          Definition D3D12MemAlloc.h:346

          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:

            diff --git a/docs/html/search/all_11.js b/docs/html/search/all_11.js index b8c1d11..ec40df7 100644 --- a/docs/html/search/all_11.js +++ b/docs/html/search/all_11.js @@ -14,6 +14,7 @@ var searchData= ['statistics_11',['Statistics',['../struct_d3_d12_m_a_1_1_statistics.html',1,'D3D12MA::Statistics'],['../statistics.html',1,'Statistics'],['../virtual_allocator.html#virtual_allocator_statistics',1,'Statistics']]], ['statistics_12',['Numeric statistics',['../statistics.html#statistics_numeric_statistics',1,'']]], ['stats_13',['Stats',['../struct_d3_d12_m_a_1_1_detailed_statistics.html#a2490d4a08a5d47c87a699001dfc8737f',1,'D3D12MA::DetailedStatistics::Stats'],['../struct_d3_d12_m_a_1_1_budget.html#a1255508930766db238cfb1312b15f1cf',1,'D3D12MA::Budget::Stats']]], - ['sub_20allocating_20buffers_14',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]], - ['supported_15',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]] + ['structures_14',['Helper structures',['../quick_start.html#quick_start_helper_structures',1,'']]], + ['sub_20allocating_20buffers_15',['Sub-allocating buffers',['../optimal_allocation.html#optimal_allocation_suballocating_buffers',1,'']]], + ['supported_16',['Features not supported',['../general_considerations.html#general_considerations_features_not_supported',1,'']]] ]; diff --git a/docs/html/search/all_2.js b/docs/html/search/all_2.js index 6a8b92b..1359221 100644 --- a/docs/html/search/all_2.js +++ b/docs/html/search/all_2.js @@ -1,26 +1,30 @@ var searchData= [ - ['calculatestatistics_0',['CalculateStatistics',['../class_d3_d12_m_a_1_1_pool.html#ad07999ac5dc8f0c63187afd45d551910',1,'D3D12MA::Pool::CalculateStatistics()'],['../class_d3_d12_m_a_1_1_allocator.html#a99db00df909963573a976c203b107d22',1,'D3D12MA::Allocator::CalculateStatistics()'],['../class_d3_d12_m_a_1_1_virtual_block.html#a614a82247ce6cf29c38895e16eb971d9',1,'D3D12MA::VirtualBlock::CalculateStatistics(DetailedStatistics *pStats) const']]], - ['clear_1',['Clear',['../class_d3_d12_m_a_1_1_virtual_block.html#ae22b18c0b7c31b44c1d740f886369189',1,'D3D12MA::VirtualBlock']]], - ['committed_20versus_20placed_20resources_2',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]], - ['compatibility_3',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]], - ['configuration_4',['Configuration',['../configuration.html',1,'index']]], - ['considerations_5',['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_6',['Table of contents',['../index.html#main_table_of_contents',1,'']]], - ['counting_7',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]], - ['cpu_20memory_20allocator_8',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]], - ['createaliasingresource_9',['CreateAliasingResource',['../class_d3_d12_m_a_1_1_allocator.html#ab45536f92410aedb7be44ea36b1b4717',1,'D3D12MA::Allocator']]], - ['createaliasingresource1_10',['CreateAliasingResource1',['../class_d3_d12_m_a_1_1_allocator.html#ad3b83cc5707cb4ed92bc277069c4ddd6',1,'D3D12MA::Allocator']]], - ['createaliasingresource2_11',['CreateAliasingResource2',['../class_d3_d12_m_a_1_1_allocator.html#a562cbaa71cbd333cade09cd67ed82453',1,'D3D12MA::Allocator']]], - ['createallocator_12',['CreateAllocator',['../class_d3_d12_m_a_1_1_allocator.html#a6e114ef3b4a791a3bf2e3109a3971559',1,'D3D12MA::Allocator::CreateAllocator()'],['../namespace_d3_d12_m_a.html#ab7a1cd1683986d75ce1488b0920f4cb0',1,'D3D12MA::CreateAllocator()']]], - ['createpool_13',['CreatePool',['../class_d3_d12_m_a_1_1_allocator.html#aac7b1f6bf53cbf4c4ce2264cb72ca515',1,'D3D12MA::Allocator']]], - ['createresource_14',['CreateResource',['../class_d3_d12_m_a_1_1_allocator.html#aa37d6b9fe8ea0864f7a35b9d68e8345a',1,'D3D12MA::Allocator']]], - ['createresource2_15',['CreateResource2',['../class_d3_d12_m_a_1_1_allocator.html#a7a1c79c79a7a573c438aa45c4a531b96',1,'D3D12MA::Allocator']]], - ['createresource3_16',['CreateResource3',['../class_d3_d12_m_a_1_1_allocator.html#a323b2af320b01d0fdecfc515c75db747',1,'D3D12MA::Allocator']]], - ['createvirtualblock_17',['CreateVirtualBlock',['../class_d3_d12_m_a_1_1_virtual_block.html#ae5650809a150e3283abd307c88ee45bb',1,'D3D12MA::VirtualBlock::CreateVirtualBlock()'],['../namespace_d3_d12_m_a.html#ab024647ae85ee63e2fa2c1c4beac6d98',1,'D3D12MA::CreateVirtualBlock()']]], - ['creating_20resources_18',['Creating resources',['../quick_start.html#quick_start_creating_resources',1,'']]], - ['creating_20virtual_20block_19',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]], - ['custom_20cpu_20memory_20allocator_20',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]], - ['custom_20memory_20pools_21',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]], - ['custompool_22',['CustomPool',['../struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html#ab06b85f3cf3254f855b29264477e3934',1,'D3D12MA::ALLOCATION_DESC']]] + ['calculatestatistics_0',['CalculateStatistics',['../class_d3_d12_m_a_1_1_pool.html#ad07999ac5dc8f0c63187afd45d551910',1,'D3D12MA::Pool::CalculateStatistics()'],['../class_d3_d12_m_a_1_1_allocator.html#a99db00df909963573a976c203b107d22',1,'D3D12MA::Allocator::CalculateStatistics()'],['../class_d3_d12_m_a_1_1_virtual_block.html#a614a82247ce6cf29c38895e16eb971d9',1,'D3D12MA::VirtualBlock::CalculateStatistics()']]], + ['callocation_5fdesc_1',['CALLOCATION_DESC',['../struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html',1,'D3D12MA::CALLOCATION_DESC'],['../struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html#a50901205f52d0c28bddaa5cc7c7a35b1',1,'D3D12MA::CALLOCATION_DESC::CALLOCATION_DESC()=default'],['../struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html#ae18d216821f86a1f35ea54bcd41c6e86',1,'D3D12MA::CALLOCATION_DESC::CALLOCATION_DESC(const ALLOCATION_DESC &o) noexcept'],['../struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html#a5c552f3160fb93b65ed16db4f6412a39',1,'D3D12MA::CALLOCATION_DESC::CALLOCATION_DESC(Pool *customPool, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept'],['../struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html#a8916820e2d709379eb3bcd2fb7e9848f',1,'D3D12MA::CALLOCATION_DESC::CALLOCATION_DESC(D3D12_HEAP_TYPE heapType, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL, D3D12_HEAP_FLAGS extraHeapFlags=D3D12_HEAP_FLAG_NONE) noexcept']]], + ['clear_2',['Clear',['../class_d3_d12_m_a_1_1_virtual_block.html#ae22b18c0b7c31b44c1d740f886369189',1,'D3D12MA::VirtualBlock']]], + ['committed_20versus_20placed_20resources_3',['Committed versus placed resources',['../optimal_allocation.html#optimal_allocation_committed_vs_placed',1,'']]], + ['compatibility_4',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]], + ['configuration_5',['Configuration',['../configuration.html',1,'index']]], + ['considerations_6',['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_7',['Table of contents',['../index.html#main_table_of_contents',1,'']]], + ['counting_8',['Resource reference counting',['../quick_start.html#quick_start_resource_reference_counting',1,'']]], + ['cpool_5fdesc_9',['CPOOL_DESC',['../struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html',1,'D3D12MA::CPOOL_DESC'],['../struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html#afc1fdbbf07c54943a70b95f122adb0d2',1,'D3D12MA::CPOOL_DESC::CPOOL_DESC()=default'],['../struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html#ab2310e41ea92aa64dfab4a3366a60cc3',1,'D3D12MA::CPOOL_DESC::CPOOL_DESC(const POOL_DESC &o) noexcept'],['../struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html#a5de61391fddfd37d91a0ec5cb7e84c1b',1,'D3D12MA::CPOOL_DESC::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'],['../struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html#a0d1e436a90bb4a07c55a5ecf60618be3',1,'D3D12MA::CPOOL_DESC::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']]], + ['cpu_20memory_20allocator_10',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]], + ['createaliasingresource_11',['CreateAliasingResource',['../class_d3_d12_m_a_1_1_allocator.html#ab45536f92410aedb7be44ea36b1b4717',1,'D3D12MA::Allocator']]], + ['createaliasingresource1_12',['CreateAliasingResource1',['../class_d3_d12_m_a_1_1_allocator.html#ad3b83cc5707cb4ed92bc277069c4ddd6',1,'D3D12MA::Allocator']]], + ['createaliasingresource2_13',['CreateAliasingResource2',['../class_d3_d12_m_a_1_1_allocator.html#a562cbaa71cbd333cade09cd67ed82453',1,'D3D12MA::Allocator']]], + ['createallocator_14',['CreateAllocator',['../class_d3_d12_m_a_1_1_allocator.html#a6e114ef3b4a791a3bf2e3109a3971559',1,'D3D12MA::Allocator::CreateAllocator()'],['../namespace_d3_d12_m_a.html#ab7a1cd1683986d75ce1488b0920f4cb0',1,'D3D12MA::CreateAllocator()']]], + ['createpool_15',['CreatePool',['../class_d3_d12_m_a_1_1_allocator.html#aac7b1f6bf53cbf4c4ce2264cb72ca515',1,'D3D12MA::Allocator']]], + ['createresource_16',['CreateResource',['../class_d3_d12_m_a_1_1_allocator.html#aa37d6b9fe8ea0864f7a35b9d68e8345a',1,'D3D12MA::Allocator']]], + ['createresource2_17',['CreateResource2',['../class_d3_d12_m_a_1_1_allocator.html#a7a1c79c79a7a573c438aa45c4a531b96',1,'D3D12MA::Allocator']]], + ['createresource3_18',['CreateResource3',['../class_d3_d12_m_a_1_1_allocator.html#a323b2af320b01d0fdecfc515c75db747',1,'D3D12MA::Allocator']]], + ['createvirtualblock_19',['CreateVirtualBlock',['../class_d3_d12_m_a_1_1_virtual_block.html#ae5650809a150e3283abd307c88ee45bb',1,'D3D12MA::VirtualBlock::CreateVirtualBlock()'],['../namespace_d3_d12_m_a.html#ab024647ae85ee63e2fa2c1c4beac6d98',1,'D3D12MA::CreateVirtualBlock()']]], + ['creating_20resources_20',['Creating resources',['../quick_start.html#quick_start_creating_resources',1,'']]], + ['creating_20virtual_20block_21',['Creating virtual block',['../virtual_allocator.html#virtual_allocator_creating_virtual_block',1,'']]], + ['custom_20cpu_20memory_20allocator_22',['Custom CPU memory allocator',['../configuration.html#custom_memory_allocator',1,'']]], + ['custom_20memory_20pools_23',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]], + ['custompool_24',['CustomPool',['../struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html#ab06b85f3cf3254f855b29264477e3934',1,'D3D12MA::ALLOCATION_DESC']]], + ['cvirtual_5fallocation_5fdesc_25',['CVIRTUAL_ALLOCATION_DESC',['../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',1,'D3D12MA::CVIRTUAL_ALLOCATION_DESC'],['../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#af7262b9e3178bb70416603aa32d4e8c6',1,'D3D12MA::CVIRTUAL_ALLOCATION_DESC::CVIRTUAL_ALLOCATION_DESC()=default'],['../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#abc6429b119b65f7cd3ed5c5bd4d36d85',1,'D3D12MA::CVIRTUAL_ALLOCATION_DESC::CVIRTUAL_ALLOCATION_DESC(const VIRTUAL_ALLOCATION_DESC &o) noexcept'],['../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#af72d9f4003fc6b86f76268aa8529d43a',1,'D3D12MA::CVIRTUAL_ALLOCATION_DESC::CVIRTUAL_ALLOCATION_DESC(UINT64 size, UINT64 alignment, VIRTUAL_ALLOCATION_FLAGS flags=VIRTUAL_ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept']]], + ['cvirtual_5fblock_5fdesc_26',['CVIRTUAL_BLOCK_DESC',['../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',1,'D3D12MA::CVIRTUAL_BLOCK_DESC'],['../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#a2871293dd04cadc9e8f10b5a5acb9b0c',1,'D3D12MA::CVIRTUAL_BLOCK_DESC::CVIRTUAL_BLOCK_DESC()=default'],['../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#a223f6535756a128b7fe86f0aa10de9af',1,'D3D12MA::CVIRTUAL_BLOCK_DESC::CVIRTUAL_BLOCK_DESC(const VIRTUAL_BLOCK_DESC &o) noexcept'],['../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#a2984a0b07b432ed8baf387d5230b7112',1,'D3D12MA::CVIRTUAL_BLOCK_DESC::CVIRTUAL_BLOCK_DESC(UINT64 size, VIRTUAL_BLOCK_FLAGS flags=VIRTUAL_BLOCK_FLAG_NONE, const ALLOCATION_CALLBACKS *allocationCallbacks=NULL) noexcept']]] ]; diff --git a/docs/html/search/all_3.js b/docs/html/search/all_3.js index 89ce51f..2600a14 100644 --- a/docs/html/search/all_3.js +++ b/docs/html/search/all_3.js @@ -2,28 +2,32 @@ var searchData= [ ['d3d12_20memory_20allocator_0',['D3D12 Memory Allocator',['../index.html',1,'']]], ['d3d12ma_1',['D3D12MA',['../namespace_d3_d12_m_a.html',1,'']]], - ['d3d12ma_5fdelete_2',['D3D12MA_DELETE',['../class_d3_d12_m_a_1_1_allocation.html#a968f13f23d03e50cc50b87835b6d5a85',1,'D3D12MA::Allocation::D3D12MA_DELETE()'],['../class_d3_d12_m_a_1_1_defragmentation_context.html#a968f13f23d03e50cc50b87835b6d5a85',1,'D3D12MA::DefragmentationContext::D3D12MA_DELETE()'],['../class_d3_d12_m_a_1_1_pool.html#a968f13f23d03e50cc50b87835b6d5a85',1,'D3D12MA::Pool::D3D12MA_DELETE()'],['../class_d3_d12_m_a_1_1_allocator.html#a968f13f23d03e50cc50b87835b6d5a85',1,'D3D12MA::Allocator::D3D12MA_DELETE()'],['../class_d3_d12_m_a_1_1_virtual_block.html#a968f13f23d03e50cc50b87835b6d5a85',1,'D3D12MA::VirtualBlock::D3D12MA_DELETE()']]], - ['d3d12ma_5fdxgi_5f1_5f4_3',['D3D12MA_DXGI_1_4',['../_d3_d12_mem_alloc_8h.html#aa623643886b8481adb32017e5c748b50',1,'D3D12MemAlloc.h']]], - ['d3d12ma_5fuse_5fsmall_5fresource_5fplacement_5falignment_4',['D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT',['../_d3_d12_mem_alloc_8h.html#ad04069a2e2bbc53b7d65f85a04a2dcbc',1,'D3D12MemAlloc.h']]], - ['d3d12memalloc_2eh_5',['D3D12MemAlloc.h',['../_d3_d12_mem_alloc_8h.html',1,'']]], - ['deallocation_6',['Deallocation',['../virtual_allocator.html#virtual_allocator_deallocation',1,'']]], - ['debug_20margins_7',['Debug margins',['../configuration.html#debug_margins',1,'']]], - ['defragmentation_8',['Defragmentation',['../defragmentation.html',1,'optimal_allocation']]], - ['defragmentation_5fdesc_9',['DEFRAGMENTATION_DESC',['../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',1,'D3D12MA']]], - ['defragmentation_5fflag_5falgorithm_5fbalanced_10',['DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED',['../namespace_d3_d12_m_a.html#ab433989212ee6736bf9d63c5bc565df4ace3a84861ed6a1b8066fa9c12c7e89b9',1,'D3D12MA']]], - ['defragmentation_5fflag_5falgorithm_5ffast_11',['DEFRAGMENTATION_FLAG_ALGORITHM_FAST',['../namespace_d3_d12_m_a.html#ab433989212ee6736bf9d63c5bc565df4a9d0301a81136ca79e3ba52542c6d2e13',1,'D3D12MA']]], - ['defragmentation_5fflag_5falgorithm_5ffull_12',['DEFRAGMENTATION_FLAG_ALGORITHM_FULL',['../namespace_d3_d12_m_a.html#ab433989212ee6736bf9d63c5bc565df4af205647f08a5c2cddced83ed66892467',1,'D3D12MA']]], - ['defragmentation_5fflag_5falgorithm_5fmask_13',['DEFRAGMENTATION_FLAG_ALGORITHM_MASK',['../namespace_d3_d12_m_a.html#ab433989212ee6736bf9d63c5bc565df4a567e0fe890cc07d8dd6576584e8d9f2d',1,'D3D12MA']]], - ['defragmentation_5fflags_14',['DEFRAGMENTATION_FLAGS',['../namespace_d3_d12_m_a.html#ab433989212ee6736bf9d63c5bc565df4',1,'D3D12MA']]], - ['defragmentation_5fmove_15',['DEFRAGMENTATION_MOVE',['../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',1,'D3D12MA']]], - ['defragmentation_5fmove_5foperation_16',['DEFRAGMENTATION_MOVE_OPERATION',['../namespace_d3_d12_m_a.html#a82bb787a69699a877b4166789a30e602',1,'D3D12MA']]], - ['defragmentation_5fmove_5foperation_5fcopy_17',['DEFRAGMENTATION_MOVE_OPERATION_COPY',['../namespace_d3_d12_m_a.html#a82bb787a69699a877b4166789a30e602a29a5c20322e633f6c34ddebd16bc61ac',1,'D3D12MA']]], - ['defragmentation_5fmove_5foperation_5fdestroy_18',['DEFRAGMENTATION_MOVE_OPERATION_DESTROY',['../namespace_d3_d12_m_a.html#a82bb787a69699a877b4166789a30e602aa2143507d723de458c2ed94e143ac242',1,'D3D12MA']]], - ['defragmentation_5fmove_5foperation_5fignore_19',['DEFRAGMENTATION_MOVE_OPERATION_IGNORE',['../namespace_d3_d12_m_a.html#a82bb787a69699a877b4166789a30e602abefe270a1803998dda3f8e01ec3a4ad6',1,'D3D12MA']]], - ['defragmentation_5fpass_5fmove_5finfo_20',['DEFRAGMENTATION_PASS_MOVE_INFO',['../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',1,'D3D12MA']]], - ['defragmentation_5fstats_21',['DEFRAGMENTATION_STATS',['../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',1,'D3D12MA']]], - ['defragmentationcontext_22',['DefragmentationContext',['../class_d3_d12_m_a_1_1_defragmentation_context.html',1,'D3D12MA']]], - ['detailedstatistics_23',['DetailedStatistics',['../struct_d3_d12_m_a_1_1_detailed_statistics.html',1,'D3D12MA']]], - ['double_20stack_24',['Double stack',['../linear_algorithm.html#linear_algorithm_double_stack',1,'']]], - ['dump_25',['JSON dump',['../statistics.html#statistics_json_dump',1,'']]] + ['d3d12ma_5fcreate_5fnot_5fzeroed_5favailable_2',['D3D12MA_CREATE_NOT_ZEROED_AVAILABLE',['../_d3_d12_mem_alloc_8h.html#a6df70df4d9e792713418dd4062b07c3a',1,'D3D12MemAlloc.h']]], + ['d3d12ma_5fdelete_3',['D3D12MA_DELETE',['../class_d3_d12_m_a_1_1_allocation.html#a968f13f23d03e50cc50b87835b6d5a85',1,'D3D12MA::Allocation::D3D12MA_DELETE()'],['../class_d3_d12_m_a_1_1_defragmentation_context.html#a968f13f23d03e50cc50b87835b6d5a85',1,'D3D12MA::DefragmentationContext::D3D12MA_DELETE()'],['../class_d3_d12_m_a_1_1_pool.html#a968f13f23d03e50cc50b87835b6d5a85',1,'D3D12MA::Pool::D3D12MA_DELETE()'],['../class_d3_d12_m_a_1_1_allocator.html#a968f13f23d03e50cc50b87835b6d5a85',1,'D3D12MA::Allocator::D3D12MA_DELETE()'],['../class_d3_d12_m_a_1_1_virtual_block.html#a968f13f23d03e50cc50b87835b6d5a85',1,'D3D12MA::VirtualBlock::D3D12MA_DELETE()']]], + ['d3d12ma_5fdxgi_5f1_5f4_4',['D3D12MA_DXGI_1_4',['../_d3_d12_mem_alloc_8h.html#aa623643886b8481adb32017e5c748b50',1,'D3D12MemAlloc.h']]], + ['d3d12ma_5frecommended_5fallocator_5fflags_5',['D3D12MA_RECOMMENDED_ALLOCATOR_FLAGS',['../_d3_d12_mem_alloc_8h.html#accfbeae642feeacf353ce695e91a5e73',1,'D3D12MemAlloc.h']]], + ['d3d12ma_5frecommended_5fheap_5fflags_6',['D3D12MA_RECOMMENDED_HEAP_FLAGS',['../_d3_d12_mem_alloc_8h.html#ac3d50f134ad24c58df4a934b87847653',1,'D3D12MemAlloc.h']]], + ['d3d12ma_5frecommended_5fpool_5fflags_7',['D3D12MA_RECOMMENDED_POOL_FLAGS',['../_d3_d12_mem_alloc_8h.html#a2679d8c9f6d900168bb45450bc88998b',1,'D3D12MemAlloc.h']]], + ['d3d12ma_5fuse_5fsmall_5fresource_5fplacement_5falignment_8',['D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT',['../_d3_d12_mem_alloc_8h.html#ad04069a2e2bbc53b7d65f85a04a2dcbc',1,'D3D12MemAlloc.h']]], + ['d3d12memalloc_2eh_9',['D3D12MemAlloc.h',['../_d3_d12_mem_alloc_8h.html',1,'']]], + ['deallocation_10',['Deallocation',['../virtual_allocator.html#virtual_allocator_deallocation',1,'']]], + ['debug_20margins_11',['Debug margins',['../configuration.html#debug_margins',1,'']]], + ['defragmentation_12',['Defragmentation',['../defragmentation.html',1,'optimal_allocation']]], + ['defragmentation_5fdesc_13',['DEFRAGMENTATION_DESC',['../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',1,'D3D12MA']]], + ['defragmentation_5fflag_5falgorithm_5fbalanced_14',['DEFRAGMENTATION_FLAG_ALGORITHM_BALANCED',['../namespace_d3_d12_m_a.html#ab433989212ee6736bf9d63c5bc565df4ace3a84861ed6a1b8066fa9c12c7e89b9',1,'D3D12MA']]], + ['defragmentation_5fflag_5falgorithm_5ffast_15',['DEFRAGMENTATION_FLAG_ALGORITHM_FAST',['../namespace_d3_d12_m_a.html#ab433989212ee6736bf9d63c5bc565df4a9d0301a81136ca79e3ba52542c6d2e13',1,'D3D12MA']]], + ['defragmentation_5fflag_5falgorithm_5ffull_16',['DEFRAGMENTATION_FLAG_ALGORITHM_FULL',['../namespace_d3_d12_m_a.html#ab433989212ee6736bf9d63c5bc565df4af205647f08a5c2cddced83ed66892467',1,'D3D12MA']]], + ['defragmentation_5fflag_5falgorithm_5fmask_17',['DEFRAGMENTATION_FLAG_ALGORITHM_MASK',['../namespace_d3_d12_m_a.html#ab433989212ee6736bf9d63c5bc565df4a567e0fe890cc07d8dd6576584e8d9f2d',1,'D3D12MA']]], + ['defragmentation_5fflags_18',['DEFRAGMENTATION_FLAGS',['../namespace_d3_d12_m_a.html#ab433989212ee6736bf9d63c5bc565df4',1,'D3D12MA']]], + ['defragmentation_5fmove_19',['DEFRAGMENTATION_MOVE',['../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',1,'D3D12MA']]], + ['defragmentation_5fmove_5foperation_20',['DEFRAGMENTATION_MOVE_OPERATION',['../namespace_d3_d12_m_a.html#a82bb787a69699a877b4166789a30e602',1,'D3D12MA']]], + ['defragmentation_5fmove_5foperation_5fcopy_21',['DEFRAGMENTATION_MOVE_OPERATION_COPY',['../namespace_d3_d12_m_a.html#a82bb787a69699a877b4166789a30e602a29a5c20322e633f6c34ddebd16bc61ac',1,'D3D12MA']]], + ['defragmentation_5fmove_5foperation_5fdestroy_22',['DEFRAGMENTATION_MOVE_OPERATION_DESTROY',['../namespace_d3_d12_m_a.html#a82bb787a69699a877b4166789a30e602aa2143507d723de458c2ed94e143ac242',1,'D3D12MA']]], + ['defragmentation_5fmove_5foperation_5fignore_23',['DEFRAGMENTATION_MOVE_OPERATION_IGNORE',['../namespace_d3_d12_m_a.html#a82bb787a69699a877b4166789a30e602abefe270a1803998dda3f8e01ec3a4ad6',1,'D3D12MA']]], + ['defragmentation_5fpass_5fmove_5finfo_24',['DEFRAGMENTATION_PASS_MOVE_INFO',['../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',1,'D3D12MA']]], + ['defragmentation_5fstats_25',['DEFRAGMENTATION_STATS',['../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',1,'D3D12MA']]], + ['defragmentationcontext_26',['DefragmentationContext',['../class_d3_d12_m_a_1_1_defragmentation_context.html',1,'D3D12MA']]], + ['detailedstatistics_27',['DetailedStatistics',['../struct_d3_d12_m_a_1_1_detailed_statistics.html',1,'D3D12MA']]], + ['double_20stack_28',['Double stack',['../linear_algorithm.html#linear_algorithm_double_stack',1,'']]], + ['dump_29',['JSON dump',['../statistics.html#statistics_json_dump',1,'']]] ]; diff --git a/docs/html/search/all_7.js b/docs/html/search/all_7.js index 67caa90..fe3f89f 100644 --- a/docs/html/search/all_7.js +++ b/docs/html/search/all_7.js @@ -4,5 +4,6 @@ var searchData= ['heapflags_1',['HeapFlags',['../struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html#a3795956e4fbfe7c3a23546e02e5d28dc',1,'D3D12MA::POOL_DESC']]], ['heapproperties_2',['HeapProperties',['../struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html#a06e06813bcb5206e9f7a8b0564bf1d6a',1,'D3D12MA::POOL_DESC']]], ['heapsfreed_3',['HeapsFreed',['../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#aecc6120afcf75028c9850f8d475b727d',1,'D3D12MA::DEFRAGMENTATION_STATS']]], - ['heaptype_4',['HeapType',['../struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html#aa46b3c0456e5a23edef3328607ebf4d7',1,'D3D12MA::ALLOCATION_DESC::HeapType'],['../struct_d3_d12_m_a_1_1_total_statistics.html#abad2e48b38f8a73a4daf8577e7a33b89',1,'D3D12MA::TotalStatistics::HeapType']]] + ['heaptype_4',['HeapType',['../struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html#aa46b3c0456e5a23edef3328607ebf4d7',1,'D3D12MA::ALLOCATION_DESC::HeapType'],['../struct_d3_d12_m_a_1_1_total_statistics.html#abad2e48b38f8a73a4daf8577e7a33b89',1,'D3D12MA::TotalStatistics::HeapType']]], + ['helper_20structures_5',['Helper structures',['../quick_start.html#quick_start_helper_structures',1,'']]] ]; diff --git a/docs/html/search/all_e.js b/docs/html/search/all_e.js index 115c5cc..dc7f629 100644 --- a/docs/html/search/all_e.js +++ b/docs/html/search/all_e.js @@ -14,15 +14,16 @@ var searchData= ['pool_5fdesc_11',['POOL_DESC',['../struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html',1,'D3D12MA']]], ['pool_5fflag_5falgorithm_5flinear_12',['POOL_FLAG_ALGORITHM_LINEAR',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1aa37a0103f511954ea42a1d0bba286b6a',1,'D3D12MA']]], ['pool_5fflag_5falgorithm_5fmask_13',['POOL_FLAG_ALGORITHM_MASK',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1aec9d4939b8cc5438545b9df840b5f5f7',1,'D3D12MA']]], - ['pool_5fflag_5fmsaa_5ftextures_5falways_5fcommitted_14',['POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1acc379a89755438c0f76667783b778baa',1,'D3D12MA']]], - ['pool_5fflag_5fnone_15',['POOL_FLAG_NONE',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1a5d8dc91add3423140809a550c7224d02',1,'D3D12MA']]], - ['pool_5fflags_16',['POOL_FLAGS',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1',1,'D3D12MA']]], - ['pools_17',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]], - ['pprivatedata_18',['pPrivateData',['../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#a98173cc9e239a84c2ce369854966e1e3',1,'D3D12MA::ALLOCATION_CALLBACKS::pPrivateData'],['../struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html#ac638dd987f1326e2fdab91892d994d35',1,'D3D12MA::ALLOCATION_DESC::pPrivateData'],['../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#aa1281297154e3823e98a7cc7e23b5d6b',1,'D3D12MA::VIRTUAL_ALLOCATION_DESC::pPrivateData'],['../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#a05c258ea40ea47667ddcc395b13a47a5',1,'D3D12MA::VIRTUAL_ALLOCATION_INFO::pPrivateData']]], - ['pprotectedsession_19',['pProtectedSession',['../struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html#a475840ec05c19732c8d5aa8bb27270f4',1,'D3D12MA::POOL_DESC']]], - ['preferredblocksize_20',['PreferredBlockSize',['../struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html#a97149c9559deae943c2cfa49aeeff8a6',1,'D3D12MA::ALLOCATOR_DESC']]], - ['prev_21',['prev',['../class_d3_d12_m_a_1_1_allocation.html#adc3ac89758a915a409e047f9b89aa160',1,'D3D12MA::Allocation']]], - ['priority_22',['Residency priority',['../optimal_allocation.html#optimal_allocation_residency_priority',1,'']]], - ['project_20setup_20and_20initialization_23',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]], - ['psrcallocation_24',['pSrcAllocation',['../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#a4946b874c958a71c21fac25b515cf5f7',1,'D3D12MA::DEFRAGMENTATION_MOVE']]] + ['pool_5fflag_5falways_5fcommitted_14',['POOL_FLAG_ALWAYS_COMMITTED',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1a15b7a6f8bfb6e4d534143f8adb6ac7ba',1,'D3D12MA']]], + ['pool_5fflag_5fmsaa_5ftextures_5falways_5fcommitted_15',['POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1acc379a89755438c0f76667783b778baa',1,'D3D12MA']]], + ['pool_5fflag_5fnone_16',['POOL_FLAG_NONE',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1a5d8dc91add3423140809a550c7224d02',1,'D3D12MA']]], + ['pool_5fflags_17',['POOL_FLAGS',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1',1,'D3D12MA']]], + ['pools_18',['Custom memory pools',['../custom_pools.html',1,'optimal_allocation']]], + ['pprivatedata_19',['pPrivateData',['../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#a98173cc9e239a84c2ce369854966e1e3',1,'D3D12MA::ALLOCATION_CALLBACKS::pPrivateData'],['../struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html#ac638dd987f1326e2fdab91892d994d35',1,'D3D12MA::ALLOCATION_DESC::pPrivateData'],['../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#aa1281297154e3823e98a7cc7e23b5d6b',1,'D3D12MA::VIRTUAL_ALLOCATION_DESC::pPrivateData'],['../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#a05c258ea40ea47667ddcc395b13a47a5',1,'D3D12MA::VIRTUAL_ALLOCATION_INFO::pPrivateData']]], + ['pprotectedsession_20',['pProtectedSession',['../struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html#a475840ec05c19732c8d5aa8bb27270f4',1,'D3D12MA::POOL_DESC']]], + ['preferredblocksize_21',['PreferredBlockSize',['../struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_o_r___d_e_s_c.html#a97149c9559deae943c2cfa49aeeff8a6',1,'D3D12MA::ALLOCATOR_DESC']]], + ['prev_22',['prev',['../class_d3_d12_m_a_1_1_allocation.html#adc3ac89758a915a409e047f9b89aa160',1,'D3D12MA::Allocation']]], + ['priority_23',['Residency priority',['../optimal_allocation.html#optimal_allocation_residency_priority',1,'']]], + ['project_20setup_20and_20initialization_24',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]], + ['psrcallocation_25',['pSrcAllocation',['../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#a4946b874c958a71c21fac25b515cf5f7',1,'D3D12MA::DEFRAGMENTATION_MOVE']]] ]; diff --git a/docs/html/search/classes_2.js b/docs/html/search/classes_2.js index efb78fa..f6d7a32 100644 --- a/docs/html/search/classes_2.js +++ b/docs/html/search/classes_2.js @@ -1,9 +1,7 @@ var searchData= [ - ['defragmentation_5fdesc_0',['DEFRAGMENTATION_DESC',['../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',1,'D3D12MA']]], - ['defragmentation_5fmove_1',['DEFRAGMENTATION_MOVE',['../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',1,'D3D12MA']]], - ['defragmentation_5fpass_5fmove_5finfo_2',['DEFRAGMENTATION_PASS_MOVE_INFO',['../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',1,'D3D12MA']]], - ['defragmentation_5fstats_3',['DEFRAGMENTATION_STATS',['../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',1,'D3D12MA']]], - ['defragmentationcontext_4',['DefragmentationContext',['../class_d3_d12_m_a_1_1_defragmentation_context.html',1,'D3D12MA']]], - ['detailedstatistics_5',['DetailedStatistics',['../struct_d3_d12_m_a_1_1_detailed_statistics.html',1,'D3D12MA']]] + ['callocation_5fdesc_0',['CALLOCATION_DESC',['../struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html',1,'D3D12MA']]], + ['cpool_5fdesc_1',['CPOOL_DESC',['../struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html',1,'D3D12MA']]], + ['cvirtual_5fallocation_5fdesc_2',['CVIRTUAL_ALLOCATION_DESC',['../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',1,'D3D12MA']]], + ['cvirtual_5fblock_5fdesc_3',['CVIRTUAL_BLOCK_DESC',['../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',1,'D3D12MA']]] ]; diff --git a/docs/html/search/classes_3.js b/docs/html/search/classes_3.js index 7ee755f..efb78fa 100644 --- a/docs/html/search/classes_3.js +++ b/docs/html/search/classes_3.js @@ -1,5 +1,9 @@ var searchData= [ - ['pool_0',['Pool',['../class_d3_d12_m_a_1_1_pool.html',1,'D3D12MA']]], - ['pool_5fdesc_1',['POOL_DESC',['../struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html',1,'D3D12MA']]] + ['defragmentation_5fdesc_0',['DEFRAGMENTATION_DESC',['../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',1,'D3D12MA']]], + ['defragmentation_5fmove_1',['DEFRAGMENTATION_MOVE',['../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',1,'D3D12MA']]], + ['defragmentation_5fpass_5fmove_5finfo_2',['DEFRAGMENTATION_PASS_MOVE_INFO',['../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',1,'D3D12MA']]], + ['defragmentation_5fstats_3',['DEFRAGMENTATION_STATS',['../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',1,'D3D12MA']]], + ['defragmentationcontext_4',['DefragmentationContext',['../class_d3_d12_m_a_1_1_defragmentation_context.html',1,'D3D12MA']]], + ['detailedstatistics_5',['DetailedStatistics',['../struct_d3_d12_m_a_1_1_detailed_statistics.html',1,'D3D12MA']]] ]; diff --git a/docs/html/search/classes_4.js b/docs/html/search/classes_4.js index 4c75f7f..7ee755f 100644 --- a/docs/html/search/classes_4.js +++ b/docs/html/search/classes_4.js @@ -1,4 +1,5 @@ var searchData= [ - ['statistics_0',['Statistics',['../struct_d3_d12_m_a_1_1_statistics.html',1,'D3D12MA']]] + ['pool_0',['Pool',['../class_d3_d12_m_a_1_1_pool.html',1,'D3D12MA']]], + ['pool_5fdesc_1',['POOL_DESC',['../struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.html',1,'D3D12MA']]] ]; diff --git a/docs/html/search/classes_5.js b/docs/html/search/classes_5.js index 7efd95a..4c75f7f 100644 --- a/docs/html/search/classes_5.js +++ b/docs/html/search/classes_5.js @@ -1,4 +1,4 @@ var searchData= [ - ['totalstatistics_0',['TotalStatistics',['../struct_d3_d12_m_a_1_1_total_statistics.html',1,'D3D12MA']]] + ['statistics_0',['Statistics',['../struct_d3_d12_m_a_1_1_statistics.html',1,'D3D12MA']]] ]; diff --git a/docs/html/search/classes_6.js b/docs/html/search/classes_6.js index 0c0c7b5..7efd95a 100644 --- a/docs/html/search/classes_6.js +++ b/docs/html/search/classes_6.js @@ -1,8 +1,4 @@ var searchData= [ - ['virtual_5fallocation_5fdesc_0',['VIRTUAL_ALLOCATION_DESC',['../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',1,'D3D12MA']]], - ['virtual_5fallocation_5finfo_1',['VIRTUAL_ALLOCATION_INFO',['../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',1,'D3D12MA']]], - ['virtual_5fblock_5fdesc_2',['VIRTUAL_BLOCK_DESC',['../struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html',1,'D3D12MA']]], - ['virtualallocation_3',['VirtualAllocation',['../struct_d3_d12_m_a_1_1_virtual_allocation.html',1,'D3D12MA']]], - ['virtualblock_4',['VirtualBlock',['../class_d3_d12_m_a_1_1_virtual_block.html',1,'D3D12MA']]] + ['totalstatistics_0',['TotalStatistics',['../struct_d3_d12_m_a_1_1_total_statistics.html',1,'D3D12MA']]] ]; diff --git a/docs/html/search/classes_7.js b/docs/html/search/classes_7.js new file mode 100644 index 0000000..0c0c7b5 --- /dev/null +++ b/docs/html/search/classes_7.js @@ -0,0 +1,8 @@ +var searchData= +[ + ['virtual_5fallocation_5fdesc_0',['VIRTUAL_ALLOCATION_DESC',['../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',1,'D3D12MA']]], + ['virtual_5fallocation_5finfo_1',['VIRTUAL_ALLOCATION_INFO',['../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',1,'D3D12MA']]], + ['virtual_5fblock_5fdesc_2',['VIRTUAL_BLOCK_DESC',['../struct_d3_d12_m_a_1_1_v_i_r_t_u_a_l___b_l_o_c_k___d_e_s_c.html',1,'D3D12MA']]], + ['virtualallocation_3',['VirtualAllocation',['../struct_d3_d12_m_a_1_1_virtual_allocation.html',1,'D3D12MA']]], + ['virtualblock_4',['VirtualBlock',['../class_d3_d12_m_a_1_1_virtual_block.html',1,'D3D12MA']]] +]; diff --git a/docs/html/search/defines_0.js b/docs/html/search/defines_0.js index c60b0a2..0ca7ae2 100644 --- a/docs/html/search/defines_0.js +++ b/docs/html/search/defines_0.js @@ -1,5 +1,9 @@ var searchData= [ - ['d3d12ma_5fdxgi_5f1_5f4_0',['D3D12MA_DXGI_1_4',['../_d3_d12_mem_alloc_8h.html#aa623643886b8481adb32017e5c748b50',1,'D3D12MemAlloc.h']]], - ['d3d12ma_5fuse_5fsmall_5fresource_5fplacement_5falignment_1',['D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT',['../_d3_d12_mem_alloc_8h.html#ad04069a2e2bbc53b7d65f85a04a2dcbc',1,'D3D12MemAlloc.h']]] + ['d3d12ma_5fcreate_5fnot_5fzeroed_5favailable_0',['D3D12MA_CREATE_NOT_ZEROED_AVAILABLE',['../_d3_d12_mem_alloc_8h.html#a6df70df4d9e792713418dd4062b07c3a',1,'D3D12MemAlloc.h']]], + ['d3d12ma_5fdxgi_5f1_5f4_1',['D3D12MA_DXGI_1_4',['../_d3_d12_mem_alloc_8h.html#aa623643886b8481adb32017e5c748b50',1,'D3D12MemAlloc.h']]], + ['d3d12ma_5frecommended_5fallocator_5fflags_2',['D3D12MA_RECOMMENDED_ALLOCATOR_FLAGS',['../_d3_d12_mem_alloc_8h.html#accfbeae642feeacf353ce695e91a5e73',1,'D3D12MemAlloc.h']]], + ['d3d12ma_5frecommended_5fheap_5fflags_3',['D3D12MA_RECOMMENDED_HEAP_FLAGS',['../_d3_d12_mem_alloc_8h.html#ac3d50f134ad24c58df4a934b87847653',1,'D3D12MemAlloc.h']]], + ['d3d12ma_5frecommended_5fpool_5fflags_4',['D3D12MA_RECOMMENDED_POOL_FLAGS',['../_d3_d12_mem_alloc_8h.html#a2679d8c9f6d900168bb45450bc88998b',1,'D3D12MemAlloc.h']]], + ['d3d12ma_5fuse_5fsmall_5fresource_5fplacement_5falignment_5',['D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT',['../_d3_d12_mem_alloc_8h.html#ad04069a2e2bbc53b7d65f85a04a2dcbc',1,'D3D12MemAlloc.h']]] ]; diff --git a/docs/html/search/enumvalues_2.js b/docs/html/search/enumvalues_2.js index 10b4213..075de46 100644 --- a/docs/html/search/enumvalues_2.js +++ b/docs/html/search/enumvalues_2.js @@ -2,6 +2,7 @@ var searchData= [ ['pool_5fflag_5falgorithm_5flinear_0',['POOL_FLAG_ALGORITHM_LINEAR',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1aa37a0103f511954ea42a1d0bba286b6a',1,'D3D12MA']]], ['pool_5fflag_5falgorithm_5fmask_1',['POOL_FLAG_ALGORITHM_MASK',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1aec9d4939b8cc5438545b9df840b5f5f7',1,'D3D12MA']]], - ['pool_5fflag_5fmsaa_5ftextures_5falways_5fcommitted_2',['POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1acc379a89755438c0f76667783b778baa',1,'D3D12MA']]], - ['pool_5fflag_5fnone_3',['POOL_FLAG_NONE',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1a5d8dc91add3423140809a550c7224d02',1,'D3D12MA']]] + ['pool_5fflag_5falways_5fcommitted_2',['POOL_FLAG_ALWAYS_COMMITTED',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1a15b7a6f8bfb6e4d534143f8adb6ac7ba',1,'D3D12MA']]], + ['pool_5fflag_5fmsaa_5ftextures_5falways_5fcommitted_3',['POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1acc379a89755438c0f76667783b778baa',1,'D3D12MA']]], + ['pool_5fflag_5fnone_4',['POOL_FLAG_NONE',['../namespace_d3_d12_m_a.html#a919d8545365d6b7209a964f2b99936d1a5d8dc91add3423140809a550c7224d02',1,'D3D12MA']]] ]; diff --git a/docs/html/search/functions_2.js b/docs/html/search/functions_2.js index 03da485..8005df8 100644 --- a/docs/html/search/functions_2.js +++ b/docs/html/search/functions_2.js @@ -1,14 +1,18 @@ var searchData= [ - ['calculatestatistics_0',['CalculateStatistics',['../class_d3_d12_m_a_1_1_pool.html#ad07999ac5dc8f0c63187afd45d551910',1,'D3D12MA::Pool::CalculateStatistics()'],['../class_d3_d12_m_a_1_1_allocator.html#a99db00df909963573a976c203b107d22',1,'D3D12MA::Allocator::CalculateStatistics()'],['../class_d3_d12_m_a_1_1_virtual_block.html#a614a82247ce6cf29c38895e16eb971d9',1,'D3D12MA::VirtualBlock::CalculateStatistics(DetailedStatistics *pStats) const']]], - ['clear_1',['Clear',['../class_d3_d12_m_a_1_1_virtual_block.html#ae22b18c0b7c31b44c1d740f886369189',1,'D3D12MA::VirtualBlock']]], - ['createaliasingresource_2',['CreateAliasingResource',['../class_d3_d12_m_a_1_1_allocator.html#ab45536f92410aedb7be44ea36b1b4717',1,'D3D12MA::Allocator']]], - ['createaliasingresource1_3',['CreateAliasingResource1',['../class_d3_d12_m_a_1_1_allocator.html#ad3b83cc5707cb4ed92bc277069c4ddd6',1,'D3D12MA::Allocator']]], - ['createaliasingresource2_4',['CreateAliasingResource2',['../class_d3_d12_m_a_1_1_allocator.html#a562cbaa71cbd333cade09cd67ed82453',1,'D3D12MA::Allocator']]], - ['createallocator_5',['CreateAllocator',['../namespace_d3_d12_m_a.html#ab7a1cd1683986d75ce1488b0920f4cb0',1,'D3D12MA']]], - ['createpool_6',['CreatePool',['../class_d3_d12_m_a_1_1_allocator.html#aac7b1f6bf53cbf4c4ce2264cb72ca515',1,'D3D12MA::Allocator']]], - ['createresource_7',['CreateResource',['../class_d3_d12_m_a_1_1_allocator.html#aa37d6b9fe8ea0864f7a35b9d68e8345a',1,'D3D12MA::Allocator']]], - ['createresource2_8',['CreateResource2',['../class_d3_d12_m_a_1_1_allocator.html#a7a1c79c79a7a573c438aa45c4a531b96',1,'D3D12MA::Allocator']]], - ['createresource3_9',['CreateResource3',['../class_d3_d12_m_a_1_1_allocator.html#a323b2af320b01d0fdecfc515c75db747',1,'D3D12MA::Allocator']]], - ['createvirtualblock_10',['CreateVirtualBlock',['../namespace_d3_d12_m_a.html#ab024647ae85ee63e2fa2c1c4beac6d98',1,'D3D12MA']]] + ['calculatestatistics_0',['CalculateStatistics',['../class_d3_d12_m_a_1_1_pool.html#ad07999ac5dc8f0c63187afd45d551910',1,'D3D12MA::Pool::CalculateStatistics()'],['../class_d3_d12_m_a_1_1_allocator.html#a99db00df909963573a976c203b107d22',1,'D3D12MA::Allocator::CalculateStatistics()'],['../class_d3_d12_m_a_1_1_virtual_block.html#a614a82247ce6cf29c38895e16eb971d9',1,'D3D12MA::VirtualBlock::CalculateStatistics()']]], + ['callocation_5fdesc_1',['CALLOCATION_DESC',['../struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html#a50901205f52d0c28bddaa5cc7c7a35b1',1,'D3D12MA::CALLOCATION_DESC::CALLOCATION_DESC()=default'],['../struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html#ae18d216821f86a1f35ea54bcd41c6e86',1,'D3D12MA::CALLOCATION_DESC::CALLOCATION_DESC(const ALLOCATION_DESC &o) noexcept'],['../struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html#a5c552f3160fb93b65ed16db4f6412a39',1,'D3D12MA::CALLOCATION_DESC::CALLOCATION_DESC(Pool *customPool, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept'],['../struct_d3_d12_m_a_1_1_c_a_l_l_o_c_a_t_i_o_n___d_e_s_c.html#a8916820e2d709379eb3bcd2fb7e9848f',1,'D3D12MA::CALLOCATION_DESC::CALLOCATION_DESC(D3D12_HEAP_TYPE heapType, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL, D3D12_HEAP_FLAGS extraHeapFlags=D3D12_HEAP_FLAG_NONE) noexcept']]], + ['clear_2',['Clear',['../class_d3_d12_m_a_1_1_virtual_block.html#ae22b18c0b7c31b44c1d740f886369189',1,'D3D12MA::VirtualBlock']]], + ['cpool_5fdesc_3',['CPOOL_DESC',['../struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html#afc1fdbbf07c54943a70b95f122adb0d2',1,'D3D12MA::CPOOL_DESC::CPOOL_DESC()=default'],['../struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html#ab2310e41ea92aa64dfab4a3366a60cc3',1,'D3D12MA::CPOOL_DESC::CPOOL_DESC(const POOL_DESC &o) noexcept'],['../struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html#a5de61391fddfd37d91a0ec5cb7e84c1b',1,'D3D12MA::CPOOL_DESC::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'],['../struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html#a0d1e436a90bb4a07c55a5ecf60618be3',1,'D3D12MA::CPOOL_DESC::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']]], + ['createaliasingresource_4',['CreateAliasingResource',['../class_d3_d12_m_a_1_1_allocator.html#ab45536f92410aedb7be44ea36b1b4717',1,'D3D12MA::Allocator']]], + ['createaliasingresource1_5',['CreateAliasingResource1',['../class_d3_d12_m_a_1_1_allocator.html#ad3b83cc5707cb4ed92bc277069c4ddd6',1,'D3D12MA::Allocator']]], + ['createaliasingresource2_6',['CreateAliasingResource2',['../class_d3_d12_m_a_1_1_allocator.html#a562cbaa71cbd333cade09cd67ed82453',1,'D3D12MA::Allocator']]], + ['createallocator_7',['CreateAllocator',['../namespace_d3_d12_m_a.html#ab7a1cd1683986d75ce1488b0920f4cb0',1,'D3D12MA']]], + ['createpool_8',['CreatePool',['../class_d3_d12_m_a_1_1_allocator.html#aac7b1f6bf53cbf4c4ce2264cb72ca515',1,'D3D12MA::Allocator']]], + ['createresource_9',['CreateResource',['../class_d3_d12_m_a_1_1_allocator.html#aa37d6b9fe8ea0864f7a35b9d68e8345a',1,'D3D12MA::Allocator']]], + ['createresource2_10',['CreateResource2',['../class_d3_d12_m_a_1_1_allocator.html#a7a1c79c79a7a573c438aa45c4a531b96',1,'D3D12MA::Allocator']]], + ['createresource3_11',['CreateResource3',['../class_d3_d12_m_a_1_1_allocator.html#a323b2af320b01d0fdecfc515c75db747',1,'D3D12MA::Allocator']]], + ['createvirtualblock_12',['CreateVirtualBlock',['../namespace_d3_d12_m_a.html#ab024647ae85ee63e2fa2c1c4beac6d98',1,'D3D12MA']]], + ['cvirtual_5fallocation_5fdesc_13',['CVIRTUAL_ALLOCATION_DESC',['../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#af7262b9e3178bb70416603aa32d4e8c6',1,'D3D12MA::CVIRTUAL_ALLOCATION_DESC::CVIRTUAL_ALLOCATION_DESC()=default'],['../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#abc6429b119b65f7cd3ed5c5bd4d36d85',1,'D3D12MA::CVIRTUAL_ALLOCATION_DESC::CVIRTUAL_ALLOCATION_DESC(const VIRTUAL_ALLOCATION_DESC &o) noexcept'],['../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#af72d9f4003fc6b86f76268aa8529d43a',1,'D3D12MA::CVIRTUAL_ALLOCATION_DESC::CVIRTUAL_ALLOCATION_DESC(UINT64 size, UINT64 alignment, VIRTUAL_ALLOCATION_FLAGS flags=VIRTUAL_ALLOCATION_FLAG_NONE, void *privateData=NULL) noexcept']]], + ['cvirtual_5fblock_5fdesc_14',['CVIRTUAL_BLOCK_DESC',['../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#a2871293dd04cadc9e8f10b5a5acb9b0c',1,'D3D12MA::CVIRTUAL_BLOCK_DESC::CVIRTUAL_BLOCK_DESC()=default'],['../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#a223f6535756a128b7fe86f0aa10de9af',1,'D3D12MA::CVIRTUAL_BLOCK_DESC::CVIRTUAL_BLOCK_DESC(const VIRTUAL_BLOCK_DESC &o) noexcept'],['../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#a2984a0b07b432ed8baf387d5230b7112',1,'D3D12MA::CVIRTUAL_BLOCK_DESC::CVIRTUAL_BLOCK_DESC(UINT64 size, VIRTUAL_BLOCK_FLAGS flags=VIRTUAL_BLOCK_FLAG_NONE, const ALLOCATION_CALLBACKS *allocationCallbacks=NULL) noexcept']]] ]; diff --git a/docs/html/search/searchdata.js b/docs/html/search/searchdata.js index 5304a71..b0a256b 100644 --- a/docs/html/search/searchdata.js +++ b/docs/html/search/searchdata.js @@ -1,7 +1,7 @@ var indexSectionsWithContent = { 0: "abcdefghijlmnopqrstuvw", - 1: "abdpstv", + 1: "abcdpstv", 2: "d", 3: "d", 4: "abcefgis", diff --git a/docs/html/statistics.html b/docs/html/statistics.html index 8c1997d..c49c20a 100644 --- a/docs/html/statistics.html +++ b/docs/html/statistics.html @@ -107,9 +107,9 @@

            printf("D3D12 reports total usage %llu B with budget %llu B.\n",
            localBudget.UsageBytes,
            localBudget.BudgetBytes);
            -
            D3D12MA::Budget
            Statistics of current memory usage and available budget for a specific memory segment group.
            Definition D3D12MemAlloc.h:442
            -
            D3D12MA::Budget::BudgetBytes
            UINT64 BudgetBytes
            Estimated amount of memory available to the program.
            Definition D3D12MemAlloc.h:465
            -
            D3D12MA::Budget::UsageBytes
            UINT64 UsageBytes
            Estimated current memory usage of the program.
            Definition D3D12MemAlloc.h:454
            +
            D3D12MA::Budget
            Statistics of current memory usage and available budget for a specific memory segment group.
            Definition D3D12MemAlloc.h:473
            +
            D3D12MA::Budget::BudgetBytes
            UINT64 BudgetBytes
            Estimated amount of memory available to the program.
            Definition D3D12MemAlloc.h:496
            +
            D3D12MA::Budget::UsageBytes
            UINT64 UsageBytes
            Estimated current memory usage of the program.
            Definition D3D12MemAlloc.h:485

            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().

            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 e2b588b..9835dac 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 @@ -99,11 +99,20 @@ More...

            #include <D3D12MemAlloc.h>

            +
            +Inheritance diagram for D3D12MA::ALLOCATION_DESC:
            +
            +
            + + +D3D12MA::CALLOCATION_DESC + +

        Enumerator
        VIRTUAL_ALLOCATION_FLAG_NONE 

        Zero.

        - + @@ -134,7 +143,7 @@

        Custom pool to place the new resource in. Optional.

        -

        When not NULL, the resource will be created inside specified custom pool.

        +

        When not null, the resource will be created inside specified custom pool. Members HeapType, ExtraHeapFlags are then ignored.

        @@ -173,7 +182,7 @@

        -

        Flags.

        +

        Flags for the allocation.

        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.png b/docs/html/struct_d3_d12_m_a_1_1_a_l_l_o_c_a_t_i_o_n___d_e_s_c.png new file mode 100644 index 0000000000000000000000000000000000000000..4598b4806f3265b179ddff7f44e1d9e25503235c GIT binary patch literal 783 zcmeAS@N?(olHy`uVBq!ia0vp^=YcqYgBeJ6=3o2`q@)9ULR|m<{|{uoc=NTi|Il&^ z1I+@7>1SR%c<=xyZhAIs2~du+B*-tA0mugfbEer>7#NsldAc};R4~4s`>^kg0!M5A z44;bs>idkN*EVd~JU3S@=5U(-Vm_t$3;wxkF4a*HNqd$$#pcYJ!l@u)X+@o0$GxE1 zu)}v_YTEfNcl=kA$(;T+OiK3rM>%(6vA8zt{^j+v-0IhSmU_2to8jAhpG{9LyBDr( z`(hZmBe<{fh|wbZvR}+{uLGm_{$KK9(|>efs^QgRoc$U)M>q4HUVm!Y70dH){xhB5 zxAe>zFY(XHL5nJVrqn;3nH!zj(Ok^je`Ccwfm(&{pMT9ucX{@4h1I;zkH7j?JgH4M zzwwb_=5}uR&lci(Kb*C;dmXp>{uFhT5brOh>_sGjGYn?){U z*;MXlbVyOv=zX;4;8!wvZd{RrS4*&2P0`kfyVTr@RRqwma&1%lU85V37*^a>Atl&)tYw zPjByPa|ed6n%u+KFUQ&De_XNbaB{5o>5UV%Ogh-zP|`U=>0^aUqUOBZh`Lm>ucwrz z3D2us$Zhlc-oD3{C;B})pKZKdB7Q#SwwH^{ob#1O{%x6mbn3%-cj7s|f;vvKpVAT|~l9!U_L*QQ5KX{~7+RUhQub StKJDrx(uGKelF{r5}E+Qp?Zb@ literal 0 HcmV?d00001 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 f07cfd0..3f0fc19 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 @@ -103,7 +103,7 @@

        - + @@ -131,7 +131,8 @@

        -

        Flags.

        +

        Flags for the entire allocator.

        +

        It is recommended to use D3D12MA_RECOMMENDED_ALLOCATOR_FLAGS.

        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 new file mode 100644 index 0000000..4f3f411 --- /dev/null +++ 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 @@ -0,0 +1,113 @@ + + + + + + + +D3D12 Memory Allocator: Member List + + + + + + + + + + + + + +
        +
        +

        Public Attributes

        ALLOCATION_FLAGS Flags
         Flags.
         Flags for the allocation.
         
        D3D12_HEAP_TYPE HeapType
         The type of memory heap where the new allocation should be placed.

        Public Attributes

        ALLOCATOR_FLAGS Flags
         Flags.
         Flags for the entire allocator.
         
        ID3D12Device * pDevice
         
        + + + + + +
        +
        D3D12 Memory Allocator +
        +
        + + + + + + + + + + + +
        +
        + + +
        +
        +
        +
        +
        +
        Loading...
        +
        Searching...
        +
        No Matches
        +
        +
        +
        +
        + + + +
        +
        +
        D3D12MA::CALLOCATION_DESC Member List
        +
        +
        + +

        This is the complete list of members for D3D12MA::CALLOCATION_DESC, including all inherited members.

        + + + + + + + + + + +
        CALLOCATION_DESC()=defaultD3D12MA::CALLOCATION_DESC
        CALLOCATION_DESC(const ALLOCATION_DESC &o) noexceptD3D12MA::CALLOCATION_DESCinlineexplicit
        CALLOCATION_DESC(Pool *customPool, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL) noexceptD3D12MA::CALLOCATION_DESCinlineexplicit
        CALLOCATION_DESC(D3D12_HEAP_TYPE heapType, ALLOCATION_FLAGS flags=ALLOCATION_FLAG_NONE, void *privateData=NULL, D3D12_HEAP_FLAGS extraHeapFlags=D3D12_HEAP_FLAG_NONE) noexceptD3D12MA::CALLOCATION_DESCinlineexplicit
        CustomPoolD3D12MA::ALLOCATION_DESC
        ExtraHeapFlagsD3D12MA::ALLOCATION_DESC
        FlagsD3D12MA::ALLOCATION_DESC
        HeapTypeD3D12MA::ALLOCATION_DESC
        pPrivateDataD3D12MA::ALLOCATION_DESC
        + +
        +Generated by doxygen 1.13.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 new file mode 100644 index 0000000..fd015d5 --- /dev/null +++ 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 @@ -0,0 +1,290 @@ + + + + + + + +D3D12 Memory Allocator: D3D12MA::CALLOCATION_DESC Struct Reference + + + + + + + + + + + + + +
        +
        + + + + + + +
        +
        D3D12 Memory Allocator +
        +
        +
        + + + + + + + + + + +
        +
        + + +
        +
        +
        +
        +
        +
        Loading...
        +
        Searching...
        +
        No Matches
        +
        +
        +
        +
        + + +
        +
        +
        +
        +Public Member Functions | +List of all members
        +
        D3D12MA::CALLOCATION_DESC Struct Reference
        +
        +
        + +

        Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure. + More...

        + +

        #include <D3D12MemAlloc.h>

        +
        +Inheritance diagram for D3D12MA::CALLOCATION_DESC:
        +
        +
        + + +D3D12MA::ALLOCATION_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=D3D12_HEAP_FLAG_NONE) noexcept
         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
        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

        +

        Helper structure that helps with complete and conscise initialization of the D3D12MA::ALLOCATION_DESC structure.

        +

        Constructor & Destructor Documentation

        + +

        ◆ CALLOCATION_DESC() [1/4]

        + +
        +
        + + + + + +
        + + + + + + + +
        D3D12MA::CALLOCATION_DESC::CALLOCATION_DESC ()
        +         		+default
        +
        + +

        Default constructor. Leaves the structure uninitialized.

        + +
        +
        + +

        ◆ CALLOCATION_DESC() [2/4]

        + +
        +
        + + + + + +
        + + + + + + + +
        D3D12MA::CALLOCATION_DESC::CALLOCATION_DESC (const ALLOCATION_DESC & o)
        +         		+inlineexplicitnoexcept
        +
        + +

        Constructor initializing from the base D3D12MA::ALLOCATION_DESC structure.

        + +
        +
        + +

        ◆ CALLOCATION_DESC() [3/4]

        + +
        +
        + + + + + +
        + + + + + + + + + + + + + + + + +
        D3D12MA::CALLOCATION_DESC::CALLOCATION_DESC (Pool * customPool,
        ALLOCATION_FLAGS flags = ALLOCATION_FLAG_NONE,
        void * privateData = NULL )
        +         		+inlineexplicitnoexcept
        +
        + +

        Constructor initializing description of an allocation to be created in a specific custom pool.

        + +
        +
        + +

        ◆ CALLOCATION_DESC() [4/4]

        + +
        +
        + + + + + +
        + + + + + + + + + + + + + + + + + + + + + +
        D3D12MA::CALLOCATION_DESC::CALLOCATION_DESC (D3D12_HEAP_TYPE heapType,
        ALLOCATION_FLAGS flags = ALLOCATION_FLAG_NONE,
        void * privateData = NULL,
        D3D12_HEAP_FLAGS extraHeapFlags = D3D12_HEAP_FLAG_NONE )
        +         		+inlineexplicitnoexcept
        +
        + +

        Constructor initializing description of an allocation to be created in a default pool of a specific D3D12_HEAP_TYPE.

        + +
        +
        +
        The documentation for this struct was generated from the following file: +
        + +
        +Generated by doxygen 1.13.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.png 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.png new file mode 100644 index 0000000000000000000000000000000000000000..d74b2ec3dac409baff9b31ee7c9cf4effd3fac37 GIT binary patch literal 778 zcmeAS@N?(olHy`uVBq!ia0vp^=YcqYgBeJ6=3o2`q@)9ULR|m<{|{uoc=NTi|Il&^ z1I+@7>1SR%c<=xyZhAIs2~du+B*-tA0mugfbEer>7#NtQdb&73>mTL%@8~(`J3DX7C#7&HmMez;HZ<YQ8en$>UDKRL1MPwXSZ%WU%=i@6)B>EE4uJb3mZyLYc`makr&eD25UiIMZ{ zj`uz^lKo~FxnusGXA4s^?v(%Ho_A3>y6k_>(SyM<+l-dovUs@gkde)ClkIA=*A&mY z`JZ*(wxvo+ZsMPvH8L+l5{rtZ7zpa=W>KDp0M0j+6{PSlG z>lTUg%;}m7u2y`iV{SO%CCAXQ`Uzvh4pJEUTXJu2o3LT!D!s)|0z-ROgNb9Gt1Yk0 zlUzM>-TlDZHNEj44*bj4J$>~G`#mn*1xY?}yR09r^bM3R|9<}EtA{g^7s$Exp853Q zfAiA~HId~H48`853-eblFTDT2SnhIZh1>O + + + + + + +D3D12 Memory Allocator: Member List + + + + + + + + + + + + + +
        +
        + + + + + + +
        +
        D3D12 Memory Allocator +
        +
        +
        + + + + + + + + + + +
        +
        + + +
        +
        +
        +
        +
        +
        Loading...
        +
        Searching...
        +
        No Matches
        +
        +
        +
        +
        + + +
        +
        +
        +
        D3D12MA::CPOOL_DESC Member List
        +
        +
        + +

        This is the complete list of members for D3D12MA::CPOOL_DESC, including all inherited members.

        + + + + + + + + + + + + + + +
        BlockSizeD3D12MA::POOL_DESC
        CPOOL_DESC()=defaultD3D12MA::CPOOL_DESC
        CPOOL_DESC(const POOL_DESC &o) noexceptD3D12MA::CPOOL_DESCinlineexplicit
        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) noexceptD3D12MA::CPOOL_DESCinlineexplicit
        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) noexceptD3D12MA::CPOOL_DESCinlineexplicit
        FlagsD3D12MA::POOL_DESC
        HeapFlagsD3D12MA::POOL_DESC
        HeapPropertiesD3D12MA::POOL_DESC
        MaxBlockCountD3D12MA::POOL_DESC
        MinAllocationAlignmentD3D12MA::POOL_DESC
        MinBlockCountD3D12MA::POOL_DESC
        pProtectedSessionD3D12MA::POOL_DESC
        ResidencyPriorityD3D12MA::POOL_DESC
        + +
        +Generated by doxygen 1.13.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 new file mode 100644 index 0000000..e58c262 --- /dev/null +++ b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.html @@ -0,0 +1,337 @@ + + + + + + + +D3D12 Memory Allocator: D3D12MA::CPOOL_DESC Struct Reference + + + + + + + + + + + + + +
        +
        + + + + + + +
        +
        D3D12 Memory Allocator +
        +
        +
        + + + + + + + + + + +
        +
        + + +
        +
        +
        +
        +
        +
        Loading...
        +
        Searching...
        +
        No Matches
        +
        +
        +
        +
        + + +
        +
        +
        +
        +Public Member Functions | +List of all members
        +
        D3D12MA::CPOOL_DESC Struct Reference
        +
        +
        + +

        Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure. + More...

        + +

        #include <D3D12MemAlloc.h>

        +
        +Inheritance diagram for D3D12MA::CPOOL_DESC:
        +
        +
        + + +D3D12MA::POOL_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.
         
         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.
         
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

        +Additional Inherited Members

        - 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

        +

        Helper structure that helps with complete and conscise initialization of the D3D12MA::POOL_DESC structure.

        +

        Constructor & Destructor Documentation

        + +

        ◆ CPOOL_DESC() [1/4]

        + +
        +
        + + + + + +
        + + + + + + + +
        D3D12MA::CPOOL_DESC::CPOOL_DESC ()
        +         		+default
        +
        + +

        Default constructor. Leaves the structure uninitialized.

        + +
        +
        + +

        ◆ CPOOL_DESC() [2/4]

        + +
        +
        + + + + + +
        + + + + + + + +
        D3D12MA::CPOOL_DESC::CPOOL_DESC (const POOL_DESC & o)
        +         		+inlineexplicitnoexcept
        +
        + +

        Constructor initializing from the base D3D12MA::POOL_DESC structure.

        + +
        +
        + +

        ◆ CPOOL_DESC() [3/4]

        + +
        +
        + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        D3D12MA::CPOOL_DESC::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 )
        +         		+inlineexplicitnoexcept
        +
        + +

        Constructor initializing description of a custom pool created in one of the standard D3D12_HEAP_TYPE.

        + +
        +
        + +

        ◆ CPOOL_DESC() [4/4]

        + +
        +
        + + + + + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        D3D12MA::CPOOL_DESC::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 )
        +         		+inlineexplicitnoexcept
        +
        + +

        Constructor initializing description of a custom pool created with custom D3D12_HEAP_PROPERTIES.

        + +
        +
        +
        The documentation for this struct was generated from the following file: +
        + +
        +Generated by doxygen 1.13.0 +
        +
        + + diff --git a/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.png b/docs/html/struct_d3_d12_m_a_1_1_c_p_o_o_l___d_e_s_c.png new file mode 100644 index 0000000000000000000000000000000000000000..0c2ce80f6dd63c424830698e459e47015a8077d0 GIT binary patch literal 650 zcmeAS@N?(olHy`uVBq!ia0vp^i-0(QgBeJ!EsL`TQqloFA+G=b{|7Q(y!l$%e`vXd zfo6fk^fNCWJa_;UH$5A+1SrQ@666=m0OW&#In(Sb3=B-7o-U3d6^w7^zCCwafv1(9 zedVXW@gHxQD{kb?oMm-;#xpPWM(%UX_CI=~vgbyxP_f)BG*M--m&>G{Qwr0ruRnWc z*0DR=Ru?{4FgGT>YW}UC#+mZP?(QAA5nI=PU%%(f*{eyx|9Y6sEnM>DWNck>>djrs zpDDY%cRKrLd5+hgZRH(Wi`fbdUk4tyY1k1vN2OQKEs*t`(k-stO)Fl1XLBk2{x$z< zVC^(@5Fm?Z2_Vp_Cw@$a1P(_g6XU%J@;-qBK9rz?)O72>&`H9z$x zJ*oM1xx@RyuO{V_%&8)tMyp&@PObnsyh`a>)axru4b@*68g`o6KYDCv`}j|X|Dl_b z{~3?G$zbTv7GzXd<-*diLP(Hdk(UcYhZbIeU;2XHnyGmUJ37v+aS;*h)Dm=cS#(RF zzH0f|Gf_P|=LSE1c6xq@-nGd31jFq&AFOc7IlQWNuXX**+3iP{+27nI>7Q57anHu$ zm7w|R$o#tdO0Qy19WHnloLKyLTdzQ<8}Fl}Ym57S%63GvoD<+*w1O#JuvR2GHrC-KglDHXq3ub}7n`^#ZTSHX!ZgaTbuR)L)Vsx!h%Gx)W5%gWYQKW}}M Q1Ev}VPgg&ebxsLQ0KuUw>Hq)$ literal 0 HcmV?d00001 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 new file mode 100644 index 0000000..5b54dce --- /dev/null +++ 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 @@ -0,0 +1,111 @@ + + + + + + + +D3D12 Memory Allocator: Member List + + + + + + + + + + + + + +
        +
        + + + + + + +
        +
        D3D12 Memory Allocator +
        +
        +
        + + + + + + + + + + +
        +
        + + +
        +
        +
        +
        +
        +
        Loading...
        +
        Searching...
        +
        No Matches
        +
        +
        +
        +
        + + +
        +
        +
        +
        D3D12MA::CVIRTUAL_ALLOCATION_DESC Member List
        +
        +
        + +

        This is the complete list of members for D3D12MA::CVIRTUAL_ALLOCATION_DESC, including all inherited members.

        + + + + + + + + +
        AlignmentD3D12MA::VIRTUAL_ALLOCATION_DESC
        CVIRTUAL_ALLOCATION_DESC()=defaultD3D12MA::CVIRTUAL_ALLOCATION_DESC
        CVIRTUAL_ALLOCATION_DESC(const VIRTUAL_ALLOCATION_DESC &o) noexceptD3D12MA::CVIRTUAL_ALLOCATION_DESCinlineexplicit
        CVIRTUAL_ALLOCATION_DESC(UINT64 size, UINT64 alignment, VIRTUAL_ALLOCATION_FLAGS flags=VIRTUAL_ALLOCATION_FLAG_NONE, void *privateData=NULL) noexceptD3D12MA::CVIRTUAL_ALLOCATION_DESCinlineexplicit
        FlagsD3D12MA::VIRTUAL_ALLOCATION_DESC
        pPrivateDataD3D12MA::VIRTUAL_ALLOCATION_DESC
        SizeD3D12MA::VIRTUAL_ALLOCATION_DESC
        + +
        +Generated by doxygen 1.13.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 new file mode 100644 index 0000000..a5a185b --- /dev/null +++ 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 @@ -0,0 +1,248 @@ + + + + + + + +D3D12 Memory Allocator: D3D12MA::CVIRTUAL_ALLOCATION_DESC Struct Reference + + + + + + + + + + + + + +
        +
        + + + + + + +
        +
        D3D12 Memory Allocator +
        +
        +
        + + + + + + + + + + +
        +
        + + +
        +
        +
        +
        +
        +
        Loading...
        +
        Searching...
        +
        No Matches
        +
        +
        +
        +
        + + +
        +
        +
        +
        +Public Member Functions | +List of all members
        +
        D3D12MA::CVIRTUAL_ALLOCATION_DESC Struct Reference
        +
        +
        + +

        Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure. + More...

        + +

        #include <D3D12MemAlloc.h>

        +
        +Inheritance diagram for D3D12MA::CVIRTUAL_ALLOCATION_DESC:
        +
        +
        + + +D3D12MA::VIRTUAL_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
        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

        +

        Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_ALLOCATION_DESC structure.

        +

        Constructor & Destructor Documentation

        + +

        ◆ CVIRTUAL_ALLOCATION_DESC() [1/3]

        + +
        +
        + + + + + +
        + + + + + + + +
        D3D12MA::CVIRTUAL_ALLOCATION_DESC::CVIRTUAL_ALLOCATION_DESC ()
        +         		+default
        +
        + +

        Default constructor. Leaves the structure uninitialized.

        + +
        +
        + +

        ◆ CVIRTUAL_ALLOCATION_DESC() [2/3]

        + +
        +
        + + + + + +
        + + + + + + + +
        D3D12MA::CVIRTUAL_ALLOCATION_DESC::CVIRTUAL_ALLOCATION_DESC (const VIRTUAL_ALLOCATION_DESC & o)
        +         		+inlineexplicitnoexcept
        +
        + +

        Constructor initializing from the base D3D12MA::VIRTUAL_ALLOCATION_DESC structure.

        + +
        +
        + +

        ◆ CVIRTUAL_ALLOCATION_DESC() [3/3]

        + +
        +
        + + + + + +
        + + + + + + + + + + + + + + + + + + + + + +
        D3D12MA::CVIRTUAL_ALLOCATION_DESC::CVIRTUAL_ALLOCATION_DESC (UINT64 size,
        UINT64 alignment,
        VIRTUAL_ALLOCATION_FLAGS flags = VIRTUAL_ALLOCATION_FLAG_NONE,
        void * privateData = NULL )
        +         		+inlineexplicitnoexcept
        +
        + +

        Constructor initializing description of a virtual allocation with given parameters.

        + +
        +
        +
        The documentation for this struct was generated from the following file: +
        + +
        +Generated by doxygen 1.13.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.png 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.png new file mode 100644 index 0000000000000000000000000000000000000000..6a492999dd970470500ff33625fc32b0c0681a43 GIT binary patch literal 927 zcmeAS@N?(olHy`uVBq!ia0y~yVB`d{12~w0q^(22T_7bL;1lBd|Nnm=^TnI5rTvGN zTNr2-NK8NT;=zLlKylNvVM~B=oFzei!3;n?7??B7zQVx3tmWzA7*fIbc5ZgwTLqpL z^}dkG|JwUro@|yZxU_8LEw6H|*>XLFXWAS0&v;(BO|O22veKGFAvHlkCACB$K}98% zW#9Mzo&Lr7%x>$gbDzduJGs98bpLgM^A9Q)|CCrNVj{`Ar}yi^e$kwBB1>CWd%QWj zZ0-GhpQG-GWo-?#QB)LMx^PLQ-t5*g*#)P|y|*YU$~~P@Ec8Y4)ppxmN`Xl=PK(aB z+D7|)dzAY6T2G7eqLY%GR&0~LXFUs>_K#C&jp<>2kDi%#6$*2bU0Pn8owdL>RLIqL zi}26MDsK0u@m~EDEYwn=-}LTLrfHn0==m3(D}HtzX^7bSV^5!H;8%T*g2wNndMa%} z!9uRV&&_6>_Z0EGt8meG=ijm(_mq^-y5E|es~Mi&b__qbczd&awC>+;8rM~l%N+(9?tJ;Dkt?-H%-@=t*D};^e_5vuF&ha-sNUWj~eR~*JK}3QF1z> z;-jSG;sau)C>oysoHI9_;YVpLGs9|6fe!P<2AmAOVghc7LJSdS4yrJ8%xLjs5HRGN z%%G4Yq{ip~)Xmh;;W>kaL2xoqDJbk2K!#ya_)n}ebC%lcPwkq%Fma|5 zd*}79JO59r>#CgZ{#LL%cG|btu-j$U>z!>%Z?GB4FP_q!wzP5kM!PQ?r<|R+XiI@h zQodR4U$K8%m+2nLdOY<_o|BW4x3gz4j~VwjD~IVnrWLw7*__g3=IrwOyUjFQ<;!W? z^Xe+UmfYBUzu~L6e)RS<6`Of{dOO$YYd@J5UenEz9UhjlPr-0mMe~u3^W`U6tmM4q zty&l={MO~4O6SGxsm`u{U4>lAq?dVz9^NLkepUDKZz@-6T$3Eu#MKlWpQZ7enRDIi zeH&U`!V{OPbS*oVYcPMZ#-`nli)MeixjorNNqKemub*r};f$xYH?M12zeo1Zv8#(dsS$@ugBYxa&wcUR~8KZ%RD y-r||E3>efdX + + + + + + +D3D12 Memory Allocator: Member List + + + + + + + + + + + + + +
        +
        + + + + + + +
        +
        D3D12 Memory Allocator +
        +
        +
        + + + + + + + + + + +
        +
        + + +
        +
        +
        +
        +
        +
        Loading...
        +
        Searching...
        +
        No Matches
        +
        +
        +
        +
        + + +
        +
        +
        +
        D3D12MA::CVIRTUAL_BLOCK_DESC Member List
        +
        +
        + +

        This is the complete list of members for D3D12MA::CVIRTUAL_BLOCK_DESC, including all inherited members.

        + + + + + + + +
        CVIRTUAL_BLOCK_DESC()=defaultD3D12MA::CVIRTUAL_BLOCK_DESC
        CVIRTUAL_BLOCK_DESC(const VIRTUAL_BLOCK_DESC &o) noexceptD3D12MA::CVIRTUAL_BLOCK_DESCinlineexplicit
        CVIRTUAL_BLOCK_DESC(UINT64 size, VIRTUAL_BLOCK_FLAGS flags=VIRTUAL_BLOCK_FLAG_NONE, const ALLOCATION_CALLBACKS *allocationCallbacks=NULL) noexceptD3D12MA::CVIRTUAL_BLOCK_DESCinlineexplicit
        FlagsD3D12MA::VIRTUAL_BLOCK_DESC
        pAllocationCallbacksD3D12MA::VIRTUAL_BLOCK_DESC
        SizeD3D12MA::VIRTUAL_BLOCK_DESC
        + +
        +Generated by doxygen 1.13.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 new file mode 100644 index 0000000..d767823 --- /dev/null +++ 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 @@ -0,0 +1,240 @@ + + + + + + + +D3D12 Memory Allocator: D3D12MA::CVIRTUAL_BLOCK_DESC Struct Reference + + + + + + + + + + + + + +
        +
        + + + + + + +
        +
        D3D12 Memory Allocator +
        +
        +
        + + + + + + + + + + +
        +
        + + +
        +
        +
        +
        +
        +
        Loading...
        +
        Searching...
        +
        No Matches
        +
        +
        +
        +
        + + +
        +
        +
        +
        +Public Member Functions | +List of all members
        +
        D3D12MA::CVIRTUAL_BLOCK_DESC Struct Reference
        +
        +
        + +

        Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure. + More...

        + +

        #include <D3D12MemAlloc.h>

        +
        +Inheritance diagram for D3D12MA::CVIRTUAL_BLOCK_DESC:
        +
        +
        + + +D3D12MA::VIRTUAL_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
        VIRTUAL_BLOCK_FLAGS Flags
         Flags.
         
        UINT64 Size
         Total size of the block.
         
        const ALLOCATION_CALLBACKS * pAllocationCallbacks
         Custom CPU memory allocation callbacks. Optional.
         
        +

        Detailed Description

        +

        Helper structure that helps with complete and conscise initialization of the D3D12MA::VIRTUAL_BLOCK_DESC structure.

        +

        Constructor & Destructor Documentation

        + +

        ◆ CVIRTUAL_BLOCK_DESC() [1/3]

        + +
        +
        + + + + + +
        + + + + + + + +
        D3D12MA::CVIRTUAL_BLOCK_DESC::CVIRTUAL_BLOCK_DESC ()
        +         		+default
        +
        + +

        Default constructor. Leaves the structure uninitialized.

        + +
        +
        + +

        ◆ CVIRTUAL_BLOCK_DESC() [2/3]

        + +
        +
        + + + + + +
        + + + + + + + +
        D3D12MA::CVIRTUAL_BLOCK_DESC::CVIRTUAL_BLOCK_DESC (const VIRTUAL_BLOCK_DESC & o)
        +         		+inlineexplicitnoexcept
        +
        + +

        Constructor initializing from the base D3D12MA::VIRTUAL_BLOCK_DESC structure.

        + +
        +
        + +

        ◆ CVIRTUAL_BLOCK_DESC() [3/3]

        + +
        +
        + + + + + +
        + + + + + + + + + + + + + + + + +
        D3D12MA::CVIRTUAL_BLOCK_DESC::CVIRTUAL_BLOCK_DESC (UINT64 size,
        VIRTUAL_BLOCK_FLAGS flags = VIRTUAL_BLOCK_FLAG_NONE,
        const ALLOCATION_CALLBACKS * allocationCallbacks = NULL )
        +         		+inlineexplicitnoexcept
        +
        + +

        Constructor initializing description of a virtual block with given parameters.

        + +
        +
        +
        The documentation for this struct was generated from the following file: +
        + +
        +Generated by doxygen 1.13.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.png 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.png new file mode 100644 index 0000000000000000000000000000000000000000..9809485e82bb0c2f8f3abffcf6272ea2104aa27a GIT binary patch literal 828 zcmV-C1H=4@P)vTJr#LVva2S`&=-}Ys|Ns9r%~qrU000SeQchC<|NsC0|NsC0Hv*f~0008V zNkl(znJHF9$c73M21!} ziiq^DWE2tUU&J`Q{>l~I3r&~T&FE%czs30d?|JclWG$>+{nR#VK5d>cn}gS&Ri zNqND3j~GqjP(;hL9SQ0Lqt!J=vS=8$r56z)UED{r5zH9uW37)fj9iZqBNtg^v|Z!_ zjArr5#<>Eoi5Mk=&5?zOkDYhCTDZNj#z5PthE ztcc0O()I2mt*n83CYwB_jZQ zT+=j7gA0?Y>d;C?Rn`8LjH;^rYh!#jpmIg`O4G&8jGHg}%5!}EmbtaREsv~e>%e}b zcyzw2(H7+D-&j;r!&rt@^?voTP8Sc$oQ<)(MvUZ|1{ZGYAu^;Da6z{d1&tWDS-P*w zdcmmPF9bDkVIR%n#;}r_gl$*hV9$TSxMvuA@?>BA;e0G7UBI|~+n=ay9yCWNr@J}iyhmqv>wHvI z9aR4X3kgzmic^wSOg}s%rmwGEUPpjjccbe7i>4Jj-GL0000

        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().

        +

        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.
        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 10bf5ff..82473c1 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 @@ -146,7 +146,7 @@

      • 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.
        • +
      • 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.
        • 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 9e3c17b..43e436d 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 @@ -99,11 +99,20 @@ More...

        #include <D3D12MemAlloc.h>

        +
        +Inheritance diagram for D3D12MA::POOL_DESC:
        +
        +
        + + +D3D12MA::CPOOL_DESC + +
        - + @@ -162,7 +171,8 @@

        -

        Flags.

        +

        Flags for the heap.

        +

        It is recommended to use D3D12MA_RECOMMENDED_HEAP_FLAGS.

        @@ -180,7 +190,7 @@

        D3D12MA_RECOMMENDED_POOL_FLAGS. You can specify additional flags if needed.

        diff --git a/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.png b/docs/html/struct_d3_d12_m_a_1_1_p_o_o_l___d_e_s_c.png new file mode 100644 index 0000000000000000000000000000000000000000..4d6107f0753d8a20e9cac9f9077d261a3750e4e1 GIT binary patch literal 658 zcmeAS@N?(olHy`uVBq!ia0vp^i-0(QgBeJ!EsL`TQqloFA+G=b{|7Q(y!l$%e`vXd zfo6fk^fNCWJa_;UH$5A+1SrQ@666=m0OW&#In(Sb3=B-No-U3d6^w7^KFoWfz|+$1 z*!Ab1|DC(sD%+g(eCNInyt-PJg>MGG^k?a%Q;fC;xVWT+DRp(YOzluo3Y0uz|MhZp zn$EF1%U72@Sg=0FR=O+qS=5%Qqx(u)Zp>a*yXXBUv-0rOZ_hMl%PcbIpEghF+j-fG zYk!I?DqmPtr#)N9{%wAT)?&6o)7N3gZ5npS#<(1LktP!QKxfh3#BzbJe`^^6=kBcy z6D>V+ZLJ31^0~^diav(lSJ?H0Mc}UN&e)5`bL9C8-~5@}wXZ__c16pI=BiJ6x3oVV zEe~`_v8y$IB(){FI!(mYWs#SQ;KUU|fi5bm#FI3a`sgxLgmE*RS^HCPdTQ0NpMvo% zn~nc599fgW(4j5JsIba~rD27TAOlbvLx&b#fnQTQwqE#oZO{r8%gsU)RTg`> zOzO#U)_EWQex_mX&b8TQlYZ}CYcOwD_cd$1h_idmBUTAiU*6JR{ye|<`-WRzrq#~+ z_(ZDx#o6YiavP(6yQRHiT{Lg04NtY5sF``*Esns{D+=qb*ylCG0_v;;kkR=KF0ToDKKl+{){ Zh8IiQf^B#73IbCPgQu&X%Q~loCIDf!DMore...

        #include <D3D12MemAlloc.h>

        +
        +Inheritance diagram for D3D12MA::VIRTUAL_ALLOCATION_DESC:
        +
        +
        + + +D3D12MA::CVIRTUAL_ALLOCATION_DESC + +

        Public Attributes

        POOL_FLAGS Flags
         Flags.
         Flags for the heap.
         
        D3D12_HEAP_PROPERTIES HeapProperties
         The parameters of memory heap where allocations of this pool should be placed.
        - + @@ -147,7 +156,7 @@

        -

        Flags.

        +

        Flags for the virtual allocation.

        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.png 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.png new file mode 100644 index 0000000000000000000000000000000000000000..a9d4204e977e435680ecb45f8de0a953beacbb2e GIT binary patch literal 933 zcmeAS@N?(olHy`uVBq!ia0y~yVB`d{12~w0q^(22T_7bL;1lBd|Nnm=^TnI5rTvGN zTNr2-NK8NT;=zLlKylNvVM~B=oFzei!3;n?7??B7zQVx3Y~bnQ7*fIbcJ9Nx!wNht zvdW=#|JCDePbf&AlM}hT^itlYNW)`>@@)TZZPMxf@-N-nrNzX>Nkys2Ma4x)$)n@Q zXRf<-f%Yf%>~x;3!yl>sy}MHOkmO~)36=7#A{LT-ca9gmsAat?xu~Z=v~%rCt6z_; z&ma97uv(Y>hDU%)mO|#7?zBa*>>fYAxd?N9(pWAtx#7G+{hN!DokEYbRf_apSSBqJ z*PFdPO-)A7xzFQ(;etKk#@n`h(VyV3RD(Kp&RS_@B@g{;EIC?}HL{ZCoVc%I z_`5G>!L)c)#*Xbu9^&U$d|b7nz)kJoGh-p)q;H2lTU~d#YOmPHI!}9!htJYuDqYLY zLP)|j-*LCJULpRzOVDQTf~ze9!68Bc9zUe`4J9$!t)&M(Io$4vGJNfWyL`>gu+ z2M&idmP}v@V18dyIq6$9)ASSWY@RMIf1+#6J4@Hs*|g`kg!*>4xJ>A1@o-`3^Z+sM zcLf2F5}YflOsVPV$(Y`&}1p zy>@Ty_G?kq+oOuhr|mwc5_{_*Lp_(X1LCNTl|Wa?jm4@V(@hJb6Mw<&;$UyIh(@( literal 0 HcmV?d00001 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 c95a5bb..0d54cd5 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 @@ -99,6 +99,15 @@         More...

        #include <D3D12MemAlloc.h>

        +
        +Inheritance diagram for D3D12MA::VIRTUAL_BLOCK_DESC:
        +
        +
        + + +D3D12MA::CVIRTUAL_BLOCK_DESC + +

        Public Attributes

        VIRTUAL_ALLOCATION_FLAGS Flags
         Flags.
         Flags for the virtual allocation.
         
        UINT64 Size
         Size of the allocation.
        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.png 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.png new file mode 100644 index 0000000000000000000000000000000000000000..bdf1b04c9af1c942d3324cdbc3ac38c0c6444638 GIT binary patch literal 836 zcmeAS@N?(olHy`uVBq!ia0vp^kAXOVgBeKP;WJtaq@)9ULR|m<{|{uoc=NTi|Il&^ z1I+@7>1SR%c<=xyZhAIs2~du+B*-tA0mugfbEer>7#Nt&d%8G=R4~4s`+n161)ih) ziN{XCT3;pPt5;QBu#6xtA#6Tt?kzBSFY)^I+vZ!(Cv2R(z`DnbtvLVE%2$WJ-;-Oc zAtQP*Yue%_tAiS)y@BEj{yVN`&s(!Ng5&Is$m7@K(_j&f7O?PtkYPyBX%_>ZP{o+VbS7Cnj>vvJ%-$Ua!*m2*@zn^-i zSS0=U-P*5be@680;amLhYtO40m;bK%6)0Ezujb10=W{<#oLTAgH~UzrsNRu+n~K+f zTsBr^mSxpXHh!~LsF43l58OH5C#J0YJ?qu|H?le=f*dZq(BTy6{! z@dr5=9&1Z5Ce*MhGxV%aU}^X$+QVS5uSt;MShxYx0iaoEifUpkpZ^Kf1rdtEg1&1L zRFtIR4|=$m>@z#|<gv1A=~F_}PWu?nT6H7!&P}Tto#zsN
        D3D12MA::VirtualBlock *block;
        HRESULT hr = CreateVirtualBlock(&blockDesc, &block);
        -
        D3D12MA::VirtualBlock
        Represents pure allocation algorithm and a data structure with allocations in some memory block,...
        Definition D3D12MemAlloc.h:1537
        -
        D3D12MA::VIRTUAL_BLOCK_DESC
        Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
        Definition D3D12MemAlloc.h:1443
        -
        D3D12MA::VIRTUAL_BLOCK_DESC::Size
        UINT64 Size
        Total size of the block.
        Definition D3D12MemAlloc.h:1451
        +
        D3D12MA::VirtualBlock
        Represents pure allocation algorithm and a data structure with allocations in some memory block,...
        Definition D3D12MemAlloc.h:1591
        +
        D3D12MA::VIRTUAL_BLOCK_DESC
        Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
        Definition D3D12MemAlloc.h:1497
        +
        D3D12MA::VIRTUAL_BLOCK_DESC::Size
        UINT64 Size
        Total size of the block.
        Definition D3D12MemAlloc.h:1505

        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.

        @@ -132,9 +132,9 @@

        // Allocation failed - no space for it could be found. Handle this error!
        }
        D3D12MA::VirtualBlock::Allocate
        HRESULT Allocate(const VIRTUAL_ALLOCATION_DESC *pDesc, VirtualAllocation *pAllocation, UINT64 *pOffset)
        Creates new allocation.
        -
        D3D12MA::VIRTUAL_ALLOCATION_DESC
        Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
        Definition D3D12MemAlloc.h:1488
        -
        D3D12MA::VIRTUAL_ALLOCATION_DESC::Size
        UINT64 Size
        Size of the allocation.
        Definition D3D12MemAlloc.h:1495
        -
        D3D12MA::VirtualAllocation
        Represents single memory allocation done inside VirtualBlock.
        Definition D3D12MemAlloc.h:471
        +
        D3D12MA::VIRTUAL_ALLOCATION_DESC
        Parameters of created virtual allocation to be passed to VirtualBlock::Allocate().
        Definition D3D12MemAlloc.h:1542
        +
        D3D12MA::VIRTUAL_ALLOCATION_DESC::Size
        UINT64 Size
        Size of the allocation.
        Definition D3D12MemAlloc.h:1549
        +
        D3D12MA::VirtualAllocation
        Represents single memory allocation done inside VirtualBlock.
        Definition D3D12MemAlloc.h:502

        Deallocation

        When no longer needed, an allocation can be freed by calling D3D12MA::VirtualBlock::FreeAllocation.

        @@ -171,7 +171,7 @@

        D3D12MA::VirtualAllocation alloc;
        UINT64 allocOffset;
        hr = block->Allocate(&allocDesc, &alloc, &allocOffset);
        -
        D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
        UINT64 Alignment
        Required alignment of the allocation.
        Definition D3D12MemAlloc.h:1500
        +
        D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
        UINT64 Alignment
        Required alignment of the allocation.
        Definition D3D12MemAlloc.h:1554

        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
          • @@ -186,9 +186,9 @@

          printf("My virtual block has %llu bytes used by %u virtual allocations\n",
          stats.AllocationBytes, stats.AllocationCount);
          D3D12MA::VirtualBlock::GetStatistics
          void GetStatistics(Statistics *pStats) const
          Retrieves basic statistics of the virtual block that are fast to calculate.
          -
          D3D12MA::Statistics
          Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group,...
          Definition D3D12MemAlloc.h:349
          -
          D3D12MA::Statistics::AllocationBytes
          UINT64 AllocationBytes
          Total number of bytes occupied by all D3D12MA::Allocation objects.
          Definition D3D12MemAlloc.h:367
          -
          D3D12MA::Statistics::AllocationCount
          UINT AllocationCount
          Number of D3D12MA::Allocation objects allocated.
          Definition D3D12MemAlloc.h:357
          +
          D3D12MA::Statistics
          Calculated statistics of memory usage e.g. in a specific memory heap type, memory segment group,...
          Definition D3D12MemAlloc.h:380
          +
          D3D12MA::Statistics::AllocationBytes
          UINT64 AllocationBytes
          Total number of bytes occupied by all D3D12MA::Allocation objects.
          Definition D3D12MemAlloc.h:398
          +
          D3D12MA::Statistics::AllocationCount
          UINT AllocationCount
          Number of D3D12MA::Allocation objects allocated.
          Definition D3D12MemAlloc.h:388

          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.

          diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h index dd40743..9c693cf 100644 --- a/include/D3D12MemAlloc.h +++ b/include/D3D12MemAlloc.h @@ -2663,6 +2663,23 @@ and D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED on the creation of any cus 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. +With DirectX 12 Agility SDK 1.716.0-preview, Microsoft added a new feature called **"tight alignment"**. +Note this is a separate feature than the "small alignment" described earlier. +When using this new SDK and a compatible graphics driver, the API exposes support for this new feature. +Then, a new flag `D3D12_RESOURCE_FLAG_USE_TIGHT_ALIGNMENT` can be added when creating a resource. +D3D12 can then return the alignment required for the resource smaller than the default ones described above. +This library automatically makes use of the tight alignment feature when available and adds that new resource flag. +When the tight alignment is enabled, the heuristics that creates small buffers as committed described above is deactivated, +as it is no longer needed. + +You can check if the tight alignment it is available in the current system by calling D3D12MA::Allocator::IsTightAlignmentSupported(). +You can tell the library to not use it by specifying D3D12MA::ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT. +Typically, you don't need to do any of those. + +The library automatically aligns all buffers to at least 256 B, even when the system supports smaller alignment. +This is the alignment required for constant buffers, expressed by `D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT` constant. +You can override this logic for \subpage custom_pools with a specific D3D12MA::POOL_DESC::MinAllocationAlignment. + \page defragmentation Defragmentation Interleaved allocations and deallocations of many objects of varying size can diff --git a/src/D3D12MemAlloc.cpp b/src/D3D12MemAlloc.cpp index 71fc787..1779494 100644 --- a/src/D3D12MemAlloc.cpp +++ b/src/D3D12MemAlloc.cpp @@ -74,6 +74,14 @@ #endif #endif +#ifndef D3D12MA_DEFAULT_ALIGNMENT + /* + Default alignment of allocations in default pools and custom pools with MinAllocationAlignment == 0. + Can be lowered for custom pools by specifying custom MinAllocationAlignment > 0. + */ + #define D3D12MA_DEFAULT_ALIGNMENT D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT +#endif + #ifndef D3D12MA_DEBUG_ALIGNMENT /* Minimum alignment of all allocations, in bytes. @@ -6240,7 +6248,7 @@ HRESULT AllocatorPimpl::Init(const ALLOCATOR_DESC& desc) 0, // minBlockCount SIZE_MAX, // maxBlockCount false, // explicitBlockSize - D3D12MA_DEBUG_ALIGNMENT, // minAllocationAlignment + (UINT64)D3D12MA_DEFAULT_ALIGNMENT, // minAllocationAlignment 0, // Default algorithm, m_MsaaAlwaysCommitted, NULL, // pProtectedSession @@ -7718,15 +7726,7 @@ D3D12_RESOURCE_ALLOCATION_INFO AllocatorPimpl::GetResourceAllocationInfo(D3D12_R } #endif // #if D3D12MA_USE_SMALL_RESOURCE_PLACEMENT_ALIGNMENT - D3D12_RESOURCE_ALLOCATION_INFO resAllocInfo = GetResourceAllocationInfoNative(inOutResourceDesc); - - // Align up to 256 B because this is the alignment required for constant buffers. - if (inOutResourceDesc.Dimension == D3D12_RESOURCE_DIMENSION_BUFFER) - { - resAllocInfo.Alignment = D3D12MA_MAX(resAllocInfo.Alignment, (UINT64)D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT); - } - - return resAllocInfo; + return GetResourceAllocationInfoNative(inOutResourceDesc); } bool AllocatorPimpl::NewAllocationWithinBudget(D3D12_HEAP_TYPE heapType, UINT64 size) @@ -8007,7 +8007,7 @@ BlockVector::BlockVector( m_MinBlockCount(minBlockCount), m_MaxBlockCount(maxBlockCount), m_ExplicitBlockSize(explicitBlockSize), - m_MinAllocationAlignment(minAllocationAlignment), + m_MinAllocationAlignment(D3D12MA_MAX(minAllocationAlignment, (UINT64)D3D12MA_DEBUG_ALIGNMENT)), m_Algorithm(algorithm), m_DenyMsaaTextures(denyMsaaTextures), m_ProtectedSession(pProtectedSession), @@ -9145,12 +9145,14 @@ PoolPimpl::PoolPimpl(AllocatorPimpl* allocator, const POOL_DESC& desc) D3D12MA_ASSERT(m_Desc.pProtectedSession == NULL); #endif + const UINT64 minAlignment = desc.MinAllocationAlignment > 0 ? desc.MinAllocationAlignment : D3D12MA_DEFAULT_ALIGNMENT; + m_BlockVector = D3D12MA_NEW(allocator->GetAllocs(), BlockVector)( allocator, desc.HeapProperties, desc.HeapFlags, preferredBlockSize, desc.MinBlockCount, maxBlockCount, explicitBlockSize, - D3D12MA_MAX(desc.MinAllocationAlignment, (UINT64)D3D12MA_DEBUG_ALIGNMENT), + minAlignment, (desc.Flags & POOL_FLAG_ALGORITHM_MASK) != 0, (desc.Flags & POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED) != 0, desc.pProtectedSession, diff --git a/src/Tests.cpp b/src/Tests.cpp index 7455b52..96a54eb 100644 --- a/src/Tests.cpp +++ b/src/Tests.cpp @@ -3065,36 +3065,44 @@ static void TestTightAlignment(const TestContext& ctx) // Use a custom heap to make sure our small buffers are not created as committed. POOL_DESC poolDesc = {}; - poolDesc.BlockSize = 1024 * 1024; + poolDesc.BlockSize = MEGABYTE; poolDesc.MinBlockCount = poolDesc.MaxBlockCount = 1; D3D12_RESOURCE_DESC resDesc; - FillResourceDescForBuffer(resDesc, 16); + FillResourceDescForBuffer(resDesc, 4); const D3D12_HEAP_TYPE heapTypes[] = { D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_UPLOAD }; for (auto heapType : heapTypes) { poolDesc.HeapProperties.Type = heapType; - ComPtr pool; - CHECK_HR(ctx.allocator->CreatePool(&poolDesc, &pool)); + for (uint32_t minAlignmentTestIndex = 0; minAlignmentTestIndex < 2; ++minAlignmentTestIndex) + { + // MinAllocationAlignment == 0 - default alignment. + // MinAllocationAlignment == 1 - minimum possible alignment. + poolDesc.MinAllocationAlignment = minAlignmentTestIndex; - ALLOCATION_DESC allocDesc = {}; - allocDesc.CustomPool = pool.Get(); + ComPtr pool; + CHECK_HR(ctx.allocator->CreatePool(&poolDesc, &pool)); - ComPtr allocs[2] = {}; + ALLOCATION_DESC allocDesc = {}; + allocDesc.CustomPool = pool.Get(); - for (size_t i = 0; i < _countof(allocs); ++i) - { - CHECK_HR(ctx.allocator->CreateResource(&allocDesc, &resDesc, - D3D12_RESOURCE_STATE_COMMON, NULL, &allocs[i], IID_NULL, NULL)); - CHECK_BOOL(allocs[i] && allocs[i]->GetResource()); + ComPtr allocs[2] = {}; + + for (size_t i = 0; i < _countof(allocs); ++i) + { + CHECK_HR(ctx.allocator->CreateResource(&allocDesc, &resDesc, + D3D12_RESOURCE_STATE_COMMON, NULL, &allocs[i], IID_NULL, NULL)); + CHECK_BOOL(allocs[i] && allocs[i]->GetResource()); + } + + // Print the offset of the 2nd buffer. + wprintf(L" In D3D12_HEAP_TYPE_%s, with MinAllocationAlignment=%llu, a %llu B buffer was aligned to %llu B.\n", + HEAP_TYPE_NAMES[(size_t)heapType], + poolDesc.MinAllocationAlignment, + resDesc.Width, + allocs[1]->GetOffset()); } - - // Print the offset of the 2nd buffer. - wprintf(L" In D3D12_HEAP_TYPE_%s, a %llu B buffer was aligned to %llu B.\n", - HEAP_TYPE_NAMES[(size_t)heapType], - resDesc.Width, - allocs[1]->GetOffset()); } } From 31086c74c2324a0ae98fe4a41506a62f80c92b4d Mon Sep 17 00:00:00 2001 From: Adam Sawicki Date: Tue, 11 Mar 2025 12:54:00 +0100 Subject: [PATCH 10/10] Improved TestSmallBuffers, TestTightAlignment For cases where various flags are used as g_AllocatorFlags. --- src/Tests.cpp | 33 ++++++++++++++++++++++++--------- 1 file changed, 24 insertions(+), 9 deletions(-) diff --git a/src/Tests.cpp b/src/Tests.cpp index 96a54eb..7566efd 100644 --- a/src/Tests.cpp +++ b/src/Tests.cpp @@ -733,6 +733,12 @@ static void TestSmallBuffers(const TestContext& ctx) { wprintf(L"Test small buffers\n"); + const bool isTightAlignmentEnabled = ctx.allocator->IsTightAlignmentSupported() && + (ctx.allocatorFlags & D3D12MA::ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT) == 0; + const bool expectSmallBuffersCommitted = !isTightAlignmentEnabled && + (ctx.allocatorFlags & D3D12MA::ALLOCATOR_FLAG_DONT_PREFER_SMALL_BUFFERS_COMMITTED) == 0; + + D3D12MA::CPOOL_DESC poolDesc = D3D12MA::CPOOL_DESC{ D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_FLAG_ALLOW_ONLY_BUFFERS }; @@ -778,9 +784,9 @@ static void TestSmallBuffers(const TestContext& ctx) CHECK_HR(ctx.allocator->CreateResource(&allocDesc, &resDesc, D3D12_RESOURCE_STATE_COMMON, nullptr, &resWithAlloc.allocation, IID_PPV_ARGS(&resWithAlloc.resource))); CHECK_BOOL(resWithAlloc.allocation && resWithAlloc.allocation->GetResource()); - // Expected to be committed unless tight alignment is supported. + // Expected to be committed? const bool isCommitted = resWithAlloc.allocation->GetHeap() == NULL; - CHECK_BOOL(isCommitted != (ctx.allocator->IsTightAlignmentSupported() != FALSE)); + CHECK_BOOL(isCommitted == expectSmallBuffersCommitted); } // Test 3: NEVER_ALLOCATE. @@ -3057,13 +3063,10 @@ static void TestTightAlignment(const TestContext& ctx) wprintf(L"Test resource tight alignment\n"); - if(!ctx.allocator->IsTightAlignmentSupported()) - { - wprintf(L" Skipped due to tight alignment not supported.\n"); - return; - } + const bool isTightAlignmentEnabled = ctx.allocator->IsTightAlignmentSupported() && + (ctx.allocatorFlags & ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT) == 0; - // Use a custom heap to make sure our small buffers are not created as committed. + // Use a custom pool to make sure our small buffers are not created as committed. POOL_DESC poolDesc = {}; poolDesc.BlockSize = MEGABYTE; poolDesc.MinBlockCount = poolDesc.MaxBlockCount = 1; @@ -3096,12 +3099,24 @@ static void TestTightAlignment(const TestContext& ctx) CHECK_BOOL(allocs[i] && allocs[i]->GetResource()); } + const UINT64 secondAllocOffset = allocs[1]->GetOffset(); + // Print the offset of the 2nd buffer. wprintf(L" In D3D12_HEAP_TYPE_%s, with MinAllocationAlignment=%llu, a %llu B buffer was aligned to %llu B.\n", HEAP_TYPE_NAMES[(size_t)heapType], poolDesc.MinAllocationAlignment, resDesc.Width, - allocs[1]->GetOffset()); + secondAllocOffset); + + UINT64 expectedMinAlignment = 1; + if (isTightAlignmentEnabled) + { + if (minAlignmentTestIndex == 0) + expectedMinAlignment = D3D12_CONSTANT_BUFFER_DATA_PLACEMENT_ALIGNMENT; + } + else + expectedMinAlignment = D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT; + CHECK_BOOL(secondAllocOffset % expectedMinAlignment == 0); } } }

        Public Attributes