EyeAuras Wiki
EN

AI Auras: Overlays

AI-first map of aura overlays and visual output surfaces.

Aura Overlays Discovery Map

Reference map for aura overlay entities: user-configurable visual surfaces owned by aura workflows.

Concept Model

  • Overlays are aura entities focused on presentation.
  • Overlays are registered through IAuraRegistrator.
  • Overlay properties persist configuration.
  • Overlays do not activate auras and do not execute action lists.
  • Retained built-in overlay UI is Blazor-hosted through IBlazorWindow; lower level INativeWindow support is host infrastructure rather than legacy overlay UI by itself.
  • Blazor OSD screen overlay is lower-level drawing, not the same as an aura overlay entity.
  • ImGui windows are optional package UI surfaces.

API Details

  • CsharpScriptOverlay - script overlay entity.
  • AuraOverlayPropertiesBase - common overlay properties base.
  • AuraOverlayContentBase - common overlay content/view-model base.
  • BlazorWindowAuraOverlay - built-in overlay host path for retained Blazor-backed overlay runtime UI.
  • IOnScreenCanvas - lower-level screen annotation canvas.
  • IBlazorWindow - native Blazor-backed window.
  • IImGuiExperimentalApi - optional ImGui SDK entry point.

C# Overlay Context Lifetime

CsharpAuraOverlay and its IWebUIOverlayScriptingApi belong to the aura/window lifetime. The script context borrows them as IWebUIAuraOverlay and IWebUIOverlayScriptingApi. Recompilation and project import replace that context; disposing it must not dispose these borrowed objects or close the overlay window.

Prefer

  • Prefer aura overlay entities when UI is part of aura configuration/lifecycle.
  • Prefer Blazor-hosted overlay views for retained EyeAuras overlay UI.
  • Prefer osd/screen-overlay.md for screen annotations and CV debug boxes.
  • Prefer windows-subsystems/blazor-windows.md for real native windows.
  • Prefer nuget/imgui-sdk.md for ImGui SDK windows.

Avoid

  • Avoid confusing overlays with triggers or actions.
  • Avoid using overlay entity docs for low-level OSD drawing.
  • Avoid treating PoeShared.Blazor.Wpf host infrastructure as removable EyeAuras legacy UI.

Research Anchors

  • CsharpScriptOverlay, AuraOverlayPropertiesBase, AuraOverlayContentBase, BlazorWindowAuraOverlay, IOnScreenCanvas, IBlazorWindow, IImGuiExperimentalApi, ImGuiWindowManager.

Search Synonyms

  • overlay
  • aura overlay
  • script overlay
  • visual overlay
  • Blazor overlay
  • ImGui overlay
  • screen annotation
  • auras/entities.md
  • auras/actions.md
  • auras/triggers.md
  • osd/screen-overlay.md
  • windows-subsystems/blazor-windows.md
  • nuget/imgui-sdk.md