Class CompilerParameters

Namespace

Stride.Shaders.Compiler

Assembly

Stride.Shaders.dll

Parameters used for compilation.

[DataSerializer(typeof(DictionaryAllSerializer<CompilerParameters, ParameterKey, object>))]
public sealed class CompilerParameters : ParameterCollection, IDictionary<ParameterKey, object>, ICollection<KeyValuePair<ParameterKey, object>>, IEnumerable<KeyValuePair<ParameterKey, object>>, IEnumerable

Inheritance

object

ParameterCollection

CompilerParameters

Implements

IDictionary<ParameterKey, object>

ICollection<KeyValuePair<ParameterKey, object>>

IEnumerable<KeyValuePair<ParameterKey, object>>

IEnumerable

Inherited Members

ParameterCollection.DataValues

ParameterCollection.ObjectValues

ParameterCollection.PermutationCounter

ParameterCollection.LayoutCounter

ParameterCollection.ParameterKeyInfos

ParameterCollection.Layout

ParameterCollection.HasLayout

ParameterCollection.ToString()

ParameterCollection.GetAccessor<T>(ObjectParameterKey<T>, bool)

ParameterCollection.GetAccessor<T>(PermutationParameterKey<T>, bool)

ParameterCollection.GetAccessor<T>(ValueParameterKey<T>, int)

ParameterCollection.Set<T>(ObjectParameterKey<T>, T)

ParameterCollection.Get<T>(ObjectParameterKey<T>, bool)

ParameterCollection.Set<T>(PermutationParameterKey<T>, T)

ParameterCollection.Get<T>(PermutationParameterKey<T>, bool)

ParameterCollection.Set<T>(ValueParameterKey<T>, T)

ParameterCollection.Set<T>(ValueParameterKey<T>, ref T)

ParameterCollection.Set<T>(ValueParameterKey<T>, T[])

ParameterCollection.Set<T>(ValueParameterKey<T>, int, ref T)

ParameterCollection.Get<T>(ValueParameterKey<T>)

ParameterCollection.GetValues<T>(ValueParameterKey<T>)

ParameterCollection.CopyTo<T>(ValueParameterKey<T>, ParameterCollection, ValueParameterKey<T>)

ParameterCollection.Set<T>(ValueParameter<T>, T)

ParameterCollection.Set<T>(ValueParameter<T>, ref T)

ParameterCollection.Set<T>(ValueParameter<T>, int, ref T)

ParameterCollection.Set<T>(PermutationParameter<T>, T)

ParameterCollection.Set<T>(ObjectParameterAccessor<T>, T)

ParameterCollection.Get<T>(ValueParameter<T>)

ParameterCollection.Get<T>(PermutationParameter<T>)

ParameterCollection.Get<T>(ObjectParameterAccessor<T>)

ParameterCollection.SetObject(ParameterKey, object)

ParameterCollection.GetObject(ParameterKey)

ParameterCollection.Remove(ParameterKey)

ParameterCollection.Clear()

ParameterCollection.ContainsKey(ParameterKey)

ParameterCollection.UpdateLayout(ParameterCollectionLayout)

Extension Methods

ParameterCollectionExtensions.ToStringPermutationsDetailed(ParameterCollection)

ArrayExtensions.ComputeHash<T>(ICollection<T>, IEqualityComparer<T>)

EnumerableExtensions.ForEach<T>(IEnumerable<T>, Action<T>)

EnumerableExtensions.IndexOf<T>(IEnumerable<T>, Func<T, bool>)

EnumerableExtensions.LastIndexOf<T>(IEnumerable<T>, Func<T, bool>)

EnumerableExtensions.ForEach<T>(IEnumerable, Action<T>)

EnumerableExtensions.IsNullOrEmpty(IEnumerable)

Constructors

CompilerParameters()

Initializes a new instance of the CompilerParameters class.

public CompilerParameters()

CompilerParameters(CompilerParameters)

