Skip to content

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.

ResultT extends object = { }

Type of processing results

new ShaderRenderer<ResultT>(params): ShaderRenderer<ResultT>

Constructor

CanvasParams

Parameters of responsive canvas

ShaderRenderer<ResultT>

CanvasRenderer.constructor

protected cameraAngle: number

Camera vertical angle in radians

CanvasRenderer.cameraAngle


protected cameraRatio: number

Camera aspect ratio

CanvasRenderer.cameraRatio


canvas: ResponsiveCanvas

Responsive canvas

CanvasRenderer.canvas


current: null | WebGLTexture = null

Current image texture


optional input: ImageTexture

Input image texture


protected loaded: boolean = false

Loaded state

CanvasRenderer.loaded


protected padCtx: [null | CanvasRenderingContext2D, null | CanvasRenderingContext2D]

Drawing context of padding canvases

CanvasRenderer.padCtx


protected plugins: Plugin<ResultT>[] = []

Attached plugins

CanvasRenderer.plugins


protected optional shader: ShaderProgram

Rendering shader


shaderCtx: null | WebGL2RenderingContext = null

Context of the video canvas layer


protected videoRatio: number

Aspect ratio of input video

CanvasRenderer.videoRatio


protected videoSize: Size

Resolution of input video

CanvasRenderer.videoSize

addListener<E>(event, listener): this

Adds the listener function to the end of the listeners array

E extends keyof RendererEvents

E

The name of the event

RendererEvents[E]

The callback function

this

This EventEmitter

CanvasRenderer.addListener


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.

Plugin<ResultT>

Promise<void>

CanvasRenderer.addPlugin


dispose(): void

Dispose renderer object

Extended to dispose responsive canvas

void

CanvasRenderer.dispose


emit<E>(event, …args): boolean

Synchronously calls each of the listeners registered for the event

E extends keyof RendererEvents

E

The name of the event

Args<RendererEvents[E]>

Arguments passed to the listeners

boolean

True if the event had listeners, False otherwise

CanvasRenderer.emit


eventNames(): (string | symbol)[]

List of emitter’s events

(string | symbol)[]

List of emitter’s events

CanvasRenderer.eventNames


getMaxListeners(): number

Maximum number of listeners per event

number

Maximum number of listeners per event

CanvasRenderer.getMaxListeners


listenerCount<E>(event): number

The number of listeners listening to the event

E extends keyof RendererEvents

E

The name of the event

number

Number of listeners

CanvasRenderer.listenerCount


listeners<E>(event): Function[]

Copy of the array of listeners for the event

E extends keyof RendererEvents

E

The name of the event

Function[]

Copy of the listeners array

CanvasRenderer.listeners


load(): Promise<void>

Initialize renderer

Initializes rendering context, shader program and buffers.

Promise<void>

Promise resolving when initialization is finished

CanvasRenderer.load


off<E>(event, listener): this

Removes the listener from the listener array for the event

E extends keyof RendererEvents

E

The name of the event

RendererEvents[E]

The callback function

this

This EventEmitter

CanvasRenderer.off


on<E>(event, listener): this

Adds the listener function to the event

E extends keyof RendererEvents

E

The name of the event

RendererEvents[E]

The callback function

this

This EventEmitter

CanvasRenderer.on


once<E>(event, listener): this

Adds a one-time listener function for the event

E extends keyof RendererEvents

E

The name of the event

RendererEvents[E]

The callback function

this

This EventEmitter

CanvasRenderer.once


prependListener<E>(event, listener): this

Adds the listener function to the beginning of the listeners array

E extends keyof RendererEvents

E

The name of the event

RendererEvents[E]

The callback function

this

This EventEmitter

CanvasRenderer.prependListener


prependOnceListener<E>(event, listener): this

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

E extends keyof RendererEvents

E

The name of the event

RendererEvents[E]

The callback function

this

CanvasRenderer.prependOnceListener


rawListeners<E>(event): Function[]

Copy of the array of listeners for the event including wrappers

E extends keyof RendererEvents

E

The name of the event

Function[]

Copy of the listeners array

CanvasRenderer.rawListeners


removeAllListeners<E>(event?): this

Removes all listeners, or those of the specified event

E extends keyof RendererEvents

E

The name of the event

this

This EventEmitter

CanvasRenderer.removeAllListeners


removeAllPlugins(): void

Remove all render plugins

Renderer will dispose all plugins before detaching them.

void

CanvasRenderer.removeAllPlugins


removeListener<E>(event, listener): this

Removes the specified listener from the listener array

E extends keyof RendererEvents

E

The name of the event

RendererEvents[E]

The callback function

this

This EventEmitter

CanvasRenderer.removeListener


removePlugin(plugin): void

Remove render plugin

Renderer will dispose the plugin before detaching it.

Plugin<ResultT>

void

CanvasRenderer.removePlugin


setMaxListeners(n): this

Sets maximum number of listeners per event

number

Maximum number of listeners

this

This EventEmitter

CanvasRenderer.setMaxListeners


setMirror(mirror): void

Set mirror mode

CanvasRenderer sets mirror mode of ResponsiveCanvas.

boolean

Mirror the output

void

CanvasRenderer.setMirror


setMode(mode): void

Set fitting mode

CanvasRenderer sets fitting mode of ResponsiveCanvas.

CanvasMode

Fitting mode

void

CanvasRenderer.setMode


setupCamera(ratio, angle): void

Set camera parameters

Callback sets up all attached plugins.

number

Camera aspect ratio

number

Camera vertical angle in radians

void

CanvasRenderer.setupCamera


protected setupPadding(): void

Setup padding canvases

Callback sets up size of padding canvases.

void

CanvasRenderer.setupPadding


setupVideo(size, ratio?): void

Set video parameters

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

Size

Resolution of input video

number

Aspect ration of input video

void

CanvasRenderer.setupVideo


unload(): void

Reset renderer

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

void

CanvasRenderer.unload


update(result, stream): Promise<void>

Update the scene

Renderers input video frame on corresponding canvas layer.

ResultT

Results of video processing

HTMLCanvasElement

Captured video frame

Promise<void>

Promise resolving when update is finished

CanvasRenderer.update


protected updatePads(stream): void

Update padding canvases

Updates padding canvases using portions of video frame.

HTMLCanvasElement

Captured video frame

void

CanvasRenderer.updatePads


protected updatePlugins(result, stream): Promise<void>

Update attached plugins

Calls update() of all attached plugins.

ResultT

Results of video processing

HTMLCanvasElement

Captured video frame

Promise<void>

Promise resolving when update is finished

CanvasRenderer.updatePlugins


protected updateScene(): void

Update and render the scene

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

void

CanvasRenderer.updateScene


protected updateVideo(stream): void

Update the video layer

Calls rendering shaders with current input texture.

HTMLCanvasElement

Captured video frame

void

CanvasRenderer.updateVideo