Class FileSystemIncludeResolver

Namespace

ShadowDusk.Core.Preprocessor

Assembly

ShadowDusk.Core.dll

An IIncludeResolver that resolves #include directives from the file system, searching first relative to the including file's directory and then the supplied additional search paths.

public sealed class FileSystemIncludeResolver : IIncludeResolver

Inheritance

object

FileSystemIncludeResolver

Implements

IIncludeResolver

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Resolve(string, string?, IReadOnlyList<string>)

Resolves a single #include reference to its file path and contents.

public Result<IncludeResolvedFile, ShaderError> Resolve(string includePath, string? includingFilePath, IReadOnlyList<string> additionalSearchPaths)

Parameters

includePath string

The path as written in the #include directive.

includingFilePath string

The file that issued the #include, or null.

additionalSearchPaths IReadOnlyList<string>

Extra directories to search, in order.

Returns

Result<IncludeResolvedFile, ShaderError>

The resolved file (path + text) on success, or a ShaderError (e.g. IncludeNotFound) on failure.