ScreenSpaceFogOptions

2024.8.15

yisky

interface ScreenSpaceFogOptions {
    blendFunction?: BlendFunction;
    directionalInscatteringColor?: ColorRepresentation;
    directionalInscatteringExponent?: number;
    directionalInscatteringStartDistance?: number;
    fogColor?: ColorRepresentation;
    fogDensity?: number;
    fogHeight?: number;
    fogHeightFalloff?: number;
    fogMaxOpacity?: number;
    inscatteringLightDirection?: Vector3;
    resolutionScale?: number;
    resolutionX?: number;
    resolutionY?: number;
    startDistance?: number;
}

Properties

blendFunction?: BlendFunction

ScreenSpaceFogOptions

directionalInscatteringColor?: ColorRepresentation

Sets the color of light that is scattered in a specific direction (like sunlight through fog).

ScreenSpaceFogOptions

directionalInscatteringExponent?: number

Defines the intensity or strength of directional inscattering color. Increasing the exponent value amplifies the effect of directional inscattering, making the scattered light more pronounced.

ScreenSpaceFogOptions

directionalInscatteringStartDistance?: number

Controls the start distance from the viewer of the directional inscattering, which is used to approximate inscattering from a directional light.

ScreenSpaceFogOptions

fogColor?: ColorRepresentation

Sets the inscattering color for the fog. Essentially, this is the fog's primary color.

ScreenSpaceFogOptions

fogDensity?: number

The global density factor, which can be thought of as the fog layer's thickness.

ScreenSpaceFogOptions

fogHeight?: number

ScreenSpaceFogOptions

fogHeightFalloff?: number

Height density factor, controls how the density increases as height decreases. Smaller values make the transition larger.

ScreenSpaceFogOptions

fogMaxOpacity?: number

This controls the maximum opacity of the fog. A value of 1 means the fog will be completely opaque, while 0 means the fog will be essentially invisible.

ScreenSpaceFogOptions

inscatteringLightDirection?: Vector3

Sets the direction of light that is scattered in a specific direction (like sunlight through fog).

ScreenSpaceFogOptions

resolutionScale?: number

ScreenSpaceFogOptions

resolutionX?: number

ScreenSpaceFogOptions

resolutionY?: number

ScreenSpaceFogOptions

startDistance?: number

Distance from the camera that the fog will start.

ScreenSpaceFogOptions