EffectCompiler Class (Microsoft.DirectX.Direct3D)

Article
11/06/2009

Compiles an effect from a function or vertex shader.

Definition

Visual Basic NotInheritable Public Class EffectCompiler
Inherits BaseEffect

C# public sealed class EffectCompiler : BaseEffect

C++ public ref class EffectCompiler sealed : BaseEffect

JScript public final class EffectCompiler extends BaseEffect

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 EffectCompiler object is finalized and collected by the garbage collector of the .NET common language runtime.

Methods

Method Description

CompileEffect Compiles an effect.

CompileShader Compiles a shader from an effect that contains one or more functions.

Dispose Immediately releases the unmanaged resources used by the BaseEffect object. Inherited from BaseEffect.

EffectCompiler Initializes a new instance of the EffectCompiler class.

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. Inherited from BaseEffect.

FromFile Creates an effect compiler from an ASCII or binary effect description.

FromStream Creates an effect compiler from an ASCII or binary effect description in a stream.

FromString Creates an effect compiler from an ASCII or binary effect description in a string.

GetAnnotation Retrieves an annotation. Inherited from BaseEffect.

GetFunction Retrieves a function. Inherited from BaseEffect.

GetFunctionDescription Retrieves a function description. Inherited from BaseEffect.

GetHashCode Returns the hash code for the current instance.

GetLiteral Retrieves a literal status of a parameter.

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. Inherited from BaseEffect.

GetParameterBySemantic Retrieves the handle of a top-level parameter or structure member parameter by looking up its semantic. Inherited from BaseEffect.

GetParameterDescription Retrieves a parameter or annotation description. Inherited from BaseEffect.

GetParameterElement Retrieves the EffectHandle of an array element parameter. Inherited from BaseEffect.

GetPass Retrieves the EffectHandle of a pass. Inherited from BaseEffect.

GetPassDescription Retrieves a pass description. Inherited from BaseEffect.

GetTechnique Retrieves the EffectHandle of a technique. Inherited from BaseEffect.

GetTechniqueDescription Retrieves a technique description. Inherited from BaseEffect.

GetValue Retrieves the value of an arbitrary parameter or annotation, including simple types, structures, arrays, strings, shaders, and textures. Inherited from BaseEffect.

GetValueBoolean Retrieves a Boolean value. Inherited from BaseEffect.

GetValueBooleanArray Retrieves an array of Boolean values. Inherited from BaseEffect.

GetValueColor Retrieves a ColorValue structure. Inherited from BaseEffect.

GetValueColorArray Retrieves an array of ColorValue structures. Inherited from BaseEffect.

GetValueFloat Retrieves a floating-point value. Inherited from BaseEffect.

GetValueFloatArray Retrieves an array of floating-point values. Inherited from BaseEffect.

GetValueInteger Retrieves an integer. Inherited from BaseEffect.

GetValueIntegerArray Retrieves an array of integers. Inherited from BaseEffect.

GetValueMatrix Retrieves a nontransposed matrix. Inherited from BaseEffect.

GetValueMatrixArray Retrieves an array of nontransposed matrices. Inherited from BaseEffect.

GetValueMatrixTranspose Retrieves a transposed matrix. Inherited from BaseEffect.

GetValueMatrixTransposeArray Retrieves an array of transposed matrices. Inherited from BaseEffect.

GetValuePixelShader Retrieves a pixel shader. Inherited from BaseEffect.

GetValueString Retrieves a string. Inherited from BaseEffect.

GetValueTexture Retrieves a texture. Inherited from BaseEffect.

GetValueVector Retrieves a vector. Inherited from BaseEffect.

GetValueVectorArray Retrieves an array of vectors. Inherited from BaseEffect.

GetValueVertexShader Retrieves a vertex shader. Inherited from BaseEffect.

op_Equality Compares the current instance of a class to another instance to determine whether they are the same.

op_Equality Compares the current instance of a class to another instance to determine whether they are the same. Inherited from BaseEffect.

op_Inequality Compares the current instance of a class to another instance to determine whether they are different.

op_Inequality Compares the current instance of a class to another instance to determine whether they are different. Inherited from BaseEffect.

raise_Disposing Raises the Microsoft.DirectX.Direct3D.EffectCompiler.Disposing event when called from within a derived class.

SetArrayRange Sets the range of an array to pass to the device.

SetLiteral Toggles the literal status of a parameter.

SetValue Sets the value of an arbitrary parameter or annotation, including simple types, structures, arrays, strings, shaders, and textures. Inherited from BaseEffect.

SetValueTranspose Sets a transposed matrix. Inherited from BaseEffect.

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. Inherited from BaseEffect.

UpdateUnmanagedPointer Updates the unmanaged pointer for this EffectCompiler object. This method supports the Framework infrastructure and is not intended to be used directly in your code.

Properties

Property Description

Description Retrieves an effect description. Inherited from BaseEffect.

Disposed Gets a value that indicates whether the object is disposed.

UnmanagedComPointer Returns the unmanaged Component Object Model (COM) ID3DXBaseEffect interface pointer. Inherited from BaseEffect.

