@babylonjs/core|

WebXRManagedOutputCanvas

Class WebXRManagedOutputCanvas

Creates a canvas that is added/removed from the webpage when entering/exiting XR

Implements

WebXRRenderTarget

Index

Constructors

Properties

canvasContext onXRLayerInitObservable xrLayer

Methods

dispose initializeXRLayerAsync

Constructors

constructor

new WebXRManagedOutputCanvas(
_xrSessionManager: WebXRSessionManager,
_options?: WebXRManagedOutputCanvasOptions,
): WebXRManagedOutputCanvas
Initializes the canvas to be added/removed upon entering/exiting xr
Parameters
- _xrSessionManager: WebXRSessionManager
  The XR Session manager
- _options: WebXRManagedOutputCanvasOptions = ...
  optional configuration for this canvas output. defaults will be used if not provided
Returns WebXRManagedOutputCanvas
- Defined in packages/dev/core/src/XR/webXRManagedOutputCanvas.ts:83

Properties

canvasContext

canvasContext: WebGL2RenderingContext

Rendering context of the canvas which can be used to display/mirror xr content

onXRLayerInitObservable

onXRLayerInitObservable: Observable<XRWebGLLayer> = ...

Observers registered here will be triggered when the xr layer was initialized

xrLayer

xrLayer: any = null

xr layer for the canvas

Methods

dispose

dispose(): void
Disposes of the object

Returns void
Implementation of WebXRRenderTarget.dispose
- Defined in packages/dev/core/src/XR/webXRManagedOutputCanvas.ts:114

initializeXRLayerAsync

initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>
Initializes a XRWebGLLayer to be used as the session's baseLayer.
Parameters
- xrSession: XRSession
  xr session
Returns Promise<XRWebGLLayer>
a promise that will resolve once the XR Layer has been created
Implementation of WebXRRenderTarget.initializeXRLayerAsync
- Defined in packages/dev/core/src/XR/webXRManagedOutputCanvas.ts:152