Warning

Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.

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