Skip to content

SceneRenderer

Generic scene renderer

Extends VideoRenderer to be used with the particular WebGL engine e.g. Babylon.js or Three.js. Type of the scene is additional parametrization of generic. ScenePlugin written for WebGL engine can be attached to a SceneRenderer. Usually they perform simple scene tasks that can be separated from the main context into atomic building blocks, for example control node of a scene to follow (be attached to) user’s head or replace its geometry with detected face mesh (mask effect).

ResultT extends object = { }

Type of processing results

SceneT = undefined

Type of renderer’s scene

new SceneRenderer<ResultT, SceneT>(params): SceneRenderer<ResultT, SceneT>

Constructor

CanvasParams

Parameters of responsive canvas

SceneRenderer<ResultT, SceneT>

ShaderRenderer.constructor

protected cameraAngle: number

Camera vertical angle in radians

ShaderRenderer.cameraAngle


protected cameraRatio: number

Camera aspect ratio

ShaderRenderer.cameraRatio


canvas: ResponsiveCanvas

Responsive canvas

ShaderRenderer.canvas


current: null | WebGLTexture = null

Current image texture

ShaderRenderer.current


optional input: ImageTexture

Input image texture

ShaderRenderer.input


protected loaded: boolean = false

Loaded state

ShaderRenderer.loaded


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

Drawing context of padding canvases

ShaderRenderer.padCtx


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

Attached plugins

ShaderRenderer.plugins


optional scene: SceneT

Renderer scene


protected optional shader: ShaderProgram

Rendering shader

ShaderRenderer.shader


shaderCtx: null | WebGL2RenderingContext = null

Context of the video canvas layer

ShaderRenderer.shaderCtx


protected videoRatio: number

Aspect ratio of input video

ShaderRenderer.videoRatio


protected videoSize: Size

Resolution of input video

ShaderRenderer.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

ShaderRenderer.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>

ShaderRenderer.addPlugin


dispose(): void

Dispose renderer object

Extended to dispose scene object.

void

ShaderRenderer.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

ShaderRenderer.emit


eventNames(): (string | symbol)[]

List of emitter’s events

(string | symbol)[]

List of emitter’s events

ShaderRenderer.eventNames


getMaxListeners(): number

Maximum number of listeners per event

number

Maximum number of listeners per event

ShaderRenderer.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

ShaderRenderer.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

ShaderRenderer.listeners


load(): Promise<void>

Initialize renderer

Initializes rendering context, shader program and buffers.

Promise<void>

Promise resolving when initialization is finished

ShaderRenderer.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

ShaderRenderer.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

ShaderRenderer.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

ShaderRenderer.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

ShaderRenderer.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

ShaderRenderer.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

ShaderRenderer.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

ShaderRenderer.removeAllListeners


removeAllPlugins(): void

Remove all render plugins

Renderer will dispose all plugins before detaching them.

void

ShaderRenderer.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

ShaderRenderer.removeListener


removePlugin(plugin): void

Remove render plugin

Renderer will dispose the plugin before detaching it.

Plugin<ResultT>

void

ShaderRenderer.removePlugin


setMaxListeners(n): this

Sets maximum number of listeners per event

number

Maximum number of listeners

this

This EventEmitter

ShaderRenderer.setMaxListeners


setMirror(mirror): void

Set mirror mode

CanvasRenderer sets mirror mode of ResponsiveCanvas.

boolean

Mirror the output

void

ShaderRenderer.setMirror


setMode(mode): void

Set fitting mode

CanvasRenderer sets fitting mode of ResponsiveCanvas.

CanvasMode

Fitting mode

void

ShaderRenderer.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

ShaderRenderer.setupCamera


protected setupPadding(): void

Setup padding canvases

Callback sets up size of padding canvases.

void

ShaderRenderer.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

ShaderRenderer.setupVideo


unload(): void

Reset renderer

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

void

ShaderRenderer.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

ShaderRenderer.update


protected updatePads(stream): void

Update padding canvases

Updates padding canvases using portions of video frame.

HTMLCanvasElement

Captured video frame

void

ShaderRenderer.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

ShaderRenderer.updatePlugins


protected updateScene(): void

Update and render the scene

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

void

ShaderRenderer.updateScene


protected updateVideo(stream): void

Update the video layer

Calls rendering shaders with current input texture.

HTMLCanvasElement

Captured video frame

void

ShaderRenderer.updateVideo