Class WebXRCompositionLayerWrapper<LayerT, LayerTypeT>

constructor

• new WebXRCompositionLayerWrapper<
      LayerT extends XRCompositionLayer = XRCompositionLayer,
      LayerTypeT extends WebXRSupportedLayerType = WebXRLayerType,
  >(
      getWidth: () => number,
      getHeight: () => number,
      layer: LayerT,
      layerType: LayerTypeT,
      isMultiview: boolean,
      createRTTProvider: (
          xrSessionManager: WebXRSessionManager,
      ) => WebXRLayerRenderTargetTextureProvider<LayerTypeT>,
      _originalInternalTexture?: Nullable<InternalTexture>,
      _destroyLayerOnDispose?: boolean,
      isStatic?: boolean,
  ): WebXRCompositionLayerWrapper<LayerT, LayerTypeT>

  Type Parameters

  • LayerT extends XRCompositionLayer = XRCompositionLayer

    the concrete WebXR composition layer type

  • LayerTypeT extends WebXRSupportedLayerType = WebXRLayerType

  Parameters

  • getWidth: () => number
  • getHeight: () => number
  • layer: LayerT
  • layerType: LayerTypeT
  • isMultiview: boolean

    Whether the layer renders both views into a texture array.

  • createRTTProvider: (
        xrSessionManager: WebXRSessionManager,
    ) => WebXRLayerRenderTargetTextureProvider<LayerTypeT>
  • _originalInternalTexture: Nullable<InternalTexture> = null
  • _destroyLayerOnDispose: boolean = false
  • isStatic: boolean = false

    Whether the layer can only be rendered when its native needsRedraw flag is set.

  Returns WebXRCompositionLayerWrapper<LayerT, LayerTypeT>

_originalInternalTexture

createRTTProvider

getHeight

getWidth

ReadonlyisMediaLayer

ReadonlyisMultiview

ReadonlyisStatic

Readonlylayer

ReadonlylayerType

ReadonlyusesRenderTargetProvider

forceMonoPresentation

• get forceMonoPresentation(): boolean

  Gets whether the compositor presents the left-eye layer configuration to both eyes.

  Returns boolean

  Whether mono presentation is forced.

  Throws

  If mono presentation control is not supported by the active XR runtime.

• set forceMonoPresentation(value: boolean): void

  Sets whether the compositor presents the left-eye layer configuration to both eyes. Applications should continue rendering both eyes when this is enabled.

  Parameters

  • value: boolean

    Whether to force mono presentation.

  Returns void

  Throws

  If mono presentation control is not supported by the active XR runtime.

isForceMonoPresentationSupported

• get isForceMonoPresentationSupported(): boolean

  Whether the native layer exposes mono-presentation control.

  Returns boolean

isOpacitySupported

• get isOpacitySupported(): boolean

  Whether the native layer exposes compositor opacity control.

  Returns boolean

isQualitySupported

• get isQualitySupported(): boolean

  Whether the native layer exposes compositor quality hints.

  Returns boolean

opacity

• get opacity(): number

  Gets the compositor opacity applied to this layer.

  Returns number

  The native opacity in the range 0 to 1.

  Throws

  If opacity is not supported by the active XR runtime.

• set opacity(value: number): void

  Sets the compositor opacity applied to this layer. The native runtime clamps the value to the range 0 to 1.

  Parameters

  • value: number

    The desired opacity.

  Returns void

  Throws

  If opacity is not supported by the active XR runtime.

quality

• get quality(): XRLayerQuality

  Gets the compositor quality hint applied to this layer.

  Returns XRLayerQuality

  The current native layer quality hint.

  Throws

  If quality hints are not supported by the active XR runtime.

• set quality(value: XRLayerQuality): void

  Sets the compositor quality hint applied to this layer.

  Parameters

  • value: XRLayerQuality

    The desired quality hint.

  Returns void

  Throws

  If quality hints are not supported by the active XR runtime, or the native runtime rejects the value.

dispose

• dispose(): void

  Disposes the Babylon render-target resources and destroys the native layer when this wrapper owns it.

  Returns void