UnmanagedComPointer Returns the unmanaged COM ID3DXEffectCompiler interface pointer.

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

Method	Description
CompileEffect	Compiles an effect.
CompileShader	Compiles a shader from an effect that contains one or more functions.
Dispose	Immediately releases the unmanaged resources used by the BaseEffect object. Inherited from BaseEffect.
EffectCompiler	Initializes a new instance of the EffectCompiler class.
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. Inherited from BaseEffect.
FromFile	Creates an effect compiler from an ASCII or binary effect description.
FromStream	Creates an effect compiler from an ASCII or binary effect description in a stream.
FromString	Creates an effect compiler from an ASCII or binary effect description in a string.
GetAnnotation	Retrieves an annotation. Inherited from BaseEffect.
GetFunction	Retrieves a function. Inherited from BaseEffect.
GetFunctionDescription	Retrieves a function description. Inherited from BaseEffect.
GetHashCode	Returns the hash code for the current instance.
GetLiteral	Retrieves a literal status of a parameter.
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. Inherited from BaseEffect.
GetParameterBySemantic	Retrieves the handle of a top-level parameter or structure member parameter by looking up its semantic. Inherited from BaseEffect.
GetParameterDescription	Retrieves a parameter or annotation description. Inherited from BaseEffect.
GetParameterElement	Retrieves the EffectHandle of an array element parameter. Inherited from BaseEffect.
GetPass	Retrieves the EffectHandle of a pass. Inherited from BaseEffect.
GetPassDescription	Retrieves a pass description. Inherited from BaseEffect.
GetTechnique	Retrieves the EffectHandle of a technique. Inherited from BaseEffect.
GetTechniqueDescription	Retrieves a technique description. Inherited from BaseEffect.
GetValue	Retrieves the value of an arbitrary parameter or annotation, including simple types, structures, arrays, strings, shaders, and textures. Inherited from BaseEffect.
GetValueBoolean	Retrieves a Boolean value. Inherited from BaseEffect.
GetValueBooleanArray	Retrieves an array of Boolean values. Inherited from BaseEffect.
GetValueColor	Retrieves a ColorValue structure. Inherited from BaseEffect.
GetValueColorArray	Retrieves an array of ColorValue structures. Inherited from BaseEffect.
GetValueFloat	Retrieves a floating-point value. Inherited from BaseEffect.
GetValueFloatArray	Retrieves an array of floating-point values. Inherited from BaseEffect.
GetValueInteger	Retrieves an integer. Inherited from BaseEffect.
GetValueIntegerArray	Retrieves an array of integers. Inherited from BaseEffect.
GetValueMatrix	Retrieves a nontransposed matrix. Inherited from BaseEffect.
GetValueMatrixArray	Retrieves an array of nontransposed matrices. Inherited from BaseEffect.
GetValueMatrixTranspose	Retrieves a transposed matrix. Inherited from BaseEffect.
GetValueMatrixTransposeArray	Retrieves an array of transposed matrices. Inherited from BaseEffect.
GetValuePixelShader	Retrieves a pixel shader. Inherited from BaseEffect.
GetValueString	Retrieves a string. Inherited from BaseEffect.
GetValueTexture	Retrieves a texture. Inherited from BaseEffect.
GetValueVector	Retrieves a vector. Inherited from BaseEffect.
GetValueVectorArray	Retrieves an array of vectors. Inherited from BaseEffect.
GetValueVertexShader	Retrieves a vertex shader. Inherited from BaseEffect.
op_Equality	Compares the current instance of a class to another instance to determine whether they are the same.
op_Equality	Compares the current instance of a class to another instance to determine whether they are the same. Inherited from BaseEffect.
op_Inequality	Compares the current instance of a class to another instance to determine whether they are different.
op_Inequality	Compares the current instance of a class to another instance to determine whether they are different. Inherited from BaseEffect.
raise_Disposing	Raises the Microsoft.DirectX.Direct3D.EffectCompiler.Disposing event when called from within a derived class.
SetArrayRange	Sets the range of an array to pass to the device.
SetLiteral	Toggles the literal status of a parameter.
SetValue	Sets the value of an arbitrary parameter or annotation, including simple types, structures, arrays, strings, shaders, and textures. Inherited from BaseEffect.
SetValueTranspose	Sets a transposed matrix. Inherited from BaseEffect.
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. Inherited from BaseEffect.
UpdateUnmanagedPointer	Updates the unmanaged pointer for this EffectCompiler object. This method supports the Framework infrastructure and is not intended to be used directly in your code.

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

Inheritance Hierarchy

Object

MarshalByRefObject

BaseEffect

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

Visual Basic	NotInheritable Public Class EffectCompiler Inherits BaseEffect
C#	public sealed class EffectCompiler : BaseEffect
C++	public ref class EffectCompiler sealed : BaseEffect
JScript	public final class EffectCompiler extends BaseEffect

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

EffectCompiler Class (Microsoft.DirectX.Direct3D)

Additional resources