Class Resize

Resize image filter class

Example

const filter = new Resize();
object.filters.push(filter);
object.applyFilters(canvas.renderAll.bind(canvas));

Hierarchy

BaseFilter
- Resize

Constructors

constructor

new Resize(options?): Resize
Constructor
Parameters
- Optional options: Record<string, any> = {}
  
  Options object
Returns Resize
Inherited from BaseFilter.constructor
- Defined in src/filters/BaseFilter.ts:58

Properties

fragmentSourceTOP

fragmentSourceTOP: string

lanczosLobes

lanczosLobes: number

LanczosLobes parameter for lanczos filter, valid for resizeType lanczos

Param

Default

`Optional` `Private` mainParameter

mainParameter?: keyof Resize

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

resizeType

resizeType: TResizeType

Resize type for webgl resizeType is just lanczos, for canvas2d can be: bilinear, hermite, sliceHack, lanczos.

Default

scaleX

scaleX: number

Scale factor for resizing, x axis

Param

Default

scaleY

scaleY: number

Scale factor for resizing, y axis

Param

Default

`Private` vertexSource

vertexSource: string = vertexSource

Array of attributes to send with buffers. do not modify

`Static` defaults

defaults: Partial<TClassProperties<Resize>> = resizeDefaultValues

`Static` type

type: string = 'Resize'

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 the resize filter to the image Determines whether to use WebGL or Canvas2D based on the options.webgl flag.
Parameters
- options: TWebGLPipelineState | T2DPipelineState
Returns void
Overrides BaseFilter.applyTo
- Defined in src/filters/Resize.ts:207

applyTo2d

applyTo2d(this, options): void
Parameters
- this: ResizeDuring2DResize
- options: T2DPipelineState
Returns void
Overrides BaseFilter.applyTo2d
- Defined in src/filters/Resize.ts:233

applyToForWebgl

applyToForWebgl(this, options): void
Parameters
- this: ResizeDuringWEBGLResize
- options: TWebGLPipelineState
Returns void
- Defined in src/filters/Resize.ts:173

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

bilinearFiltering

bilinearFiltering(this, options, oW, oH, dW, dH): ImageData
bilinearFiltering
Parameters
- this: ResizeDuring2DResize
- options: T2DPipelineState
- oW: number
  
  Original Width
- oH: number
  
  Original Height
- dW: number
  
  Destination Width
- dH: number
  
  Destination Height
Returns ImageData
- Defined in src/filters/Resize.ts:427

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

generateShader

generateShader(filterWindow): string
Generate vertex and shader sources from the necessary steps numbers
Parameters
- filterWindow: number
Returns string
- Defined in src/filters/Resize.ts:149

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(this): 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
Parameters
- this: ResizeDuringWEBGLResize
Returns string
Overrides BaseFilter.getCacheKey
- Defined in src/filters/Resize.ts:124

getFilterWindow

getFilterWindow(this): number
Parameters
- this: ResizeDuringWEBGLResize
Returns number
- Defined in src/filters/Resize.ts:119

getFragmentSource

getFragmentSource(this): string
Parameters
- this: ResizeDuringWEBGLResize
Returns string
Overrides BaseFilter.getFragmentSource
- Defined in src/filters/Resize.ts:129

getMainParameter

