ImGui

View source
imgui.ImGui (Class)

Static Members

createContext(?sharedFontAtlas: ImFontAtlas = cast 0): ImGuiContext
Name Type Default
sharedFontAtlas ImFontAtlas cast 0
Returns
ImGuiContext
destroyContext(?ctx: ImGuiContext = cast 0): Void
Name Type Default
ctx ImGuiContext cast 0
getCurrentContext(): ImGuiContext
Returns
ImGuiContext
setCurrentContext(ctx: ImGuiContext): Void
Name Type
ctx ImGuiContext
getIO(): ImGuiIO
Returns
ImGuiIO
getPlatformIO(): ImGuiPlatformIO
Returns
ImGuiPlatformIO
getStyle(): ImGuiStyle
Returns
ImGuiStyle
newFrame(): Void
endFrame(): Void
render(): Void
getDrawData(): ImDrawData
Returns
ImDrawData
showIDStackToolWindow(): Void
showStyleEditor(?ref: ImGuiStyle = cast 0): Void
Name Type Default
ref ImGuiStyle cast 0
showStyleSelector(label: String): Bool
Name Type
label String
Returns
Bool
showFontSelector(label: String): Void
Name Type
label String
showUserGuide(): Void
getVersion(): String
Returns
String
styleColorsDark(?dst: ImGuiStyle = cast 0): Void
Name Type Default
dst ImGuiStyle cast 0
styleColorsLight(?dst: ImGuiStyle = cast 0): Void
Name Type Default
dst ImGuiStyle cast 0
styleColorsClassic(?dst: ImGuiStyle = cast 0): Void
Name Type Default
dst ImGuiStyle cast 0
end(): Void
beginChild(strId: String, size: ImVec2, ?childFlags: Int = 0, ?windowFlags: Int = 0): Bool
Name Type Default
strId String
size ImVec2
childFlags Int 0
windowFlags Int 0
Returns
Bool
beginChildID(id: Int, size: ImVec2, ?childFlags: Int = 0, ?windowFlags: Int = 0): Bool
Name Type Default
id Int
size ImVec2
childFlags Int 0
windowFlags Int 0
Returns
Bool
endChild(): Void
isWindowAppearing(): Bool
Returns
Bool
isWindowCollapsed(): Bool
Returns
Bool
isWindowFocused(?flags: Int = 0): Bool
Name Type Default
flags Int 0
Returns
Bool
isWindowHovered(?flags: Int = 0): Bool
Name Type Default
flags Int 0
Returns
Bool
getWindowDrawList(): ImDrawList
Returns
ImDrawList
getWindowDpiScale(): Float
Returns
Float
getWindowPos(): ImVec2
Returns
ImVec2
getWindowSize(): ImVec2
Returns
ImVec2
getWindowWidth(): Float
Returns
Float
getWindowHeight(): Float
Returns
Float
getWindowViewport(): ImGuiViewport
Returns
ImGuiViewport
setNextWindowPosEx(pos: ImVec2, ?cond: Int = 0, pivot: ImVec2): Void
Name Type Default
pos ImVec2
cond Int 0
pivot ImVec2
setNextWindowPos(pos: ImVec2, ?cond: Int = 0): Void
Name Type Default
pos ImVec2
cond Int 0
setNextWindowSize(size: ImVec2, ?cond: Int = 0): Void
Name Type Default
size ImVec2
cond Int 0
setNextWindowSizeConstraints(sizeMin: ImVec2, sizeMax: ImVec2, ?customCallback: Int = 0, ?customCallbackData: Int = 0): Void
Name Type Default
sizeMin ImVec2
sizeMax ImVec2
customCallback Int 0
customCallbackData Int 0
setNextWindowContentSize(size: ImVec2): Void
Name Type
size ImVec2
setNextWindowCollapsed(collapsed: Bool, ?cond: Int = 0): Void
Name Type Default
collapsed Bool
cond Int 0
setNextWindowFocus(): Void
setNextWindowScroll(scroll: ImVec2): Void
Name Type
scroll ImVec2
setNextWindowBgAlpha(alpha: Float): Void
Name Type
alpha Float
setNextWindowViewport(viewportId: Int): Void
Name Type
viewportId Int
setWindowPos(pos: ImVec2, ?cond: Int = 0): Void
Name Type Default
pos ImVec2
cond Int 0
setWindowSize(size: ImVec2, ?cond: Int = 0): Void
Name Type Default
size ImVec2
cond Int 0
setWindowCollapsed(collapsed: Bool, ?cond: Int = 0): Void
Name Type Default
collapsed Bool
cond Int 0
setWindowFocus(): Void
setWindowPosStr(name: String, pos: ImVec2, ?cond: Int = 0): Void
Name Type Default
name String
pos ImVec2
cond Int 0
setWindowSizeStr(name: String, size: ImVec2, ?cond: Int = 0): Void
Name Type Default
name String
size ImVec2
cond Int 0
setWindowCollapsedStr(name: String, collapsed: Bool, ?cond: Int = 0): Void
Name Type Default
name String
collapsed Bool
cond Int 0
setWindowFocusStr(name: String): Void
Name Type
name String
getScrollX(): Float
Returns
Float
getScrollY(): Float
Returns
Float
setScrollX(scrollX: Float): Void
Name Type
scrollX Float
setScrollY(scrollY: Float): Void
Name Type
scrollY Float
getScrollMaxX(): Float
Returns
Float
getScrollMaxY(): Float
Returns
Float
setScrollHereX(?centerXRatio: Float = 0.5): Void
Name Type Default
centerXRatio Float 0.5
setScrollHereY(?centerYRatio: Float = 0.5): Void
Name Type Default
centerYRatio Float 0.5
setScrollFromPosX(localX: Float, ?centerXRatio: Float = 0.5): Void
Name Type Default
localX Float
centerXRatio Float 0.5
setScrollFromPosY(localY: Float, ?centerYRatio: Float = 0.5): Void
Name Type Default
localY Float
centerYRatio Float 0.5
pushFontFloat(font: ImFont, fontSizeBaseUnscaled: Float): Void
Name Type
font ImFont
fontSizeBaseUnscaled Float
popFont(): Void
getFont(): ImFont
Returns
ImFont
getFontSize(): Float
Returns
Float
getFontBaked(): ImFontBaked
Returns
ImFontBaked
pushStyleColor(idx: Int, col: Int): Void
Name Type
idx Int
col Int
pushStyleColorImVec4(idx: Int, col: ImVec4): Void
Name Type
idx Int
col ImVec4
popStyleColorEx(?count: Int = 1): Void
Name Type Default
count Int 1
popStyleColor(): Void
pushStyleVar(idx: Int, val: Float): Void
Name Type
idx Int
val Float
pushStyleVarImVec2(idx: Int, val: ImVec2): Void
Name Type
idx Int
val ImVec2
pushStyleVarX(idx: Int, valX: Float): Void
Name Type
idx Int
valX Float
pushStyleVarY(idx: Int, valY: Float): Void
Name Type
idx Int
valY Float
popStyleVarEx(?count: Int = 1): Void
Name Type Default
count Int 1
popStyleVar(): Void
pushItemFlag(option: Int, enabled: Bool): Void
Name Type
option Int
enabled Bool
popItemFlag(): Void
pushItemWidth(itemWidth: Float): Void
Name Type
itemWidth Float
popItemWidth(): Void
setNextItemWidth(itemWidth: Float): Void
Name Type
itemWidth Float
calcItemWidth(): Float
Returns
Float
pushTextWrapPos(?wrapLocalPosX: Float = 0.0): Void
Name Type Default
wrapLocalPosX Float 0.0
popTextWrapPos(): Void
getFontTexUvWhitePixel(): ImVec2
Returns
ImVec2
getColorU32Ex(idx: Int, ?alphaMul: Float = 1.0): Int
Name Type Default
idx Int
alphaMul Float 1.0
Returns
Int
getColorU32(idx: Int): Int
Name Type
idx Int
Returns
Int
getColorU32ImVec4(col: ImVec4): Int
Name Type
col ImVec4
Returns
Int
getColorU32ImU32Ex(col: Int, ?alphaMul: Float = 1.0): Int
Name Type Default
col Int
alphaMul Float 1.0
Returns
Int
getColorU32ImU32(col: Int): Int
Name Type
col Int
Returns
Int
getStyleColorVec4(idx: Int): Int
Name Type
idx Int
Returns
Int
getCursorScreenPos(): ImVec2
Returns
ImVec2
setCursorScreenPos(pos: ImVec2): Void
Name Type
pos ImVec2
getContentRegionAvail(): ImVec2
Returns
ImVec2
getCursorPos(): ImVec2
Returns
ImVec2
getCursorPosX(): Float
Returns
Float
getCursorPosY(): Float
Returns
Float
setCursorPos(localPos: ImVec2): Void
Name Type
localPos ImVec2
setCursorPosX(localX: Float): Void
Name Type
localX Float
setCursorPosY(localY: Float): Void
Name Type
localY Float
getCursorStartPos(): ImVec2
Returns
ImVec2
separator(): Void
sameLineEx(?offsetFromStartX: Float = 0.0, ?spacing: Float = -1.0): Void
Name Type Default
offsetFromStartX Float 0.0
spacing Float -1.0
sameLine(): Void
newLine(): Void
spacing(): Void
dummy(size: ImVec2): Void
Name Type
size ImVec2
indentEx(?indentW: Float = 0.0): Void
Name Type Default
indentW Float 0.0
indent(): Void
unindentEx(?indentW: Float = 0.0): Void
Name Type Default
indentW Float 0.0
unindent(): Void
beginGroup(): Void
endGroup(): Void
alignTextToFramePadding(): Void
getTextLineHeight(): Float
Returns
Float
getTextLineHeightWithSpacing(): Float
Returns
Float
getFrameHeight(): Float
Returns
Float
getFrameHeightWithSpacing(): Float
Returns
Float
pushID(strId: String): Void
Name Type
strId String
pushIDStr(strIdBegin: String, strIdEnd: String): Void
Name Type
strIdBegin String
strIdEnd String
pushIDPtr(ptrId: Int): Void
Name Type
ptrId Int
pushIDInt(intId: Int): Void
Name Type
intId Int
popID(): Void
getID(strId: String): Int
Name Type
strId String
Returns
Int
getIDStr(strIdBegin: String, strIdEnd: String): Int
Name Type
strIdBegin String
strIdEnd String
Returns
Int
getIDPtr(ptrId: Int): Int
Name Type
ptrId Int
Returns
Int
getIDInt(intId: Int): Int
Name Type
intId Int
Returns
Int
text(text: String, ?textEnd: String = null): Void
Name Type Default
text String
textEnd String null
textUnformatted(text: String): Void
Name Type
text String
textColored(col: ImVec4, text: String): Void
Name Type
col ImVec4
text String
textDisabled(text: String): Void
Name Type
text String
textWrapped(text: String): Void
Name Type
text String
labelText(label: String, text: String): Void
Name Type
label String
text String
bulletText(text: String): Void
Name Type
text String
separatorText(label: String): Void
Name Type
label String
buttonEx(label: String, size: ImVec2): Bool
Name Type
label String
size ImVec2
Returns
Bool
button(label: String): Bool
Name Type
label String
Returns
Bool
smallButton(label: String): Bool
Name Type
label String
Returns
Bool
invisibleButton(strId: String, size: ImVec2, ?flags: Int = 0): Bool
Name Type Default
strId String
size ImVec2
flags Int 0
Returns
Bool
arrowButton(strId: String, dir: Int): Bool
Name Type
strId String
dir Int
Returns
Bool
radioButton(label: String, active: Bool): Bool
Name Type
label String
active Bool
Returns
Bool
progressBar(fraction: Float, sizeArg: ImVec2, ?overlay: String = null): Void
Name Type Default
fraction Float
sizeArg ImVec2
overlay String null
bullet(): Void
Name Type
label String
Returns
Bool
textLinkOpenURLEx(label: String, ?url: String = null): Bool
Name Type Default
label String
url String null
Returns
Bool
textLinkOpenURL(label: String): Bool
Name Type
label String
Returns
Bool
imageEx(texRef: ImTextureRef, imageSize: ImVec2, uv0: ImVec2, uv1: ImVec2): Void
Name Type
texRef ImTextureRef
imageSize ImVec2
uv0 ImVec2
uv1 ImVec2
image(texRef: ImTextureRef, imageSize: ImVec2): Void
Name Type
texRef ImTextureRef
imageSize ImVec2
imageWithBgEx(texRef: ImTextureRef, imageSize: ImVec2, uv0: ImVec2, uv1: ImVec2, bgCol: ImVec4, tintCol: ImVec4): Void
Name Type
texRef ImTextureRef
imageSize ImVec2
uv0 ImVec2
uv1 ImVec2
bgCol ImVec4
tintCol ImVec4
imageWithBg(texRef: ImTextureRef, imageSize: ImVec2): Void
Name Type
texRef ImTextureRef
imageSize ImVec2
imageButtonEx(strId: String, texRef: ImTextureRef, imageSize: ImVec2, uv0: ImVec2, uv1: ImVec2, bgCol: ImVec4, tintCol: ImVec4): Bool
Name Type
strId String
texRef ImTextureRef
imageSize ImVec2
uv0 ImVec2
uv1 ImVec2
bgCol ImVec4
tintCol ImVec4
Returns
Bool
imageButton(strId: String, texRef: ImTextureRef, imageSize: ImVec2): Bool
Name Type
strId String
texRef ImTextureRef
imageSize ImVec2
Returns
Bool
beginCombo(label: String, previewValue: String, ?flags: Int = 0): Bool
Name Type Default
label String
previewValue String
flags Int 0
Returns
Bool
endCombo(): Void
comboCharEx(label: String, currentItem: Int, items: Int, itemsCount: Int, ?popupMaxHeightInItems: Int = -1): Bool
Name Type Default
label String
currentItem Int
items Int
itemsCount Int
popupMaxHeightInItems Int -1
Returns
Bool
comboChar(label: String, currentItem: Int, items: Int, itemsCount: Int): Bool
Name Type
label String
currentItem Int
items Int
itemsCount Int
Returns
Bool
comboCallbackEx(label: String, currentItem: Int, getter: Int, userData: Int, itemsCount: Int, ?popupMaxHeightInItems: Int = -1): Bool
Name Type Default
label String
currentItem Int
getter Int
userData Int
itemsCount Int
popupMaxHeightInItems Int -1
Returns
Bool
comboCallback(label: String, currentItem: Int, getter: Int, userData: Int, itemsCount: Int): Bool
Name Type
label String
currentItem Int
getter Int
userData Int
itemsCount Int
Returns
Bool
dragFloat2Ex(label: String, v: Array<Float>, ?vSpeed: Float = 1.0, ?vMin: Float = 0.0, ?vMax: Float = 0.0, ?format: String = "%.3f", ?flags: Int = 0): Bool
Name Type Default
label String
v Array<Float>
vSpeed Float 1.0
vMin Float 0.0
vMax Float 0.0
format String "%.3f"
flags Int 0
Returns
Bool
dragFloat2(label: String, v: Array<Float>): Bool
Name Type
label String
v Array<Float>
Returns
Bool
dragFloat3Ex(label: String, v: Array<Float>, ?vSpeed: Float = 1.0, ?vMin: Float = 0.0, ?vMax: Float = 0.0, ?format: String = "%.3f", ?flags: Int = 0): Bool
Name Type Default
label String
v Array<Float>
vSpeed Float 1.0
vMin Float 0.0
vMax Float 0.0
format String "%.3f"
flags Int 0
Returns
Bool
dragFloat3(label: String, v: Array<Float>): Bool
Name Type
label String
v Array<Float>
Returns
Bool
dragFloat4Ex(label: String, v: Array<Float>, ?vSpeed: Float = 1.0, ?vMin: Float = 0.0, ?vMax: Float = 0.0, ?format: String = "%.3f", ?flags: Int = 0): Bool
Name Type Default
label String
v Array<Float>
vSpeed Float 1.0
vMin Float 0.0
vMax Float 0.0
format String "%.3f"
flags Int 0
Returns
Bool
dragFloat4(label: String, v: Array<Float>): Bool
Name Type
label String
v Array<Float>
Returns
Bool
dragInt2Ex(label: String, v: Array<Int>, ?vSpeed: Float = 1.0, ?vMin: Int = 0, ?vMax: Int = 0, ?format: String = "%d", ?flags: Int = 0): Bool
Name Type Default
label String
v Array<Int>
vSpeed Float 1.0
vMin Int 0
vMax Int 0
format String "%d"
flags Int 0
Returns
Bool
dragInt2(label: String, v: Array<Int>): Bool
Name Type
label String
v Array<Int>
Returns
Bool
dragInt3Ex(label: String, v: Array<Int>, ?vSpeed: Float = 1.0, ?vMin: Int = 0, ?vMax: Int = 0, ?format: String = "%d", ?flags: Int = 0): Bool
Name Type Default
label String
v Array<Int>
vSpeed Float 1.0
vMin Int 0
vMax Int 0
format String "%d"
flags Int 0
Returns
Bool
dragInt3(label: String, v: Array<Int>): Bool
Name Type
label String
v Array<Int>
Returns
Bool
dragInt4Ex(label: String, v: Array<Int>, ?vSpeed: Float = 1.0, ?vMin: Int = 0, ?vMax: Int = 0, ?format: String = "%d", ?flags: Int = 0): Bool
Name Type Default
label String
v Array<Int>
vSpeed Float 1.0
vMin Int 0
vMax Int 0
format String "%d"
flags Int 0
Returns
Bool
dragInt4(label: String, v: Array<Int>): Bool
Name Type
label String
v Array<Int>
Returns
Bool
dragScalarEx(label: String, dataType: Int, pData: Int, ?vSpeed: Float = 1.0, ?pMin: Int = 0, ?pMax: Int = 0, ?format: String = null, ?flags: Int = 0): Bool
Name Type Default
label String
dataType Int
pData Int
vSpeed Float 1.0
pMin Int 0
pMax Int 0
format String null
flags Int 0
Returns
Bool
dragScalar(label: String, dataType: Int, pData: Int): Bool
Name Type
label String
dataType Int
pData Int
Returns
Bool
dragScalarNEx(label: String, dataType: Int, pData: Int, components: Int, ?vSpeed: Float = 1.0, ?pMin: Int = 0, ?pMax: Int = 0, ?format: String = null, ?flags: Int = 0): Bool
Name Type Default
label String
dataType Int
pData Int
components Int
vSpeed Float 1.0
pMin Int 0
pMax Int 0
format String null
flags Int 0
Returns
Bool
dragScalarN(label: String, dataType: Int, pData: Int, components: Int): Bool
Name Type
label String
dataType Int
pData Int
components Int
Returns
Bool
sliderFloat2Ex(label: String, v: Array<Float>, vMin: Float, vMax: Float, ?format: String = "%.3f", ?flags: Int = 0): Bool
Name Type Default
label String
v Array<Float>
vMin Float
vMax Float
format String "%.3f"
flags Int 0
Returns
Bool
sliderFloat2(label: String, v: Array<Float>, vMin: Float, vMax: Float): Bool
Name Type
label String
v Array<Float>
vMin Float
vMax Float
Returns
Bool
sliderFloat3Ex(label: String, v: Array<Float>, vMin: Float, vMax: Float, ?format: String = "%.3f", ?flags: Int = 0): Bool
Name Type Default
label String
v Array<Float>
vMin Float
vMax Float
format String "%.3f"
flags Int 0
Returns
Bool
sliderFloat3(label: String, v: Array<Float>, vMin: Float, vMax: Float): Bool
Name Type
label String
v Array<Float>
vMin Float
vMax Float
Returns
Bool
sliderFloat4Ex(label: String, v: Array<Float>, vMin: Float, vMax: Float, ?format: String = "%.3f", ?flags: Int = 0): Bool
Name Type Default
label String
v Array<Float>
vMin Float
vMax Float
format String "%.3f"
flags Int 0
Returns
Bool
sliderFloat4(label: String, v: Array<Float>, vMin: Float, vMax: Float): Bool
Name Type
label String
v Array<Float>
vMin Float
vMax Float
Returns
Bool
sliderInt2Ex(label: String, v: Array<Int>, vMin: Int, vMax: Int, ?format: String = "%d", ?flags: Int = 0): Bool
Name Type Default
label String
v Array<Int>
vMin Int
vMax Int
format String "%d"
flags Int 0
Returns
Bool
sliderInt2(label: String, v: Array<Int>, vMin: Int, vMax: Int): Bool
Name Type
label String
v Array<Int>
vMin Int
vMax Int
Returns
Bool
sliderInt3Ex(label: String, v: Array<Int>, vMin: Int, vMax: Int, ?format: String = "%d", ?flags: Int = 0): Bool
Name Type Default
label String
v Array<Int>
vMin Int
vMax Int
format String "%d"
flags Int 0
Returns
Bool
sliderInt3(label: String, v: Array<Int>, vMin: Int, vMax: Int): Bool
Name Type
label String
v Array<Int>
vMin Int
vMax Int
Returns
Bool
sliderInt4Ex(label: String, v: Array<Int>, vMin: Int, vMax: Int, ?format: String = "%d", ?flags: Int = 0): Bool
Name Type Default
label String
v Array<Int>
vMin Int
vMax Int
format String "%d"
flags Int 0
Returns
Bool
sliderInt4(label: String, v: Array<Int>, vMin: Int, vMax: Int): Bool
Name Type
label String
v Array<Int>
vMin Int
vMax Int
Returns
Bool
sliderScalarEx(label: String, dataType: Int, pData: Int, pMin: Int, pMax: Int, ?format: String = null, ?flags: Int = 0): Bool
Name Type Default
label String
dataType Int
pData Int
pMin Int
pMax Int
format String null
flags Int 0
Returns
Bool
sliderScalar(label: String, dataType: Int, pData: Int, pMin: Int, pMax: Int): Bool
Name Type
label String
dataType Int
pData Int
pMin Int
pMax Int
Returns
Bool
sliderScalarNEx(label: String, dataType: Int, pData: Int, components: Int, pMin: Int, pMax: Int, ?format: String = null, ?flags: Int = 0): Bool
Name Type Default
label String
dataType Int
pData Int
components Int
pMin Int
pMax Int
format String null
flags Int 0
Returns
Bool
sliderScalarN(label: String, dataType: Int, pData: Int, components: Int, pMin: Int, pMax: Int): Bool
Name Type
label String
dataType Int
pData Int
components Int
pMin Int
pMax Int
Returns
Bool
vSliderScalarEx(label: String, size: ImVec2, dataType: Int, pData: Int, pMin: Int, pMax: Int, ?format: String = null, ?flags: Int = 0): Bool
Name Type Default
label String
size ImVec2
dataType Int
pData Int
pMin Int
pMax Int
format String null
flags Int 0
Returns
Bool
vSliderScalar(label: String, size: ImVec2, dataType: Int, pData: Int, pMin: Int, pMax: Int): Bool
Name Type
label String
size ImVec2
dataType Int
pData Int
pMin Int
pMax Int
Returns
Bool
inputFloat2Ex(label: String, v: Array<Float>, ?format: String = "%.3f", ?flags: Int = 0): Bool
Name Type Default
label String
v Array<Float>
format String "%.3f"
flags Int 0
Returns
Bool
inputFloat2(label: String, v: Array<Float>): Bool
Name Type
label String
v Array<Float>
Returns
Bool
inputFloat3Ex(label: String, v: Array<Float>, ?format: String = "%.3f", ?flags: Int = 0): Bool
Name Type Default
label String
v Array<Float>
format String "%.3f"
flags Int 0
Returns
Bool
inputFloat3(label: String, v: Array<Float>): Bool
Name Type
label String
v Array<Float>
Returns
Bool
inputFloat4Ex(label: String, v: Array<Float>, ?format: String = "%.3f", ?flags: Int = 0): Bool
Name Type Default
label String
v Array<Float>
format String "%.3f"
flags Int 0
Returns
Bool
inputFloat4(label: String, v: Array<Float>): Bool
Name Type
label String
v Array<Float>
Returns
Bool
inputInt2(label: String, v: Array<Int>, ?flags: Int = 0): Bool
Name Type Default
label String
v Array<Int>
flags Int 0
Returns
Bool
inputInt3(label: String, v: Array<Int>, ?flags: Int = 0): Bool
Name Type Default
label String
v Array<Int>
flags Int 0
Returns
Bool
inputInt4(label: String, v: Array<Int>, ?flags: Int = 0): Bool
Name Type Default
label String
v Array<Int>
flags Int 0
Returns
Bool
inputScalarEx(label: String, dataType: Int, pData: Int, ?pStep: Int = 0, ?pStepFast: Int = 0, ?format: String = null, ?flags: Int = 0): Bool
Name Type Default
label String
dataType Int
pData Int
pStep Int 0
pStepFast Int 0
format String null
flags Int 0
Returns
Bool
inputScalar(label: String, dataType: Int, pData: Int): Bool
Name Type
label String
dataType Int
pData Int
Returns
Bool
inputScalarNEx(label: String, dataType: Int, pData: Int, components: Int, ?pStep: Int = 0, ?pStepFast: Int = 0, ?format: String = null, ?flags: Int = 0): Bool
Name Type Default
label String
dataType Int
pData Int
components Int
pStep Int 0
pStepFast Int 0
format String null
flags Int 0
Returns
Bool
inputScalarN(label: String, dataType: Int, pData: Int, components: Int): Bool
Name Type
label String
dataType Int
pData Int
components Int
Returns
Bool
colorEdit3(label: String, col: Array<Float>, ?flags: Int = 0): Bool
Name Type Default
label String
col Array<Float>
flags Int 0
Returns
Bool
colorEdit4(label: String, col: Array<Float>, ?flags: Int = 0): Bool
Name Type Default
label String
col Array<Float>
flags Int 0
Returns
Bool
colorPicker3(label: String, col: Array<Float>, ?flags: Int = 0): Bool
Name Type Default
label String
col Array<Float>
flags Int 0
Returns
Bool
colorPicker4(label: String, col: Array<Float>, ?flags: Int = 0, ?refCol: Int = 0): Bool
Name Type Default
label String
col Array<Float>
flags Int 0
refCol Int 0
Returns
Bool
colorButtonEx(descId: String, col: ImVec4, ?flags: Int = 0, size: ImVec2): Bool
Name Type Default
descId String
col ImVec4
flags Int 0
size ImVec2
Returns
Bool
colorButton(descId: String, col: ImVec4, ?flags: Int = 0): Bool
Name Type Default
descId String
col ImVec4
flags Int 0
Returns
Bool
setColorEditOptions(flags: Int): Void
Name Type
flags Int
treeNode(label: String): Bool
Name Type
label String
Returns
Bool
treeNodeStr(strId: String, text: String): Bool
Name Type
strId String
text String
Returns
Bool
treeNodePtr(ptrId: Int, text: String): Bool
Name Type
ptrId Int
text String
Returns
Bool
treeNodeEx(label: String, ?flags: Int = 0): Bool
Name Type Default
label String
flags Int 0
Returns
Bool
treeNodeExStr(strId: String, flags: Int, text: String): Bool
Name Type
strId String
flags Int
text String
Returns
Bool
treeNodeExPtr(ptrId: Int, flags: Int, text: String): Bool
Name Type
ptrId Int
flags Int
text String
Returns
Bool
treePush(strId: String): Void
Name Type
strId String
treePushPtr(ptrId: Int): Void
Name Type
ptrId Int
treePop(): Void
getTreeNodeToLabelSpacing(): Float
Returns
Float
collapsingHeader(label: String, ?flags: Int = 0): Bool
Name Type Default
label String
flags Int 0
Returns
Bool
setNextItemOpen(isOpen: Bool, ?cond: Int = 0): Void
Name Type Default
isOpen Bool
cond Int 0
setNextItemStorageID(storageId: Int): Void
Name Type
storageId Int
treeNodeGetOpen(storageId: Int): Bool
Name Type
storageId Int
Returns
Bool
selectableEx(label: String, ?selected: Bool = false, ?flags: Int = 0, size: ImVec2): Bool
Name Type Default
label String
selected Bool false
flags Int 0
size ImVec2
Returns
Bool
selectable(label: String): Bool
Name Type
label String
Returns
Bool
beginMultiSelectEx(flags: Int, ?selectionSize: Int = -1, ?itemsCount: Int = -1): ImGuiMultiSelectIO
Name Type Default
flags Int
selectionSize Int -1
itemsCount Int -1
Returns
ImGuiMultiSelectIO
beginMultiSelect(flags: Int): ImGuiMultiSelectIO
Name Type
flags Int
Returns
ImGuiMultiSelectIO
endMultiSelect(): ImGuiMultiSelectIO
Returns
ImGuiMultiSelectIO
setNextItemSelectionUserData(selectionUserData: Float): Void
Name Type
selectionUserData Float
isItemToggledSelection(): Bool
Returns
Bool
beginListBox(label: String, size: ImVec2): Bool
Name Type
label String
size ImVec2
Returns
Bool
endListBox(): Void
listBox(label: String, currentItem: Int, items: Int, itemsCount: Int, ?heightInItems: Int = -1): Bool
Name Type Default
label String
currentItem Int
items Int
itemsCount Int
heightInItems Int -1
Returns
Bool
listBoxCallbackEx(label: String, currentItem: Int, getter: Int, userData: Int, itemsCount: Int, ?heightInItems: Int = -1): Bool
Name Type Default
label String
currentItem Int
getter Int
userData Int
itemsCount Int
heightInItems Int -1
Returns
Bool
listBoxCallback(label: String, currentItem: Int, getter: Int, userData: Int, itemsCount: Int): Bool
Name Type
label String
currentItem Int
getter Int
userData Int
itemsCount Int
Returns
Bool
plotLinesEx(label: String, values: Array<Float>, ?valuesOffset: Int = 0, ?overlayText: String = null, ?scaleMin: Float = 3.402823466e+38, ?scaleMax: Float = 3.402823466e+38, graphSize: ImVec2, ?stride: Int = 4): Void
Name Type Default
label String
values Array<Float>
valuesOffset Int 0
overlayText String null
scaleMin Float 3.402823466e+38
scaleMax Float 3.402823466e+38
graphSize ImVec2
stride Int 4
plotLines(label: String, values: Array<Float>): Void
Name Type
label String
values Array<Float>
plotLinesCallbackEx(label: String, valuesGetter: Int, data: Int, valuesCount: Int, ?valuesOffset: Int = 0, ?overlayText: String = null, ?scaleMin: Float = 3.402823466e+38, ?scaleMax: Float = 3.402823466e+38, graphSize: ImVec2): Void
Name Type Default
label String
valuesGetter Int
data Int
valuesCount Int
valuesOffset Int 0
overlayText String null
scaleMin Float 3.402823466e+38
scaleMax Float 3.402823466e+38
graphSize ImVec2
plotLinesCallback(label: String, valuesGetter: Int, data: Int, valuesCount: Int): Void
Name Type
label String
valuesGetter Int
data Int
valuesCount Int
plotHistogramEx(label: String, values: Array<Float>, ?valuesOffset: Int = 0, ?overlayText: String = null, ?scaleMin: Float = 3.402823466e+38, ?scaleMax: Float = 3.402823466e+38, graphSize: ImVec2, ?stride: Int = 4): Void
Name Type Default
label String
values Array<Float>
valuesOffset Int 0
overlayText String null
scaleMin Float 3.402823466e+38
scaleMax Float 3.402823466e+38
graphSize ImVec2
stride Int 4
plotHistogram(label: String, values: Array<Float>): Void
Name Type
label String
values Array<Float>
plotHistogramCallbackEx(label: String, valuesGetter: Int, data: Int, valuesCount: Int, ?valuesOffset: Int = 0, ?overlayText: String = null, ?scaleMin: Float = 3.402823466e+38, ?scaleMax: Float = 3.402823466e+38, graphSize: ImVec2): Void
Name Type Default
label String
valuesGetter Int
data Int
valuesCount Int
valuesOffset Int 0
overlayText String null
scaleMin Float 3.402823466e+38
scaleMax Float 3.402823466e+38
graphSize ImVec2
plotHistogramCallback(label: String, valuesGetter: Int, data: Int, valuesCount: Int): Void
Name Type
label String
valuesGetter Int
data Int
valuesCount Int
beginMenuBar(): Bool
Returns
Bool
endMenuBar(): Void
beginMainMenuBar(): Bool
Returns
Bool
endMainMenuBar(): Void
beginMenuEx(label: String, ?enabled: Bool = true): Bool
Name Type Default
label String
enabled Bool true
Returns
Bool
beginMenu(label: String): Bool
Name Type
label String
Returns
Bool
endMenu(): Void
Name Type Default
label String
shortcut String null
selected Bool false
enabled Bool true
Returns
Bool
Name Type
label String
Returns
Bool
beginTooltip(): Bool
Returns
Bool
endTooltip(): Void
setTooltip(text: String): Void
Name Type
text String
beginItemTooltip(): Bool
Returns
Bool
setItemTooltip(text: String): Void
Name Type
text String
beginPopup(strId: String, ?flags: Int = 0): Bool
Name Type Default
strId String
flags Int 0
Returns
Bool
endPopup(): Void
openPopup(strId: String, ?popupFlags: Int = 0): Void
Name Type Default
strId String
popupFlags Int 0
openPopupID(id: Int, ?popupFlags: Int = 0): Void
Name Type Default
id Int
popupFlags Int 0
openPopupOnItemClick(?strId: String = null, ?popupFlags: Int = 0): Void
Name Type Default
strId String null
popupFlags Int 0
closeCurrentPopup(): Void
beginPopupContextItemEx(?strId: String = null, ?popupFlags: Int = 0): Bool
Name Type Default
strId String null
popupFlags Int 0
Returns
Bool
beginPopupContextItem(): Bool
Returns
Bool
beginPopupContextWindowEx(?strId: String = null, ?popupFlags: Int = 0): Bool
Name Type Default
strId String null
popupFlags Int 0
Returns
Bool
beginPopupContextWindow(): Bool
Returns
Bool
beginPopupContextVoidEx(?strId: String = null, ?popupFlags: Int = 0): Bool
Name Type Default
strId String null
popupFlags Int 0
Returns
Bool
beginPopupContextVoid(): Bool
Returns
Bool
isPopupOpen(strId: String, ?flags: Int = 0): Bool
Name Type Default
strId String
flags Int 0
Returns
Bool
beginTableEx(strId: String, columns: Int, ?flags: Int = 0, outerSize: ImVec2, ?innerWidth: Float = 0.0): Bool
Name Type Default
strId String
columns Int
flags Int 0
outerSize ImVec2
innerWidth Float 0.0
Returns
Bool
beginTable(strId: String, columns: Int, ?flags: Int = 0): Bool
Name Type Default
strId String
columns Int
flags Int 0
Returns
Bool
endTable(): Void
tableNextRowEx(?rowFlags: Int = 0, ?minRowHeight: Float = 0.0): Void
Name Type Default
rowFlags Int 0
minRowHeight Float 0.0
tableNextRow(): Void
tableNextColumn(): Bool
Returns
Bool
tableSetColumnIndex(columnN: Int): Bool
Name Type
columnN Int
Returns
Bool
tableSetupColumnEx(label: String, ?flags: Int = 0, ?initWidthOrWeight: Float = 0.0, ?userId: Int = 0): Void
Name Type Default
label String
flags Int 0
initWidthOrWeight Float 0.0
userId Int 0
tableSetupColumn(label: String, ?flags: Int = 0): Void
Name Type Default
label String
flags Int 0
tableSetupScrollFreeze(cols: Int, rows: Int): Void
Name Type
cols Int
rows Int
tableHeader(label: String): Void
Name Type
label String
tableHeadersRow(): Void
tableAngledHeadersRow(): Void
tableGetSortSpecs(): ImGuiTableSortSpecs
Returns
ImGuiTableSortSpecs
tableGetColumnCount(): Int
Returns
Int
tableGetColumnIndex(): Int
Returns
Int
tableGetRowIndex(): Int
Returns
Int
tableGetColumnName(?columnN: Int = -1): String
Name Type Default
columnN Int -1
Returns
String
tableGetColumnFlags(?columnN: Int = -1): Int
Name Type Default
columnN Int -1
Returns
Int
tableSetColumnEnabled(columnN: Int, v: Bool): Void
Name Type
columnN Int
v Bool
tableGetHoveredColumn(): Int
Returns
Int
tableSetBgColor(target: Int, color: Int, ?columnN: Int = -1): Void
Name Type Default
target Int
color Int
columnN Int -1
columnsEx(?count: Int = 1, ?id: String = null, ?borders: Bool = true): Void
Name Type Default
count Int 1
id String null
borders Bool true
columns(): Void
nextColumn(): Void
getColumnIndex(): Int
Returns
Int
getColumnWidth(?columnIndex: Int = -1): Float
Name Type Default
columnIndex Int -1
Returns
Float
setColumnWidth(columnIndex: Int, width: Float): Void
Name Type
columnIndex Int
width Float
getColumnOffset(?columnIndex: Int = -1): Float
Name Type Default
columnIndex Int -1
Returns
Float
setColumnOffset(columnIndex: Int, offsetX: Float): Void
Name Type
columnIndex Int
offsetX Float
getColumnsCount(): Int
Returns
Int
beginTabBar(strId: String, ?flags: Int = 0): Bool
Name Type Default
strId String
flags Int 0
Returns
Bool
endTabBar(): Void
endTabItem(): Void
tabItemButton(label: String, ?flags: Int = 0): Bool
Name Type Default
label String
flags Int 0
Returns
Bool
setTabItemClosed(tabOrDockedWindowLabel: String): Void
Name Type
tabOrDockedWindowLabel String
dockSpaceEx(dockspaceId: Int, size: ImVec2, ?flags: Int = 0, ?windowClass: ImGuiWindowClass = cast 0): Int
Name Type Default
dockspaceId Int
size ImVec2
flags Int 0
windowClass ImGuiWindowClass cast 0
Returns
Int
dockSpace(dockspaceId: Int): Int
Name Type
dockspaceId Int
Returns
Int
dockSpaceOverViewportEx(?dockspaceId: Int = 0, ?viewport: ImGuiViewport = cast 0, ?flags: Int = 0, ?windowClass: ImGuiWindowClass = cast 0): Int
Name Type Default
dockspaceId Int 0
viewport ImGuiViewport cast 0
flags Int 0
windowClass ImGuiWindowClass cast 0
Returns
Int
dockSpaceOverViewport(): Int
Returns
Int
setNextWindowDockID(dockId: Int, ?cond: Int = 0): Void
Name Type Default
dockId Int
cond Int 0
setNextWindowClass(windowClass: ImGuiWindowClass): Void
Name Type
windowClass ImGuiWindowClass
getWindowDockID(): Int
Returns
Int
isWindowDocked(): Bool
Returns
Bool
logToTTY(?autoOpenDepth: Int = -1): Void
Name Type Default
autoOpenDepth Int -1
logToFile(?autoOpenDepth: Int = -1, ?filename: String = null): Void
Name Type Default
autoOpenDepth Int -1
filename String null
logToClipboard(?autoOpenDepth: Int = -1): Void
Name Type Default
autoOpenDepth Int -1
logFinish(): Void
logButtons(): Void
logText(text: String): Void
Name Type
text String
beginDragDropSource(?flags: Int = 0): Bool
Name Type Default
flags Int 0
Returns
Bool
setDragDropPayload(type: String, data: Int, sz: Int, ?cond: Int = 0): Bool
Name Type Default
type String
data Int
sz Int
cond Int 0
Returns
Bool
endDragDropSource(): Void
beginDragDropTarget(): Bool
Returns
Bool
acceptDragDropPayload(type: String, ?flags: Int = 0): ImGuiPayload
Name Type Default
type String
flags Int 0
Returns
ImGuiPayload
endDragDropTarget(): Void
getDragDropPayload(): ImGuiPayload
Returns
ImGuiPayload
beginDisabled(?disabled: Bool = true): Void
Name Type Default
disabled Bool true
endDisabled(): Void
pushClipRect(clipRectMin: ImVec2, clipRectMax: ImVec2, intersectWithCurrentClipRect: Bool): Void
Name Type
clipRectMin ImVec2
clipRectMax ImVec2
intersectWithCurrentClipRect Bool
popClipRect(): Void
setItemDefaultFocus(): Void
setKeyboardFocusHereEx(?offset: Int = 0): Void
Name Type Default
offset Int 0
setKeyboardFocusHere(): Void
setNavCursorVisible(visible: Bool): Void
Name Type
visible Bool
setNextItemAllowOverlap(): Void
isItemHovered(?flags: Int = 0): Bool
Name Type Default
flags Int 0
Returns
Bool
isItemActive(): Bool
Returns
Bool
isItemFocused(): Bool
Returns
Bool
isItemClickedEx(?mouseButton: Int = 0): Bool
Name Type Default
mouseButton Int 0
Returns
Bool
isItemClicked(): Bool
Returns
Bool
isItemVisible(): Bool
Returns
Bool
isItemEdited(): Bool
Returns
Bool
isItemActivated(): Bool
Returns
Bool
isItemDeactivated(): Bool
Returns
Bool
isItemDeactivatedAfterEdit(): Bool
Returns
Bool
isItemToggledOpen(): Bool
Returns
Bool
isAnyItemHovered(): Bool
Returns
Bool
isAnyItemActive(): Bool
Returns
Bool
isAnyItemFocused(): Bool
Returns
Bool
getItemID(): Int
Returns
Int
getItemRectMin(): ImVec2
Returns
ImVec2
getItemRectMax(): ImVec2
Returns
ImVec2
getItemRectSize(): ImVec2
Returns
ImVec2
getItemFlags(): Int
Returns
Int
getMainViewport(): ImGuiViewport
Returns
ImGuiViewport
getBackgroundDrawListEx(?viewport: ImGuiViewport = cast 0): ImDrawList
Name Type Default
viewport ImGuiViewport cast 0
Returns
ImDrawList
getBackgroundDrawList(): ImDrawList
Returns
ImDrawList
getForegroundDrawListEx(?viewport: ImGuiViewport = cast 0): ImDrawList
Name Type Default
viewport ImGuiViewport cast 0
Returns
ImDrawList
getForegroundDrawList(): ImDrawList
Returns
ImDrawList
isRectVisibleBySize(size: ImVec2): Bool
Name Type
size ImVec2
Returns
Bool
isRectVisible(rectMin: ImVec2, rectMax: ImVec2): Bool
Name Type
rectMin ImVec2
rectMax ImVec2
Returns
Bool
getTime(): Float
Returns
Float
getFrameCount(): Int
Returns
Int
getDrawListSharedData(): ImDrawListSharedData
Returns
ImDrawListSharedData
getStyleColorName(idx: Int): String
Name Type
idx Int
Returns
String
setStateStorage(storage: ImGuiStorage): Void
Name Type
storage ImGuiStorage
getStateStorage(): ImGuiStorage
Returns
ImGuiStorage
calcTextSizeEx(text: String, ?textEnd: String = null, ?hideTextAfterDoubleHash: Bool = false, ?wrapWidth: Float = -1.0): ImVec2
Name Type Default
text String
textEnd String null
hideTextAfterDoubleHash Bool false
wrapWidth Float -1.0
Returns
ImVec2
calcTextSize(text: String): ImVec2
Name Type
text String
Returns
ImVec2
colorConvertU32ToFloat4(in_: Int): ImVec4
Name Type
in_ Int
Returns
ImVec4
colorConvertFloat4ToU32(in_: ImVec4): Int
Name Type
in_ ImVec4
Returns
Int
isKeyDown(key: Int): Bool
Name Type
key Int
Returns
Bool
isKeyPressedEx(key: Int, ?repeat: Bool = true): Bool
Name Type Default
key Int
repeat Bool true
Returns
Bool
isKeyPressed(key: Int): Bool
Name Type
key Int
Returns
Bool
isKeyReleased(key: Int): Bool
Name Type
key Int
Returns
Bool
isKeyChordPressed(keyChord: Int): Bool
Name Type
keyChord Int
Returns
Bool
getKeyPressedAmount(key: Int, repeatDelay: Float, rate: Float): Int
Name Type
key Int
repeatDelay Float
rate Float
Returns
Int
getKeyName(key: Int): String
Name Type
key Int
Returns
String
setNextFrameWantCaptureKeyboard(wantCaptureKeyboard: Bool): Void
Name Type
wantCaptureKeyboard Bool
shortcut(keyChord: Int, ?flags: Int = 0): Bool
Name Type Default
keyChord Int
flags Int 0
Returns
Bool
setNextItemShortcut(keyChord: Int, ?flags: Int = 0): Void
Name Type Default
keyChord Int
flags Int 0
setItemKeyOwner(key: Int): Bool
Name Type
key Int
Returns
Bool
isMouseDown(button: Int): Bool
Name Type
button Int
Returns
Bool
isMouseClickedEx(button: Int, ?repeat: Bool = false): Bool
Name Type Default
button Int
repeat Bool false
Returns
Bool
isMouseClicked(button: Int): Bool
Name Type
button Int
Returns
Bool
isMouseReleased(button: Int): Bool
Name Type
button Int
Returns
Bool
isMouseDoubleClicked(button: Int): Bool
Name Type
button Int
Returns
Bool
isMouseReleasedWithDelay(button: Int, delay: Float): Bool
Name Type
button Int
delay Float
Returns
Bool
getMouseClickedCount(button: Int): Int
Name Type
button Int
Returns
Int
isMouseHoveringRectEx(rMin: ImVec2, rMax: ImVec2, ?clip: Bool = true): Bool
Name Type Default
rMin ImVec2
rMax ImVec2
clip Bool true
Returns
Bool
isMouseHoveringRect(rMin: ImVec2, rMax: ImVec2): Bool
Name Type
rMin ImVec2
rMax ImVec2
Returns
Bool
isMousePosValid(?mousePos: Int = 0): Bool
Name Type Default
mousePos Int 0
Returns
Bool
isAnyMouseDown(): Bool
Returns
Bool
getMousePos(): ImVec2
Returns
ImVec2
getMousePosOnOpeningCurrentPopup(): ImVec2
Returns
ImVec2
isMouseDragging(button: Int, ?lockThreshold: Float = -1.0): Bool
Name Type Default
button Int
lockThreshold Float -1.0
Returns
Bool
getMouseDragDelta(?button: Int = 0, ?lockThreshold: Float = -1.0): ImVec2
Name Type Default
button Int 0
lockThreshold Float -1.0
Returns
ImVec2
resetMouseDragDeltaEx(?button: Int = 0): Void
Name Type Default
button Int 0
resetMouseDragDelta(): Void
getMouseCursor(): Int
Returns
Int
setMouseCursor(cursorType: Int): Void
Name Type
cursorType Int
setNextFrameWantCaptureMouse(wantCaptureMouse: Bool): Void
Name Type
wantCaptureMouse Bool
getClipboardText(): String
Returns
String
setClipboardText(text: String): Void
Name Type
text String
loadIniSettingsFromDisk(iniFilename: String): Void
Name Type
iniFilename String
loadIniSettingsFromMemory(iniData: String, ?iniSize: Int = 0): Void
Name Type Default
iniData String
iniSize Int 0
saveIniSettingsToDisk(iniFilename: String): Void
Name Type
iniFilename String
saveIniSettingsToMemory(?outIniSize: Int = 0): String
Name Type Default
outIniSize Int 0
Returns
String
debugTextEncoding(text: String): Void
Name Type
text String
debugFlashStyleColor(idx: Int): Void
Name Type
idx Int
debugStartItemPicker(): Void
debugCheckVersionAndDataLayout(versionStr: String, szIo: Int, szStyle: Int, szVec2: Int, szVec4: Int, szDrawvert: Int, szDrawidx: Int): Bool
Name Type
versionStr String
szIo Int
szStyle Int
szVec2 Int
szVec4 Int
szDrawvert Int
szDrawidx Int
Returns
Bool
debugLog(text: String): Void
Name Type
text String
setAllocatorFunctions(allocFunc: Int, freeFunc: Int, ?userData: Int = 0): Void
Name Type Default
allocFunc Int
freeFunc Int
userData Int 0
getAllocatorFunctions(pAllocFunc: Int, pFreeFunc: Int, pUserData: Int): Void
Name Type
pAllocFunc Int
pFreeFunc Int
pUserData Int
memAlloc(size: Int): Int
Name Type
size Int
Returns
Int
memFree(ptr: Int): Void
Name Type
ptr Int
updatePlatformWindows(): Void
renderPlatformWindowsDefaultEx(?platformRenderArg: Int = 0, ?rendererRenderArg: Int = 0): Void
Name Type Default
platformRenderArg Int 0
rendererRenderArg Int 0
renderPlatformWindowsDefault(): Void
destroyPlatformWindows(): Void
findViewportByID(viewportId: Int): ImGuiViewport
Name Type
viewportId Int
Returns
ImGuiViewport
findViewportByPlatformHandle(platformHandle: Int): ImGuiViewport
Name Type
platformHandle Int
Returns
ImGuiViewport
imVector_Construct(vector: Int): Void
Name Type
vector Int
imVector_Destruct(vector: Int): Void
Name Type
vector Int
showDemoWindow(?pOpen: Dynamic): Dynamic

