Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ImGui

Index

Enumerations

Interfaces

Type aliases

Functions

Type aliases

bool_ref

bool_ref: boolean[]

number_ref

number_ref: number[]

string_ref

string_ref: string[]

Functions

alignTextToFramePadding

  • alignTextToFramePadding(): void

arrowButton

  • arrowButton(strId: string, dir: Dir): boolean

begin

beginChild

  • beginChild(strId: string, size?: vec2, border?: boolean, flags?: WindowFlags): boolean
  • beginChild(id: number, size?: vec2, border?: boolean, flags?: WindowFlags): boolean

beginChildFrame

beginCombo

  • beginCombo(label: string, previewValue: string, flags?: ComboFlags): boolean

beginGroup

  • beginGroup(): void

beginMainMenuBar

  • beginMainMenuBar(): boolean

beginMenu

  • beginMenu(label: string, enabled?: boolean): boolean

beginMenuBar

  • beginMenuBar(): boolean

beginPopup

  • beginPopup(strId: string, flags?: WindowFlags): boolean

beginPopupContextItem

  • beginPopupContextItem(strId?: string, popupFlags?: PopupFlags): boolean

beginPopupContextVoid

  • beginPopupContextVoid(strId?: string, popupFlags?: PopupFlags): boolean

beginPopupContextWindow

  • beginPopupContextWindow(strId?: string, popupFlags?: PopupFlags): boolean

beginPopupModal

beginTabBar

  • beginTabBar(strId: string, flags?: TabBarFlags): boolean

beginTabItem

beginTooltip

  • beginTooltip(): void

bullet

  • bullet(): void

bulletText

  • bulletText(text: string): void

button

  • button(label: string, size?: vec2): boolean

calcItemWidth

  • calcItemWidth(): number

calcListClipping

  • calcListClipping(itemsCount: number, itemsHeight: number): vec2

calcTextSize

  • calcTextSize(text: string, hideTextAfterDoubleHash?: boolean, wrapWidth?: number): vec2

captureKeyboardFromApp

  • captureKeyboardFromApp(wantCaptureKeyboardValue: boolean): void

captureMouseFromApp

  • captureMouseFromApp(wantCaptureMouseValue?: boolean): void

checkbox

  • checkbox(label: string, v: bool_ref): boolean

checkboxFlags

  • checkboxFlags(label: string, flags: number_ref, flagsValue: number): boolean

closeCurrentPopup

  • closeCurrentPopup(): void

collapsingHeader

colorButton

colorConvertHSVtoRGB

  • colorConvertHSVtoRGB(color: vec4): vec4

colorConvertRGBtoHSV

  • colorConvertRGBtoHSV(color: vec4): vec4

colorEdit3

colorEdit4

colorPicker3

colorPicker4

columns

  • columns(count?: number, id?: string, border?: boolean): void

combo

  • combo(label: string, currentItem: number_ref, items: any[], popupMaxHeightInItems?: number): boolean

dockSpace

dockSpaceOverViewport

dragFloat

  • dragFloat(label: string, v: number_ref, vSpeed?: number, vMin?: number, vMax?: number, format?: string, flags?: SliderFlags): boolean

dragFloatRange

  • dragFloatRange(label: string, vCurrentMin: number_ref, vCurrentMax: number_ref, vSpeed?: number, vMin?: number, vMax?: number, format?: string, formatMax?: string, flags?: SliderFlags): boolean

dragFloats

  • dragFloats(label: string, v: number[], vSpeed?: number, vMin?: number, vMax?: number, format?: string, flags?: SliderFlags): boolean

dragInt

  • dragInt(label: string, v: number_ref, vSpeed?: number, vMin?: number, vMax?: number, format?: string, flags?: SliderFlags): boolean

dragIntRange

  • dragIntRange(label: string, vCurrentMin: number_ref, vCurrentMax: number_ref, vSpeed?: number, vMin?: number, vMax?: number, format?: string, formatMax?: string, flags?: SliderFlags): boolean

