This is the documentation for Enlighten.

struct Enlighten PppiConfiguration

struct Enlighten::PppiConfiguration

PppiConfiguration.

Enums

Name Description
AtlasResolution

The available resolutions for the atlas.

Variables

Name Description
AtlasResolution m_AtlasResolution

The resolution of each atlas slice, in tiles.

Geo::u32 m_AtlasSize

The number of slices in the atlas. Each slice contains 64x64 tiles, 192x192 texels.

bool m_DoubleLodDistance

When true, double the distance at which a given probe LOD is available.

Geo::u32 m_MaxProbeSets

The maximum number of concurrently added probe sets. 8 bytes allocated per probe set. Default 65536 = 512KB.

Geo::u32 m_ResolutionBias

The highest resolution required in the PPPI clipmap.

PppiAtlasFootprint::TileDistribution m_TileDistribution

The number of tiles in each atlas pool.

bool m_UseComputeUpdate

When true, updates are processed by IPppiComputeUpdateHandler.

const Geo::u32 MaxAtlasSize = 64

The maximum number of slices in the atlas.

Functions

Name Description
GetAtlasResolution()

Return the resolution of one slice in the atlas.

GetAtlasSize()

Return the number of slices in the atlas.

IsValid()

Return true if the configuration is valid.

PppiConfiguration(bool)

Constructor.


AtlasResolution


public: enum AtlasResolution
{
    AtlasResolution32 = 32,
    AtlasResolution64 = 64
}


The available resolutions for the atlas.

enumerators
AtlasResolution32
AtlasResolution64


AtlasResolution Enlighten::PppiConfiguration::GetAtlasResolution


public: AtlasResolution GetAtlasResolution() const


Return the resolution of one slice in the atlas.


Geo::u32 Enlighten::PppiConfiguration::GetAtlasSize


public: Geo::u32 GetAtlasSize() const


Return the number of slices in the atlas.

Print an error if the size is not valid


bool Enlighten::PppiConfiguration::IsValid


public: bool IsValid() const


Return true if the configuration is valid.


Enlighten::PppiConfiguration::PppiConfiguration


public: PppiConfiguration
(
    bool doubleLodDistance
)


Constructor.