Class CompositionLayer

Base class for all composition layer types. Derive from this and extend to add your own layer type.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

CompositionLayer

Inherited Members

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.GetComponentIndex()

Component.CompareTag(string)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

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

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

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.Instantiate(Object, Vector3, Quaternion)

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

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

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.ReferenceEquals(object, object)

Namespace: Unity.XR.CompositionLayers

Assembly: Unity.XR.CompositionLayers.dll

Syntax

[ExecuteAlways]
[DisallowMultipleComponent]
[AddComponentMenu("XR/Composition Layers/Composition Layer")]
[Icon("Packages/com.unity.xr.compositionlayers/Editor/Icons/d_LayerUniversal.png")]
[DefaultExecutionOrder(-2147483648)]
public sealed class CompositionLayer : MonoBehaviour

Properties

Extensions

Provides access to the list of CompositionLayerExtension components that are currently enabled on this CompositionLayer gameObject.

Declaration

public List<CompositionLayerExtension> Extensions { get; }

Property Value

Type	Description
List<CompositionLayerExtension>

LayerData

The data associated with the layer type this layer is set to.

Declaration

public LayerData LayerData { get; }

Property Value

Type	Description
LayerData	ScriptableObject instance for layer data.

Order

The layer ordering of this layer in relation to the main eye layer. Order less than 0 will render under the eye layer in ascending order. Order greater than or equal to 0 will render over the eye layer in ascending order.

Declaration

public int Order { get; set; }

Property Value

Type	Description
int

OrderInitialized

Order Initialized is used to track if the Order is initialized to a valid value. A Order has been initialized when the CompositionLayer is managed with the CompositionLayerManager.

Declaration

public bool OrderInitialized { get; }

Property Value

Type	Description
bool

Methods

ChangeLayerDataType(string)

Will populate the layer data with existing data associated with that typeFullName.

Declaration

public void ChangeLayerDataType(string typeFullName)

Parameters

Type	Name	Description
string	typeFullName	The layer Id for the LayerData type.

ChangeLayerDataType(Type)

Sets the LayerData and base on a LayerDataDescriptor subclass defined by the passed in Type.

Declaration

public void ChangeLayerDataType(Type type)

Parameters

Type	Name	Description
Type	type	The type of LayerData to change the layer type to.

ChangeLayerDataType(LayerData)

Sets the LayerData.

Declaration

public void ChangeLayerDataType(LayerData layer)

Parameters

Type	Name	Description
LayerData	layer	The LayerData instance to assign.

ChangeLayerDataType(LayerDataDescriptor)

Sets the layer type from the LayerDataDescriptor. LayerData is populated from data associated with the LayerDataDescriptor.

Declaration

public void ChangeLayerDataType(LayerDataDescriptor descriptor)

Parameters

Type	Name	Description
LayerDataDescriptor	descriptor	The LayerDataDescriptor for a type of LayerData

ChangeLayerDataType<T>()

Sets the LayerData base on a LayerDataDescriptor subclass of type T.

Declaration

public void ChangeLayerDataType<T>() where T : LayerData

Type Parameters

Name	Description
T	The type of LayerData to change the layer type to.

GetPlatformLayerData<T>()

Get/Desrialize PlatformLayerData. This function keeps deselized PlatformLayerData internally.

Declaration

public T GetPlatformLayerData<T>() where T : PlatformLayerData

Returns

Type	Description
T	PlatformLayerData.

Type Parameters

Name	Description
T	The type of PlatformLayerData changed to.

SetPlatformLayerData(PlatformLayerData)

Set/Serialize PlatformLayerData.

Declaration

public void SetPlatformLayerData(PlatformLayerData platformLayerData)

Parameters

Type	Name	Description
PlatformLayerData	platformLayerData	Target PlatformLayerData.

Extension Methods

CompositionLayerUtils.AddSuggestedExtensions(CompositionLayer)

CompositionLayerUtils.CanChangeOrderTo(CompositionLayer, int)

CompositionLayerUtils.TryChangeLayerOrder(CompositionLayer, int, int)

CompositionLayerUtils.TrySwapLayers(CompositionLayer, CompositionLayer)