dragInts

  • dragInts(label: string, v: number[], vSpeed?: number, vMin?: number, vMax?: number, format?: string, flags?: SliderFlags): boolean

dummy

  • dummy(size: vec2): void

end

  • end(): void

endChild

  • endChild(): void

endChildFrame

  • endChildFrame(): void

endCombo

  • endCombo(): void

endGroup

  • endGroup(): void

endMainMenuBar

  • endMainMenuBar(): void

endMenu

  • endMenu(): void

endMenuBar

  • endMenuBar(): void

endPopup

  • endPopup(): void

endTabBar

  • endTabBar(): void

endTabItem

  • endTabItem(): void

endTooltip

  • endTooltip(): void

findViewportById

getBackgroundDrawList

getClipboardText

  • getClipboardText(): string

getColor

getColumnIndex

  • getColumnIndex(): number

getColumnOffset

  • getColumnOffset(columnIndex?: number): number

getColumnWidth

  • getColumnWidth(columnIndex?: number): number

getColumnsCount

  • getColumnsCount(): number

getContentRegionAvail

  • getContentRegionAvail(): vec2

getContentRegionMax

  • getContentRegionMax(): vec2

getCursorPos

  • getCursorPos(): vec2

getCursorPosX

  • getCursorPosX(): number

getCursorPosY

  • getCursorPosY(): number

getCursorScreenPos

  • getCursorScreenPos(): vec2

getCursorStartPos

  • getCursorStartPos(): vec2

getFont

getFontSize

  • getFontSize(): number

getFontTexUvWhitePixel

  • getFontTexUvWhitePixel(): vec2

getForegroundDrawList

getFrameCount

  • getFrameCount(): number

getFrameHeight

  • getFrameHeight(): number

getFrameHeightWithSpacing

  • getFrameHeightWithSpacing(): number

getId

  • getId(strId: string): number
  • getId(ptrId: number): number

getIo

getItemRectMax

  • getItemRectMax(): vec2

getItemRectMin

  • getItemRectMin(): vec2

getItemRectSize

  • getItemRectSize(): vec2

getKeyPressedAmount

  • getKeyPressedAmount(keyIndex: Scancode, repeatDelay: number, rate: number): number

getMainViewport

getMouseCursor

getMouseDragDelta

getMousePos

  • getMousePos(): vec2

getMousePosOnOpeningCurrentPopup

  • getMousePosOnOpeningCurrentPopup(): vec2

getScrollMaxX

  • getScrollMaxX(): number

getScrollMaxY

  • getScrollMaxY(): number

getScrollX

  • getScrollX(): number

getScrollY

  • getScrollY(): number

getStyle

getStyleColor

getStyleColorName

  • getStyleColorName(idx: Col): string

getTextLineHeight

  • getTextLineHeight(): number

getTextLineHeightWithSpacing

  • getTextLineHeightWithSpacing(): number

getTime

  • getTime(): number

getTreeNodeToLabelSpacing

  • getTreeNodeToLabelSpacing(): number

getVersion

  • getVersion(): string

getWindowContentRegionMax

  • getWindowContentRegionMax(): vec2

getWindowContentRegionMin

  • getWindowContentRegionMin(): vec2

getWindowContentRegionWidth

  • getWindowContentRegionWidth(): number

getWindowDockId

  • getWindowDockId(): number

getWindowDpiScale

  • getWindowDpiScale(): number

getWindowDrawList

getWindowHeight

  • getWindowHeight(): number

getWindowPos

  • getWindowPos(): vec2

getWindowSize

  • getWindowSize(): vec2

getWindowViewport

getWindowWidth

  • getWindowWidth(): number

image

  • image(userTextureId: number, size: vec2, uv0?: vec2, uv1?: vec2, tintCol?: vec4, borderCol?: vec4): void

imageButton

  • imageButton(userTextureId: number, size: vec2, uv0?: vec2, uv1?: vec2, framePadding?: number, bgCol?: vec4, tintCol?: vec4): boolean

