Class Composed

A container class that knows how to apply a sequence of filters to an input image.

Hierarchy

BaseFilter
- Composed

Constructors

constructor

new Composed(__namedParameters?): Composed
Parameters
- __namedParameters: {
  subFilters?: BaseFilter[];
  } & Record<string, any> = {}
Returns Composed
Overrides BaseFilter.constructor
- Defined in src/filters/Composed.ts:17

Properties

`Optional` `Private` mainParameter

mainParameter?: keyof Composed

Name of the parameter that can be changed in the filter. Some filters have more than one parameter and there is no mainParameter

subFilters

subFilters: BaseFilter[]

A non sparse array of filters to apply

`Private` vertexSource

vertexSource: string = vertexSource

Array of attributes to send with buffers. do not modify

`Static` defaults

defaults: Record<string, any>

`Static` type

type: string = 'Composed'

The class type. Used to identify which class this is. This is used for serialization purposes and internally it can be used to identify classes. As a developer you could use instance of Class but to avoid importing all the code and blocking tree shaking we try to avoid doing that.

Accessors

type

get type(): string
Filter type

Returns string
Default
Inherited from BaseFilter.type
- Defined in src/filters/BaseFilter.ts:25

Methods

_setupFrameBuffer

_setupFrameBuffer(options): void
Parameters
- options: TWebGLPipelineState
Returns void
Inherited from BaseFilter._setupFrameBuffer
- Defined in src/filters/BaseFilter.ts:190

_swapTextures

_swapTextures(options): void
Parameters
- options: TWebGLPipelineState
Returns void
Inherited from BaseFilter._swapTextures
- Defined in src/filters/BaseFilter.ts:217

applyTo

applyTo(options): void
Apply this container's filters to the input image provided.
Parameters
- options: TWebGLPipelineState | T2DPipelineState
Returns void
Overrides BaseFilter.applyTo
- Defined in src/filters/Composed.ts:31

applyTo2d

applyTo2d(options): void
Parameters
- options: T2DPipelineState
Returns void
Inherited from BaseFilter.applyTo2d
- Defined in src/filters/BaseFilter.ts:275

applyToWebGL

applyToWebGL(options): void
Apply this filter using webgl.
Parameters
- options: TWebGLPipelineState
Returns void
Inherited from BaseFilter.applyToWebGL
- Defined in src/filters/BaseFilter.ts:315

bindAdditionalTexture

bindAdditionalTexture(gl, texture, textureUnit): void
Parameters
- gl: WebGLRenderingContext
- texture: WebGLTexture
- textureUnit: number
Returns void
Inherited from BaseFilter.bindAdditionalTexture
- Defined in src/filters/BaseFilter.ts:334

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
Inherited from BaseFilter.createHelpLayer
- Defined in src/filters/BaseFilter.ts:380

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
Inherited from BaseFilter.createProgram
- Defined in src/filters/BaseFilter.ts:77

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.
Inherited from BaseFilter.getAttributeLocations
- Defined in src/filters/BaseFilter.ts:146

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
Inherited from BaseFilter.getCacheKey
- Defined in src/filters/BaseFilter.ts:284

`Protected` getFragmentSource

getFragmentSource(): string
Returns string
Inherited from BaseFilter.getFragmentSource
- Defined in src/filters/BaseFilter.ts:66

getMainParameter

