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

Implements

IReferenceImageLibrary

ISerializationCallbackReceiver

IEnumerable<XRReferenceImage>

IEnumerable

Inherited Members

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

object.MemberwiseClone()

Namespace: UnityEngine.XR.ARSubsystems

Assembly: solution.dll

Syntax

[CreateAssetMenu(fileName = "ReferenceImageLibrary", menuName = "XR/Reference Image Library", order = 1001)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.arsubsystems@4.2/manual/image-tracking.html")]
public class XRReferenceImageLibrary : ScriptableObject, IReferenceImageLibrary, ISerializationCallbackReceiver, IEnumerable<XRReferenceImage>, IEnumerable

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

Name	Description
this[int]	Get an image by index.
count	The number of images in the library.
dataStore	(Read Only) Binary data associated with a string key.
guid	A GUID associated with this reference library. The GUID is used to uniquely identify this library at runtime.

Methods

Name	Description
GetEnumerator()	Gets an enumerator which can be used to iterate over the reference images in this library.
indexOf(XRReferenceImage)	Get the index of referenceImage in the image library.

Extension Methods

XRReferenceImageLibraryExtensions.Add(XRReferenceImageLibrary)

XRReferenceImageLibraryExtensions.ClearDataStore(XRReferenceImageLibrary)

XRReferenceImageLibraryExtensions.RemoveAt(XRReferenceImageLibrary, int)

XRReferenceImageLibraryExtensions.SetDataForKey(XRReferenceImageLibrary, string, byte[])

XRReferenceImageLibraryExtensions.SetName(XRReferenceImageLibrary, int, string)

XRReferenceImageLibraryExtensions.SetSize(XRReferenceImageLibrary, int, Vector2)

XRReferenceImageLibraryExtensions.SetSpecifySize(XRReferenceImageLibrary, int, bool)

XRReferenceImageLibraryExtensions.SetTexture(XRReferenceImageLibrary, int, Texture2D, bool)