indent

  • indent(indentW?: number): void

inputDouble

  • inputDouble(label: string, v: number_ref, step?: number, stepFast?: number, format?: string, flags?: InputTextFlags): boolean

inputFloat

  • inputFloat(label: string, v: number_ref, step?: number, stepFast?: number, format?: string, flags?: InputTextFlags): boolean

inputFloats

  • inputFloats(label: string, v: number[], step?: number, stepFast?: number, format?: string, flags?: InputTextFlags): boolean

inputInt

inputInts

  • inputInts(label: string, v: number[], step?: number, stepFast?: number, format?: string, flags?: InputTextFlags): boolean

inputText

inputTextMultiline

inputTextWithHint

invisibleButton

isAnyItemActive

  • isAnyItemActive(): boolean

isAnyItemFocused

  • isAnyItemFocused(): boolean

isAnyItemHovered

  • isAnyItemHovered(): boolean

isAnyMouseDown

  • isAnyMouseDown(): boolean

isItemActivated

  • isItemActivated(): boolean

isItemActive

  • isItemActive(): boolean

isItemClicked

isItemDeactivated

  • isItemDeactivated(): boolean

isItemDeactivatedAfterEdit

  • isItemDeactivatedAfterEdit(): boolean

isItemEdited

  • isItemEdited(): boolean

isItemFocused

  • isItemFocused(): boolean

isItemHovered

isItemToggledOpen

  • isItemToggledOpen(): boolean

isItemVisible

  • isItemVisible(): boolean

isKeyDown

  • isKeyDown(keyIndex: Scancode): boolean

isKeyPressed

  • isKeyPressed(keyIndex: Scancode, repeat?: boolean): boolean

isKeyReleased

  • isKeyReleased(keyIndex: Scancode): boolean

isMouseClicked

  • isMouseClicked(button: MouseButton, repeat?: boolean): boolean

isMouseDoubleClicked

isMouseDown

isMouseDragging

  • isMouseDragging(button: MouseButton, lockThreshold?: number): boolean

isMouseHoveringRect

  • isMouseHoveringRect(rMin: vec2, rMax: vec2, clip?: boolean): boolean

isMousePosValid

  • isMousePosValid(mousePos?: vec2): boolean

isMouseReleased

isPopupOpen

  • isPopupOpen(strId: string, flags?: PopupFlags): boolean

isRectVisible

  • isRectVisible(size: vec2): boolean
  • isRectVisible(rectMin: vec2, rectMax: vec2): boolean

isWindowAppearing

  • isWindowAppearing(): boolean

isWindowCollapsed

  • isWindowCollapsed(): boolean

isWindowDocked

  • isWindowDocked(): boolean

isWindowFocused

isWindowHovered

labelText

  • labelText(label: string, text: string): void

listBox

  • listBox(label: string, currentItem: number_ref, items: any[], heightInItems?: number): boolean

listBoxFooter

  • listBoxFooter(): void

listBoxHeader

  • listBoxHeader(label: string, size?: vec2): boolean
  • listBoxHeader(label: string, itemsCount: number, heightInItems?: number): boolean

loadIniSettingsFromDisk

  • loadIniSettingsFromDisk(iniFilename: string): void

loadIniSettingsFromMemory

  • loadIniSettingsFromMemory(iniData: Buffer): void

logButtons

  • logButtons(): void

logFinish

  • logFinish(): void

logText

  • logText(text: string): void

logToClipboard

  • logToClipboard(autoOpenDepth?: number): void

logToFile

  • logToFile(autoOpenDepth?: number, filename?: string): void

logToTTY

  • logToTTY(autoOpenDepth?: number): void

menuItem

  • menuItem(label: string, shortcut?: string, selected?: boolean, enabled?: boolean): boolean
  • menuItem(label: string, shortcut: string, selected: bool_ref, enabled?: boolean): boolean

newLine

  • newLine(): void

nextColumn

  • nextColumn(): void

