Skip to main content

Class: OffscreenSurface<ContextType, ContextOptions>

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

Extends

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

ParameterType
__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.widthnumber
__namedParameters.heightnumber
__namedParameters.context_constructor(canvas: OffscreenCanvas | HTMLCanvasElement, context_type: ContextType, options?: ContextOptions) => ContextProvider
__namedParameters.context_typeContextType
__namedParameters.context_options?ContextOptions
__namedParameters.resolution_scalenumber

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:131

Returns

number

Set Signature

set resolution_scale(scale: number): void

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

Parameters
ParameterType
scalenumber
Returns

void

Methods

release()

release(): void

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

Returns

void

Overrides

RenderingSurfaceBase.release


getBoundingRect()

getBoundingRect(): Rect

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

Returns

Rect

Overrides

RenderingSurfaceBase.getBoundingRect


resize()

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

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

Parameters

ParameterType
widthnumber
heightnumber

Returns

void