Google is committed to advancing racial equity for Black communities. See how.

Google.XR.ARCoreExtensions.ARCoreExtensionsCameraConfigFilter

The ARCoreExtensionsCameraConfigFilter class is used by the camera manager to derive a list of camera configurations available on the device at runtime.

Summary

It is possible to select options in such a way that some devices will have no available configurations at runtime. In this case, your app will not run.

Beginning with ARCore SDK 1.15.0, some devices support additional camera configs with lower GPU texture resolutions than the device's default GPU texture resolution. See the ARCore supported devices page for an up to date list of devices with this capability.

An app may adjust its capabilities at runtime by selecting a wider range of config filters and using ARCoreExtensions.OnChooseXRCameraConfiguration to specify a selection function. In that function the app may then adjust its runtime settings and select an appropriate camera configuration.

If no callback is registered, ARCore Extensions will use the first XRCameraConfiguration in the list of available configurations.

Inheritance

Inherits from: ScriptableObject

Public attributes

DepthSensorUsage = CameraConfigDepthSensorUsage.RequireAndUse | CameraConfigDepthSensorUsage.DoNotUse
Allows an app to use or disable a hardware depth sensor, such as a time-of-flight sensor (or ToF sensor), if present on the device.
StereoCameraUsage = CameraConfigStereoCameraUsage.RequireAndUse | CameraConfigStereoCameraUsage.DoNotUse
Allows an app to use or disable additional cameras to improve tracking.
TargetCameraFramerate = CameraConfigTargetFps.Target30FPS | CameraConfigTargetFps.Target60FPS
The camera frame rate filter for the currently selected camera.

Public functions

CopyFrom(ARCoreExtensionsCameraConfigFilter otherFilter)
void
ValueType copy from another ARCoreExtensionsCameraConfigFilter object into this one.
Equals(object other)
override bool
ValueType check if two ARCoreExtensionsCameraConfigFilter objects are equal.
GetDepthSensorUsageInfo()
HelpAttribute
Reflection function used by 'DynamicHelp' for DepthSensorUsage.
GetHashCode()
override int
Return a hash code for this object.
GetStereoCameraUsageInfo()
HelpAttribute
Reflection function used by 'DynamicHelp' for StereoCameraUsage.
GetTargetCameraFramerateInfo()
HelpAttribute
Reflection function used by 'DynamicHelp' for TargetCameraFramerate.
OnValidate()
void
Unity's OnValidate.

Public attributes

DepthSensorUsage

CameraConfigDepthSensorUsage DepthSensorUsage =
            CameraConfigDepthSensorUsage.RequireAndUse | CameraConfigDepthSensorUsage.DoNotUse

Allows an app to use or disable a hardware depth sensor, such as a time-of-flight sensor (or ToF sensor), if present on the device.

StereoCameraUsage

CameraConfigStereoCameraUsage StereoCameraUsage =
            CameraConfigStereoCameraUsage.RequireAndUse | CameraConfigStereoCameraUsage.DoNotUse

Allows an app to use or disable additional cameras to improve tracking.

TargetCameraFramerate

CameraConfigTargetFps TargetCameraFramerate =
            CameraConfigTargetFps.Target30FPS | CameraConfigTargetFps.Target60FPS

The camera frame rate filter for the currently selected camera.

Public functions

CopyFrom

void CopyFrom(
  ARCoreExtensionsCameraConfigFilter otherFilter
)

ValueType copy from another ARCoreExtensionsCameraConfigFilter object into this one.

Details
Parameters
otherFilter

Equals

override bool Equals(
  object other
)

ValueType check if two ARCoreExtensionsCameraConfigFilter objects are equal.

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

GetDepthSensorUsageInfo

HelpAttribute GetDepthSensorUsageInfo()

Reflection function used by 'DynamicHelp' for DepthSensorUsage.

Details
Returns
The help attribute of the hardware depth sensor usage filter, such as a time-of-flight (ToF) sensor.

GetHashCode

override int GetHashCode()

Return a hash code for this object.

Details
Returns
A hash code value.

GetStereoCameraUsageInfo

HelpAttribute GetStereoCameraUsageInfo()

Reflection function used by 'DynamicHelp' for StereoCameraUsage.

Details
Returns
The help attribute of stereo sensor usage filter.

GetTargetCameraFramerateInfo

HelpAttribute GetTargetCameraFramerateInfo()

Reflection function used by 'DynamicHelp' for TargetCameraFramerate.

Details
Returns
The help attribute of target camera framerate filter.

OnValidate

void OnValidate()

Unity's OnValidate.