Struct LayerDataDescriptor

Defines the meta data that is associated with a LayerData type.

Implements

IEquatable<LayerDataDescriptor>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Unity.XR.CompositionLayers.Layers

Assembly: Unity.XR.CompositionLayers.dll

Syntax

public readonly struct LayerDataDescriptor : IEquatable<LayerDataDescriptor>

Constructors

LayerDataDescriptor(string, string, string, string, string, string, string, bool, bool, Type, Type[])

Creates a new LayerDataDescriptor

Declaration

public LayerDataDescriptor(string provider, string name, string typeFullName, string description, string iconPath, string inspectorIcon, string listViewIcon, bool preferOverlay, bool supportTransform, Type dataType, Type[] suggestedExtensions)

Parameters

Type	Name	Description
string	provider	The source that is providing the LayerData type.
string	name	The display name of the LayerData type.
string	typeFullName	The unique class Id key used for finding the LayerData type.
string	description	A description of what the LayerData does and how it is used.
string	iconPath	The icon used for the inspector of the LayerData object.
string	inspectorIcon	The icon used for the inspector of the LayerData object.
string	listViewIcon	The icon used in the Composition Layer Window for CompositionLayers using this type of LayerData.
bool	preferOverlay	Should new instance of the LayerData be an overlay or underlay.
bool	supportTransform	This layer type supports world or camera relative transforms.
Type	dataType	The Type of the LayerData.
Type[]	suggestedExtensions	Suggested extension types to use with the LayerData on the CompositionLayer.

Fields

DataType

The Type of the LayerData.

Declaration

public readonly Type DataType

Field Value

Type	Description
Type

Description

A description of what the LayerData does and how it is used.

Declaration

public readonly string Description

Field Value

Type	Description
string

IconPath

Path to the icon folder used for the LayerData.

Declaration

public readonly string IconPath

Field Value

Type	Description
string

InspectorIcon

The icon used for the inspector of the LayerData object.

Declaration

public readonly string InspectorIcon

Field Value

Type	Description
string

ListViewIcon

The icon used in the Composition Layer Window for CompositionLayers using this type of LayerData.

Declaration

public readonly string ListViewIcon

Field Value

Type	Description
string

Name

The display name of the LayerData type.

Declaration

public readonly string Name

Field Value

Type	Description
string

PreferOverlay

Should new instance of the LayerData be an overlay or underlay.

Declaration

public readonly bool PreferOverlay

Field Value

Type	Description
bool

Provider

The source that is providing the LayerData type.

Declaration

public readonly string Provider

Field Value

Type	Description
string

SuggestedExtensions

Suggested extension types to use with the LayerData on the CompositionLayer.

Declaration

public readonly Type[] SuggestedExtensions

Field Value

Type	Description
Type[]

SupportTransform

This layer type supports world or camera relative transforms.

Declaration

public readonly bool SupportTransform

Field Value

Type	Description
bool

TypeFullName

The full type name used for identifying this LayerData type.

Declaration

public readonly string TypeFullName

Field Value

Type	Description
string

Properties

Empty

LayerDataDescriptor with all empty or null values

Declaration

public static LayerDataDescriptor Empty { get; }

Property Value

Type	Description
LayerDataDescriptor

Methods

Equals(object)

Determines whether this instance obj is equal to the current LayerDataDescriptor.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object for comparison.

Returns

Type	Description
bool	true if the specified object is equal to the current LayerDataDescriptor. Otherwise, false.

Overrides

ValueType.Equals(object)

Equals(LayerDataDescriptor)

Determines whether the specified LayerDataDescriptor is equal to the current LayerDataDescriptor.

Declaration

public bool Equals(LayerDataDescriptor other)

Parameters

Type	Name	Description
LayerDataDescriptor	other	The LayerDataDescriptor to compare with the current LayerDataDescriptor.

Returns

Type	Description
bool	true if the specified LayerDataDescriptor is equal to the current LayerDataDescriptor. Otherwise, false.

GetHashCode()

Returns the hash code for the current LayerDataDescriptor.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for the current LayerDataDescriptor.

Overrides

ValueType.GetHashCode()

Operators

operator ==(LayerDataDescriptor, LayerDataDescriptor)

Determines whether two specified LayerDataDescriptor instances are equal.

Declaration

public static bool operator ==(LayerDataDescriptor left, LayerDataDescriptor right)

Parameters

Type	Name	Description
LayerDataDescriptor	left	The first LayerDataDescriptor to compare.
LayerDataDescriptor	right	The second LayerDataDescriptor to compare.

Returns

Type	Description
bool	true if the two LayerDataDescriptor instances are equal. Otherwise, false.

operator !=(LayerDataDescriptor, LayerDataDescriptor)

Determines whether two specified LayerDataDescriptor instances are not equal.

Declaration

public static bool operator !=(LayerDataDescriptor left, LayerDataDescriptor right)

Parameters

Type	Name	Description
LayerDataDescriptor	left	The first LayerDataDescriptor to compare.
LayerDataDescriptor	right	The second LayerDataDescriptor to compare.

Returns

Type	Description
bool	true if the two LayerDataDescriptor instances are not equal. Otherwise, false.

Implements

IEquatable<T>