Skip to content
Dear ImGui over WebSockets
C++ JavaScript CMake
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples Reorganizing files + fix sdl2 example Jul 13, 2019
include/imgui-ws ref #2 : add tool 'compressor-benchmark' Jul 13, 2019
src update latest submodules : incppect, imgui Nov 13, 2019
third-party update latest submodules : incppect, imgui Nov 13, 2019
tools
.gitignore .gitignore update Nov 13, 2019
.gitmodules Major refactoring Jul 6, 2019
.travis.yml fix travis builds Nov 13, 2019
CMakeLists.txt Reorganizing files + fix sdl2 example Jul 13, 2019
LICENSE Initial commit Jun 30, 2019
README.md Update README.md Nov 12, 2019

README.md

Build Status

imgui-ws

Dear ImGui over WebSockets

This is a small library that allows to stream a Dear ImGui scene to multiple WebSocket clients at once. This is achieved by sending Dear ImGui's DrawData structure which is then rendered in the browser using WebGL. To reduce the amount of network traffic, we send only the diffs between sequential frames (for more info - see #1).

Live examples

These are sample applications using imgui-ws, running on a Linode 2GB instance:

Example URL Description
demo-null http://imgui-ws.ggerganov.com:5001/ Dear ImGui's demo app
basic-null http://imgui-ws.ggerganov.com:5002/ Basic read-only data visualization

Tools

There are a few tools that help with the development and the optimization of the ImDrawData compression:

  • record-sdl2

    Record the ImDrawData for all rendered frames in a Dear ImGui session

    ./bin/record-sdl2 session.imdd
    
  • replay-sdl2

    Replay a session recorded with the record-sdl2 tool

    ./bin/replay-sdl2 session.imdd
    
  • compressor-benchmark

    Run the available ImDrawData compression algorithms on various pre-recorded Dear ImGui sessions. Reports compression ratio, average required bandwidth and cpu utilization:

    ./bin/compressor-benchmark session0.imdd [session1.imdd] [session2.imdd] [...]
    

Building & running

# build
git clone https://github.com/ggerganov/imgui-ws --recursive
cd imgui-ws && mkdir build && cd build
cmake ..
make

# running
./bin/demo-null 5000

Open some browsers and point them to http://localhost:5000/

Dependencies

Screenshot

imgui-ws

Credits

You can’t perform that action at this time.