Versions Compared

Key

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

class Enlighten::ILightTransportOutput

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

An interface for diagnosing the quality and any issues with the light transport process in EnlightenPrecomp2.

Functions

NameDescription
Create()

Creates a new ILightTransportOutput.

GetBackFaceTolerance()

Return the percentage of rays that must hit front faces used for this system.

GetFinalSystemDependencies()

Returns the final dependencies, systems that are referenced in the final form factors.

GetHasRayOriginData()

Return whether the output contains ray origin data.

GetLightTransportPixel(Geo::s32)

Retrieve an output pixel. The index is in the range [0;GetNumPixels()-1].

GetLOD(Geo::s32)

Terrain LOD access.

GetNumFinalSystemDependencies()

Returns the number of systems in the final dependecies list.

GetNumLODs()

Terrain LOD access.

GetNumPixels()

Number of output pixels in the system.

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.


Anchor
a5350e1d2a19dc28d12dd45ecf8b5a7f9
a5350e1d2a19dc28d12dd45ecf8b5a7f9

static ILightTransportOutput* Enlighten::ILightTransportOutput::Create

...

public: ILightTransportOutput * Create()

...

Creates a new ILightTransportOutput.


Anchor
a13a81edaa354dfe849915cca88dafbe0
a13a81edaa354dfe849915cca88dafbe0

virtual float Enlighten::ILightTransportOutput::GetBackFaceTolerance

...

public: float GetBackFaceTolerance() const

...

Return the percentage of rays that must hit front faces used for this system.


Anchor
a97d7fc000f4848c2e34b22081d6aaff1
a97d7fc000f4848c2e34b22081d6aaff1

virtual const Geo::GeoGuid* Enlighten::ILightTransportOutput::GetFinalSystemDependencies

...

public: const Geo::GeoGuid * GetFinalSystemDependencies() const

...

Returns the final dependencies, systems that are referenced in the final form factors.


Anchor
a31c04bebffc76f5f57007213677219b7
a31c04bebffc76f5f57007213677219b7

virtual bool Enlighten::ILightTransportOutput::GetHasRayOriginData

...

public: bool GetHasRayOriginData() const

...

Return whether the output contains ray origin data.


Anchor
a7f0aa63f50563d45bab5278723c57bb9
a7f0aa63f50563d45bab5278723c57bb9

virtual const LightTransportPixel* Enlighten::ILightTransportOutput::GetLightTransportPixel

...

public: const LightTransportPixel * GetLightTransportPixel
(
    Geo::s32 pixelIdx
) const

...

Retrieve an output pixel. The index is in the range [0;GetNumPixels()-1].


Anchor
a9c825c852f1d4a9532fb206550aeaf37
a9c825c852f1d4a9532fb206550aeaf37

virtual const ILightTransportOutput* Enlighten::ILightTransportOutput::GetLOD

...

public: const ILightTransportOutput * GetLOD
(
    Geo::s32 lodIndex
) const

...

Terrain LOD access.


Anchor
ab25d58b73a3445b42aef9c0316d6a5f2
ab25d58b73a3445b42aef9c0316d6a5f2

virtual Geo::s32 Enlighten::ILightTransportOutput::GetNumFinalSystemDependencies

...

public: Geo::s32 GetNumFinalSystemDependencies() const

...

Returns the number of systems in the final dependecies list.


Anchor
ad6874bba4c5a6ce0dd06c10aaf0828b3
ad6874bba4c5a6ce0dd06c10aaf0828b3

virtual Geo::s32 Enlighten::ILightTransportOutput::GetNumLODs

...

public: Geo::s32 GetNumLODs() const

...

Terrain LOD access.


Anchor
ad75922dfa0637a4d86a888d24884adef
ad75922dfa0637a4d86a888d24884adef

virtual Geo::s32 Enlighten::ILightTransportOutput::GetNumPixels

...

public: Geo::s32 GetNumPixels() const

...

Number of output pixels in the system.


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.