Skip to main content

Fog

This class contains the parameters that define linear fog, i.e., that grows linearly denser with the distance.

Code Example

const scene = new THREE.Scene(); scene.fog = new THREE.Fog( 0xcccccc, 10, 15
);

Constructor

Fog

function Fog( color: Integer, near: Float, far: Float ): void;  

The color parameter is passed to the Color constructor to set the color property. Color can be a hexadecimal integer or a CSS-style string.

Properties

isFog

isFog: Boolean;  

Read-only flag to check if a given object is of type Fog.

name

name: String;  

Optional name of the object (doesn't need to be unique). Default is an empty string.

color

color: Color;  

Fog color. Example: If set to black, far away objects will be rendered black.

near

near: Float;  

The minimum distance to start applying fog. Objects that are less than 'near' units from the active camera won't be affected by fog.

Default is 1.

far

far: Float;  

The maximum distance at which fog stops being calculated and applied. Objects that are more than 'far' units away from the active camera won't be affected by fog.

Default is 1000.

Methods

clone

function clone( ): Fog;  

Returns a new fog instance with the same parameters as this one.

toJSON

function toJSON( ): Object;  

Return fog data in JSON format.

Source

src/scenes/Fog.js