Difference between revisions of "ImGui.Core"

From GiderosMobile
Line 15: Line 15:
 
[[ImGui.new]] ''initializes ImGui''<br/><!--GIDEROSMTD:ImGui.new() initializes ImGui-->
 
[[ImGui.new]] ''initializes ImGui''<br/><!--GIDEROSMTD:ImGui.new() initializes ImGui-->
  
 +
[[ImGui.Core:arrowButton|ImGui:arrowButton]] ''displays an ImGui arrow button''<br/><!--GIDEROSMTD:ImGui:arrowButton(stringID, direction) displays an ImGui arrow button-->
 
[[ImGui:beginWindow]] ''pushes window to the stack and starts appending to it''<br/><!--GIDEROSMTD:ImGui:beginWindow(name, p_open, flags) pushes window to the stack and starts appending to it-->
 
[[ImGui:beginWindow]] ''pushes window to the stack and starts appending to it''<br/><!--GIDEROSMTD:ImGui:beginWindow(name, p_open, flags) pushes window to the stack and starts appending to it-->
 
[[ImGui.Core:bulletText|ImGui:bulletText]] ''displays an ImGui bulleted text''<br/><!--GIDEROSMTD:ImGui:bulletText(string) displays an ImGui bulleted text-->
 
[[ImGui.Core:bulletText|ImGui:bulletText]] ''displays an ImGui bulleted text''<br/><!--GIDEROSMTD:ImGui:bulletText(string) displays an ImGui bulleted text-->
 +
[[ImGui.Core:button|ImGui:button]] ''displays an ImGui button''<br/><!--GIDEROSMTD:ImGui:button(string, w, h) displays an ImGui button-->
 
[[ImGui:endFrame]] ''ends the ImGui frame''<br/><!--GIDEROSMTD:ImGui:endFrame() ends the ImGui frame-->
 
[[ImGui:endFrame]] ''ends the ImGui frame''<br/><!--GIDEROSMTD:ImGui:endFrame() ends the ImGui frame-->
 
[[ImGui:endWindow]] ''pops window from the stack''<br/><!--GIDEROSMTD:ImGui:endWindow() pops window from the stack-->
 
[[ImGui:endWindow]] ''pops window from the stack''<br/><!--GIDEROSMTD:ImGui:endWindow() pops window from the stack-->
 
[[ImGui:getIO]] ''accesses the IO structure (mouse/keyboard/gamepad inputs...)''<br/><!--GIDEROSMTD:ImGui:getIO() accesses the IO structure (mouse/keyboard/gamepad inputs, time, various configuration options/flags)-->
 
[[ImGui:getIO]] ''accesses the IO structure (mouse/keyboard/gamepad inputs...)''<br/><!--GIDEROSMTD:ImGui:getIO() accesses the IO structure (mouse/keyboard/gamepad inputs, time, various configuration options/flags)-->
 
[[ImGui:getStyle]] ''accesses the Style structure (colors, sizes)''<br/><!--GIDEROSMTD:ImGui:getStyle() accesses the Style structure (colors, sizes)-->
 
[[ImGui:getStyle]] ''accesses the Style structure (colors, sizes)''<br/><!--GIDEROSMTD:ImGui:getStyle() accesses the Style structure (colors, sizes)-->
 +
[[ImGui.Core:invisibleButton|ImGui:invisibleButton]] ''an ImGui invisible button''<br/><!--GIDEROSMTD:ImGui:invisibleButton(string, w, h) an ImGui invisible button-->
 
[[ImGui.Core:labelText|ImGui:labelText]] ''displays an ImGui labelled text''<br/><!--GIDEROSMTD:ImGui:labelText(string, string) displays an ImGui labelled text-->
 
[[ImGui.Core:labelText|ImGui:labelText]] ''displays an ImGui labelled text''<br/><!--GIDEROSMTD:ImGui:labelText(string, string) displays an ImGui labelled text-->
 
