ShaderLoader.FromFile Method

 Language:

Assembles a shader from a file.

Definition

Visual Basic Public Shared Function FromFile( _
    ByVal sourceFile As String, _
    ByVal includeFile As Include, _
    ByVal flags As ShaderFlags, _
    ByRef compilationErrors As String _
) As GraphicsStream
C# public static GraphicsStream FromFile(
    string sourceFile,
    Include includeFile,
    ShaderFlags flags,
    out string compilationErrors
);
C++ public:
static GraphicsStream^ FromFile(
    String^ sourceFile,
    Include^ includeFile,
    ShaderFlags flags,
    [Out] String^% compilationErrors
);
JScript public static function FromFile(
    sourceFile : String,
    includeFile : Include,
    flags : ShaderFlags,
    compilationErrors : String
) : GraphicsStream;

Parameters

sourceFile System.String
String that specifies the file name containing the shader code to assemble.
includeFile Microsoft.DirectX.Direct3D.Include
Reference to an Include object that provides access to include-file directives.
flags Microsoft.DirectX.Direct3D.ShaderFlags
Value of the ShaderFlags enumeration that represents the shader compiler options to use.
compilationErrors System.String
String containing a listing of errors and warnings that were encountered during compilation. These are the same messages the debugger displays in debug mode.

Return Value

Microsoft.DirectX.GraphicsStream
A GraphicsStream object that contains the assembled shader code, as well as any embedded debug and symbol table information.

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.

Send comments about this topic to Microsoft. © Microsoft Corporation. All rights reserved.

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