openPopup

  • openPopup(strId: string, popupFlags?: PopupFlags): void

openPopupContextItem

  • openPopupContextItem(strId?: string, popupFlags?: PopupFlags): boolean

plotHistogram

  • plotHistogram(label: string, values: number[], valuesOffset?: number, overlayText?: string, scaleMin?: number, scaleMax?: number, graphSize?: vec2): void

plotLines

  • plotLines(label: string, values: number[], valuesOffset?: number, overlayText?: string, scaleMin?: number, scaleMax?: number, graphSize?: vec2): void

popAllowKeyboardFocus

  • popAllowKeyboardFocus(): void

popButtonRepeat

  • popButtonRepeat(): void

popClipRect

  • popClipRect(): void

popFont

  • popFont(): void

popId

  • popId(): void

popItemDisabled

  • popItemDisabled(): void

popItemWidth

  • popItemWidth(): void

popStyleColor

  • popStyleColor(count?: number): void

popStyleVar

  • popStyleVar(count?: number): void

popTextWrapPos

  • popTextWrapPos(): void

progressBar

  • progressBar(fraction: number, sizeArg?: vec2, overlay?: string): void

pushAllowKeyboardFocus

  • pushAllowKeyboardFocus(allowKeyboardFocus: boolean): void

pushButtonRepeat

  • pushButtonRepeat(repeat: boolean): void

pushClipRect

  • pushClipRect(clipRectMin: vec2, clipRectMax: vec2, intersectWithCurrentClipRect: boolean): void

pushFont

pushId

  • pushId(strId: string): void
  • pushId(ptrId: number): void

pushItemDisabled

  • pushItemDisabled(disabled: boolean): void

pushItemWidth

  • pushItemWidth(itemWidth: number): void

pushStyleColor

  • pushStyleColor(idx: Col, col: vec4): void

pushStyleVar

pushTextWrapPos

  • pushTextWrapPos(wrapLocalPosX?: number): void

radioButton

  • radioButton(label: string, active: boolean): boolean
  • radioButton(label: string, v: number_ref, vButton: number): boolean

resetMouseDragDelta

sameLine

  • sameLine(offsetFromStartX?: number, spacing?: number): void

saveIniSettingsToDisk

  • saveIniSettingsToDisk(iniFilename: string): void

saveIniSettingsToMemory

  • saveIniSettingsToMemory(): Buffer

selectable

separator

  • separator(): void

setClipboardText

  • setClipboardText(text: string): void

setColorEditOptions

setColumnOffset

  • setColumnOffset(columnIndex: number, offsetX: number): void

setColumnWidth

  • setColumnWidth(columnIndex: number, width: number): void

setCursorPos

  • setCursorPos(localPos: vec2): void

setCursorPosX

  • setCursorPosX(localX: number): void

setCursorPosY

  • setCursorPosY(localY: number): void

setCursorScreenPos

  • setCursorScreenPos(pos: vec2): void

setItemAllowOverlap

  • setItemAllowOverlap(): void

setItemDefaultFocus

  • setItemDefaultFocus(): void

setKeyboardFocusHere

  • setKeyboardFocusHere(offset?: number): void

setMouseCursor

setNextItemOpen

  • setNextItemOpen(isOpen: boolean, cond?: Cond): void

setNextItemWidth

  • setNextItemWidth(itemWidth: number): void

setNextWindowBgAlpha

  • setNextWindowBgAlpha(alpha: number): void

setNextWindowCollapsed

  • setNextWindowCollapsed(collapsed: boolean, cond?: Cond): void

setNextWindowContentSize

  • setNextWindowContentSize(size: vec2): void

setNextWindowFocus

  • setNextWindowFocus(): void

setNextWindowPos

  • setNextWindowPos(pos: vec2, cond?: Cond, pivot?: vec2): void

setNextWindowSize

  • setNextWindowSize(size: vec2, cond?: Cond): void

