Versions Compared

Key

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

class Enlighten::IBakeInputRuntime

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

The Enlighten runtime objects; RadDataCore, InputWorkspace, et al.

Functions

NameDescription
AddProbeSet(RadProbeSetCore *, CpuEnvironment *, const IPrecompOutputProbeSet *)

Adds an Enlighten probeset to the runtime solver.

AddSystem(RadSystemCore *, IPrecompRadiosityNormalTexture *, CpuEnvironment *, InputWorkspace *, ClusterAlbedoWorkspaceMaterialData *)

Adds an Enlighten system to the runtime solver.

Create()

Create a new IBakeInputRuntime.

Load(IGeoInputStream &, Geo::u32)

Load an instance of this class from an IGeoInputStream.

NonCopyable(NonCopyable &&)

Defaulted to allow move.

operator=(NonCopyable &&)

Defaulted to allow move.

Release()

Free this object that was created within the Enlighten libraries.

Save(IGeoStream &, Geo::u32)

Save an instance of this class to an IGeoStream.

SetBounceScale(float)

Set the bounce scale used during the indirect lighting calculation based on the runtime data.

SetDefaultEnvironment(CpuEnvironment *)

Adds an emissive environment to the light input. Takes ownership.


Anchor
a04a7966b22170c2d78cf402324cab7f5
a04a7966b22170c2d78cf402324cab7f5

virtual bool Enlighten::IBakeInputRuntime::AddProbeSet

...

public: bool AddProbeSet
(
    RadProbeSetCore * probeSet,
    CpuEnvironment * environment,
    const IPrecompOutputProbeSet * pOutputProbeSet
)

...

Adds an Enlighten probeset to the runtime solver.

Takes ownership.

Parameters
[in]probeSet

RadProbeSetCore that contains the precomputed data for the probe set

[in]environment

Environment map to be used by probe set

[in]pOutputProbeSet

IPrecompOutputProbeSet for the probe set created during the precompute


Anchor
a85bb518764e610d64c8c78d2cc015558
a85bb518764e610d64c8c78d2cc015558

virtual bool Enlighten::IBakeInputRuntime::AddSystem

...

public: bool AddSystem
(
    RadSystemCore * radCore,
    IPrecompRadiosityNormalTexture * normalTexture,
    CpuEnvironment * environment,
    InputWorkspace * inputWorkspace,
    ClusterAlbedoWorkspaceMaterialData * cawMaterialData
)

...

Adds an Enlighten system to the runtime solver.

Takes ownership.

Parameters
[in]radCore

RadSystemCore that contains the precomputed data for the system

[in]normalTexture

Radiosity normal texture to be used by system

[in]environment

Environment map to be used by system

[in]inputWorkspace

InputWorkspace to use for system

[in]cawMaterialData

Material data to use for system


Anchor
ad9ebee57d287ac5b6cb4a186d5ef0147
ad9ebee57d287ac5b6cb4a186d5ef0147

static IBakeInputRuntime* Enlighten::IBakeInputRuntime::Create

...

public: IBakeInputRuntime * Create()

...

Create a new IBakeInputRuntime.


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
adaed81b4c59f263dcb4e78c4126f4683
adaed81b4c59f263dcb4e78c4126f4683

Geo::NonCopyable::NonCopyable

...

public: NonCopyable
(
    NonCopyable &&
)

...

Defaulted to allow move.


Anchor
a6abc781e23b8f4864e0b868806e0acbf
a6abc781e23b8f4864e0b868806e0acbf

NonCopyable& Geo::NonCopyable::operator=

...

public: NonCopyable & operator=
(
    NonCopyable &&
)

...

Defaulted to allow move.


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.


Anchor
aefd33947edda411900dcad7be6b159b3
aefd33947edda411900dcad7be6b159b3

virtual bool Enlighten::IBakeInputRuntime::SetBounceScale

...

public: bool SetBounceScale
(
    float bounceScale
)

...

Set the bounce scale used during the indirect lighting calculation based on the runtime data.

The bounce scale needs to be a value in the range [0..1] otherwise it is not set and this function returns false.


Anchor
a6aec5999e9b6d7e4d8f6cdf1f0b04a90
a6aec5999e9b6d7e4d8f6cdf1f0b04a90

virtual bool Enlighten::IBakeInputRuntime::SetDefaultEnvironment

...

public: bool SetDefaultEnvironment
(
    CpuEnvironment * environment
)

...

Adds an emissive environment to the light input. Takes ownership.