ImGUI

Whitehairt

RunAway ImGUI 文档

Author: TimeUnbound
Date: 2026.04.24

• Begin
  
  • 功能: 开始一个新的 GUI 窗口
  • 用法:
    1. ImGui.Begin("窗口标题")

    复制代码
    
    
  • 返回值: 布尔值，表示窗口是否打开
  • 注意: 必须与
    1. End()

    复制代码
    配对使用
    
  
  
• BeginMenu
  
  • 功能: 开始创建一个子菜单
  • 用法:
    1. ImGui.BeginMenu("菜单名称")

    复制代码
    
    
  • 返回值: 布尔值，表示菜单是否被展开
  • 注意: 必须与
    1. EndMenu()

    复制代码
    配对使用
    
  
  
• BeginMenuBar
  
  • 功能: 开始创建一个菜单栏（通常附加在窗口顶部）
  • 用法:
    1. ImGui.BeginMenuBar()

    复制代码
    
    
  • 返回值: 布尔值，表示菜单栏是否成功创建
  • 注意: 必须与
    1. EndMenuBar()

    复制代码
    配对使用，并且所在窗口需开启 MenuBar 标志
    
  
  
• BeginTabBar
  
  • 功能: 开始标签栏容器
  • 用法:
    1. ImGui.BeginTabBar("标签栏ID")

    复制代码
    
    
  • 返回值: 布尔值，表示标签栏是否成功创建
  • 注意: 必须与
    1. EndTabBar()

    复制代码
    配对使用
    
  
  
• BeginTabItem
  
  • 功能: 开始单个标签页
  • 用法:
    1. ImGui.BeginTabItem("标签页标题")

    复制代码
    
    
  • 返回值: 布尔值，表示标签页是否可见/激活
  • 注意: 必须与
    1. EndTabItem()

    复制代码
    配对使用
    
  
  
• Button
  
  • 功能: 创建可点击的按钮
  • 用法:
    1. ImGui.Button("按钮文本")

    复制代码
    
    
  • 返回值: 布尔值，表示按钮是否被点击
  • 注意: 通常与 if 语句配合使用
    
  
  
• Checkbox
  
  • 功能: 创建复选框控件
  • 用法:
    1. ImGui.Checkbox("标签", settings, "属性名")

    复制代码
    
    
  • 返回值: 布尔值，表示复选框状态是否改变
  • 注意: 当用户勾选/取消勾选时，会自动更新 settings 对象中的对应属性
    
  
  
• ColorEdit3
  
  • 功能: 创建 RGB 颜色编辑器
  • 用法:
    1. ImGui.ColorEdit3("标签", settings, ["r", "g", "b"])

    复制代码
    
    
  • 参数解释: 修改 settings 对象中的 r、g、b 三个属性
    
  
  
• ColorEdit4
  
  • 功能: 创建 RGBA 颜色编辑器（包含透明度 Alpha 通道）
  • 用法:
    1. ImGui.ColorEdit4("标签", settings, ["r", "g", "b", "a"])

    复制代码
    
    
  • 参数解释: 修改 settings 对象中的 r、g、b、a 四个属性
    
  
  
• Combo
  
  • 功能: 创建下拉选择框
  • 用法:
    1. ImGui.Combo("标签", settings, 选项数组, "属性名")

    复制代码
    
    
  • 参数解释: 从选项数组中选择一项，选中索引存储在 settings 的对应属性
    
  
  
• End
  
  • 功能: 结束当前窗口
  • 用法:
    1. ImGui.End()

    复制代码
    
    
  • 注意: 必须与
    1. Begin()

    复制代码
    配对使用，表示窗口内容的结束
    
  
  
• EndMenu
  
  • 功能: 结束子菜单
  • 用法:
    1. ImGui.EndMenu()

    复制代码
    
    
  • 注意: 必须与
    1. BeginMenu()

    复制代码
    配对使用
    
  
  
• EndMenuBar
  
  • 功能: 结束菜单栏
  • 用法:
    1. ImGui.EndMenuBar()

    复制代码
    
    
  • 注意: 必须与
    1. BeginMenuBar()

    复制代码
    配对使用
    
  
  
