This is the documentation for Enlighten.
class Enlighten IBakeOutputProbeSet
class Enlighten::IBakeOutputProbeSet
└>Geo::IGeoSerialisable
└>Geo::IGeoReleasable
Baking output for a probe set.
Functions
| Name | Description |
|---|---|
| Create() | Create a new and empty IBakeOutputProbeSet. |
| Create(Geo::s32, Geo::s32) | Create a new IBakeOutputProbeSet for the given number of elements. |
| CreateU8Output(float, Geo::u8 *) | Get the probe values in U8 format. |
| GetMaxValue() | Retrieves the largest coefficient used in any probe. |
| GetNumElements() | Returns the number of elements in the output data. |
| GetNumProbes() | Returns the number of probes in the probe set. |
| GetOutput() | Get the probe values. |
| GetOutput() | Get the probe values. |
| GetShOrder() | Returns the SH order of 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. |
static IBakeOutputProbeSet* Enlighten::IBakeOutputProbeSet::Create
public: IBakeOutputProbeSet * Create()
Create a new and empty IBakeOutputProbeSet.
static IBakeOutputProbeSet* Enlighten::IBakeOutputProbeSet::Create
public: IBakeOutputProbeSet * Create
(
Geo::s32 shOrder,
Geo::s32 numProbes
)
Create a new IBakeOutputProbeSet for the given number of elements.
virtual void Enlighten::IBakeOutputProbeSet::CreateU8Output
public: void CreateU8Output
(
float scale,
Geo::u8 * output
) const
Get the probe values in U8 format.
Parameters
| [in] | scale | The scale to apply to the values to bring them into the range [0,1]. For example 1.0/GetMaxValue(). |
| [in] | output | Must refer to a block of memory at least GetNumElements() bytes in size. |
virtual float Enlighten::IBakeOutputProbeSet::GetMaxValue
public: float GetMaxValue() const
Retrieves the largest coefficient used in any probe.
virtual Geo::s32 Enlighten::IBakeOutputProbeSet::GetNumElements
public: Geo::s32 GetNumElements() const
Returns the number of elements in the output data.
virtual Geo::s32 Enlighten::IBakeOutputProbeSet::GetNumProbes
public: Geo::s32 GetNumProbes() const
Returns the number of probes in the probe set.
virtual const float* Enlighten::IBakeOutputProbeSet::GetOutput
public: const float * GetOutput() const
Get the probe values.
The data is owned by this object.
virtual float* Enlighten::IBakeOutputProbeSet::GetOutput
public: float * GetOutput()
Get the probe values.
The data is owned by this object.
virtual Geo::s32 Enlighten::IBakeOutputProbeSet::GetShOrder
public: Geo::s32 GetShOrder() const
Returns the SH order of the probe set.
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.