Renderer · interface

FogOptions

interface FogOptions

import type { FogOptions } from '@driftengine/core';

Properties

Name	Type	Description
`colour`readonly	`Rgb`
`density`readonly	`number`	Extinction per metre at the camera's own height, not at the base.
`heightFalloff`readonly	`number`	Reciprocal scale height of the haze, per metre. 0 is a uniform medium.
`eyeY`readonly	`number`	The camera's height, so a fragment's own height is one subtraction away.
`underwaterColour`readonly	`Rgb`
`underwaterDensity`readonly	`number`
`underwaterFactor`readonly	`number`
`mode`readonly	`number`	`MEDIUM_FOG` integrates a medium; `LINEAR_FOG` ramps between near and far.
`near`readonly	`number`	Where haze begins: the ramp's start in linear mode, and in the medium the distance along the ray it is integrated from (`Atmosphere.fogStart`), 0 at the camera.
`far`readonly	`number`