ParameterKeys Class
Namespace: Stride.Rendering
Assembly: Stride.dll
System.Object →
ParameterKeys
Derived from ParameterKeys:
public static class ParameterKeys
Name |
Description |
Methods
|
|
ComposeIndexer<T>(T, String, Int32) |
Compose a key with a name and index (e.g if key is MyKey.MyKeyName and name is MyName and index is 5, the result key will be MyKey.MyKeyName.MyName[5] )
|
|
ComposeWith<T>(T, String) |
Compose a key with a name (e.g if key is MyKey.MyKeyName and name is MyName , the result key will be MyKey.MyKeyName.MyName )
|
|
FindByName(String) |
|
|
GetKeys() |
Returns property keys matching a given type
|
|
IndexedKey<T>(T, Int32) |
Creates the key with specified index.
|
|
Merge(ParameterKey, Type, String) |
|
|
NewObject<T>(T, String) |
|
|
NewPermutation<T>(T, String) |
|
|
NewValue<T>(T, String) |
|
|
TryFindByName(String) |
|
|
Improve this Doc
View Source
Methods
ComposeIndexer<T>(T, String, Int32)
Compose a key with a name and index (e.g if key is MyKey.MyKeyName
and name is MyName
and index is 5, the result key will be MyKey.MyKeyName.MyName[5]
)
public static T ComposeIndexer<T>(this T key, string name, int index)
where T : ParameterKey
Parameters
Type |
Name |
Description |
T |
key |
The key.
|
System.String |
name |
The name to append to the key.
|
System.Int32 |
index |
The index.
|
Returns
Type Parameters
Name |
Description |
T |
Type of the key value
|
Exceptions
Type |
Condition |
System.ArgumentNullException |
key
or
name
|
System.ArgumentOutOfRangeException |
index;Must be >= 0
|
ComposeWith<T>(T, String)
Compose a key with a name (e.g if key is MyKey.MyKeyName
and name is MyName
, the result key will be MyKey.MyKeyName.MyName
)
public static T ComposeWith<T>(this T key, string name)
where T : ParameterKey
Parameters
Type |
Name |
Description |
T |
key |
The key.
|
System.String |
name |
The name to append to the key.
|
Returns
Type |
Description |
T |
The composition of key and name
|
Type Parameters
Name |
Description |
T |
Type of the key value
|
Exceptions
Type |
Condition |
System.ArgumentNullException |
key
or
name
|
FindByName(String)
public static ParameterKey FindByName(string name)
Parameters
Type |
Name |
Description |
System.String |
name |
|
Returns
GetKeys()
Returns property keys matching a given type
public static IEnumerable<ParameterKey> GetKeys()
Returns
Type |
Description |
System.Collections.Generic.IEnumerable<ParameterKey> |
|
IndexedKey<T>(T, Int32)
Creates the key with specified index.
public static T IndexedKey<T>(T key, int index)
where T : ParameterKey
Parameters
Type |
Name |
Description |
T |
key |
|
System.Int32 |
index |
The index.
|
Returns
Type Parameters
Merge(ParameterKey, Type, String)
public static ParameterKey Merge(ParameterKey key, Type ownerType, string name)
Parameters
Type |
Name |
Description |
ParameterKey |
key |
|
System.Type |
ownerType |
|
System.String |
name |
|
Returns
NewObject<T>(T, String)
public static ObjectParameterKey<T> NewObject<T>(T defaultValue = null, string name = null)
Parameters
Type |
Name |
Description |
T |
defaultValue |
|
System.String |
name |
|
Returns
Type Parameters
NewPermutation<T>(T, String)
public static PermutationParameterKey<T> NewPermutation<T>(T defaultValue = null, string name = null)
Parameters
Type |
Name |
Description |
T |
defaultValue |
|
System.String |
name |
|
Returns
Type Parameters
NewValue<T>(T, String)
public static ValueParameterKey<T> NewValue<T>(T defaultValue = default(T), string name = null)
where T : struct
Parameters
Type |
Name |
Description |
T |
defaultValue |
|
System.String |
name |
|
Returns
Type Parameters
TryFindByName(String)
public static ParameterKey TryFindByName(string name)
Parameters
Type |
Name |
Description |
System.String |
name |
|
Returns