UImGui

GitHub tag (latest by date)
_{(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. This project use FreeType as default renderer.

Using imgui 1.90.1

What is Dear ImGui?

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.

Motivation

To update (using ImGui.Net.dll) easier and often.

Features

Feature	RG	UImGui
IL2CPP	:x:	:heavy_check_mark:
Windows	:heavy_check_mark:	:heavy_check_mark:
Linux	:heavy_check_mark:	:heavy_check_mark:
MacOS	:heavy_check_mark:	:heavy_check_mark:
Custom Assert	:heavy_check_mark:	:x:
Unity Input Manager	:heavy_check_mark:	:heavy_check_mark:
Unity Input System	:heavy_check_mark:	:heavy_check_mark:
Docking	:x:	:heavy_check_mark:
RenderPipeline Built in	:heavy_check_mark:	:heavy_check_mark:
RenderPipeline URP	:x:	:heavy_check_mark:
RenderPipeline HDRP	:x:	:heavy_check_mark:
Renderer Mesh	:heavy_check_mark:	:heavy_check_mark:
Renderer Procedural	~	:heavy_check_mark:
FreeType	~	WIP
Image / Texture	:x:	:heavy_check_mark:
ImNodes	:x:	WIP
ImGuizmo	:x:	WIP
ImPlot	:x:	WIP

Usage

Add package from git URL: https://github.com/psydack/uimgui.git or add manually in your packages folders and update your manifest.json with the lastest version (e.g: "com.psydack.uimgui" : "5.0.0")
Add UImGui component to the scene and
(Optional) Set Platform Type to Input System if you're using the new input system the SampleDemoWindow object 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.
To use ImNodes, ImGuizmo or ImPlot check the sample script. If you won't use, you can disable using directives
(optional) You can build your ImGui.NET using my custom repo: ImGui.NET and ImGui.NET-nativebuild

Samples

It has a demo script called ShowDemoWindow 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 Events to true on UImGui instance.

using UImGui;
using UnityEngine;

public class StaticSample : MonoBehaviour
{
    private void Awake()
    {
        UImGuiUtility.Layout += OnLayout;
        UImGuiUtility.OnInitialize += OnInitialize;
        UImGuiUtility.OnDeinitialize += OnDeinitialize;
    }

    private void OnLayout(UImGui.UImGui obj)
    {
        // Unity Update method. 
        // Your code belongs here! Like ImGui.Begin... etc.
    }

    private void OnInitialize(UImGui.UImGui obj)
    {
        // runs after UImGui.OnEnable();
    }

    private void OnDeinitialize(UImGui.UImGui obj)
    {
        // runs after UImGui.OnDisable();
    }

    private void OnDisable()
    {
        UImGuiUtility.Layout -= OnLayout;
        UImGuiUtility.OnInitialize -= OnInitialize;
        UImGuiUtility.OnDeinitialize -= OnDeinitialize;
    }
}

To use instance instead a global UImGui, use like this.

using UnityEngine;

public class InstanceSample : MonoBehaviour
{
    [SerializeField]
    private UImGui.UImGui _uimGuiInstance;

    private void Awake()
    {
        if (_uimGuiInstance == null)
        {
            Debug.LogError("Must assign a UImGuiInstance or use UImGuiUtility with Do Global Events on UImGui component.");
        }

        _uimGuiInstance.Layout += OnLayout;
        _uimGuiInstance.OnInitialize += OnInitialize;
        _uimGuiInstance.OnDeinitialize += OnDeinitialize;
    }

    private void OnLayout(UImGui.UImGui obj)
    {
        // Unity Update method. 
        // Your code belongs here! Like ImGui.Begin... etc.
    }

    private void OnInitialize(UImGui.UImGui obj)
    {
        // runs after UImGui.OnEnable();
    }

    private void OnDeinitialize(UImGui.UImGui obj)
    {
        // runs after UImGui.OnDisable();
    }

    private void OnDisable()
    {
        _uimGuiInstance.Layout -= OnLayout;
        _uimGuiInstance.OnInitialize -= OnInitialize;
        _uimGuiInstance.OnDeinitialize -= OnDeinitialize;
    }
}

Sample code

[SerializeField]
private float _sliderFloatValue = 1;

[SerializeField]
private string _inputText;

// Add listeners, etc ...

private void OnLayout(UImGui.UImGui obj)
{
    ImGui.Text($"Hello, world {123}");
    if (ImGui.Button("Save"))
    {
        Debug.Log("Save");
    }

    ImGui.InputText("string", ref _inputText, 100);
    ImGui.SliderFloat("float", ref _sliderFloatValue, 0.0f, 1.0f);
}

[SerializeField]
private Vector4 _myColor;
private bool _isOpen;

private void OnLayout(UImGui.UImGui obj)
{
    // 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 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

[SerializeField]
private Texture _sampleTexture;

private void OnLayout(UImGui.UImGui obj)
{
    if (ImGui.Begin("Image Sample"))
    {
        System.IntPtr id = UImGuiUtility.GetTextureId(_sampleTexture);
        Vector2 size = new Vector2(_sampleTexture.width, _sampleTexture.height)
        ImGui.Image(id, size);

        ImGui.End();
    }
}

Custom UserData

[Serializable]
private struct UserData
{
    public int SomeCoolValue;
}

[SerializeField]
private UserData _userData;
private string _input = "";

// Add Listeners... etc.

private unsafe void OnInitialize(UImGui.UImGui uimgui)
{
    fixed (UserData* ptr = &_userData)
    {
        uimgui.SetUserData((IntPtr)ptr);
    }
}

private unsafe void OnLayout(UImGui.UImGui obj)
{
    if (ImGui.Begin("Custom UserData"))
    {
        fixed (UserData* ptr = &_userData)
        {
            ImGuiInputTextCallback customCallback = CustomCallback;
            ImGui.InputText("label", ref _input, 100, ~(ImGuiInputTextFlags)0, customCallback, (IntPtr)ptr);
        }

        ImGui.End();
    }
}

private unsafe int CustomCallback(ImGuiInputTextCallbackData* data)
{
    IntPtr userDataPtr = (IntPtr)data->UserData;
    if (userDataPtr != IntPtr.Zero)
    {
        UserData userData = Marshal.PtrToStructure<UserData>(userDataPtr);
        Debug.Log(userData.SomeCoolValue);
    }

    // You must to overwrite how you handle with new inputs.
    // ...

    return 1;
}

Custom font

Thanks
Check here for more information

First create a method with ImGuiIOPtr like this

public void AddJapaneseFont(ImGuiIOPtr io)
{
// you can put on StreamingAssetsFolder and call from there like:
//string fontPath = $"{Application.streamingAssetsPath}/NotoSansCJKjp - Medium.otf";
string fontPath = "D:\\Users\\rofli.souza\\Desktop\\NotoSansCJKjp-Medium.otf";
io.Fonts.AddFontFromFileTTF(fontPath, 18, null, io.Fonts.GetGlyphRangesJapanese());

// you can create a configs and do a lot of stuffs
//ImFontConfig fontConfig = default;
//ImFontConfigPtr fontConfigPtr = new ImFontConfigPtr(&fontConfig);
//fontConfigPtr.MergeMode = true;
//io.Fonts.AddFontDefault(fontConfigPtr);
//int[] icons = { 0xf000, 0xf3ff, 0 };
//fixed (void* iconsPtr = icons)
//{
//  io.Fonts.AddFontFromFileTTF("fontawesome-webfont.ttf", 18.0f, fontConfigPtr, (System.IntPtr)iconsPtr);
//}
}

Assign the object that contain these method in UImGui script

Create an awesome text:

if (ImGui.Begin("ウィンドウテスト"))
{
ImGui.Text("こんにちは！テスト");

ImGui.End();
}

Yay!

You can see more samples here.

Using URP

Add a Render Im Gui Feature render feature to the renderer asset.
Assign it to the render feature field of the DearImGui component.
Check this issue which I describe how to make it work step by step.

Using HDRP

When using the High Definition Render Pipeline;
Add a script called Custom Pass Volume anywhere on your scene;
Add "DearImGuiPass"
Update Injection Point to before or after post processing.
Good to go. Any doubts see this link

Using Built in

No special sets.

Directives

UIMGUI_REMOVE_IMPLOT: don't load implot lib and sources.
UIMGUI_REMOVE_IMNODES: don't load imnodes lib and sources.
UIMGUI_REMOVE_IMGUIZMO: don't load imguizmo lib and sources.

Known issues

Issue: Already using System.Runtime.CompilerServices.Unsafe.dll will cause the following error: Multiple precompiled assemblies with the same name System.Runtime.CompilerServices.Unsafe.dll included or the current platform Only one assembly with the same name is allowed per platform. Resolution: addUIMGUI_REMOVE_UNSAFE_DLL`` on Project Settings > Player > Other Settings > Script define symbols > Apply > Restart Unity Editor.

Issue: ImPlot isn't work right.

Issue: Font atlas crash. There's no fix. Use callback for custom font instead

Credits

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

License

Dear ImGui is licensed under the MIT License, see LICENSE.txt for more information.

psydack / uimgui

readme