class Enlighten::IPrecompCubeMapBuildParameters
Precompute parameters for cube maps.
Please see the Technical Guide in the main SDK document for full documentation of these parameters and their use.
Functions
Name | Description |
---|---|
GetBudget() | The number of form factors to store per output sample. |
GetDependencyIncludedSystemDistance() | Bounding box (-this distance; +this distance) in all directions is created around the location of the cube map. |
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. |
GetQuality() | The number of rays to cast for computing form factors. |
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. |
SetDependencyIncludedSystemDistance(float) | Bounding box (-this distance; +this distance) in all directions is created around the location of the cube map. |
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. |
SetQuality(Geo::s32) | The number of rays to cast for computing form factors. |
SetVisibilityThreshold(float) | The necessary visibility of a cluster to be used as form factor. |
virtual Geo::s32 Enlighten::IPrecompCubeMapBuildParameters::GetBudget
public: Geo::s32 GetBudget() const
The number of form factors to store per output sample.
virtual float Enlighten::IPrecompCubeMapBuildParameters::GetDependencyIncludedSystemDistance
public: float GetDependencyIncludedSystemDistance() const
Bounding box (-this distance; +this distance) in all directions is created around the location of the cube map.
All systems whose bounding boxes intersect this created bounding box will be fully represented in ray tracing when calculating dependencies. Other systems will be represented as bounding boxes only.
virtual float Enlighten::IPrecompCubeMapBuildParameters::GetDependencyLocalityDistance
public: float GetDependencyLocalityDistance() const
Maximum distance at which a given system will be considered local.
virtual float Enlighten::IPrecompCubeMapBuildParameters::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 Geo::s32 Enlighten::IPrecompCubeMapBuildParameters::GetEnvironmentResolution
public: Geo::s32 GetEnvironmentResolution() const
The resolution for each face of the environment map.
virtual Geo::s32 Enlighten::IPrecompCubeMapBuildParameters::GetQuality
public: Geo::s32 GetQuality() const
The number of rays to cast for computing form factors.
virtual float Enlighten::IPrecompCubeMapBuildParameters::GetVisibilityThreshold
public: float GetVisibilityThreshold() const
The necessary visibility of a cluster to be used as form factor.
virtual void Enlighten::IPrecompCubeMapBuildParameters::SetBudget
public: void SetBudget
(
Geo::s32 budget
)
The number of form factors to store per output sample.
virtual void Enlighten::IPrecompCubeMapBuildParameters::SetDependencyIncludedSystemDistance
public: void SetDependencyIncludedSystemDistance
(
float v
)
Bounding box (-this distance; +this distance) in all directions is created around the location of the cube map.
All systems whose bounding boxes intersect this created bounding box will be fully represented in ray tracing when calculating dependencies. Other systems will be represented as bounding boxes only.
virtual void Enlighten::IPrecompCubeMapBuildParameters::SetDependencyLocalityDistance
public: void SetDependencyLocalityDistance
(
float v
)
Maximum distance at which a given system will be considered local.
virtual void Enlighten::IPrecompCubeMapBuildParameters::SetDependencyVisibilityThreshold
public: void SetDependencyVisibilityThreshold
(
float v
)
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 void Enlighten::IPrecompCubeMapBuildParameters::SetEnvironmentResolution
public: void SetEnvironmentResolution
(
Geo::s32 v
)
The resolution for each face of the environment map.
virtual void Enlighten::IPrecompCubeMapBuildParameters::SetQuality
public: void SetQuality
(
Geo::s32 quality
)
The number of rays to cast for computing form factors.
virtual void Enlighten::IPrecompCubeMapBuildParameters::SetVisibilityThreshold
public: void SetVisibilityThreshold
(
float visibilityThreshold
)
The necessary visibility of a cluster to be used as form factor.