Struct XRTrackedImage

Contains low-level data for a tracked image in the environment.

Implements
Inherited Members
Namespace: UnityEngine.XR.ARSubsystems
Assembly: Unity.XR.ARSubsystems.dll
Syntax
public struct XRTrackedImage : ITrackable, IEquatable<XRTrackedImage>

Constructors

XRTrackedImage(TrackableId, Guid, Pose, Vector2, TrackingState, IntPtr)

Constructs an XRTrackedImage.

Declaration
public XRTrackedImage(TrackableId trackableId, Guid sourceImageId, Pose pose, Vector2 size, TrackingState trackingState, IntPtr nativePtr)
Parameters
Type Name Description
TrackableId trackableId

The TrackableId associated with this tracked image.
Guid sourceImageId

A GUID associated with the source image.
Pose pose

The Pose associated with the detected image.
Vector2 size

The size (dimensions) of the detected image.
TrackingState trackingState

The TrackingState of the detected image.
IntPtr nativePtr

A native pointer associated with the detected image.

Properties

defaultValue

Generates a XRTrackedImage populated with default values.

Declaration
public static XRTrackedImage defaultValue { get; }
Property Value
Type Description
XRTrackedImage

nativePtr

A native pointer associated with this tracked image. The data pointed to by this pointer is implementation-defined. While its lifetime is also implementation-defined, it should be valid at least until the next call to GetChanges(Allocator).

Declaration
public IntPtr nativePtr { get; }
Property Value
Type Description
IntPtr

pose

The Pose associated with this tracked image.

Declaration
public Pose pose { get; }
Property Value
Type Description
Pose

size

The size (dimensions) of this tracked image.

Declaration
public Vector2 size { get; }
Property Value
Type Description
Vector2

sourceImageId

The GUID associated with the source image.

Declaration
public Guid sourceImageId { get; }
Property Value
Type Description
Guid

trackableId

The TrackableId associated with this tracked image.

Declaration
public TrackableId trackableId { get; }
Property Value
Type Description
TrackableId

trackingState

The TrackingState associated with this tracked image.

Declaration
public TrackingState trackingState { get; }
Property Value
Type Description
TrackingState

Methods

Equals(object)

Tests for equality.

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

The object to compare against.
Returns
Type Description
bool

True if obj is of type XRTrackedImage and Equals(XRTrackedImage) also returns true; otherwise false.
Overrides

Equals(XRTrackedImage)

Tests for equality.

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

The other XRTrackedImage to compare against.
Returns
Type Description
bool

True if every field in other is equal to this XRTrackedImage, otherwise false.

GetHashCode()

Generates a hash suitable for use with containers like HashSet and Dictionary.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code generated from this object's fields.
Overrides

Operators

operator ==(XRTrackedImage, XRTrackedImage)

Tests for equality. Same as Equals(XRTrackedImage).

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

The left-hand side of the comparison.
XRTrackedImage rhs

The right-hand side of the comparison.
Returns
Type Description
bool

True if lhs is equal to rhs, otherwise false.

operator !=(XRTrackedImage, XRTrackedImage)

Tests for inequality. Same as !Equals(XRTrackedImage).

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

The left-hand side of the comparison.
XRTrackedImage rhs

The right-hand side of the comparison.
Returns
Type Description
bool

True if lhs is not equal to rhs, otherwise false.

Implements