(ImGui library is available under a free and permissive license, but needs financial support to sustain its continued improvements. In addition to maintenance and stability there are many desirable features yet to be added. If your company is using Dear ImGui, please consider reaching out.)
UImGui (Unity ImGui) is an UPM package for the immediate mode GUI library using ImGui.NET. This project is based on RG.ImGui project.
Using ImGui.NET 1.82
Dear ImGui is a bloat-free graphical user interface library for C++. It outputs optimized vertex buffers that you can render anytime in your 3D-pipeline enabled application. It is fast, portable, renderer agnostic and self-contained (no external dependencies).
Dear ImGui is designed to enable fast iterations and to empower programmers to create content creation tools and visualization / debug tools (as opposed to UI for the average end-user). It favors simplicity and productivity toward this goal, and lacks certain features normally found in more high-level libraries.
To update (using ImGui.Net.dll) easier and often.
| Feature | RG | UImGui |
|---|---|---|
| IL2CPP | ❌ | ✔️ |
| Docking | ❌ | ✔️ |
| Unity Input Manager | ✔️ | ✔️ |
| Unity Input System | ✔️ | ✔️ |
| Docking | ❌ | ✔️ |
| RenderPipeline Built in | ✔️ | ✔️ |
| RenderPipeline URP | ❌ | ✔️ |
| RenderPipeline HDRP | ❌ | ✔️ |
| Renderer Mesh | ✔️ | ✔️ |
| Renderer Procedural | ~ | ✔️ |
| FreeType | ✔️ | ❌ |
| Image / Texture | ❌ | ✔️ |
- Add package from git URL: https://github.com/psydack/uimguit
- Add
UImGuicomponent to the scene and - (Optional) Set
Platform TypetoInput Systemif you're using the new input system theSampleDemoWindowobject on the scene the following properties: - If you're using URP check Using URP section, for HDRP Using HDRP section, for built in check Using Built in section.
- You're ready. Look Samples section for more usage samples.
It has a demo scene called UImGuiDemoScene inside UImGui/Sample folder.
You can subscribe to global layout or for a specific UImGui context:
If choose to use global, don't to forget to set Do Global Layout to true on UImGui instance.
using ImGuiNET;
using UImGui;
using UnityEngine;
public class UsingCurrentUImGui : MonoBehaviour
{
[SerializeField]
private UImGui.UImGui _uImGui;
private void OnEnable()
{
_uImGui.Layout += OnLayout;
// UImGuiUtility.Layout += OnLayout; // Use this for global layout.
}
private void OnDisable()
{
_uImGui.Layout -= OnLayout;
// UImGuiUtility.Layout -= OnLayout; // Use this for global layout.
}
private void OnLayout()
{
// Your code goes here.
}
}The following codes goes on your Layout event, like this:
using ImGuiNET;
using UnityEngine;
public class UsingCurrentUImGui : MonoBehaviour
{
// Or you can use global layout. Look commented lines.
[SerializeField]
private UImGui.UImGui _uImGui;
[SerializeField]
private float _sliderFloatValue = 1;
private byte[] _inputText = new byte[100];
private void OnEnable()
{
_uImGui.Layout += OnLayout;
// UImGuiUtility.Layout += OnLayout; // Use this for global layout.
}
private void OnDisable()
{
_uImGui.Layout -= OnLayout;
// UImGuiUtility.Layout -= OnLayout; // Use this for global layout.
}
private void OnLayout()
{
ImGui.Text($"Hello, world {123}");
if (ImGui.Button("Save"))
{
Debug.Log("Save");
}
ImGui.InputText("string", _inputText, (uint)(sizeof(byte) * _inputText.Length));
ImGui.SliderFloat("float", ref _sliderFloatValue, 0.0f, 1.0f);
}
}[SerializeField]
private System.Numerics.Vector4 _myColor;
private bool _isOpen;
private void OnLayout()
{
// Create a window called "My First Tool", with a menu bar.
ImGui.Begin("My First Tool", ref _isOpen, ImGuiWindowFlags.MenuBar);
if (ImGui.BeginMenuBar())
{
if (ImGui.BeginMenu("File"))
{
if (ImGui.MenuItem("Open..", "Ctrl+O")) { /* Do stuff */ }
if (ImGui.MenuItem("Save", "Ctrl+S")) { /* Do stuff */ }
if (ImGui.MenuItem("Close", "Ctrl+W")) { _isOpen = false; }
ImGui.EndMenu();
}
ImGui.EndMenuBar();
}
// Edit a color (stored as ~4 floats)
ImGui.ColorEdit4("Color", ref _myColor);
// Plot some values
float[] my_values = new float[] { 0.2f, 0.1f, 1.0f, 0.5f, 0.9f, 2.2f };
ImGui.PlotLines("Frame Times", ref my_values[0], my_values.Length);
// Display contents in a scrolling region
ImGui.TextColored(new System.Numerics.Vector4(1, 1, 0, 1), "Important Stuff");
ImGui.BeginChild("Scrolling");
for (int n = 0; n < 50; n++)
ImGui.Text($"{n}: Some text");
ImGui.EndChild();
ImGui.End();
}Image Sample
using ImGuiNET;
using UImGui;
using UnityEngine;
public class UsingCurrentUImGui : MonoBehaviour
{
[SerializeField]
private Texture _sampleTexture;
private void OnEnable()
{
UImGuiUtility.Layout += OnLayout;
}
private void OnDisable()
{
UImGuiUtility.Layout -= OnLayout;
}
private void OnLayout()
{
if (ImGui.Begin("Image Sample"))
{
System.IntPtr id = UImGuiUtility.GetTextureId(_sampleTexture);
System.Numerics.Vector2 size = new System.Numerics.Vector2(_sampleTexture.width, _sampleTexture.height)
ImGui.Image(id, size);
ImGui.End();
}
}
}- Add a
Render Im Gui Featurerender feature to the renderer asset. - Assign it to the
render featurefield of the DearImGui component.
- When using the
High Definition Render Pipeline 8CE8, add a custom render pass and select "DearImGuiPass" injected after post processing. - Assign it to the
render featurefield of the DearImGui component. - See Known issues HDRP for more info.
No special sets.
Solution You should change your anti-aliasing from FXAA to None or SMAA or disable post processing. To do this, check your camera.
- Alpha blending is incorrect when using HDRP. Still need to investigate why, it seems like the closer to 50% alpha you get the more opaque an object appears.
- Procedural rendering is not yet supported on HDRP.
Original repo https://github.com/realgamessoftware/dear-imgui-unity
Thanks to @lacrc and @airtonmotoki for encouraging me.
https://www.conventionalcommits.org/en/v1.0.0/
https://semver.org/
https://github.com/yeyushengfan258/Lyra-Cursors
https://github.com/lob/generate-changelog
Dear ImGui is licensed under the MIT License, see LICENSE.txt for more information.