[[ImGui:newFrame]] ''starts a new ImGui frame''<br/><!--GIDEROSMTD:ImGui:newFrame(dt) starts a new ImGui frame-->
 
[[ImGui:newFrame]] ''starts a new ImGui frame''<br/><!--GIDEROSMTD:ImGui:newFrame(dt) starts a new ImGui frame-->
Line 34: Line 37:
 
[[ImGui:showStyleSelector]] ''adds a style selector block (not a window)''<br/><!--GIDEROSMTD:ImGui:showStyleSelector(style) adds a style selector block (not a window)-->
 
[[ImGui:showStyleSelector]] ''adds a style selector block (not a window)''<br/><!--GIDEROSMTD:ImGui:showStyleSelector(style) adds a style selector block (not a window)-->
 
[[ImGui:showUserGuide]] ''adds basic help/info block (not a window)''<br/><!--GIDEROSMTD:ImGui:showUserGuide() adds basic help/info block (not a window)-->
 
[[ImGui:showUserGuide]] ''adds basic help/info block (not a window)''<br/><!--GIDEROSMTD:ImGui:showUserGuide() adds basic help/info block (not a window)-->
 +
[[ImGui.Core:smallButton|ImGui:smallButton]] ''displays an ImGui small button''<br/><!--GIDEROSMTD:ImGui:smallButton(string) displays an ImGui small button-->
 
[[ImGui:text]] ''displays an ImGui text''<br/><!--GIDEROSMTD:ImGui:text(string) displays an ImGui text-->
 
[[ImGui:text]] ''displays an ImGui text''<br/><!--GIDEROSMTD:ImGui:text(string) displays an ImGui text-->
 
[[ImGui:textColored]] ''displays an ImGui colored text''<br/><!--GIDEROSMTD:ImGui:textColored(string, hex, alpha) displays an ImGui colored text-->
 
[[ImGui:textColored]] ''displays an ImGui colored text''<br/><!--GIDEROSMTD:ImGui:textColored(string, hex, alpha) displays an ImGui colored text-->

Revision as of 00:34, 26 March 2021

Supported platforms: Platform android.pngPlatform ios.pngPlatform mac.pngPlatform pc.pngPlatform html5.pngPlatform winrt.pngPlatform win32.png
Available since: Gideros 2020.9

Description

This is the ImGui main class.


PLEASE NOTE THE DOCUMENTATION IS WORK IN PROGRESS


Methods

ImGui.new initializes ImGui

ImGui:arrowButton displays an ImGui arrow button
ImGui:beginWindow pushes window to the stack and starts appending to it
ImGui:bulletText displays an ImGui bulleted text
ImGui:button displays an ImGui button
ImGui:endFrame ends the ImGui frame
ImGui:endWindow pops window from the stack
ImGui:getIO accesses the IO structure (mouse/keyboard/gamepad inputs...)
ImGui:getStyle accesses the Style structure (colors, sizes)
ImGui:invisibleButton an ImGui invisible button
ImGui:labelText displays an ImGui labelled text
ImGui:newFrame starts a new ImGui frame
ImGui:render ends the ImGui frame, finalizes the draw data
ImGui:setClassicStyle sets a classic color style
ImGui:setDarkStyle sets a dark color style
ImGui:setLightStyle sets a light color style
ImGui:showAboutWindow creates an ImGui About window
ImGui:showDemoWindow displays an ImGui demo
ImGui:showFontSelector adds a font selector block (not a window)
ImGui:showMetricsWindow displays an ImGui metrics window
ImGui:showStyleEditor adds the style editor block (not a window)
ImGui:showStyleSelector adds a style selector block (not a window)
ImGui:showUserGuide adds basic help/info block (not a window)
ImGui:smallButton displays an ImGui small button
ImGui:text displays an ImGui text
ImGui:textColored displays an ImGui colored text
ImGui:textDisabled displays an ImGui disabled text
ImGui:textWrapped displays an ImGui wrapped text

