Class XRReferenceImageLibrary

A reference image library is a collection of images to search for in the physical environment when image tracking is enabled.

Inheritance
Object
Object
ScriptableObject
XRReferenceImageLibrary
Inherited Members
Namespace: UnityEngine.XR.ARSubsystems
Syntax
[CreateAssetMenu(fileName = "ReferenceImageLibrary", menuName = "XR/Reference Image Library", order = 1001)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.arsubsystems@4.1/manual/image-tracking.html")]
public class XRReferenceImageLibrary : ScriptableObject, IReferenceImageLibrary
Remarks

Image libraries are immutable at runtime. To create and manipulate an image library via Editor scripts, see the extension methods in XRReferenceImageLibraryExtensions. If you need to mutate the library at runtime, see MutableRuntimeReferenceImageLibrary.

Properties

count

The number of images in the library.

Declaration
public int count { get; }
Property Value
Type Description
Int32
Implements

guid

A Guid associated with this reference library. The Guid is used to uniquely identify this library at runtime.

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

Item[Int32]

Get an image by index.

Declaration
public XRReferenceImage this[int index] { get; }
Parameters
Type Name Description
Int32 index

The index of the image in the library. Must be between 0 and count - 1.
Property Value
Type Description
XRReferenceImage

The XRReferenceImage at index.
Implements
Exceptions
Type Condition
IndexOutOfRangeException

Thrown if index is not between 0 and count - 1.

Methods

GetEnumerator()

Gets an enumerator which can be used to iterate over the images in this library.

Declaration
public List<XRReferenceImage>.Enumerator GetEnumerator()
Returns
Type Description
List.Enumerator<>

An IEnumerator which can be used to iterate over the images in the library.
Examples

This examples iterates over the reference images contained in the library.

XRReferenceImageLibrary imageLibrary = ...
foreach (var referenceImage in imageLibrary)
    Debug.LogFormat("Image guid: {0}", referenceImage.guid);

indexOf(XRReferenceImage)

Get the index of referenceImage in the image library.

Declaration
public int indexOf(XRReferenceImage referenceImage)
Parameters
Type Name Description
XRReferenceImage referenceImage

The XRReferenceImage to find.
Returns
Type Description
Int32

The zero-based index of the referenceImage, or -1 if not found.

Extension Methods