Microsoft DirectX 9.0 SDK Update (October 2004)

ShaderLoader.CompileShader Method

Language:

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

Definition

Visual Basic .NET Public Shared Function CompileShader( _
    ByVal data 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 CompileShader(
    string data,
    string functionName,
    Macro[] preprocessorDefines,
    Include includeFile,
    string profile,
    ShaderFlags flags,
    out string errorMessages,
    out ConstantTable table
);
Managed C++ public: static GraphicsStream* CompileShader(
    String *data,
    String *functionName,
    Macro preprocessorDefines __gc[],
    Include *includeFile,
    String *profile,
    ShaderFlags flags,
    String **errorMessages,
    ConstantTable **table
);
JScript .NET public static function CompileShader(
    data : String,
    functionName : String,
    preprocessorDefines : Macro[],
    includeFile : Include,
    profile : String,
    flags : ShaderFlags,
    errorMessages : String,
    table : ConstantTable
) : GraphicsStream;

Parameters

data System.String. String that contains 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 Leave Site Microsoft® Direct3D® could not allocate sufficient memory to complete the call.


© 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