Resolves #include directives in GLSL shader source. More...

#include <phosphor-shaders/include/PhosphorShaders/ShaderIncludeResolver.h>

Static Public Member Functions
static QString	expandIncludes (const QString &source, const QString &currentFileDir, const QStringList &includePaths, QString outError=nullptr, QStringList outIncludedPaths=nullptr, QStringList *outSourcePaths=nullptr)
	Expand #include directives in `source`.

Static Public Attributes
static constexpr int	MaxIncludeDepth = 10

static constexpr const char *	GeneratedPreambleInclude = "p_generated.glsl"
	Reserved include name for the generated `p_<id>` autocomplete sidecar (`plasmazones-shader-validate --emit-preamble`).

Detailed Description

Resolves #include directives in GLSL shader source.

Supports:

#include "path" — search relative to current file's directory, then include paths
#include <path> — search only in include paths (e.g. global shaders dir)

Member Function Documentation

◆ expandIncludes()

static QString PhosphorShaders::ShaderIncludeResolver::expandIncludes	(	const QString &	source,
		const QString &	currentFileDir,
		const QStringList &	includePaths,
		QString *	outError = `nullptr`,
		QStringList *	outIncludedPaths = `nullptr`,
		QStringList *	outSourcePaths = `nullptr`
	)

static

Expand #include directives in source.

Parameters

source	Raw shader source (may contain #include "..." or #include <...>)
currentFileDir	Directory of the file that contains `source`
includePaths	Directories to search for includes
outError	If non-null, set on error (file not found, depth exceeded)
outIncludedPaths	If non-null, appended with the canonical absolute path of every successfully-resolved include file. Lets callers fingerprint transitively-included headers (e.g. for cache invalidation) — without this, a cache keyed only on the top-level shader's mtime serves stale baked SPIR-V when an included header changes.
outSourcePaths	If non-null, populated as a GLSL source-string legend: element `i` is the path of source-string number `i` as referenced by the `#line <n> <i>` directives this resolver emits around each inlined include. Index 0 is the top-level source — left empty because the resolver is handed only the source text and its directory, not the top-level file's path, so the caller (which knows which file it asked to expand) fills index 0. Consumers map a glslang / driver diagnostic of the form `<i>:<line>` back to `<path>:<line>`.

Returns: Expanded source, or empty string on error

Member Data Documentation

◆ GeneratedPreambleInclude

constexpr const char* PhosphorShaders::ShaderIncludeResolver::GeneratedPreambleInclude = "p_generated.glsl"

staticconstexpr

Reserved include name for the generated p_<id> autocomplete sidecar (plasmazones-shader-validate --emit-preamble).

An #include of a file with this basename is skipped (treated as a no-op) during expansion: the real param preamble is spliced at load, so the sidecar is an editor-only aid that must neither resolve nor error at runtime. Lets an author keep #include "p_generated.glsl" in the frag for glslls autocomplete while shipping it unchanged, with or without the sidecar present.

◆ MaxIncludeDepth

constexpr int PhosphorShaders::ShaderIncludeResolver::MaxIncludeDepth = 10