Skip to content

Class ImGuiRenderer

Namespace: Apogee.DevTools
Assembly: Apogee.DevTools.dll

Draws Dear ImGui's draw data onto the frame's output as a render-graph pass: its textures (the font atlas) become images in the bindless heap as ImGui asks for them, and its vertices and indices go through per-frame buffers that the shader pulls from. Use it as the of , or call on your own graph.

public sealed class ImGuiRenderer : IRenderOverlay, IDisposable

Inheritance

object ← ImGuiRenderer

Implements

IRenderOverlay, IDisposable

Inherited Members

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

Constructors

ImGuiRenderer(GraphicsDevice, ShaderLibrary?, string?, int)

public ImGuiRenderer(GraphicsDevice device, ShaderLibrary? shaders = null, string? cacheDirectory = null, int framesInFlight = 2)

Parameters

device GraphicsDevice

shaders ShaderLibrary?

cacheDirectory string?

framesInFlight int

Properties

Shaders

The library the shader comes from (its errors are what the dev overlay shows when an edit does not compile).

public ShaderLibrary Shaders { get; }

Property Value

ShaderLibrary

TextureCount

The number of ImGui textures on the GPU (the font atlas, and any a game registers).

public int TextureCount { get; }

Property Value

int

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()