Skip to content

Class Ui

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

The few Dear ImGui calls the dev tools use, with C# strings and ref values instead of C pointers. Call them between BeginFrame and EndFrame.

public static class Ui

Inheritance

object ← Ui

Inherited Members

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

Methods

Begin(string, ref bool, ImGuiWindowFlags)

public static bool Begin(string title, ref bool open, ImGuiWindowFlags flags = ImGuiWindowFlags.None)

Parameters

title string

open bool

flags ImGuiWindowFlags

Returns

bool

Begin(string, ImGuiWindowFlags)

Begins a window without a close button.

public static bool Begin(string title, ImGuiWindowFlags flags = ImGuiWindowFlags.None)

Parameters

title string

flags ImGuiWindowFlags

Returns

bool

BeginTable(string, int, ImGuiTableFlags)

public static bool BeginTable(string id, int columns, ImGuiTableFlags flags = ImGuiTableFlags.RowBg | ImGuiTableFlags.BordersInnerH | ImGuiTableFlags.SizingStretchProp)

Parameters

id string

columns int

flags ImGuiTableFlags

Returns

bool

Cell(string)

public static void Cell(string text)

Parameters

text string

Checkbox(string, ref bool)

public static bool Checkbox(string label, ref bool value)

Parameters

label string

value bool

Returns

bool

CollapsingHeader(string, bool)

A header that opens and closes its content; returns true while open. openByDefault sets its first state.

public static bool CollapsingHeader(string label, bool openByDefault = true)

Parameters

label string

openByDefault bool

Returns

bool

Combo(string, ref int, params string[])

public static bool Combo(string label, ref int current, params string[] items)

Parameters

label string

current int

items string[]

Returns

bool

End()

public static void End()

EndTable()

public static void EndTable()

PlotLines(string, ReadOnlySpan<float>, int, string, float, float, Vector2)

public static void PlotLines(string label, ReadOnlySpan<float> values, int offset, string overlay, float min, float max, Vector2 size)

Parameters

label string

values ReadOnlySpan<float>

offset int

overlay string

min float

max float

size Vector2

ProgressBar(float, Vector2, string?)

public static void ProgressBar(float fraction, Vector2 size, string? overlay = null)

Parameters

fraction float

size Vector2

overlay string?

Row()

Starts a row; follow with for each column.

public static void Row()

SameLine()

public static void SameLine()

Separator()

public static void Separator()

SetNextWindow(Vector2, Vector2, ImGuiCond)

public static void SetNextWindow(Vector2 position, Vector2 size, ImGuiCond condition = ImGuiCond.FirstUseEver)

Parameters

position Vector2

size Vector2

condition ImGuiCond

SliderFloat(string, ref float, float, float, string)

public static bool SliderFloat(string label, ref float value, float min, float max, string format = "%.2f")

Parameters

label string

value float

min float

max float

format string

Returns

bool

Spacing()

public static void Spacing()

TableHeader(params string[])

public static void TableHeader(params string[] columns)

Parameters

columns string[]

Text(string)

public static void Text(string text)

Parameters

text string

TextColored(Vector4, string)

Text in a color (red for errors).

public static void TextColored(Vector4 color, string text)

Parameters

color Vector4

text string