Class FogShader

Fog shader effect.

Hierarchy (View Summary)

Properties

initialUniforms speed commonUniforms COMPUTE_MASK defaultUniforms FRAGMENT_HEADER vertexShader

Accessors

scale

Methods

_preRender reset _configure create createProgram FOG fragmentShader OCTAVES

Properties

initialUniforms

initialUniforms: object

The initial values of the shader uniforms.

speed

speed: number = 1

The speed multiplier applied to animation. 0 stops animation.

StaticcommonUniforms

commonUniforms: {
    alpha: number;
    depthElevation: number;
    effectDimensions: [number, number];
    occlusionTexture: null | Texture<Resource>;
    occlusionWeights: number[];
    reverseOcclusion: boolean;
    reverseTerrain: boolean;
    screenDimensions: [number, number];
    terrainTexture: null | Texture<Resource>;
    terrainWeights: number[];
    time: number;
    tint: number[];
    useOcclusion: boolean;
    useTerrain: boolean;
} = ...

Common uniforms for all weather shaders.

StaticCOMPUTE_MASK

COMPUTE_MASK: string = ...

Compute the weather masking value.

StaticdefaultUniforms

defaultUniforms: { intensity: number; rotation: number; slope: number } = ...

Default uniforms for a specific class

StaticFRAGMENT_HEADER

FRAGMENT_HEADER: string = ...

Compute the weather masking value.

StaticvertexShader

vertexShader: string = ...

The raw vertex shader used by this class. A subclass of AbstractBaseShader must implement the vertexShader static field.

Accessors

scale

  • set scale(scale: number | { x: number; y: number }): void

    Update the scale of this effect with new values

    Parameters

    • scale: number | { x: number; y: number }

      The desired scale

    Returns void

Methods

_preRender

reset

Protected_configure

Staticcreate

StaticcreateProgram

StaticFOG

  • FOG(mode: number): string

    Configure the fog complexity according to mode (performance).

    Parameters

    • mode: number

    Returns string

StaticfragmentShader

  • fragmentShader(mode: any): string

    Parameters

    • mode: any

    Returns string

    Inherit Doc

StaticOCTAVES

  • OCTAVES(mode: number): string

    Configure the number of octaves into the shaders.

    Parameters

    • mode: number

    Returns string

Settings

Member Visibility

On This Page

Properties
Accessors
Methods