ID3D12Resource::Unmap method (d3d12.h)

Article
02/22/2024

Invalidates the CPU pointer to the specified subresource in the resource.

Syntax

void Unmap(
                 UINT              Subresource,
  [in, optional] const D3D12_RANGE *pWrittenRange
);

Parameters

Subresource

Type: UINT

Specifies the index of the subresource.

[in, optional] pWrittenRange

Type: const D3D12_RANGE*

A pointer to a D3D12_RANGE structure that describes the range of memory to unmap.

This indicates the region the CPU might have modified, and the coordinates are subresource-relative. A null pointer indicates the entire subresource might have been modified by the CPU. It is valid to specify the CPU didn't write any data by passing a range where End is less than or equal to Begin.

This parameter is only used by tooling, and not for correctness of the actual unmap operation.

Return value

None

Remarks

Refer to the extensive Remarks and Examples for the Map method.

Requirements

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