FragmentLinker.GatherFragmentsFromFile Method

Language:

Assembles shader fragments and creates a new fragment linker object.

Definition

Visual Basic Public Shared Function GatherFragmentsFromFile( _
    ByVal file As String, _
    ByVal preprocessorDefines() As Macro, _
    ByVal includeFile As Include, _
    ByVal flags As ShaderFlags, _
    ByRef compilationErrors As String _
) As GraphicsStream

C# public static GraphicsStream GatherFragmentsFromFile(
    string file,
    Macro[] preprocessorDefines,
    Include includeFile,
    ShaderFlags flags,
    out string compilationErrors
);

C++ public:
static GraphicsStream^ GatherFragmentsFromFile(
    String^ file,
    array<Macro>^ preprocessorDefines,
    Include^ includeFile,
    ShaderFlags flags,
    [Out] String^% compilationErrors
);

JScript public static function GatherFragmentsFromFile(
    file : String,
    preprocessorDefines : Macro[],
    includeFile : Include,
    flags : ShaderFlags,
    compilationErrors : String
) : GraphicsStream;

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

Parameters

file System.String
String that represents the name of the file that contains the shader fragments.

preprocessorDefines Microsoft.DirectX.Direct3D.Macro[]
Array of Macro objects that specify the preprocessor definitions to use.

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

flags Microsoft.DirectX.Direct3D.ShaderFlags
A ShaderFlags enumeration that specifies the shader compiler options to use.

compilationErrors System.String
A String that contains a listing of errors and warnings that were encountered during compilation.

Return Value

Microsoft.DirectX.GraphicsStream
A GraphicsStream object that contains the created shader. This buffer 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 represents the name of the file that contains the shader fragments.
preprocessorDefines	Microsoft.DirectX.Direct3D.Macro[] Array of Macro objects that specify the preprocessor definitions to use.
includeFile	Microsoft.DirectX.Direct3D.Include An Include object that provides access to include-file directives.
flags	Microsoft.DirectX.Direct3D.ShaderFlags A ShaderFlags enumeration that specifies the shader compiler options to use.
compilationErrors	System.String A String that contains a listing of errors and warnings that were encountered during compilation.

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.