Difference between revisions of "Dear ImGui"

From GiderosMobile
Line 33: Line 33:
 
[[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: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-->
 +
[[ImGui:render]] ''ends the ImGui frame, finalizes the draw data''<br/><!--GIDEROSMTD:ImGui:render() ends the ImGui frame, finalizes the draw data-->
 
[[ImGui:showDemoWindow]] ''displays an ImGui demo''<br/><!--GIDEROSMTD:ImGui:showDemoWindow() displays an ImGui demo-->
 
[[ImGui:showDemoWindow]] ''displays an ImGui demo''<br/><!--GIDEROSMTD:ImGui:showDemoWindow() displays an ImGui demo-->
 
[[ImGui:text]] ''displays an ImGui text''<br/><!--GIDEROSMTD:ImGui:text() displays an ImGui text-->
 
[[ImGui:text]] ''displays an ImGui text''<br/><!--GIDEROSMTD:ImGui:text() displays an ImGui text-->
Line 40: Line 41:
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
 
=== Events ===
 
=== Events ===
[[ImGui.KeyChar]]<br/><!--GIDEROSEVT:ImGui.KeyChar-->
+
ImGui.KeyChar<br/><!--GIDEROSEVT:ImGui.KeyChar-->
[[ImGui.KeyDown]]<br/><!--GIDEROSEVT:ImGui.KeyDown-->
+
ImGui.KeyDown<br/><!--GIDEROSEVT:ImGui.KeyDown-->
[[ImGui.KeyUp]]<br/><!--GIDEROSEVT:ImGui.KeyUp-->
+
ImGui.KeyUp<br/><!--GIDEROSEVT:ImGui.KeyUp-->
[[ImGui.MouseDown]]<br/><!--GIDEROSEVT:ImGui.MouseDown-->
+
ImGui.MouseDown<br/><!--GIDEROSEVT:ImGui.MouseDown-->
[[ImGui.MouseHover]]<br/><!--GIDEROSEVT:ImGui.MouseHover-->
+
ImGui.MouseHover<br/><!--GIDEROSEVT:ImGui.MouseHover-->
[[ImGui.MouseMove]]<br/><!--GIDEROSEVT:ImGui.MouseMove-->
+
ImGui.MouseMove<br/><!--GIDEROSEVT:ImGui.MouseMove-->
[[ImGui.MouseUp]]<br/><!--GIDEROSEVT:ImGui.MouseUp-->
+
ImGui.MouseUp<br/><!--GIDEROSEVT:ImGui.MouseUp-->
[[ImGui.MouseWheel]]<br/><!--GIDEROSEVT:ImGui.MouseWheel-->
+
ImGui.MouseWheel<br/><!--GIDEROSEVT:ImGui.MouseWheel-->
[[ImGui.TouchBegin]]<br/><!--GIDEROSEVT:ImGui.TouchBegin-->
+
ImGui.TouchBegin<br/><!--GIDEROSEVT:ImGui.TouchBegin-->
[[ImGui.TouchEnd]]<br/><!--GIDEROSEVT:ImGui.TouchEnd-->
+
ImGui.TouchEnd<br/><!--GIDEROSEVT:ImGui.TouchEnd-->
[[ImGui.TouchCancel]]<br/><!--GIDEROSEVT:ImGui.TouchCancel-->
+
ImGui.TouchCancel<br/><!--GIDEROSEVT:ImGui.TouchCancel-->
[[ImGui.TouchMove]]<br/><!--GIDEROSEVT:ImGui.TouchMove-->
+
ImGui.TouchMove<br/><!--GIDEROSEVT:ImGui.TouchMove-->
 
=== Constants ===
 
=== Constants ===
 
ImGui._VERSION<br/><!--GIDEROSCST:ImGui._VERSION-->
 
ImGui._VERSION<br/><!--GIDEROSCST:ImGui._VERSION-->

Revision as of 18:08, 16 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 an implementation of the Dear ImGui library.

See full original documentation here: https://pthom.github.io/imgui_manual_online/manual/imgui_manual.html


To use Dear ImGui in your project you need to add the ImGui plugin and call require like so:

require 'ImGui'


This is a brand new plugin in Gideros Studio so it may take some time to document it thoroughly.

In the meantime, the author's GitHub is the best place to get info regarding Dear ImGui Gideros functions.

https://github.com/MultiPain/Gideros_ImGui


Of course, Gideros Wiki is here to help as well. You will find below some Dear ImGui examples implemented in Gideros Studio. ImGui_Examples

Methods

ImGui.new initializes ImGui

ImGui:beginWindow pushes window to the stack and starts appending to it
ImGui:endFrame ends the ImGui frame
ImGui:endWindow pops window from the stack
ImGui:newFrame starts a new ImGui frame
ImGui:render ends the ImGui frame, finalizes the draw data
ImGui:showDemoWindow displays an ImGui demo
ImGui:text displays an ImGui text

WORK IN PROGRESS...

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