Class MutableRuntimeReferenceImageLibrary

A reference image library that can be constructed and modified at runtime.

Inheritance

object

RuntimeReferenceImageLibrary

MutableRuntimeReferenceImageLibrary

Implements

IReferenceImageLibrary

Inherited Members

RuntimeReferenceImageLibrary.this[int]

RuntimeReferenceImageLibrary.count

RuntimeReferenceImageLibrary.GetReferenceImageAt(int)

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: UnityEngine.XR.ARSubsystems

Assembly: solution.dll

Syntax

public abstract class MutableRuntimeReferenceImageLibrary : RuntimeReferenceImageLibrary, IReferenceImageLibrary

Remarks

This differs from an XRReferenceImageLibrary, which can only be constructed in the Editor and is immutable at runtime.

Important

Implementors: XRImageTrackingSubsystem providers must implement this class for their provider if supportsMutableLibrary is true to provide the functionality to support runtime mutable libraries.

This is not something consumers of the AR Subsystems package should implement.

Properties

Name	Description
supportedTextureFormatCount	The number of texture formats that are supported for image addition.
supportsValidation	(Read Only) `True` if this MutableRuntimeReferenceImageLibrary supports the validation of images when added via ScheduleAddImageWithValidationJob(NativeSlice<byte>, Vector2Int, TextureFormat, XRReferenceImage, JobHandle).

Methods

Name	Description
CreateAddJobState(IntPtr, JobHandle)	Derived classes should call this to create an AddReferenceImageJobState to be returned by its implementation of ScheduleAddImageWithValidationJobImpl(NativeSlice<byte>, Vector2Int, TextureFormat, XRReferenceImage, JobHandle).
GetAddReferenceImageJobStatus(AddReferenceImageJobState)	Get the status of an AddReferenceImageJobState.
GetEnumerator()	Gets an enumerator for this collection of reference images. This allows this image library to act as a collection in a `foreach` statement. The MutableRuntimeReferenceImageLibrary.Enumerator is a `struct`, so no garbage is generated.
GetSupportedTextureFormatAt(int)	Returns the supported texture format at `index`. Useful for enumerating the supported texture formats for image addition.
GetSupportedTextureFormatAtImpl(int)	Derived methods should return the TextureFormat at the given `index`. `index` has already been validated to be within [0..supportedTextureFormatCount].
IsTextureFormatSupported(TextureFormat)	Determines whether the given `format` is supported.
ScheduleAddImageJob(NativeSlice<byte>, Vector2Int, TextureFormat, XRReferenceImage, JobHandle)	Asynchronously adds an image to this library.
ScheduleAddImageJobImpl(NativeSlice<byte>, Vector2Int, TextureFormat, XRReferenceImage, JobHandle)	This method should schedule a Unity Job which adds an image to this reference image library.
ScheduleAddImageWithValidationJob(NativeSlice<byte>, Vector2Int, TextureFormat, XRReferenceImage, JobHandle)	Asynchronously adds an image to this library.
ScheduleAddImageWithValidationJobImpl(NativeSlice<byte>, Vector2Int, TextureFormat, XRReferenceImage, JobHandle)	This method should schedule a Unity Job which adds an image to this reference image library.