GoogleARCore.ARCoreSessionConfig

Holds settings that are used to configure the session.

Summary

Inheritance

Inherits from: ScriptableObject

Public attributes

AugmentedImageDatabase
The database to use for detecting AugmentedImage Trackables.
EnableCloudAnchor = false
bool
Toggles whether cloud anchor is enabled.
EnableLightEstimation = true
bool
Toggles whether light estimation is enabled.
MatchCameraFramerate = true
bool
Toggles whether ARCore may introduce a delay into Unity's frame update to match the rate that the camera sensor is delivering frames (this is 30 frames-per-second on most devices).
PlaneFindingMode = DetectedPlaneFindingMode.HorizontalAndVertical
Chooses which plane finding mode will be used.

Properties

EnablePlaneFinding
bool
Gets or sets a value indicating whether PlaneFinding is enabled.

Public functions

CopyFrom(ARCoreSessionConfig other)
void
ValueType copy from another SessionConfig object into this one.
Equals(object other)
override bool
ValueType check if two SessionConfig objects are equal.
GetHashCode()
override int
Return a hash code for this object.

Public attributes

AugmentedImageDatabase

AugmentedImageDatabase AugmentedImageDatabase

The database to use for detecting AugmentedImage Trackables.

EnableCloudAnchor

bool EnableCloudAnchor = false

Toggles whether cloud anchor is enabled.

EnableLightEstimation

bool EnableLightEstimation = true

Toggles whether light estimation is enabled.

MatchCameraFramerate

bool MatchCameraFramerate = true

Toggles whether ARCore may introduce a delay into Unity's frame update to match the rate that the camera sensor is delivering frames (this is 30 frames-per-second on most devices).

Enabling this setting can reduce power consumption caused by rendering the same background texture more than once. Since enabling this setting also sets QualitySetting.vSyncCount to 0 the entire Unity application (e.g animations, UI) will also update at the camera sensor frame rate.

Note that enabling this setting does not guarentee each Unity frame will have a new and unique camera background texture. This is because the period of time ARCore will wait for a new camera frame to become available is capped (currently at 66ms) to avoid a deadlock.

PlaneFindingMode

DetectedPlaneFindingMode PlaneFindingMode = DetectedPlaneFindingMode.HorizontalAndVertical

Chooses which plane finding mode will be used.

Properties

EnablePlaneFinding

bool EnablePlaneFinding

Gets or sets a value indicating whether PlaneFinding is enabled.

Public functions

CopyFrom

void CopyFrom(
  ARCoreSessionConfig other
)

ValueType copy from another SessionConfig object into this one.

Details
Parameters
other
The SessionConfig to copy from.

Equals

override bool Equals(
  object other
)

ValueType check if two SessionConfig objects are equal.

Details
Parameters
other
The other SessionConfig.
Returns
True if the two SessionConfig objects are value-type equal, otherwise false.

GetHashCode

override int GetHashCode()

Return a hash code for this object.

Details
Returns
A hash code value.

Send feedback about...