BaseEffect Class (Microsoft.DirectX.Direct3D)

Provides methods for retrieving and setting effect parameters such as constants, functions, shaders, and techniques.

Definition

Visual Basic	Public Class BaseEffect     Inherits MarshalByRefObject     Implements IDisposable
C#	public class BaseEffect : MarshalByRefObject, IDisposable
C++	public ref class BaseEffect : MarshalByRefObject, IDisposable
JScript	public class BaseEffect extends MarshalByRefObject implements IDisposable

Members Table

The following table lists the members exposed by the object.

Events

Event	Description
Disposing	Occurs when the Dispose method is called or when the BaseEffect object is finalized and collected by the garbage collector of the .NET common language runtime.

Methods

Method	Description
BaseEffect	Initializes a new instance of the BaseEffect class.
Dispose	Immediately releases the unmanaged resources used by the BaseEffect object.
Equals	Returns a value that indicates whether the current instance is equal to a specified object.
Finalize	Allows the BaseEffect object to free resources before it is destroyed by the garbage collector.
GetAnnotation	Retrieves an annotation.
GetFunction	Retrieves a function.
GetFunctionDescription	Retrieves a function description.
GetHashCode	Returns the hash code for the current instance.
GetObjectByValue	This member supports the infrastructure for Microsoft DirectX 9.0 for Managed Code and is not intended to be used directly from your code.
GetParameter	Retrieves a top-level parameter or a structure member parameter.
GetParameterBySemantic	Retrieves the handle of a top-level parameter or structure member parameter by looking up its semantic.
GetParameterDescription	Retrieves a parameter or annotation description.
GetParameterElement	Retrieves the EffectHandle of an array element parameter.
GetPass	Retrieves the EffectHandle of a pass.
GetPassDescription	Retrieves a pass description.
GetTechnique	Retrieves the EffectHandle of a technique.
GetTechniqueDescription	Retrieves a technique description.
GetValue	Retrieves the value of an arbitrary parameter or annotation, including simple types, structures, arrays, strings, shaders, and textures.
GetValueBoolean	Retrieves a Boolean value.
GetValueBooleanArray	Retrieves an array of Boolean values.
GetValueColor	Retrieves a ColorValue structure.
GetValueColorArray	Retrieves an array of ColorValue structures.
GetValueFloat	Retrieves a floating-point value.
GetValueFloatArray	Retrieves an array of floating-point values.
GetValueInteger	Retrieves an integer.
GetValueIntegerArray	Retrieves an array of integers.
GetValueMatrix	Retrieves a nontransposed matrix.
GetValueMatrixArray	Retrieves an array of nontransposed matrices.
GetValueMatrixTranspose	Retrieves a transposed matrix.
GetValueMatrixTransposeArray	Retrieves an array of transposed matrices.
GetValuePixelShader	Retrieves a pixel shader.
GetValueString	Retrieves a string.
GetValueTexture	Retrieves a texture.
GetValueVector	Retrieves a vector.
GetValueVectorArray	Retrieves an array of vectors.
GetValueVertexShader	Retrieves a vertex shader.
op_Equality	Compares the current instance of a class to another instance to determine whether they are the same.
op_Inequality	Compares the current instance of a class to another instance to determine whether they are different.
raise_Disposing	Raises the Microsoft.DirectX.Direct3D.BaseEffect.Disposing event when called from within a derived class.
SetValue	Sets the value of an arbitrary parameter or annotation, including simple types, structures, arrays, strings, shaders, and textures.
SetValueTranspose	Sets a transposed matrix.
UpdateUnmanagedPointer	Updates the unmanaged pointer for this BaseEffect object. This method supports the Microsoft .NET Framework infrastructure and is not intended to be used directly in your code.

Properties

Property	Description
Description	Retrieves an effect description.
Disposed	Gets a value that indicates whether the object is disposed.
UnmanagedComPointer	Returns the unmanaged Component Object Model (COM) ID3DXBaseEffect interface pointer.

Inheritance Hierarchy

Object

MarshalByRefObject

BaseEffect

Effect

EffectCompiler

Class Information

Namespace	Microsoft.DirectX.Direct3D
Assembly	Microsoft.DirectX.Direct3DX (microsoft.directx.direct3dx.dll)
Strong Name	Microsoft.DirectX.Direct3DX,  Version=1.0.900.0,  Culture=neutral,  PublicKeyToken=d3231b57b74a1492