Open 3D Engine Atom Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Public Attributes | List of all members
AZ::DX12::ImageTileLayout Struct Reference

#include <Image.h>

Public Member Functions

bool IsPacked (uint32_t subresourceIndex) const
 
uint32_t GetPackedSubresourceIndex () const
 
uint32_t GetTileOffset (uint32_t subresourceIndex) const
 
void GetSubresourceTileInfo (uint32_t subresourceIndex, uint32_t &imageTileOffset, D3D12_TILED_RESOURCE_COORDINATE &coordinate, D3D12_TILE_REGION_SIZE &regionSize) const
 

Public Attributes

RHI::Size m_tileSize
 
uint32_t m_tileCount = 0
 
uint32_t m_tileCountStandard = 0
 
uint32_t m_tileCountPacked = 0
 
uint32_t m_mipCount = 0
 
uint32_t m_mipCountStandard = 0
 
uint32_t m_mipCountPacked = 0
 
AZStd::vector< D3D12_SUBRESOURCE_TILING > m_subresourceTiling
 

Detailed Description

Contains the tiled resource layout for an image. More than one sub-resources can be packed into one or more tiles. The lowest N mips are typically packed into one or two tiles. The rest of the mips are considered 'standard' and are composed of one or more tiles.

Member Function Documentation

◆ GetSubresourceTileInfo()

void AZ::DX12::ImageTileLayout::GetSubresourceTileInfo ( uint32_t  subresourceIndex,
uint32_t &  imageTileOffset,
D3D12_TILED_RESOURCE_COORDINATE &  coordinate,
D3D12_TILE_REGION_SIZE &  regionSize 
) const

Given a subresource index, returns the tile offset of the subresource from the total image tile set. The coordinate and region size are used to describe how the tiles map to the source image. Packed mips are treated as a simple region of flat tiles.

The documentation for this struct was generated from the following file: