Class FogShader

Fog shader effect.

Hierarchy (view full)

Properties

speed initialUniforms defaultUniforms COMPUTE_MASK FRAGMENT_HEADER commonUniforms vertexShader

Accessors

scale

Methods

_preRender reset _configure OCTAVES FOG createProgram fragmentShader create

Properties

speed

speed: number = 1

The speed multiplier applied to animation. 0 stops animation.

initialUniforms

initialUniforms: object

The initial values of the shader uniforms.

Static defaultUniforms

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

Default uniforms for a specific class

Type declaration

  • intensity: number
  • rotation: number
  • slope: number

Abstract

Static COMPUTE_MASK

COMPUTE_MASK: string = ...

Compute the weather masking value.

Static FRAGMENT_HEADER

FRAGMENT_HEADER: string = ...

Compute the weather masking value.

Static commonUniforms

commonUniforms: {
    useOcclusion: boolean;
    occlusionTexture: any;
    reverseOcclusion: boolean;
    occlusionWeights: number[];
    useTerrain: boolean;
    terrainTexture: any;
    reverseTerrain: boolean;
    terrainWeights: number[];
    alpha: number;
    tint: number[];
    screenDimensions: [number, number];
    effectDimensions: [number, number];
    depthElevation: number;
    time: number;
} = ...

Common uniforms for all weather shaders.

Type declaration

  • useOcclusion: boolean
  • occlusionTexture: any
  • reverseOcclusion: boolean
  • occlusionWeights: number[]
  • useTerrain: boolean
  • terrainTexture: any
  • reverseTerrain: boolean
  • terrainWeights: number[]
  • alpha: number
  • tint: number[]
  • screenDimensions: [number, number]
  • effectDimensions: [number, number]
  • depthElevation: number
  • time: number

Static vertexShader

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): 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

Static OCTAVES

  • OCTAVES(mode): string

  • Configure the number of octaves into the shaders.

    Parameters

    • mode: number

    Returns string

Static FOG

  • FOG(mode): string

  • Configure the fog complexity according to mode (performance).

    Parameters

    • mode: number

    Returns string

Static createProgram

Static fragmentShader

  • fragmentShader(mode): string

  • Parameters

    • mode: any

    Returns string

    Inherit Doc

Static create

Settings

Member Visibility

Theme

On This Page

speedinitialUniformsdefaultUniformsCOMPUTE_MASKFRAGMENT_HEADERcommonUniformsvertexShaderscale_preRenderreset_configureOCTAVESFOGcreateProgramfragmentShadercreate