ID3D12CommandQueue::CopyTileMappings method (d3d12.h)

Article
02/22/2024

Copies mappings from a source reserved resource to a destination reserved resource.

Syntax

void CopyTileMappings(
  [in] ID3D12Resource                        *pDstResource,
  [in] const D3D12_TILED_RESOURCE_COORDINATE *pDstRegionStartCoordinate,
  [in] ID3D12Resource                        *pSrcResource,
  [in] const D3D12_TILED_RESOURCE_COORDINATE *pSrcRegionStartCoordinate,
  [in] const D3D12_TILE_REGION_SIZE          *pRegionSize,
       D3D12_TILE_MAPPING_FLAGS              Flags
);

Parameters

[in] pDstResource

A pointer to the destination reserved resource.

[in] pDstRegionStartCoordinate

A pointer to a D3D12_TILED_RESOURCE_COORDINATE structure that describes the starting coordinates of the destination reserved resource.

[in] pSrcResource

A pointer to the source reserved resource.

[in] pSrcRegionStartCoordinate

A pointer to a D3D12_TILED_RESOURCE_COORDINATE structure that describes the starting coordinates of the source reserved resource.

[in] pRegionSize

A pointer to a D3D12_TILE_REGION_SIZE structure that describes the size of the reserved region.

Flags

One member of D3D12_TILE_MAPPING_FLAGS.

Return value

None

Remarks

Use CopyTileMappings to copy the tile mappings from one reserved resource to another, either to duplicate a resource mapping, or to initialize a new mapping before modifying it using UpdateTileMappings.

CopyTileMappings helps with tasks such as shifting mappings around within and across reserved resources, for example, scrolling tiles. The source and destination regions can overlap; the result of the copy in this situation is as if the source was saved to a temporary location and from there written to the destination.

The destination and the source regions must each entirely fit in their resource or behavior is undefined and the debug layer will emit an error.

Requirements

Requirement	Value
Target Platform	Windows
Header	d3d12.h