Class XRLoader

XR Loader abstract class used as a base class for specific provider implementations. Providers should implement subclasses of this to provide specific initialization and management implementations that make sense for their supported scenarios and needs.

Inheritance

object

Object

ScriptableObject

XRLoader

XRLoaderHelper

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.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.XR.Management

Assembly: Unity.XR.Management.dll

Syntax

public abstract class XRLoader : ScriptableObject

Methods

Deinitialize()

Ask loader to deinitialize all initialized subsystems.

Declaration

public virtual bool Deinitialize()

Returns

Type	Description
bool	Whether or not deinitialization succeeded.

GetLoadedSubsystem<T>()

Gets the loaded subsystem of the specified type. Implementation dependent as only implemetnations know what they have loaded and how best to get it..

Declaration

public abstract T GetLoadedSubsystem<T>() where T : class, ISubsystem

Returns

Type	Description
T	The loaded subsystem or null if not found.

Type Parameters

Name	Description
T	Type of the subsystem to get

GetSupportedGraphicsDeviceTypes(bool)

Gets the loader's supported graphics device types. If the list is empty, it is assumed that it supports all graphics device types.

Declaration

public virtual List<GraphicsDeviceType> GetSupportedGraphicsDeviceTypes(bool buildingPlayer)

Parameters

Type	Name	Description
bool	buildingPlayer	True if the player is being built. You may want to include or exclude graphics apis if the player is being built or not.

Returns

Type	Description
List<GraphicsDeviceType>	Returns the loader's supported graphics device types.

Initialize()

Initialize the loader. This should initialize all subsystems to support the desired runtime setup this loader represents.

This is the only method on XRLoader that Management uses to determine the active loader to use. If this method returns true, Management locks this loader as the activeLoader and and stops fall through processing on the loaders list of current loaders.

If this method returns false, XRManagerSettings continues to process the next loader in the loaders list, or fails completely when the list is exhausted.

Declaration

public virtual bool Initialize()

Returns

Type	Description
bool	Whether or not initialization succeeded.

Start()

Ask loader to start all initialized subsystems.

Declaration

public virtual bool Start()

Returns

Type	Description
bool	Whether or not all subsystems were successfully started.

Stop()

Ask loader to stop all initialized subsystems.

Declaration

public virtual bool Stop()

Returns

Type	Description
bool	Whether or not all subsystems were successfully stopped.