Class RainShader

Rain shader effect.

Hierarchy (view full)

AbstractWeatherShader
- RainShader

Index

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: {
    opacity: number;
    intensity: number;
    strength: number;
    rotation: number;
    resolution: number[];
} = ...

Default uniforms for a specific class

Type declaration

opacity: number
intensity: number
strength: number
rotation: number
resolution: number[]

Abstract

`Static` fragmentShader

fragmentShader: string = ...

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

`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
Inherited from AbstractWeatherShader.scale

Methods

_preRender

_preRender(mesh, renderer): void
Parameters
- mesh: any
- renderer: any
Returns void
Inherited from AbstractWeatherShader._preRender

reset

reset(): void
Reset the shader uniforms back to their initial values.

Returns void
Inherited from AbstractWeatherShader.reset

`Protected` _configure

_configure(): void
Protected
A one time initialization performed on creation.

Returns void
Inherited from AbstractWeatherShader._configure

`Static` create

create(initialUniforms): AbstractWeatherShader
Parameters
- initialUniforms: any
Returns AbstractWeatherShader
Inherited from AbstractWeatherShader.create

`Static` createProgram

createProgram(): Program
Create the shader program.

Returns Program
Inherited from AbstractWeatherShader.createProgram

Class RainShader

Hierarchy (view full)

Index

Properties

Accessors

Methods

Properties

speed

initialUniforms

Static defaultUniforms

Type declaration

opacity: number

intensity: number

strength: number

rotation: number

resolution: number[]

Abstract

Static fragmentShader

Static COMPUTE_MASK

Static FRAGMENT_HEADER

Static commonUniforms

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

Accessors

scale

Parameters

Returns void

Methods

_preRender

Parameters

Returns void

reset

Returns void

Protected _configure

Returns void

Static create

Parameters

Returns AbstractWeatherShader

Static createProgram

Returns Program

Settings

Member Visibility

Theme

On This Page

`Static` defaultUniforms

`Static` fragmentShader

`Static` COMPUTE_MASK

`Static` FRAGMENT_HEADER

`Static` commonUniforms

`Static` vertexShader

`Protected` _configure

`Static` create

`Static` createProgram