GARSemanticMode

Summary

Enumerations

GARSemanticMode{
  GARSemanticModeDisabled = 0,
  GARSemanticModeEnabled = 1
}
enum
Describes the behavior of the Scene Semantics API.

Enumerations

GARSemanticMode

 GARSemanticMode

Describes the behavior of the Scene Semantics API.

Scene Semantics uses a machine learning model to label each pixel from the camera feed with a GARSemanticLabel. See the Scene Semantics Developer Guide for more information.

The Scene Semantics API is currently able to distinguish between outdoor labels specified by GARSemanticLabel. Usage indoors is currently unsupported and may yield unreliable results. Some ARCore supported devices do not support the Scene Semantics API. Use isSemanticModeSupported: (GARSession(Semantics)) to query for support for Scene Semantics. Affected devices are also indicated on the ARCore supported devices page.

The default value is GARSemanticModeDisabled. Use GARSessionConfiguration.semanticMode and setConfiguration:error: (GARSession)to set the desired mode.

Properties
GARSemanticModeDisabled

The Scene Semantics API is not enabled.

Calls to GARFrame::acquireSemanticImage:, GARFrame::acquireSemanticConfidenceImage:, and GARFrame::fractionForSemanticLabel:error: will not return valid results.

This is the default mode.

GARSemanticModeEnabled

The Scene Semantics API is enabled.

Calls to GARFrame::acquireSemanticImage:, GARFrame::acquireSemanticConfidenceImage:, and GARFrame::fractionForSemanticLabel:error: will return valid results.

Use GARSessionConfiguration.semanticMode and setConfiguration:error: (GARSession)to set the desired mode.