This is the documentation for Enlighten.
class Enlighten ILightTransportOutput
- William Joseph
- geosw (Unlicensed)
class Enlighten::ILightTransportOutput
└>Geo::IGeoSerialisable
└>Geo::IGeoReleasable
An interface for diagnosing the quality and any issues with the light transport process in EnlightenPrecomp2.
Functions
| Name | Description |
|---|---|
| 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. |
| 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 ILightTransportOutput* Enlighten::ILightTransportOutput::Create
public: ILightTransportOutput * Create()
Creates a new ILightTransportOutput.
virtual float Enlighten::ILightTransportOutput::GetBackFaceTolerance
public: float GetBackFaceTolerance() const
Return the percentage of rays that must hit front faces used for this system.
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.
virtual bool Enlighten::ILightTransportOutput::GetHasRayOriginData
public: bool GetHasRayOriginData() const
Return whether the output contains ray origin data.
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].
virtual const ILightTransportOutput* Enlighten::ILightTransportOutput::GetLOD
public: const ILightTransportOutput * GetLOD
(
Geo::s32 lodIndex
) const
Terrain LOD access.
virtual Geo::s32 Enlighten::ILightTransportOutput::GetNumFinalSystemDependencies
public: Geo::s32 GetNumFinalSystemDependencies() const
Returns the number of systems in the final dependecies list.
virtual Geo::s32 Enlighten::ILightTransportOutput::GetNumLODs
public: Geo::s32 GetNumLODs() const
Terrain LOD access.
virtual Geo::s32 Enlighten::ILightTransportOutput::GetNumPixels
public: Geo::s32 GetNumPixels() const
Number of output pixels in the system.
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.