Class XRReferenceImageLibraryExtensions
Extension methods for the XRReferenceImageLibrary.
Namespace: UnityEditor.XR.ARSubsystems
Syntax
public static class XRReferenceImageLibraryExtensions
Remarks
At runtime, XRReferenceImageLibrarys are immutable. These Editor-only extension methods let you build and manipulate image libraries in Editor scripts.
Methods
Add(XRReferenceImageLibrary)
Creates an empty XRReferenceImage
and adds it to the library. The new
reference image is inserted at the end of the list of reference images.
Declaration
public static void Add(this XRReferenceImageLibrary library)
Parameters
Type | Name | Description |
---|---|---|
XRReferenceImageLibrary | library | The XRReferenceImageLibrary being extended. |
Exceptions
Type | Condition |
---|---|
ArgumentNullException | Thrown if |
RemoveAt(XRReferenceImageLibrary, Int32)
Removes the XRReferenceImage at index
.
Declaration
public static void RemoveAt(this XRReferenceImageLibrary library, int index)
Parameters
Type | Name | Description |
---|---|---|
XRReferenceImageLibrary | library | The XRReferenceImageLibrary being extended. |
Int32 | index | The index in the list of images to remove. |
Exceptions
Type | Condition |
---|---|
ArgumentNullException | Thrown if |
IndexOutOfRangeException | Thrown if |
SetName(XRReferenceImageLibrary, Int32, String)
Sets the XRReferenceImage.name
value on the XRReferenceImage
at index
.
This value is read-only in the Player; it can only be modified in the Editor.
Declaration
public static void SetName(this XRReferenceImageLibrary library, int index, string name)
Parameters
Type | Name | Description |
---|---|---|
XRReferenceImageLibrary | library | The |
Int32 | index | The index of the reference image within the library to modify. |
String | name |
Exceptions
Type | Condition |
---|---|
ArgumentNullException | Thrown if |
IndexOutOfRangeException | Thrown if |
SetSize(XRReferenceImageLibrary, Int32, Vector2)
Sets the XRReferenceImage.size
value on the XRReferenceImage
at index
.
This value is read-only in the Player; it can only be modified in the Editor.
Declaration
public static void SetSize(this XRReferenceImageLibrary library, int index, Vector2 size)
Parameters
Type | Name | Description |
---|---|---|
XRReferenceImageLibrary | library | The |
Int32 | index | The index of the reference image within the library to modify. |
Vector2 | size |
Exceptions
Type | Condition |
---|---|
ArgumentNullException | Thrown if |
IndexOutOfRangeException | Thrown if |
SetSpecifySize(XRReferenceImageLibrary, Int32, Boolean)
Sets the XRReferenceImage.specifySize
value on the XRReferenceImage
at index
.
This value is read-only in the Player; it can only be modified in the Editor.
Declaration
public static void SetSpecifySize(this XRReferenceImageLibrary library, int index, bool specifySize)
Parameters
Type | Name | Description |
---|---|---|
XRReferenceImageLibrary | library | The |
Int32 | index | The index of the reference image within the library to modify. |
Boolean | specifySize | Whether |
Exceptions
Type | Condition |
---|---|
ArgumentNullException | Thrown if |
IndexOutOfRangeException | Thrown if |
SetTexture(XRReferenceImageLibrary, Int32, Texture2D, Boolean)
Set the texture on the reference image.
Declaration
public static void SetTexture(this XRReferenceImageLibrary library, int index, Texture2D texture, bool keepTexture)
Parameters
Type | Name | Description |
---|---|---|
XRReferenceImageLibrary | library | The XRReferenceImageLibrary being extended. |
Int32 | index | The reference image index to modify. |
Texture2D | texture | The texture to set. |
Boolean | keepTexture | Whether to store a strong reference to the texture. If |
Exceptions
Type | Condition |
---|---|
ArgumentNullException | Thrown if |
IndexOutOfRangeException | Thrown if |