ktsu.ImGuiApp 1.12.4

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer prerelease version of this package available.
See the version list below for details. 
dotnet add package ktsu.ImGuiApp --version 1.12.4
                    


                    

                
NuGet\Install-Package ktsu.ImGuiApp -Version 1.12.4
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="ktsu.ImGuiApp" Version="1.12.4" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="ktsu.ImGuiApp" Version="1.12.4" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="ktsu.ImGuiApp" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add ktsu.ImGuiApp --version 1.12.4
                    


                    

                
#r "nuget: ktsu.ImGuiApp, 1.12.4"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#addin nuget:?package=ktsu.ImGuiApp&version=1.12.4
                    


                            Install ktsu.ImGuiApp as a Cake Addin
                        

                    

                
#tool nuget:?package=ktsu.ImGuiApp&version=1.12.4
                    


                            Install ktsu.ImGuiApp as a Cake Tool

ktsu.ImGuiApp

A .NET library that provides application scaffolding for Dear ImGui, using Silk.NET and ImGui.NET.

NuGet License

Features

  • Provides a simple-to-use API for creating ImGui applications.
  • Uses Silk.NET for OpenGL and input handling.
  • Manages window state, rendering, and input handling.
  • DPI-aware scaling and offscreen positioning checks for window management.
  • Built-in font loading system and texture management for ImGui.
  • Flexible delegate callbacks for application lifecycle and menu handling.
  • Sample project that demonstrates how to use the library in a .NET application.
  • Supports .NET 8 and newer.
  • Open-source and actively maintained.

Installation

To install ImGuiApp, you can use the .NET CLI:

dotnet add package ktsu.ImGuiApp

Or by adding the package reference to your project file:

<PackageReference Include="ktsu.ImGuiApp" Version="X.X.X" />

Or you can use the NuGet Package Manager in Visual Studio to search for and install the ktsu.ImGuiApp package.

Quick Start

Create a new class and call ImGuiApp.Start() with your application config:

using ktsu.ImGuiApp;
using ImGuiNET;

static class Program
{
    static void Main()
    {
        ImGuiApp.Start(new AppConfig()
        {
            Title = "ImGuiApp Demo",
            OnStart = () => { /* Initialization code */ },
            OnUpdate = delta => { /* Logic updates */ },
            OnRender = delta => { ImGui.Text("Hello, ImGuiApp!"); },
            OnAppMenu = () =>
            {
                if (ImGui.BeginMenu("File"))
                {
                    // Menu items
                    if (ImGui.MenuItem("Exit"))
                    {
                        ImGuiApp.Stop();
                    }
                    ImGui.EndMenu();
                }
            }
        });
    }
}

Demo Application

  1. Clone or download the repository.
  2. Open the solution in Visual Studio (or run dotnet build).
  3. Start the ImGuiAppDemo project to see a basic ImGui application.

Using FontAppearance to Customize Fonts

Use the resource designer to add font files to your project, then load the fonts using the ImGuiApp.Start() call:

ImGuiApp.Start(new()
{
    Title = "ImGuiApp Demo",
    OnRender = OnRender,
    Fonts = Fonts = new Dictionary<string, byte[]>
    {
        { nameof(Resources.MY_FONT), Resources.MY_FONT }
    },
});

Or load the font data manually and pass the data to the ImGuiApp.Start() call:

var fontData = File.ReadAllBytes("path/to/font.ttf");
ImGuiApp.Start(new()
{
    Title = "ImGuiApp Demo",
    OnRender = OnRender,
    Fonts = new Dictionary<string, byte[]>
    {
        { "MyFont", fontData }
    },
});

Then apply the font to ImGui using the FontAppearance class:

private static void OnRender(float deltaTime)
{
    ImGui.Text("Hello, I am normal text!");

    using (new FontAppearance("MyFont", 24))
    {
        ImGui.Text("Hello, I am BIG fancy text!");
    }

    using (new FontAppearance(32))
    {
        ImGui.Text("Hello, I am just huge text!");
    }

    using (new FontAppearance("MyFont"))
    {
        ImGui.Text("Hello, I am somewhat fancy!");
    }
}

Texture Management

Load and manage textures using ImGuiApp.GetOrLoadTexture, ImGuiApp.UploadTextureRGBA, and ImGuiApp.DeleteTexture:

var textureId = ImGuiApp.GetOrLoadTexture("path/to/texture.png");
ImGui.Image(textureId, new Vector2(128, 128));

