API 参考
正在准备搜索索引…

ImGui.ImGuiIOFields

上下文配置与实时输入输出状态;输出由原生代码更新。

interface ImGuiIOFields {
    AppAcceptingEvents: boolean;
    AppFocusLost: boolean;
    BackendFlags: number;
    ConfigDebugBeginReturnValueLoop: boolean;
    ConfigDebugBeginReturnValueOnce: boolean;
    ConfigDebugHighlightIdConflicts: boolean;
    ConfigDebugHighlightIdConflictsShowItemPicker: boolean;
    ConfigDebugIgnoreFocusLoss: boolean;
    ConfigDebugIniSettings: boolean;
    ConfigDebugIsDebuggerPresent: boolean;
    ConfigDragClickToInputText: boolean;
    ConfigErrorRecovery: boolean;
    ConfigErrorRecoveryEnableAssert: boolean;
    ConfigErrorRecoveryEnableDebugLog: boolean;
    ConfigErrorRecoveryEnableTooltip: boolean;
    ConfigFlags: number;
    ConfigInputTextCursorBlink: boolean;
    ConfigInputTextEnterKeepActive: boolean;
    ConfigInputTrickleEventQueue: boolean;
    ConfigMacOSXBehaviors: boolean;
    ConfigMemoryCompactTimer: number;
    ConfigNavCaptureKeyboard: boolean;
    ConfigNavCursorVisibleAlways: boolean;
    ConfigNavCursorVisibleAuto: boolean;
    ConfigNavEscapeClearFocusItem: boolean;
    ConfigNavEscapeClearFocusWindow: boolean;
    ConfigNavMoveSetMousePos: boolean;
    ConfigNavSwapGamepadButtons: boolean;
    ConfigScrollbarScrollByPage: boolean;
    ConfigWindowsCopyContentsWithCtrlC: boolean;
    ConfigWindowsMoveFromTitleBarOnly: boolean;
    ConfigWindowsResizeFromEdges: boolean;
    DeltaTime: number;
    DisplayFramebufferScaleX: number;
    DisplayFramebufferScaleY: number;
    DisplaySizeX: number;
    DisplaySizeY: number;
    FontAllowUserScaling: boolean;
    FontGlobalScale: number;
    Framerate: number;
    IniSavingRate: number;
    InputQueueSurrogate: number;
    KeyAlt: boolean;
    KeyCtrl: boolean;
    KeyMods: number;
    KeyRepeatDelay: number;
    KeyRepeatRate: number;
    KeyShift: boolean;
    KeySuper: boolean;
    MetricsActiveWindows: number;
    MetricsRenderIndices: number;
    MetricsRenderVertices: number;
    MetricsRenderWindows: number;
    MouseClicked0: boolean;
    MouseClicked1: boolean;
    MouseClicked2: boolean;
    MouseClicked3: boolean;
    MouseClicked4: boolean;
    MouseClickedCount0: number;
    MouseClickedCount1: number;
    MouseClickedCount2: number;
    MouseClickedCount3: number;
    MouseClickedCount4: number;
    MouseClickedLastCount0: number;
    MouseClickedLastCount1: number;
    MouseClickedLastCount2: number;
    MouseClickedLastCount3: number;
    MouseClickedLastCount4: number;
    MouseClickedTime0: number;
    MouseClickedTime1: number;
    MouseClickedTime2: number;
    MouseClickedTime3: number;
    MouseClickedTime4: number;
    MouseCtrlLeftAsRightClick: boolean;
    MouseDeltaX: number;
    MouseDeltaY: number;
    MouseDoubleClicked0: boolean;
    MouseDoubleClicked1: boolean;
    MouseDoubleClicked2: boolean;
    MouseDoubleClicked3: boolean;
    MouseDoubleClicked4: boolean;
    MouseDoubleClickMaxDist: number;
    MouseDoubleClickTime: number;
    MouseDown0: boolean;
    MouseDown1: boolean;
    MouseDown2: boolean;
    MouseDown3: boolean;
    MouseDown4: boolean;
    MouseDownDuration0: number;
    MouseDownDuration1: number;
    MouseDownDuration2: number;
    MouseDownDuration3: number;
    MouseDownDuration4: number;
    MouseDownDurationPrev0: number;
    MouseDownDurationPrev1: number;
    MouseDownDurationPrev2: number;
    MouseDownDurationPrev3: number;
    MouseDownDurationPrev4: number;
    MouseDownOwned0: boolean;
    MouseDownOwned1: boolean;
    MouseDownOwned2: boolean;
    MouseDownOwned3: boolean;
    MouseDownOwned4: boolean;
    MouseDownOwnedUnlessPopupClose0: boolean;
    MouseDownOwnedUnlessPopupClose1: boolean;
    MouseDownOwnedUnlessPopupClose2: boolean;
    MouseDownOwnedUnlessPopupClose3: boolean;
    MouseDownOwnedUnlessPopupClose4: boolean;
    MouseDragMaxDistanceSqr0: number;
    MouseDragMaxDistanceSqr1: number;
    MouseDragMaxDistanceSqr2: number;
    MouseDragMaxDistanceSqr3: number;
    MouseDragMaxDistanceSqr4: number;
    MouseDragThreshold: number;
    MouseDrawCursor: boolean;
    MousePosPrevX: number;
    MousePosPrevY: number;
    MousePosX: number;
    MousePosY: number;
    MouseReleased0: boolean;
    MouseReleased1: boolean;
    MouseReleased2: boolean;
    MouseReleased3: boolean;
    MouseReleased4: boolean;
    MouseReleasedTime0: number;
    MouseReleasedTime1: number;
    MouseReleasedTime2: number;
    MouseReleasedTime3: number;
    MouseReleasedTime4: number;
    MouseSource: number;
    MouseWheel: number;
    MouseWheelH: number;
    MouseWheelRequestAxisSwap: boolean;
    NavActive: boolean;
    NavVisible: boolean;
    PenPressure: number;
    WantCaptureKeyboard: boolean;
    WantCaptureMouse: boolean;
    WantCaptureMouseUnlessPopupClose: boolean;
    WantSaveIniSettings: boolean;
    WantSetMousePos: boolean;
    WantTextInput: boolean;
}
源码与继承
成员目录142

