View.FogOptions (filament-android 1.21.1 API)

java.lang.Object
- com.google.android.filament.View.FogOptions

Enclosing class:

View
```
public static class View.FogOptions
extends java.lang.Object
```
Options to control fog in the scene

See Also:

View.setFogOptions(com.google.android.filament.View.FogOptions)

Field Summary

Fields
Modifier and Type	Field	Description
`float[]`	`color`	Fog's color as a linear RGB color.
`float`	`density`	fog's density at altitude given by 'height'
`float`	`distance`	distance in world units from the camera where the fog starts ( >= 0.0 )
`boolean`	`enabled`	enable or disable fog
`boolean`	`fogColorFromIbl`	fog color will be modulated by the IBL color in the view direction
`float`	`height`	fog's floor in world units
`float`	`heightFalloff`	how fast fog dissipates with altitude
`float`	`inScatteringSize`	size of in-scattering (>0 to activate).
`float`	`inScatteringStart`	distance in world units from the camera where in-scattering starts
`float`	`maximumOpacity`	fog's maximum opacity between 0 and 1

Constructor Summary

Constructors
Constructor Description

FogOptions()

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - distance
```
public float distance
```
    distance in world units from the camera where the fog starts ( >= 0.0 )
  - maximumOpacity
```
public float maximumOpacity
```
    fog's maximum opacity between 0 and 1
  - height
```
public float height
```
    fog's floor in world units
  - heightFalloff
```
public float heightFalloff
```
    how fast fog dissipates with altitude
  - color
```
@NonNull
@Size(min=3L)
public float[] color
```
    Fog's color as a linear RGB color.
  - density
```
public float density
```
    fog's density at altitude given by 'height'
  - inScatteringStart
```
public float inScatteringStart
```
    distance in world units from the camera where in-scattering starts
  - inScatteringSize
```
public float inScatteringSize
```
    size of in-scattering (>0 to activate). Good values are >> 1 (e.g. ~10 - 100)
  - fogColorFromIbl
```
public boolean fogColorFromIbl
```
    fog color will be modulated by the IBL color in the view direction
  - enabled
```
public boolean enabled
```
    enable or disable fog
- Constructor Detail
  - FogOptions
```
public FogOptions()
```