docs.unity3d.com
    Show / Hide Table of Contents

    Class XRImageTrackingSubsystem.IProvider

    Methods to implement by the implementing provider.

    Inheritance
    Object
    XRImageTrackingSubsystem.IProvider
    Namespace: UnityEngine.XR.ARSubsystems
    Syntax
    protected class IProvider : object

    Properties

    imageLibrary

    Set the XRReferenceImageLibrary. Setting this to null implies the subsystem should stop detecting or tracking images.

    Declaration
    public virtual XRReferenceImageLibrary imageLibrary { set; }
    Property Value
    Type Description
    XRReferenceImageLibrary

    maxNumberOfMovingImages

    The maximum number of moving images to track in realtime.

    Declaration
    public virtual int maxNumberOfMovingImages { set; }
    Property Value
    Type Description
    Int32

    Methods

    Destroy()

    Called when the subsystem is destroyed.

    Declaration
    public virtual void Destroy()

    GetChanges(XRTrackedImage, Allocator)

    Get the changes (added, updated, removed) to the tracked images since the last call to this method.

    Declaration
    public virtual TrackableChanges<XRTrackedImage> GetChanges(XRTrackedImage defaultTrackedImage, Allocator allocator)
    Parameters
    Type Name Description
    XRTrackedImage defaultTrackedImage

    An XRTrackedImage populated with default values. The implementation should first fill arrays of added, updated, and removed with copies of this before copying in its own values. This guards against addtional fields added to the XRTrackedImage in the future.

    Allocator allocator

    The allocator to use for the returned data.

    Returns
    Type Description
    TrackableChanges<XRTrackedImage>

    The set of changes (added, updated, removed) tracked images since the last call to this method.

    Back to top
    Terms of use
    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