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
Functions
Name | Description |
|---|---|
Whether to use edge stitching. | |
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). | |
The size of an input cluster. | |
The strictness with which the geometry is voxelised during preclustering. | |
General Debugging Options -------------------------------------------------- Whether to compute ray origin output during light transport. | |
Number of children per node in the cluster hierarchy. | |
Returns a set of build parameters representing the defaults. | |
Bounding box of the system whose dependencies are being calculated is expanded by this distance in all directions. | |
Maximum distance at which a given system will be considered local. | |
Do not consider a system as a dependency if its visibility is smaller than the threshold. | |
Whether to generate directional irradiance output. | |
Number of visibility samples to store per byte for precomputed directional visibility. | |
Number of vertical sphere slices for precomputed directional visibility storage. | |
Whether to use edge stitching. | |
Maximum distance between edges for them to be stitchable, as a multiple of output pixel size. | |
The resolution for each face of the environment map. | |
Whether to exclude the environment form factors from the rad core data which is used for solving to the lightmap. | |
Whether to generate per cluster offsets for sampling probes. | |
High quality clustering visibility weighting. | |
A relative importance multiplier for this system in the global light transport step. | |
The number of form factors to store per irradiance output sample. | |
Push off for irradiance form factor rays, in cm. | |
The number of rays to cast for computing irradiance form factors. | |
Maximum number of clustering iterations. | |
Clustering iteration termination error threshold. | |
Maximum number of input samples for a system. | |
The maximum size of an output system, in pixels. | |
Minimum number of input samples for a system. | |
The minimum size of an output system, in pixels. | |
Radius controlling how close ray origins can be to other geometry, in cm. | |
Number of per-triangle visibility samples to use for computing triangle visibility and input sample visibility. | |
If terrain LODs are being generated, specifies how many LODs to generate. | |
Whether to use pixel stitching. | |
Maximum dot product of normals for pixels to be stitchable. | |
High quality clustering visibility weighting. | |
Threshold controlling input (duster) sample culling behaviour. | |
The number of input samples per cluster. | |
Deprecated ShadowFace API. | |
Maximum distance between charts for them to be stitchable, as a multiple of output pixel size. | |
Maximum dot product of normals for charts to be stitchable. | |
Threshold controlling visibility-based cluster triangle culling behaviour. | |
The valid overhang distance for mesh projection. | |
Whether to disable viewsets. | |
Size of voxel grid to use for automatic viewsets, as a multiplier of (minimum) output pixel size. | |
The error allowed for reducing the number of form factors for each spherical output sample. | |
Load an instance of this class from an IGeoStream. | |
Whether to create "terrain" LODs. | |
If terrain LODs are being generated, specifies whether half a pixel padding should be added to final terrain system atlas. | |
Save an instance of this class to an IGeoStream. | |
Whether to use edge stitching. | |
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). | |
The size of an input cluster. | |
The strictness with which the geometry is voxelised during preclustering. | |
General Debugging Options -------------------------------------------------- Whether to compute ray origin output during light transport. | |
Number of children per node in the cluster hierarchy. | |
Bounding box of the system whose dependencies are being calculated is expanded by this distance in all directions. | |
Maximum distance at which a given system will be considered local. | |
Do not consider a system as a dependency if its visibility is smaller than the threshold. | |
Whether to generate directional irradiance output. | |
Number of visibility samples to store per byte for precomputed directional visibility. | |
Number of vertical sphere slices for precomputed directional visibility storage. | |
Whether to use edge stitching. | |
Maximum distance between edges for them to be stitchable, as a multiple of output pixel size. | |
The resolution for each face of the environment map. | |
Whether to exclude the environment form factors from the rad core data which is used for solving to the lightmap. | |
Whether to generate per cluster offsets for sampling probes. | |
High quality clustering visibility weighting. | |
A relative importance multiplier for this system in the global light transport step. | |
The number of form factors to store per irradiance output sample. | |
Push off for irradiance form factor rays, in cm. | |
The number of rays to cast for computing irradiance form factors. | |
Maximum number of clustering iterations. | |
Clustering iteration termination error threshold. | |
Maximum number of input samples for a system. | |
The maximum size of an output system, in pixels. | |
Minimum number of input samples for a system. | |
The minimum size of an output system, in pixels. | |
Radius controlling how close ray origins can be to other geometry, in cm. | |
Number of per-triangle visibility samples to use for computing triangle visibility and input sample visibility. | |
If terrain LODs are being generated, specifies how many LODs to generate. | |
Whether to use pixel stitching. | |
Maximum dot product of normals for pixels to be stitchable. | |
Whether to create "terrain" LODs. | |
If terrain LODs are being generated, specifies whether half a pixel padding should be added to final terrain system atlas. | |
Whether to enforce that clustering creates no more than 65535 clusters such that a cluster index will fit in an unsigned integer. | |
Threshold controlling input (duster) sample culling behaviour. | |
The number of input samples per cluster. | |
Deprecated ShadowFace API. | |
Maximum distance between charts for them to be stitchable, as a multiple of output pixel size. | |
Maximum dot product of normals for charts to be stitchable. | |
Threshold controlling visibility-based cluster triangle culling behaviour. | |
The valid overhang distance for mesh projection. | |
Whether to disable viewsets. | |
Size of voxel grid to use for automatic viewsets, as a multiplier of (minimum) output pixel size. | |
The error allowed for reducing the number of form factors for each spherical output sample. |
virtual bool Enlighten::IPrecompBuildParameters::GetAlignedEdgeStitching
public: bool GetAlignedEdgeStitching() const
Whether to use edge stitching.
virtual float Enlighten::IPrecompBuildParameters::GetBackFaceTolerance
public: float GetBackFaceTolerance() const
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).
virtual float Enlighten::IPrecompBuildParameters::GetClusterSize
public: float GetClusterSize() const
The size of an input cluster.
virtual float Enlighten::IPrecompBuildParameters::GetClusterTolerance
public: float GetClusterTolerance() const
The strictness with which the geometry is voxelised during preclustering.
virtual bool Enlighten::IPrecompBuildParameters::GetComputeRayOriginOutput
public: bool GetComputeRayOriginOutput() const
General Debugging Options -------------------------------------------------- Whether to compute ray origin output during light transport.
Ray origin output is useful for debugging radiosity issues. The default value is false.
virtual float Enlighten::IPrecompBuildParameters::GetCTDiv
public: float GetCTDiv() const
Number of children per node in the cluster hierarchy.
static const IPrecompBuildParameters* Enlighten::IPrecompBuildParameters::GetDefaultValues
public: const IPrecompBuildParameters * GetDefaultValues()
Returns a set of build parameters representing the defaults.
virtual float Enlighten::IPrecompBuildParameters::GetDependencyIncludedSystemDistance
public: float GetDependencyIncludedSystemDistance() const
Bounding box of the system whose dependencies are being calculated is expanded by this distance in all directions.
All systems whose bounding boxes intersect this expanded bounding box will be fully represented in ray tracing when calculating dependencies. Other systems will be represented as bounding boxes only.
virtual float Enlighten::IPrecompBuildParameters::GetDependencyLocalityDistance
public: float GetDependencyLocalityDistance() const
Maximum distance at which a given system will be considered local.
virtual float Enlighten::IPrecompBuildParameters::GetDependencyVisibilityThreshold
public: float GetDependencyVisibilityThreshold() const
Do not consider a system as a dependency if its visibility is smaller than the threshold.
Specify 0 to accept systems with any visibility.
virtual bool Enlighten::IPrecompBuildParameters::GetDirectionalIrradiance
public: bool GetDirectionalIrradiance() const
Whether to generate directional irradiance output.
virtual Geo::s32 Enlighten::IPrecompBuildParameters::GetDirectionalVisibilityDirectionsPerByte
public: Geo::s32 GetDirectionalVisibilityDirectionsPerByte() const
Number of visibility samples to store per byte for precomputed directional visibility.
The default value is 4 (2 bits per direction). Valid values are 1,2,4 and 8. 8 produces the best compression, 1 the best quality. 4 produces the best size / quality balance.
virtual Geo::s32 Enlighten::IPrecompBuildParameters::GetDirectionalVisibilitySlices
public: Geo::s32 GetDirectionalVisibilitySlices() const
Number of vertical sphere slices for precomputed directional visibility storage.
The number of sampled visibility directions will be roughly the square of this number. Defaults to 27 (875 sampled directions). Valid values range between 2 and 64.
virtual bool Enlighten::IPrecompBuildParameters::GetEdgeStitching
public: bool GetEdgeStitching() const
Whether to use edge stitching.
virtual float Enlighten::IPrecompBuildParameters::GetEdgeStitchingDistanceMultiplier
public: float GetEdgeStitchingDistanceMultiplier() const
Maximum distance between edges for them to be stitchable, as a multiple of output pixel size.
virtual Geo::s32 Enlighten::IPrecompBuildParameters::GetEnvironmentResolution
public: Geo::s32 GetEnvironmentResolution() const
The resolution for each face of the environment map.
virtual bool Enlighten::IPrecompBuildParameters::GetExcludeEnvironmentInPrimaryBounce
public: bool GetExcludeEnvironmentInPrimaryBounce() const
Whether to exclude the environment form factors from the rad core data which is used for solving to the lightmap.
virtual bool Enlighten::IPrecompBuildParameters::GetGenerateClusterProbeSampleOffsets
public: bool GetGenerateClusterProbeSampleOffsets() const
Whether to generate per cluster offsets for sampling probes.
virtual float Enlighten::IPrecompBuildParameters::GetHQVisWeight
public: float GetHQVisWeight() const
High quality clustering visibility weighting.
A value of 0 means that only position information is used for clustering, a value of 1 means only visibility information is used. Generally, a value close to 1 should be used..