Effect.CompileEffectFromFile Method (String, CompilerMacro , CompilerIncludeHandler, CompilerOptions, TargetPlatform)
Note
This method is available only when developing for Windows.
Compiles an effect from a file containing the effect source code.
Namespace: Microsoft.Xna.Framework.Graphics
Assembly: Microsoft.Xna.Framework (in microsoft.xna.framework.dll)
Syntax
public static CompiledEffect CompileEffectFromFile (
string effectFile,
CompilerMacro[] preprocessorDefines,
CompilerIncludeHandler includeHandler,
CompilerOptions options,
TargetPlatform platform
)
Parameters
- effectFile
The name of the file containing the effect source code. - preprocessorDefines
Describes preprocessor definitions used by an effect object. - includeHandler
User-implemented interface to provide callbacks for #include directives during shader compilation. - options
Compilation optimization options. - platform
The target platform for the compilation.
Return Value
The compiled effect.
Exceptions
Exception type | Condition |
---|---|
ArgumentException | effectFile is a zero-length string, contains only white space, or contains one or more invalid characters as defined by InvalidPathChars. |
ArgumentNullException | effectFile is null. |
PathTooLongException | The specified path, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters. |
DirectoryNotFoundException | The specified path is invalid (for example, it is on an unmapped drive). |
UnauthorizedAccessException | The effectFile parameter specifies a directory, or the caller does not have the required permission to access the file specified by filename. |
FileNotFoundException | The file specified in effectFile was not found. |
NotSupportedException | effectFile is in an invalid format. |
See Also
Reference
Effect Class
Effect Members
Microsoft.Xna.Framework.Graphics Namespace
Platforms
Windows XP SP2, Windows Vista