getMainParameter(): undefined | string | number | ((gl, program) => TWebGLAttributeLocationMap) | ((options) => TWebGLProgramCacheItem) | (() => {
    lanczosLobes: number;
    resizeType: TResizeType;
    scaleX: number;
    scaleY: number;
    type: string;
}) | (() => {
    type: string;
}) | ((gl, program) => {
    uDelta: null | WebGLUniformLocation;
    uTaps: null | WebGLUniformLocation;
}) | ((this, gl, uniformLocations) => void) | ((this) => number) | ((this) => string) | ((this) => string) | ((this) => any[]) | ((filterWindow) => string) | ((this, options) => void) | ((options) => void) | (() => boolean) | ((lobes) => ((x) => number)) | ((this, options) => void) | ((options, oW, oH, dW, dH) => ImageData) | ((this, options, oW, oH, dW, dH) => ImageData) | ((this, options, oW, oH, dW, dH) => ImageData) | ((this, options, oW, oH, dW, dH) => ImageData) | ((gl, fragmentSource?, vertexSource?) => {
    attributeLocations: TWebGLAttributeLocationMap;
    program: WebGLProgram;
    uniformLocations: TWebGLUniformLocationMap;
}) | ((gl, attributeLocations, aPositionData) => void) | ((options) => void) | ((options) => void) | ((options) => void) | ((gl, texture, textureUnit) => void) | ((gl, textureUnit) => void) | (() => undefined | string | number | ((gl, program) => TWebGLAttributeLocationMap) | ((options) => TWebGLProgramCacheItem) | (() => {
    lanczosLobes: number;
    resizeType: TResizeType;
    scaleX: number;
    scaleY: number;
    type: string;
}) | (() => {
    type: string;
}) | ((gl, program) => {
    uDelta: null | WebGLUniformLocation;
    uTaps: null | WebGLUniformLocation;
}) | ((this, gl, uniformLocations) => void) | ((this) => number) | ((this) => string) | ((this) => string) | ((this) => any[]) | ((filterWindow) => string) | ((this, options) => void) | ((options) => void) | (() => boolean) | ((lobes) => ((x) => number)) | ((this, options) => void) | ((options, oW, oH, dW, dH) => ImageData) | ((this, options, oW, oH, dW, dH) => ImageData) | ((this, options, oW, oH, dW, dH) => ImageData) | ((this, options, oW, oH, dW, dH) => ImageData) | ((gl, fragmentSource?, vertexSource?) => {
    attributeLocations: TWebGLAttributeLocationMap;
    program: WebGLProgram;
    uniformLocations: TWebGLUniformLocationMap;
}) | ((gl, attributeLocations, aPositionData) => void) | ((options) => void) | ((options) => void) | ((options) => void) | ((gl, texture, textureUnit) => void) | ((gl, textureUnit) => void) | (() => string | number | ((gl: WebGLRenderingContext, program: WebGLProgram) => TWebGLAttributeLocationMap) | ... 29 more ... | undefined) | ((value) => void) | ((options) => void)) | ((value) => void) | ((options) => void)
Returns undefined | string | number | ((gl, program) => TWebGLAttributeLocationMap) | ((options) => TWebGLProgramCacheItem) | (() => {
    lanczosLobes: number;
    resizeType: TResizeType;
    scaleX: number;
    scaleY: number;
    type: string;
}) | (() => {
    type: string;
}) | ((gl, program) => {
    uDelta: null | WebGLUniformLocation;
    uTaps: null | WebGLUniformLocation;
}) | ((this, gl, uniformLocations) => void) | ((this) => number) | ((this) => string) | ((this) => string) | ((this) => any[]) | ((filterWindow) => string) | ((this, options) => void) | ((options) => void) | (() => boolean) | ((lobes) => ((x) => number)) | ((this, options) => void) | ((options, oW, oH, dW, dH) => ImageData) | ((this, options, oW, oH, dW, dH) => ImageData) | ((this, options, oW, oH, dW, dH) => ImageData) | ((this, options, oW, oH, dW, dH) => ImageData) | ((gl, fragmentSource?, vertexSource?) => {
    attributeLocations: TWebGLAttributeLocationMap;
    program: WebGLProgram;
    uniformLocations: TWebGLUniformLocationMap;
}) | ((gl, attributeLocations, aPositionData) => void) | ((options) => void) | ((options) => void) | ((options) => void) | ((gl, texture, textureUnit) => void) | ((gl, textureUnit) => void) | (() => undefined | string | number | ((gl, program) => TWebGLAttributeLocationMap) | ((options) => TWebGLProgramCacheItem) | (() => {
    lanczosLobes: number;
    resizeType: TResizeType;
    scaleX: number;
    scaleY: number;
    type: string;
}) | (() => {
    type: string;
}) | ((gl, program) => {
    uDelta: null | WebGLUniformLocation;
    uTaps: null | WebGLUniformLocation;
}) | ((this, gl, uniformLocations) => void) | ((this) => number) | ((this) => string) | ((this) => string) | ((this) => any[]) | ((filterWindow) => string) | ((this, options) => void) | ((options) => void) | (() => boolean) | ((lobes) => ((x) => number)) | ((this, options) => void) | ((options, oW, oH, dW, dH) => ImageData) | ((this, options, oW, oH, dW, dH) => ImageData) | ((this, options, oW, oH, dW, dH) => ImageData) | ((this, options, oW, oH, dW, dH) => ImageData) | ((gl, fragmentSource?, vertexSource?) => {
    attributeLocations: TWebGLAttributeLocationMap;
    program: WebGLProgram;
    uniformLocations: TWebGLUniformLocationMap;
}) | ((gl, attributeLocations, aPositionData) => void) | ((options) => void) | ((options) => void) | ((options) => void) | ((gl, texture, textureUnit) => void) | ((gl, textureUnit) => void) | (() => string | number | ((gl: WebGLRenderingContext, program: WebGLProgram) => TWebGLAttributeLocationMap) | ... 29 more ... | undefined) | ((value) => void) | ((options) => void)) | ((value) => void) | ((options) => void)
Inherited from BaseFilter.getMainParameter
- Defined in src/filters/BaseFilter.ts:351