setNextWindowSizeConstraints

  • setNextWindowSizeConstraints(sizeMin: vec2, sizeMax: vec2): void

setNextWindowViewport

  • setNextWindowViewport(viewportId: number): void

setScrollFromPosX

  • setScrollFromPosX(localX: number, centerXRatio?: number): void

setScrollFromPosY

  • setScrollFromPosY(localY: number, centerYRatio?: number): void

setScrollHereX

  • setScrollHereX(centerXRatio?: number): void

setScrollHereY

  • setScrollHereY(centerYRatio?: number): void

setScrollX

  • setScrollX(scrollX: number): void

setScrollY

  • setScrollY(scrollY: number): void

setTabItemClosed

  • setTabItemClosed(tabOrDockedWindowLabel: string): void

setTooltip

  • setTooltip(text: string): void

setWindowCollapsed

  • setWindowCollapsed(collapsed: boolean, cond?: Cond): void
  • setWindowCollapsed(name: string, collapsed: boolean, cond?: Cond): void

setWindowFocus

  • setWindowFocus(): void
  • setWindowFocus(name: string): void

setWindowFontScale

  • setWindowFontScale(scale: number): void

setWindowPos

  • setWindowPos(pos: vec2, cond?: Cond): void
  • setWindowPos(name: string, pos: vec2, cond?: Cond): void

setWindowSize

  • setWindowSize(size: vec2, cond?: Cond): void
  • setWindowSize(name: string, size: vec2, cond?: Cond): void

showAboutWindow

  • showAboutWindow(open?: bool_ref): void

showDemoWindow

showFontSelector

  • showFontSelector(): void

showMetricsWindow

  • showMetricsWindow(open?: bool_ref): void

showStyleEditor

  • showStyleEditor(): void

showStyleSelector

  • showStyleSelector(): void

showUserGuide

  • showUserGuide(): void

sliderAngle

  • sliderAngle(label: string, vRad: number_ref, vDegreesMin?: number, vDegreesMax?: number, format?: string, flags?: SliderFlags): boolean

sliderFloat

  • sliderFloat(label: string, v: number_ref, vMin: number, vMax: number, format?: string, flags?: SliderFlags): boolean

sliderFloats

  • sliderFloats(label: string, v: number[], vMin: number, vMax: number, format?: string, flags?: SliderFlags): boolean

sliderInt

  • sliderInt(label: string, v: number_ref, vMin: number, vMax: number, format?: string, flags?: SliderFlags): boolean

sliderInts

  • sliderInts(label: string, v: number[], vMin: number, vMax: number, format?: string, flags?: SliderFlags): boolean

smallButton

  • smallButton(label: string): boolean

spacing

  • spacing(): void

styleColorsClassic

  • styleColorsClassic(): void

styleColorsDark

  • styleColorsDark(): void

styleColorsLight

  • styleColorsLight(): void

text

  • text(text: string): void

textColored

  • textColored(text: string, col: vec4): void

textDisabled

  • textDisabled(text: string): void

textWrapped

  • textWrapped(text: string): void

treeNode

treeNodeEx

  • treeNodeEx(strId: string, label: string, flags?: TreeNodeFlags): boolean
  • treeNodeEx(ptrId: number, label: string, flags?: TreeNodeFlags): boolean

treePop

  • treePop(): void

treePush

  • treePush(strId: string): void
  • treePush(ptrId: number): void
  • treePush(): void

unindent

  • unindent(indentW?: number): void

vSliderFloat

  • vSliderFloat(label: string, size: vec2, v: number_ref, vMin: number, vMax: number, format?: string, flags?: SliderFlags): boolean

vSliderInt

  • vSliderInt(label: string, size: vec2, v: number_ref, vMin: number, vMax: number, format?: string, flags?: SliderFlags): boolean

valueBool

  • valueBool(prefix: string, b: boolean): void

valueFloat

  • valueFloat(prefix: string, v: number, format?: string): void

valueInt

  • valueInt(prefix: string, v: number): void

Generated using TypeDoc