Skip to content

FaceRenderer

Abstract renderer for @geenee/bodyprocessors!FaceProcessor

Specializes BabylonUniRenderer generic for @geenee/bodyprocessors!FaceResult.This is abstract renderer that doesn’t implement any logic.

new FaceRenderer(container, mode?, mirror?, options?): FaceRenderer

Constructor

HTMLElement

Container of @geenee/armature!ResponsiveCanvas

CanvasMode

Fitting mode

boolean

Mirror the output

EngineOptions

FaceRenderer

BabylonUniRenderer.constructor

protected camera: UniversalCamera

Camera instance

BabylonUniRenderer.camera


protected cameraAngle: number

Camera vertical angle in radians

BabylonUniRenderer.cameraAngle


protected cameraRatio: number

Camera aspect ratio

BabylonUniRenderer.cameraRatio


canvas: ResponsiveCanvas

Responsive canvas

BabylonUniRenderer.canvas


current: null | WebGLTexture

Current image texture

BabylonUniRenderer.current


optional input: ImageTexture

Input image texture

BabylonUniRenderer.input


protected layer: Layer

Video layer

BabylonUniRenderer.layer


protected loaded: boolean

Loaded state

BabylonUniRenderer.loaded


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

Drawing context of padding canvases

BabylonUniRenderer.padCtx


protected plugins: Plugin<FaceResult>[]

Attached plugins

BabylonUniRenderer.plugins


protected renderer: Engine

Rendering engine

BabylonUniRenderer.renderer


optional scene: Scene

Renderer scene

BabylonUniRenderer.scene


protected setupPadding: () => void

Setup padding canvases

Callback sets up size of padding canvases.

void

BabylonUniRenderer.setupPadding


protected optional shader: ShaderProgram

Rendering shader

BabylonUniRenderer.shader


shaderCtx: null | WebGL2RenderingContext

Context of the video canvas layer

BabylonUniRenderer.shaderCtx


protected videoRatio: number

Aspect ratio of input video

BabylonUniRenderer.videoRatio


protected videoSize: Size

Resolution of input video

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

BabylonUniRenderer.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<FaceResult>

Promise<void>

BabylonUniRenderer.addPlugin


dispose(): void

Dispose renderer object

Extended to dispose scene and engine.

void

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

BabylonUniRenderer.emit


eventNames(): (string | symbol)[]

List of emitter’s events

(string | symbol)[]

List of emitter’s events

BabylonUniRenderer.eventNames


getMaxListeners(): number

Maximum number of listeners per event

number

Maximum number of listeners per event

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

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

BabylonUniRenderer.listeners


load(): Promise<void>

Initialize renderer

Initializes rendering context, shader program and buffers.

Promise<void>

Promise resolving when initialization is finished

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

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

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

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

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

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

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

BabylonUniRenderer.removeAllListeners


removeAllPlugins(): void

Remove all render plugins

Renderer will dispose all plugins before detaching them.

void

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

BabylonUniRenderer.removeListener


removePlugin(plugin): void

Remove render plugin

Renderer will dispose the plugin before detaching it.

Plugin<FaceResult>

void

BabylonUniRenderer.removePlugin


setMaxListeners(n): this

Sets maximum number of listeners per event

number

Maximum number of listeners

this

This EventEmitter

BabylonUniRenderer.setMaxListeners


setMirror(mirror): void

Set mirror mode

CanvasRenderer sets mirror mode of ResponsiveCanvas.

boolean

Mirror the output

void

BabylonUniRenderer.setMirror


setMode(mode): void

Set fitting mode

CanvasRenderer sets fitting mode of ResponsiveCanvas.

CanvasMode

Fitting mode

void

BabylonUniRenderer.setMode


setupCamera(ratio, angle): void

Set camera parameters

Setups BabylonRenderer#camera instance according to parameters provided by @geenee/armature!Processor.

number

Aspect ration of input video

number

Vertical field of view in radians

void

BabylonUniRenderer.setupCamera


setupVideo(size, ratio?): void

Set video parameters

Resizes video texture and rendering shader.

Size

Resolution of input video

number

Aspect ration of input video

void

BabylonUniRenderer.setupVideo


unload(): void

Reset renderer

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

void

BabylonUniRenderer.unload


update(result, stream): Promise<void>

Update the scene

Renderers input video frame on corresponding canvas layer.

FaceResult

Results of video processing

HTMLCanvasElement

Captured video frame

Promise<void>

Promise resolving when update is finished

BabylonUniRenderer.update


protected updatePads(stream): void

Update padding canvases

Updates padding canvases using portions of video frame.

HTMLCanvasElement

Captured video frame

void

BabylonUniRenderer.updatePads


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

Update attached plugins

Calls update() of all attached plugins.

FaceResult

Results of video processing

HTMLCanvasElement

Captured video frame

Promise<void>

Promise resolving when update is finished

BabylonUniRenderer.updatePlugins


protected updateScene(): void

Update and render the scene

Virtual method updating and rendering 3D scene. For babylon.js engine calls this.scene.render().

void

BabylonUniRenderer.updateScene


protected updateVideo(stream): void

Update the video layer

Renders processed frame to texture of video layer.

HTMLCanvasElement

Captured video frame

void

BabylonUniRenderer.updateVideo