Class: ShaderRenderer<ResultT>

@geenee/armature.ShaderRenderer

Generic shader renderer

ShaderRenderer is based on CanvasRenderer and uses two canvas layers: one for video stream and another to render 3D scene on top of it. Video is rendered by WebGL shaders, this allows to apply complex computationally demanding post-processing effects to the input stream. For example, simple mono-chrome or sepia effects, or more complex face beatification and dynamic geometry filters. Shader effects can be encapsulated in a form of plugins. Plugins are levels of abstraction allowing to single out ready-made helpers that are used as atomic building blocks.

Type parameters

Name	Type	Description
ResultT	extends Object = {}	Type of processing results

Hierarchy

• CanvasRenderer<ResultT>

  ↳ ShaderRenderer

  ↳↳ SceneRenderer

Constructors

constructor

• new ShaderRenderer<ResultT>(params)

Constructor

Type parameters

Name	Type
ResultT	extends Object = {}

Parameters

Name	Type	Description
params	CanvasParams	Parameters of responsive canvas

Overrides

CanvasRenderer.constructor

Properties

cameraAngle

• Protected cameraAngle: number

Camera vertical angle in radians

Inherited from

CanvasRenderer.cameraAngle

---

cameraRatio

• Protected cameraRatio: number

Camera aspect ratio

Inherited from

CanvasRenderer.cameraRatio

---

canvas

• canvas: ResponsiveCanvas

Responsive canvas

Inherited from

CanvasRenderer.canvas

---

current

• current: null | WebGLTexture = null

Current image texture

---

input

• Protected Optional input: ImageTexture

Input image texture

---

loaded

• Protected loaded: boolean = false

Loaded state

Inherited from

CanvasRenderer.loaded

---

padCtx

• Protected padCtx: [null | CanvasRenderingContext2D, null | CanvasRenderingContext2D]

Drawing context of padding canvases

Inherited from

CanvasRenderer.padCtx

---

plugins

• Protected plugins: Plugin<ResultT>[] = []

Attached plugins

Inherited from

CanvasRenderer.plugins

---

shader

• Protected Optional shader: ShaderProgram

Rendering shader

---

shaderCtx

• shaderCtx: null | WebGL2RenderingContext = null

Context of the video canvas layer

---

videoRatio

• Protected videoRatio: number

Aspect ratio of input video

Inherited from

CanvasRenderer.videoRatio

---

videoSize

• Protected videoSize: Size

Resolution of input video

Inherited from

CanvasRenderer.videoSize

Methods

addListener

▸ addListener<E>(event, listener): ShaderRenderer<ResultT>

Adds the listener function to the end of the listeners array

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
listener	RendererEvents[E]	The callback function

Returns

ShaderRenderer<ResultT>

This EventEmitter

Inherited from

CanvasRenderer.addListener

---

addPlugin

▸ addPlugin(plugin): Promise<void>

Add render plugin

Initializes the plugin if it's not loaded yet but renderer is ready. Renderer takes ownership of the plugin instance meaning it will release it when plugin is detached or renderer is disposed itself.

Parameters

Name	Type
plugin	Plugin<ResultT>

Returns

Promise<void>

Inherited from

CanvasRenderer.addPlugin

---

dispose

▸ dispose(): void

Dispose renderer object

Extended to dispose all attached plugins.

Returns

void

Inherited from

CanvasRenderer.dispose

---

emit

▸ emit<E>(event, ...args): boolean

Synchronously calls each of the listeners registered for the event

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
...args	Args<RendererEvents[E]>	Arguments passed to the listeners

Returns

boolean

True if the event had listeners, False otherwise

Inherited from

CanvasRenderer.emit

---

eventNames

▸ eventNames(): (string | symbol)[]

List of emitter's events

Returns

(string | symbol)[]

List of emitter's events

Inherited from

CanvasRenderer.eventNames

---

getMaxListeners

▸ getMaxListeners(): number

Maximum number of listeners per event

Returns

number

Maximum number of listeners per event

Inherited from

CanvasRenderer.getMaxListeners

---

listenerCount

▸ listenerCount<E>(event): number

The number of listeners listening to the event

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event

Returns

number

Number of listeners

Inherited from

CanvasRenderer.listenerCount

---

listeners

▸ listeners<E>(event): Function[]

Copy of the array of listeners for the event

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event

Returns

Function[]

Copy of the listeners array

Inherited from

CanvasRenderer.listeners

---

load

▸ load(): Promise<void>

Initialize renderer

Initializes rendering context, shader program and buffers.

Returns

Promise<void>

Promise resolving when initialization is finished

Overrides

CanvasRenderer.load

---

off

▸ off<E>(event, listener): ShaderRenderer<ResultT>

Removes the listener from the listener array for the event

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
listener	RendererEvents[E]	The callback function

Returns

ShaderRenderer<ResultT>

This EventEmitter

Inherited from

CanvasRenderer.off

---

on

▸ on<E>(event, listener): ShaderRenderer<ResultT>

Adds the listener function to the event

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
listener	RendererEvents[E]	The callback function

Returns

ShaderRenderer<ResultT>

This EventEmitter

Inherited from

CanvasRenderer.on

---

once

▸ once<E>(event, listener): ShaderRenderer<ResultT>

