This filter handles masking and post-processing for visual effects.

Hierarchy (View Summary)

Constructors

  • 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 VisualEffectsMaskingFilter

Properties

defaultUniforms: {
    ambientDarkness: number[];
    ambientDaylight: number[];
    contrast: number;
    darknessLevelTexture: null;
    enableVisionMasking: boolean;
    exposure: number;
    mode: number;
    replacementColor: number[];
    saturation: number;
    screenDimensions: number[];
    tint: number[];
    visionTexture: null;
} = ...
FILTER_MODES: Readonly<{ BACKGROUND: 0; COLORATION: 2; ILLUMINATION: 1 }> = ...

Masking modes.

fragmentCore: string = ...

The fragment core code.

fragmentHeader: string = ...

Memory allocations and headers for the VisualEffectsMaskingFilter

The filter header according to the filter mode.

POST_PROCESS_TECHNIQUES: {
    CONTRAST: { glsl: string; id: string };
    EXPOSURE: { glsl: string; id: string };
    SATURATION: { glsl: string; id: string };
} = ...

Filter post-process techniques.

vertexShader: string = ...

The default vertex shader used by all instances of AbstractBaseMaskFilter

Methods

  • Parameters

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

    Returns void

  • Remove all post-processing modes and reset some key uniforms.

    Returns void

  • Update the filter shader with new post-process modes.

    Parameters

    • OptionalpostProcessModes: string[] = []

      New modes to apply.

    • Optionaluniforms: object = {}

      Uniforms value to update.

    Returns void

  • Construct filter post-processing code according to provided value.

    Parameters

    • postProcessModes: string[] = []

      Post-process modes to construct techniques.

    Returns string

    The constructed shader code for post-process techniques.

  • Specify the fragment shader to use according to mode

    Parameters

    • postProcessModes: string[] = []

    Returns string