Skip to main content

Class: LayersOptions

Defined in: src/layers/LayersOptions.ts:9

Options for WebXR composition layers.

Off by default. Layers are an optional session feature and the layer types an app would want are newer than the SDK's baseline browser, so asking for them unconditionally would mean every app pays for a capability most do not use.

Constructors​

Constructor​

new LayersOptions(): LayersOptions

Returns​

LayersOptions

Properties​

enabled​

enabled: boolean = false

Defined in: src/layers/LayersOptions.ts:11

Whether to request the layers session feature.

video​

video: boolean = true

Defined in: src/layers/LayersOptions.ts:20

Whether a video shown through VideoView should be presented as a composition layer when the platform allows it.

Falls back to rendering into the scene as a texture when it cannot, so an app can leave this on and still work everywhere.