class Enlighten PppiManager

This is the documentation for Enlighten.

class Enlighten PppiManager

class Enlighten::PppiManager

Class that manages the various resources needed for octree probe interpolation.

Notably: The auxiliary data for probe sets that need to be written to the atlas The atlas of probe sets The indirection map referencing the atlas

Functions

Name

Description

Name

Description

AddProbeSet(const Enlighten::RadProbeSetCore *, float *)

Adds a probe set to the PppiManager.

BeginUpdate()

Must be called before updates to the PppiManager, including adding/removing/updating probe sets and moving the view origin.

BeginUpdate(const PppiIrradiance &)

Must be called before updates to the PppiManager, including adding/removing/updating probe sets and moving the view origin.

EndUpdate()

Call this after all updates to the PppiManager are complete at the end of the frame. /.

GetAtlasNumAllocatedBlocks()

Get the number of blocks currently allocated within the atlas.

GetAtlasTextureSize()

Gets the edge length of the atlas 3D volume texture.

GetIndirectionClipmapOrigin()

Gets the world-space quantised origin of the indirection clipmap.

GetVoxelSize()

Get voxel size.

HasProbeSet(const Enlighten::RadProbeSetCore *)

Checks whether a probe set is part of the PppiManager.

Init(const PppiOutputWorkspace &)

Initialises the PppiManager with the given textures.

RemoveProbeSet(const Enlighten::RadProbeSetCore *)

Removes a probe set from the PppiManager.

SetViewOrigin(const Geo::v128 &)

Sets the viewer's origin in the world.

UpdateProbeSet(const Enlighten::RadProbeSetCore *, Geo::s32, bool, UpdatePppiAtlasStats &)

Updates a probe set, writing its values to the Atlas.



void Enlighten::PppiManager::AddProbeSet


public: void AddProbeSet
(
    const Enlighten::RadProbeSetCore * probeSet,
    float * ProbeOutput
)


Adds a probe set to the PppiManager.

 

Parameters

[in]

probeSet

The probe set to add

[in]

ProbeOutput

The output buffer where this probe set's values will be written

 



void Enlighten::PppiManager::BeginUpdate


public: void BeginUpdate()


Must be called before updates to the PppiManager, including adding/removing/updating probe sets and moving the view origin.



void Enlighten::PppiManager::BeginUpdate


public: void BeginUpdate
(
    const PppiIrradiance & border
)