ShaderLoader.CompileShaderFromFile Method

Language:

Definition

Visual Basic Public Shared Function CompileShaderFromFile( _
    ByVal file As String, _
    ByVal functionName As String, _
    ByVal preprocessorDefines() As Macro, _
    ByVal includeFile As Include, _
    ByVal profile As String, _
    ByVal flags As ShaderFlags, _
    ByRef errorMessages As String, _
    ByRef table As ConstantTable _
) As GraphicsStream

C# public static GraphicsStream CompileShaderFromFile(
    string file,
    string functionName,
    Macro[] preprocessorDefines,
    Include includeFile,
    string profile,
    ShaderFlags flags,
    out string errorMessages,
    out ConstantTable table
);

C++ public:
static GraphicsStream^ CompileShaderFromFile(
    String^ file,
    String^ functionName,
    array<Macro>^ preprocessorDefines,
    Include^ includeFile,
    String^ profile,
    ShaderFlags flags,
    [Out] String^% errorMessages,
    [Out] ConstantTable^% table
);

JScript public static function CompileShaderFromFile(
    file : String,
    functionName : String,
    preprocessorDefines : Macro[],
    includeFile : Include,
    profile : String,
    flags : ShaderFlags,
    errorMessages : String,
    table : ConstantTable
) : GraphicsStream;

Visual Basic	Public Shared Function CompileShaderFromFile( _ ByVal file As String, _ ByVal functionName As String, _ ByVal preprocessorDefines() As Macro, _ ByVal includeFile As Include, _ ByVal profile As String, _ ByVal flags As ShaderFlags, _ ByRef errorMessages As String, _ ByRef table As ConstantTable _ ) As GraphicsStream
C#	public static GraphicsStream CompileShaderFromFile( string file, string functionName, Macro[] preprocessorDefines, Include includeFile, string profile, ShaderFlags flags, out string errorMessages, out ConstantTable table );
C++	public: static GraphicsStream^ CompileShaderFromFile( String^ file, String^ functionName, array<Macro>^ preprocessorDefines, Include^ includeFile, String^ profile, ShaderFlags flags, [Out] String^% errorMessages, [Out] ConstantTable^% table );
JScript	public static function CompileShaderFromFile( file : String, functionName : String, preprocessorDefines : Macro[], includeFile : Include, profile : String, flags : ShaderFlags, errorMessages : String, table : ConstantTable ) : GraphicsStream;

Parameters

file System.String
String that specifies the file name containing the shader code to compile.

functionName System.String
String that contains the name of the shader entry-point function where execution begins.

preprocessorDefines Microsoft.DirectX.Direct3D.Macro[]
Reference to a Macro object that describes the preprocessor definitions to use.

includeFile Microsoft.DirectX.Direct3D.Include
Reference to an Include object that provides access to include-file directives.

profile System.String
String containing the shader profile that determines the shader instruction set to use.

flags Microsoft.DirectX.Direct3D.ShaderFlags

errorMessages 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.

table Microsoft.DirectX.Direct3D.ConstantTable
Reference to a ConstantTable object that can be used to access shader constants.

Return Value

Microsoft.DirectX.GraphicsStream
A GraphicsStream object that contains the compiled 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 Microsoft Direct3D could not allocate sufficient memory to complete the call.

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

file	System.String String that specifies the file name containing the shader code to compile.
functionName	System.String String that contains the name of the shader entry-point function where execution begins.
preprocessorDefines	Microsoft.DirectX.Direct3D.Macro[] Reference to a Macro object that describes the preprocessor definitions to use.
includeFile	Microsoft.DirectX.Direct3D.Include Reference to an Include object that provides access to include-file directives.
profile	System.String String containing the shader profile that determines the shader instruction set to use.
flags	Microsoft.DirectX.Direct3D.ShaderFlags
errorMessages	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.
table	Microsoft.DirectX.Direct3D.ConstantTable Reference to a ConstantTable object that can be used to access shader constants.

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