Class ShaderValidationReport

Namespace

ShadowDusk.Core

Assembly

ShadowDusk.Core.dll

Everything wrong — and everything worth knowing — about one shader, across one or more targets. Produced by ValidateAsync(IShaderCompiler, string, CompilerOptions?, CancellationToken) / Validate(IShaderCompiler, string, CompilerOptions?, CancellationToken). The simplest use is to print it: ToString() renders the complete human-readable report (per-target status, every error with its source location and the compiler's verbatim text, every warning). For structured access walk Targets.

public sealed class ShaderValidationReport

Inheritance

object

ShaderValidationReport

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ShaderValidationReport(IReadOnlyList<ShaderTargetValidation>)

Creates a report over the given per-target results.

public ShaderValidationReport(IReadOnlyList<ShaderTargetValidation> targets)

Parameters

targets IReadOnlyList<ShaderTargetValidation>

Properties

AllDiagnostics

Every diagnostic from every target, errors first within each target, in target order. Convenient for logging pipelines that want one flat list.

public IReadOnlyList<ShaderError> AllDiagnostics { get; }

Property Value

IReadOnlyList<ShaderError>

IsClean

True when there is nothing to report at all — every target compiled and no target produced a single warning.

public bool IsClean { get; }

Property Value

bool

IsValid

True when the shader compiled for every validated target.

public bool IsValid { get; }

Property Value

bool

Targets

Per-target results, in the order they were validated.

public IReadOnlyList<ShaderTargetValidation> Targets { get; }

Property Value

IReadOnlyList<ShaderTargetValidation>

Methods

ToString()

The complete human-readable report: a summary line, then each target's status with every error and warning — source location when known, and the underlying compiler's full verbatim text when it adds information. Designed so that printing this one string tells a shader author what is wrong and where.

public override string ToString()

Returns

string