Show / Hide Table of Contents

Class ImGuiImplementation

A basic ImGui interface that adds the ImGuiMonoGameComponent to MonoGame, rendering ImGui over SadConsole.

Inheritance
object
ImGuiImplementation
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: SadConsole.ImGuiSystem
Assembly: SadConsole.Debug.MonoGame.dll
Syntax
public static class ImGuiImplementation

Properties

MonoGameComponent

Gets the MonoGame component that is rendering ImGui.

Declaration
public static ImGuiMonoGameComponent MonoGameComponent { get; }
Property Value
Type Description
ImGuiMonoGameComponent

Renderer

Gets the renderer for ImGui.

Declaration
public static ImGuiRenderer Renderer { get; }
Property Value
Type Description
ImGuiRenderer

UIObjects

Gets the list of UI objects that is drawn by ImGui.

Declaration
public static List<ImGuiObjectBase> UIObjects { get; }
Property Value
Type Description
List<ImGuiObjectBase>

Methods

Start(bool, bool, bool, float, string)

Starts the ImGui system.

Declaration
public static void Start(bool disableFinalDraw = true, bool disableUpdate = false, bool disableInput = true, float fontSize = 18, string fontFileTTF = "Roboto-Regular.ttf")
Parameters
Type Name Description
bool disableFinalDraw

Turns off DoFinalDraw, which causes SadConsole to only render ImGui to the screen.

bool disableUpdate

Turns off DoUpdate, which pauses SadConsole's update loop.

bool disableInput

Turns off DoKeyboard and DoMouse, allowing only ImGui to handle input.

float fontSize

The font size to use with ImGui.

string fontFileTTF

The TTF font file to use with ImGui.

In this article

Back to top

Back to top Generated by DocFX