Adds a one-time listener function for the event

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
listener	RendererEvents[E]	The callback function

Returns

ShaderRenderer<ResultT>

This EventEmitter

Inherited from

CanvasRenderer.once

---

prependListener

▸ prependListener<E>(event, listener): ShaderRenderer<ResultT>

Adds the listener function to the beginning of the listeners array

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
listener	RendererEvents[E]	The callback function

Returns

ShaderRenderer<ResultT>

This EventEmitter

Inherited from

CanvasRenderer.prependListener

---

prependOnceListener

▸ prependOnceListener<E>(event, listener): ShaderRenderer<ResultT>

Adds a one-time listener function to the beginning of the listeners array

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
listener	RendererEvents[E]	The callback function

Returns

ShaderRenderer<ResultT>

Inherited from

CanvasRenderer.prependOnceListener

---

rawListeners

▸ rawListeners<E>(event): Function[]

Copy of the array of listeners for the event including wrappers

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event

Returns

Function[]

Copy of the listeners array

Inherited from

CanvasRenderer.rawListeners

---

removeAllListeners

▸ removeAllListeners<E>(event?): ShaderRenderer<ResultT>

Removes all listeners, or those of the specified event

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event?	E	The name of the event

Returns

ShaderRenderer<ResultT>

This EventEmitter

Inherited from

CanvasRenderer.removeAllListeners

---

removeAllPlugins

▸ removeAllPlugins(): void

Remove all render plugins

Renderer will dispose all plugins before detaching them.

Returns

void

Inherited from

CanvasRenderer.removeAllPlugins

---

removeListener

▸ removeListener<E>(event, listener): ShaderRenderer<ResultT>

Removes the specified listener from the listener array

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
listener	RendererEvents[E]	The callback function

Returns

ShaderRenderer<ResultT>

This EventEmitter

Inherited from

CanvasRenderer.removeListener

---

removePlugin

▸ removePlugin(plugin): void

Remove render plugin

Renderer will dispose the plugin before detaching it.

Parameters

Name	Type
plugin	Plugin<ResultT>

Returns

void

Inherited from

CanvasRenderer.removePlugin

---

setMaxListeners

▸ setMaxListeners(n): ShaderRenderer<ResultT>

Sets maximum number of listeners per event

Parameters

Name	Type	Description
n	number	Maximum number of listeners

Returns

ShaderRenderer<ResultT>

This EventEmitter

Inherited from

CanvasRenderer.setMaxListeners

---

setMirror

▸ setMirror(mirror): void

Set mirror mode

CanvasRenderer sets mirror mode of ResponsiveCanvas.

Parameters

Name	Type
mirror	boolean

Returns

void

Inherited from

CanvasRenderer.setMirror

---

setupCamera

▸ setupCamera(ratio, angle): void

Set camera parameters

Some video processors statically define camera parameters from just a video resolution. In this cases setupCamera() is used to pass these static camera parameters to renderer.

Parameters

Name	Type	Description
ratio	number	Aspect ration of input video
angle	number	-

Returns

void

Inherited from

CanvasRenderer.setupCamera

---

setupPadding

▸ Protected setupPadding(): void

Setup padding canvases

Callback sets up size of padding canvases.

Returns

void

Inherited from

CanvasRenderer.setupPadding

---

setupVideo

▸ setupVideo(size, ratio?): void

Set video parameters

Callback sets up size of video canvas layer, resizes texture and allocates new storage.

Parameters

Name	Type	Description
size	Size	Resolution of input video
ratio?	number	Aspect ration of input video

Returns

void

Overrides

CanvasRenderer.setupVideo

---

unload

▸ unload(): void

Reset renderer

Releases all resources and instances created in load(). Releases rendering context, shader program and buffers.

Returns

void

Overrides

CanvasRenderer.unload

---

update

▸ update(result, stream): Promise<void>

Update the scene

Renderers input video frame on corresponding canvas layer.

Parameters

Name	Type	Description
result	ResultT	Results of video processing
stream	HTMLCanvasElement	Captured video frame

Returns

Promise<void>

Promise resolving when update is finished

Overrides

CanvasRenderer.update

---

updatePads

▸ Protected updatePads(stream): void

Update padding canvases

Updates padding canvases using portions of video frame.

Parameters

Name	Type	Description
stream	HTMLCanvasElement	Captured video frame

Returns

void

Inherited from

CanvasRenderer.updatePads

---

updatePlugins

▸ Protected updatePlugins(result, stream): Promise<void>

Update attached plugins

Calls update() of all attached plugins.

Parameters

Name	Type	Description
result	ResultT	Results of video processing
stream	HTMLCanvasElement	Captured video frame

Returns

Promise<void>

Promise resolving when update is finished

Inherited from

CanvasRenderer.updatePlugins

---

updateScene

▸ Protected updateScene(): void

Update and render the scene

Virtual method updating and rendering the scene. Overridden by implementation of derived renderer.

Returns

void

Inherited from

CanvasRenderer.updateScene

---

updateVideo

▸ Protected updateVideo(stream): void

Update the video layer

Calls rendering shaders with current input texture.

Parameters

Name	Type	Description
stream	HTMLCanvasElement	Captured video frame

Returns

void

Overrides

CanvasRenderer.updateVideo