Contributing

Contributions are welcome! Please submit issues and pull requests to help improve the library.

Versioning

Check the CHANGELOG.md for detailed release notes and version changes.

License

ImGuiApp is licensed under the MIT License. See the LICENSE.md file for more information.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.12.5-pre.2 98 4/4/2025
1.12.5-pre.1 97 4/4/2025
1.12.4 104 4/4/2025
1.12.3 148 3/30/2025
1.12.2 214 3/30/2025
1.12.1 81 3/29/2025
1.12.0 151 3/21/2025
1.11.1-pre.1 111 3/20/2025
1.11.0 176 3/19/2025
1.10.0 186 3/17/2025
1.9.0 118 3/15/2025
1.8.1 123 3/15/2025
1.8.0 195 3/14/2025
1.7.1 210 3/12/2025
1.7.0 217 3/12/2025
1.6.1-pre.1 124 3/12/2025
1.6.0 217 3/12/2025
1.5.1-pre.1 131 3/11/2025
1.5.0 312 3/7/2025
1.4.1-pre.3 170 3/6/2025
1.4.1-pre.2 64 2/19/2025
1.4.1-pre.1 68 2/17/2025
1.4.0 351 2/17/2025
1.3.1-pre.1 70 2/11/2025
1.3.0 669 2/7/2025
1.2.1-pre.1 62 2/6/2025
1.2.0 245 2/5/2025
1.1.0 1,028 1/5/2025
1.0.12 189 12/28/2024
1.0.12-pre.11 74 1/4/2025
1.0.12-pre.10 72 1/3/2025
1.0.12-pre.9 59 1/3/2025
1.0.12-pre.8 61 1/3/2025
1.0.12-pre.7 62 1/3/2025
1.0.12-pre.6 60 1/1/2025
1.0.12-pre.5 78 12/31/2024
1.0.12-pre.4 55 12/29/2024
1.0.12-pre.3 53 12/28/2024
1.0.12-pre.2 53 12/27/2024
1.0.12-pre.1 49 12/27/2024
1.0.11-pre.1 49 12/27/2024
1.0.10-pre.1 59 12/27/2024
1.0.9 135 12/26/2024
1.0.8 121 12/26/2024
1.0.7 123 12/25/2024
1.0.6 146 12/24/2024
1.0.5 122 12/23/2024
1.0.4 92 12/23/2024
1.0.3 259 12/19/2024
1.0.2 158 12/17/2024
1.0.1 174 12/13/2024
1.0.0 198 12/9/2024
1.0.0-alpha.76 104 12/7/2024
1.0.0-alpha.75 73 12/6/2024
1.0.0-alpha.74 101 12/5/2024
1.0.0-alpha.73 173 12/2/2024
1.0.0-alpha.72 64 12/2/2024
1.0.0-alpha.71 81 12/1/2024
1.0.0-alpha.70 83 11/30/2024
1.0.0-alpha.69 77 11/29/2024
1.0.0-alpha.68 88 11/28/2024
1.0.0-alpha.67 112 11/26/2024
1.0.0-alpha.66 160 11/21/2024
1.0.0-alpha.65 107 11/20/2024
1.0.0-alpha.64 123 11/17/2024
1.0.0-alpha.63 61 11/15/2024
1.0.0-alpha.62 84 11/14/2024
1.0.0-alpha.61 94 11/13/2024
1.0.0-alpha.60 151 11/7/2024
1.0.0-alpha.59 57 11/7/2024
1.0.0-alpha.58 76 11/6/2024
1.0.0-alpha.57 104 11/5/2024
1.0.0-alpha.56 210 11/2/2024
1.0.0-alpha.55 66 11/1/2024
1.0.0-alpha.54 346 10/18/2024
1.0.0-alpha.53 315 10/9/2024
1.0.0-alpha.52 101 10/8/2024
1.0.0-alpha.51 126 10/5/2024
1.0.0-alpha.50 80 10/4/2024
1.0.0-alpha.49 258 9/25/2024
1.0.0-alpha.48 94 9/24/2024
1.0.0-alpha.47 113 9/21/2024
1.0.0-alpha.46 101 9/19/2024
1.0.0-alpha.45 59 9/19/2024
1.0.0-alpha.44 86 9/19/2024
1.0.0-alpha.43 53 9/19/2024
1.0.0-alpha.42 94 9/19/2024
1.0.0-alpha.41 103 9/18/2024
1.0.0-alpha.40 62 9/18/2024
1.0.0-alpha.39 82 9/18/2024
1.0.0-alpha.38 74 9/18/2024
1.0.0-alpha.37 110 9/18/2024
1.0.0-alpha.36 222 9/14/2024