getTaps

getTaps(this): any[]
Parameters
- this: ResizeDuringWEBGLResize
Returns any[]
- Defined in src/filters/Resize.ts:134

getUniformLocations

getUniformLocations(gl, program): {
uDelta: null | WebGLUniformLocation;
uTaps: null | WebGLUniformLocation;
}
Return WebGL uniform locations for this filter's shader.
Parameters
- gl: WebGLRenderingContext
  
  The GL canvas context used to compile this filter's shader.
- program: WebGLProgram
  
  This filter's compiled shader program.
Returns {
uDelta: null | WebGLUniformLocation;
uTaps: null | WebGLUniformLocation;
}
- uDelta: null | WebGLUniformLocation
- uTaps: null | WebGLUniformLocation
Overrides BaseFilter.getUniformLocations
- Defined in src/filters/Resize.ts:94

hermiteFastResize

hermiteFastResize(this, options, oW, oH, dW, dH): ImageData
hermiteFastResize
Parameters
- this: ResizeDuring2DResize
- options: T2DPipelineState
- oW: number
  
  Original Width
- oH: number
  
  Original Height
- dW: number
  
  Destination Width
- dH: number
  
  Destination Height
Returns ImageData
- Defined in src/filters/Resize.ts:490

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/Resize.ts:215

lanczosCreate

lanczosCreate(lobes): ((x) => number)
Parameters
- lobes: number
Returns ((x) => number)
- - (x): number
  - Parameters
    - x: number
    Returns number
- Defined in src/filters/Resize.ts:219

lanczosResize

lanczosResize(this, options, oW, oH, dW, dH): ImageData
Filter lanczosResize
Parameters
- this: ResizeDuring2DResize
- options: T2DPipelineState
- oW: number
  
  Original Width
- oH: number
  
  Original Height
- dW: number
  
  Destination Width
- dH: number
  
  Destination Height
Returns ImageData
- Defined in src/filters/Resize.ts:336

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(this, gl, uniformLocations): void
Send data from this filter to its shader program's uniforms.
Parameters
- this: ResizeDuringWEBGLResize
- gl: WebGLRenderingContext
  
  The GL canvas context used to compile this filter's shader.
- uniformLocations: TWebGLUniformLocationMap
  
  A map of string uniform names to WebGLUniformLocation objects
Returns void
Overrides BaseFilter.sendUniformData
- Defined in src/filters/Resize.ts:107

setMainParameter

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

sliceByTwo

sliceByTwo(options, oW, oH, dW, dH): ImageData
Filter sliceByTwo
Parameters
- options: T2DPipelineState
- oW: number
  
  Original Width
- oH: number
  
  Original Height
- dW: number
  
  Destination Width
- dH: number
  
  Destination Height
Returns ImageData
- Defined in src/filters/Resize.ts:271

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(): {
    lanczosLobes: number;
    resizeType: TResizeType;
    scaleX: number;
    scaleY: number;
    type: string;
}
Returns object representation of an instance

Returns {
    lanczosLobes: number;
    resizeType: TResizeType;
    scaleX: number;
    scaleY: number;
    type: string;
}
Object representation of an instance
- lanczosLobes: number
- resizeType: TResizeType
- scaleX: number
- scaleY: number
- type: string
Overrides BaseFilter.toObject
- Defined in src/filters/Resize.ts:560

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(__namedParameters, options): Promise<BaseFilter>
Parameters
- __namedParameters: Record<string, any>
- options: Abortable
Returns Promise<BaseFilter>
Inherited from BaseFilter.fromObject
- Defined in src/filters/BaseFilter.ts:410

Class Resize

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

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

Returns Resize

Properties

fragmentSourceTOP

lanczosLobes

Param

Default

Optional Private mainParameter

resizeType

Default

scaleX

Param

Default

scaleY

Param

Default

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

this: ResizeDuring2DResize

options: T2DPipelineState

Returns void

applyToForWebgl

Parameters

this: ResizeDuringWEBGLResize

options: TWebGLPipelineState

Returns void

applyToWebGL

Parameters

options: TWebGLPipelineState

Returns void

bilinearFiltering

Parameters

this: ResizeDuring2DResize

options: T2DPipelineState

oW: number

oH: number

dW: number

dH: number

Returns ImageData

bindAdditionalTexture

Parameters

gl: WebGLRenderingContext

texture: WebGLTexture

textureUnit: number

Returns void

createHelpLayer

Parameters

options: T2DPipelineState

Returns void

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

`Optional` `Private` mainParameter

`Private` vertexSource

`Static` defaults

`Static` type

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

Returns {
uDelta: null | WebGLUniformLocation;
uTaps: null | WebGLUniformLocation;
}