Skip to content

Latest commit

 

History

History
122 lines (85 loc) · 6.21 KB

nf-d3d11_2-id3d11devicecontext2-copytilemappings.md

File metadata and controls

122 lines (85 loc) · 6.21 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:d3d11_2.ID3D11DeviceContext2.CopyTileMappings
ID3D11DeviceContext2::CopyTileMappings (d3d11_2.h)
Copies mappings from a source tiled resource to a destination tiled resource.
CopyTileMappings
CopyTileMappings method [Direct3D 11]
CopyTileMappings method [Direct3D 11]
ID3D11DeviceContext2 interface
ID3D11DeviceContext2 interface [Direct3D 11]
CopyTileMappings method
ID3D11DeviceContext2.CopyTileMappings
ID3D11DeviceContext2::CopyTileMappings
d3d11_2/ID3D11DeviceContext2::CopyTileMappings
direct3d11.id3d11devicecontext2_copytilemappings
direct3d11\id3d11devicecontext2_copytilemappings.htm
direct3d11
03EBF4F5-CEC3-485D-8124-AAB90DA4D6E1
12/05/2018
CopyTileMappings, CopyTileMappings method [Direct3D 11], CopyTileMappings method [Direct3D 11],ID3D11DeviceContext2 interface, ID3D11DeviceContext2 interface [Direct3D 11],CopyTileMappings method, ID3D11DeviceContext2.CopyTileMappings, ID3D11DeviceContext2::CopyTileMappings, d3d11_2/ID3D11DeviceContext2::CopyTileMappings, direct3d11.id3d11devicecontext2_copytilemappings
d3d11_2.h
Windows
Windows 8.1 [desktop apps \| UWP apps]
Windows Server 2012 R2 [desktop apps \| UWP apps]
D3D11.lib
Windows
19H1
ID3D11DeviceContext2::CopyTileMappings
d3d11_2/ID3D11DeviceContext2::CopyTileMappings
c++
APIRef
kbSyntax
COM
D3D11.lib
D3D11.dll
ID3D11DeviceContext2.CopyTileMappings

ID3D11DeviceContext2::CopyTileMappings

-description

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

-parameters

-param pDestTiledResource [in]

Type: ID3D11Resource*

A pointer to the destination tiled resource.

-param pDestRegionStartCoordinate [in]

Type: const D3D11_TILED_RESOURCE_COORDINATE*

A pointer to a D3D11_TILED_RESOURCE_COORDINATE structure that describes the starting coordinates of the destination tiled resource.

-param pSourceTiledResource [in]

Type: ID3D11Resource*

A pointer to the source tiled resource.

-param pSourceRegionStartCoordinate [in]

Type: const D3D11_TILED_RESOURCE_COORDINATE*

A pointer to a D3D11_TILED_RESOURCE_COORDINATE structure that describes the starting coordinates of the source tiled resource.

-param pTileRegionSize [in]

Type: const D3D11_TILE_REGION_SIZE*

A pointer to a D3D11_TILE_REGION_SIZE structure that describes the size of the tiled region.

-param Flags [in]

Type: UINT

A combination of D3D11_TILE_MAPPING_FLAGS values that are combined by using a bitwise OR operation. The only valid value is D3D11_TILE_MAPPING_NO_OVERWRITE, which indicates that previously submitted commands to the device that may still be executing do not reference any of the tile region being updated. The device can then avoid having to flush previously submitted work to perform the tile mapping update. If the app violates this promise by updating tile mappings for locations in tiled resources that are still being referenced by outstanding commands, undefined rendering behavior results, including the potential for significant slowdowns on some architectures. This is like the "no overwrite" concept that exists elsewhere in the Direct3D API, except applied to the tile mapping data structure itself (which in hardware is a page table). The absence of the D3D11_TILE_MAPPING_NO_OVERWRITE value requires that tile mapping updates that CopyTileMappings specifies must be completed before any subsequent Direct3D command can proceed.

-returns

Type: HRESULT

Returns S_OK if successful; otherwise, returns one of the following:

  • Returns E_INVALIDARG if various conditions such as invalid flags or passing in non Tiled Resources result in the call being dropped. The dest and the source regions must each entirely fit in their resource or behavior is undefined (debug layer will emit an error).
  • Returns E_OUTOFMEMORY if the call results in the driver having to allocate space for new page table mappings but running out of memory. If out of memory occurs when this is called in a commandlist and the commandlist is being executed, the device will be removed. Applications can avoid this situation by only doing update calls that change existing mappings from Tiled Resources within commandlists (so drivers will not have to allocate page table memory, only change the mapping).

-remarks

CopyTileMappings helps with tasks such as shifting mappings around within and across tiled 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 temp location and then from there written to the destination.

For more info about tiled resources, see Tiled resources.

-see-also

ID3D11DeviceContext2