GoogleARCore. ARCoreSessionConfig
Holds settings that are used to configure the session.
Summary
Inheritance
Inherits from: ScriptableObject
Public attributes |
|
---|---|
AugmentedFaceMode = AugmentedFaceMode.Disabled
|
Chooses which GoogleARCore.AugmentedFaceMode the ARCore session uses.
|
AugmentedImageDatabase
|
The database to use for detecting AugmentedImage Trackables.
|
CameraFocusMode = CameraFocusMode.Fixed
|
Chooses the desired focus mode to be used by the ARCore camera.
|
EnableCloudAnchor = false
|
bool
Toggles whether the Cloud Anchors are enabled.
|
LightEstimationMode =
LightEstimationMode.EnvironmentalHDRWithReflections
|
Choose which light estimation mode will be used.
|
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 |
|
---|---|
EnableLightEstimation
|
bool
Gets or sets a value indicating whether light estimation is enabled. |
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.
|
OnValidate()
|
void
Unity OnValidate.
|
Public attributes
AugmentedFaceMode
AugmentedFaceMode AugmentedFaceMode = AugmentedFaceMode.Disabled
Chooses which GoogleARCore.AugmentedFaceMode the ARCore session uses.
AugmentedImageDatabase
AugmentedImageDatabase AugmentedImageDatabase
The database to use for detecting AugmentedImage Trackables.
When this value is null, Augmented Image detection is disabled.
CameraFocusMode
CameraFocusMode CameraFocusMode = CameraFocusMode.Fixed
Chooses the desired focus mode to be used by the ARCore camera.
The default focus mode varies by device and camera, and is set to optimize AR tracking. Currently the default on most ARCore devices and cameras is GoogleARCore.CameraFocusMode.Fixed
, although this default might change in the future.
Note, on devices where ARCore does not support auto focus mode due to the use of a fixed focus camera, setting GoogleARCore.CameraFocusMode.Auto
will be ignored. Similarly, on devices where tracking requires auto focus mode, setting GoogleARCore.CameraFocusMode.Fixed
will be ignored. See the ARCore supported devices page for a list of affected devices.
EnableCloudAnchor
bool EnableCloudAnchor = false
Toggles whether the Cloud Anchors are enabled.
LightEstimationMode
LightEstimationMode LightEstimationMode = LightEstimationMode.EnvironmentalHDRWithReflections
Choose which light estimation mode will be used.
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
EnableLightEstimation
bool EnableLightEstimation
Gets or sets a value indicating whether light estimation is enabled.
true
if enable light estimation; otherwise, false
.
Deprecated. Please use ARCoreSessionConfig.LightEstimationMode instead.
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 |
|
Equals
override bool Equals( object other )
ValueType check if two SessionConfig objects are equal.
Details | |||
---|---|---|---|
Parameters |
|
||
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.
|
OnValidate
void OnValidate()
Unity OnValidate.