UImGui

What is Dear ImGui?

Features

Usage

Using URP

Using HDRP

Examples

Basic

using UImGui;
using ImGuiNET;
using UnityEngine;
public class StaticSample : MonoBehaviour
{
	private void Awake()
	{
		UImGuiUtility.Layout += OnLayout;
	}
	private void OnLayout(UImGui.UImGui obj)
	{
		// Unity Update method. 
		// Your code belongs here! Like ImGui.Begin... etc.
		ImGui.ShowDemoWindow();
	}
	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;
	}
}

Simple Example

[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);
}

More Complex Example

[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[] myValues = new float[] { 0.2f, 0.1f, 1.0f, 0.5f, 0.9f, 2.2f };
	ImGui.PlotLines("Frame Times", ref myValues[0], myValues.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 Example

[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 Example

[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

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);
	//}
}

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

Authors

License