WebXRHelper
@3dverse/livelink-react v0.2.32
@3dverse/livelink-react / WebXRHelper
Class: WebXRHelper
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:48
Constructors
new WebXRHelper()
new WebXRHelper(
resolution_scale):WebXRHelper
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:120
Parameters
resolution_scale
number = 1.0
Returns
Properties
cameras_origin
cameras_origin:
null|CamerasOriginTransform=null
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:61
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:105
Returns
null | XRSession
mode
Get Signature
get mode():
XRSessionMode
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:110
Returns
XRSessionMode
reference_space
Get Signature
get reference_space():
null|XRReferenceSpace
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:115
Returns
null | XRReferenceSpace
fakeAlpha
Get Signature
get fakeAlpha():
boolean
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:161
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):void
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:171
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
value
boolean
Returns
void
resolution_scale
Get Signature
get resolution_scale():
number
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:810
Returns
number
Set Signature
set resolution_scale(
value):void
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:818
Parameters
value
number
Returns
void
Methods
isSessionSupported()
staticisSessionSupported(mode):Promise<boolean>
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:89
Test if the provided XR session mode is supported by this browser.
Parameters
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:136
Release the XRSession and the rendering OffscreenSurface.
Returns
Promise<void>
initialize()
initialize(
mode,options):Promise<void>
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:181
Initialize the XRSession.
Parameters
mode
XRSessionMode
options
XRSessionInit = {}
Returns
Promise<void>
configureViewports()
configureViewports(
livelink,enableScale):Promise<Viewport[]>
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:232
Configure the size and scale of the livelink viewports based on the XR views.
Parameters
livelink
Livelink
enableScale
boolean = false
Returns
Promise<Viewport[]>
start()
start():
void
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:319
Start the XRFrame animation loop.
Returns
void
setReferenceSpaceType()
setReferenceSpaceType(
type):Promise<XRReferenceSpace>
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:329
Sets the reference space of the XR session
Parameters
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):Promise<void>
Defined in: livelink.react/sources/web-xr/WebXRHelper.ts:344
Update the XRSesssion render state with the native WebGLREnderingContext of the viewport's ContextWebGL.
Parameters
layer_init
XRWebGLLayerInit = {}
Returns
Promise<void>
Resolves when the render state is updated.