Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

class Enlighten::IBakeSolvedRuntime

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

Interface for providing radiosity output for systems and probesets for baking.

The probe data is explicitly accessible for efficiently lighting dynamic objects.

Functions

NameDescription
Create()

Create a new IBakeSolvedRuntime.

GetSolvedProbe(Geo::GeoGuid, Geo::s32, float *)

Get the solved values of a probe, as floats.

GetSolvedProbeCompressed(Geo::GeoGuid, Geo::s32, float, Geo::u8 *)

Get the solved values of a probe, as chars.

GetSolvedProbePositions(Geo::GeoGuid)

Get the positions of the solved probes, as 4 component vectors.

GetSolvedProbeSet(Geo::GeoGuid)

Get the runtime data for the probe set.

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.


Anchor
a2f1c41d22050302d54b32439dd454a98
a2f1c41d22050302d54b32439dd454a98

static IBakeSolvedRuntime* Enlighten::IBakeSolvedRuntime::Create

...

public: IBakeSolvedRuntime * Create()

...

Create a new IBakeSolvedRuntime.


Anchor
a9b23d70d631b88a229e8c0c0ebfe52b7
a9b23d70d631b88a229e8c0c0ebfe52b7

virtual bool Enlighten::IBakeSolvedRuntime::GetSolvedProbe

...

public: bool GetSolvedProbe
(
    Geo::GeoGuid id,
    Geo::s32 idx,
    float * output
) const

...

Get the solved values of a probe, as floats.

Parameters
[in]id

The probe set id.

[in]idx

The index of the probe within the probeset.

[out]output

The output (SH_Order x 3 probe values) is written here.


Anchor
a2fbe00e6b9e2c182f509322f33831a52
a2fbe00e6b9e2c182f509322f33831a52

virtual bool Enlighten::IBakeSolvedRuntime::GetSolvedProbeCompressed

...

public: bool GetSolvedProbeCompressed
(
    Geo::GeoGuid id,
    Geo::s32 idx,
    float scale,
    Geo::u8 * output
) const

...

Get the solved values of a probe, as chars.

Parameters
[in]id

The probe set id.

[in]idx

The index of the probe within the probeset.

[in]scale

The maximum scale of the output (used to normalise from 0 to 255).

[out]output

The output (SH_Order x 3 probe values) is written here.


Anchor
a608559f6f19dd217bb15702fcd9823f8
a608559f6f19dd217bb15702fcd9823f8

virtual const Geo::v128* Enlighten::IBakeSolvedRuntime::GetSolvedProbePositions

...

public: const Geo::v128 * GetSolvedProbePositions
(
    Geo::GeoGuid id
) const

...

Get the positions of the solved probes, as 4 component vectors.

Parameters
[in]id

The probe set id.


Anchor
a5d48c94718390b9a4b52ae3e76d7a5d3
a5d48c94718390b9a4b52ae3e76d7a5d3

virtual const RadProbeSetCore* Enlighten::IBakeSolvedRuntime::GetSolvedProbeSet

...

public: const RadProbeSetCore * GetSolvedProbeSet
(
    Geo::GeoGuid id
) const

...

Get the runtime data for the probe set.

Parameters
[in]id

The probe set id.


Anchor
ae5fb810c8f4470cb3c9fcb16c6f7f7fe
ae5fb810c8f4470cb3c9fcb16c6f7f7fe

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.


Anchor
af6bdf30b42adde386c428e9dc2821eb9
af6bdf30b42adde386c428e9dc2821eb9

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


Anchor
a5b03439626a3dac9b9c27feb1a3978d3
a5b03439626a3dac9b9c27feb1a3978d3

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.