Difference between revisions of "Dear ImGui"

From GiderosMobile
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
<!-- GIDEROSOBJ:ImGui -->
 
<!-- GIDEROSOBJ:ImGui -->
'''<translate>Supported platforms</translate>:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]][[File:Platform html5.png]][[File:Platform winrt.png]][[File:Platform win32.png]]<br/>
+
'''Supported platforms:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]][[File:Platform html5.png]][[File:Platform winrt.png]][[File:Platform win32.png]]<br/>
'''<translate>Available since</translate>:''' Gideros 2020.9<br/>
+
'''Available since:''' Gideros 2020.9<br/>
  
 
=== Description ===
 
=== Description ===
Line 23: Line 23:
 
'''Of course, Gideros Wiki is here to help as well. You will find below some Dear ImGui examples implemented in Gideros Studio.
 
'''Of course, Gideros Wiki is here to help as well. You will find below some Dear ImGui examples implemented in Gideros Studio.
 
[[ImGui_Examples]]
 
[[ImGui_Examples]]
 
{|-
 
| style="width: 50%; vertical-align:top;"|
 
=== Methods ===
 
[[ImGui.new]] ''initializes ImGui''<br/><!--GIDEROSMTD:ImGui.new() initializes ImGui-->
 
 
[[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: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: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: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:setLightStyle]] ''sets a light color style''<br/><!--GIDEROSMTD:ImGui:setLightStyle() sets a light color style-->
 
[[ImGui:showDemoWindow]] ''displays an ImGui demo''<br/><!--GIDEROSMTD:ImGui:showDemoWindow() displays an ImGui demo-->
 
[[ImGui:showMetricsWindow]] ''displays an ImGui metrics window''<br/><!--GIDEROSMTD:ImGui:showMetricsWindow() displays an ImGui metrics window-->
 
[[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-->
 
 
'''WORK IN PROGRESS...'''
 
 
| style="width: 50%; vertical-align:top;"|
 
=== Events ===
 
ImGui.KeyChar<br/><!--GIDEROSEVT:ImGui.KeyChar-->
 
ImGui.KeyDown<br/><!--GIDEROSEVT:ImGui.KeyDown-->
 
ImGui.KeyUp<br/><!--GIDEROSEVT:ImGui.KeyUp-->
 
ImGui.MouseDown<br/><!--GIDEROSEVT:ImGui.MouseDown-->
 
ImGui.MouseHover<br/><!--GIDEROSEVT:ImGui.MouseHover-->
 
ImGui.MouseMove<br/><!--GIDEROSEVT:ImGui.MouseMove-->
 
ImGui.MouseUp<br/><!--GIDEROSEVT:ImGui.MouseUp-->
 
ImGui.MouseWheel<br/><!--GIDEROSEVT:ImGui.MouseWheel-->
 
ImGui.TouchBegin<br/><!--GIDEROSEVT:ImGui.TouchBegin-->
 
ImGui.TouchEnd<br/><!--GIDEROSEVT:ImGui.TouchEnd-->
 
ImGui.TouchCancel<br/><!--GIDEROSEVT:ImGui.TouchCancel-->
 
ImGui.TouchMove<br/><!--GIDEROSEVT:ImGui.TouchMove-->
 
=== Constants ===
 
ImGui._VERSION<br/><!--GIDEROSCST:ImGui._VERSION-->
 
|}
 
  
 
=== Classes ===
 
=== Classes ===
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
[[ImGui]]<br/><!--GIDEROSOBJ:ImGui-->
+
'''[[ImGui]]'''<br/><!--GIDEROSOBJ:ImGui-->
[[ImGui.Style]]<br/><!--GIDEROSOBJ:ImGui.Style-->
+
'''[[ImGui.Style]]'''<br/><!--GIDEROSOBJ:ImGui.Style-->
 
</div>
 
</div>
  
 
{{GIDEROS IMPORTANT LINKS}}
 
{{GIDEROS IMPORTANT LINKS}}

Revision as of 01:53, 23 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

Classes