BaseFilter
Defined in: src/filters/BaseFilter.ts:21
Extended by
Section titled “Extended by”BlendColorBlendImageBlurBrightnessColorMatrixComposedContrastConvoluteGammaGrayscaleInvertNoisePixelateRemoveColorResizeSaturationVibrance
Type Parameters
Section titled “Type Parameters”Name extends string
OwnProps
Section titled “OwnProps”OwnProps extends Record<string, any> = object
SerializedProps
Section titled “SerializedProps”SerializedProps extends Record<string, any> = OwnProps
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BaseFilter<
Name,OwnProps,SerializedProps>(options?):BaseFilter<Name,OwnProps,SerializedProps>
Defined in: src/filters/BaseFilter.ts:57
Constructor
Parameters
Section titled “Parameters”options?
Section titled “options?”object & Partial<OwnProps> & Record<string, any> = {}
Options object
Returns
Section titled “Returns”BaseFilter<Name, OwnProps, SerializedProps>
Properties
Section titled “Properties”defaults
Section titled “defaults”
staticdefaults:Record<string,unknown>
Defined in: src/filters/BaseFilter.ts:51
statictype:string='BaseFilter'
Defined in: src/filters/BaseFilter.ts:42
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.
uniformLocations
Section titled “uniformLocations”
staticuniformLocations:string[] =[]
Defined in: src/filters/BaseFilter.ts:49
Contains the uniform locations for the fragment shader. uStepW and uStepH are handled by the BaseFilter, each filter class needs to specify all the one that are needed
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get type():
Name
Defined in: src/filters/BaseFilter.ts:31
Filter type
Default
Section titled “Default”Returns
Section titled “Returns”Name
Methods
Section titled “Methods”_setupFrameBuffer()
Section titled “_setupFrameBuffer()”_setupFrameBuffer(
options):void
Defined in: src/filters/BaseFilter.ts:205
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”void
_swapTextures()
Section titled “_swapTextures()”_swapTextures(
options):void
Defined in: src/filters/BaseFilter.ts:232
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”void
applyTo()
Section titled “applyTo()”applyTo(
options):void
Defined in: src/filters/BaseFilter.ts:265
Apply this filter to the input image data provided.
Determines whether to use WebGL or Canvas2D based on the options.webgl flag.
Parameters
Section titled “Parameters”options
Section titled “options”TWebGLPipelineState | T2DPipelineState
Returns
Section titled “Returns”void
applyTo2d()
Section titled “applyTo2d()”applyTo2d(
_options):void
Defined in: src/filters/BaseFilter.ts:275
Parameters
Section titled “Parameters”_options
Section titled “_options”Returns
Section titled “Returns”void
applyToWebGL()
Section titled “applyToWebGL()”applyToWebGL(
options):void
Defined in: src/filters/BaseFilter.ts:315
Apply this filter using webgl.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”void
bindAdditionalTexture()
Section titled “bindAdditionalTexture()”bindAdditionalTexture(
gl,texture,textureUnit):void
Defined in: src/filters/BaseFilter.ts:334
Parameters
Section titled “Parameters”WebGLRenderingContext
texture
Section titled “texture”WebGLTexture
textureUnit
Section titled “textureUnit”number
Returns
Section titled “Returns”void
createHelpLayer()
Section titled “createHelpLayer()”createHelpLayer(
options):void
Defined in: src/filters/BaseFilter.ts:370
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
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”void
createProgram()
Section titled “createProgram()”createProgram(
gl,fragmentSource,vertexSource):object
Defined in: src/filters/BaseFilter.ts:83
Compile this filter’s shader program.
Parameters
Section titled “Parameters”WebGLRenderingContext
The GL canvas context to use for shader compilation.
fragmentSource
Section titled “fragmentSource”string = ...
fragmentShader source for compilation
vertexSource
Section titled “vertexSource”string = ...
vertexShader source for compilation
Returns
Section titled “Returns”object
attributeLocations
Section titled “attributeLocations”attributeLocations:
TWebGLAttributeLocationMap
program
Section titled “program”program:
WebGLProgram
uniformLocations
Section titled “uniformLocations”uniformLocations:
TWebGLUniformLocationMap
getAttributeLocations()
Section titled “getAttributeLocations()”getAttributeLocations(
gl,program):TWebGLAttributeLocationMap
Defined in: src/filters/BaseFilter.ts:153
Return a map of attribute names to WebGLAttributeLocation objects.
Parameters
Section titled “Parameters”WebGLRenderingContext
The canvas context used to compile the shader program.
program
Section titled “program”WebGLProgram
The shader program from which to take attribute locations.
Returns
Section titled “Returns”A map of attribute names to attribute locations.
getCacheKey()
Section titled “getCacheKey()”getCacheKey():
string
Defined in: src/filters/BaseFilter.ts:284
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
Section titled “Returns”string
getUniformLocations()
Section titled “getUniformLocations()”getUniformLocations(
gl,program):TWebGLUniformLocationMap
Defined in: src/filters/BaseFilter.ts:169
Return a map of uniform names to WebGLUniformLocation objects.
Parameters
Section titled “Parameters”WebGLRenderingContext
The canvas context used to compile the shader program.
program
Section titled “program”WebGLProgram
The shader program from which to take uniform locations.
Returns
Section titled “Returns”A map of uniform names to uniform locations.
getVertexSource()
Section titled “getVertexSource()”getVertexSource():
string
Defined in: src/filters/BaseFilter.ts:72
Returns
Section titled “Returns”string
isNeutralState()
Section titled “isNeutralState()”isNeutralState(
options?):boolean
Defined in: src/filters/BaseFilter.ts:248
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
Section titled “Parameters”options?
Section titled “options?”any
Returns
Section titled “Returns”boolean
retrieveShader()
Section titled “retrieveShader()”retrieveShader(
options):TWebGLProgramCacheItem
Defined in: src/filters/BaseFilter.ts:295
Retrieves the cached shader.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”the compiled program shader
sendAttributeData()
Section titled “sendAttributeData()”sendAttributeData(
gl,attributeLocations,aPositionData):void
Defined in: src/filters/BaseFilter.ts:192
Send attribute data from this filter to its shader program on the GPU.
Parameters
Section titled “Parameters”WebGLRenderingContext
The canvas context used to compile the shader program.
attributeLocations
Section titled “attributeLocations”Record<string, number>
A map of shader attribute names to their locations.
aPositionData
Section titled “aPositionData”Float32Array
Returns
Section titled “Returns”void
sendUniformData()
Section titled “sendUniformData()”sendUniformData(
_gl,_uniformLocations):void
Defined in: src/filters/BaseFilter.ts:359
Send uniform data from this filter to its shader program on the GPU.
Intended to be overridden by subclasses.
Parameters
Section titled “Parameters”WebGLRenderingContext
The canvas context used to compile the shader program.
_uniformLocations
Section titled “_uniformLocations”A map of shader uniform names to their locations.
Returns
Section titled “Returns”void
toJSON()
Section titled “toJSON()”toJSON():
object&SerializedProps
Defined in: src/filters/BaseFilter.ts:407
Returns a JSON representation of an instance
Returns
Section titled “Returns”object & SerializedProps
JSON
toObject()
Section titled “toObject()”toObject():
object&SerializedProps
Defined in: src/filters/BaseFilter.ts:387
Returns object representation of an instance It will automatically export the default values of a filter, stored in the static defaults property.
Returns
Section titled “Returns”object & SerializedProps
Object representation of an instance
unbindAdditionalTexture()
Section titled “unbindAdditionalTexture()”unbindAdditionalTexture(
gl,textureUnit):void
Defined in: src/filters/BaseFilter.ts:345
Parameters
Section titled “Parameters”WebGLRenderingContext
textureUnit
Section titled “textureUnit”number
Returns
Section titled “Returns”void
fromObject()
Section titled “fromObject()”
staticfromObject(__namedParameters,_options):Promise<BaseFilter<string,object,object>>
Defined in: src/filters/BaseFilter.ts:412
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Record<string, any>
_options
Section titled “_options”Returns
Section titled “Returns”Promise<BaseFilter<string, object, object>>