class ShadowMapAtlas

The FidelityFX Cauldron Framework shadow map atlas representation.

File location: framework/cauldron/framework/inc/render/shadowmapresourcepool.h

Construction

Return type

Description

ShadowMapAtlas (uint32_t size, Texture * pRenderTarget)
Construction. Takes a texture to add to the atlast and it’s size (squared).

Methods

Return type

Description

const Texture *

Returns the atlas’s render target “Texture“.

Cell

GetCell (int32_t index) const
Returns the “Cell“ information for the atlas cell corresponding to the requested index.

int32_t

FindBestCell (uint32_t size) const
Returns an index to a cell that can hold the requested size of texture, or -1 if none was found.

int32_t

AllocateCell (uint32_t size, int32_t index)
Allocates a new sub-cell of specified size into the index-defined cell in the shadow atlas.

void

FreeCell (int32_t index)
Frees the specified cell.

Detailed description

The FidelityFX Cauldron Framework shadow map atlas representation.

Construction

ShadowMapAtlas

Copied!

ShadowMapAtlas (uint32_t size, Texture * pRenderTarget)

Construction. Takes a texture to add to the atlast and it’s size (squared).


Methods

GetRenderTarget

Copied!

const Texture * GetRenderTarget () const

Returns the atlas’s render target Texture.


GetCell

Copied!

Cell  GetCell (int32_t index) const

Returns the Cell information for the atlas cell corresponding to the requested index.


FindBestCell

Copied!

int32_t FindBestCell (uint32_t size) const

Returns an index to a cell that can hold the requested size of texture, or -1 if none was found.


AllocateCell

Copied!

int32_t AllocateCell (uint32_t size, int32_t index)

Allocates a new sub-cell of specified size into the index-defined cell in the shadow atlas.


FreeCell

Copied!

void FreeCell (int32_t index)

Frees the specified cell.