EffectParameterDescription.Index Property

EffectParameterDescriptionIndex Property

Gets the zero-based index.

Namespace: DigitalRune.Graphics.Effects
Assembly: DigitalRune.Graphics (in DigitalRune.Graphics.dll) Version: 1.2.0.0 (1.2.1.14562)

Syntax

C++

Copy

public int Index { get; }

Public ReadOnly Property Index As Integer
	Get

public:
property int Index {
	int get ();
}

member Index : int with get

Property Value

Type: Int32
The zero-based index. The default value is 0. (Internal: The value may be -1 during initialization. -1 indicates that the index is unknown and should be set automatically. When the index is -1 at runtime, this usually indicates an error and parameter bindings will not be applied correctly.)

Exceptions

Exception	Condition
ArgumentOutOfRangeException	value is out of range. Allowed values are -1, 0, and positive numbers.

Remarks

The index defines the object to which the parameter is bound if multiple objects of the same type exist. Example: The description (Semantic = "PointLightPosition", Index = 3, Hint = Local) means that the parameter stores the position of 4^th point light near the object that is being rendered.

Reference

EffectParameterDescription Class

DigitalRune.Graphics.Effects Namespace