create Demo window. demonstrate most ImGui features. call this to learn about the library! try to make it always available in your application!

Name Type Default
pOpen Dynamic (optional)
Returns
Dynamic
showMetricsWindow(?pOpen: Dynamic): Dynamic

create Metrics/Debugger window. display Dear ImGui internals: windows, draw commands, various internal state, etc.

Name Type Default
pOpen Dynamic (optional)
Returns
Dynamic
showDebugLogWindow(?pOpen: Dynamic): Dynamic

create Debug Log window. display a simplified log of important dear imgui events.

Name Type Default
pOpen Dynamic (optional)
Returns
Dynamic
showIDStackToolWindowEx(?pOpen: Dynamic): Dynamic

create Stack Tool window. hover items with mouse to query information about the source of their unique ID.

Name Type Default
pOpen Dynamic (optional)
Returns
Dynamic
showAboutWindow(?pOpen: Dynamic): Dynamic

create About window. display Dear ImGui version, credits and build/system information.

Name Type Default
pOpen Dynamic (optional)
Returns
Dynamic
begin(name: Dynamic, ?pOpen: Dynamic, ?flags: Dynamic): Dynamic
Name Type Default
name Dynamic
pOpen Dynamic (optional)
flags Dynamic (optional)
Returns
Dynamic
checkbox(label: Dynamic, v: Dynamic): Dynamic
Name Type
label Dynamic
v Dynamic
Returns
Dynamic
checkboxFlagsIntPtr(label: Dynamic, flags: Dynamic, flagsValue: Dynamic): Dynamic
Name Type
label Dynamic
flags Dynamic
flagsValue Dynamic
Returns
Dynamic
checkboxFlagsUintPtr(label: Dynamic, flags: Dynamic, flagsValue: Dynamic): Dynamic
Name Type
label Dynamic
flags Dynamic
flagsValue Dynamic
Returns
Dynamic
radioButtonIntPtr(label: Dynamic, v: Dynamic, vButton: Dynamic): Dynamic

shortcut to handle the above pattern when value is an integer

Name Type
label Dynamic
v Dynamic
vButton Dynamic
Returns
Dynamic
comboEx(label: Dynamic, currentItem: Dynamic, itemsSeparatedByZeros: Dynamic, ?popupMaxHeightInItems: Dynamic): Dynamic

Separate items with \0 within a string, end item-list with \0\0. e.g. "One\0Two\0Three\0"

Name Type Default
label Dynamic
currentItem Dynamic
itemsSeparatedByZeros Dynamic
popupMaxHeightInItems Dynamic (optional)
Returns
Dynamic
combo(label: Dynamic, currentItem: Dynamic, itemsSeparatedByZeros: Dynamic): Dynamic

Implied popup_max_height_in_items = -1

Name Type
label Dynamic
currentItem Dynamic
itemsSeparatedByZeros Dynamic
Returns
Dynamic
dragFloatEx(label: Dynamic, v: Dynamic, ?vSpeed: Dynamic, ?vMin: Dynamic, ?vMax: Dynamic, ?format: Dynamic, ?flags: Dynamic): Dynamic

If v_min >= v_max we have no bound

Name Type Default
label Dynamic
v Dynamic
vSpeed Dynamic (optional)
vMin Dynamic (optional)
vMax Dynamic (optional)
format Dynamic (optional)
flags Dynamic (optional)
Returns
Dynamic
dragFloat(label: Dynamic, v: Dynamic): Dynamic

Implied v_speed = 1.0f, v_min = 0.0f, v_max = 0.0f, format = "%.3f", flags = 0

Name Type
label Dynamic
v Dynamic
Returns
Dynamic
dragFloatRange2Ex(label: Dynamic, vCurrentMin: Dynamic, vCurrentMax: Dynamic, ?vSpeed: Dynamic, ?vMin: Dynamic, ?vMax: Dynamic, ?format: Dynamic, ?formatMax: Dynamic, ?flags: Dynamic): Dynamic
Name Type Default
label Dynamic
vCurrentMin Dynamic
vCurrentMax Dynamic
vSpeed Dynamic (optional)
vMin Dynamic (optional)
vMax Dynamic (optional)
format Dynamic (optional)
formatMax Dynamic (optional)
flags Dynamic (optional)
Returns
Dynamic
dragFloatRange2(label: Dynamic, vCurrentMin: Dynamic, vCurrentMax: Dynamic): Dynamic

Implied v_speed = 1.0f, v_min = 0.0f, v_max = 0.0f, format = "%.3f", format_max = NULL, flags = 0

Name Type
label Dynamic
vCurrentMin Dynamic
vCurrentMax Dynamic
Returns
Dynamic
dragIntEx(label: Dynamic, v: Dynamic, ?vSpeed: Dynamic, ?vMin: Dynamic, ?vMax: Dynamic, ?format: Dynamic, ?flags: Dynamic): Dynamic

If v_min >= v_max we have no bound

Name Type Default
label Dynamic
v Dynamic
vSpeed Dynamic (optional)
vMin Dynamic (optional)
vMax Dynamic (optional)
format Dynamic (optional)
flags Dynamic (optional)
Returns
Dynamic
dragInt(label: Dynamic, v: Dynamic): Dynamic

Implied v_speed = 1.0f, v_min = 0, v_max = 0, format = "%d", flags = 0

Name Type
label Dynamic
v Dynamic
Returns
Dynamic
dragIntRange2Ex(label: Dynamic, vCurrentMin: Dynamic, vCurrentMax: Dynamic, ?vSpeed: Dynamic, ?vMin: Dynamic, ?vMax: Dynamic, ?format: Dynamic, ?formatMax: Dynamic, ?flags: Dynamic): Dynamic
Name Type Default
label Dynamic
vCurrentMin Dynamic
vCurrentMax Dynamic
vSpeed Dynamic (optional)
vMin Dynamic (optional)
vMax Dynamic (optional)
format Dynamic (optional)
formatMax Dynamic (optional)
flags Dynamic (optional)
Returns
Dynamic
dragIntRange2(label: Dynamic, vCurrentMin: Dynamic, vCurrentMax: Dynamic): Dynamic

Implied v_speed = 1.0f, v_min = 0, v_max = 0, format = "%d", format_max = NULL, flags = 0

Name Type
label Dynamic
vCurrentMin Dynamic
vCurrentMax Dynamic
Returns
Dynamic
sliderFloatEx(label: Dynamic, v: Dynamic, vMin: Dynamic, vMax: Dynamic, ?format: Dynamic, ?flags: Dynamic): Dynamic

adjust format to decorate the value with a prefix or a suffix for in-slider labels or unit display.

Name Type Default
label Dynamic
v Dynamic
vMin Dynamic
vMax Dynamic
format Dynamic (optional)
flags Dynamic (optional)
Returns
Dynamic
sliderFloat(label: Dynamic, v: Dynamic, vMin: Dynamic, vMax: Dynamic): Dynamic

Implied format = "%.3f", flags = 0

Name Type
label Dynamic
v Dynamic
vMin Dynamic
vMax Dynamic
Returns
Dynamic
sliderAngleEx(label: Dynamic, vRad: Dynamic, ?vDegreesMin: Dynamic, vDegreesMax: Dynamic, ?format: Dynamic, ?flags: Dynamic): Dynamic
Name Type Default
label Dynamic
vRad Dynamic
vDegreesMin Dynamic (optional)
vDegreesMax Dynamic
format Dynamic (optional)
flags Dynamic (optional)
Returns
Dynamic
sliderAngle(label: Dynamic, vRad: Dynamic): Dynamic

