ImGui

Immediate Mode GUI for C#

2 months after

Note: ImGui is being heavily refactored to employ a render-tree based architecture, so most features described below are not working for now. If you are interested in a working ImGui implementation, check out the old version, that rebuilds and repaints everything every frame.

Hello ImGui,

Hello ImGui is an immediate mode GUI library inspired by IMGUI of Unity3D and dear imgui.

code sample

Now it runs on Win10 x64, Ubuntu 16.04, and Android. See platforms. MAC and iphone are not supported because I don't have them.

Please be informed that ImGui is just released. There's a lack of usability and documentation. But all will be improved gradually.

Please note that the API is unstable and will change at any time.

Get Started

For Windows and Linux

  1. Preparation

    • Download msjh.ttf to directory ImGui\src\ImGui\assets\fonts. See font note.
  2. Create a .NET Core 2.0 project and reference ImGui.

  3. Add follwing code files to your project,

    Program.cs

    namespace YourApp
    {
        class Program
        {
            [STAThread]
            static void Main()
            {
                Application.Init();
                Application.Run(new MainForm());
            }
        }
    }

    MainForm.cs

    namespace YourApp
    {
        public class MainForm : Form
        {
            public MainForm() : base(new Rect(320, 180, 1280, 720)) { }
    
            protected override void OnGUI()
            {
                //your GUI code here
            }
        }
    }
  4. Build your project

  5. Run

    • run in VS2017: Press F5
    • run in Windows console:

      cd MyApp/bin/Debug/netcoreapp2.0
      dotnet MyApp.dll
    • run in Linux terminal:

      cd MyApp/bin/Debug/netcoreapp2.0
      dotnet MyApp.dll
  6. Exit

    Press Esc or click the close button of the window.

For Android

  1. Copy Android Templates project. The referenced Demo can be removed if you don't need that.
  2. Add your GUI code in MainForm.OnGUI.
  3. Build and deploy it to your Android device.

For now, please refer to the shared project Demo for how to use Hello ImGui.

Target

A Real Universal GUI Framework.

Dependency

  • ImageSharp: A cross-platform library for the processing of image files; written in C#. It provides image loading functions for ImGui.
  • Xamarin.Android: Xamarin.Android provides open-source bindings of the Android SDK for use with .NET managed languages such as C#. It mainly provides C# runtime for ImGui.

Credits

DroidSans.ttf, Droid Sans is a humanist sans serif typeface designed by Steve Matteson licenced under Apache 2.

ImGui doesn't depend on following projects, some code used by ImGui are taken from them.

  • Typography: C# Font Reader (TrueType / OpenType / OpenFont) , Glyphs Layout and Rendering
  • OpenTK: low-level C# wrapper for OpenGL
  • CSharpGL: Object Oriented OpenGL in C#
  • LogUtility: a light log tools

License

Hello ImGui is licensed under the LGPL License, see LICENSE for more information.

Related Repositories

imgui-rs

imgui-rs

Rust bindings for ImGui ...

love-imgui

love-imgui

imgui module for the LÖVE game engine ...

imgui-cmake

imgui-cmake

CMake support for https://github.com/ocornut/imgui ...

imgui-sdl-csgo

imgui-sdl-csgo

Proof of concept for implementing imgui into various Source games on Linux. ...

imgui-rs

imgui-rs

IMGUI-RS provides Rust bindings for IMGUI, a bloat-free intermediate mode GUI li ...