XRState

• webVis API Reference
• XRState

Type Alias XRState

XRState: {
    anchored: boolean;
    backgroundFeedVisible: boolean;
    modelTrackingPhase: XRModelTrackingPhase;
    worldMappingStatus: XRWorldMappingStatus;
}

Reflects the current state of the XR system.

Type declaration

• anchored: boolean

  Whether the rendered model is anchored in the XR space or not.

  See

  • RealityAPI.anchorXR
  • RealityAPI.unanchorXR

• backgroundFeedVisible: boolean

  Whether the background feed is visible or not.

  See

  • RealityAPI.showXRBackgroundFeed
  • RealityAPI.hideXRBackgroundFeed

• modelTrackingPhase: XRModelTrackingPhase

  Specifies in which phase the model tracking is.

  If the XR system does not support model tracking, this value will always be XRModelTrackingPhase.NONE.

• worldMappingStatus: XRWorldMappingStatus

  Represents the current world mapping status of the XR system if available.

See

• RealityAPI.getXRState
• XRStateChangedEvent