Class Pixelate

Pixelate filter class

Example

const filter = new Pixelate({
  blocksize: 8
});
object.filters.push(filter);
object.applyFilters();

Hierarchy

BaseFilter
- Pixelate

Constructors

constructor

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

Properties

blocksize

blocksize: number

`Optional` `Private` mainParameter

mainParameter?: keyof Pixelate

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

`Private` vertexSource

vertexSource: string = vertexSource

Array of attributes to send with buffers. do not modify

`Static` defaults

defaults: Partial<TClassProperties<Pixelate>> = pixelateDefaultValues

`Static` type

type: string = 'Pixelate'

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

applyTo2d

applyTo2d(options): void
Apply the Pixelate operation to a Uint8ClampedArray representing the pixels of an image.
Parameters
- options: T2DPipelineState
Returns void
Overrides BaseFilter.applyTo2d
- Defined in src/filters/Pixelate.ts:34

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
Overrides BaseFilter.getFragmentSource
- Defined in src/filters/Pixelate.ts:63

getMainParameter

getMainParameter(): undefined | string | number | ((gl, program) => TWebGLAttributeLocationMap) | ((options) => TWebGLProgramCacheItem) | (() => {
    type: string;
}) | (() => {
    type: string;
}) | ((gl, program) => TWebGLUniformLocationMap) | ((gl, uniformLocations) => void) | (() => string) | ((options) => void) | (() => boolean) | ((options) => void) | ((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) | (() => {
    type: string;
}) | (() => {
    type: string;
}) | ((gl, program) => TWebGLUniformLocationMap) | ((gl, uniformLocations) => void) | (() => string) | ((options) => void) | (() => boolean) | ((options) => void) | ((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) | ... 19 more ... | undefined) | ((value) => void) | ((options) => void)) | ((value) => void) | ((options) => void)
Returns undefined | string | number | ((gl, program) => TWebGLAttributeLocationMap) | ((options) => TWebGLProgramCacheItem) | (() => {
    type: string;
}) | (() => {
    type: string;
}) | ((gl, program) => TWebGLUniformLocationMap) | ((gl, uniformLocations) => void) | (() => string) | ((options) => void) | (() => boolean) | ((options) => void) | ((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) | (() => {
    type: string;
}) | (() => {
    type: string;
}) | ((gl, program) => TWebGLUniformLocationMap) | ((gl, uniformLocations) => void) | (() => string) | ((options) => void) | (() => boolean) | ((options) => void) | ((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) | ... 19 more ... | undefined) | ((value) => void) | ((options) => void)) | ((value) => void) | ((options) => void)
Inherited from BaseFilter.getMainParameter
- Defined in src/filters/BaseFilter.ts:351

getUniformLocations

getUniformLocations(gl, program): TWebGLUniformLocationMap
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 TWebGLUniformLocationMap
Overrides BaseFilter.getUniformLocations
- Defined in src/filters/Pixelate.ts:73

isNeutralState

isNeutralState(): boolean
Indicate when the filter is not gonna apply changes to the image

Returns boolean
Overrides BaseFilter.isNeutralState
- Defined in src/filters/Pixelate.ts:59

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 data from this filter to its shader program's uniforms.
Parameters
- 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/Pixelate.ts:90

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(): {
type: string;
}
Returns object representation of an instance

Returns {
type: string;
}
Object representation of an instance
- type: string
Inherited from BaseFilter.toObject
- Defined in src/filters/BaseFilter.ts:393

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 Pixelate

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

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

Returns Pixelate

Properties

blocksize

Optional Private mainParameter

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

`Optional` options: 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 {
type: string;
}

`Static` fromObject