Share via

EffectCompiler.FromStream(Stream,Include,ShaderFlags) Method (Microsoft.DirectX.Direct3D)

  • Article

Creates an effect compiler from an ASCII or binary effect description in a stream.

Definition

Visual Basic Public Shared Function FromStream( _
    ByVal sourceData As StreamLeave Site, _
    ByVal includeFile As Include, _
    ByVal flags As ShaderFlags _
) As EffectCompiler
C# public static EffectCompiler FromStream(
    StreamLeave Site sourceData,
    Include includeFile,
    ShaderFlags flags
);
C++ public:
static EffectCompiler^ FromStream(
    StreamLeave Site^ sourceData,
    Include^ includeFile,
    ShaderFlags flags
);
JScript public static function FromStream(
    sourceData : StreamLeave Site,
    includeFile : Include,
    flags : ShaderFlags
) : EffectCompiler;

Parameters

sourceData System.IO.Stream
A StreamLeave Site object that contains the data used to create the EffectCompiler.
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.

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.

OutOfMemoryExceptionLeave Site

Microsoft Direct3D could not allocate sufficient memory to complete the call.

See Also