属性

属性

AppAcceptingEvents: boolean

是否接受输入事件的开关;通过 IO_SetAppAcceptingEvents() 修改。

源码与继承
AppFocusLost: boolean

应用失焦状态;应通过 IO_AddFocusEvent() 更新,不应直接修改。

源码与继承
BackendFlags: number

声明后端实际支持能力的 ImGuiBackendFlags。

源码与继承
ConfigDebugBeginReturnValueLoop: boolean

按窗口深度循环让 Begin/BeginChild 返回 false,用于测试。

源码与继承
ConfigDebugBeginReturnValueOnce: boolean

让首次 Begin/BeginChild 返回 false,以测试配对 End 调用。

源码与继承
ConfigDebugHighlightIdConflicts: boolean

高亮重复的项目 ID 并显示错误弹窗。

源码与继承
ConfigDebugHighlightIdConflictsShowItemPicker: boolean

在 ID 冲突弹窗中显示项目拾取器按钮。

源码与继承
ConfigDebugIgnoreFocusLoss: boolean

调试时忽略失焦事件,不因此清空输入状态。

源码与继承
ConfigDebugIniSettings: boolean

保存 .ini 设置时添加诊断注释,会增加保存开销。

源码与继承
ConfigDebugIsDebuggerPresent: boolean

仅在已附加原生调试器时启用断点工具。

源码与继承
ConfigDragClickToInputText: boolean

点击后松开且未拖动时,将 Drag 控件切换为文本输入。

源码与继承
ConfigErrorRecovery: boolean

