Class: VirtualSurface

Defined in: livelink.js/sources/rendering/surfaces/VirtualSurface.ts:15

A virtual rendering surface.

A virtual surface is a surface that is not backed by a physical canvas. It is used to represent a surface that is not directly rendered to the screen.

Its main usecase is for video recording, where the frame rendered by the server is consumed as is and put directly into a video file.

Extends

• RenderingSurfaceBase

Constructors

Constructor

new VirtualSurface(__namedParameters: {
  width: number;
  height: number;
}): VirtualSurface;

Defined in: livelink.js/sources/rendering/surfaces/VirtualSurface.ts:38

Creates a new virtual surface.

Parameters

Parameter	Type
__namedParameters	{ width: number; height: number; }
__namedParameters.width	number
__namedParameters.height	number

Returns

VirtualSurface

Overrides

RenderingSurfaceBase.constructor;

Accessors

width

Get Signature

get width(): number;

Defined in: livelink.js/sources/rendering/surfaces/VirtualSurface.ts:24

Width of the surface.

Returns

number

Overrides

RenderingSurfaceBase.width

---

height

Get Signature

get height(): number;

Defined in: livelink.js/sources/rendering/surfaces/VirtualSurface.ts:31

Height of the surface.

Returns

number

Overrides

RenderingSurfaceBase.height

Methods

getBoundingRect()

getBoundingRect(): Rect;

Defined in: livelink.js/sources/rendering/surfaces/VirtualSurface.ts:46

Returns the bounding rectangle of the surface.

Returns

Rect

Overrides

RenderingSurfaceBase.getBoundingRect