Struct ArCameraConfigFilter

Used to filter the set of camera configurations returned by XRCameraSubsystem.GetConfigurations.

Namespace: UnityEngine.XR.ARCore
Syntax
public struct ArCameraConfigFilter : IDisposable, IEquatable<ArCameraConfigFilter>

Constructors

ArCameraConfigFilter(ArSession)

Creates a new, default-constructed ArCameraConfigFilter.

Declaration
public ArCameraConfigFilter(ArSession session)
Parameters
Type Name Description
ArSession session

A non-null ArSession.
Remarks

When you no longer need the ArCameraConfigFilter, you should destroy it by calling Dispose(). If you do not dispose it, ARCore will leak memory.

Properties

IsNull

(Read Only) Indicates whether this ArCameraConfigFilter is Null.

Declaration
public readonly bool IsNull { get; }
Property Value
Type Description
Boolean

Null

Represents a null ArCameraConfigFilter, i.e., one whose underlying native pointer is null.

Declaration
public static readonly ArCameraConfigFilter Null { get; }
Property Value
Type Description
ArCameraConfigFilter

Methods

AsIntPtr()

Gets the underlying native pointer for this ArCameraConfigFilter.

Declaration
public IntPtr AsIntPtr()
Returns
Type Description
IntPtr

Returns the underlying native pointer for this ArCameraConfigFilter.

Dispose()

Destroys this ArCameraConfigFilter and sets the underlying native pointer to null.

Declaration
public void Dispose()
Remarks

You should only dispose an ArCameraConfigFilter if you explicitly created it, e.g., by calling ArCameraConfigFilter(ArSession). If you convert an existing config from an IntPtr (e.g., by calling FromIntPtr(IntPtr)), then you should not dispose it.

Equals(Object)

Tests for equality.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj

An Object to compare against.
Returns
Type Description
Boolean

Returns true if obj is an ArCameraConfigFilter and it compares equal to this one using Equals(ArCameraConfigFilter).
Overrides

Equals(ArCameraConfigFilter)

Tests for equality.

Declaration
public bool Equals(ArCameraConfigFilter other)
Parameters
Type Name Description
ArCameraConfigFilter other

The ArCameraConfigFilter to compare against.
Returns
Type Description
Boolean

Returns true if the underlying native pointers are the same. Returns false otherwise.
Remarks

Two ArCameraConfigFilters are considered equal if their underlying pointers are equal.

FromIntPtr(IntPtr)

Create a ArCameraConfigFilter from an existing native pointer. The native pointer must point to an existing ArCameraConfigFilter.

Declaration
public static ArCameraConfigFilter FromIntPtr(IntPtr value)
Parameters
Type Name Description
IntPtr value

A pointer to an existing native ArCameraConfigFilter.
Returns
Type Description
ArCameraConfigFilter

Returns an ArCameraConfigFilter whose underlying native pointer is value.

GetDepthSensorUsage(ArSession)

Gets the desired depth sensor usages to allow.

Declaration
public ArCameraConfigDepthSensorUsage GetDepthSensorUsage(ArSession session)
Parameters
Type Name Description
ArSession session

The ARCore ArSession.
Returns
Type Description
ArCameraConfigDepthSensorUsage

Returns the ArCameraConfigDepthSensorUsage values allowed by this filter.

GetHashCode()

Generates a hash code suitable for use with a HashSet or Dictionary

Declaration
public override int GetHashCode()
Returns
Type Description
Int32

Returns a hash code for this ArCameraConfigFilter.
Overrides

GetTargetFps(ArSession)

Gets the desired frame rates to allow.

Declaration
public ArCameraConfigTargetFps GetTargetFps(ArSession session)
Parameters
Type Name Description
ArSession session

The ARCore ArSession.
Returns
Type Description
ArCameraConfigTargetFps

Returns the frame rates allowed by this filter.

SetDepthSensorUsage(ArSession, ArCameraConfigDepthSensorUsage)

Sets the desired depth sensor usages to allow.

Declaration
public void SetDepthSensorUsage(ArSession session, ArCameraConfigDepthSensorUsage depthSensorUsage)
Parameters
Type Name Description
ArSession session

The ARCore ArSession.
ArCameraConfigDepthSensorUsage depthSensorUsage

The ArCameraConfigDepthSensorUsage values allowed by this filter.

SetTargetFps(ArSession, ArCameraConfigTargetFps)

Sets the desired frame rates to allow.

Declaration
public void SetTargetFps(ArSession session, ArCameraConfigTargetFps targetFps)
Parameters
Type Name Description
ArSession session

The ARCore ArSession.
ArCameraConfigTargetFps targetFps

The ArCameraConfigTargetFps values allowed by this filter.

Operators

Equality(ArCameraConfigFilter, ArCameraConfigFilter)

Tests for equality. Same as Equals(ArCameraConfigFilter).

Declaration
public static bool operator ==(ArCameraConfigFilter lhs, ArCameraConfigFilter rhs)
Parameters
Type Name Description
ArCameraConfigFilter lhs

The ArCameraConfigFilter to compare with rhs.
ArCameraConfigFilter rhs

The ArCameraConfigFilter to compare with lhs.
Returns
Type Description
Boolean

Returns true if lhs is equal to rhs using Equals(ArCameraConfigFilter). Returns false otherwise.

Explicit(ArCameraConfigFilter to IntPtr)

Casts an ArCameraConfigFilter to its underlying native pointer.

Declaration
public static explicit operator IntPtr(ArCameraConfigFilter filter)
Parameters
Type Name Description
ArCameraConfigFilter filter

The ArCameraConfigFilter to cast.
Returns
Type Description
IntPtr

Returns the underlying native pointer for filter

Inequality(ArCameraConfigFilter, ArCameraConfigFilter)

Tests for inequality. Same as the negation of Equals(ArCameraConfigFilter).

Declaration
public static bool operator !=(ArCameraConfigFilter lhs, ArCameraConfigFilter rhs)
Parameters
Type Name Description
ArCameraConfigFilter lhs

The ArCameraConfigFilter to compare with rhs.
ArCameraConfigFilter rhs

The ArCameraConfigFilter to compare with lhs.
Returns
Type Description
Boolean

Returns false if lhs is equal to rhs using Equals(ArCameraConfigFilter). Returns true otherwise.

See Also