Class ParameterKey

Namespace

Stride.Rendering

Assembly

Stride.dll

Key of an effect parameter.

public abstract class ParameterKey : PropertyKey, IComparable

Inheritance

object

PropertyKey

ParameterKey

Implements

IComparable

Derived

ParameterKey<T>

Inherited Members

PropertyKey.name

PropertyKey.Name

PropertyKey.Metadatas

PropertyKey.OwnerType

PropertyKey.PropertyType

PropertyKey.IsValueType

PropertyKey.CompareTo(object)

PropertyKey.ToString()

PropertyKey.SetupMetadatas()

Extension Methods

ParameterKeys.ComposeIndexer<T>(T, string, int)

ParameterKeys.ComposeWith<T>(T, string)

Constructors

ParameterKey(Type, string, int, params PropertyKeyMetadata[])

Initializes a new instance of the ParameterKey class.

protected ParameterKey(Type propertyType, string name, int length, params PropertyKeyMetadata[] metadatas)

Parameters

propertyType Type

Type of the property.

name string

The name.

length int

The length.

metadatas PropertyKeyMetadata[]

The metadatas.

Fields

HashCode

public ulong HashCode

Field Value

ulong

Properties

DefaultValueMetadata

public ParameterKeyValueMetadata DefaultValueMetadata { get; }

Property Value

ParameterKeyValueMetadata

Length

Gets the number of elements for this key.

public int Length { get; }

Property Value

int

Size

public abstract int Size { get; }

Property Value

int

Type

public ParameterKeyType Type { get; protected set; }

Property Value

ParameterKeyType

Methods

ConvertValue(object)

Converts the value passed by parameter to the expecting value of this parameter key (for example, if value is an integer while this parameter key is expecting a float)

public object ConvertValue(object value)

Parameters

value object

The value.

Returns

object

System.Object.

Equals(object)

Determines whether the specified object is equal to this instance.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with this instance.

Returns

bool

true if the specified object is equal to this instance; otherwise, false.

GetHashCode()

Returns a hash code for this instance.

public override int GetHashCode()

Returns

int

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

SetupMetadata(PropertyKeyMetadata)

protected override void SetupMetadata(PropertyKeyMetadata metadata)

Parameters

metadata PropertyKeyMetadata

Operators

operator ==(ParameterKey, ParameterKey)

Implements the operator ==.

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

Parameters

left ParameterKey

The left.

right ParameterKey

The right.

Returns

bool

The result of the operator.

operator !=(ParameterKey, ParameterKey)

Implements the operator !=.

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

Parameters

left ParameterKey

The left.

right ParameterKey

The right.

Returns

bool

The result of the operator.