Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AbstractWeatherShader

The base shader class for weather shaders.

Hierarchy

Index

Constructors

Accessors

Properties

Methods

Constructors

constructor

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

scaleX

  • set scaleX(x: any): void

  • Parameters

    • x: any

    Returns void

scaleY

  • set scaleY(y: any): void

  • Parameters

    • y: any

    Returns void

Properties

speed

speed: number = 1

The speed multiplier applied to animation. 0 stops animation.

_defaults

_defaults: any

The initial default values of shader uniforms

Private #scale

#scale: { x: number; y: number } = ...

Type declaration

  • x: number
  • y: number

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 defaultUniforms

defaultUniforms: any

Default uniforms for a specific class

abstract

Static vertexShader

vertexShader: string = ...

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

Static fragmentShader

fragmentShader: string = ""

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

Methods

_preRender

  • Perform operations which are required before binding the Shader to the Renderer.

    internal

    Parameters

    • mesh: QuadMesh

      The mesh linked to this shader.

    Returns void

Static create

Static createProgram

  • createProgram(): Program

  • Create the shader program.

    Returns Program