//filament-android/com.google.android.filament/View/FogOptions

FogOptions

[main]
open class FogOptions

Options to control large-scale fog in the scene. Materials can enable the linearFog property, which uses a simplified, linear equation for fog calculation; in this mode, the heightFalloff is ignored as well as the mipmap selection in IBL or skyColor mode.

Constructors

FogOptions	[main]
constructor()

Properties

Name	Summary
color	[main]
open var color: Array<Float>
Fog's color is used for ambient light in-scattering, a good value is to use the average of the ambient light, possibly tinted towards blue for outdoors environments.
cutOffDistance	[main]
open var cutOffDistance: Float
Distance in world units [m] after which the fog calculation is disabled.
density	[main]
open var density: Float
Extinction factor in [1/m] at an altitude 'height'.
distance	[main]
open var distance: Float
Distance in world units [m] from the camera to where the fog starts ( >= 0.
enabled	[main]
open var enabled: Boolean
Enable or disable large-scale fog
fogColorFromIbl	[main]
open var fogColorFromIbl: Boolean
The fog color will be sampled from the IBL in the view direction and tinted by color.
height	[main]
open var height: Float
Fog's floor in world units [m].
heightFalloff	[main]
open var heightFalloff: Float
How fast the fog dissipates with the altitude.
inScatteringSize	[main]
open var inScatteringSize: Float
Very inaccurately simulates the Sun's in-scattering.
inScatteringStart	[main]
open var inScatteringStart: Float
Distance in world units [m] from the camera where the Sun in-scattering starts.
maximumOpacity	[main]
open var maximumOpacity: Float
fog's maximum opacity between 0 and 1.
skyColor	[main]
open var skyColor: Texture
skyTexture must be a mipmapped cubemap.