getMainParameter(): undefined | string | BaseFilter[] | ((gl, program) => TWebGLUniformLocationMap) | ((gl, program) => TWebGLAttributeLocationMap) | ((gl, uniformLocations) => void) | ((options) => void) | ((options) => TWebGLProgramCacheItem) | ((gl, fragmentSource?, vertexSource?) => {
    attributeLocations: TWebGLAttributeLocationMap;
    program: WebGLProgram;
    uniformLocations: TWebGLUniformLocationMap;
}) | ((gl, attributeLocations, aPositionData) => void) | ((options) => void) | ((options) => void) | (() => boolean) | ((options) => void) | (() => string) | ((options) => void) | ((gl, texture, textureUnit) => void) | ((gl, textureUnit) => void) | (() => undefined | string | BaseFilter[] | ((gl, program) => TWebGLUniformLocationMap) | ((gl, program) => TWebGLAttributeLocationMap) | ((gl, uniformLocations) => void) | ((options) => void) | ((options) => TWebGLProgramCacheItem) | ((gl, fragmentSource?, vertexSource?) => {
    attributeLocations: TWebGLAttributeLocationMap;
    program: WebGLProgram;
    uniformLocations: TWebGLUniformLocationMap;
}) | ((gl, attributeLocations, aPositionData) => void) | ((options) => void) | ((options) => void) | (() => boolean) | ((options) => void) | (() => string) | ((options) => void) | ((gl, texture, textureUnit) => void) | ((gl, textureUnit) => void) | (() => string | BaseFilter[] | ((gl: WebGLRenderingContext, program: WebGLProgram) => TWebGLUniformLocationMap) | ... 19 more ... | undefined) | (() => {
    subFilters: {
        type: string;
    }[];
    type: string;
}) | (() => {
    type: string;
}) | ((value) => void) | ((options) => void)) | (() => {
    subFilters: {
        type: string;
    }[];
    type: string;
}) | (() => {
    type: string;
}) | ((value) => void) | ((options) => void)
Returns undefined | string | BaseFilter[] | ((gl, program) => TWebGLUniformLocationMap) | ((gl, program) => TWebGLAttributeLocationMap) | ((gl, uniformLocations) => void) | ((options) => void) | ((options) => TWebGLProgramCacheItem) | ((gl, fragmentSource?, vertexSource?) => {
    attributeLocations: TWebGLAttributeLocationMap;
    program: WebGLProgram;
    uniformLocations: TWebGLUniformLocationMap;
}) | ((gl, attributeLocations, aPositionData) => void) | ((options) => void) | ((options) => void) | (() => boolean) | ((options) => void) | (() => string) | ((options) => void) | ((gl, texture, textureUnit) => void) | ((gl, textureUnit) => void) | (() => undefined | string | BaseFilter[] | ((gl, program) => TWebGLUniformLocationMap) | ((gl, program) => TWebGLAttributeLocationMap) | ((gl, uniformLocations) => void) | ((options) => void) | ((options) => TWebGLProgramCacheItem) | ((gl, fragmentSource?, vertexSource?) => {
    attributeLocations: TWebGLAttributeLocationMap;
    program: WebGLProgram;
    uniformLocations: TWebGLUniformLocationMap;
}) | ((gl, attributeLocations, aPositionData) => void) | ((options) => void) | ((options) => void) | (() => boolean) | ((options) => void) | (() => string) | ((options) => void) | ((gl, texture, textureUnit) => void) | ((gl, textureUnit) => void) | (() => string | BaseFilter[] | ((gl: WebGLRenderingContext, program: WebGLProgram) => TWebGLUniformLocationMap) | ... 19 more ... | undefined) | (() => {
    subFilters: {
        type: string;
    }[];
    type: string;
}) | (() => {
    type: string;
}) | ((value) => void) | ((options) => void)) | (() => {
    subFilters: {
        type: string;
    }[];
    type: string;
}) | (() => {
    type: string;
}) | ((value) => void) | ((options) => void)
Inherited from BaseFilter.getMainParameter
- Defined in src/filters/BaseFilter.ts:351

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.
Inherited from BaseFilter.getUniformLocations
- Defined in src/filters/BaseFilter.ts:164

isNeutralState

isNeutralState(): 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 )

Returns boolean
Overrides BaseFilter.isNeutralState
- Defined in src/filters/Composed.ts:52

retrieveShader

