Class BaseFilter

constructor

• new BaseFilter(options?): BaseFilter

• Constructor

  Parameters

  • Optional options: Record<string, any> = {}

    Options object

  Returns BaseFilter

Static defaults

Static type

type

• get type(): string

• Filter type

  Returns string

  Default

  
  Copy

_setupFrameBuffer

• _setupFrameBuffer(options): void

• Parameters

  • options: TWebGLPipelineState

  Returns void

_swapTextures

• _swapTextures(options): void

• Parameters

  • options: TWebGLPipelineState

  Returns void

applyTo

• applyTo(options): void

• Apply this filter to the input image data provided.

  Determines whether to use WebGL or Canvas2D based on the options.webgl flag.

  Parameters

  • options: TWebGLPipelineState | T2DPipelineState

  Returns void

applyTo2d

• applyTo2d(options): void

• Parameters

  • options: T2DPipelineState

  Returns void

applyToWebGL

• applyToWebGL(options): void

• Apply this filter using webgl.

  Parameters

  • options: TWebGLPipelineState

  Returns void

bindAdditionalTexture

• bindAdditionalTexture(gl, texture, textureUnit): void

• Parameters

  • gl: WebGLRenderingContext

  • texture: WebGLTexture

  • textureUnit: number

  Returns void

createHelpLayer

• createHelpLayer(options): void

• If needed by a 2d filter, this functions can create an helper canvas to be used remember that options.targetCanvas is available for use till end of chain.

  Parameters

  • options: T2DPipelineState

  Returns void

createProgram

• createProgram(gl, fragmentSource?, vertexSource?): {
      attributeLocations: TWebGLAttributeLocationMap;
      program: WebGLProgram;
      uniformLocations: TWebGLUniformLocationMap;
  }

• Compile this filter's shader program.

  Parameters

  • gl: WebGLRenderingContext

    The GL canvas context to use for shader compilation.

  • fragmentSource: string = ...

    fragmentShader source for compilation

  • vertexSource: string = ...

    vertexShader source for compilation

  Returns {
      attributeLocations: TWebGLAttributeLocationMap;
      program: WebGLProgram;
      uniformLocations: TWebGLUniformLocationMap;
  }

  • attributeLocations: TWebGLAttributeLocationMap

  • program: WebGLProgram

  • uniformLocations: TWebGLUniformLocationMap

getAttributeLocations

• getAttributeLocations(gl, program): TWebGLAttributeLocationMap

• Return a map of attribute names to WebGLAttributeLocation objects.

  Parameters

  • gl: WebGLRenderingContext

    The canvas context used to compile the shader program.

  • program: WebGLProgram

    The shader program from which to take attribute locations.

  Returns TWebGLAttributeLocationMap

  A map of attribute names to attribute locations.

getCacheKey

• getCacheKey(): string

• Returns a string that represent the current selected shader code for the filter. Used to force recompilation when parameters change or to retrieve the shader from cache

  Returns string

getMainParameter

• getMainParameter(): undefined | string | ((options) => void) | ((gl, program) => TWebGLUniformLocationMap) | ((gl, program) => TWebGLAttributeLocationMap) | ((gl, uniformLocations) => void) | ((options) => void) | ((options) => TWebGLProgramCacheItem) | ((options?) => boolean) | ((gl, fragmentSource?, vertexSource?) => {
      attributeLocations: TWebGLAttributeLocationMap;
      program: WebGLProgram;
      uniformLocations: TWebGLUniformLocationMap;
  }) | ((gl, attributeLocations, aPositionData) => void) | ((options) => void) | ((options) => void) | (() => string) | ((options) => void) | ((gl, texture, textureUnit) => void) | ((gl, textureUnit) => void) | (() => undefined | string | ((options) => void) | ((gl, program) => TWebGLUniformLocationMap) | ((gl, program) => TWebGLAttributeLocationMap) | ((gl, uniformLocations) => void) | ((options) => void) | ((options) => TWebGLProgramCacheItem) | ((options?) => boolean) | ((gl, fragmentSource?, vertexSource?) => {
      attributeLocations: TWebGLAttributeLocationMap;
      program: WebGLProgram;
      uniformLocations: TWebGLUniformLocationMap;
  }) | ((gl, attributeLocations, aPositionData) => void) | ((options) => void) | ((options) => void) | (() => string) | ((options) => void) | ((gl, texture, textureUnit) => void) | ((gl, textureUnit) => void) | (() => string | ((options: TWebGLPipelineState | T2DPipelineState) => void) | ((gl: WebGLRenderingContext, program: WebGLProgram) => TWebGLUniformLocationMap) | ... 18 more ... | undefined) | (() => {
      type: string;
  }) | (() => {
      type: string;
  }) | ((value) => void) | ((options) => void)) | (() => {
      type: string;
  }) | (() => {
      type: string;
  }) | ((value) => void) | ((options) => void)