public CompilerParameters(CompilerParameters compilerParameters)

Parameters

compilerParameters CompilerParameters

Fields

EffectParameters

public EffectCompilerParameters EffectParameters

Field Value

EffectCompilerParameters

Properties

Count

Gets the number of elements contained in the ICollection<T>.

public int Count { get; }

Property Value

int

The number of elements contained in the ICollection<T>.

IsReadOnly

Gets a value indicating whether the ICollection<T> is read-only.

public bool IsReadOnly { get; }

Property Value

bool

true if the ICollection<T> is read-only; otherwise, false.

this[ParameterKey]

Gets or sets the element with the specified key.

public object this[ParameterKey key] { get; set; }

Parameters

key ParameterKey

The key of the element to get or set.

Property Value

object

The element with the specified key.

Exceptions

ArgumentNullException

key is null.

KeyNotFoundException

The property is retrieved and key is not found.

NotSupportedException

The property is set and the IDictionary<TKey, TValue> is read-only.

Keys

Gets an ICollection<T> containing the keys of the IDictionary<TKey, TValue>.

public ICollection<ParameterKey> Keys { get; }

Property Value

ICollection<ParameterKey>

An ICollection<T> containing the keys of the object that implements IDictionary<TKey, TValue>.

Values

Gets an ICollection<T> containing the values in the IDictionary<TKey, TValue>.

public ICollection<object> Values { get; }

Property Value

ICollection<object>

An ICollection<T> containing the values in the object that implements IDictionary<TKey, TValue>.

Methods

Add(ParameterKey, object)

Adds an element with the provided key and value to the IDictionary<TKey, TValue>.

public void Add(ParameterKey key, object value)

Parameters

key ParameterKey

The object to use as the key of the element to add.

value object

The object to use as the value of the element to add.

Exceptions

ArgumentNullException

key is null.

ArgumentException

An element with the same key already exists in the IDictionary<TKey, TValue>.

NotSupportedException

The IDictionary<TKey, TValue> is read-only.

Add(KeyValuePair<ParameterKey, object>)

Adds an item to the ICollection<T>.

public void Add(KeyValuePair<ParameterKey, object> item)

Parameters

item KeyValuePair<ParameterKey, object>

The object to add to the ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

Contains(KeyValuePair<ParameterKey, object>)

Determines whether the ICollection<T> contains a specific value.

public bool Contains(KeyValuePair<ParameterKey, object> item)

Parameters

item KeyValuePair<ParameterKey, object>

The object to locate in the ICollection<T>.

Returns

bool

true if item is found in the ICollection<T>; otherwise, false.

CopyTo(KeyValuePair<ParameterKey, object>[], int)

Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.

public void CopyTo(KeyValuePair<ParameterKey, object>[] array, int arrayIndex)

Parameters

array KeyValuePair<ParameterKey, object>[]

The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing.

arrayIndex int

The zero-based index in array at which copying begins.

Exceptions

ArgumentNullException

array is null.

ArgumentOutOfRangeException

arrayIndex is less than 0.

ArgumentException

The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array.

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<KeyValuePair<ParameterKey, object>> GetEnumerator()

Returns

IEnumerator<KeyValuePair<ParameterKey, object>>

An enumerator that can be used to iterate through the collection.

Remove(KeyValuePair<ParameterKey, object>)

Removes the first occurrence of a specific object from the ICollection<T>.

public bool Remove(KeyValuePair<ParameterKey, object> item)

Parameters

item KeyValuePair<ParameterKey, object>

The object to remove from the ICollection<T>.

Returns

bool

true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

TryGetValue(ParameterKey, out object)

Gets the value associated with the specified key.

public bool TryGetValue(ParameterKey key, out object value)

Parameters

key ParameterKey

The key whose value to get.

value object

When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.

Returns

bool

true if the object that implements IDictionary<TKey, TValue> contains an element with the specified key; otherwise, false.

Exceptions

ArgumentNullException

key is null.