module Interpolation

This is the documentation for Enlighten.

module Interpolation

Classes and functions for interpolating light probe data.

Classes

Name

Description

Name

Description

Enlighten::InterpolatedPoint

Data structure describing a point in space to receive interpolated probe output.

Enlighten::InterpolationInputSet

Data structure describing the inputs and outputs of a probe set to be used as input data for interpolation.

Enlighten::InterpolationInputSet::CachedData

Internal cached data.

Enlighten::ProbeInterpolant

Data structure identifying a probe and associated weight (influence) which forms part of a set to be interpolated.

Enlighten::ProbeInterpolationTask

Task describing a set of probe sets to be used as inputs for interpolation, and a set of points which require interpolated outputs.

Functions

Name

Description

Name

Description

DoProbeInterpolationTask(const Enlighten::ProbeInterpolationTask *, Geo::u32 &)

Performs an interpolation of SH coefficients for a given set of points in space and probe sets.

GetProbeInterpolants(Geo::v128, const InterpolationInputSet *, ProbeInterpolant *, Geo::s32, Geo::s32 &, Geo::u32)

Retrieves the probes interpolants for a given point for a single probe set.

GetProbeInterpolants(Geo::v128, const InterpolationInputSet *, Geo::s32, ProbeInterpolant *, Geo::s32, Geo::s32 &, Geo::u32)

Retrieves the probes interpolants for a given point for multiple probe set.

GetProbeInterpolantsUnchecked(Geo::v128, const InterpolationInputSet *, Geo::s32, ProbeInterpolant *, Geo::s32, Geo::s32 &, Geo::u32)

Retrieves the probes interpolants for a given point for multiple probe set, without performing any kind of validation on the input arguments.

GetProbeSetInterpolants(Geo::v128, const InterpolationInputSet *, Geo::s32, ProbeInterpolant *, Geo::s32, Geo::s32 &)

Retrieves the probe set interpolants for a given point.

GetProbeShCoefficients(Geo::v128, const InterpolationInputSet *, float *, float *, float *, eSHOrder)

Retrieves the interpolated light probe spherical harmonics coefficients for a point based on a single input probe set.

GetProbeShCoefficients(Geo::v128, const InterpolationInputSet *, Geo::s32, float *, float *, float *, eSHOrder)

Retrieves the interpolated light probe spherical harmonics coefficients for a point based on multiple input probe sets.



bool GEO_CALL Enlighten::DoProbeInterpolationTask


public: bool GEO_CALL DoProbeInterpolationTask
(
    const Enlighten::ProbeInterpolationTask * task,
    Geo::u32 & timeUs
)


Performs an interpolation of SH coefficients for a given set of points in space and probe sets.

All parameters must point to valid non-null objects.

 

Parameters

[in]

task

A valid pointer to the probe interpolation task structure.

[out]

timeUs

Number of microseconds it took to solve the task.

Returns

TRUE if the interpolation is successful.

 



bool GEO_CALL Enlighten::GetProbeInterpolants


public: bool GEO_CALL GetProbeInterpolants
(
    Geo::v128 point,
    const InterpolationInputSet * inputSet,
    ProbeInterpolant * interpolants,
    Geo::s32 numMaxInterpolants,
    Geo::s32 & numUsedInterpolants,
    Geo::u32 lod
)