• Returns undefined | string | ((options) => void) | ((gl, program) => TWebGLUniformLocationMap) | ((gl, program) => TWebGLAttributeLocationMap) | ((gl, uniformLocations) => void) | ((options) => void) | ((options) => TWebGLProgramCacheItem) | ((options?) => boolean) | ((gl, fragmentSource?, vertexSource?) => {
      attributeLocations: TWebGLAttributeLocationMap;
      program: WebGLProgram;
      uniformLocations: TWebGLUniformLocationMap;
  }) | ((gl, attributeLocations, aPositionData) => void) | ((options) => void) | ((options) => void) | (() => string) | ((options) => void) | ((gl, texture, textureUnit) => void) | ((gl, textureUnit) => void) | (() => undefined | string | ((options) => void) | ((gl, program) => TWebGLUniformLocationMap) | ((gl, program) => TWebGLAttributeLocationMap) | ((gl, uniformLocations) => void) | ((options) => void) | ((options) => TWebGLProgramCacheItem) | ((options?) => boolean) | ((gl, fragmentSource?, vertexSource?) => {
      attributeLocations: TWebGLAttributeLocationMap;
      program: WebGLProgram;
      uniformLocations: TWebGLUniformLocationMap;
  }) | ((gl, attributeLocations, aPositionData) => void) | ((options) => void) | ((options) => void) | (() => string) | ((options) => void) | ((gl, texture, textureUnit) => void) | ((gl, textureUnit) => void) | (() => string | ((options: TWebGLPipelineState | T2DPipelineState) => void) | ((gl: WebGLRenderingContext, program: WebGLProgram) => TWebGLUniformLocationMap) | ... 18 more ... | undefined) | (() => {
      type: string;
  }) | (() => {
      type: string;
  }) | ((value) => void) | ((options) => void)) | (() => {
      type: string;
  }) | (() => {
      type: string;
  }) | ((value) => void) | ((options) => void)

getUniformLocations

• getUniformLocations(gl, program): TWebGLUniformLocationMap

• Return a map of uniform names to WebGLUniformLocation objects.

  Intended to be overridden by subclasses.

  Parameters

  • gl: WebGLRenderingContext

    The canvas context used to compile the shader program.

  • program: WebGLProgram

    The shader program from which to take uniform locations.

  Returns TWebGLUniformLocationMap

  A map of uniform names to uniform locations.

isNeutralState

• isNeutralState(options?): boolean

• Generic isNeutral implementation for one parameter based filters. Used only in image applyFilters to discard filters that will not have an effect on the image Other filters may need their own version ( ColorMatrix, HueRotation, gamma, ComposedFilter )

  Parameters

  • Optional options: any

  Returns boolean

retrieveShader

• retrieveShader(options): TWebGLProgramCacheItem

• Retrieves the cached shader.

  Parameters

  • options: TWebGLPipelineState

  Returns TWebGLProgramCacheItem

  the compiled program shader

sendAttributeData

• sendAttributeData(gl, attributeLocations, aPositionData): void

• Send attribute data from this filter to its shader program on the GPU.

  Parameters

  • gl: WebGLRenderingContext

    The canvas context used to compile the shader program.

  • attributeLocations: Record<string, number>

    A map of shader attribute names to their locations.

  • aPositionData: Float32Array

  Returns void

sendUniformData

• sendUniformData(gl, uniformLocations): void

• Send uniform data from this filter to its shader program on the GPU.

  Intended to be overridden by subclasses.

  Parameters

  • gl: WebGLRenderingContext

    The canvas context used to compile the shader program.

  • uniformLocations: TWebGLUniformLocationMap

    A map of shader uniform names to their locations.

  Returns void

setMainParameter

• setMainParameter(value): void

• Parameters

  • value: any

  Returns void

toJSON

• toJSON(): {
      type: string;
  }

• Returns a JSON representation of an instance

  Returns {
      type: string;
  }

  JSON

  • type: string

toObject

• toObject(): {
      type: string;
  }

• Returns object representation of an instance

  Returns {
      type: string;
  }

  Object representation of an instance

  • type: string

unbindAdditionalTexture

• unbindAdditionalTexture(gl, textureUnit): void

• Parameters

  • gl: WebGLRenderingContext

  • textureUnit: number

  Returns void

Static fromObject

• fromObject(__namedParameters, options): Promise<BaseFilter>

• Parameters

  • __namedParameters: Record<string, any>

  • options: Abortable

  Returns Promise<BaseFilter>