• EndTabBar
  
  • 功能: 结束标签栏容器
  • 用法:
    1. ImGui.EndTabBar()

    复制代码
    
    
  • 注意: 必须与
    1. BeginTabBar()

    复制代码
    配对使用
    
  
  
• EndTabItem
  
  • 功能: 结束当前标签页
  • 用法:
    1. ImGui.EndTabItem()

    复制代码
    
    
  • 注意: 必须与
    1. BeginTabItem()

    复制代码
    配对使用
    
  
  
• InputInt
  
  • 功能: 创建整数输入框
  • 用法:
    1. ImGui.InputInt("标签", settings, "属性名")

    复制代码
    
    
  • 返回值: 布尔值，表示整数是否被修改
  • 参数解释: 用户在输入框中输入的整数会更新到 settings 对象的对应属性
    
  
  
• InputText
  
  • 功能: 创建文本输入框
  • 用法:
    1. ImGui.InputText("标签", settings, "属性名")

    复制代码
    
    
  • 返回值: 布尔值，表示文本是否被修改
  • 参数解释: 用户在输入框中输入的内容会更新到 settings 对象的对应属性
    
  
  
• MenuItem
  
  • 功能: 创建一个菜单项
  • 用法:
    1. ImGui.MenuItem("菜单项名称")

    复制代码
    
    
  • 返回值: 布尔值，表示该菜单项是否被点击
    
  
  
• SameLine
  
  • 功能: 将下一个控件放在同一行
  • 用法:
    1. ImGui.SameLine()

    复制代码
    
    
  • 注意: 不需要与任何函数配对，只影响下一个控件的布局位置
    
  
  
• SetNextWindowPos
  
  • 功能: 设置下一个即将创建的窗口的位置
  • 用法:
    1. ImGui.SetNextWindowPos(x, y)

    复制代码
    
    
  • 注意: 必须在
    1. Begin()

    复制代码
    之前调用
    
  
  
• SetNextWindowSize
  
  • 功能: 设置下一个即将创建的窗口的尺寸
  • 用法:
    1. ImGui.SetNextWindowSize(width, height)

    复制代码
    
    
  • 注意: 必须在
    1. Begin()

    复制代码
    之前调用
    
  
  
• SetTabItemClosed
  
  • 功能: 在代码逻辑中通知引擎关闭指定的标签页
  • 用法:
    1. ImGui.SetTabItemClosed("标签页标题")

    复制代码
    
    
  
  
• ShowDemoWindow
  
  • 功能: 显示 ImGUI 的官方演示窗口
  • 用法:
    1. ImGui.ShowDemoWindow()

    复制代码
    
    
  
  
• ShowStyleEditor
  
  • 功能: 显示 ImGUI 官方的样式编辑器窗口
  • 用法:
    1. ImGui.ShowStyleEditor()

    复制代码
    
    
  
  
• SliderFloat
  
  • 功能: 创建浮点数滑块
  • 用法:
    1. ImGui.SliderFloat("标签", settings, "属性名", 最小值, 最大值)

    复制代码
    
    
  • 参数解释: 控制浮点数值在指定范围内滑动
    
  
  
• SliderInt
  
  • 功能: 创建整数滑块
  • 用法:
    1. ImGui.SliderInt("标签", settings, "属性名", 最小值, 最大值)

    复制代码
    
    
  • 参数解释: 控制整数值在指定范围内滑动
    
  
  
• StyleColorsClassic
  
  • 功能: 应用 ImGUI 经典样式主题（Classic）
  • 用法:
    1. ImGui.StyleColorsClassic()

    复制代码
    
    
  
  
• StyleColorsDark
  
  • 功能: 应用 ImGUI 深色样式主题（Dark - 默认）
  • 用法:
    1. ImGui.StyleColorsDark()

    复制代码
    
    
  
  
• StyleColorsLight
  
  • 功能: 应用 ImGUI 浅色样式主题（Light）
  • 用法:
    1. ImGui.StyleColorsLight()

    复制代码
    
    
  
  
• Text
  
  • 功能: 显示普通文本内容
  • 用法:
    1. ImGui.Text("要显示的文本")

    复制代码
    
    
  • 注意: 这是最简单的显示函数，只用于输出文本