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.

XRConfiguration

Type Alias XRConfiguration

XRConfiguration: {
    autoShowBackgroundFeed?: boolean;
    deviceScreenshotsEnabled?: boolean;
    imageSourceConfig: XRImageSourceConfig;
    modelTrackingEnabled?: boolean;
    rayCastingEnabled?: boolean;
}

Configuration for the XR system. The configuration is used when connecting to the XR system.

Type declaration

  • OptionalautoShowBackgroundFeed?: boolean

    If true, the XR system will show the XR background feed automatically when it is available.

    Default

    true
  • OptionaldeviceScreenshotsEnabled?: boolean

    If true, the XR system will be able to use functionalities that require device screenshots.

    Default

    false
  • imageSourceConfig: XRImageSourceConfig

    Specifies the configuration of the source of the XR images.

  • OptionalmodelTrackingEnabled?: boolean

    If true, the XR system will be able to use functionalities that require model-based tracking.

    Default

    true
  • OptionalrayCastingEnabled?: boolean

    If true, the XR system will be able to use functionalities that require ray casting.

    Default

    false

See

RealityAPI.connectXR