Skip to main content

Table: rom.gui

Functions (5)​

add_to_menu_bar(imgui_rendering)​

Registers a function that will be called under your dedicated space in the imgui main menu bar. Example Usage:

rom.gui.add_to_menu_bar(function()
   if ImGui.BeginMenu("Ayo") then
       if ImGui.Button("Label") then
         log.info("hi")
       end
       ImGui.EndMenu()
   end
end)
  • Parameters:
    • imgui_rendering (function): Function that will be called under your dedicated space in the imgui main menu bar.

Example Usage:

rom.gui.add_to_menu_bar(imgui_rendering)

add_always_draw_imgui(imgui_rendering)​

Registers a function that will be called every rendering frame, regardless of the gui is in its open state. You can call ImGui functions in it, please check the ImGui.md documentation file for more info. Example Usage:

rom.gui.add_always_draw_imgui(function()
   if ImGui.Begin("My Custom Window") then
       if ImGui.Button("Label") then
         log.info("hi")
       end

   end
   ImGui.End()
end)
  • Parameters:
    • imgui_rendering (function): Function that will be called every rendering frame, regardless of the gui is in its open state. You can call ImGui functions in it, please check the ImGui.md documentation file for more info.

Example Usage:

rom.gui.add_always_draw_imgui(imgui_rendering)

add_imgui(imgui_rendering)​

Registers a function that will be called every rendering frame, only if the gui is in its open state. You can call ImGui functions in it, please check the ImGui.md documentation file for more info. Example Usage:

rom.gui.add_imgui(function()
   if ImGui.Begin("My Custom Window") then
       if ImGui.Button("Label") then
         log.info("hi")
       end

   end
   ImGui.End()
end)
  • Parameters:
    • imgui_rendering (function): Function that will be called every rendering frame, only if the gui is in its open state. You can call ImGui functions in it, please check the ImGui.md documentation file for more info.

Example Usage:

rom.gui.add_imgui(imgui_rendering)

is_open()​

  • Returns:
    • bool: Returns true if the GUI is open.

Example Usage:

bool = rom.gui.is_open()

toggle()​

Opens or closes the GUI.

Example Usage:

rom.gui.toggle()