Skip to main content

XRContext

Defined in: livelink.js/sources/rendering/contexts/XRContext.ts:15

Experimental

Extends

Constructors

new XRContext()

new XRContext(
canvas: OffscreenCanvas | HTMLCanvasElement,
context_type: "webgl" | "webgl2",
context_attributes?: WebGLContextAttributes & {
xrCompatible: boolean;
}): XRContext

Defined in: livelink.js/sources/rendering/contexts/XRContext.ts:92

Experimental

Parameters

ParameterTypeDefault value
canvasOffscreenCanvas | HTMLCanvasElementundefined
context_type"webgl" | "webgl2""webgl"
context_attributes?WebGLContextAttributes & { xrCompatible: boolean; }undefined

Returns

XRContext

Overrides

ContextProvider.constructor

Properties

PropertyTypeDefault valueDescription
screen_distancenumber25Experimental
scale_factornumber1Experimental
fake_alpha_enabledbooleanfalseExperimental

Accessors

native

Get Signature

get native(): WebGLRenderingContext | WebGL2RenderingContext

Defined in: livelink.js/sources/rendering/contexts/XRContext.ts:78

Experimental

Returns

WebGLRenderingContext | WebGL2RenderingContext


frame_buffer

Set Signature

set frame_buffer(fb: WebGLFramebuffer): void

Defined in: livelink.js/sources/rendering/contexts/XRContext.ts:85

Experimental

Parameters
ParameterType
fbWebGLFramebuffer
Returns

void


meta_data

Get Signature

get meta_data(): null | FrameMetaData

Defined in: livelink.js/sources/rendering/contexts/XRContext.ts:127

Experimental

Returns

null | FrameMetaData

Methods

drawFrame()

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

Defined in: livelink.js/sources/rendering/contexts/XRContext.ts:115

Experimental

Parameters

ParameterType
frame{ frame: OffscreenCanvas | VideoFrame; left: number; top: number; meta_data: FrameMetaData; }
frame.frameOffscreenCanvas | VideoFrame
frame.leftnumber
frame.topnumber
frame.meta_dataFrameMetaData

Returns

void

Overrides

ContextProvider.drawFrame


drawXRFrame()

drawXRFrame(__namedParameters: {
xr_views: {
view: XRView;
viewport: XRViewport;
frame_camera_transform: {
position: Vec3;
orientation: Quat;
};
}[];
}): void

Defined in: livelink.js/sources/rendering/contexts/XRContext.ts:134

Experimental

Parameters

ParameterType
__namedParameters{ xr_views: { view: XRView; viewport: XRViewport; frame_camera_transform: { position: Vec3; orientation: Quat; }; }[]; }
__namedParameters.xr_views{ view: XRView; viewport: XRViewport; frame_camera_transform: { position: Vec3; orientation: Quat; }; }[]

Returns

void


refreshSize()

refreshSize(): void

Defined in: livelink.js/sources/rendering/contexts/XRContext.ts:231

Experimental

Returns

void

Overrides

ContextProvider.refreshSize


release()

release(): void

Defined in: livelink.js/sources/rendering/contexts/XRContext.ts:236

Experimental

Returns

void

Overrides

ContextProvider.release