Skip to content

Class FrameOverlay

Namespace: Apogee.Host
Assembly: Apogee.Host.dll

What goes over the finished picture: the game's UI, then the dev tools on top of it. The UI renderer is made the first frame after a document was loaded, so a script that only has ImGui panels never compiles the UI shader.

public sealed class FrameOverlay : IRenderOverlay, IDisposable

Inheritance

object ← FrameOverlay

Implements

IRenderOverlay, IDisposable

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

Constructors

FrameOverlay(GraphicsDevice, ShaderLibrary, ScriptSession, ImGuiRenderer)

What goes over the finished picture: the game's UI, then the dev tools on top of it. The UI renderer is made the first frame after a document was loaded, so a script that only has ImGui panels never compiles the UI shader.

public FrameOverlay(GraphicsDevice device, ShaderLibrary shaders, ScriptSession session, ImGuiRenderer imgui)

Parameters

device GraphicsDevice

shaders ShaderLibrary

session ScriptSession

imgui ImGuiRenderer

Methods

AddPasses(RenderGraph, ImageHandle, Frame)

Adds the passes that draw onto output, which holds the tone-mapped image by now and is left as it is.

public void AddPasses(RenderGraph graph, ImageHandle output, Frame frame)

Parameters

graph RenderGraph

output ImageHandle

frame Frame

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()