对支持检测的 API 误用尝试恢复;不保证避免崩溃。

源码与继承
ConfigErrorRecoveryEnableAssert: boolean

在可恢复错误发生时触发原生断言。

源码与继承
ConfigErrorRecoveryEnableDebugLog: boolean

将可恢复错误写入 ImGui 调试日志。

源码与继承
ConfigErrorRecoveryEnableTooltip: boolean

用提示框显示可恢复错误;至少保留一种错误报告方式。

源码与继承
ConfigFlags: number

应用设置的 ImGuiConfigFlags,包括键盘和手柄导航。

源码与继承
ConfigInputTextCursorBlink: boolean

启用文本编辑光标闪烁。

源码与继承
ConfigInputTextEnterKeepActive: boolean

按 Enter 后保持单行文本输入活跃并选中其内容。

源码与继承
ConfigInputTrickleEventQueue: boolean

将队列中冲突的输入分散到多帧,避免丢失短暂点击。

源码与继承
ConfigMacOSXBehaviors: boolean

使用 macOS 编辑、快捷键与选择习惯,包括以 Cmd 代替 Ctrl。

源码与继承
ConfigMemoryCompactTimer: number

释放未使用窗口或表格缓冲区前的秒数;-1 禁用回收。

源码与继承
ConfigNavCaptureKeyboard: boolean

键盘或手柄导航活跃时设置 WantCaptureKeyboard。

源码与继承
ConfigNavCursorVisibleAlways: boolean

无论是否使用鼠标,都保持导航光标可见。

源码与继承
ConfigNavCursorVisibleAuto: boolean

方向导航输入时显示导航光标,鼠标点击时隐藏。

源码与继承
ConfigNavEscapeClearFocusItem: boolean

允许 Escape 清除项目焦点及其导航高亮。

源码与继承
ConfigNavEscapeClearFocusWindow: boolean

允许 Escape 同时清除窗口和项目焦点。

源码与继承
ConfigNavMoveSetMousePos: boolean

允许导航修改 MousePos 并通过 WantSetMousePos 请求移动系统光标。

源码与继承
ConfigNavSwapGamepadButtons: boolean

交换手柄的确认与取消按钮,采用任天堂式布局。

源码与继承
ConfigScrollbarScrollByPage: boolean

点击滚动滑块外部时按页滚动;Shift+点击仍直接定位。

源码与继承
ConfigWindowsCopyContentsWithCtrlC: boolean

实验性功能:Ctrl+C 按提交顺序复制焦点窗口中的文字。

源码与继承
ConfigWindowsMoveFromTitleBarOnly: boolean

仅允许拖动标题栏来移动窗口;无标题栏窗口除外。

源码与继承
ConfigWindowsResizeFromEdges: boolean

允许从边缘和左下角调整窗口大小;需要后端光标支持。

源码与继承
DeltaTime: number

距上一帧经过的秒数,必须为正。

源码与继承
DisplayFramebufferScaleX: number

每显示像素对应的水平帧缓冲像素数,通常为一或二。

源码与继承
DisplayFramebufferScaleY: number

每显示像素对应的垂直帧缓冲像素数,通常为一或二。

源码与继承
DisplaySizeX: number

主显示区域宽度,单位为应用帧缓冲缩放前的显示像素。

源码与继承
DisplaySizeY: number

主显示区域高度,单位为应用帧缓冲缩放前的显示像素。

源码与继承
FontAllowUserScaling: boolean

已过时的选项,允许 Ctrl+滚轮缩放单个窗口的文字。

源码与继承
FontGlobalScale: number

全局字体大小倍率;不会重建字体图集。

源码与继承
Framerate: number

根据最近 60 帧 DeltaTime 滚动平均值估算的每秒帧数。

源码与继承
IniSavingRate: number

自动保存 .ini 设置的最短间隔,单位为秒。

源码与继承
InputQueueSurrogate: number

IO_AddInputCharacterUTF16() 暂存的 UTF-16 高代理项;无则为零。

