Edit

Share via

ID3D12Resource::GetHeapProperties method (d3d12.h)

  • Article

Retrieves the properties of the resource heap, for placed and committed resources.

Syntax

HRESULT GetHeapProperties(
  [out, optional] D3D12_HEAP_PROPERTIES *pHeapProperties,
  [out, optional] D3D12_HEAP_FLAGS      *pHeapFlags
);

Parameters

[out, optional] pHeapProperties

Type: D3D12_HEAP_PROPERTIES*

Pointer to a D3D12_HEAP_PROPERTIES structure, that on successful completion of the method will contain the resource heap properties.

[out, optional] pHeapFlags

Type: D3D12_HEAP_FLAGS*

Specifies a D3D12_HEAP_FLAGS variable, that on successful completion of the method will contain any miscellaneous heap flags.

Return value

Type: HRESULT

This method returns one of the Direct3D 12 Return Codes. If the resource was created as reserved, E_INVALIDARG is returned.

Remarks

This method only works on placed and committed resources, not on reserved resources. If the resource was created as reserved, E_INVALIDARG is returned. The pages could be mapped to none, one, or more heaps.

For more information, refer to Memory Management in Direct3D 12.

Requirements

Requirement Value
Target Platform Windows
Header d3d12.h
Library D3d12.lib
DLL D3d12.dll

See also

ID3D12Resource