C++ Installation

Integrate Dear ImGui Bundle in your own project in 5 minutes¶

The easiest way to use Dear ImGui Bundle in an external project is to use the template available at https://github.com/pthom/imgui_bundle_template.

This template includes everything you need to set up your own project.

Build from source¶

If you choose to clone this repo, follow these instructions:

git clone https://github.com/pthom/imgui_bundle.git
cd imgui_bundle
git submodule update --init --recursive # (1)
mkdir build
cd build
cmake ..
make -j

(1) Since there are lots of submodules, this might take a few minutes

Install as a CMake package¶

Dear ImGui Bundle can be installed with cmake --install, and then used from another project with find_package(imgui_bundle) (this is also the basis for package managers such as Conan). The cpp_package preset builds the C++ libraries (without the demos) and installs them into builds/cpp_package/install:

cmake --preset cpp_package
cmake --build builds/cpp_package/build --config Release
cmake --install builds/cpp_package/build --config Release

Then, in your project (see the template for a complete example):

find_package(imgui_bundle CONFIG REQUIRED)  # cmake -DCMAKE_PREFIX_PATH=/path/to/imgui_bundle/builds/cpp_package/install
imgui_bundle_add_app(my_app my_app.cpp)

(The template falls back to a local copy or to a download of imgui_bundle when no installed package is found; pass -Dimgui_bundle_DIR=/path/to/install/lib/cmake/imgui_bundle instead to require the installed package.)

Run the C++ demo¶

If you built ImGuiBundle from source, Simply run build/bin/demo_imgui_bundle.

The source for the demos can be found inside bindings/imgui_bundle/demos_cpp.

Multiplatform applications¶

Hello ImGui and Dear ImGui Bundle offer excellent support for multiplatform applications (Windows, macOS, Linux, iOS, Android, and Emscripten).

See this tutorial video for Hello ImGui: