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

sfml.js-imgui · 概览

窗口初始化、事件传递与帧渲染。 控件、原生句柄、回调与共享状态。 字体图集、字形范围与样式颜色。

SFML

窗口初始化、事件传递与帧渲染。

全部 API14
SFML
GetIO

返回 ImGuiIO 的实时可写视图。

GetStyle

返回 ImGuiStyle 的实时可写视图。

ImGuiIOView

直接映射原生内存的 ImGuiIO 实时可写视图。

ImGuiStyleView

直接映射原生内存的 ImGuiStyle 实时可写视图。

Init

为窗口初始化 ImGui 与 imgui-sfml 后端。

IsInitialized

返回窗口是否已初始化 ImGui。

ProcessEvent

把 sfml.js 窗口事件转交给 ImGui。

Render

提交 sfml.js 已录制的绘制,并在窗口上绘制 ImGui。

SetCurrentWindow

把窗口切换为当前 ImGui 上下文。

Shutdown

关闭窗口的 ImGui 上下文;未初始化时为空操作。

Update

更新 ImGui 帧状态并开始新帧。

UpdateFontTexture

重新构建 ImGui 字体纹理;修改字体后调用。

Version

Dear ImGui 版本号。

ImGui

控件、原生句柄、回调与共享状态。

全部 API835
ImGui
AcceptDragDropPayload

接受指定类型的内容。

AddCallbackEx

向 DrawList 追加一个 JavaScript 绘制回调。

AlignTextToFramePadding

将后续文本基线与带边框控件对齐。

ArrowButton

显示带箭头的方形按钮。

Begin

开始窗口或向窗口追加内容。

BeginChild

开始具有独立滚动和裁剪区域的子窗口。

BeginChildFrame

开始带框架样式的子窗口。

BeginChildFrameEx

使用旧版辅助函数开始一个带框控件样式的子窗口。

BeginChildID

在当前窗口内开始一个由数值 ID 标识的子窗口。

BeginCombo

开始用于自定义条目的组合框弹出区域。

BeginDisabled

开始可禁用用户交互的作用域。

BeginDragDropSource

开始拖放源。

BeginDragDropTarget

为前一个条目开始拖放目标。

BeginGroup

开始具有固定水平起始位置的分组。

BeginItemTooltip

鼠标悬停于前一个条目时开始工具提示。

BeginListBox

开始带边框、可滚动的列表框区域。

BeginMainMenuBar

开始屏幕顶部的菜单栏。

BeginMenu

显示启用的子菜单入口,并在展开时开始添加其内容。

BeginMenuBar

开始向当前窗口菜单栏追加内容。

BeginMenuEx

显示子菜单项,并在打开时开始其内容区域。

BeginMultiSelect

开始多选作用域。

BeginMultiSelectEx

开始用于多项选择和范围选择交互的作用域。

BeginPopup

开始向已打开的弹出窗口追加内容。

BeginPopupContextItem

为前一个条目打开并开始上下文弹出窗口。

BeginPopupContextItemEx

为前一个条目打开并开始上下文弹出窗口。

BeginPopupContextVoid

在所有窗口之外释放鼠标右键时打开并开始上下文弹出菜单。

BeginPopupContextVoidEx

在所有窗口之外打开并开始上下文弹出窗口。

BeginPopupContextWindow

在当前窗口上释放鼠标右键时打开并开始上下文弹出菜单。

BeginPopupContextWindowEx

为当前窗口打开并开始上下文弹出窗口。

BeginPopupModal

开始向已打开的模态弹出窗口追加内容。

BeginTabBar

开始标签栏。

BeginTabItem

开始标签项并报告是否被选中。

BeginTable

开始表格。

BeginTableEx

开始用于添加行列内容的表格布局。

BeginTooltip

开始工具提示窗口。

Bullet

绘制项目符号,并让后续内容保持在同一行。

BulletText

绘制项目符号与格式化文本。

BulletTextUnformatted

显示带项目符号的文本。

Button

显示按钮并报告是否被按下。

ButtonEx

显示按钮并报告是否被按下。

CalcItemWidth

根据当前设置和光标位置计算条目宽度。

CalcTextSize

计算文本尺寸。

CalcTextSizeEx

使用当前字体测量文本,可选择换行及隐藏 ID 后缀。

Checkbox

显示用于编辑布尔值的复选框。

CheckboxFlagsIntPtr

显示复选框,设置或清除整数标志值中的一组位。

CheckboxFlagsUintPtr

显示复选框,设置或清除整数标志值中的一组位。

CloseCurrentPopup

关闭当前弹出窗口。

CollapsingHeader

显示折叠标题并报告是否展开。

CollapsingHeaderBoolPtr

显示可关闭的折叠标题。

ColorButton

显示可点击的色块,悬停时可查看颜色详情。

ColorButtonEx

显示颜色样本按钮。

ColorConvertFloat4ToU32

将浮点 RGBA 分量打包为 32 位颜色,不应用样式透明度。

ColorConvertHSVtoRGB

将颜色从色相、饱和度和明度转换为 RGB 分量。

ColorConvertRGBtoHSV

将颜色从 RGB 分量转换为色相、饱和度和明度。

ColorConvertU32ToFloat4

将打包的 32 位颜色转换为四个浮点分量。

ColorEdit3

编辑 RGB 颜色。

ColorEdit4

显示用于编辑颜色及其透明度分量的紧凑控件。

ColorPicker3

显示不含透明度的三分量颜色选择器。

ColorPicker4

显示用于选择颜色及其透明度分量的可视化选择器。

Columns

配置旧式分栏布局。

ColumnsEx

设置旧式分栏布局,或通过切回单列结束分栏。

Combo

使用零字符分隔的标签列表显示下拉选择框。

ComboCallbackEx

带 JavaScript 取值回调的 Combo。

ComboChar

使用标签数组显示下拉选择框。

ComboCharEx

使用标签数组显示下拉选择框。

ComboEx

使用空字符分隔的条目显示组合框。

createFontGlyphRangesBuilder

创建字形范围构建器。

createListClipper

创建列表裁剪器。

createSelectionBasicStorage

创建选中集合。

createTextBuffer

创建 ImGuiTextBuffer。

createTextFilter

创建文本过滤器。

DebugCheckVersionAndDataLayout

检查编译版本和数据结构布局。

DebugFlashStyleColor

短暂闪烁样式颜色,以显示界面中使用该颜色的位置。

DebugLog

向调试日志写入格式化文本。

DebugLogUnformatted

向调试日志追加文本。

DebugStartItemPicker

启动可视化控件选择器,以便在调试器中断到选中的控件。

DebugTextEncoding

显示文本编码的调试信息。

DragFloat

通过拖动编辑浮点数值。

DragFloat2

使用拖动控件编辑 2 个浮点分量。

DragFloat2Ex

使用拖动控件编辑 2 个浮点分量。

DragFloat3

使用拖动控件编辑 3 个浮点分量。

DragFloat3Ex

使用拖动控件编辑 3 个浮点分量。

DragFloat4

使用拖动控件编辑 4 个浮点分量。

DragFloat4Ex

使用拖动控件编辑 4 个浮点分量。

DragFloatEx

通过拖动编辑数值。

DragFloatRange2

使用一对拖动控件编辑浮点范围的下限和上限。

DragFloatRange2Ex

使用一对拖动控件编辑浮点范围的下限和上限。

DragInt

使用拖动控件编辑整数值。

DragInt2

使用拖动控件编辑 2 个整数分量。

DragInt2Ex

使用拖动控件编辑 2 个整数分量。

DragInt3

使用拖动控件编辑 3 个整数分量。

DragInt3Ex

使用拖动控件编辑 3 个整数分量。

DragInt4

使用拖动控件编辑 4 个整数分量。

DragInt4Ex

使用拖动控件编辑 4 个整数分量。

DragIntEx

通过拖动编辑数值。

DragIntRange2

使用一对拖动控件编辑整数范围的下限和上限。

DragIntRange2Ex

使用一对拖动控件编辑整数范围的下限和上限。

DragScalar

使用拖动控件编辑指定数据类型的单个数值。

DragScalarEx

使用拖动控件编辑指定数据类型的单个数值。

DragScalarN

使用拖动控件编辑指定数据类型的多个数值分量。

DragScalarNEx

使用拖动控件编辑指定数据类型的多个数值分量。

DrawCallback

DrawList 的自定义绘制回调。

Dummy

添加指定尺寸的占位项目。

End

结束 Begin 打开的窗口作用域,并恢复先前的当前窗口。

EndChild

结束 BeginChild 打开的子窗口作用域,继续向父窗口添加内容。

EndChildFrame

结束旧版 BeginChildFrame 辅助函数打开的带框子窗口。

EndCombo

结束当前组合框弹出区域。

EndDisabled

结束 BeginDisabled 作用域,恢复先前的交互和透明度状态。

EndDragDropSource

结束当前拖放源。

EndDragDropTarget

结束当前拖放目标。

EndFrame

结束当前 Dear ImGui 帧。

EndGroup

结束分组并将其边界合并为一个条目。

EndListBox

结束当前列表框区域。

EndMainMenuBar

结束主菜单栏。

EndMenu

结束当前菜单。

EndMenuBar

结束当前窗口菜单栏。

EndMultiSelect

结束 BeginMultiSelect 作用域,并完成选择请求的整理。

EndPopup

结束当前弹出窗口。

EndTabBar

结束当前标签栏。

EndTabItem

结束当前标签项。

EndTable

结束当前表格。

EndTooltip

结束当前工具提示窗口。

FontAtlas_GetTexDataAsAlpha8

不拷贝地取得字体图集的 alpha8 贴图数据。

FontAtlas_GetTexDataAsRGBA32

不拷贝地取得字体图集的 RGBA32 贴图数据。

FontGlyphRangesBuilder_BuildRanges

构建字形范围,返回以 0 结尾的副本。

FontTextureView

字体图集贴图数据视图。

FormatArgument

可传给格式化辅助函数的参数。

GetBackgroundDrawList

获取在界面内容后方绘制的绘制列表。

GetClipboardText

获取操作系统剪贴板中的文本。

GetColorU32

应用全局样式透明度,将样式颜色打包为 32 位值。

GetColorU32Ex

获取应用透明度的打包样式颜色。

GetColorU32ImU32

将全局样式透明度应用于已打包的 32 位颜色。

GetColorU32ImU32Ex

获取指定颜色,应用样式 alpha,并打包为适用于 ImDrawList 的 32 位值。

GetColorU32ImVec4

获取指定颜色,应用样式 alpha,并打包为适用于 ImDrawList 的 32 位值。

GetColumnIndex

获取当前列索引。

GetColumnOffset

获取旧式分栏边界偏移量。

GetColumnsCount

查询当前旧式分栏布局的列数。

GetColumnWidth

获取列宽(像素)。

GetContentRegionAvail

获取当前光标位置之后的可用内容区域。

GetContentRegionMax

获取内容区域最大边界的窗口局部坐标。

GetCursorPos

获取布局光标的窗口局部坐标。

GetCursorPosX

读取布局游标在窗口局部坐标系中的 X 坐标。

GetCursorPosY

读取布局游标在窗口局部坐标系中的 Y 坐标。

GetCursorScreenPos

获取布局光标的屏幕坐标。

GetCursorStartPos

获取布局光标起始位置的窗口局部坐标。

GetDragDropPayload

获取当前活动的拖放载荷。

GetDrawData

获取已渲染帧的绘制数据。

GetDrawListSharedData

获取绘制列表使用的共享数据。

GetFont

获取当前字体。

GetFontSize

获取当前字体应用当前缩放后的字号(即像素高度)。

GetFontTexUvWhitePixel

获取白色像素的 UV 坐标,适合通过 ImDrawList API 绘制自定义形状。

GetForegroundDrawList

获取在界面内容上方绘制的绘制列表。

GetFrameCount

获取 imgui 全局帧计数。

GetFrameHeight

获取带边框控件的高度。

GetFrameHeightWithSpacing

获取包含垂直间距的带边框控件高度。

GetID

根据 ID 栈和传入值计算标识符。

GetIDInt

将整数与当前 ID 栈一起哈希,生成控件标识符。

GetIDPtr

将指针值与当前 ID 栈一起哈希,生成控件标识符。

GetIDStr

将字符串区间与当前 ID 栈一起哈希,生成控件标识符。

GetIO

访问输入和配置状态。

GetItemID

获取最后一个条目的标识符。

GetItemRectMax

获取最后一个条目右下角的屏幕坐标。

GetItemRectMin

获取最后一个条目左上角的屏幕坐标。

GetItemRectSize

获取最后一个项目的尺寸。

GetKeyName

[调试] 返回按键的英文名称。

GetKeyPressedAmount

根据指定重复延迟和频率计算按键次数。

GetMainViewport

获取主视口。

GetMouseClickedCount

获取当前鼠标点击的连续点击次数。

GetMouseCursor

获取期望的鼠标光标形状。

GetMouseDragDelta

获取开始拖动以来的鼠标位移。

GetMousePos

获取当前鼠标位置。

GetMousePosOnOpeningCurrentPopup

获取当前弹出窗口打开时的鼠标位置。

GetPlatformIO

访问平台和渲染器集成接口。

GetScrollMaxX

获取最大水平滚动偏移量。

GetScrollMaxY

获取最大垂直滚动偏移量。

GetScrollX

获取水平滚动偏移量。

GetScrollY

获取垂直滚动偏移量。

GetStateStorage

访问当前窗口正在使用的键值状态存储。

GetStyle

访问 Style 结构(颜色、尺寸)。

GetStyleColorName

获取样式颜色的名称。

GetStyleColorVec4

获取 ImGuiStyle 结构中存储的原始样式颜色。

GetTextLineHeight

获取单行文本的高度。

GetTextLineHeightWithSpacing

获取包含行间距的文本行高度。

GetTime

获取 imgui 全局时间。

GetTreeNodeToLabelSpacing

获取树节点与标签之间的水平间距。

GetVersion

获取编译后的 Dear ImGui 版本字符串。

GetWindowContentRegionMax

获取窗口内容区域最大边界的窗口局部坐标。

GetWindowContentRegionMin

获取窗口内容区域最小边界的窗口局部坐标。

GetWindowDrawList

获取当前窗口关联的绘制列表,以追加自定义绘制图元。

GetWindowHeight

获取当前窗口的高度。

GetWindowPos

获取当前窗口的屏幕坐标。

GetWindowSize

获取当前窗口的尺寸。

GetWindowWidth

获取当前窗口的宽度。

Image

显示图像。

ImageButton

显示包含纹理图像的可点击按钮。

ImageButtonEx

显示包含纹理图像的可点击按钮。

ImageEx

将纹理图像显示为不可交互的控件。

ImageImVec4

使用旧式着色和边框颜色显示图像。

ImageWithBg

显示纹理图像,支持背景色和着色。

ImageWithBgEx

显示纹理图像,支持背景色和着色。

ImColor_HSV

根据色相、饱和度、明度和透明度创建 RGBA 颜色。

ImColor_SetHSV

用 HSV 写入 RGBA 颜色数组。

ImDrawCmd

从绘制列表或渲染回调借用的绘制命令句柄。

ImDrawCmd_GetTexID

获取当前绘制命令关联的纹理标识符。

ImDrawCmdFields

原生内存中的绘制命令标量,不是快照。

ImDrawData

帧绘制数据句柄;借用结果在下一次 NewFrame() 时失效。

ImDrawData_AddDrawList

向绘制数据添加绘制列表。

ImDrawData_Clear

重置帧绘制数据,不清空或销毁所引用的绘制列表。

ImDrawData_DeIndexAllBuffers

将索引绘制缓冲区转换为非索引缓冲区。

ImDrawData_ScaleClipRects

缩放全部绘制命令的裁剪矩形。

ImDrawDataFields

帧渲染统计与显示坐标到帧缓冲的几何信息。

ImDrawFlags

路径与圆角选项的按位组合。

ImDrawFlags

路径闭合与矩形圆角选择;圆角需要指定半径。

ImDrawList

命令与几何缓冲区句柄;窗口拥有的列表只适用于当前帧。

ImDrawList__CalcCircleAutoSegmentCount

根据圆的半径和配置的细分误差确定分段数。

ImDrawList__ClearFreeMemory

重置绘制列表,并释放其缓冲区、栈、路径和通道内存。

ImDrawList__OnChangedClipRect

更新或拆分绘制命令,以反映裁剪矩形的变化。

ImDrawList__OnChangedTextureID

更新或拆分绘制命令,以反映纹理绑定的变化。

ImDrawList__OnChangedVtxOffset

重置局部顶点索引,并根据顶点偏移的变化更新绘制命令。

ImDrawList__PathArcToFastEx

使用预计算的采样点和采样步长向路径添加圆弧。

ImDrawList__PathArcToN

按显式指定的分段数向当前路径添加圆弧。

ImDrawList__PopUnusedDrawCmd

移除末尾既无元素也无回调的绘制命令。

ImDrawList__ResetForNewFrame

为新帧重置绘制列表。

ImDrawList__SetTextureID

更改当前绘制命令的纹理,不压入纹理栈。

ImDrawList__TryMergeDrawCmds

当渲染状态与索引区间兼容时,合并最后两个绘制命令。

ImDrawList_AddBezierCubic

向绘制列表添加描边的三次贝塞尔曲线。

ImDrawList_AddBezierQuadratic

向绘制列表添加描边的二次贝塞尔曲线。

ImDrawList_AddCircle

向绘制列表添加圆轮廓。

ImDrawList_AddCircleEx

向绘制列表添加圆轮廓。

ImDrawList_AddCircleFilled

向绘制列表添加颜色填充的圆。

ImDrawList_AddConcavePolyFilled

向绘制列表添加无孔洞且不自交的填充凹多边形。

ImDrawList_AddConvexPolyFilled

向绘制列表添加填充的凸多边形。

ImDrawList_AddDrawCmd

开始新的绘制命令。

ImDrawList_AddEllipse

向绘制列表添加椭圆轮廓。

ImDrawList_AddEllipseEx

向绘制列表添加椭圆轮廓。

ImDrawList_AddEllipseFilled

向绘制列表添加颜色填充的椭圆。

ImDrawList_AddEllipseFilledEx

向绘制列表添加颜色填充的椭圆。

ImDrawList_AddImage

向绘制列表添加图像矩形。

ImDrawList_AddImageEx

向绘制列表添加带纹理的轴对齐矩形。

ImDrawList_AddImageQuad

向绘制列表添加带纹理的四边形。

ImDrawList_AddImageQuadEx

向绘制列表添加带纹理的四边形。

ImDrawList_AddImageRounded

向绘制列表添加带纹理的圆角矩形。

ImDrawList_AddLine

向绘制列表添加直线。

ImDrawList_AddLineEx

向绘制列表添加有色线段。

ImDrawList_AddNgon

向绘制列表添加正多边形轮廓。

ImDrawList_AddNgonEx

向绘制列表添加正多边形轮廓。

ImDrawList_AddNgonFilled

向绘制列表添加颜色填充的正多边形。

ImDrawList_AddPolyline

向绘制列表添加折线。

ImDrawList_AddQuad

向绘制列表添加四边形轮廓。

ImDrawList_AddQuadEx

向绘制列表添加四边形轮廓。

ImDrawList_AddQuadFilled

向绘制列表添加颜色填充的四边形。

ImDrawList_AddRect

向绘制列表添加轴对齐的矩形轮廓。

ImDrawList_AddRectEx

向绘制列表添加轴对齐的矩形轮廓。

ImDrawList_AddRectFilled

向绘制列表添加填充的轴对齐矩形。

ImDrawList_AddRectFilledEx

向绘制列表添加填充的轴对齐矩形。

ImDrawList_AddRectFilledMultiColor

添加填充矩形,颜色由四个角的颜色插值得到。

ImDrawList_AddText

使用当前字体和字号向绘制列表添加文本。

ImDrawList_AddTextEx

使用当前字体和字号向绘制列表添加文本。

ImDrawList_AddTextImFontPtr

向绘制列表添加文本,显式控制字体和字号。

ImDrawList_AddTextImFontPtrEx

向绘制列表添加文本,显式控制字体和字号。

ImDrawList_AddTriangle

向绘制列表添加三角形轮廓。

ImDrawList_AddTriangleEx

向绘制列表添加三角形轮廓。

ImDrawList_AddTriangleFilled

向绘制列表添加颜色填充的三角形。

ImDrawList_ChannelsMerge

按通道顺序将绘制通道合并回单个绘制列表。

ImDrawList_ChannelsSetCurrent

选择用于接收后续图元的绘制通道。

ImDrawList_ChannelsSplit

将绘制列表拆分为可独立排序的通道。

ImDrawList_CloneOutput

创建 CmdBuffer/IdxBuffer/VtxBuffer 的副本。

ImDrawList_GetClipRectMax

读取当前绘制列表裁剪矩形的右下角。

ImDrawList_GetClipRectMin

读取当前绘制列表裁剪矩形的左上角。

ImDrawList_PathArcTo

沿圆弧向当前路径添加点。

ImDrawList_PathArcToFast

使用预计算角度追加圆弧。

ImDrawList_PathBezierCubicCurveTo

从当前路径终点追加三次贝塞尔曲线段,不进行描边。

ImDrawList_PathBezierQuadraticCurveTo

从当前路径终点追加二次贝塞尔曲线段,不进行描边。

ImDrawList_PathClear

清空当前路径。

ImDrawList_PathEllipticalArcTo

向当前路径添加自动细分的椭圆弧。

ImDrawList_PathEllipticalArcToEx

向当前路径追加椭圆弧。

ImDrawList_PathFillConcave

填充当前凹路径,并清空已累积的点。

ImDrawList_PathFillConvex

填充当前凸路径,并清空已累积的点。

ImDrawList_PathLineTo

向当前绘制路径添加一个点。

ImDrawList_PathLineToMergeDuplicate

仅当新点与末尾点不同时向路径追加该点。

ImDrawList_PathRect

向当前路径添加矩形,可使用圆角。

ImDrawList_PathStroke

将当前路径描画为折线,并清空已累积的点。

ImDrawList_PopClipRect

弹出绘制列表的裁剪矩形,恢复先前仅影响渲染的裁剪状态。

ImDrawList_PopTextureID

弹出 ImDrawList_PushTextureID 压入的纹理绑定,并恢复先前的绑定。

ImDrawList_PrimQuadUV

将带 UV 坐标的四边形写入预留的顶点和索引空间。

ImDrawList_PrimRect

将轴对齐矩形写入为两个三角形。

ImDrawList_PrimRectUV

将带 UV 坐标的轴对齐矩形写入预留的顶点和索引空间。

ImDrawList_PrimReserve

为绘制图元预留顶点和索引空间。

ImDrawList_PrimUnreserve

从最近一次图元预留空间的末尾释放未使用的顶点和索引。

ImDrawList_PrimVtx

写入顶点及其索引。

ImDrawList_PrimWriteIdx

向预留空间写入一个索引,并前移索引游标。

ImDrawList_PrimWriteVtx

向预留空间写入一个顶点,并前移顶点游标。

ImDrawList_PushClipRect

压入仅用于渲染的裁剪矩形。

ImDrawList_PushClipRectFullScreen

将共享的全屏裁剪矩形压入绘制列表的裁剪栈。

ImDrawList_PushTextureID

为后续绘制列表图元压入纹理绑定。

ImDrawListFields

绘制列表配置及内部几何记账状态。

ImDrawListFlags

绘制列表选项的按位组合。

ImDrawListFlags

绘制列表的抗锯齿和顶点偏移能力。

ImDrawListSharedData

从 ImGui 上下文借用的绘制列表共享配置。

ImDrawListSplitter

用于拆分和合并绘制列表通道的辅助句柄。

ImDrawListSplitter_Clear

清空绘制列表分割器并保留通道分配内存。

ImDrawListSplitter_ClearFreeMemory

重置绘制列表拆分器,并释放其通道缓冲区。

ImDrawListSplitter_Merge

按通道顺序将绘制通道合并回单个绘制列表。

ImDrawListSplitter_SetCurrentChannel

选择用于接收后续图元的绘制通道。

ImDrawListSplitter_Split

将绘制列表拆分为可独立添加内容、随后合并的通道。

ImDrawListSplitterFields

由拆分、合并与切换调用维护的内部通道状态。

ImFont

字体句柄;图集返回的字体为借用数据,图集清空字体后失效。

ImFont_FindGlyph

查找字符字形,缺失时使用回退字形。

ImFont_FindGlyphNoFallback

查找字符字形,不使用回退字形替代。

ImFont_GetCharAdvance

读取字符未经缩放的水平推进量,缺失时使用回退推进量。

ImFont_GetDebugName

读取用于调试的字体源名称。

ImFont_IsLoaded

检查字体是否已加载到图集中。

ImFontAtlas

光栅化字体图集句柄;上下文返回的图集为借用对象。

ImFontAtlas_AddCustomRectFontGlyph

预留图集矩形,并将其映射为字体中的自定义字形。

ImFontAtlas_AddCustomRectRegular

在字体图集中预留自定义矩形。

ImFontAtlas_AddFont

注册配置好的字体源,供下一次图集构建使用。

ImFontAtlas_AddFontDefault

向图集添加内嵌的默认字体。

ImFontAtlas_AddFontFromFileTTF

加载 TTF 或 OTF 字体文件,并注册供图集构建使用。

ImFontAtlas_AddFontFromMemoryCompressedBase85TTF

从 Base85 编码的压缩 TrueType 数据添加字体。

ImFontAtlas_AddFontFromMemoryCompressedTTF

从内存中的压缩 TrueType 数据添加字体。

ImFontAtlas_AddFontFromMemoryTTF

从内存中的未压缩 TrueType 数据添加字体。

ImFontAtlas_Build

构建字体图集及其纹理数据。

ImFontAtlas_Clear

清除全部输入和输出。

ImFontAtlas_ClearFonts

清空字体的输入和输出数据。

ImFontAtlas_ClearInputData

清空字体图集的输入数据。

ImFontAtlas_ClearTexData

清除输出纹理数据(CPU 侧)。

ImFontAtlas_GetCustomRectByIndex

按索引访问已注册的图集自定义矩形。

ImFontAtlas_IsBuilt

判断字体图集是否已构建。

ImFontAtlas_SetTexID

将图集与上传后的渲染器纹理标识符关联。

ImFontAtlasCustomRect

借用的图集打包矩形;添加矩形或重建图集可能使其失效。

ImFontAtlasCustomRectFields

图集打包输出;这些是像素坐标,不是归一化 UV。

ImFontAtlasFields

图集构建配置;应在构建前修改,不要在帧锁定期间修改。

ImFontAtlasFlags

字体图集构建选项的按位组合。

ImFontAtlasFlags

字体图集纹理尺寸和可选烘焙资源。

ImFontConfig

添加或构建字体时使用的字体源配置句柄。

ImFontConfigFields

图集构建所使用的字体源和光栅器设置。

ImFontGlyph

借用的字形度量和图集坐标;字体重建后失效。

ImFontGlyphFields

实时字形度量、UV 与原生位域访问器。

ImFontGlyphRangesBuilder

用于构建包含端点的字形范围的 Unicode 字符集句柄。

ImFontGlyphRangesBuilder_AddChar

向字形范围添加字符。

ImFontGlyphRangesBuilder_AddRanges

向字形范围构建器添加字符范围。

ImFontGlyphRangesBuilder_AddText

将 UTF-8 字符串中的全部字符添加到字形范围。

ImFontGlyphRangesBuilder_Clear

清除字形范围构建器中选中的所有码点。

ImFontGlyphRangesBuilder_GetBit

判断字形范围位是否已设置。

ImFontGlyphRangesBuilder_SetBit

设置字形范围位。

ImGuiBackendFlags

后端能力报告的按位组合。

ImGuiBackendFlags

平台与渲染后端报告的能力。

ImGuiButtonFlags

按钮选项的按位组合;鼠标按钮位可以组合。

ImGuiButtonFlags

InvisibleButton() 的鼠标按钮激活与导航选项。

ImGuiChildFlags

子窗口选项的按位组合。

ImGuiChildFlags

BeginChild() 的尺寸、内边距和导航选项。

ImGuiCol

样式颜色槽位的数值索引。

ImGuiCol

ImGuiStyle 中的颜色槽位,也用于 PushStyleColor()。

ImGuiColorEditFlags

颜色编辑与预览选项的按位组合。

ImGuiColorEditFlags

颜色编辑器、拾色器和预览选项。显示格式与颜色数据的 RGB/HSV 存储格式独立。

ImGuiComboFlags

组合框选项的按位组合。

ImGuiComboFlags

组合框预览与弹窗尺寸选项;高度策略只能选一个。

ImGuiCond

应用设置的单个条件。

ImGuiCond

应用窗口设置的条件;只能选择一个,不可组合。

ImGuiConfigFlags

应用 IO 配置选项的按位组合。

ImGuiConfigFlags

由应用设置的 IO 配置标志。

ImGuiDataType

原生存储类型的数值标识。

ImGuiDataType

原生标量存储类型;Bool、String 不受标量控件支持。

ImGuiDir

方向的数值标识。

ImGuiDir

用于导航和箭头绘制的四个方向。

ImGuiDragDropFlags

拖放选项的按位组合。

ImGuiDragDropFlags

拖动源、载荷生命周期和目标接收选项。

ImGuiFocusedFlags

窗口焦点查询选项的按位组合。

ImGuiFocusedFlags

IsWindowFocused() 的检查范围;原始输入分发应使用 IO 捕获标志。

ImGuiHoveredFlags

悬停查询选项的按位组合。

ImGuiHoveredFlags

悬停查询范围、遮挡例外和时序。原始鼠标输入分发应使用 IO 捕获标志。

ImGuiInputFlags

快捷键路由和重复选项的按位组合。

ImGuiInputFlags

快捷键重复和路由设置;Route 策略只能选一个。

ImGuiInputTextCallbackData

文本编辑回调状态;仅在当前回调执行期间有效。

ImGuiInputTextCallbackDataFields

文本回调标量;位置和长度按 UTF-8 字节计,不是 JS 索引。

ImGuiInputTextFlags

文本输入选项的按位组合。

ImGuiInputTextFlags

文本输入的过滤、编辑和回调选项。

ImGuiIO

借用的上下文输入输出状态;销毁上下文后失效。

ImGuiIOFields

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

ImGuiItemFlags

通用控件选项的按位组合。

ImGuiItemFlags

PushItemFlag() 控制的通用控件行为。

ImGuiKey

按键 API 接受的命名输入标识或修饰位。

ImGuiKey

键盘、手柄、鼠标命名输入及组合键修饰位。 NamedKey_BEGIN 以下的原生或旧键码不属于命名键。

ImGuiListClipper

用于等间距、可随机访问行的可见范围迭代器句柄。

ImGuiListClipperFields

裁剪器输出范围与内部垂直位置记账状态。

ImGuiMouseButton

鼠标按钮的索引。

ImGuiMouseButton

鼠标按钮索引,不是位标志。

ImGuiMouseCursor

光标形状的数值标识。

ImGuiMouseCursor

请求的鼠标光标形状。

ImGuiMouseSource

指针输入来源的数值标识。

ImGuiMouseSource

指针事件的物理来源。

ImGuiMultiSelectFlags

多选选项的按位组合。

ImGuiMultiSelectFlags

多选手势、清空规则和交互范围。

ImGuiMultiSelectIO

当前多选作用域中借用的选择请求与状态。

ImGuiMultiSelectIOFields

多选范围锚点与导航状态,不包含请求列表。

ImGuiPayload

借用的拖放载荷;不要在拖放操作结束后继续使用。

ImGuiPayloadFields

拖放载荷的标量元数据;不暴露其数据指针。

ImGuiPlatformIO

ImGui 上下文拥有的、供借用的平台服务与区域设置状态。

ImGuiPlatformIOFields

数字文本输入的平台区域配置。

ImGuiPopupFlags

弹窗选项位与一个编码的鼠标按钮索引。

ImGuiPopupFlags

弹窗开启与查询选项。鼠标按钮是索引,不可按位组合。 上下文函数默认右键;添加其他标志时,若仍需右键必须显式包含它。

ImGuiSelectableFlags

可选项选项的按位组合。

ImGuiSelectableFlags

Selectable() 的选择、高亮和命中检测选项。

ImGuiSelectionBasicStorage

将多选请求应用到持久标识符的选择集句柄。

ImGuiSelectionBasicStorageFields

选择存储的数量与排序配置;不是选中 ID 集合。

ImGuiSelectionExternalStorage

将多选请求应用到应用自有存储的适配器句柄。

ImGuiSelectionRequestType

选择请求种类的数值标识。

ImGuiSelectionRequestType

ImGui 请求应用对自有选择数据执行的变更类型。

ImGuiSliderFlags

滑块和拖动选项的按位组合。

ImGuiSliderFlags

滑块和拖动控件的数值映射、直接输入与边界选项。

ImGuiSortDirection

排序方向的数值标识。

ImGuiSortDirection

表格排序规格中的排序方向。

ImGuiStorage

按 ID 索引的原生值存储;借用的窗口存储随其所有者失效。

ImGuiStyle

从上下文借用的样式状态,包括尺寸、颜色和悬停规则。

ImGuiStyleFields

原生样式标量;除非另有说明,尺寸单位均为像素。

ImGuiStyleVar

可压栈样式字段的数值标识。

ImGuiStyleVar

由 PushStyleVar()/PopStyleVar() 临时覆盖的样式字段。

ImGuiTabBarFlags

标签栏选项的按位组合。

ImGuiTabBarFlags

标签栏排序、控件和溢出策略。

ImGuiTabItemFlags

单个标签选项的按位组合。

ImGuiTabItemFlags

单个标签的选择、位置和关闭行为。

ImGuiTableBgTarget

表格背景层的数值标识。

ImGuiTableBgTarget

TableSetBgColor() 的背景层,按 RowBg0 到 CellBg 顺序绘制。

ImGuiTableColumnFlags

列配置或状态位的按位组合。

ImGuiTableColumnFlags

列配置及 TableGetColumnFlags() 返回的只读状态。

ImGuiTableFlags

表格选项位,包含单个编码尺寸策略。

ImGuiTableFlags

表格布局、装饰和交互选项。尺寸策略选一个;排序仅提供规格,不替应用排数据。

ImGuiTableRowFlags

表格行选项的按位组合。

ImGuiTableRowFlags

传给 TableNextRow() 的行角色。

ImGuiTableSortSpecs

借用的表格排序状态;表格变化或开始新帧后需重新获取。

ImGuiTableSortSpecsFields

表格排序规格数量与应用的待排序标志。

ImGuiTextBuffer

带原生 NUL 终止字节的可增长 UTF-8 文本缓冲区句柄。

ImGuiTextFilter

逗号分隔的包含/排除过滤器句柄;减号前缀表示排除项。

ImGuiTextFilterFields

构建逗号分隔过滤表达式时计算的文本过滤器记账状态。

ImGuiTreeNodeFlags

树节点选项的按位组合。

ImGuiTreeNodeFlags

树节点外观、命中区域和展开行为。

ImGuiViewport

借用的视口几何信息;仅在所属上下文和视口存活期间有效。

ImGuiViewportFields

视口标识与显示空间几何;工作区域不包含已预留的界面区域。

ImGuiViewportFlags

视口类型和所有权标记的按位组合。

ImGuiViewportFlags

视口的平台类型和所有权标记。

ImGuiWindowFlags

窗口选项的按位组合。

ImGuiWindowFlags

Begin() 的窗口外观、交互和生命周期选项。

ImVec2Like

二分量输入,从 x/y 对象、元组或 Float32Array 的前两个元素复制。

ImVec2Value

普通二分量值,不是原生内存的实时视图。

ImVec4Like

按值复制的四分量输入;颜色通常按 RGBA 顺序传入。

ImVec4Value

普通四分量值;通常表示 RGBA,各通道范围为零到一。

Indent

按样式中的缩进间距将内容位置右移。

IndentEx

向右缩进后续内容。

InputDouble

在数字文本框中编辑双精度浮点值。

InputDoubleEx

在数字文本框中编辑双精度浮点值。

InputFloat

在数字文本框中编辑浮点值。

InputFloat2

在数字文本框中编辑 2 个浮点分量。

InputFloat2Ex

在数字文本框中编辑 2 个浮点分量。

InputFloat3

在数字文本框中编辑 3 个浮点分量。

InputFloat3Ex

在数字文本框中编辑 3 个浮点分量。

InputFloat4

在数字文本框中编辑 4 个浮点分量。

InputFloat4Ex

在数字文本框中编辑 4 个浮点分量。

InputFloatEx

在数字文本框中编辑浮点值。

InputInt

在数字文本框中编辑整数值。

InputInt2

在数字文本框中编辑 2 个整数分量。

InputInt3

在数字文本框中编辑 3 个整数分量。

InputInt4

在数字文本框中编辑 4 个整数分量。

InputIntEx

在数字文本框中编辑整数值。

InputScalar

在文本框中编辑指定数据类型的单个数值。

InputScalarEx

在文本框中编辑指定数据类型的单个数值。

InputScalarN

在文本框中编辑指定数据类型的多个数值分量。

InputScalarNEx

在文本框中编辑指定数据类型的多个数值分量。

InputText

编辑单行文本。

InputTextCallback

InputText 的自定义回调。

InputTextCallbackData_ClearSelection

将回调文本选区收缩为缓冲区末尾的空区间。

InputTextCallbackData_DeleteChars

从回调文本缓冲区删除字节,并更新其编辑状态。

InputTextCallbackData_HasSelection

检查输入回调缓冲区是否存在非空文本选区。

InputTextCallbackData_InsertChars

向回调缓冲区插入文本,更新编辑状态,并在需要时请求扩容。

InputTextCallbackData_SelectAll

选中输入回调缓冲区中的全部文本。

InputTextEx

带 JavaScript 回调的输入框。

InputTextMultiline

显示用于编辑多行文本的输入框。

InputTextMultilineEx

带 JavaScript 回调的多行输入框。

InputTextWithHint

显示单行文本输入框,内容为空时显示提示。

InputTextWithHintEx

显示单行文本输入框,内容为空时显示提示。

InvisibleButton

创建不可见的可交互按钮区域。

IO_AddFocusEvent

将应用焦点变化加入队列。

IO_AddInputCharacter

将新的字符输入加入队列。

IO_AddInputCharactersUTF8

将 UTF-8 字符串中的字符输入加入队列。

IO_AddInputCharacterUTF16

将 UTF-16 输入码元加入队列。

IO_AddKeyAnalogEvent

将模拟按键按下或释放事件加入队列。

IO_AddKeyEvent

将按键按下或释放事件加入队列。

IO_AddMouseButtonEvent

将鼠标按钮变化加入队列。

IO_AddMousePosEvent

将鼠标位置更新加入队列。

IO_AddMouseSourceEvent

将鼠标来源变化加入队列(鼠标/触摸屏/笔)。

IO_AddMouseWheelEvent

将鼠标滚轮更新加入队列。

IO_ClearEventsQueue

清除所有传入事件。

IO_ClearInputCharacters

清空当前帧的文本输入缓冲区。

IO_ClearInputKeys

清除当前键盘/手柄状态及当前帧文本输入缓冲区。

IO_ClearInputMouse

清除当前鼠标状态。

IO_SetAppAcceptingEvents

启用或禁用输入事件入队。

IO_SetKeyEventNativeData

为兼容性接收原生按键元数据;此版本执行校验但不存储这些数据。

IO_SetKeyEventNativeDataEx

为输入事件关联原生按键数据。

IsAnyItemActive

是否有任意项目处于激活状态?

IsAnyItemFocused

是否有任意项目获得焦点?

IsAnyItemHovered

是否有任意项目处于悬停状态?

IsAnyMouseDown

判断是否有鼠标按钮处于按下状态。

IsItemActivated

最后一个项目是否刚被激活(此前处于非激活状态)?

IsItemActive

判断最后一个条目是否处于活动状态。

IsItemClicked

检查悬停在上一个控件时是否按下了鼠标左键。

IsItemClickedEx

判断最后一个条目是否在悬停时被点击。

IsItemDeactivated

最后一个项目是否刚退出激活状态(此前处于激活状态)?

IsItemDeactivatedAfterEdit

最后一个项目是否刚退出激活状态,且在激活期间修改过值(例如滑块/拖动控件被移动)?

IsItemEdited

最后一个项目是否在本帧修改了其底层值,或被按下?

IsItemFocused

最后一个项目是否获得键盘/手柄导航焦点?

IsItemHovered

判断鼠标是否悬停于最后一个条目。

IsItemToggledOpen

最后一个项目的展开状态是否被切换?

IsItemToggledSelection

最后一个项目的选择状态是否发生切换?

IsItemVisible

最后一个项目是否可见(项目可能因裁剪/滚动而不可见)?

IsKeyChordPressed

判断组合键是否被按下。

IsKeyDown

判断按键是否处于按下状态。

IsKeyPressed

检查按键是否在本帧刚被按下或产生了重复事件。

IsKeyPressedEx

判断按键是否被按下。

IsKeyReleased

判断按键是否被释放。

IsMouseClicked

检查鼠标按钮是否在本帧刚被按下,按住时不重复触发。

IsMouseClickedEx

判断鼠标按钮是否被点击。

IsMouseDoubleClicked

判断鼠标按钮是否被双击。

IsMouseDown

判断鼠标按钮是否处于按下状态。

IsMouseDragging

鼠标是否正在拖动?

IsMouseHoveringRect

按当前裁剪区域检查鼠标是否位于屏幕坐标矩形内,忽略窗口层叠顺序。

IsMouseHoveringRectEx

判断鼠标是否位于指定屏幕矩形内。

IsMousePosValid

判断鼠标位置是否有效。

IsMouseReleased

判断鼠标按钮是否被释放。

IsMouseReleasedWithDelay

延迟检测鼠标按钮释放事件。

IsPopupOpen

判断弹出窗口是否已打开。

IsRectVisible

测试屏幕坐标中的矩形是否可见/未被裁剪,以便在用户侧进行粗略裁剪。

IsRectVisibleBySize

判断光标位置的矩形是否可见。

IsWindowAppearing

判断当前窗口是否正在首次显示或重新出现。

IsWindowCollapsed

检查当前窗口是否已折叠。

IsWindowFocused

判断当前窗口是否获得焦点。

IsWindowHovered

判断鼠标是否悬停在当前窗口上。

ItemGetter

Combo 与 ListBox 的条目取值回调。

LabelText

绘制标签与格式化文本。

LabelTextUnformatted

显示文本+标签,对齐方式与数值+标签控件相同。

ListBox

显示可滚动的标签列表,用于选择单个项目。

ListBoxCallbackEx

带 JavaScript 取值回调的 ListBox。

ListClipper_Begin

初始化等间距列表的裁剪过程,以跳过屏幕外的项目。

ListClipper_End

结束列表裁剪并前进到剩余条目之后。

ListClipper_ForceDisplayRangeByIndices

让列表裁剪器包含指定索引范围。

ListClipper_IncludeItemByIndex

让列表裁剪器包含指定条目,不受可见性限制。

ListClipper_IncludeItemsByIndex

让列表裁剪器包含指定范围的条目。

ListClipper_IncludeRangeByIndices

让列表裁剪器包含指定索引范围。

ListClipper_SeekCursorForItem

将光标移向指定项目。

ListClipper_Step

前进到下一个可见列表条目范围。

LoadIniSettingsFromDisk

从 INI 文件加载界面设置。

LoadIniSettingsFromMemory

从内存中的 INI 文本加载界面设置。

LogButtons

显示用于捕获界面文本的控件。

LogFinish

停止记录日志(关闭文件等)。

LogText

向日志写入格式化文本。

LogTextUnformatted

将文本数据直接传入日志(不显示在界面中)。

LogToClipboard

开始向操作系统剪贴板记录日志。

LogToFile

开始向文件记录日志。

LogToTTY

开始将界面文本记录到标准输出。

MemAlloc

使用 Dear ImGui 配置的分配器分配内存。

MemFree

使用 Dear ImGui 配置的释放器释放内存。

显示启用且未勾选的菜单操作项。

显示可切换勾选状态的菜单项。

显示菜单项并报告是否被激活。

NativeStructMapping

用于构建结构体访问器的原生内存区域和标量布局。

NewFrame

开始新的 Dear ImGui 帧。

NewLine

撤销一次 SameLine(),或在水平布局上下文中强制换行。

NextColumn

移动到下一列,默认仍在当前行;若当前行已结束,则移到下一行。

OpenPopup

将弹出窗口标记为打开。

OpenPopupID

将数值 ID 指定的弹出窗口标记为打开。

OpenPopupOnItemClick

点击前一个条目时打开弹出窗口。

Payload_Clear

重置拖放载荷元数据,不释放所引用的数据。

Payload_IsDataType

检查有效的拖放载荷是否具有指定的类型标签。

Payload_IsDelivery

检查拖放载荷是否正因释放操作而交付给目标。

Payload_IsPreview

检查拖放载荷是否正在接受它的目标上预览。

PlotGetter

图表的数值取值回调。

PlotHistogram

将数值样本显示为垂直柱状图。

PlotHistogramCallbackEx

带 JavaScript 取值回调的直方图。

PlotHistogramEx

将数值样本显示为垂直柱状图。

PlotLines

将数值绘制为折线图。

PlotLinesCallbackEx

带 JavaScript 取值回调的折线图。

PlotLinesEx

将数值样本显示为折线图。

PopAllowKeyboardFocus

恢复配对的旧版 PushAllowKeyboardFocus 保存的控件标志。

PopButtonRepeat

恢复配对的旧版 PushButtonRepeat 保存的控件标志。

PopClipRect

恢复 PushClipRect 保存的窗口裁剪矩形,用于绘制和命中测试。

PopFont

恢复配对的 PushFont 保存的字体。

PopID

从 ID 栈弹出一项。

PopItemFlag

恢复配对的 PushItemFlag 保存的控件标志。

PopItemWidth

恢复当前窗口中 PushItemWidth 保存的控件宽度。

PopStyleColor

弹出样式颜色覆盖项,恢复 PushStyleColor 保存的颜色。

PopStyleColorEx

弹出样式颜色覆盖项,恢复 PushStyleColor 保存的颜色。

PopStyleVar

弹出样式变量覆盖项,恢复 PushStyleVar 系列保存的值。

PopStyleVarEx

弹出样式变量覆盖项,恢复 PushStyleVar 系列保存的值。

PopTabStop

恢复配对的旧版 PushTabStop 保存的控件标志。

PopTextWrapPos

恢复当前窗口中 PushTextWrapPos 保存的文本换行位置。

ProgressBar

按完成比例显示进度条,并可叠加文本。

PushAllowKeyboardFocus

压入后续条目是否接受键盘焦点的设置。

PushButtonRepeat

压入按钮重复触发设置。

PushClipRect

压入用于绘制和交互的裁剪矩形。

PushFont

压入后续控件使用的字体。

PushID

将字符串标识符压入 ID 栈。

PushIDInt

将整数压入 ID 栈(会对整数进行哈希)。

PushIDPtr

将指针压入 ID 栈(会对指针进行哈希)。

PushIDStr

将字符串压入 ID 栈(会对字符串进行哈希)。

PushItemFlag

压入共享条目标志设置。

PushItemWidth

压入后续带标签控件使用的宽度。

PushStyleColor

修改样式颜色。

PushStyleColorImVec4

使用浮点 RGBA 分量临时覆盖样式颜色。

PushStyleVar

修改样式中的 float 变量。

PushStyleVarImVec2

压入双分量样式变量。

PushStyleVarX

压入样式变量的 X 分量。

PushStyleVarY

压入样式变量的 Y 分量。

PushTabStop

临时控制后续控件能否通过 Tab 导航获得焦点。

PushTextWrapPos

压入后续文本使用的换行位置。

RadioButton

根据传入的选中状态显示单选按钮。

RadioButtonIntPtr

显示可更新整数选中值的单选按钮。

Render

结束当前帧并完成绘制数据。

ResetMouseDragDelta

将鼠标拖动起点重置为当前指针位置。

ResetMouseDragDeltaEx

将鼠标拖动起点重置为当前指针位置。

SameLine

将下一个控件放在前一个控件右侧的同一行。

SameLineEx

将下一个控件或分组放在同一行。

SaveIniSettingsToDisk

将界面设置保存到 INI 文件。

SaveIniSettingsToMemory

将界面设置序列化为 INI 文本。

Selectable

显示可选条目。

SelectableBoolPtr

显示可选中项,激活时更新其布尔选中状态。

SelectableBoolPtrEx

显示可更新自身选中状态的可选条目。

SelectableEx

根据传入的选中状态显示可选条目。

SelectedItem

选中项迭代结果。

SelectionBasicStorage_ApplyRequests

应用来自 BeginMultiSelect() 和 EndMultiSelect() 的选择请求。

SelectionBasicStorage_Clear

清空选择集。

SelectionBasicStorage_Contains

查询某项目 ID 是否在选择集中。

SelectionBasicStorage_GetNextSelectedItem

迭代到下一个选中项。

SelectionBasicStorage_GetStorageIdFromIndex

根据提供的适配器将索引转换为项目 ID。

SelectionBasicStorage_SetItemSelected

在选区中添加或移除条目。

SelectionBasicStorage_Swap

交换两个选择集。

SelectionExternalStorage_ApplyRequests

通过原生项目选择回调应用选择请求;此 JS 绑定未暴露该回调的配置接口。

Separator

绘制分隔线。

SeparatorText

在水平分隔线中显示文本标签。

SetClipboardText

通过已配置的平台剪贴板处理器替换剪贴板文本。

SetColorEditOptions

设置颜色编辑器和拾色器的默认选项。

SetColumnOffset

设置旧式分栏边界偏移量。

SetColumnWidth

设置列宽(像素)。

SetCursorPos

使用窗口局部坐标设置布局游标位置。

SetCursorPosX

设置布局游标在窗口局部坐标系中的 X 坐标。

SetCursorPosY

设置布局游标在窗口局部坐标系中的 Y 坐标。

SetCursorScreenPos

设置布局光标的屏幕坐标。

SetDragDropPayload

设置拖放载荷数据。

SetItemAllowOverlap

允许后续条目覆盖最后一个条目。

SetItemDefaultFocus

将最后一个条目设为新出现窗口的默认焦点。

SetItemKeyOwner

将输入所有权分配给最后一个条目。

SetItemTooltip

为上一个项目设置格式化工具提示。

SetItemTooltipUnformatted

当前一个项目被悬停时,设置纯文本工具提示。

SetKeyboardFocusHere

请求将键盘焦点移至下一个控件。

SetKeyboardFocusHereEx

将键盘焦点设到下一个控件。

SetMouseCursor

设置期望的鼠标光标形状。

SetNavCursorVisible

设置键盘和游戏手柄导航光标的可见性。

SetNextFrameWantCaptureKeyboard

覆盖下一帧的键盘输入捕获状态。

SetNextFrameWantCaptureMouse

覆盖下一帧的鼠标输入捕获状态。

SetNextItemAllowOverlap

允许后续条目覆盖下一个条目。

SetNextItemOpen

设置下一个 TreeNode/CollapsingHeader 的展开状态。

SetNextItemSelectionUserData

为下一个控件关联应用侧选择数据,供多选请求使用。

SetNextItemShortcut

为下一个控件分配经过路由的键盘快捷键以激活它。

SetNextItemStorageID

设置用于存储展开/折叠状态的 ID(默认与项目 ID 相同)。

SetNextItemWidth

设置下一个带标签控件的宽度。

SetNextWindowBgAlpha

设置下一个窗口背景色的 alpha。

SetNextWindowCollapsed

设置下一个窗口的折叠状态。

SetNextWindowContentSize

设置下一个窗口的内容尺寸。

SetNextWindowFocus

使下一个窗口获得焦点并置于最上层。

SetNextWindowPos

设置下一个窗口的位置。

SetNextWindowPosEx

设置下一个窗口的位置。

SetNextWindowScroll

设置下一个窗口的滚动偏移量。

SetNextWindowSize

设置下一个窗口的尺寸。

SetNextWindowSizeConstraints

设置下一个窗口的尺寸限制。

SetScrollFromPosX

滚动以显示当前窗口内的指定位置。

SetScrollFromPosY

滚动以显示当前窗口内的指定位置。

SetScrollHereX

水平滚动以显示当前光标位置。

SetScrollHereY

垂直滚动以显示当前光标位置。

SetScrollX

设置水平滚动偏移量。

SetScrollY

设置垂直滚动偏移量。

SetStateStorage

替换当前窗口的状态存储。

SetTabItemClosed

通知标签栏或停靠系统某个标签已关闭。

SetTooltip

设置格式化工具提示。

SetTooltipUnformatted

设置纯文本工具提示。

SetWindowCollapsed

设置当前窗口的折叠状态。

SetWindowCollapsedStr

设置指定名称窗口的折叠状态。

SetWindowFocus

聚焦当前窗口并将其置于最前方。

SetWindowFocusStr

使指定名称的窗口获得焦点并置于最上层。

SetWindowFontScale

设置当前窗口的字体缩放比例。

SetWindowPos

设置当前窗口的位置。

SetWindowPosStr

设置指定名称窗口的位置。

SetWindowSize

设置当前窗口的尺寸。

SetWindowSizeStr

设置指定名称窗口的尺寸。

Shortcut

检测并路由键盘快捷键。

ShowAboutWindow

显示版本、致谢和构建信息。

ShowDebugLogWindow

显示调试日志窗口。

ShowDemoWindow

显示 Dear ImGui 演示窗口。

ShowFontSelector

显示已加载字体的选择器。

ShowIDStackToolWindow

显示 ID 栈调试窗口,检查控件标识符的构成。

ShowIDStackToolWindowEx

显示 ID 栈调试窗口。

ShowMetricsWindow

显示性能指标和调试器窗口。

ShowStackToolWindow

显示 ID 栈调试窗口。

ShowStyleEditor

显示内嵌样式编辑器。

ShowStyleSelector

显示内置配色样式选择器。

ShowUserGuide

显示基本鼠标和键盘操作说明。

SliderAngle

使用以度数显示的滑块编辑以弧度存储的角度。

SliderAngleEx

使用以度数显示的滑块编辑以弧度存储的角度。

SliderFloat

通过滑块编辑浮点数值。

SliderFloat2

使用水平滑块编辑 2 个浮点分量。

SliderFloat2Ex

使用水平滑块编辑 2 个浮点分量。

SliderFloat3

使用水平滑块编辑 3 个浮点分量。

SliderFloat3Ex

使用水平滑块编辑 3 个浮点分量。

SliderFloat4

使用水平滑块编辑 4 个浮点分量。

SliderFloat4Ex

使用水平滑块编辑 4 个浮点分量。

SliderFloatEx

通过滑块编辑浮点数值。

SliderInt

使用水平滑块编辑整数值。

SliderInt2

使用水平滑块编辑 2 个整数分量。

SliderInt2Ex

使用水平滑块编辑 2 个整数分量。

SliderInt3

使用水平滑块编辑 3 个整数分量。

SliderInt3Ex

使用水平滑块编辑 3 个整数分量。

SliderInt4

使用水平滑块编辑 4 个整数分量。

SliderInt4Ex

使用水平滑块编辑 4 个整数分量。

SliderIntEx

使用水平滑块编辑整数值。

SliderScalar

使用水平滑块编辑指定数据类型的单个数值。

SliderScalarEx

使用水平滑块编辑指定数据类型的单个数值。

SliderScalarN

使用水平滑块编辑指定数据类型的多个数值分量。

SliderScalarNEx

使用水平滑块编辑指定数据类型的多个数值分量。

SmallButton

显示可嵌入文本的紧凑按钮。

Spacing

添加垂直间距。

Storage_BuildSortByKey

批量重建后按键排序存储条目。

Storage_Clear

清空存储中的全部键值对。

Storage_GetBool

按键查找存储的布尔值,不插入缺失的条目。

Storage_GetBoolRef

取得 ImGuiStorage 中 bool 值的可写引用。

Storage_GetFloat

按键查找存储的浮点值,不插入缺失的条目。

Storage_GetFloatRef

取得 ImGuiStorage 中 float 值的可写引用。

Storage_GetInt

按键查找存储的整数值,不插入缺失的条目。

Storage_GetIntRef

取得 ImGuiStorage 中 int 值的可写引用。

Storage_GetVoidPtr

获取指定键对应的已存储指针。

Storage_GetVoidPtrRef

取得 ImGuiStorage 中指针值的可写引用。

Storage_SetAllInt

设置全部已存储的整数值。

Storage_SetBool

按键存储布尔值,必要时插入条目。

Storage_SetFloat

按键存储浮点值,必要时插入条目。

Storage_SetInt

按键存储整数值,必要时插入条目。

Storage_SetVoidPtr

按键存储指针值,必要时插入条目。

Style_ScaleAllSizes

缩放内边距、间距和圆角等样式尺寸,以适应不同的界面缩放比例。

StyleColorsClassic

应用经典配色样式。

StyleColorsDark

应用深色配色样式。

StyleColorsLight

应用浅色配色样式。

TabItemButton

显示标签形状的按钮。

TableAngledHeadersRow

为启用倾斜标题的列提交倾斜表头。

TableGetColumnCount

返回列数(传给 BeginTable 的值)。

TableGetColumnFlags

返回列标志,以便查询其 Enabled/Visible/Sorted/Hovered 状态标志。

TableGetColumnIndex

返回当前列索引。

TableGetColumnName

获取表格列名。

TableGetHoveredColumn

获取鼠标悬停的表格列索引。

TableGetRowIndex

返回当前行索引。

TableGetSortSpecs

获取当前表格的排序规则。

TableHeader

手动提交一个标题单元格(很少使用)。

TableHeadersRow

提交表格列标题及其上下文菜单。

TableNextColumn

前进到下一表格列,并在需要时换行。

TableNextRow

结束当前表格行,并开始新的一行。

TableNextRowEx

开始向新行的第一个单元格追加内容。

TableSetBgColor

修改单元格、行或列的颜色。

TableSetColumnEnabled

修改用户可控制的列启用/禁用状态。

TableSetColumnIndex

开始向指定列追加内容。

TableSetupColumn

声明表格列并配置其布局。

TableSetupColumnEx

声明表格列,并配置其标签、尺寸策略和行为。

TableSetupScrollFreeze

锁定列/行,使其在滚动时保持可见。

Text

绘制格式化文本。

TextBuffer_append

向可增长的文本缓冲区追加未经格式化的文本。

TextBuffer_appendf

向 ImGuiTextBuffer 追加格式化文本。

TextBuffer_begin

将文本缓冲区复制为 JS 字符串,不含原生末尾的 NUL。

TextBuffer_c_str

将文本缓冲区复制为 JS 字符串,不含原生末尾的 NUL。

TextBuffer_clear

清空文本缓冲区内容并释放其分配的内存。

TextBuffer_empty

检查文本缓冲区是否不含文本。

TextBuffer_end

获取文本缓冲区的结束位置。

TextBuffer_reserve

确保文本缓冲区容量,不改变文本长度。

TextBuffer_resize

调整文本缓冲区的大小。

TextBuffer_size

计算文本缓冲区的字节长度,不含结尾零字符。

TextColored

绘制带颜色的格式化文本。

TextColoredUnformatted

以指定颜色显示文本。

TextDisabled

绘制使用禁用颜色的格式化文本。

TextDisabledUnformatted

使用禁用文本颜色显示文本。

TextFilter_Build

将筛选输入解析为逗号分隔的包含和排除条件。

TextFilter_Clear

清空筛选输入,并重新构建空筛选器。

TextFilter_Draw

显示文本过滤器编辑框并重建过滤条件。

TextFilter_IsActive

检查文本筛选器是否包含已解析的筛选条件。

TextFilter_PassFilter

按已解析的包含和排除筛选条件检查文本。

显示可点击的文本超链接。

TextLinkOpenURL

显示文本链接,点击时将标签内容作为 URL 或文件打开。

TextLinkOpenURLEx

显示点击后打开文件或 URL 的文本链接。

TextUnformatted

显示文本,不进行格式字符串处理。

TextUnformattedEx

显示文本,不进行格式字符串处理。

TextWrapped

绘制自动换行的格式化文本。

TextWrappedUnformatted

显示自动换行的文本。

TreeNode

显示树节点,并在展开时开始其内容区域。

TreeNodeEx

显示由标签标识、行为可配置的可展开树节点。

TreeNodeExPtr

绘制带标志的指针 ID 折叠节点。

TreeNodeExPtrUnformatted

显示可展开树节点,使用基于指针的 ID 和未经格式化的标签。

TreeNodeExStr

绘制带标志的字符串 ID 折叠节点。

TreeNodeExStrUnformatted

显示可展开树节点,使用独立的字符串 ID 和未经格式化的标签。

TreeNodePtr

使用指针 ID 绘制可折叠节点。

TreeNodePtrUnformatted

显示可展开树节点,使用基于指针的 ID 和未经格式化的标签。

TreeNodeStr

绘制可折叠节点,ID 与显示文本分离。

TreeNodeStrUnformatted

显示标识符与标签分离的树节点。

TreePop

结束树作用域并恢复缩进和 ID 栈。

TreePush

缩进内容并为树作用域压入标识符。

TreePushPtr

缩进并压入基于指针的树 ID 作用域,由 TreePop 结束。

Unindent

按样式中的缩进间距将内容位置左移。

UnindentEx

将后续内容向左退回。

viewImDrawCmd

无需复制标量值即可访问绘制命令。

viewImDrawData

在 Render() 与下一次 NewFrame() 之间查看帧绘制数据。

viewImDrawList

在绘制列表存储有效期间访问其标量。

viewImDrawListSplitter

无需复制即可检查拆分器的实时记账状态。

viewImFontAtlas

通过原生内存标量属性访问图集设置。

viewImFontAtlasCustomRect

读写原生图集矩形的打包位置。

viewImFontConfig

无需复制原生标量即可访问字体构建配置。

viewImFontGlyph

访问原生存储中的字形几何信息与纹理坐标。

viewImGuiInputTextCallbackData

在当前文本编辑回调执行期间访问其字段。

viewImGuiIO

无需复制即可访问上下文设置与原生维护的输入输出状态。

viewImGuiListClipper

观察 ListClipper_Begin()、ListClipper_Step()、ListClipper_End() 更新的原生裁剪范围。

viewImGuiMultiSelectIO

访问当前多选作用域的范围与导航状态。

viewImGuiPayload

无需复制载荷字节即可访问拖放元数据。

viewImGuiPlatformIO

无需复制即可访问上下文的平台区域标量。

viewImGuiSelectionBasicStorage

访问原生选择存储中的选中数量与排序选项。

viewImGuiStyle

访问上下文实时样式中的尺寸、不透明度与悬停行为。

viewImGuiTableSortSpecs

访问表格排序元数据,并确认应用已完成排序。

viewImGuiTextFilter

查看文本过滤器构建后的包含项数量。

viewImGuiViewport

访问原生视口标识及显示区域、工作区域几何。

Viewport_GetCenter

获取视口中心。

Viewport_GetWorkCenter

计算视口工作区的中心,排除菜单栏等预留区域。

VSliderFloat

使用垂直滑块编辑浮点值。

VSliderFloatEx

使用垂直滑块编辑浮点值。

VSliderInt

使用垂直滑块编辑整数值。

VSliderIntEx

使用垂直滑块编辑整数值。

VSliderScalar

使用垂直滑块编辑指定数据类型的单个数值。

VSliderScalarEx

使用垂直滑块编辑指定数据类型的单个数值。

字体与样式

字体图集、字形范围与样式颜色。

全部 API11
getFontAtlas

取出 ImGuiIO 拥有的字体图集。

getGlyphRangesChineseFull

返回完整中文字形范围。

getGlyphRangesChineseSimplifiedCommon

返回常用简体中文字形范围。

getGlyphRangesCyrillic

返回西里尔字形范围。

getGlyphRangesDefault

返回默认字形范围。

getGlyphRangesGreek

返回希腊语字形范围。

getGlyphRangesJapanese

返回日语字形范围。

getGlyphRangesKorean

返回韩语字形范围。

getGlyphRangesThai

返回泰语字形范围。

getGlyphRangesVietnamese

返回越南语字形范围。

getStyleColors

直接读写样式的 RGBA 颜色数组。

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