Skip to main content
Version: 3.3

enum DepthMode

(Niantic.Lightship.AR.Utilities.Preloading.DepthMode)

Overview​

The Lightship depth model to use.


enum DepthMode: byte {
        Unspecified = 0,
        Custom      = 1,
        Fast        = 2,
        Medium      = 3,
        Smooth      = 4,
};

Detailed Documentation​

The Lightship depth model to use.

This is analogous to Unity's UnityEngine.XR.ARSubsystems.EnvironmentDepthMode.

Enum Values​

Unspecified - The default model will be used, if applicable.

Custom - Lightship will use the model file provided by the user.

The model file path can be provided via the ARDK configuration file or with IModelPreloader.RegisterModel(DepthMode, string).

Fast - Depth will be generated at the fastest resolution.

Medium - Depth will be generated at a medium resolution.

Smooth - Depth will be generated at the best resolution.