erik/acdream
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat(ui): Phase D.2a — VitalsPanel wired into GameWindow + backend pivot

Browse source 
Closes Phase D.2a. Launch with ACDREAM_DEVTOOLS=1 now shows a live
ImGui "Vitals" window whose HP bar reads CombatState.GetHealthPercent
for the local player. Without the env var the branches are dead code,
no ImGui context is created, and behaviour is identical to before.

GameWindow hunks:
  - fields: _imguiBootstrap / _panelHost / _vitalsVm + DevToolsEnabled
  - init (OnLoad): construct bootstrap + host, register VitalsPanel
  - GUID push: _vitalsVm?.SetLocalPlayerGuid(chosen.Id) at live-connect
  - frame begin: _imguiBootstrap.BeginFrame(dt) after GL clear
  - frame end: _panelHost.RenderAll(ctx) + _imguiBootstrap.Render() after debug overlay
  - input gating: skip WASD when ImGui.GetIO().WantCaptureKeyboard

Backend pivot: Hexa.NET.ImGui → ImGui.NET + Silk.NET.OpenGL.Extensions.ImGui.

First-light integration with the Hexa backend crashed 0xC0000005 inside
Hexa.NET.ImGui.Backends.OpenGL3.ImGuiImplOpenGL3.InitNative. Root cause:
Hexa's native OpenGL3 backend resolves GL function pointers via GLFW or
SDL internally; with Silk.NET (which uses neither) the pointers are null
and the native code crashes on first use. The mitigation path was
already planned — the design doc's Risk section called a pivot to
ImGui.NET a "one-morning operation" — and that's exactly what happened.

  - Packages: Hexa.NET.ImGui 2.2.9 + Hexa.NET.ImGui.Backends 1.0.18
    → ImGui.NET 1.91.6.1 + Silk.NET.OpenGL.Extensions.ImGui 2.23.0
  - ImGuiBootstrapper: was static Initialize(gl)+Shutdown() wrapping
    Hexa's OpenGL3 init; now an IDisposable wrapping Silk.NET's
    ImGuiController instance which handles GL backend init + input
    subscription in one go.
  - SilkInputBridge.cs deleted (~190 LOC): ImGuiController subscribes
    IKeyboard / IMouse events itself, we don't need a bespoke bridge.
  - ImGuiPanelRenderer: ImGuiNET.ImGui.* calls instead of
    Hexa.NET.ImGui.ImGui.*. Widget surface unchanged.

Boundary discipline is preserved — no panel imports ImGuiNET; only
ImGuiPanelRenderer does. The D.2b custom toolkit will implement the
same IPanelRenderer contract without touching panel code.

Out of scope (tracked for follow-up):
  - Stam/Mana currently return float? null (VitalsVM). Absolute values
    need LocalPlayerState + PlayerDescription (0x0013) parsing to be
    stored rather than discarded — filed as a post-D.2a issue.
  - Mouse-capture gating (WorldMouseFallThrough-style click-through
    tests) — not needed until we add clickable inventory items.

Roadmap + memory + architecture doc + UI framework plan updated in the
same commit per CLAUDE.md roadmap-discipline rules. 753 tests pass
(550 Core + 192 Core.Net + 11 new UI.Abstractions), 0 build warnings.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Erik 2026-04-25 00:43:46 +02:00
parent a7dbce3474
commit 55aaca7a14
13 changed files with 218 additions and 275 deletions
Download patch file Download diff file Expand all files Collapse all files

19
src/AcDream.UI.ImGui/AcDream.UI.ImGui.csproj
View file

