ImGui + SFML

Library which allows you to use ImGui with SFML Based on this repository with some improvements / changes.

How-to

Detailed tutorial on my blog

Setting up:

• Download ImGui
• Add ImGui folder to your include directories
• Add imgui.cpp and imgui_draw.cpp to your build/project
• Copy the contents of imconfig-SFML.h to your imconfig.h file. (to be able to cast ImVec2 to sf::Vector2f and vice versa)
• Add a folder which contains imgui-SFML.h to your include directories
• Add imgui-SFML.cpp to your build/project

In your code:

• Call ImGui::SFML::Init and pass your sf::Window + sf::RenderTarget or sf::RenderWindow there

• For each iteration of a game loop:

  • Poll and process events:

    sf::Event event;
    while (window.pollEvent(event)) {
        ImGui::SFML::ProcessEvent(event);
        ...
    }

  • Call ImGui::SFML::Update(deltaTime) where deltaTime is sf::Time

  • Call ImGui functions (ImGui::Begin(), ImGui::Button(), etc.)

  • Call ImGui::EndFrame if you update more than once before rendering (you'll need to include imgui_internal.h for that)

  • Call ImGui::Render()

• Call ImGui::SFML::Shutdown() at the end of your program

Example code

See example file here

#include "imgui.h"
#include "imgui-SFML.h"
 
#include <SFML/Graphics/RenderWindow.hpp>
#include <SFML/System/Clock.hpp>
#include <SFML/Window/Event.hpp>
 
int main()
{
    sf::RenderWindow window(sf::VideoMode(800, 600), "ImGui + SFML = <3");
    window.setFramerateLimit(60);
    ImGui::SFML::Init(window);

    sf::Clock deltaClock;
    while (window.isOpen()) {
        sf::Event event;
        while (window.pollEvent(event)) {
            ImGui::SFML::ProcessEvent(event);

            if (event.type == sf::Event::Closed) {
                window.close();
            }
        }

        ImGui::SFML::Update(deltaClock.restart());

        ImGui::Begin("Hello, world!");
        ImGui::Button("Look at this pretty button");
        ImGui::End();

        window.clear();
        ImGui::Render();
        window.display();
    }

    ImGui::SFML::Shutdown();
}

CMake how-to

• Checkout the repository as a submoudle
• Set IMGUI_ROOT
• Modify your builds to copy imgui-SFML and dependencies (sfml) to your project

add_subdirectory(repos/imgui-sfml)
include_directories("${IMGUI_SFML_INCLUDE_DIRS}")
add_executable(MY_PROJECT ${IMGUI_SOURCES} ${IMGUI_SFML_SOURCES} ${SRCS})
...
target_link_libraries(MY_PROJECT ${IMGUI_SFML_DEPENDENCIES})

SFML related ImGui overloads / new widgets

There are some useful overloads implemented for SFML objects (see header for overloads):

ImGui::Image(const sf::Sprite& sprite);
ImGui::Image(const sf::Texture& texture);
ImGui::ImageButton(const sf::Sprite& sprite);
ImGui::ImageButton(const sf::Texture& texture);

License

This library is licensed under the MIT License, see LICENSE for more information.