源码与继承
KeyAlt: boolean

当前是否按住 Alt 修饰键。

源码与继承
KeyCtrl: boolean

当前是否按住 Control 修饰键。

源码与继承
KeyMods: number

NewFrame() 合并的 ImGuiMod 位掩码;应视为只读派生状态。

源码与继承
KeyRepeatDelay: number

按键或可重复按钮开始连发前的初始等待秒数。

源码与继承
KeyRepeatRate: number

按键或按钮连发的间隔,单位为秒。

源码与继承
KeyShift: boolean

当前是否按住 Shift 修饰键。

源码与继承
KeySuper: boolean

当前是否按住 Cmd/Super/Windows 修饰键。

源码与继承
MetricsActiveWindows: number

活跃窗口数量,包括活跃但不可见的窗口。

源码与继承
MetricsRenderIndices: number

上一次 Render() 输出的索引数,每个三角形三个。

源码与继承
MetricsRenderVertices: number

上一次 Render() 输出的顶点数。

源码与继承
MetricsRenderWindows: number

已渲染的可见窗口数量。

源码与继承
MouseClicked0: boolean

按钮 0 本帧从松开变为按下。

源码与继承
MouseClicked1: boolean

按钮 1 本帧从松开变为按下。

源码与继承
MouseClicked2: boolean

按钮 2 本帧从松开变为按下。

源码与继承
MouseClicked3: boolean

按钮 3 本帧从松开变为按下。

源码与继承
MouseClicked4: boolean

按钮 4 本帧从松开变为按下。

源码与继承
MouseClickedCount0: number

按钮 0 本帧连续点击次数;无新点击时为零。

源码与继承
MouseClickedCount1: number

按钮 1 本帧连续点击次数;无新点击时为零。

源码与继承
MouseClickedCount2: number

按钮 2 本帧连续点击次数;无新点击时为零。

源码与继承
MouseClickedCount3: number

按钮 3 本帧连续点击次数;无新点击时为零。

源码与继承
MouseClickedCount4: number

按钮 4 本帧连续点击次数;无新点击时为零。

源码与继承
MouseClickedLastCount0: number

按钮 0 最近一次连续点击次数,松开后仍保留。

源码与继承
MouseClickedLastCount1: number

按钮 1 最近一次连续点击次数,松开后仍保留。

源码与继承
MouseClickedLastCount2: number

按钮 2 最近一次连续点击次数,松开后仍保留。

源码与继承
MouseClickedLastCount3: number

按钮 3 最近一次连续点击次数,松开后仍保留。

源码与继承
MouseClickedLastCount4: number

按钮 4 最近一次连续点击次数,松开后仍保留。

源码与继承
MouseClickedTime0: number

按钮 0 上次点击的上下文时间,单位秒,用于检测多击。

源码与继承
MouseClickedTime1: number

按钮 1 上次点击的上下文时间,单位秒,用于检测多击。

源码与继承
MouseClickedTime2: number

按钮 2 上次点击的上下文时间,单位秒,用于检测多击。

源码与继承
MouseClickedTime3: number

按钮 3 上次点击的上下文时间,单位秒,用于检测多击。

源码与继承
MouseClickedTime4: number

按钮 4 上次点击的上下文时间,单位秒,用于检测多击。

源码与继承
MouseCtrlLeftAsRightClick: boolean

当前 macOS Ctrl+左键点击正被模拟为右键点击。

源码与继承
MouseDeltaX: number

鼠标水平移动像素数;前后位置任一无效时为零。

源码与继承
MouseDeltaY: number

鼠标垂直移动像素数;前后位置任一无效时为零。

源码与继承
MouseDoubleClicked0: boolean

按钮 0 本帧双击;MouseClickedCount0 等于二。

源码与继承
MouseDoubleClicked1: boolean

按钮 1 本帧双击;MouseClickedCount1 等于二。

源码与继承
MouseDoubleClicked2: boolean