@ -7,15 +7,20 @@
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
</PropertyGroup>
<ItemGroup>
<!-- Hexa.NET.ImGui backend — chosen over ImGui.NET + Silk.NET.OpenGL.Extensions.ImGui
for AOT-ready native-lib bundling and closer tracking of upstream cimgui.
See docs/plans/2026-04-24-ui-framework.md §"Choice: Hexa.NET.ImGui". -->
<PackageReference Include="Hexa.NET.ImGui" Version="2.2.9" />
<PackageReference Include="Hexa.NET.ImGui.Backends" Version="1.0.18" />
<!-- SilkInputBridge references Silk.NET.Input types directly so we need
the package even though AcDream.App transitively has it. -->
<!-- Pivoted from Hexa.NET.ImGui to ImGui.NET + Silk.NET.OpenGL.Extensions.ImGui
on 2026-04-25 because Hexa's native OpenGL3 backend does its own GL
function resolution via GLFW / SDL internally; with Silk.NET (no GLFW/SDL)
it crashed in InitNative with 0xC0000005. The Silk.NET extension is
purpose-built for this scenario — it wraps ImGui.NET's backend using
Silk.NET's own GL binding. See docs/plans/2026-04-24-ui-framework.md
"Risk: Hexa.NET.ImGui stops being maintained → mitigation: switch to
ImGui.NET is a one-morning operation." This WAS the one-morning
operation, triggered by a different Hexa issue (GL-loader absence). -->
<PackageReference Include="ImGui.NET" Version="1.91.6.1" />
<PackageReference Include="Silk.NET.OpenGL.Extensions.ImGui" Version="2.23.0" />
<PackageReference Include="Silk.NET.Input" Version="2.23.0" />
<PackageReference Include="Silk.NET.OpenGL" Version="2.23.0" />
<PackageReference Include="Silk.NET.Windowing" Version="2.23.0" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\AcDream.UI.Abstractions\AcDream.UI.Abstractions.csproj" />

96
src/AcDream.UI.ImGui/ImGuiBootstrapper.cs
View file

@ -1,62 +1,64 @@
using Hexa.NET.ImGui;
using Hexa.NET.ImGui.Backends.OpenGL3;
using Silk.NET.Input;
using Silk.NET.OpenGL;
using Silk.NET.OpenGL.Extensions.ImGui;
using Silk.NET.Windowing;
namespace AcDream.UI.ImGui;
/// <summary>
/// One-shot ImGui setup / teardown for the devtools overlay. Called from
/// <c>GameWindow</c> when <c>ACDREAM_DEVTOOLS=1</c>. Hides the cimgui
/// context + OpenGL3 renderer-impl lifecycles behind two static methods
/// so the calling code stays clean.
/// Owns the <c>ImGuiController</c> from <c>Silk.NET.OpenGL.Extensions.ImGui</c>,
/// which handles the whole Silk.NET ↔ ImGui.NET integration:
/// <list type="bullet">
/// <item>Creates the ImGui context + OpenGL3 backend using Silk.NET's GL binding
/// (no GLFW / SDL dependency — unlike Hexa.NET.ImGui, which assumed one).</item>
/// <item>Subscribes to Silk.NET's window + input events to drive IO.</item>
/// <item>Per frame: <c>Update(dt)</c> calls <c>ImGui.NewFrame()</c>; <c>Render()</c>
/// calls <c>ImGui.Render()</c> + uploads draw data via its OpenGL3 backend.</item>
/// </list>
///
/// <para>
/// Intentionally <b>not</b> an <c>IDisposable</c> singleton — the host
/// window owns the one call to <see cref="Shutdown"/> at application
/// exit. Re-initialisation mid-session is not supported.
/// Instance-scoped rather than static so GL-context lifetime is explicit.
/// <c>GameWindow</c> owns the one instance and disposes on shutdown.
/// </para>
///
/// <para>
/// History: tried <c>Hexa.NET.ImGui</c> + <c>Hexa.NET.ImGui.Backends.OpenGL3</c> first
/// per the original plan, but its native OpenGL3 backend resolves GL functions
/// via GLFW / SDL internally and crashed (0xC0000005) in <c>InitNative</c> without
/// one of those present. Pivoted to the official Silk.NET extension on 2026-04-25.
/// </para>
/// </summary>
public static class ImGuiBootstrapper
public sealed class ImGuiBootstrapper : IDisposable
{
private static bool _initialized;
private readonly ImGuiController _controller;
public ImGuiBootstrapper(GL gl, IView window, IInputContext input)
{
ArgumentNullException.ThrowIfNull(gl);
ArgumentNullException.ThrowIfNull(window);
ArgumentNullException.ThrowIfNull(input);
// ImGuiController constructor handles:
// - ImGui.CreateContext()
// - ImGuiOpenGL3 shader + vertex-buffer init (via Silk.NET GL)
// - Keyboard + mouse event subscription (bound to Silk.NET IInputContext)
// - Default style = dark
_controller = new ImGuiController(gl, window, input);
}
/// <summary>
/// Create an ImGui context, apply the dark style + enable keyboard
/// navigation, and bootstrap the OpenGL3 renderer backend. The GL
/// context owned by Silk.NET must be current on the calling thread.
/// Begin an ImGui frame. Call BEFORE any <c>ImGui.*</c> widget calls.
/// Internally: consumes buffered input events, calls <c>ImGui.NewFrame()</c>.
/// </summary>
/// <param name="glslVersion">
/// GLSL version directive for the ImGui-internal shader.
/// <c>"#version 330"</c> matches acdream's existing shaders and is
/// the safest default for the OpenGL 4.3 core profile we ship.
/// </param>
public static void Initialize(string glslVersion = "#version 330")
{
if (_initialized) return;
public void BeginFrame(float deltaSeconds) => _controller.Update(deltaSeconds);
Hexa.NET.ImGui.ImGui.CreateContext();
Hexa.NET.ImGui.ImGui.StyleColorsDark();
/// <summary>
/// Finalise the ImGui frame and draw to the framebuffer. Call AFTER all
/// panel draws, within the same frame as <see cref="BeginFrame"/>. The
/// OpenGL3 backend save/restores the GL state it touches (shader, VAO,
/// texture, blend, scissor); state not in its save-list (e.g.
/// <c>GL_FRAMEBUFFER_SRGB</c>) is caller's responsibility.
/// </summary>
public void Render() => _controller.Render();
var io = Hexa.NET.ImGui.ImGui.GetIO();
io.ConfigFlags |= ImGuiConfigFlags.NavEnableKeyboard;
// DO NOT enable NavEnableGamepad — we don't wire a gamepad backend.
// DO NOT enable DockingEnable / ViewportsEnable — out of scope for D.2a.
ImGuiImplOpenGL3.Init(glslVersion);
_initialized = true;
}
/// <summary>Tear down the OpenGL3 renderer + destroy the ImGui context.</summary>
public static void Shutdown()
{
if (!_initialized) return;
ImGuiImplOpenGL3.Shutdown();
Hexa.NET.ImGui.ImGui.DestroyContext();
_initialized = false;
}
/// <summary>True after <see cref="Initialize"/> has run successfully.</summary>
public static bool IsInitialized => _initialized;
public void Dispose() => _controller.Dispose();
}

