Skip to main content
Creates a special-purpose diagnostic heap in system memory from a file mapping object. The created heap can persist even in the event of a GPU-fault or device-removed scenario.

​
Syntax

​
Parameters

hFileMapping
Type: HANDLE The handle to the file mapping object to use to create the heap. riid
Type: const IID & The globally unique identifier (GUID) for the heap interface (ID3D12Heap). The REFIID, or GUID, of the interface to the heap can be obtained by using the __uuidof() macro. For example, __uuidof(ID3D12Heap) will retrieve the GUID of the interface to a heap. ppvHeap [out]
Type: void ** SAL: COM_Outptr A pointer to a memory block. On success, the D3D12 runtime will write a pointer to the newly-opened heap into the memory block. The type of the pointer depends on the provided riid parameter.

​
Return value

Type: HRESULT This method returns E_OUTOFMEMORY if there is insufficient memory to open the existing heap. See Direct3D 12 Return Codes for other possible return values.

​
Remarks

The heap is created in system memory, and it permits CPU access. It wraps the entire VirtualAlloc region. Heaps can be used for placed and reserved resources, as orthogonally as other heaps. Restrictions may still exist based on the flags that cannot be app-chosen.

​
Requirements

Header: d3d12_xs.h or d3d12_x.h
Library: d3d12_xs.lib or d3d12_x.lib
Supported Platforms: XBOX Series consoles and XBOX One family

​
See Also

ID3D12Device3 interface
Last modified on August 6, 2026

Related topics

OpenExistingHeapFromAddressTAK Editor SetupGameInput Device Mapping Tool and Testing GuideMicrosoftGame.config EditorD3D12_FEATURE_DATA_EXISTING_HEAPS