Microsoft DirectX 9.0 SDK Update (October 2004)

BaseEffect Class

Language:

Note: This documentation is preliminary and is subject to change.

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

Definition

Visual Basic .NET Public Class BaseEffect
   Inherits MarshalByRefObject 
   Implements IDisposable
C# public class BaseEffect : MarshalByRefObject,
   IDisposable
Managed C++ public __gc class BaseEffect  : public MarshalByRefObject,
   IDisposable
JScript .NET public class BaseEffect extends MarshalByRefObject
   implements IDisposable

Members Table

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.
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.
static (Shared in Visual Basic .NET) op_Equality Compares the current instance of a class to another instance to determine whether they are the same.
static (Shared in Visual Basic .NET) 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.
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.
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 Leave Site
MarshalByRefObject Leave Site

Class Information

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

© 2004 Microsoft Corporation. All rights reserved. Terms of use.

Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center