Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VisualEffectsMaskingFilter

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

Hierarchy

Index

Constructors

Properties

Methods

Accessors

Constructors

constructor

Properties

filterMode

filterMode: string

program

program: any

Private #postProcessModes

#postProcessModes: string[]

Code to determine which post-processing effect is applied in this filter.

Static FILTER_MODES

FILTER_MODES: { BACKGROUND: string; ILLUMINATION: string; COLORATION: string } = ...

Masking modes.

Type declaration

  • BACKGROUND: string
  • ILLUMINATION: string
  • COLORATION: string

Static defaultUniforms

defaultUniforms: { replacementColor: number[]; tint: number[]; screenDimensions: number[]; enableVisionMasking: boolean; uRoofSampler: number; uVisionSampler: number; exposure: number; contrast: number; saturation: number } = ...
override

Type declaration

  • replacementColor: number[]
  • tint: number[]
  • screenDimensions: number[]
  • enableVisionMasking: boolean
  • uRoofSampler: number
  • uVisionSampler: number
  • exposure: number
  • contrast: number
  • saturation: number

Static POST_PROCESS_TECHNIQUES

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

Filter post-process techniques.

Type declaration

  • EXPOSURE: { id: string; glsl: string }
    • id: string
    • glsl: string
  • CONTRAST: { id: string; glsl: string }
    • id: string
    • glsl: string
  • SATURATION: { id: string; glsl: string }
    • id: string
    • glsl: string
  • TINT: { id: string; glsl: string }
    • id: string
    • glsl: string

Static fragmentCore

fragmentCore: string = ...

The fragment core code.

Static vertexShader

vertexShader: string = ...

The default vertex shader used by all instances of AbstractBaseMaskFilter

Methods

updatePostprocessModes

  • updatePostprocessModes(postProcessModes?: string[], uniforms?: any): void

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

    Parameters

    • postProcessModes: string[] = []
    • uniforms: any = {}

    Returns void

reset

  • reset(): void

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

    Returns void

apply

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

    Parameters

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

    Returns void

Static create

Static replacementColor

  • replacementColor(filterMode: number): string

  • Assign the replacement color according to the filter mode.

    Parameters

    • filterMode: number

      Filter mode.

    Returns string

    The replacement color.

Static fragmentHeader

  • fragmentHeader(filterMode: number): string

  • Memory allocations and headers for the VisualEffectsMaskingFilter

    Parameters

    • filterMode: number

      Filter mode.

    Returns string

    The filter header according to the filter mode.

Static fragmentPostProcess

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

Static fragmentShader

  • fragmentShader(filterMode?: number, postProcessModes?: string[]): string

  • Specify the fragment shader to use according to mode

    override

    Parameters

    • filterMode: number = ...
    • postProcessModes: string[] = []

    Returns string

Accessors

resolution

  • get resolution(): number
  • set resolution(value: number): void

  • Always target the resolution of the render texture or renderer

    Returns number

  • Always target the resolution of the render texture or renderer

    Parameters

    • value: number

    Returns void

multisample

  • get multisample(): MSAA_QUALITY
  • set multisample(value: MSAA_QUALITY): void

  • Always target the MSAA level of the render texture or renderer

    Returns MSAA_QUALITY

  • Always target the MSAA level of the render texture or renderer

    Parameters

    • value: MSAA_QUALITY

    Returns void