retrieveShader(options): TWebGLProgramCacheItem
Retrieves the cached shader.
Parameters
- options: TWebGLPipelineState
Returns TWebGLProgramCacheItem
the compiled program shader
Inherited from BaseFilter.retrieveShader
- Defined in src/filters/BaseFilter.ts:295

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
Inherited from BaseFilter.sendAttributeData
- Defined in src/filters/BaseFilter.ts:177

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
Inherited from BaseFilter.sendUniformData
- Defined in src/filters/BaseFilter.ts:369

setMainParameter

setMainParameter(value): void
Parameters
- value: any
Returns void
Inherited from BaseFilter.setMainParameter
- Defined in src/filters/BaseFilter.ts:355

toJSON

toJSON(): {
type: string;
}
Returns a JSON representation of an instance

Returns {
type: string;
}
JSON
- type: string
Inherited from BaseFilter.toJSON
- Defined in src/filters/BaseFilter.ts:405

toObject

toObject(): {
    subFilters: {
        type: string;
    }[];
    type: string;
}
Serialize this filter into JSON.

Returns {
    subFilters: {
        type: string;
    }[];
    type: string;
}
A JSON representation of this filter.
- subFilters: {
  type: string;
  }[]
- type: string
Overrides BaseFilter.toObject
- Defined in src/filters/Composed.ts:45

unbindAdditionalTexture

unbindAdditionalTexture(gl, textureUnit): void
Parameters
- gl: WebGLRenderingContext
- textureUnit: number
Returns void
Inherited from BaseFilter.unbindAdditionalTexture
- Defined in src/filters/BaseFilter.ts:345

`Static` fromObject

fromObject(object, options?): Promise<BaseFilter>
Deserialize a JSON definition of a ComposedFilter into a concrete instance.
Parameters
- object: Record<string, any>
  
  Object to create an instance from
- Optional options: {
  signal: AbortSignal;
  }
  - signal: AbortSignal
    
    handle aborting BlendImage filter loading, see https://developer.mozilla.org/en-US/docs/Web/API/AbortController/signal
Returns Promise<BaseFilter>

Static
Overrides BaseFilter.fromObject
- Defined in src/filters/Composed.ts:64

Class Composed

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { subFilters?: BaseFilter[]; } & Record<string, any> = {}

Returns Composed

Properties

Optional Private mainParameter

subFilters

Private vertexSource

Static defaults

Static type

Accessors

type

Returns string

Default

Methods

_setupFrameBuffer

Parameters

options: TWebGLPipelineState

Returns void

_swapTextures

Parameters

options: TWebGLPipelineState

Returns void

applyTo

Parameters

options: TWebGLPipelineState | T2DPipelineState

Returns void

applyTo2d

Parameters

options: T2DPipelineState

Returns void

applyToWebGL

Parameters

options: TWebGLPipelineState

Returns void

bindAdditionalTexture

Parameters

gl: WebGLRenderingContext

texture: WebGLTexture

textureUnit: number

Returns void

createHelpLayer

Parameters

options: T2DPipelineState

Returns void

createProgram

Parameters

gl: WebGLRenderingContext

fragmentSource: string = ...

vertexSource: string = ...

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

attributeLocations: TWebGLAttributeLocationMap

program: WebGLProgram

uniformLocations: TWebGLUniformLocationMap

getAttributeLocations

Parameters

gl: WebGLRenderingContext

program: WebGLProgram

Returns TWebGLAttributeLocationMap

getCacheKey

Returns string

Protected getFragmentSource

Returns string

getMainParameter

getUniformLocations

Parameters

gl: WebGLRenderingContext

program: WebGLProgram

Returns TWebGLUniformLocationMap

isNeutralState

Returns boolean

retrieveShader

__namedParameters: {
subFilters?: BaseFilter[];
} & Record<string, any> = {}

`Optional` `Private` mainParameter

`Private` vertexSource

`Static` defaults

`Static` type

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

`Protected` getFragmentSource

Returns {
type: string;
}

Returns {
subFilters: {
type: string;
}[];
type: string;
}

subFilters: {
type: string;
}[]

`Static` fromObject

`Optional` options: {
signal: AbortSignal;
}