class Enlighten PppiWorld

This is the documentation for Enlighten.

class Enlighten PppiWorld

class Enlighten::PppiWorld

 

Updates output textures for all probe sets in the world.

Functions

Name

Description

Name

Description

AddProbeSet(const RadProbeSetCore *, const float *, void *)

Add a probe set to the world.

GetAtlasBlockCount()

Returns the number of blocks currently allocated within the atlas.

GetAtlasTileCount()

Returns the number of blocks currently allocated within the atlas.

GetProbeSetCount()

Return the number of probe sets added to the world.

GetRequiredOutputTextures(PppiConfiguration)

Returns the required textures. Always provide the same configuration to the constructor of PppiWorld.

PppiWorld(PppiConfiguration)

Construct with an optional configuration.

ProbeSetOutputChanged(PppiProbeSetHandle, PppiProbeSetLod)

Notify that the probe output changed for the given probe set.

RemoveProbeSet(PppiProbeSetHandle)

Remove a probe set from the world.

SetOutputWorkspace(const PppiOutputWorkspace &, IPppiTextureUpdateHandler *)

Use the provided output textures.

SetProbeSetStateHandler(IPppiProbeSetStateHandler *)

Use the provided probe set state callback.

Update(UpdatePppiStats &, const Geo::v128 &, const IViewVolumeIntersector *, float)

Update indirection texture based on the view origin.

UpdateBorder(const PppiIrradiance &)

Update the lighting for areas not covered by any probe set.



PppiProbeSetHandle Enlighten::PppiWorld::AddProbeSet


public: PppiProbeSetHandle AddProbeSet
(
    const RadProbeSetCore * probeSet,
    const float * probeOutput,
    void * userData
)


Add a probe set to the world.

 

Parameters

[in]

probeSet

The probe set to add

[in]

probeOutput

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

[in]

userData

User defined value passed to IPppiProbeSetStateHandler::ProbeSetStateChanged.

 



Geo::s32 Enlighten::PppiWorld::GetAtlasBlockCount


public: Geo::s32 GetAtlasBlockCount() const


Returns the number of blocks currently allocated within the atlas.

Use this to determine the appropriate size of the atlas.



Geo::s32 Enlighten::PppiWorld::GetAtlasTileCount


public: Geo::s32 GetAtlasTileCount() const