Microsoft DirectX 9.0 SDK Update (October 2004)

EffectCompiler.FromFile Method

Language:

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

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

Definition

Visual Basic .NET Public Shared Function FromFile( _
    ByVal sourceFile As String, _
    ByVal includeFile As Include, _
    ByVal flags As ShaderFlags, _
    ByRef compilationErrors As String _
) As EffectCompiler
C# public static EffectCompiler FromFile(
    string sourceFile,
    Include includeFile,
    ShaderFlags flags,
    out string compilationErrors
);
Managed C++ public: static EffectCompiler* FromFile(
    String *sourceFile,
    Include *includeFile,
    ShaderFlags flags,
    String **compilationErrors
);
JScript .NET public static function FromFile(
    sourceFile : String,
    includeFile : Include,
    flags : ShaderFlags,
    compilationErrors : String
) : EffectCompiler;

Parameters

sourceFile System.String. String that indicates the file name.
includeFile Microsoft.DirectX.Direct3D.Include. Optional Include object to use for handling #include directives. If this value is null, #include directives are either honored when compiling from a file, or cause an error when compiled from a resource or memory.
flags Microsoft.DirectX.Direct3D.ShaderFlags. One or more compile options identified by the ShaderFlags enumeration.
compilationErrors System.String. String that contains a listing of compilation errors.

Return Value

Microsoft.DirectX.Direct3D.EffectCompiler . An EffectCompiler that represents the effect compiler.

Remarks

Exceptions
InvalidCallException The method call is invalid. For example, a method's parameter might contain an invalid value.
InvalidDataException The data is invalid.
OutOfMemoryException Leave Site Microsoft® Direct3D® could not allocate sufficient memory to complete the call.

See Also


© 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