This is the documentation for Enlighten.

class Enlighten IBakeOutputSystemFinalGather

class Enlighten::IBakeOutputSystemFinalGather

    └>Geo::IGeoSerialisable
        └>Geo::IGeoReleasable

Baking output for indirect lighting from Final Gather.

Functions

Name Description
Create()

Create a new IBakeOutputSystemFinalGather.

GetDirectionalIrradianceTexture()

Get the baked directional irradiance into a Geo::GeoFp16Texture texture.

GetErrorDirectionalityTexture(Geo::s32)

Get the error estimate of a directional baking result into a Geo::GeoFp16Texture texture.

GetErrorTexture()

Get the error estimate of the baking result into a Geo::GeoFp16Texture texture.

GetFullName()

Get the lightmap name.

GetOutputDirectionalityTexture(Geo::s32)

Get the directional result of the baking into an array of floats (X * Y * 4 values).

GetOutputTexture()

Get the result of the baking into a Geo::GeoFp16Texture texture.

Load(IGeoInputStream &, Geo::u32)

Load an instance of this class from an IGeoInputStream.

Release()

Free this object that was created within the Enlighten libraries.

Save(IGeoStream &, Geo::u32)

Save an instance of this class to an IGeoStream.


static IBakeOutputSystemFinalGather* Enlighten::IBakeOutputSystemFinalGather::Create


public: IBakeOutputSystemFinalGather * Create()


Create a new IBakeOutputSystemFinalGather.


virtual Geo::GeoFp16Texture* Enlighten::IBakeOutputSystemFinalGather::GetDirectionalIrradianceTexture


public: Geo::GeoFp16Texture * GetDirectionalIrradianceTexture() const


Get the baked directional irradiance into a Geo::GeoFp16Texture texture.

Each pixel encodes the dominant direction in the RGB components and the rebalancing coefficient inthe A component. Note that the dominant direction is stored as a vector, i.e. its components lie in the [-1,1] interval. This differs to the real-time directional irradiance output, which encodes the [-1,1] interval into the 8-bit range of values in [0,255].


virtual Geo::GeoFp16Texture* Enlighten::IBakeOutputSystemFinalGather::GetErrorDirectionalityTexture


public: Geo::GeoFp16Texture * GetErrorDirectionalityTexture
(
    Geo::s32 index
) const


Get the error estimate of a directional baking result into a Geo::GeoFp16Texture texture.


virtual Geo::GeoFp16Texture* Enlighten::IBakeOutputSystemFinalGather::GetErrorTexture


public: Geo::GeoFp16Texture * GetErrorTexture() const


Get the error estimate of the baking result into a Geo::GeoFp16Texture texture.


virtual const char* Enlighten::IBakeOutputSystemFinalGather::GetFullName


public: const char * GetFullName() const


Get the lightmap name.


virtual Geo::GeoFp16Texture* Enlighten::IBakeOutputSystemFinalGather::GetOutputDirectionalityTexture


public: Geo::GeoFp16Texture * GetOutputDirectionalityTexture
(
    Geo::s32 index
) const


Get the directional result of the baking into an array of floats (X * Y * 4 values).


virtual Geo::GeoFp16Texture* Enlighten::IBakeOutputSystemFinalGather::GetOutputTexture


public: Geo::GeoFp16Texture * GetOutputTexture() const


Get the result of the baking into a Geo::GeoFp16Texture texture.


virtual bool Geo::IGeoSerialisable::Load


public: bool Load
(
    IGeoInputStream & stream,
    Geo::u32 section
)


Load an instance of this class from an IGeoInputStream.

The stream must be ready to read from. You can load sections of an object by passing a bitmask representing the desired sections rather than Iff::AllSectionsMask, which will load all sections. It is also safe to call this method on an object multiple times with different section arguments to load multiple parts.


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)'


virtual bool Geo::IGeoSerialisable::Save


public: bool Save
(
    IGeoStream & stream,
    Geo::u32 section
) const


Save an instance of this class to an IGeoStream.

The stream must be ready to write to. You can save sections of an object by passing a bitmask representing the desired sections rather than Iff::AllSectionsMask, which will save all sections that are available.