Vixen
02b45cc4
csharp
public record class CompositorField

One of a compositor node's settings, as its type declares it.

No guide page documents this yet — the page shows what the code says about itself.

Remarks

⚠ Declared on the node type rather than emitted by the generator. The node-graph generator reads [Input] and [Output] fields, whose declared type is the port's kind — and every kind it has is a number or a texture, because that is what a shader graph and a VFX graph are made of. A compositor's settings are mostly names, which are not ports at all: nothing connects to them and no edge carries them. Rather than teach the generator a port kind that cannot be wired, each node says what it holds.

The cost is a list per node type that has to agree with what Emit reads. It is one file, and the alternative — a node kind that appears on the canvas as a socket nobody can connect a wire to — is a worse thing to explain.

Fields and properties (6)

  • public string Key

    What it is stored under — a port name in Texts or in Values.

  • public string Label

    What the row is called.

  • public CompositorFieldKind Kind

    Which editor it wants.

  • public string Help

    One sentence, shown on hover.

  • public string[]? Options

    The choices, for Choice.

  • public float Fallback

    The number a Number starts at.

Methods (1)

  • public CompositorField(string Key, string Label, CompositorFieldKind Kind, string Help = "", string[]? Options = null, float Fallback = 0)

    One of a compositor node's settings, as its type declares it.

Used by (16)

  • BufferNodeVixen.Editor.AssetEditors
  • BufferReadbackNodeVixen.Editor.AssetEditors
  • BufferUploadNodeVixen.Editor.AssetEditors
  • CompositorNodeVixen.Editor.AssetEditors
  • CompositorViewVixen.Editor.AssetEditors
  • ComputeNodeVixen.Editor.AssetEditors
  • FullScreenNodeVixen.Editor.AssetEditors
  • GpuCullingNodeVixen.Editor.AssetEditors
  • HiZNodeVixen.Editor.AssetEditors
  • PunctualShadowNodeVixen.Editor.AssetEditors
  • RenderPassNodeVixen.Editor.AssetEditors
  • ResourceNodeVixen.Editor.AssetEditors
  • SequenceNodeVixen.Editor.AssetEditors
  • ShadowMapNodeVixen.Editor.AssetEditors
  • SingleStageNodeVixen.Editor.AssetEditors
  • StageNodeVixen.Editor.AssetEditors