Vixen
02b45cc4

GraphicsCompositorAsset

class Core/Vixen.Rendering/Compositor/CompositorAsset.cs:1030
csharp
public record class GraphicsCompositorAsset

A whole authored frame: the stages it has, and the tree that draws them.

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

Remarks

docs/plan/06's third idea, as a file. "Swap forward for deferred" is a different document rather than a different build, and the three shipped presets are three of these over the same features.

Version is checked rather than ignored. A file from a later editor is refused by number, naming both versions, because the alternative is binding what it understands and silently dropping what it does not — which produces a frame that is missing a pass and says nothing about it.

Fields and properties (8)

  • public int Version

    The schema version this document is written in.

  • public RenderStageAsset[] Stages

    The stages, which nodes refer to by name.

  • public RenderResourceAsset[] Resources

    The transient targets the frame declares, which passes refer to by name.

  • public RenderBufferAsset[] Buffers

    The transient buffers it declares.

  • public ViewBlockAsset? ViewBlock

    The per-view block every shader in the frame shares, or null for a frame with none.

  • public GpuDrivenAsset? GpuDriven

    Whether the frame draws the GPU-driven way, or null for the way every device can.

  • public ISceneRendererAsset? Game

    The root of the graph — the whole frame.

  • public static GraphicsCompositorAsset Default

    The frame a project with no compositor of its own is drawn with.

Used by (23)

  • ArenaThirdPersonShooter
  • FrameDocumentTestsThirdPersonShooter.Frame.Tests
  • VirtualGeometryGameVirtualGeometry
  • AppGraphicsVixen.App.Hosting
  • BufferTransferTestsVixen.Rendering.Tests
  • CompositorAssetTestsVixen.Rendering.Tests
  • CompositorBuilderVixen.Rendering
  • CompositorContentTestsVixen.Assets.Tests
  • DefaultFrameTestsVixen.Rendering.Tests
  • GpuDrivenCompositorTestsVixen.Rendering.Tests
  • PostEffectTestsVixen.Rendering.PostFx.Tests
  • SceneRenderHostVixen.Engine.Renderer
  • SceneRenderHostTestsVixen.Engine.Renderer.Tests
  • TypeRegistrationVixen.Rendering
  • VirtualGeometryDeviceTestsVixen.Graphics.Golden.Tests
  • Vixen_Rendering_Compositor_GraphicsCompositorAssetSerializerVixen.Rendering
  • WorldRendererTestsVixen.Engine.Renderer.Tests
  • CompositorCompilerTestsVixen.Editor.AssetEditors.Tests
  • CompositorDocumentVixen.Editor.AssetEditors
  • CompositorGraphCompilerVixen.Editor.AssetEditors
  • CompositorImporterVixen.Editor.Assets
  • CompositorViewVixen.Editor.AssetEditors
  • HostedRendererTestsVixen.App.Tests