class Enlighten IBakeOutputProbeSet

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

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.