WebXRManagedOutputCanvas

Class WebXRManagedOutputCanvas

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

Hierarchy

WebXRManagedOutputCanvas

Implements

WebXRRenderTarget

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WebXRManagedOutputCanvas(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions): WebXRManagedOutputCanvas

- Defined in .temp/docdirectory/doc.d.ts:95458
Initializes the canvas to be added/removed upon entering/exiting xr

Parameters
- _xrSessionManager: WebXRSessionManager
  
  The XR Session manager
- Optional _options: WebXRManagedOutputCanvasOptions
  
  optional configuration for this canvas output. defaults will be used if not provided
Returns WebXRManagedOutputCanvas

Properties

canvasContextSearch playground for canvasContext

canvasContext: WebGLRenderingContext

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

onXRLayerInitObservableSearch playground for onXRLayerInitObservable

onXRLayerInitObservable: Observable<XRWebGLLayer>

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

xrLayerSearch playground for xrLayer

xrLayer: Nullable<XRWebGLLayer>

xr layer for the canvas

Methods

disposeSearch playground for dispose

dispose(): void

Implementation of WebXRRenderTarget.dispose
- Defined in .temp/docdirectory/doc.d.ts:95468
Disposes of the object

Returns void

initializeXRLayerAsyncSearch playground for initializeXRLayerAsync

initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>

Implementation of WebXRRenderTarget.initializeXRLayerAsync
- Defined in .temp/docdirectory/doc.d.ts:95474
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