## v1.12.4 (patch)

Changes since v1.12.3:

- Update .gitignore to include additional IDE and OS-specific files ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.12.3 (patch)

Changes since v1.12.2:

- Update packages ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.12.2 (patch)

Changes since v1.12.1:

- Add LICENSE template ([@matt-edmondson](https://github.com/matt-edmondson))
- Update build scripts ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.12.1 (patch)

Changes since v1.12.0:

- Update packages ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.12.0 (minor)

Changes since v1.11.0:

- Throw an exception if the font is not ready yet for some reason ([@matt-edmondson](https://github.com/matt-edmondson))
- Try a different method of memory marshaling and reorder some thigns to try fix the font crash ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.11.0 (minor)

Changes since v1.10.0:

- Replace the Silk.NET window invoker with ktsu.Invoker ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.10.0 (minor)

Changes since v1.9.0:

- Font system cleanup ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.9.0 (minor)

Changes since v1.8.0:

- Add an image to the demo app to test the texture upload ([@matt-edmondson](https://github.com/matt-edmondson))
- Add an overload to ImGuiController.Texture to allow specifying the pixel format ([@matt-edmondson](https://github.com/matt-edmondson))
- Re-add icon to fix LFS ([@matt-edmondson](https://github.com/matt-edmondson))
- Remove icon to fix LFS ([@matt-edmondson](https://github.com/matt-edmondson))
- Reuse the texture upload from ImGuiController to remove code duplication ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.8.1 (patch)

Changes since v1.8.0:

- Re-add icon to fix LFS ([@matt-edmondson](https://github.com/matt-edmondson))
- Remove icon to fix LFS ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.8.0 (minor)

Changes since v1.7.0:

- Add constructors and documentation to FontAppearance class ([@matt-edmondson](https://github.com/matt-edmondson))
- Enhance documentation ([@matt-edmondson](https://github.com/matt-edmondson))
- Refactor font loading to use unmanaged memory ([@matt-edmondson](https://github.com/matt-edmondson))
- Renamed several classes and moved them to their own source files ([@matt-edmondson](https://github.com/matt-edmondson))
- Update license links in README.md ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.7.1 (patch)

Changes since v1.7.0:

- Add constructors and documentation to FontAppearance class ([@matt-edmondson](https://github.com/matt-edmondson))
- Enhance documentation ([@matt-edmondson](https://github.com/matt-edmondson))
- Renamed several classes and moved them to their own source files ([@matt-edmondson](https://github.com/matt-edmondson))
- Update license links in README.md ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.7.0 (minor)

Changes since v1.6.0:

- Add better font management to ImGuiApp and icon to demo project ([@matt-edmondson](https://github.com/matt-edmondson))
- Fix crash on shutdown when imgui would try to free memory owned by dotnet ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.6.0 (minor)

Changes since v1.5.0:

- Remove unnesscessary threading protections that were speculative fixes for the font ownership crash ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.5.0 (minor)

Changes since v1.4.0:

- Refactor ImGuiApp and related classes for thread safety ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.4.0 (minor)

Changes since v1.3.0:

- Apply new editorconfig ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.3.0 (minor)

Changes since v1.2.0:

- Always call ImGui.End for ImGui.Begin ([@Damon3000s](https://github.com/Damon3000s))

## v1.2.0 (minor)

Changes since v1.1.0:

- Call EndChild instead of just End ([@Damon3000s](https://github.com/Damon3000s))
- Enable debug tracing in versioning and changelog scripts; handle empty tag scenarios ([@matt-edmondson](https://github.com/matt-edmondson))
- Replace deprecated ImGui enum value ([@Damon3000s](https://github.com/Damon3000s))
- Update files from Resources.resx ([@Damon3000s](https://github.com/Damon3000s))

## v1.1.0 (minor)

Changes since v1.0.0:

- Add automation scripts for metadata and version management ([@matt-edmondson](https://github.com/matt-edmondson))
- Add conditional compilation for contextLock in ImGuiController ([@matt-edmondson](https://github.com/matt-edmondson))
- Add Silk.NET packages for enhanced graphics and input support ([@matt-edmondson](https://github.com/matt-edmondson))
- Fix mouse wheel scrolling and improve API usage ([@Damon3000s](https://github.com/Damon3000s))
- Fix version script to exclude merge commits and order logs correctly ([@matt-edmondson](https://github.com/matt-edmondson))
- Remove spelling check ignore comments in ImGuiApp files ([@matt-edmondson](https://github.com/matt-edmondson))
- Renamed metadata files ([@matt-edmondson](https://github.com/matt-edmondson))
- Replace LICENSE file with LICENSE.md and update copyright information ([@matt-edmondson](https://github.com/matt-edmondson))
- Review feedback ([@Damon3000s](https://github.com/Damon3000s))

## v1.0.12 (patch)

Changes since v1.0.12-pre.11:

- Add automation scripts for metadata and version management ([@matt-edmondson](https://github.com/matt-edmondson))
- Fix mouse wheel scrolling and improve API usage ([@Damon3000s](https://github.com/Damon3000s))
- Fix version script to exclude merge commits and order logs correctly ([@matt-edmondson](https://github.com/matt-edmondson))
- Review feedback ([@Damon3000s](https://github.com/Damon3000s))

## v1.0.8 (patch)

Changes since v1.0.7:

- Replace LICENSE file with LICENSE.md and update copyright information ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.0.4 (patch)

Changes since v1.0.3:

- Add conditional compilation for contextLock in ImGuiController ([@matt-edmondson](https://github.com/matt-edmondson))

## v1.0.0 (major)

Changes since 0.0.0.0:

- #1 Track the state of the window when its in the Normal state ([@matt-edmondson](https://github.com/matt-edmondson))
- Add a method to convert ems to pixels based on the current font size ([@matt-edmondson](https://github.com/matt-edmondson))
- Add a property for getting the current window state from the app and correctly set the position and layout from the initial window state ([@matt-edmondson](https://github.com/matt-edmondson))
- Add action to publish to nuget ([@matt-edmondson](https://github.com/matt-edmondson))
- Add an onStart delegate ([@matt-edmondson](https://github.com/matt-edmondson))
- Add divider widgets to ImGuiApp ([@matt-edmondson](https://github.com/matt-edmondson))
- Add dpi dependent content scaling ([@matt-edmondson](https://github.com/matt-edmondson))
- Add frame limiting ([@matt-edmondson](https://github.com/matt-edmondson))
- Add github package support ([@matt-edmondson](https://github.com/matt-edmondson))
- Add medium font ([@matt-edmondson](https://github.com/matt-edmondson))
- Add methods to allow saving and restoring divider states in bulk and add a delegate that gets called when a zone is resized ([@matt-edmondson](https://github.com/matt-edmondson))
- Add more locks for GL ([@matt-edmondson](https://github.com/matt-edmondson))
- Add Stop() method to quit the application ([@matt-edmondson](https://github.com/matt-edmondson))
- Add the ability to set the window icon ([@matt-edmondson](https://github.com/matt-edmondson))
- Added methods for loading textures ([@matt-edmondson](https://github.com/matt-edmondson))
- Also dont render if the window is not visible ([@matt-edmondson](https://github.com/matt-edmondson))
- Assign dependabot PRs to matt ([@matt-edmondson](https://github.com/matt-edmondson))
- Avoid double upload of symbols package ([@matt-edmondson](https://github.com/matt-edmondson))
- Bump ktsu.StrongPaths from 1.1.29 to 1.1.30 ([@matt-edmondson](https://github.com/matt-edmondson))
- Cleanup and force demo window open for debug ([@matt-edmondson](https://github.com/matt-edmondson))
- Cleanup and reduce code duplication ([@matt-edmondson](https://github.com/matt-edmondson))
- Consume the resize and move events from silk to actually call the resize delegate ([@matt-edmondson](https://github.com/matt-edmondson))
- Copy ImGuiController from Silk.NET ([@matt-edmondson](https://github.com/matt-edmondson))
- Create dependabot.yml ([@matt-edmondson](https://github.com/matt-edmondson))
- Create VERSION ([@matt-edmondson](https://github.com/matt-edmondson))
- Destroy and clear fonts on shutdown before the imgui context gets destroyed ([@matt-edmondson](https://github.com/matt-edmondson))
- Documentation and warning fixes ([@matt-edmondson](https://github.com/matt-edmondson))
- Dont try to push packages when building pull requests ([@matt-edmondson](https://github.com/matt-edmondson))
- Enable sourcelink ([@matt-edmondson](https://github.com/matt-edmondson))
- Expose the Scale Factor to the public api so that clients can scale their custom things accordingly ([@matt-edmondson](https://github.com/matt-edmondson))
- Fix a crash calling an ImGui style too early in the initialization ([@matt-edmondson](https://github.com/matt-edmondson))
- Fix build and remove obsolete files and settings ([@matt-edmondson](https://github.com/matt-edmondson))
- Fix issue with OnStart being invoked too early ([@matt-edmondson](https://github.com/matt-edmondson))
- Fix namespacing to include ImGuiApp and make it filescoped and apply code style rules ([@matt-edmondson](https://github.com/matt-edmondson))
- Implement net6 DllImports ([@matt-edmondson](https://github.com/matt-edmondson))
- Initial commit ([@matt-edmondson](https://github.com/matt-edmondson))
- Migrate demo to net8 ([@matt-edmondson](https://github.com/matt-edmondson))
- Migrate ktsu.io to ktsu namespace ([@matt-edmondson](https://github.com/matt-edmondson))
- Migrate to Silk.NET for windowing/graphics backend ([@matt-edmondson](https://github.com/matt-edmondson))
- Minor code style changes ([@matt-edmondson](https://github.com/matt-edmondson))
- More detailed exception message in TranslateInputKeyToImGuiKey ([@Damon3000s](https://github.com/Damon3000s))
- Move OnStart callsite to a place where font loading works with Silk.NET, and add a demo project ([@matt-edmondson](https://github.com/matt-edmondson))
- Prevent drawing an extra border around the main window ([@matt-edmondson](https://github.com/matt-edmondson))
- Read from AUTHORS file during build ([@matt-edmondson](https://github.com/matt-edmondson))
- Read from VERSION when building ([@matt-edmondson](https://github.com/matt-edmondson))
- Read PackageDescription from DESCRIPTION file ([@matt-edmondson](https://github.com/matt-edmondson))
- Reduce background tick rates ([@matt-edmondson](https://github.com/matt-edmondson))
- Reformat ImGuiController instantiation for readability ([@matt-edmondson](https://github.com/matt-edmondson))
- Remove DividerContainers and zones and Extensions which have been moved to their own respective libraries ([@matt-edmondson](https://github.com/matt-edmondson))
- Remove windows only flags and migrate to nested Directory.Build.props ([@matt-edmondson](https://github.com/matt-edmondson))
- Reposition the window if it becomes completely offscreen ([@matt-edmondson](https://github.com/matt-edmondson))
- Roll back code style changes to a working version ([@matt-edmondson](https://github.com/matt-edmondson))
- Rollback net6 imports ([@matt-edmondson](https://github.com/matt-edmondson))
- Separate application update and render so we dont render when the application is minimized ([@matt-edmondson](https://github.com/matt-edmondson))
- Set System.Text.Json to 8.0.5 ([@Damon3000s](https://github.com/Damon3000s))
- Speculative fix for crash on shutdown ([@matt-edmondson](https://github.com/matt-edmondson))
- Sync workflows ([@matt-edmondson](https://github.com/matt-edmondson))
- Take a lock during the closing delegate ([@matt-edmondson](https://github.com/matt-edmondson))
- Tell imgui were responsible for owning the font atlas data and then free it ourselves on shutdown ([@matt-edmondson](https://github.com/matt-edmondson))
- Update build actions ([@matt-edmondson](https://github.com/matt-edmondson))
- Update build config ([@matt-edmondson](https://github.com/matt-edmondson))
- Update Directory.Build.props ([@matt-edmondson](https://github.com/matt-edmondson))
- Update Directory.Build.targets ([@matt-edmondson](https://github.com/matt-edmondson))
- Update dotnet.yml ([@matt-edmondson](https://github.com/matt-edmondson))
- Update ImGui.NET ([@matt-edmondson](https://github.com/matt-edmondson))
- Update LICENSE ([@matt-edmondson](https://github.com/matt-edmondson))
- Update nuget.config ([@matt-edmondson](https://github.com/matt-edmondson))
- Update project properties to enable windows targeting to allow building on linux build servers ([@matt-edmondson](https://github.com/matt-edmondson))
- Update VERSION ([@matt-edmondson](https://github.com/matt-edmondson))
- Use a concurrent dictionary for textures ([@matt-edmondson](https://github.com/matt-edmondson))
- v1.0.0-alpha.9 ([@matt-edmondson](https://github.com/matt-edmondson))