AuroraMiddleware/D3D12MemoryAllocator
1
0
Fork 0
mirror of https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator.git synced 2024-11-24 21:10:11 +00:00
Code Issues Projects Releases Wiki Activity

Fix documentation of Allocator::AllocateMemory function

Browse Source
This commit is contained in:
Adam Sawicki 2020-01-23 13:24:28 +01:00
parent 9cd14c31dc
commit 2a210dbf13
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/D3D12MemAlloc.h
View File

@ -727,7 +727,7 @@ public:
REFIID riidResource, REFIID riidResource,
void** ppvResource); void** ppvResource);
/* \brief Allocates memory without creating any resource placed in it. /** \brief Allocates memory without creating any resource placed in it.
This function is similar to `ID3D12Device::CreateHeap`, but it may really assign This function is similar to `ID3D12Device::CreateHeap`, but it may really assign
part of a larger, existing heap to the allocation. part of a larger, existing heap to the allocation.
@ -741,6 +741,9 @@ public:
`pAllocInfo->SizeInBytes` must be multiply of 64KB. `pAllocInfo->SizeInBytes` must be multiply of 64KB.
`pAllocInfo->Alignment` must be one of the legal values as described in documentation of `D3D12_HEAP_DESC`. `pAllocInfo->Alignment` must be one of the legal values as described in documentation of `D3D12_HEAP_DESC`.
If you use #ALLOCATION_FLAG_COMMITTED you will get a separate memory block -
a heap that always has offset 0.
*/ */
HRESULT AllocateMemory( HRESULT AllocateMemory(
const ALLOCATION_DESC* pAllocDesc, const ALLOCATION_DESC* pAllocDesc,