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 *, Geo::u64 *, void *, Geo::u8)

Add a probe set to the world.

GetAtlasTileCount()

Returns the number of tiles 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)

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

RemoveProbeSet(PppiProbeSetHandle)

Remove a probe set from the world.

SetProbeSetStateHandler(IPppiProbeSetStateHandler *)

Use the provided probe set state callback.

Update(UpdatePppiStats &, const Geo::v128 &, float, IPppiComputeUpdateHandler &, const PppiIrradiance16 *, Geo::u8)

Update indirection texture based on the view origin.

Update(UpdatePppiStats &, const Geo::v128 &, float, const PppiIrradiance16 *, IPppiComputeUpdateHandler *, Geo::u8)

Update indirection texture based on the view origin.



PppiProbeSetHandle Enlighten::PppiWorld::AddProbeSet


public: PppiProbeSetHandle AddProbeSet
(
    const RadProbeSetCore * probeSet,
    Geo::u64 * probeOutput,
    void * userData,
    Geo::u8 partition
)


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.

[in]

partition

The index of the partition containing this probe set.

 



Geo::s32 Enlighten::PppiWorld::GetAtlasTileCount


public: Geo::s32 GetAtlasTileCount() const


Returns the number of tiles currently allocated within the atlas.

Use this to determine the appropriate size of the atlas.



Geo::u32 Enlighten::PppiWorld::GetProbeSetCount


public: Geo::u32 GetProbeSetCount() const