BilateralPlugin

Bilateral smoothing plugin

ShaderPlugin applying bilateral filter: non-linear, edge-preserving, and noise-reducing smoothing image filter.

Extends

• ShaderPlugin<any>

Constructors

new BilateralPlugin()

new BilateralPlugin(smooth, sense): BilateralPlugin

Constructor

Parameters

• smooth: number = 7.0

Smoothing strength

• sense: number = 0.05

Edge sensitivity

Returns

BilateralPlugin

Overrides

ShaderPlugin.constructor

Properties

fragSrc?

protected optional fragSrc: string

Code of fragment shader (copy shader by default)

Inherited from

ShaderPlugin.fragSrc

---

inputs?

protected optional inputs: string[]

Shader texture inputs (names of sampler uniforms)

Inherited from

ShaderPlugin.inputs

---

loaded

loaded: boolean

Loaded state

Inherited from

ShaderPlugin.loaded

---

ordinal

ordinal: number

Ordinal number

Inherited from

ShaderPlugin.ordinal

---

renderer?

protected optional renderer: Renderer<any>

Renderer loaded the plugin

Inherited from

ShaderPlugin.renderer

---

sense

protected sense: number = 0.05

Edge sensitivity

---

shader?

protected optional shader: ShaderProgram

Rendering shader

Inherited from

ShaderPlugin.shader

---

shaderCtx?

protected optional shaderCtx: WebGL2RenderingContext

Rendering context

Inherited from

ShaderPlugin.shaderCtx

---

size

protected size: Size

Image size

Inherited from

ShaderPlugin.size

---

smooth

protected smooth: number = 7.0

Smoothing strength

---

uniforms?

protected optional uniforms: object

Shader uniforms as name-type map object

Index Signature

[key: string]: UniformType

Inherited from

ShaderPlugin.uniforms

---

vertSrc?

protected optional vertSrc: string

Vertex shader source (copy shader by default)

Inherited from

ShaderPlugin.vertSrc

Methods

dispose()

dispose(): void

Dispose video plugin

Returns

void

Inherited from

ShaderPlugin.dispose

---

load()

load(renderer): Promise<void>

Initialize plugin

Initializes resources required for shader effect.

Parameters

• renderer: Renderer<any>

Renderer this plugin is attached to

Returns

Promise<void>

Promise resolving when initialization is finished

Overrides

ShaderPlugin.load

---

process()

process(result, input): Promise<boolean>

Process the image

Applies bilateral smoothing filter.

Parameters

• result: any

Results of video processing

• input: WebGLTexture

Current image texture

Returns

Promise<boolean>

True on success, false otherwise

Overrides

ShaderPlugin.process

---

setupCamera()

setupCamera(ratio, angle): void

Set camera parameters

Could be overridden to adjust plugin’s pipeline.

Parameters

• ratio: number

Aspect ration of input video

• angle: number

Vertical field of view in radians

Returns

void

Inherited from

ShaderPlugin.setupCamera

---

setupVideo()

setupVideo(size): void

Set video size

Adjusts shader and texture to a new size.

Parameters

• size: Size

Resolution of input video

Returns

void

Overrides

ShaderPlugin.setupVideo

---

unload()

unload(): void

Reset plugin

Releases all resources and instances created in load().

Returns

void

Overrides

ShaderPlugin.unload

---

update()

update(result, stream): Promise<void>

Sealed

Update the image

Main method implementing webgl shader effect or filter. ShaderRenderer keeps track of the current iamge texture that will be be rendered. ShaderPlugin uses the current texture as input and writes results to ShaderPlugin#output. ShaderPlugin#output becomes new current texture of ShaderRenderer. This way all ShaderPlugins attached to renderer organize a chain of effects applied on top of each other. Method process() implements shader effect itself, it’s intended to be overridden by effect authors.

Parameters

• result: any

Results of video processing

• stream: HTMLCanvasElement

Captured video frame

Returns

Promise<void>

Promise resolving when update is finished

Inherited from

ShaderPlugin.update