Edit

ID3D11Device2::GetResourceTiling method (d3d11_2.h)

  • Article

Gets info about how a tiled resource is broken into tiles.

Syntax

void GetResourceTiling(
  [in]                ID3D11Resource           *pTiledResource,
  [out, optional]     UINT                     *pNumTilesForEntireResource,
  [out, optional]     D3D11_PACKED_MIP_DESC    *pPackedMipDesc,
  [out, optional]     D3D11_TILE_SHAPE         *pStandardTileShapeForNonPackedMips,
  [in, out, optional] UINT                     *pNumSubresourceTilings,
  [in]                UINT                     FirstSubresourceTilingToGet,
  [out]               D3D11_SUBRESOURCE_TILING *pSubresourceTilingsForNonPackedMips
);

Parameters

[in] pTiledResource

Type: ID3D11Resource*

A pointer to the tiled resource to get info about.

[out, optional] pNumTilesForEntireResource

Type: UINT*

A pointer to a variable that receives the number of tiles needed to store the entire tiled resource.

[out, optional] pPackedMipDesc

Type: D3D11_PACKED_MIP_DESC*

A pointer to a D3D11_PACKED_MIP_DESC structure that GetResourceTiling fills with info about how the tiled resource's mipmaps are packed.

[out, optional] pStandardTileShapeForNonPackedMips

Type: D3D11_TILE_SHAPE*

A pointer to a D3D11_TILE_SHAPE structure that GetResourceTiling fills with info about the tile shape. This is info about how pixels fit in the tiles, independent of tiled resource's dimensions, not including packed mipmaps. If the entire tiled resource is packed, this parameter is meaningless because the tiled resource has no defined layout for packed mipmaps. In this situation, GetResourceTiling sets the members of D3D11_TILE_SHAPE to zeros.

[in, out, optional] pNumSubresourceTilings

Type: UINT*

A pointer to a variable that contains the number of tiles in the subresource. On input, this is the number of subresources to query tilings for; on output, this is the number that was actually retrieved at pSubresourceTilingsForNonPackedMips (clamped to what's available).

[in] FirstSubresourceTilingToGet

Type: UINT

The number of the first subresource tile to get. GetResourceTiling ignores this parameter if the number that pNumSubresourceTilings points to is 0.

[out] pSubresourceTilingsForNonPackedMips

Type: D3D11_SUBRESOURCE_TILING*

A pointer to a D3D11_SUBRESOURCE_TILING structure that GetResourceTiling fills with info about subresource tiles.

If subresource tiles are part of packed mipmaps, GetResourceTiling sets the members of D3D11_SUBRESOURCE_TILING to zeros, except the StartTileIndexInOverallResource member, which GetResourceTiling sets to D3D11_PACKED_TILE (0xffffffff). The D3D11_PACKED_TILE constant indicates that the whole D3D11_SUBRESOURCE_TILING structure is meaningless for this situation, and the info that the pPackedMipDesc parameter points to applies.

Return value

None

Remarks

For more info about tiled resources, see Tiled resources.

Requirements

Requirement Value
Minimum supported client Windows 8.1 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 R2 [desktop apps | UWP apps]
Target Platform Windows
Header d3d11_2.h
Library D3D11.lib

See also

ID3D11Device2