Implied v_degrees_min = -360.0f, v_degrees_max = +360.0f, format = "%.0f deg", flags = 0

Name Type
label Dynamic
vRad Dynamic
Returns
Dynamic
sliderIntEx(label: Dynamic, v: Dynamic, vMin: Dynamic, vMax: Dynamic, ?format: Dynamic, ?flags: Dynamic): Dynamic
Name Type Default
label Dynamic
v Dynamic
vMin Dynamic
vMax Dynamic
format Dynamic (optional)
flags Dynamic (optional)
Returns
Dynamic
sliderInt(label: Dynamic, v: Dynamic, vMin: Dynamic, vMax: Dynamic): Dynamic

Implied format = "%d", flags = 0

Name Type
label Dynamic
v Dynamic
vMin Dynamic
vMax Dynamic
Returns
Dynamic
vSliderFloatEx(label: Dynamic, size: Dynamic, v: Dynamic, vMin: Dynamic, vMax: Dynamic, ?format: Dynamic, ?flags: Dynamic): Dynamic
Name Type Default
label Dynamic
size Dynamic
v Dynamic
vMin Dynamic
vMax Dynamic
format Dynamic (optional)
flags Dynamic (optional)
Returns
Dynamic
vSliderFloat(label: Dynamic, size: Dynamic, v: Dynamic, vMin: Dynamic, vMax: Dynamic): Dynamic