Events

ImGui.KeyChar
ImGui.KeyDown
ImGui.KeyUp
ImGui.MouseDown
ImGui.MouseHover
ImGui.MouseMove
ImGui.MouseUp
ImGui.MouseWheel
ImGui.TouchBegin
ImGui.TouchEnd
ImGui.TouchCancel
ImGui.TouchMove

Constants

ImGui._VERSION

Window Flags
ImGui.WindowFlags_AlwaysAutoResize
ImGui.WindowFlags_AlwaysHorizontalScrollbar
ImGui.WindowFlags_AlwaysUseWindowPadding
ImGui.WindowFlags_AlwaysVerticalScrollbar
ImGui.WindowFlags_HorizontalScrollbar
ImGui.WindowFlags_MenuBar
ImGui.WindowFlags_NoBackground
ImGui.WindowFlags_NoBringToFrontOnFocus
ImGui.WindowFlags_NoCollapse
ImGui.WindowFlags_NoDecoration
ImGui.WindowFlags_NoFocusOnAppearing
ImGui.WindowFlags_NoInputs
ImGui.WindowFlags_NoMouseInputs
ImGui.WindowFlags_NoMove
ImGui.WindowFlags_NoNav
ImGui.WindowFlags_NoNavFocus
ImGui.WindowFlags_NoNavInputs
ImGui.WindowFlags_None
ImGui.WindowFlags_NoResize
ImGui.WindowFlags_NoSavedSettings
ImGui.WindowFlags_NoScrollbar
ImGui.WindowFlags_NoScrollWithMouse
ImGui.WindowFlags_NoTitleBar
ImGui.WindowFlags_UnsavedDocument

Col Flags
ImGui.Col_Border
ImGui.Col_BorderShadow
ImGui.Col_Button
ImGui.Col_ButtonActive
ImGui.Col_ButtonHovered
ImGui.Col_CheckMark
ImGui.Col_ChildBg
ImGui.Col_DragDropTarget
ImGui.Col_FrameBg
ImGui.Col_FrameBgActive
ImGui.Col_FrameBgHovered
ImGui.Col_Header
ImGui.Col_HeaderActive
ImGui.Col_HeaderHovered
ImGui.Col_MenuBarBg
ImGui.Col_ModalWindowDimBg
ImGui.Col_NavHighlight
ImGui.Col_NavWindowingDimBg
ImGui.Col_NavWindowingHighlight
ImGui.Col_PlotHistogram
ImGui.Col_PlotHistogramHovered
ImGui.Col_PlotLines
ImGui.Col_PlotLinesHovered
ImGui.Col_PopupBg
ImGui.Col_ResizeGrip
ImGui.Col_ResizeGripActive
ImGui.Col_ResizeGripHovered
ImGui.Col_ScrollbarBg
ImGui.Col_ScrollbarGrab
ImGui.Col_ScrollbarGrabActive
ImGui.Col_ScrollbarGrabHovered
ImGui.Col_Separator
ImGui.Col_SeparatorActive
ImGui.Col_SeparatorHovered
ImGui.Col_SliderGrab
ImGui.Col_SliderGrabActive
ImGui.Col_Tab
ImGui.Col_TabActive
ImGui.Col_TabHovered
ImGui.Col_TableBorderLight
ImGui.Col_TableBorderStrong
ImGui.Col_TableHeaderBg
ImGui.Col_TableRowBg
ImGui.Col_TableRowBgAlt
ImGui.Col_TabUnfocused
ImGui.Col_TabUnfocusedActive
ImGui.Col_Text
ImGui.Col_TextDisabled
ImGui.Col_TextSelectedBg
ImGui.Col_TitleBg
ImGui.Col_TitleBgActive
ImGui.Col_TitleBgCollapsed
ImGui.Col_WindowBg


Dear ImGui