21
src/AcDream.UI.ImGui/ImGuiPanelRenderer.cs
View file

@ -1,31 +1,32 @@
using System.Numerics;
using AcDream.UI.Abstractions;
using ImGuiNET;
namespace AcDream.UI.ImGui;
/// <summary>
/// <see cref="IPanelRenderer"/> implemented as thin wrappers around
/// Hexa.NET.ImGui calls. This is the ONLY place where Hexa.NET.ImGui
/// types appear outside of bootstrap / input-bridge plumbing — panels
/// that need a feature must extend the abstraction here, not by importing
/// ImGui in panel files.
/// ImGui.NET calls. This is the ONLY place where ImGuiNET types appear
/// outside of bootstrap plumbing — panels that need a feature must
/// extend the abstraction here, not by importing ImGuiNET in panel
/// files.
/// </summary>
public sealed class ImGuiPanelRenderer : IPanelRenderer
{
/// <inheritdoc />
public bool Begin(string title) => Hexa.NET.ImGui.ImGui.Begin(title);
public bool Begin(string title) => ImGuiNET.ImGui.Begin(title);
/// <inheritdoc />
public void End() => Hexa.NET.ImGui.ImGui.End();
public void End() => ImGuiNET.ImGui.End();
/// <inheritdoc />
public void Text(string text) => Hexa.NET.ImGui.ImGui.TextUnformatted(text);
public void Text(string text) => ImGuiNET.ImGui.TextUnformatted(text);
/// <inheritdoc />
public void SameLine() => Hexa.NET.ImGui.ImGui.SameLine();
public void SameLine() => ImGuiNET.ImGui.SameLine();
/// <inheritdoc />
public void Separator() => Hexa.NET.ImGui.ImGui.Separator();
public void Separator() => ImGuiNET.ImGui.Separator();
/// <inheritdoc />
public void ProgressBar(float fraction, float width, string? overlay = null)
@ -36,6 +37,6 @@ public sealed class ImGuiPanelRenderer : IPanelRenderer
else if (fraction > 1f) fraction = 1f;
var size = new Vector2(width, 0f); // height 0 → ImGui picks based on font
Hexa.NET.ImGui.ImGui.ProgressBar(fraction, size, overlay ?? string.Empty);
ImGuiNET.ImGui.ProgressBar(fraction, size, overlay ?? string.Empty);
}
}

188
src/AcDream.UI.ImGui/SilkInputBridge.cs
View file

