Class DefaultLayerData

Subclass of LayerData that represents the default base rendered layer for composition layer ordering. This is an implicit layer that Unity will render to the display of the target XR device.

The intention of this layer is to provide a default "invisible" layer to act as the 0th layer which seperates underlay layers from overlay layers.

Inheritance

object

LayerData

DefaultLayerData

Inherited Members

LayerData.BlendTypeDirectly

LayerData.BlendType

LayerData.ReportStateChange

LayerData.UpdateValue<T>(T, T)

LayerData.CopyFrom(LayerData)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.XR.CompositionLayers.Layers

Assembly: Unity.XR.CompositionLayers.dll

Syntax

public class DefaultLayerData : LayerData

Constructors

DefaultLayerData()

Initializes a new instance of the DefaultLayerData class.

Declaration

[Preserve]
public DefaultLayerData()

Methods

Validate(CompositionLayer)

Validates the DefaultLayerData to ensure the correct layer is used by the CompositionLayerManager.

Declaration

protected override bool Validate(CompositionLayer layer)

Parameters

Type	Name	Description
CompositionLayer	layer	The composition layer to validate.

Returns

Type	Description
bool	true if the layer is valid for use by the CompositionLayerManager. Otherwise, false.

Overrides

LayerData.Validate(CompositionLayer)

Remarks

If the CompositionLayerManager is not present, this layer is valid as long as it exists in the scene and is not hidden. If the CompositionLayerManager is present, this layer is valid if it is the DefaultSceneCompositionLayer.