Class WeatherOcclusionMaskFilter

The filter used by the weather layer to mask weather above occluded roofs.

See

foundry.canvas.layers.WeatherEffects

Hierarchy (View Summary)

Constructors

constructor

Properties

elevation defaultUniforms fragmentShader vertexShader

Methods

apply create

Constructors

constructor

  • new WeatherOcclusionMaskFilter(
        vertexSrc?: string,
        fragmentSrc?: string,
        uniforms?: Dict<any>,
    ): WeatherOcclusionMaskFilter

    Parameters

    • OptionalvertexSrc: string

      The source of the vertex shader.

    • OptionalfragmentSrc: string

      The source of the fragment shader.

    • Optionaluniforms: Dict<any>

      Custom uniforms to use to augment the built-in ones.

    Returns WeatherOcclusionMaskFilter

Properties

elevation

elevation: number = Infinity

Elevation of this weather occlusion mask filter.

StaticdefaultUniforms

defaultUniforms: {
    depthElevation: number;
    occlusionTexture: null;
    occlusionWeights: number[];
    reverseOcclusion: boolean;
    reverseTerrain: boolean;
    sceneAnchor: number[];
    sceneDimensions: number[];
    terrainTexture: null;
    terrainUvMatrix: Matrix;
    terrainWeights: number[];
    useOcclusion: boolean;
    useTerrain: boolean;
} = ...

StaticfragmentShader

fragmentShader: string = ...

StaticvertexShader

vertexShader: string = ...

Methods

apply

  • apply(
        filterManager: any,
        input: any,
        output: any,
        clear: any,
        currentState: any,
    ): void

    Parameters

    • filterManager: any
    • input: any
    • output: any
    • clear: any
    • currentState: any

    Returns void

Staticcreate

  • create(initialUniforms?: object): AbstractBaseFilter

    A factory method for creating the filter using its defined default values.

    Parameters

    • OptionalinitialUniforms: object = {}

      Initial uniform values which override filter defaults

    Returns AbstractBaseFilter

    The constructed AbstractFilter instance.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods