Stride

OPEN / CLOSE
  • Features
  • Blog
  • Documentation
  • Community
(icon) Download

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

OPEN / CLOSE
  • English
  • 日本語
    Show / Hide Table of Contents

    ParameterKey<T> Class

    Namespace: Stride.Rendering
    Assembly: Stride.dll

    Key of an gereric effect parameter.

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

    public abstract class ParameterKey<T> : ParameterKey, IComparable
    Type Parameters
    Name Description
    T

    Type of the parameter key.

    Name Description
    Constructors
    ParameterKey(ParameterKeyType, String, Int32, PropertyKeyMetadata)

    Initializes a new instance of the ParameterKey<T> class.

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

    Initializes a new instance of the ParameterKey<T> class.

    Properties
    DefaultValueMetadataT
    IsValueType
    Size
    Methods
    SetupMetadata(PropertyKeyMetadata)
    ToString()
    | Improve this Doc View Source

    Constructors


    ParameterKey(ParameterKeyType, String, Int32, PropertyKeyMetadata)

    Initializes a new instance of the ParameterKey<T> class.

    protected ParameterKey(ParameterKeyType type, string name, int length, PropertyKeyMetadata metadata)
    Parameters
    Type Name Description
    ParameterKeyType type
    System.String name

    The name.

    System.Int32 length

    The length.

    PropertyKeyMetadata metadata

    The metadata.


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

    Initializes a new instance of the ParameterKey<T> class.

    protected ParameterKey(ParameterKeyType type, string name, int length = 1, params PropertyKeyMetadata[] metadatas)
    Parameters
    Type Name Description
    ParameterKeyType type
    System.String name

    The name.

    System.Int32 length

    The length.

    PropertyKeyMetadata[] metadatas

    The metadatas.

    | Improve this Doc View Source

    Properties


    DefaultValueMetadataT

    public ParameterKeyValueMetadata<T> DefaultValueMetadataT { get; }
    Property Value
    Type Description
    ParameterKeyValueMetadata<T>

    IsValueType

    public override bool IsValueType { get; }
    Property Value
    Type Description
    System.Boolean
    Overrides
    PropertyKey.IsValueType

    Size

    public override int Size { get; }
    Property Value
    Type Description
    System.Int32
    Overrides
    ParameterKey.Size
    | Improve this Doc View Source

    Methods


    SetupMetadata(PropertyKeyMetadata)

    protected override void SetupMetadata(PropertyKeyMetadata metadata)
    Parameters
    Type Name Description
    PropertyKeyMetadata metadata
    Overrides
    ParameterKey.SetupMetadata(PropertyKeyMetadata)

    ToString()

    public override string ToString()
    Returns
    Type Description
    System.String
    Overrides
    PropertyKey.ToString()

    Inherited Members

    ParameterKey.HashCode
    ParameterKey.DefaultValueMetadata
    ParameterKey.Length
    ParameterKey.Type
    ParameterKey.Equals(Object)
    ParameterKey.GetHashCode()
    ParameterKey.ConvertValue(Object)
    PropertyKey.Name
    PropertyKey.Metadatas
    PropertyKey.OwnerType
    PropertyKey.PropertyType
    PropertyKey.CompareTo(Object)
    PropertyKey.SetupMetadatas()

    Extension Methods

    ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)
    ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)
    ParameterKeys.ComposeWith<T>(T, String)
    ParameterKeys.ComposeIndexer<T>(T, String, Int32)
    • Improve this Doc
    • View Source
    In This Article

    Back to top

    Copyright © 2019-2021 .NET Foundation and Contributors
    Supported by the .NET Foundation