Implied format = "%.3f", flags = 0

Name Type
label Dynamic
size Dynamic
v Dynamic
vMin Dynamic
vMax Dynamic
Returns
Dynamic
vSliderIntEx(label: Dynamic, size: Dynamic, v: Dynamic, vMin: Dynamic, vMax: Dynamic, ?format: Dynamic, ?flags: Dynamic): Dynamic
Name Type Default
label Dynamic
size Dynamic
v Dynamic
vMin Dynamic
vMax Dynamic
format Dynamic (optional)
flags Dynamic (optional)
Returns
Dynamic
vSliderInt(label: Dynamic, size: Dynamic, v: Dynamic, vMin: Dynamic, vMax: Dynamic): Dynamic

Implied format = "%d", flags = 0

Name Type
label Dynamic
size Dynamic
v Dynamic
vMin Dynamic
vMax Dynamic
Returns
Dynamic
inputTextEx(label: Dynamic, buf: Dynamic, ?maxLength: Dynamic, ?flags: Dynamic, ?callback: Dynamic, ?userData: Dynamic): Dynamic
Name Type Default
label Dynamic
buf Dynamic
maxLength Dynamic (optional)
flags Dynamic (optional)
callback Dynamic (optional)
userData Dynamic (optional)
Returns
Dynamic
inputText(label: Dynamic, buf: Dynamic, ?maxLength: Dynamic, ?flags: Dynamic): Dynamic

Implied callback = NULL, user_data = NULL

Name Type Default
label Dynamic
buf Dynamic
maxLength Dynamic (optional)
flags Dynamic (optional)
Returns
Dynamic
inputTextMultilineEx(label: Dynamic, buf: Dynamic, ?maxLength: Dynamic, size: Dynamic, ?flags: Dynamic, ?callback: Dynamic, ?userData: Dynamic): Dynamic
Name Type Default
label Dynamic
buf Dynamic
maxLength Dynamic (optional)
size Dynamic
flags Dynamic (optional)
callback Dynamic (optional)
userData Dynamic (optional)
Returns
Dynamic
inputTextMultiline(label: Dynamic, buf: Dynamic, ?maxLength: Dynamic): Dynamic

Implied size = ImVec2(0, 0), flags = 0, callback = NULL, user_data = NULL

Name Type Default
label Dynamic
buf Dynamic
maxLength Dynamic (optional)
Returns
Dynamic
inputTextWithHintEx(label: Dynamic, hint: Dynamic, buf: Dynamic, ?maxLength: Dynamic, ?flags: Dynamic, ?callback: Dynamic, ?userData: Dynamic): Dynamic
Name Type Default
label Dynamic
hint Dynamic
buf Dynamic
maxLength Dynamic (optional)
flags Dynamic (optional)
callback Dynamic (optional)
userData Dynamic (optional)
Returns
Dynamic
inputTextWithHint(label: Dynamic, hint: Dynamic, buf: Dynamic, ?maxLength: Dynamic, ?flags: Dynamic): Dynamic

Implied callback = NULL, user_data = NULL

Name Type Default
label Dynamic
hint Dynamic
buf Dynamic
maxLength Dynamic (optional)
flags Dynamic (optional)
Returns
Dynamic
inputFloatEx(label: Dynamic, v: Dynamic, ?step: Dynamic, ?stepFast: Dynamic, ?format: Dynamic, ?flags: Dynamic): Dynamic
Name Type Default
label Dynamic
v Dynamic
step Dynamic (optional)
stepFast Dynamic (optional)
format Dynamic (optional)
flags Dynamic (optional)
Returns
Dynamic
inputFloat(label: Dynamic, v: Dynamic): Dynamic

Implied step = 0.0f, step_fast = 0.0f, format = "%.3f", flags = 0

Name Type
label Dynamic
v Dynamic
Returns
Dynamic
inputIntEx(label: Dynamic, v: Dynamic, ?step: Dynamic, ?stepFast: Dynamic, ?flags: Dynamic): Dynamic
Name Type Default
label Dynamic
v Dynamic
step Dynamic (optional)
stepFast Dynamic (optional)
flags Dynamic (optional)
Returns
Dynamic
inputInt(label: Dynamic, v: Dynamic): Dynamic

Implied step = 1, step_fast = 100, flags = 0

Name Type
label Dynamic
v Dynamic
Returns
Dynamic
inputDoubleEx(label: Dynamic, v: Dynamic, ?step: Dynamic, ?stepFast: Dynamic, ?format: Dynamic, ?flags: Dynamic): Dynamic
Name Type Default
label Dynamic
v Dynamic
step Dynamic (optional)
stepFast Dynamic (optional)
format Dynamic (optional)
flags Dynamic (optional)
Returns
Dynamic
inputDouble(label: Dynamic, v: Dynamic): Dynamic

Implied step = 0.0, step_fast = 0.0, format = "%.6f", flags = 0

Name Type
label Dynamic
v Dynamic
Returns
Dynamic
collapsingHeaderBoolPtr(label: Dynamic, pVisible: Dynamic, ?flags: Dynamic): Dynamic

when 'p_visible != NULL': if '*p_visible==true' display an additional small close button on upper right of the header which will set the bool to false when clicked, if '*p_visible==false' don't display the header.

Name Type Default
label Dynamic
pVisible Dynamic
flags Dynamic (optional)
Returns
Dynamic
selectableBoolPtrEx(label: Dynamic, pSelected: Dynamic, ?flags: Dynamic, size: Dynamic): Dynamic

"bool* p_selected" point to the selection state (read-write), as a convenient helper.

Name Type Default
label Dynamic
pSelected Dynamic
flags Dynamic (optional)
size Dynamic
Returns
Dynamic
selectableBoolPtr(label: Dynamic, pSelected: Dynamic, ?flags: Dynamic): Dynamic

Implied size = ImVec2(0, 0)

Name Type Default
label Dynamic
pSelected Dynamic
flags Dynamic (optional)
Returns
Dynamic

return true when activated + toggle (*p_selected) if p_selected != NULL

Name Type Default
label Dynamic
shortcut Dynamic
pSelected Dynamic
enabled Dynamic (optional)
Returns
Dynamic
beginPopupModal(name: Dynamic, ?pOpen: Dynamic, ?flags: Dynamic): Dynamic

return true if the modal is open, and you can start outputting to it.

Name Type Default
name Dynamic
pOpen Dynamic (optional)
flags Dynamic (optional)
Returns
Dynamic
beginTabItem(label: Dynamic, ?pOpen: Dynamic, ?flags: Dynamic): Dynamic

create a Tab. Returns true if the Tab is selected.

Name Type Default
label Dynamic
pOpen Dynamic (optional)
flags Dynamic (optional)
Returns
Dynamic
colorConvertRGBtoHSV(r: Dynamic, g: Dynamic, b: Dynamic, outH: Dynamic, outS: Dynamic, outV: Dynamic): Dynamic
Name Type
r Dynamic
g Dynamic
b Dynamic
outH Dynamic
outS Dynamic
outV Dynamic
Returns
Dynamic
colorConvertHSVtoRGB(h: Dynamic, s: Dynamic, v: Dynamic, outR: Dynamic, outG: Dynamic, outB: Dynamic): Dynamic
Name Type
h Dynamic
s Dynamic
v Dynamic
outR Dynamic
outG Dynamic
outB Dynamic
Returns
Dynamic