ImGuiApp Demo Project

This project show cases a sample application using ImGuiApp.

ImGuiApp provides some basic functionality needed to quickly create C++ gui applications using the GLFW and OpenGL backends of Dear ImGui. ImGuiApp uses CMake and has been tested on Windows 11 (MinGW & Clang 18.1.5) and Linux (Ubuntu 22.04 with GNU 11.4.0 compiler).

This project is inspired by Walnut which is built using uses Vulkan instead of OpenGL.

ImGuiApp Demo Application

ImGuiApp Demo Application with undocked windows

Requirements

• CMake
• Clang or MinGW (Windows) or Your favorite Linux C++ compile (Linux)
• IDE of choice Visual Studio Code (tested) or Visual Studio 2022 (not fully tested)

Getting Started

1. Clone the repository

   git clone --recursive https://github.com/MasterpieceNKA/ImGuiApp_Demo.git
   
   cd ImGuiApp_Demo

2. Build and run the project depending on Operating System

   For Windows or Linux build and run the project using (with clang compiler)

   mkdir build 
   
   cd build
   
   cmake ..
   
   cmake --build .
   
   .\bin\Debug\ImGuiApp_Demo

   For Windows or Linux build and run the project using (with default compiler)

   
   mkdir build 
   
   cd build
   
   cmake .. -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_C_COMPILER=clang
   
   cmake --build .
   
   .\bin\Debug\ImGuiApp_Demo
   
   

   Or using provided build scripts for Windows that either Clang .\debugBuild_clang.bat or MinGW .\debugBuild_MinGW.bat

3. Customise and use other project structures according to your needs

Example project structure setups for using ImGuiApp

3rd party libaries

• Dear ImGui
• GLFW
• GLEW
• GLM
• spdlog

Additional

• ImGuiApp uses the Roboto font (Apache License, Version 2.0)
• Documentation generated using Doxygen