Class VisualEffectsMaskingFilter

constructor

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

  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

StaticFILTER_MODES

StaticfragmentCore

StaticfragmentHeader

StaticPOST_PROCESS_TECHNIQUES

StaticdefaultUniforms

• get 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;
  }

  Returns {
      ambientDarkness: number[];
      ambientDaylight: number[];
      contrast: number;
      darknessLevelTexture: null;
      enableVisionMasking: boolean;
      exposure: number;
      mode: number;
      replacementColor: number[];
      saturation: number;
      screenDimensions: number[];
      tint: number[];
      visionTexture: null;
  }

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

reset

• reset(): void

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

  Returns void

updatePostprocessModes

• updatePostprocessModes(postProcessModes?: string[], uniforms?: object): 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

Static_createFragmentShader

• _createFragmentShader(options: any): string

  Parameters

  • options: any

  Returns string

Staticcreate

• create(__namedParameters?: {}, options: any): AbstractBaseFilter

  Parameters

  • __namedParameters: {} = {}
  • options: any

  Returns AbstractBaseFilter

StaticfragmentPostProcess

• fragmentPostProcess(postProcessModes?: string[]): string

  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.