class Enlighten IPrecompProbeSetBuildParameters

This is the documentation for Enlighten.

class Enlighten IPrecompProbeSetBuildParameters

class Enlighten::IPrecompProbeSetBuildParameters

A class defining parameters for SH sample probe building.

Functions

Name

Description

Name

Description

GetBudget()

The number of form factors to store per output sample.

GetCoefficientBasisX()

The basis vectors for the probe coefficients.

GetCoefficientBasisY()

The basis vectors for the probe coefficients.

GetCoefficientBasisZ()

The basis vectors for the probe coefficients.

GetCoefficientOrder()

The desired output order of the coefficients.

GetCullingThreshold()

Determines the threshold of valid visibility below which a point is culled.

GetDependencyIncludedSystemDistance()

Bounding box of the probe set (i.e. bounding box containing all the probes) whose dependencies are being calculated is.

GetDependencyLocalityDistance()

Maximum distance at which a given system will be considered local.

GetDependencyVisibilityThreshold()

Do not consider a system as a dependency if its visibility is smaller than the threshold.

GetEnvironmentResolution()

The resolution for each face of the environment map.

GetErrorThreshold()

Determines the threshold of interpolation error below which a point may be removed.

GetExcludeEnvironmentInPrimaryBounce()

Whether to exclude environment when solving the probes directly.

GetIndividualProbes()

Whether to treat the probes in this set entirely individually, and disable optimisations in the EntireProbeSetSolver which share data between probes.

GetNumEnvironmentVisibilitySHCoefficients()

The number of SH coefficients used for environment visibility.

GetNumSHCoefficients()

The number of SH coefficients used.

GetQuality()

The number of rays to cast for computing form factors.

GetUseCulling()

Whether to cull probes that are not in valid locations.

GetVisibilityThreshold()

The necessary visibility of a cluster to be used as form factor.

SetBudget(Geo::s32)

The number of form factors to store per output sample.

SetCoefficientBasis(const Geo::v128 &, const Geo::v128 &, const Geo::v128 &)

The basis vectors for the probe coefficients.

SetCoefficientOrder(const Geo::s8 *)

The desired output order of the coefficients.

SetCullingThreshold(float)

Determines the threshold of valid visibility below which a point is culled.

SetDependencyIncludedSystemDistance(float)

Bounding box of the probe set (i.e. bounding box containing all the probes) whose dependencies are being calculated is.

SetDependencyLocalityDistance(float)

Maximum distance at which a given system will be considered local.

SetDependencyVisibilityThreshold(float)

Do not consider a system as a dependency if its visibility is smaller than the threshold.

SetEnvironmentResolution(Geo::s32)

The resolution for each face of the environment map.

SetErrorThreshold(float)

Determines the threshold of interpolation error below which a point may be removed.

SetExcludeEnvironmentInPrimaryBounce(bool)

Whether to exclude environment when solving the probes directly.

SetIndividualProbes(bool)

Whether to treat the probes in this set entirely individually, and disable optimisations in the EntireProbeSetSolver which share data between probes.

SetNumEnvironmentVisibilitySHCoefficients(Geo::s32)

The number of SH coefficients used for environment visibility.

SetNumSHCoefficients(Geo::s32)

The number of SH coefficients used.

SetQuality(Geo::s32)

The number of rays to cast for computing form factors.

SetUseCulling(bool)

Whether to cull probes that are not in valid locations.

SetVisibilityThreshold(float)

The necessary visibility of a cluster to be used as form factor.