Package dev.twilite.client.ui.overlay

Interface ImGuiOverlayRenderer

All Superinterfaces:
OverlayBinding
public interface ImGuiOverlayRenderer extends OverlayBinding
Optional advanced ImGui overlay renderer for interactive native ImGui widgets.

Implement this on an OverlayBinding annotated with OverlayPanel. The overlay manager creates the native ImGui panel, then calls buildImGuiOverlay(ImGuiOverlay.Panel) every frame. Widget events are routed back through onImGuiOverlayAction(String, String).

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    buildImGuiOverlay(ImGuiOverlay.Panel panel)
    Adds rows and widgets to the native ImGui panel.
    default boolean
    imgui()
    Returns whether annotation-backed panel rows should render through native ImGui.
    default void
    onImGuiOverlayAction(String key, String value)
    Handles an interactive ImGui widget event.

  • Method Details

    • imgui

      default boolean imgui()
      Description copied from interface: OverlayBinding
      Returns whether annotation-backed panel rows should render through native ImGui.

      World geometry overlays still render through Java2D. Override this when an overlay needs to force a renderer. If left inherited, the Overlay plugin config controls the effective default.

      Specified by:
      imgui in interface OverlayBinding

    • buildImGuiOverlay

      void buildImGuiOverlay(ImGuiOverlay.Panel panel)
      Adds rows and widgets to the native ImGui panel.

    • onImGuiOverlayAction

      default void onImGuiOverlayAction(String key, String value)
      Handles an interactive ImGui widget event.
      Parameters:
      key - stable widget key supplied when building the widget
      value - widget value, or "click" for buttons