Class AbstractBaseMaskFilter

This class defines an interface for masked custom filters

Hierarchy (View Summary)

AbstractBaseFilter
- AbstractBaseMaskFilter

Index

Constructors

Properties

defaultUniforms fragmentShader vertexShader

Methods

Constructors

constructor

new AbstractBaseMaskFilter(
    vertexSrc?: string,
    fragmentSrc?: string,
    uniforms?: Dict<any>,
): AbstractBaseMaskFilter
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 AbstractBaseMaskFilter
Inherited from AbstractBaseFilter.constructor

Properties

`Static`defaultUniforms

defaultUniforms: object = {}

The default uniforms used by the filter

`Static`fragmentShader

fragmentShader: string = undefined

The fragment shader which renders this filter.

`Static`vertexShader

vertexShader: string = ...

The default vertex shader used by all instances of AbstractBaseMaskFilter

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
Overrides AbstractBaseFilter.apply

`Static`create

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.

Inherited from AbstractBaseFilter.create