From 2d83dfe7a4709c16e8f149c38136b3b326f3cf85 Mon Sep 17 00:00:00 2001 From: Adam Sawicki Date: Tue, 5 Mar 2024 16:59:27 +0100 Subject: [PATCH] Improvements in documentation Rebuilt the documentation. --- ...ass_d3_d12_m_a_1_1_allocation-members.html | 1 - .../html/class_d3_d12_m_a_1_1_allocation.html | 37 ------------------- ...lass_d3_d12_m_a_1_1_allocator-members.html | 5 ++- docs/html/class_d3_d12_m_a_1_1_allocator.html | 25 +++++++++++++ docs/html/configuration.html | 10 ++--- docs/html/custom_pools.html | 3 ++ docs/html/defragmentation.html | 20 +++++----- docs/html/doxygen_crawl.html | 2 - docs/html/functions.html | 8 +--- docs/html/functions_func.html | 6 +-- docs/html/functions_vars.html | 2 +- docs/html/index.html | 4 +- docs/html/menudata.js | 6 +-- docs/html/quick_start.html | 16 +++++--- docs/html/resource_aliasing.html | 2 +- docs/html/search/all_0.js | 17 +++++---- docs/html/search/all_7.js | 2 +- docs/html/search/all_8.js | 3 +- docs/html/search/functions_6.js | 3 +- docs/html/search/searchdata.js | 4 +- docs/html/search/variables_0.js | 4 +- docs/html/search/variables_5.js | 2 +- docs/html/statistics.html | 6 +-- ..._d12_m_a_1_1_total_statistics-members.html | 2 +- ...truct_d3_d12_m_a_1_1_total_statistics.html | 17 +++++---- docs/html/virtual_allocator.html | 14 +++---- include/D3D12MemAlloc.h | 5 +++ 27 files changed, 110 insertions(+), 116 deletions(-) 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 0e0838e..4e4bc60 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 @@ -101,7 +101,6 @@ $(function() { SetName(LPCWSTR Name)D3D12MA::Allocation SetPrivateData(void *pPrivateData)D3D12MA::Allocationinline SetResource(ID3D12Resource *pResource)D3D12MA::Allocation - WasZeroInitialized() constD3D12MA::Allocationinline
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 01c630a..da74bcc 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 @@ -125,9 +125,6 @@ Public Member Functions LPCWSTR GetName () const  Returns the name associated with the allocation object.
  -BOOL WasZeroInitialized () const - Returns TRUE if the memory of the allocation was filled with zeros when the allocation was created.
- 

Detailed Description

Represents single memory allocation.

@@ -385,40 +382,6 @@ Public Member Functions

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

-
- - -

◆ WasZeroInitialized()

- -
-
- - - - - -
- - - - - - - -
BOOL D3D12MA::Allocation::WasZeroInitialized () const
- 		-inline
-
- -

Returns TRUE if the memory of the allocation was filled with zeros when the allocation was created.

-

Returns TRUE only if the allocator is sure that the entire memory where the allocation was created was filled with zeros at the moment the allocation was made.

-

Returns FALSE if the memory could potentially contain garbage data. If it's a render-target or depth-stencil texture, it then needs proper initialization with ClearRenderTargetView, ClearDepthStencilView, DiscardResource, or a copy operation, as described on page "ID3D12Device::CreatePlacedResource method - Notes on the required resource initialization" in Microsoft documentation. Please note that rendering a fullscreen triangle or quad to the texture as a render target is not a proper way of initialization!

-

See also articles:

- -

Member Data Documentation

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 9211af4..3bfd2e4 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 @@ -99,8 +99,9 @@ $(function() { GetD3D12Options() constD3D12MA::Allocator GetMemoryCapacity(UINT memorySegmentGroup) constD3D12MA::Allocator IsCacheCoherentUMA() constD3D12MA::Allocator - IsUMA() constD3D12MA::Allocator - SetCurrentFrameIndex(UINT frameIndex)D3D12MA::Allocator + IsGPUUploadHeapSupported() 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 e71636d..fad695b 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 @@ -104,6 +104,9 @@ Public Member Functions BOOL IsCacheCoherentUMA () const  Returns true if D3D12_FEATURE_DATA_ARCHITECTURE1::CacheCoherentUMA was found to be true.
  +BOOL IsGPUUploadHeapSupported () const + Returns true if GPU Upload Heaps are supported on the current system.
+  UINT64 GetMemoryCapacity (UINT memorySegmentGroup) const  Returns total amount of memory of specific segment group, in bytes.
  @@ -780,6 +783,28 @@ Public Member Functions
  • "ID3D12Device::GetCustomHeapProperties method (d3d12.h)"
    • + + + +

    ◆ IsGPUUploadHeapSupported()

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

    Returns true if GPU Upload Heaps are supported on the current system.

    +

    When true, you can use D3D12_HEAP_TYPE_GPU_UPLOAD.

    +

    This flag is fetched from D3D12_FEATURE_D3D12_OPTIONS16::GPUUploadHeapSupported.

    +

    #define D3D12MA_OPTIONS16_SUPPORTED 1 is needed for the compilation of this library. Otherwise the flag is always false.

    +
    diff --git a/docs/html/configuration.html b/docs/html/configuration.html index 4979fee..5daa253 100644 --- a/docs/html/configuration.html +++ b/docs/html/configuration.html @@ -110,15 +110,15 @@ Custom CPU memory allocator
    D3D12MA::Allocator* allocator;
    HRESULT hr = D3D12MA::CreateAllocator(&allocatorDesc, &allocator);
    -
    D3D12MA::Allocator
    Represents main object of this library initialized for particular ID3D12Device.
    Definition D3D12MemAlloc.h:1121
    +
    D3D12MA::Allocator
    Represents main object of this library initialized for particular ID3D12Device.
    Definition D3D12MemAlloc.h:1099
    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:1082
    -
    D3D12MA::ALLOCATOR_DESC::pAllocationCallbacks
    const ALLOCATION_CALLBACKS * pAllocationCallbacks
    Custom CPU memory allocation callbacks. Optional.
    Definition D3D12MemAlloc.h:1102
    -
    D3D12MA::ALLOCATOR_DESC::pAdapter
    IDXGIAdapter * pAdapter
    Definition D3D12MemAlloc.h:1108
    -
    D3D12MA::ALLOCATOR_DESC::pDevice
    ID3D12Device * pDevice
    Definition D3D12MemAlloc.h:1090
    +
    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

    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 d3ee00d..40dce7e 100644 --- a/docs/html/custom_pools.html +++ b/docs/html/custom_pools.html @@ -84,9 +84,12 @@ Usage

    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;
    +
    // This flag is optional but recommended.
    +
    poolDesc.Flags = D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED;
    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

    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 58032e6..1b07b63 100644 --- a/docs/html/defragmentation.html +++ b/docs/html/defragmentation.html @@ -136,19 +136,19 @@ $(function() {
    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:511
    +
    D3D12MA::Allocation::GetResource
    ID3D12Resource * GetResource() const
    Returns D3D12 resource associated with this object.
    Definition D3D12MemAlloc.h:512
    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:790
    +
    D3D12MA::DefragmentationContext
    Represents defragmentation process in progress.
    Definition D3D12MemAlloc.h:768
    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:670
    -
    D3D12MA::DEFRAGMENTATION_DESC
    Parameters for defragmentation.
    Definition D3D12MemAlloc.h:692
    -
    D3D12MA::DEFRAGMENTATION_DESC::Flags
    DEFRAGMENTATION_FLAGS Flags
    Flags.
    Definition D3D12MemAlloc.h:694
    -
    D3D12MA::DEFRAGMENTATION_MOVE::pSrcAllocation
    Allocation * pSrcAllocation
    Allocation that should be moved.
    Definition D3D12MemAlloc.h:728
    -
    D3D12MA::DEFRAGMENTATION_MOVE::pDstTmpAllocation
    Allocation * pDstTmpAllocation
    Temporary allocation pointing to destination memory that will replace pSrcAllocation.
    Definition D3D12MemAlloc.h:736
    -
    D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO
    Parameters for incremental defragmentation steps.
    Definition D3D12MemAlloc.h:744
    -
    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:768
    -
    D3D12MA::DEFRAGMENTATION_PASS_MOVE_INFO::MoveCount
    UINT32 MoveCount
    Number of elements in the pMoves array.
    Definition D3D12MemAlloc.h:746
    +
    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

    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:

      - i -

      @@ -242,11 +243,6 @@ $(function() {
    2. UnusedRangeSizeMin : D3D12MA::DetailedStatistics
    3. UsageBytes : D3D12MA::Budget
      4. - - -

      - w -

      diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html index 964ad33..68624de 100644 --- a/docs/html/functions_func.html +++ b/docs/html/functions_func.html @@ -131,6 +131,7 @@ $(function() {

      - i -

      @@ -142,11 +143,6 @@ $(function() {
    4. SetPrivateData() : D3D12MA::Allocation
    5. SetResource() : D3D12MA::Allocation
      6. - - -

      - w -

      diff --git a/docs/html/functions_vars.html b/docs/html/functions_vars.html index f5de40e..f37bc17 100644 --- a/docs/html/functions_vars.html +++ b/docs/html/functions_vars.html @@ -116,7 +116,7 @@ $(function() {
    6. HeapFlags : D3D12MA::POOL_DESC
    7. HeapProperties : D3D12MA::POOL_DESC
    8. HeapsFreed : D3D12MA::DEFRAGMENTATION_STATS
      9. -
    9. HeapType : D3D12MA::ALLOCATION_DESC, D3D12MA::TotalStatistics
      10. +
    10. HeapType : D3D12MA::ALLOCATION_DESC, D3D12MA::TotalStatistics
      11. diff --git a/docs/html/index.html b/docs/html/index.html index d4145a7..7ecaf48 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -74,8 +74,8 @@ $(function() {
      D3D12 Memory Allocator
      -

      Version 2.1.0-development (2023-07-05)

      -

      Copyright (c) 2019-2023 Advanced Micro Devices, Inc. All rights reserved.
      +

      Version 2.1.0-development (2024-07-05)

      +

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

      Documentation of all members: D3D12MemAlloc.h

      diff --git a/docs/html/menudata.js b/docs/html/menudata.js index 3f67953..2b1ec86 100644 --- a/docs/html/menudata.js +++ b/docs/html/menudata.js @@ -65,8 +65,7 @@ var menudata={children:[ {text:"r",url:"functions.html#index_r"}, {text:"s",url:"functions.html#index_s"}, {text:"t",url:"functions.html#index_t"}, -{text:"u",url:"functions.html#index_u"}, -{text:"w",url:"functions.html#index_w"}]}, +{text:"u",url:"functions.html#index_u"}]}, {text:"Functions",url:"functions_func.html",children:[ {text:"a",url:"functions_func.html#index_a"}, {text:"b",url:"functions_func.html#index_b"}, @@ -75,8 +74,7 @@ var menudata={children:[ {text:"f",url:"functions_func.html#index_f"}, {text:"g",url:"functions_func.html#index_g"}, {text:"i",url:"functions_func.html#index_i"}, -{text:"s",url:"functions_func.html#index_s"}, -{text:"w",url:"functions_func.html#index_w"}]}, +{text:"s",url:"functions_func.html#index_s"}]}, {text:"Variables",url:"functions_vars.html",children:[ {text:"a",url:"functions_vars.html#index_a"}, {text:"b",url:"functions_vars.html#index_b"}, diff --git a/docs/html/quick_start.html b/docs/html/quick_start.html index 6f0631b..fceb345 100644 --- a/docs/html/quick_start.html +++ b/docs/html/quick_start.html @@ -96,14 +96,20 @@ Project setup and initialization

      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* allocator;
      HRESULT hr = D3D12MA::CreateAllocator(&allocatorDesc, &allocator);
      -
      D3D12MA::Allocator
      Represents main object of this library initialized for particular ID3D12Device.
      Definition D3D12MemAlloc.h:1121
      +
      D3D12MA::Allocator
      Represents main object of this library initialized for particular ID3D12Device.
      Definition D3D12MemAlloc.h:1099
      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_DESC
      Parameters of created Allocator object. To be used with CreateAllocator().
      Definition D3D12MemAlloc.h:1082
      -
      D3D12MA::ALLOCATOR_DESC::pAdapter
      IDXGIAdapter * pAdapter
      Definition D3D12MemAlloc.h:1108
      -
      D3D12MA::ALLOCATOR_DESC::pDevice
      ID3D12Device * pDevice
      Definition D3D12MemAlloc.h:1090
      +
      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

      (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();
      @@ -138,7 +144,7 @@ Creating resources
      IID_NULL, NULL);
      // Use allocation->GetResource()...
      -
      D3D12MA::Allocation
      Represents single memory allocation.
      Definition D3D12MemAlloc.h:482
      +
      D3D12MA::Allocation
      Represents single memory allocation.
      Definition D3D12MemAlloc.h:483
      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
      diff --git a/docs/html/resource_aliasing.html b/docs/html/resource_aliasing.html index 5f62850..e81e1ec 100644 --- a/docs/html/resource_aliasing.html +++ b/docs/html/resource_aliasing.html @@ -153,7 +153,7 @@ $(function() {
      res2->Release();
      res1->Release();
      alloc->Release();
      -
      D3D12MA::Allocation
      Represents single memory allocation.
      Definition D3D12MemAlloc.h:482
      +
      D3D12MA::Allocation
      Represents single memory allocation.
      Definition D3D12MemAlloc.h:483
      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
      diff --git a/docs/html/search/all_0.js b/docs/html/search/all_0.js index 9b1472b..d1b5fb8 100644 --- a/docs/html/search/all_0.js +++ b/docs/html/search/all_0.js @@ -42,12 +42,13 @@ var searchData= ['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',['../class_d3_d12_m_a_1_1_allocation.html#a5c38846905b1ca0ff228c6081f2fc20c',1,'D3D12MA::Allocation']]], - ['allochandle_43',['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']]], - ['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,'']]] + ['allochandle_42',['AllocHandle',['../struct_d3_d12_m_a_1_1_virtual_allocation.html#a5d3166cf1f284fbbea4d0b169c4dba13',1,'D3D12MA::VirtualAllocation']]], + ['allochandle_43',['allocHandle',['../class_d3_d12_m_a_1_1_allocation.html#a5c38846905b1ca0ff228c6081f2fc20c',1,'D3D12MA::Allocation']]], + ['allochandle_44',['AllocHandle',['../namespace_d3_d12_m_a.html#a15e349adce86a40e0417d405aef1af80',1,'D3D12MA']]], + ['also_45',['See also',['../index.html#main_see_also',1,'']]], + ['and_20benefits_46',['Features and benefits',['../custom_pools.html#custom_pools_features_and_benefits',1,'']]], + ['and_20compatibility_47',['Versioning and compatibility',['../general_considerations.html#general_considerations_versioning_and_compatibility',1,'']]], + ['and_20initialization_48',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]], + ['and_20units_49',['Alignment and units',['../virtual_allocator.html#virtual_allocator_alignment_and_units',1,'']]], + ['at_20once_50',['Free-at-once',['../linear_algorithm.html#linear_algorithm_free_at_once',1,'']]] ]; diff --git a/docs/html/search/all_7.js b/docs/html/search/all_7.js index 7c24ce3..ebf5e92 100644 --- a/docs/html/search/all_7.js +++ b/docs/html/search/all_7.js @@ -4,5 +4,5 @@ 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#a07247152fc70a8ee5605cab0fe220ea5',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']]] ]; diff --git a/docs/html/search/all_8.js b/docs/html/search/all_8.js index b66f55c..90457e4 100644 --- a/docs/html/search/all_8.js +++ b/docs/html/search/all_8.js @@ -3,5 +3,6 @@ var searchData= ['initialization_0',['Project setup and initialization',['../quick_start.html#quick_start_project_setup',1,'']]], ['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']]], - ['isuma_3',['IsUMA',['../class_d3_d12_m_a_1_1_allocator.html#a9e742884bd45dd7f01193d13fcd05af0',1,'D3D12MA::Allocator']]] + ['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']]] ]; diff --git a/docs/html/search/functions_6.js b/docs/html/search/functions_6.js index dfdf1c8..22c80f9 100644 --- a/docs/html/search/functions_6.js +++ b/docs/html/search/functions_6.js @@ -2,5 +2,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']]], - ['isuma_2',['IsUMA',['../class_d3_d12_m_a_1_1_allocator.html#a9e742884bd45dd7f01193d13fcd05af0',1,'D3D12MA::Allocator']]] + ['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']]] ]; diff --git a/docs/html/search/searchdata.js b/docs/html/search/searchdata.js index 4df02bf..9eb6f9b 100644 --- a/docs/html/search/searchdata.js +++ b/docs/html/search/searchdata.js @@ -1,10 +1,10 @@ var indexSectionsWithContent = { - 0: "abcdefghijlmnopqrstuvw", + 0: "abcdefghijlmnopqrstuv", 1: "abdpstv", 2: "d", 3: "d", - 4: "abcefgisw", + 4: "abcefgis", 5: "abcefhlmnoprstu", 6: "af", 7: "adpv", diff --git a/docs/html/search/variables_0.js b/docs/html/search/variables_0.js index 6a95675..733f671 100644 --- a/docs/html/search/variables_0.js +++ b/docs/html/search/variables_0.js @@ -6,6 +6,6 @@ var searchData= ['allocationsizemax_3',['AllocationSizeMax',['../struct_d3_d12_m_a_1_1_detailed_statistics.html#a2f47015bebf9a30ce221aef88fe11991',1,'D3D12MA::DetailedStatistics']]], ['allocationsizemin_4',['AllocationSizeMin',['../struct_d3_d12_m_a_1_1_detailed_statistics.html#a187e5562265c3daa87c15d54f1396a6a',1,'D3D12MA::DetailedStatistics']]], ['allocationsmoved_5',['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']]], - ['allochandle_6',['allocHandle',['../class_d3_d12_m_a_1_1_allocation.html#a5c38846905b1ca0ff228c6081f2fc20c',1,'D3D12MA::Allocation']]], - ['allochandle_7',['AllocHandle',['../struct_d3_d12_m_a_1_1_virtual_allocation.html#a5d3166cf1f284fbbea4d0b169c4dba13',1,'D3D12MA::VirtualAllocation']]] + ['allochandle_6',['AllocHandle',['../struct_d3_d12_m_a_1_1_virtual_allocation.html#a5d3166cf1f284fbbea4d0b169c4dba13',1,'D3D12MA::VirtualAllocation']]], + ['allochandle_7',['allocHandle',['../class_d3_d12_m_a_1_1_allocation.html#a5c38846905b1ca0ff228c6081f2fc20c',1,'D3D12MA::Allocation']]] ]; diff --git a/docs/html/search/variables_5.js b/docs/html/search/variables_5.js index 7c24ce3..ebf5e92 100644 --- a/docs/html/search/variables_5.js +++ b/docs/html/search/variables_5.js @@ -4,5 +4,5 @@ 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#a07247152fc70a8ee5605cab0fe220ea5',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']]] ]; diff --git a/docs/html/statistics.html b/docs/html/statistics.html index 493cc35..9ff6b9f 100644 --- a/docs/html/statistics.html +++ b/docs/html/statistics.html @@ -94,9 +94,9 @@ Numeric statistics
      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:433
      -
      D3D12MA::Budget::BudgetBytes
      UINT64 BudgetBytes
      Estimated amount of memory available to the program.
      Definition D3D12MemAlloc.h:456
      -
      D3D12MA::Budget::UsageBytes
      UINT64 UsageBytes
      Estimated current memory usage of the program.
      Definition D3D12MemAlloc.h:445
      +
      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

      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_total_statistics-members.html b/docs/html/struct_d3_d12_m_a_1_1_total_statistics-members.html index 2885f55..c4f197e 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 @@ -81,7 +81,7 @@ $(function() {

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

      - +
      HeapTypeD3D12MA::TotalStatistics
      HeapTypeD3D12MA::TotalStatistics
      MemorySegmentGroupD3D12MA::TotalStatistics
      TotalD3D12MA::TotalStatistics
      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 68566db..27e44a8 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 @@ -89,9 +89,9 @@ $(function() { - - - + + + @@ -103,14 +103,14 @@ Public Attributes

      General statistics from current state of the allocator - total memory usage across all memory heaps and segments.

      These are slower to calculate. Use for debugging purposes. See function D3D12MA::Allocator::CalculateStatistics().

      Member Data Documentation

      - -

      ◆ HeapType

      + +

      ◆ HeapType

      Public Attributes

      DetailedStatistics HeapType [4]
       One element for each type of heap located at the following indices:
       
      DetailedStatistics HeapType [5]
       One element for each type of heap located at the following indices:
       
      DetailedStatistics MemorySegmentGroup [2]
       One element for each memory segment group located at the following indices:
       
      - +
      DetailedStatistics D3D12MA::TotalStatistics::HeapType[4]DetailedStatistics D3D12MA::TotalStatistics::HeapType[5]
      @@ -120,7 +120,8 @@ Public Attributes
    11. 0 = D3D12_HEAP_TYPE_DEFAULT
    12. 1 = D3D12_HEAP_TYPE_UPLOAD
    13. 2 = D3D12_HEAP_TYPE_READBACK
      14. -
    14. 3 = D3D12_HEAP_TYPE_CUSTOM
      15. +
    15. 3 = D3D12_HEAP_TYPE_CUSTOM
      16. +
    16. 4 = D3D12_HEAP_TYPE_GPU_UPLOAD
      17. @@ -145,7 +146,7 @@ Public Attributes

      Meaning of these segment groups is:

      • When IsUMA() == FALSE (discrete graphics card):
          -
        • DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT or D3D12_MEMORY_POOL_L1).
          • +
        • DXGI_MEMORY_SEGMENT_GROUP_LOCAL (index 0) represents GPU memory (resources allocated in D3D12_HEAP_TYPE_DEFAULT, D3D12_HEAP_TYPE_GPU_UPLOAD or D3D12_MEMORY_POOL_L1).
        • DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL (index 1) represents system memory (resources allocated in D3D12_HEAP_TYPE_UPLOAD, D3D12_HEAP_TYPE_READBACK, or D3D12_MEMORY_POOL_L0).
        • diff --git a/docs/html/virtual_allocator.html b/docs/html/virtual_allocator.html index 96173d0..d150718 100644 --- a/docs/html/virtual_allocator.html +++ b/docs/html/virtual_allocator.html @@ -92,9 +92,9 @@ Creating virtual block
        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:1526
        -
        D3D12MA::VIRTUAL_BLOCK_DESC
        Parameters of created D3D12MA::VirtualBlock object to be passed to CreateVirtualBlock().
        Definition D3D12MemAlloc.h:1432
        -
        D3D12MA::VIRTUAL_BLOCK_DESC::Size
        UINT64 Size
        Total size of the block.
        Definition D3D12MemAlloc.h:1440
        +
        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

        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.

        @@ -119,9 +119,9 @@ Making virtual allocations
        // 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:1477
        -
        D3D12MA::VIRTUAL_ALLOCATION_DESC::Size
        UINT64 Size
        Size of the allocation.
        Definition D3D12MemAlloc.h:1484
        -
        D3D12MA::VirtualAllocation
        Represents single memory allocation done inside VirtualBlock.
        Definition D3D12MemAlloc.h:462
        +
        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

        Deallocation

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

        @@ -158,7 +158,7 @@ Alignment and units
        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:1489
        +
        D3D12MA::VIRTUAL_ALLOCATION_DESC::Alignment
        UINT64 Alignment
        Required alignment of the allocation.
        Definition D3D12MemAlloc.h:1476

        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
          • diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h index ff989cb..dac75e5 100644 --- a/include/D3D12MemAlloc.h +++ b/include/D3D12MemAlloc.h @@ -1637,6 +1637,9 @@ 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* allocator; HRESULT hr = D3D12MA::CreateAllocator(&allocatorDesc, &allocator); @@ -1861,6 +1864,8 @@ to obtain object D3D12MA::Pool. Example: \code POOL_DESC poolDesc = {}; poolDesc.HeapProperties.Type = D3D12_HEAP_TYPE_DEFAULT; +// This flag is optional but recommended. +poolDesc.Flags = D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED; Pool* pool; HRESULT hr = allocator->CreatePool(&poolDesc, &pool);