@ -1,188 +0,0 @@
using System.Numerics;
using Hexa.NET.ImGui;
using Silk.NET.Input;
namespace AcDream.UI.ImGui;
/// <summary>
/// Forwards Silk.NET keyboard / mouse events to ImGui's IO. Replaces what
/// you'd get from the stock GLFW or SDL backends in a non-Silk.NET host.
///
/// <para>
/// Event-driven (we subscribe to Silk.NET events); does not poll. Each
/// handler writes directly to <c>ImGui.GetIO()</c> via the <c>AddXxx</c>
/// family of calls. Frame-start book-keeping (display size, delta time,
/// active modifier latch) happens in <see cref="BeginFrame"/>.
/// </para>
///
/// <para>
/// Call <see cref="Dispose"/> at app shutdown to unsubscribe from Silk.NET
/// events.
/// </para>
/// </summary>
public sealed class SilkInputBridge : IDisposable
{
private readonly IInputContext _input;
private readonly IKeyboard? _keyboard;
private readonly IMouse? _mouse;
public SilkInputBridge(IInputContext input)
{
_input = input ?? throw new ArgumentNullException(nameof(input));
_keyboard = input.Keyboards.Count > 0 ? input.Keyboards[0] : null;
_mouse = input.Mice.Count > 0 ? input.Mice[0] : null;
if (_keyboard is not null)
{
_keyboard.KeyDown += OnKeyDown;
_keyboard.KeyUp += OnKeyUp;
_keyboard.KeyChar += OnKeyChar;
}
if (_mouse is not null)
{
_mouse.MouseMove += OnMouseMove;
_mouse.MouseDown += OnMouseDown;
_mouse.MouseUp += OnMouseUp;
_mouse.Scroll += OnScroll;
}
}
/// <summary>
/// Per-frame bookkeeping. Call right before <c>ImGui.NewFrame()</c>.
/// Sets display size (in logical pixels) and delta-time on ImGui's IO.
/// </summary>
public void BeginFrame(Vector2 displaySize, float deltaSeconds)
{
var io = Hexa.NET.ImGui.ImGui.GetIO();
io.DisplaySize = displaySize;
io.DeltaTime = deltaSeconds > 0f ? deltaSeconds : 1f / 60f;
}
// ─── event handlers ──────────────────────────────────────────────
private void OnKeyDown(IKeyboard kb, Key key, int scancode) => AddKey(key, down: true);
private void OnKeyUp (IKeyboard kb, Key key, int scancode) => AddKey(key, down: false);
private void OnKeyChar(IKeyboard kb, char c)
{
// Feeds typed text into any focused ImGui TextField. Safe to call
// even when no TextField has focus — ImGui buffers the character
// and discards it if nothing claims it.
Hexa.NET.ImGui.ImGui.GetIO().AddInputCharacter(c);
}
private void OnMouseMove(IMouse m, Vector2 pos)
{
Hexa.NET.ImGui.ImGui.GetIO().AddMousePosEvent(pos.X, pos.Y);
}
private void OnMouseDown(IMouse m, MouseButton button) => AddMouseButton(button, down: true);
private void OnMouseUp (IMouse m, MouseButton button) => AddMouseButton(button, down: false);
private void OnScroll(IMouse m, ScrollWheel wheel)
{
Hexa.NET.ImGui.ImGui.GetIO().AddMouseWheelEvent(wheel.X, wheel.Y);
}
// ─── helpers ─────────────────────────────────────────────────────
private static void AddKey(Key key, bool down)
{
// Update modifier latches first (ImGui reads these when any AddKeyEvent fires).
var io = Hexa.NET.ImGui.ImGui.GetIO();
if (key is Key.ControlLeft or Key.ControlRight) io.AddKeyEvent(ImGuiKey.ModCtrl, down);
if (key is Key.ShiftLeft or Key.ShiftRight) io.AddKeyEvent(ImGuiKey.ModShift, down);
if (key is Key.AltLeft or Key.AltRight) io.AddKeyEvent(ImGuiKey.ModAlt, down);
if (key is Key.SuperLeft or Key.SuperRight) io.AddKeyEvent(ImGuiKey.ModSuper, down);
if (KeyMap.TryGetValue(key, out var imguiKey))
io.AddKeyEvent(imguiKey, down);
// Unmapped keys are silently ignored — fine for D.2a; panels that
// need exotic keys can extend the map.
}
private static void AddMouseButton(MouseButton button, bool down)
{
int idx = button switch
{
MouseButton.Left => 0,
MouseButton.Right => 1,
MouseButton.Middle => 2,
_ => -1,
};
if (idx < 0) return;
Hexa.NET.ImGui.ImGui.GetIO().AddMouseButtonEvent(idx, down);
}
/// <summary>
/// Silk.NET → ImGui key map. Covers text-input + navigation keys +
/// WASD + function keys. Unlisted keys fall through to no-op.
/// </summary>
private static readonly Dictionary<Key, ImGuiKey> KeyMap = new()
{
// Navigation + control
[Key.Tab] = ImGuiKey.Tab,
[Key.Left] = ImGuiKey.LeftArrow,
[Key.Right] = ImGuiKey.RightArrow,
[Key.Up] = ImGuiKey.UpArrow,
[Key.Down] = ImGuiKey.DownArrow,
[Key.PageUp] = ImGuiKey.PageUp,
[Key.PageDown] = ImGuiKey.PageDown,
[Key.Home] = ImGuiKey.Home,
[Key.End] = ImGuiKey.End,
[Key.Insert] = ImGuiKey.Insert,
[Key.Delete] = ImGuiKey.Delete,
[Key.Backspace] = ImGuiKey.Backspace,
[Key.Space] = ImGuiKey.Space,
[Key.Enter] = ImGuiKey.Enter,
[Key.Escape] = ImGuiKey.Escape,
// Modifiers (also add via the mod-flag path, but these let ImGui
// see them as named keys too).
[Key.ControlLeft] = ImGuiKey.LeftCtrl,
[Key.ControlRight] = ImGuiKey.RightCtrl,
[Key.ShiftLeft] = ImGuiKey.LeftShift,
[Key.ShiftRight] = ImGuiKey.RightShift,
[Key.AltLeft] = ImGuiKey.LeftAlt,
[Key.AltRight] = ImGuiKey.RightAlt,
// Letters (Silk.NET.Key.A..Z map 1:1 to ImGuiKey.A..Z).
[Key.A] = ImGuiKey.A, [Key.B] = ImGuiKey.B, [Key.C] = ImGuiKey.C, [Key.D] = ImGuiKey.D,
[Key.E] = ImGuiKey.E, [Key.F] = ImGuiKey.F, [Key.G] = ImGuiKey.G, [Key.H] = ImGuiKey.H,
[Key.I] = ImGuiKey.I, [Key.J] = ImGuiKey.J, [Key.K] = ImGuiKey.K, [Key.L] = ImGuiKey.L,
[Key.M] = ImGuiKey.M, [Key.N] = ImGuiKey.N, [Key.O] = ImGuiKey.O, [Key.P] = ImGuiKey.P,
[Key.Q] = ImGuiKey.Q, [Key.R] = ImGuiKey.R, [Key.S] = ImGuiKey.S, [Key.T] = ImGuiKey.T,
[Key.U] = ImGuiKey.U, [Key.V] = ImGuiKey.V, [Key.W] = ImGuiKey.W, [Key.X] = ImGuiKey.X,
[Key.Y] = ImGuiKey.Y, [Key.Z] = ImGuiKey.Z,
// Digit row
[Key.Number0] = ImGuiKey.Key0, [Key.Number1] = ImGuiKey.Key1, [Key.Number2] = ImGuiKey.Key2,
[Key.Number3] = ImGuiKey.Key3, [Key.Number4] = ImGuiKey.Key4, [Key.Number5] = ImGuiKey.Key5,
[Key.Number6] = ImGuiKey.Key6, [Key.Number7] = ImGuiKey.Key7, [Key.Number8] = ImGuiKey.Key8,
[Key.Number9] = ImGuiKey.Key9,
// Function keys
[Key.F1] = ImGuiKey.F1, [Key.F2] = ImGuiKey.F2, [Key.F3] = ImGuiKey.F3, [Key.F4] = ImGuiKey.F4,
[Key.F5] = ImGuiKey.F5, [Key.F6] = ImGuiKey.F6, [Key.F7] = ImGuiKey.F7, [Key.F8] = ImGuiKey.F8,
[Key.F9] = ImGuiKey.F9, [Key.F10] = ImGuiKey.F10, [Key.F11] = ImGuiKey.F11, [Key.F12] = ImGuiKey.F12,
};
public void Dispose()
{
if (_keyboard is not null)
{
_keyboard.KeyDown -= OnKeyDown;
_keyboard.KeyUp -= OnKeyUp;
_keyboard.KeyChar -= OnKeyChar;
}
if (_mouse is not null)
{
_mouse.MouseMove -= OnMouseMove;
_mouse.MouseDown -= OnMouseDown;
_mouse.MouseUp -= OnMouseUp;
_mouse.Scroll -= OnScroll;
}
}
}