OffscreenSurface

Defined in: livelink.js/sources/rendering/surfaces/OffscreenSurface.ts:13

Extends

• RenderingSurfaceBase

Type Parameters

Type Parameter
ContextType extends CanvasContextType
ContextOptions

Constructors

new OffscreenSurface()

new OffscreenSurface<ContextType, ContextOptions>(__namedParameters: {
  width: number;
  height: number;
  context_constructor: (canvas: OffscreenCanvas | HTMLCanvasElement, context_type: ContextType, options?: ContextOptions) => ContextProvider;
  context_type: ContextType;
  context_options: ContextOptions;
  resolution_scale: number;
}): OffscreenSurface<ContextType, ContextOptions>

Defined in: livelink.js/sources/rendering/surfaces/OffscreenSurface.ts:32

Parameters

Parameter	Type
__namedParameters	{ width: number; height: number; context_constructor: (canvas: OffscreenCanvas | HTMLCanvasElement, context_type: ContextType, options?: ContextOptions) => ContextProvider; context_type: ContextType; context_options: ContextOptions; resolution_scale: number; }
__namedParameters.width	number
__namedParameters.height	number
__namedParameters.context_constructor	(canvas: OffscreenCanvas | HTMLCanvasElement, context_type: ContextType, options?: ContextOptions) => ContextProvider
__namedParameters.context_type	ContextType
__namedParameters.context_options?	ContextOptions
__namedParameters.resolution_scale	number

Returns

OffscreenSurface<ContextType, ContextOptions>

Overrides

RenderingSurfaceBase.constructor;

Accessors

width

Get Signature

get width(): number

Defined in: livelink.js/sources/rendering/surfaces/OffscreenSurface.ts:63

Returns

number

Overrides

RenderingSurfaceBase.width

---

height

Get Signature

get height(): number

Defined in: livelink.js/sources/rendering/surfaces/OffscreenSurface.ts:69

Returns

number

Overrides

RenderingSurfaceBase.height

---

context

Get Signature

get context(): ContextProvider

Defined in: livelink.js/sources/rendering/surfaces/OffscreenSurface.ts:76

Returns

ContextProvider

---

cameras

Get Signature

get cameras(): readonly Entity[]

Defined in: livelink.js/sources/rendering/surfaces/OffscreenSurface.ts:83

Returns

readonly Entity[]

---

resolution_scale

Get Signature

get resolution_scale(): number

Defined in: livelink.js/sources/rendering/surfaces/OffscreenSurface.ts:128

Returns

number

Set Signature

set resolution_scale(scale: number): void

Defined in: livelink.js/sources/rendering/surfaces/OffscreenSurface.ts:135

Parameters

Parameter	Type
scale	number

Returns

void

Methods

release()

release(): void

Defined in: livelink.js/sources/rendering/surfaces/OffscreenSurface.ts:92

Returns

void

Overrides

RenderingSurfaceBase.release

---

_drawFrame()

_drawFrame(frame: {
  frame: OffscreenCanvas | VideoFrame;
  left: number;
  top: number;
  meta_data: FrameMetaData;
 }): void

Defined in: livelink.js/sources/rendering/surfaces/OffscreenSurface.ts:100

Parameters

Parameter	Type
frame	{ frame: OffscreenCanvas | VideoFrame; left: number; top: number; meta_data: FrameMetaData; }
frame.frame	OffscreenCanvas | VideoFrame
frame.left	number
frame.top	number
frame.meta_data	FrameMetaData

Returns

void

Overrides

RenderingSurfaceBase._drawFrame;

---

getBoundingRect()

getBoundingRect(): Rect

Defined in: livelink.js/sources/rendering/surfaces/OffscreenSurface.ts:112

Returns

Rect

Overrides

RenderingSurfaceBase.getBoundingRect

---

resize()

resize(width: number, height: number): void

Defined in: livelink.js/sources/rendering/surfaces/OffscreenSurface.ts:119

Parameters

Parameter	Type
width	number
height	number

Returns

void