This is the documentation for Enlighten.

class Enlighten BaseProbeSet

class Enlighten::BaseProbeSet

    └>Geo::IGeoReleasable

Class used by the update manager to hold all of the resources for a probe set together.

This class is used as-is by the CPU and console update managers. Note that currently the update manager system can only solve whole probe sets at once - there is not yet any mechanism for solving only subsets.

Functions

Name Description
GetUpdateMarker()

Get the current value of the update marker. The marker changes every time the probe set is updated.

Release()

Free this object that was created within the Enlighten libraries.

Release()

Free this object that was created within the Enlighten libraries.

SetBakedOutput(const BakedProbeOutputInfo &)

Property-setting functions which can be enqueued with EnqueueSetObjectParameter.

SetBakedOutputMultiplier(float)

Property-setting functions which can be enqueued with EnqueueSetObjectParameter.

SetEmissiveEnvironment(Geo::GeoGuid)

Property-setting functions which can be enqueued with EnqueueSetObjectParameter.

SetFramesPerUpdate(Geo::s32)

Property-setting functions which can be enqueued with EnqueueSetObjectParameter.

SetFramesPerUpdateForLod(Geo::s32, Geo::s32)

Property-setting functions which can be enqueued with EnqueueSetObjectParameter.

SetFramesPerUpdateForLod(Geo::GeoPair< Geo::s32, Geo::s32 >)

Property-setting functions which can be enqueued with EnqueueSetObjectParameter.

SetLod(Geo::s32)

Property-setting functions which can be enqueued with EnqueueSetObjectParameter.

SetTemporalCoherenceThreshold(float)

Property-setting functions which can be enqueued with EnqueueSetObjectParameter.

SetUpdateCounter(Geo::s32)

Property-setting functions which can be enqueued with EnqueueSetObjectParameter.


Geo::u32 Enlighten::BaseProbeSet::GetUpdateMarker


public: Geo::u32 GetUpdateMarker() const


Get the current value of the update marker. The marker changes every time the probe set is updated.


virtual void Enlighten::BaseProbeSet::Release


protected: virtual void Release()


Free this object that was created within the Enlighten libraries.

Expect this to behave in a similar way to calling 'delete(this)'


virtual void Geo::IGeoReleasable::Release


public: void Release()


Free this object that was created within the Enlighten libraries.

Expect this to behave in a similar way to calling 'delete(this)'


void Enlighten::BaseProbeSet::SetBakedOutput


public: void SetBakedOutput
(
    const BakedProbeOutputInfo & bakeInfo
)


Property-setting functions which can be enqueued with EnqueueSetObjectParameter.


void Enlighten::BaseProbeSet::SetBakedOutputMultiplier


public: void SetBakedOutputMultiplier
(
    float bakeMultiplier
)


Property-setting functions which can be enqueued with EnqueueSetObjectParameter.


void Enlighten::BaseProbeSet::SetEmissiveEnvironment


public: void SetEmissiveEnvironment
(
    Geo::GeoGuid id
)


Property-setting functions which can be enqueued with EnqueueSetObjectParameter.


void Enlighten::BaseProbeSet::SetFramesPerUpdate


public: void SetFramesPerUpdate
(
    Geo::s32 f
)


Property-setting functions which can be enqueued with EnqueueSetObjectParameter.


void Enlighten::BaseProbeSet::SetFramesPerUpdateForLod


public: void SetFramesPerUpdateForLod
(
    Geo::s32 f,
    Geo::s32 relativeLod
)


Property-setting functions which can be enqueued with EnqueueSetObjectParameter.


void Enlighten::BaseProbeSet::SetFramesPerUpdateForLod


public: void SetFramesPerUpdateForLod
(
    Geo::GeoPair< Geo::s32, Geo::s32 > p
)


Property-setting functions which can be enqueued with EnqueueSetObjectParameter.


void Enlighten::BaseProbeSet::SetLod


public: void SetLod
(
    Geo::s32 lod
)


Property-setting functions which can be enqueued with EnqueueSetObjectParameter.


void Enlighten::BaseProbeSet::SetTemporalCoherenceThreshold


public: void SetTemporalCoherenceThreshold
(
    float t
)


Property-setting functions which can be enqueued with EnqueueSetObjectParameter.


void Enlighten::BaseProbeSet::SetUpdateCounter


public: void SetUpdateCounter
(
    Geo::s32 c
)


Property-setting functions which can be enqueued with EnqueueSetObjectParameter.