Class: WebXRHelper
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:45
Constructors
new WebXRHelper()
new WebXRHelper(resolution_scale: number): WebXRHelper
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:117
Parameters
| Parameter | Type | Default value |
|---|---|---|
resolution_scale | number | 1.0 |
Returns
Properties
| Property | Type | Default value | Description |
|---|---|---|---|
cameras_origin | null | CamerasOriginTransform | null | Use it to shift the XRView camera transforms |
Accessors
session
Get Signature
get session(): null | XRSession
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:102
Returns
null | XRSession
mode
Get Signature
get mode(): XRSessionMode
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:107
Returns
XRSessionMode
reference_space
Get Signature
get reference_space(): null | XRReferenceSpace
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:112
Returns
null | XRReferenceSpace
fakeAlpha
Get Signature
get fakeAlpha(): boolean
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:154
Get the fake alpha mode flag of the XRContext. If enabled: the alpha channel is set highest intensity among rgb channels for all pixels with all rgb intensities inferior than 0.1.
Returns
boolean
Set Signature
set fakeAlpha(value: boolean): void
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:164
Set the fake alpha mode flag of the XRContext. If enabled: the alpha channel is set highest intensity among rgb channels for all pixels with all rgb intensities inferior than 0.1.
Parameters
| Parameter | Type |
|---|---|
value | boolean |
Returns
void
resolution_scale
Get Signature
get resolution_scale(): number
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:803
Returns
number
Set Signature
set resolution_scale(value: number): void
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:811
Parameters
| Parameter | Type |
|---|---|
value | number |
Returns
void
Methods
isSessionSupported()
static isSessionSupported(mode: XRSessionMode): Promise<boolean>
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:86
Test if the provided XR session mode is supported by this browser.
Parameters
| Parameter | Type | Description |
|---|---|---|
mode | XRSessionMode | defines the XR session mode to test |
Returns
Promise<boolean>
Resolves with boolean indicating if the provided session mode is supported.
release()
release(): Promise<void>
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:133
Release the XRSession and the rendering OffscreenSurface.
Returns
Promise<void>
initialize()
initialize(mode: XRSessionMode, options: XRSessionInit): Promise<void>
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:174
Initialize the XRSession.
Parameters
| Parameter | Type | Description |
|---|---|---|
mode | XRSessionMode | |
options | XRSessionInit |
Returns
Promise<void>
configureViewports()
configureViewports(livelink: Livelink, enableScale: boolean): Promise<void>
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:221
Configure the size and scale of the livelink viewports based on the XR views.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
livelink | Livelink | undefined | |
enableScale | boolean | false |
Returns
Promise<void>
start()
start(): void
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:304
Start the XRFrame animation loop.
Returns
void
stop()
stop(): void
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:311
Stop the XRFrame animation loop.
Returns
void
setReferenceSpaceType()
setReferenceSpaceType(type: XRReferenceSpaceType): Promise<XRReferenceSpace>
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:323
Sets the reference space of the XR session
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
type | XRReferenceSpaceType | "local" | https://developer.mozilla.org/en-US/docs/Web/API/XRSession/requestReferenceSpace#type |
Returns
Promise<XRReferenceSpace>
Resolves with the reference to the new reference space.
updateRenderState()
updateRenderState(layer_init: XRWebGLLayerInit): Promise<void>
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:338
Update the XRSesssion render state with the native WebGLREnderingContext of the viewport's ContextWebGL.
Parameters
| Parameter | Type | Description |
|---|---|---|
layer_init | XRWebGLLayerInit |
Returns
Promise<void>
Resolves when the render state is updated.
releaseLivelinkViewports()
releaseLivelinkViewports(): void
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:691
Returns
void