Kanzi 4.1.0
ShaderGraphValidationError Class Referencesealed

Structured description of a single shader-graph validation failure. More...

Public Member Functions

 ShaderGraphValidationError (ShaderGraphValidationErrorCode code, string message, string? nodeId=null, string? edgeId=null, string? portId=null, string? suggestion=null)
 

Properties

ShaderGraphValidationErrorCode Code [get]
 Discriminator for branching on failure category.
 
stringEdgeId [get]
 Id of the offending edge, when the error is edge-scoped.
 
string Message [get]
 Human-readable description of what went wrong.
 
stringNodeId [get]
 Id of the offending node, when the error is node-scoped.
 
stringPortId [get]
 Id of the offending port, when the error is port-scoped.
 
stringSuggestion [get]
 Optional remediation hint; may be null.
 

Detailed Description

Structured description of a single shader-graph validation failure.

The validator returns these from ShaderGraph.ValidateModelJson(string) and packages them in ShaderGraphValidationException.Errors when ShaderGraph.SetModelJson(string) rejects a write.

Constructor & Destructor Documentation

◆ ShaderGraphValidationError()

ShaderGraphValidationError ( ShaderGraphValidationErrorCode code,
string message,
string? nodeId = null,
string? edgeId = null,
string? portId = null,
string? suggestion = null )
inline

Property Documentation

◆ Code

Discriminator for branching on failure category.

◆ EdgeId

string? EdgeId
get

Id of the offending edge, when the error is edge-scoped.

◆ Message

string Message
get

Human-readable description of what went wrong.

◆ NodeId

string? NodeId
get

Id of the offending node, when the error is node-scoped.

◆ PortId

string? PortId
get

Id of the offending port, when the error is port-scoped.

◆ Suggestion

string? Suggestion
get

Optional remediation hint; may be null.