按钮 2 本帧双击;MouseClickedCount2 等于二。

源码与继承
MouseDoubleClicked3: boolean

按钮 3 本帧双击;MouseClickedCount3 等于二。

源码与继承
MouseDoubleClicked4: boolean

按钮 4 本帧双击;MouseClickedCount4 等于二。

源码与继承
MouseDoubleClickMaxDist: number

双击序列中点击位置之间的最大像素距离。

源码与继承
MouseDoubleClickTime: number

连续点击构成双击的最大间隔,单位为秒。

源码与继承
MouseDown0: boolean

鼠标左键(按钮 0)当前是否按下。

源码与继承
MouseDown1: boolean

鼠标右键(按钮 1)当前是否按下。

源码与继承
MouseDown2: boolean

鼠标中键(按钮 2)当前是否按下。

源码与继承
MouseDown3: boolean

鼠标第一个扩展键(按钮 3)当前是否按下。

源码与继承
MouseDown4: boolean

鼠标第二个扩展键(按钮 4)当前是否按下。

源码与继承
MouseDownDuration0: number

按钮 0 按住秒数;-1 表示松开,零表示刚按下。

源码与继承
MouseDownDuration1: number

按钮 1 按住秒数;-1 表示松开,零表示刚按下。

源码与继承
MouseDownDuration2: number

按钮 2 按住秒数;-1 表示松开,零表示刚按下。

源码与继承
MouseDownDuration3: number

按钮 3 按住秒数;-1 表示松开,零表示刚按下。

源码与继承
MouseDownDuration4: number

按钮 4 按住秒数;-1 表示松开,零表示刚按下。

源码与继承
MouseDownDurationPrev0: number

上一帧按钮 0 按住的秒数;-1 表示当时已松开。

源码与继承
MouseDownDurationPrev1: number

上一帧按钮 1 按住的秒数;-1 表示当时已松开。

源码与继承
MouseDownDurationPrev2: number

上一帧按钮 2 按住的秒数;-1 表示当时已松开。

源码与继承
MouseDownDurationPrev3: number

上一帧按钮 3 按住的秒数;-1 表示当时已松开。

源码与继承
MouseDownDurationPrev4: number

上一帧按钮 4 按住的秒数;-1 表示当时已松开。

源码与继承
MouseDownOwned0: boolean

按钮 0 的按下始于 ImGui 窗口内或被弹窗阻挡的空白处。

源码与继承
MouseDownOwned1: boolean

按钮 1 的按下始于 ImGui 窗口内或被弹窗阻挡的空白处。

源码与继承
MouseDownOwned2: boolean

按钮 2 的按下始于 ImGui 窗口内或被弹窗阻挡的空白处。

源码与继承
MouseDownOwned3: boolean

按钮 3 的按下始于 ImGui 窗口内或被弹窗阻挡的空白处。

源码与继承
MouseDownOwned4: boolean

按钮 4 的按下始于 ImGui 窗口内或被弹窗阻挡的空白处。

源码与继承
MouseDownOwnedUnlessPopupClose0: boolean

按钮 0 的按下属于 ImGui,但排除普通的弹窗关闭点击。

源码与继承
MouseDownOwnedUnlessPopupClose1: boolean

按钮 1 的按下属于 ImGui,但排除普通的弹窗关闭点击。

源码与继承
MouseDownOwnedUnlessPopupClose2: boolean

按钮 2 的按下属于 ImGui,但排除普通的弹窗关闭点击。

源码与继承
MouseDownOwnedUnlessPopupClose3: boolean

按钮 3 的按下属于 ImGui,但排除普通的弹窗关闭点击。

源码与继承
MouseDownOwnedUnlessPopupClose4: boolean

按钮 4 的按下属于 ImGui,但排除普通的弹窗关闭点击。

源码与继承
MouseDragMaxDistanceSqr0: number

按住按钮 0 期间,相对其点击起点的最大像素距离平方。

