ParameterKey Class

    Namespace: Stride.Rendering
    Assembly: Stride.dll

    Key of an effect parameter.

    System.Object → PropertyKey → ParameterKey
    Derived from ParameterKey: ParameterKey<T> 

    public abstract class ParameterKey : PropertyKey, IComparable
    Name Description
    Constructors
    ParameterKey(Type, String, Int32, PropertyKeyMetadata[])

    Initializes a new instance of the ParameterKey class.
    Fields
    HashCode
    Properties
    DefaultValueMetadata
    Length

    Gets the number of elements for this key.
    Size
    Type
    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)
    Equals(Object)

    Determines whether the specified System.Object is equal to this instance.
    GetHashCode()

    Returns a hash code for this instance.
    SetupMetadata(PropertyKeyMetadata)
    Operators
    Equality(ParameterKey, ParameterKey)

    Implements the operator ==.
    Inequality(ParameterKey, ParameterKey)

    Implements the operator !=.
    | Improve this Doc View Source

    Constructors

    ParameterKey(Type, String, Int32, PropertyKeyMetadata[])

    Initializes a new instance of the ParameterKey class.

    protected ParameterKey(Type propertyType, string name, int length, params PropertyKeyMetadata[] metadatas)
    Parameters
    Type Name Description
    System.Type propertyType

    Type of the property.
    System.String name

    The name.
    System.Int32 length

    The length.
    PropertyKeyMetadata[] metadatas

    The metadatas.
    | Improve this Doc View Source

    Fields

    HashCode

    public ulong HashCode
    Field Value
    Type Description
    System.UInt64
    | Improve this Doc View Source

    Properties

    DefaultValueMetadata

    public ParameterKeyValueMetadata DefaultValueMetadata { get; }
    Property Value
    Type Description
    ParameterKeyValueMetadata

    Length

    Gets the number of elements for this key.

    public int Length { get; }
    Property Value
    Type Description
    System.Int32

    Size

    public abstract int Size { get; }
    Property Value
    Type Description
    System.Int32

    Type

    public ParameterKeyType Type { get; protected set; }
    Property Value
    Type Description
    ParameterKeyType
    | Improve this Doc View Source

    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
    Type Name Description
    System.Object value

    The value.
    Returns
    Type Description
    System.Object

    System.Object.

    Equals(Object)

    Determines whether the specified System.Object is equal to this instance.

    public override bool Equals(object obj)
    Parameters
    Type Name Description
    System.Object obj

    The System.Object to compare with this instance.
    Returns
    Type Description
    System.Boolean

    true if the specified System.Object is equal to this instance; otherwise, false.
    Overrides
    System.Object.Equals(System.Object)

    GetHashCode()

    Returns a hash code for this instance.

    public override int GetHashCode()
    Returns
    Type Description
    System.Int32

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

    Overrides
    System.Object.GetHashCode()

    SetupMetadata(PropertyKeyMetadata)

    protected override void SetupMetadata(PropertyKeyMetadata metadata)
    Parameters
    Type Name Description
    PropertyKeyMetadata metadata
    Overrides
    | Improve this Doc View Source

    Operators

    Equality(ParameterKey, ParameterKey)

    Implements the operator ==.

    public static bool operator ==(ParameterKey left, ParameterKey right)
    Parameters
    Type Name Description
    ParameterKey left

    The left.
    ParameterKey right

    The right.
    Returns
    Type Description
    System.Boolean

    The result of the operator.

    Inequality(ParameterKey, ParameterKey)

    Implements the operator !=.

    public static bool operator !=(ParameterKey left, ParameterKey right)
    Parameters
    Type Name Description
    ParameterKey left

    The left.
    ParameterKey right

    The right.
    Returns
    Type Description
    System.Boolean

    The result of the operator.

    Inherited Members

    Extension Methods