From 0a9cbbbdb0da95be059f6c40a958188bfbd96b9e Mon Sep 17 00:00:00 2001 From: Adam Sawicki Date: Tue, 5 Mar 2024 17:02:00 +0100 Subject: [PATCH] Improvements in documentation (2) Rebuilt the documentation. --- docs/html/custom_pools.html | 3 ++- include/D3D12MemAlloc.h | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/html/custom_pools.html b/docs/html/custom_pools.html index 40dce7e..14b22ea 100644 --- a/docs/html/custom_pools.html +++ b/docs/html/custom_pools.html @@ -84,8 +84,9 @@ 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.
+
// These flags are optional but recommended.
poolDesc.Flags = D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED;
+
poolDesc.HeapFlags = D3D12_HEAP_FLAG_CREATE_NOT_ZEROED;
Pool* pool;
HRESULT hr = allocator->CreatePool(&poolDesc, &pool);
diff --git a/include/D3D12MemAlloc.h b/include/D3D12MemAlloc.h index dac75e5..a12034f 100644 --- a/include/D3D12MemAlloc.h +++ b/include/D3D12MemAlloc.h @@ -1864,8 +1864,9 @@ to obtain object D3D12MA::Pool. Example: \code POOL_DESC poolDesc = {}; poolDesc.HeapProperties.Type = D3D12_HEAP_TYPE_DEFAULT; -// This flag is optional but recommended. +// These flags are optional but recommended. poolDesc.Flags = D3D12MA::POOL_FLAG_MSAA_TEXTURES_ALWAYS_COMMITTED; +poolDesc.HeapFlags = D3D12_HEAP_FLAG_CREATE_NOT_ZEROED; Pool* pool; HRESULT hr = allocator->CreatePool(&poolDesc, &pool);