Skip to main content

Class: RiveRenderLayer

Defined in: rendering/render-layers/rive-render-layer.ts:9

The RiveRenderLayer class represents a rendering layer with its own canvas and rive instance.

Extends​

Implements​

Constructors​

Constructor​

new RiveRenderLayer(name, canvas, rive, riveEventDispatcher): RiveRenderLayer

Defined in: rendering/render-layers/rive-render-layer.ts:23

Constructs a new instance of the RiveRenderLayer class.

Parameters​

name​

string

The name of the render layer.

canvas​

HTMLCanvasElement

The canvas element associated with the render layer.

rive​

Rive

The Rive instance to use for rendering.

riveEventDispatcher​

EventDispatcher<RiveEventPayload>

The event dispatcher for Rive events.

Returns​

RiveRenderLayer

Overrides​

RenderLayer.constructor

Properties​

canvas​

canvas: HTMLCanvasElement

Defined in: rendering/render-layers/render-layer.ts:11

The canvas element associated with the render layer.

Inherited from​

RenderLayer.canvas

center​

center: Vector2

Defined in: rendering/render-layers/render-layer.ts:14

The center of the canvas.

Inherited from​

RenderLayer.center

name​

name: string

Defined in: rendering/render-layers/render-layer.ts:8

The name of the render layer.

Inherited from​

RenderLayer.name

rive​

rive: Rive

Defined in: rendering/render-layers/rive-render-layer.ts:11

The Rive instance associated with the render layer.

Methods​

registerRiveEvent()​

registerRiveEvent(riveEventName, event): void

Defined in: rendering/render-layers/rive-render-layer.ts:50

Registers a Rive event with the specified name and event handler.

Parameters​

riveEventName​

string

The name of the Rive event.

event​

ParameterizedForgeEvent<RiveEventPayload>

The event handler to register.

Returns​

void

resize()​

resize(width, height): void

Defined in: rendering/render-layers/rive-render-layer.ts:40

Resizes the canvas to the specified width and height, and updates the Rive instance.

Parameters​

width​

number

The new width of the canvas.

height​

number

The new height of the canvas.

Returns​

void

Overrides​

RenderLayer.resize

stop()​

stop(): void

Defined in: rendering/render-layers/rive-render-layer.ts:60

Stops the render layer by clearing the canvas and cleaning up the Rive instance.

Returns​

void

Implementation of​

Stoppable.stop