XRConfiguration

Interface XRConfiguration

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

See

RealityAPI.connectXR

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

Properties

autoShowBackgroundFeed? deviceScreenshotsEnabled? imageSourceConfig modelTrackingEnabled? rayCastingEnabled?

Properties

OptionalautoShowBackgroundFeed

autoShowBackgroundFeed?: boolean

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

Default

true

OptionaldeviceScreenshotsEnabled

deviceScreenshotsEnabled?: boolean

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

Default

false

imageSourceConfig

imageSourceConfig: XRImageSourceConfig

Specifies the configuration of the source of the XR images.

OptionalmodelTrackingEnabled

modelTrackingEnabled?: boolean

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

Default

true

OptionalrayCastingEnabled

rayCastingEnabled?: boolean

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

Default

false