Struct XRTrackedImage | AR Subsystems | 3.1.10
docs.unity3d.com
    Show / Hide Table of Contents

    Struct XRTrackedImage

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

    Namespace: UnityEngine.XR.ARSubsystems
    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 (i.e., 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 .

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

    pose

    The Pose associated with this tracked image.

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

    size

    The size (i.e., 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
    Implements
    ITrackable.trackableId

    trackingState

    The TrackingState associated with this tracked image.

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

    Methods

    Equals(Object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    Object obj
    Returns
    Type Description
    Boolean
    Overrides
    ValueType.Equals(Object)

    Equals(XRTrackedImage)

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

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32
    Overrides
    ValueType.GetHashCode()

    Operators

    Equality(XRTrackedImage, XRTrackedImage)

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

    Inequality(XRTrackedImage, XRTrackedImage)

    Declaration
    public static bool operator !=(XRTrackedImage lhs, XRTrackedImage rhs)
    Parameters
    Type Name Description
    XRTrackedImage lhs
    XRTrackedImage rhs
    Returns
    Type Description
    Boolean
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023