class Enlighten IPrecompBuildParameters

This is the documentation for Enlighten.

class Enlighten IPrecompBuildParameters

class Enlighten::IPrecompBuildParameters

A class containing various parameters and dials for the system level precompute process.

Variables

Name

Description

const Geo::s32 kShadowFaceBack = 0

Deprecated ShadowFace API.

const Geo::s32 kShadowFaceBoth = -1

Deprecated ShadowFace API.

const Geo::s32 kShadowFaceFront = 1

Deprecated ShadowFace API.

const Geo::s32 kShadowFaceUseMaterialAPI = -2

Deprecated ShadowFace API.

Functions

Name

Description

GetAlignedEdgeStitching()

Whether to use edge stitching.

GetBackFaceTolerance()

Whether to reject ray origins which can see any back face (if false, we only reject ray origins if they see nothing but back faces).

GetClusterSize()

The size of an input cluster.

GetClusterTolerance()

The strictness with which the geometry is voxelised during preclustering.

GetComputeRayOriginOutput()

General Debugging Options -------------------------------------------------- Whether to compute ray origin output during light transport.

GetCTDiv()

Number of children per node in the cluster hierarchy.

GetDefaultValues()

Returns a set of build parameters representing the defaults.

GetDependencyIncludedSystemDistance()

Bounding box of the system whose dependencies are being calculated is expanded by this distance in all directions.

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.

GetDirectionalIrradiance()

Whether to generate directional irradiance output.

GetDirectionalVisibilityDirectionsPerByte()

Number of visibility samples to store per byte for precomputed directional visibility.

GetDirectionalVisibilitySlices()

Number of vertical sphere slices for precomputed directional visibility storage.

GetEdgeStitching()

Whether to use edge stitching.

GetEdgeStitchingDistanceMultiplier()

Maximum distance between edges for them to be stitchable, as a multiple of output pixel size.

GetEnvironmentResolution()

The resolution for each face of the environment map.

GetExcludeEnvironmentInPrimaryBounce()

Whether to exclude the environment form factors from the rad core data which is used for solving to the lightmap.

GetGenerateClusterProbeSampleOffsets()

Whether to generate per cluster offsets for sampling probes.

GetHQVisWeight()

High quality clustering visibility weighting.

GetImportance()

A relative importance multiplier for this system in the global light transport step.

GetIrradianceBudget()

The number of form factors to store per irradiance output sample.

GetIrradiancePushOff()

Push off for irradiance form factor rays, in cm.

GetIrradianceQuality()

The number of rays to cast for computing irradiance form factors.

GetITBudget()

Maximum number of clustering iterations.

GetLCEpsilon()

Clustering iteration termination error threshold.

GetMaxSamples()

Maximum number of input samples for a system.

GetMaxSolutionSize()

The maximum size of an output system, in pixels.

GetMinSamples()

Minimum number of input samples for a system.

GetMinSolutionSize()

The minimum size of an output system, in pixels.

GetModellingTolerance()

Radius controlling how close ray origins can be to other geometry, in cm.

GetNSBudget()

Number of per-triangle visibility samples to use for computing triangle visibility and input sample visibility.

GetNumTerrainLODLevels()

If terrain LODs are being generated, specifies how many LODs to generate.

GetPixelStitching()

Whether to use pixel stitching.

GetPixelStitchingNormalDotProduct()

Maximum dot product of normals for pixels to be stitchable.

GetSafe16BitClustering()

High quality clustering visibility weighting.

GetSampleCullingThreshold()

Threshold controlling input (duster) sample culling behaviour.

GetSamplesPerCluster()

The number of input samples per cluster.