源码与继承
MouseDragMaxDistanceSqr1: number

按住按钮 1 期间,相对其点击起点的最大像素距离平方。

源码与继承
MouseDragMaxDistanceSqr2: number

按住按钮 2 期间,相对其点击起点的最大像素距离平方。

源码与继承
MouseDragMaxDistanceSqr3: number

按住按钮 3 期间,相对其点击起点的最大像素距离平方。

源码与继承
MouseDragMaxDistanceSqr4: number

按住按钮 4 期间,相对其点击起点的最大像素距离平方。

源码与继承
MouseDragThreshold: number

按住鼠标后被视为拖动所需的移动像素距离。

源码与继承
MouseDrawCursor: boolean

请求 ImGui 绘制软件鼠标光标。

源码与继承
MousePosPrevX: number

上一次鼠标 X 显示像素坐标;-3.4028234663852886e38 表示位置不可用。

源码与继承
MousePosPrevY: number

上一次鼠标 Y 显示像素坐标;-3.4028234663852886e38 表示位置不可用。

源码与继承
MousePosX: number

鼠标显示坐标 X,单位为像素;-3.4028234663852886e38 表示位置不可用。

源码与继承
MousePosY: number

鼠标显示坐标 Y,单位为像素;-3.4028234663852886e38 表示位置不可用。

源码与继承
MouseReleased0: boolean

按钮 0 本帧从按下变为松开。

源码与继承
MouseReleased1: boolean

按钮 1 本帧从按下变为松开。

源码与继承
MouseReleased2: boolean

按钮 2 本帧从按下变为松开。

源码与继承
MouseReleased3: boolean

按钮 3 本帧从按下变为松开。

源码与继承
MouseReleased4: boolean

按钮 4 本帧从按下变为松开。

源码与继承
MouseReleasedTime0: number

按钮 0 上次松开的 ImGui 上下文时钟时间,单位秒。

源码与继承
MouseReleasedTime1: number

按钮 1 上次松开的 ImGui 上下文时钟时间,单位秒。

源码与继承
MouseReleasedTime2: number

按钮 2 上次松开的 ImGui 上下文时钟时间,单位秒。

源码与继承
MouseReleasedTime3: number

按钮 3 上次松开的 ImGui 上下文时钟时间,单位秒。

源码与继承
MouseReleasedTime4: number

按钮 4 上次松开的 ImGui 上下文时钟时间,单位秒。

源码与继承
MouseSource: number

标识鼠标、触摸屏或笔输入的 ImGuiMouseSource。

源码与继承
MouseWheel: number

本帧垂直滚轮增量;正值向上,每单位约五行。

源码与继承
MouseWheelH: number

本帧水平滚轮增量;正值向左,负值向右。

源码与继承
MouseWheelRequestAxisSwap: boolean

非 macOS 系统上,Shift 请求将垂直滚轮转换为水平滚轮。

源码与继承
NavActive: boolean

当前焦点窗口接受键盘或手柄导航。

源码与继承
NavVisible: boolean

键盘或手柄导航可用,且导航高亮可见。

源码与继承
PenPressure: number

零到一的触摸或笔压力;目前 ImGui 自身不使用。

源码与继承
WantCaptureKeyboard: boolean

为真时不向应用传递键盘输入;仍须始终传给 ImGui。

源码与继承
WantCaptureMouse: boolean

为真时不向应用传递鼠标输入;无论真假都仍须传给 ImGui。

源码与继承
WantCaptureMouseUnlessPopupClose: boolean

鼠标捕获状态,但排除仅用于关闭弹窗的空白处点击。

源码与继承
WantSaveIniSettings: boolean

请求手动保存 .ini;保存设置后须清除此标志。

源码与继承
WantSetMousePos: boolean

请求后端将系统光标移动到导航更新后的 MousePos。

源码与继承
WantTextInput: boolean

请求文本输入,例如显示屏幕键盘。

源码与继承

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0