Struct ARKitFocusRange

Represents the minimum and maximum supported lens position. A lens position value doesn't correspond to an exact physical distance, nor does it represent a consistent focus distance from device to device.

Implements

IEquatable<ARKitFocusRange>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.XR.ARKit

Assembly: Unity.XR.ARKit.dll

Syntax

public struct ARKitFocusRange : IEquatable<ARKitFocusRange>

Properties

maximumLensPosition

Maximum supported lens position. This value represent the furthest distance at which the lens can focus.

Declaration

public float maximumLensPosition { get; }

Property Value

Type	Description
float

minimumLensPosition

Minimum supported lens position. This value represent the shortest distance at which the lens can focus.

Declaration

public float minimumLensPosition { get; }

Property Value

Type	Description
float

Methods

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
bool	true if obj is an ARKitFocusRange and is equal to this instance using Equals(ARKitFocusRange).

Overrides

ValueType.Equals(object)

Equals(ARKitFocusRange)

Tests for equality.

Declaration

public bool Equals(ARKitFocusRange other)

Parameters

Type	Name	Description
ARKitFocusRange	other	The ARKitFocusRange to compare against.

Returns

Type	Description
bool	true if the lens position range is the same. Otherwise, false.

Remarks

Two ARKitFocusRanges are considered equal if their minimum lens position and maximum lens position are equal.

GetHashCode()

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

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for this ARKitFocusRange.

Overrides

ValueType.GetHashCode()

ToString()

Generates a string representation of this ARKitFocusRange suitable for debugging purposes.

Declaration

public override string ToString()

Returns

Type	Description
string	A string representation of this ARKitFocusRange.

Overrides

ValueType.ToString()

Operators

operator ==(ARKitFocusRange, ARKitFocusRange)

Tests for equality. Same as Equals(ARKitFocusRange).

Declaration

public static bool operator ==(ARKitFocusRange lhs, ARKitFocusRange rhs)

Parameters

Type	Name	Description
ARKitFocusRange	lhs	The ARKitFocusRange to compare with rhs.
ARKitFocusRange	rhs	The ARKitFocusRange to compare with lhs.

Returns

Type	Description
bool	true if lhs is equal to rhs using Equals(ARKitFocusRange). Otherwise, false.

operator !=(ARKitFocusRange, ARKitFocusRange)

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

Declaration

public static bool operator !=(ARKitFocusRange lhs, ARKitFocusRange rhs)

Parameters

Type	Name	Description
ARKitFocusRange	lhs	The ARKitFocusRange to compare with rhs.
ARKitFocusRange	rhs	The ARKitFocusRange to compare with lhs.

Returns

Type	Description
bool	false if lhs is equal to rhs using Equals(ARKitFocusRange). Otherwise, true.

Implements

IEquatable<T>