Class AbstractWeatherShader

The base shader class for weather shaders.

Hierarchy (View Summary)

Properties

initialUniforms speed commonUniforms COMPUTE_MASK defaultUniforms FRAGMENT_HEADER fragmentShader vertexShader

Accessors

scale

Methods

_preRender reset _configure create createProgram

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.

Static AbstractdefaultUniforms

defaultUniforms: any

Default uniforms for a specific class

StaticFRAGMENT_HEADER

FRAGMENT_HEADER: string = ...

Compute the weather masking value.

StaticfragmentShader

fragmentShader: string | (...args: any[]) => string = ""

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

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

  • reset(): void

    Reset the shader uniforms back to their initial values.

    Returns void

Protected_configure

Staticcreate

StaticcreateProgram

  • createProgram(): Program

    Create the shader program.

    Returns Program

Settings

Member Visibility

On This Page

Properties
Accessors
Methods