Skip to content

Commit 042987f

Browse files
Minor improvements in documentation of macros
Cherry-picked from branch feature/resource-tight-alignment.
1 parent 1f8aa44 commit 042987f

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

include/D3D12MemAlloc.h

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Documentation of all members: D3D12MemAlloc.h
8585

8686
#ifndef D3D12MA_DXGI_1_4
8787
#ifdef __IDXGIAdapter3_INTERFACE_DEFINED__
88-
/// Define this macro to 0 to disable usage of DXGI 1.4 (which is used for IDXGIAdapter3 and query for memory budget).
88+
/// Define this macro to 0 to disable usage of DXGI 1.4 (which is used for `IDXGIAdapter3` and query for memory budget).
8989
#define D3D12MA_DXGI_1_4 1
9090
#else
9191
#define D3D12MA_DXGI_1_4 0
@@ -94,6 +94,7 @@ Documentation of all members: D3D12MemAlloc.h
9494

9595
#ifndef D3D12MA_CREATE_NOT_ZEROED_AVAILABLE
9696
#ifdef __ID3D12Device8_INTERFACE_DEFINED__
97+
/// This macro is defined to 0 or 1 automatically. Define it to 0 to disable support for `D3D12_HEAP_FLAG_CREATE_NOT_ZEROED`.
9798
#define D3D12MA_CREATE_NOT_ZEROED_AVAILABLE 1
9899
#else
99100
#define D3D12MA_CREATE_NOT_ZEROED_AVAILABLE 0
@@ -128,9 +129,9 @@ Documentation of all members: D3D12MemAlloc.h
128129

129130
#ifndef D3D12MA_RECOMMENDED_HEAP_FLAGS
130131
#if D3D12MA_CREATE_NOT_ZEROED_AVAILABLE
131-
/// Set of flags recommended for use in D3D12MA::POOL_DESC::HeapFlags for optimal performance.
132132
#define D3D12MA_RECOMMENDED_HEAP_FLAGS (D3D12_HEAP_FLAG_CREATE_NOT_ZEROED)
133133
#else
134+
/// Set of flags recommended for use in D3D12MA::POOL_DESC::HeapFlags for optimal performance.
134135
#define D3D12MA_RECOMMENDED_HEAP_FLAGS (D3D12_HEAP_FLAG_NONE)
135136
#endif
136137
#endif

0 commit comments

Comments
 (0)