EffectParameterBinding Class

Binds a parameter of an effect to a certain value.

Inheritance Hierarchy

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

Syntax

public abstract class EffectParameterBinding

Public MustInherit Class EffectParameterBinding

public ref class EffectParameterBinding abstract

[<AbstractClassAttribute>]
type EffectParameterBinding =  class end

The EffectParameterBinding type exposes the following members.

Constructors

	Name	Description
	EffectParameterBinding	Initializes a new instance of the EffectParameterBinding class. (This constructor creates an uninitialized instance. Use this constructor only for cloning or other special cases!)
	EffectParameterBinding(Effect, EffectParameter)	Initializes a new instance of the EffectParameterBinding class.

Methods

	Name	Description
	Apply	Applies the value to the effect parameter.
	Clone	Creates a new EffectParameterBinding that is a clone of the current instance.
	CloneCore	Makes the instance a clone (deep copy) of the specified EffectParameterBinding.
	CreateInstanceCore	When implemented in a derived class, creates a new instance of the EffectParameterBinding derived class.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnApply	Called when the effect parameter value needs to be applied.
	OnUpdate	Called when the effect parameter value needs to be updated.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Update	Updates the value of the binding.

Properties

	Name	Description
	Description	Gets the description of the effect parameter.
	Parameter	Gets the effect parameter.

Remarks

This class is used to bind an EffectParameter of an Effect to a certain value. When the effect parameter represents a single value (such as Single, Vector3, Matrix, etc.) an EffectParameterBindingT should be used to bind the value. When the effect parameter represents an array of values an EffectParameterArrayBindingT needs to be used.

Cloning:
EffectParameterBindings need to be cloneable. The method Clone calls CreateInstanceCore and CloneCore(EffectParameterBinding) which are responsible for creating a clone of the current instance. Classes that derive from EffectParameterBinding need to provide the implementation for CreateInstanceCore and override CloneCore(EffectParameterBinding) if necessary.