This is the documentation for Enlighten.
class Enlighten IProbeSetManager
class Enlighten::IProbeSetManager
Probe Set Manager interface class.
Functions
Name | Description |
|---|---|
Get an interpolation set that corresponds to given index - this index needs to be comaptible with ProbeInterpolant::m_ProbeSetIndex filled by the GetProbeInterpolants(...) method. | |
GetLodRangeProbeInterpolants(Geo::v128 const &, ProbeInterpolant *, Geo::s32, Geo::u8 *, Geo::u32) | Retrieves the probes interpolants for a given point and specified range of LODs. |
Set a maximum interpolation weight for the given Probe Set. | |
Get the total number of Probe Sets under management. | |
GetProbeInterpolants(Geo::v128 const &, ProbeInterpolant *, Geo::s32, Geo::s32 &) | Retrieves the probes interpolants for a given point. |
GetProbeInterpolants(Geo::v128 const &, ProbeInterpolant *, Geo::s32, Geo::s32 &, Geo::u32) | Retrieves the probes interpolants for a given point and specified LOD. |
Marks all Interpolation Input Sets as unloaded. | |
MarkProbeSetAsLoaded(Enlighten::InterpolationInputSet const &) | Marks given Interpolation Input Set as loaded. |
Marks given Interpolation Input Set as unloaded. | |
OnAllLoadedProbeSetsArrayChanged(Enlighten::InterpolationInputSet const *, Geo::s32) | Allows the probe set manager a chance to observe the contiguous memory block in which the runtime stores all loaded input sets. |
Set a maximum interpolation weight for the given Probe Set. |
virtual Enlighten::InterpolationInputSet const* Enlighten::IProbeSetManager::GetInterpolationInputSet
public: Enlighten::InterpolationInputSet const * GetInterpolationInputSet
(
Geo::u32 index
) const
Get an interpolation set that corresponds to given index - this index needs to be comaptible with ProbeInterpolant::m_ProbeSetIndex filled by the GetProbeInterpolants(...) method.
May return NULL is Probe Set that corresponds to index is unloaded. Note, however that none of the ProbeInterpolant::m_ProbeSetIndex indices returned from GetProbeInterpolants(...) should correspond to an unloaded Probe Sets.
Returns
The InterpolationI Input Set for a given index or NULL if that Probe Set in unloaded.
virtual bool Enlighten::IProbeSetManager::GetLodRangeProbeInterpolants
public: virtual bool GetLodRangeProbeInterpolants
(
Geo::v128 const & point,
ProbeInterpolant * interpolants,
Geo::s32 numMaxInterpolants,
Geo::u8 * numUsedInterpolants,
Geo::u32 numLods
) const
Retrieves the probes interpolants for a given point and specified range of LODs.
Only loaded Probe Sets are considered for interpolation. This interface is only supported to enable Transparency and Contributing Probe when using Probe LOD with PPPI.
Parameters
[in] | point | Location used for the interpolation. |
[out] | interpolants | Output probe interpolants array with size numMaxInterpolants * numLods. |
[in] | numMaxInterpolants | Maximum number of interpolants that may be output for each LOD. |
[out] | numUsedInterpolants | Array to which is output the number of interpolants used for each LOD. |
[in] | numLods | The range of LODs [0, numLods) for which interpolants should be returned. |