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:

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

D3D12MA::CPOOL_DESC::CPOOL_DESC ( )

default

Default constructor. Leaves the structure uninitialized.

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

inlineexplicitnoexcept

Constructor initializing from the base D3D12MA::POOL_DESC structure.

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.

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: