Class WebXRLayers
Hierarchy
- WebXRAbstractFeature
- WebXRLayers
Index
Constructors
constructor
Construct a new (abstract) WebXR feature
Parameters
_xrSessionManager: WebXRSessionManager
Optional _options: IWebXRLayersOptions
Returns WebXRLayers
Properties
disable
Should auto-attach be disabled?
is
Is this feature disposed?
xr
The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
Static Readonly NameSearch playground for Name
The module's name
Static Readonly VersionSearch playground for Version
The (Babylon) version of this module. This is an integer representing the implementation version. This number does not correspond to the WebXR specs version
Accessors
attached
Is this feature attached
Returns boolean
Methods
addXRSession
Add a new layer to the already-existing list of layers
Parameters
wrappedLayer: WebXRLayerWrapper
the new layer to add to the existing ones
Returns void
attachSearch playground for attach
Attach this feature. Will usually be called by the features manager.
Returns boolean
true if successful.
create
Creates a new XRProjectionLayer.
Parameters
Optional params: XRProjectionLayerInit
an object providing configuration options for the new XRProjectionLayer.
Optional multiview: boolean
whether the projection layer should render with multiview.
Returns WebXRProjectionLayerWrapper
the projection layer
createXRWebGLLayerSearch playground for createXRWebGLLayer
Creates a new XRWebGLLayer.
Parameters
Optional params: XRWebGLLayerInit
an object providing configuration options for the new XRWebGLLayer
Returns WebXRWebGLLayerWrapper
the XRWebGLLayer
detachSearch playground for detach
detach this feature.
Returns boolean
true if successful, false if failed or already detached
disposeSearch playground for dispose
Dispose this feature and all of the resources attached.
Returns void
is
This function will be executed during before enabling the feature and can be used to not-allow enabling it. Note that at this point the session has NOT started, so this is purely checking if the browser supports it
Returns boolean
whether or not the feature is compatible in this environment
setXRSession
Sets the layers to be used by the XR session. Note that you must call this function with any layers you wish to render to since it adds them to the XR session's render state (replacing any layers that were added in a previous call to setXRSessionLayers or updateRenderState). This method also sets up the session manager's render target texture provider as the first layer in the array, which feeds the WebXR camera(s) attached to the session.
Parameters
wrappedLayers: WebXRLayerWrapper[]
An array of WebXRLayerWrapper, usually returned from the WebXRLayers createLayer functions.
Returns void
Exposes the WebXR Layers API.