imgui

mirror of https://github.com/ocornut/imgui.git synced 2024-11-17 20:37:20 +01:00

History

ocornut b1a18d82e3 Moving backends code from examples/ to backends/ (step 6: update markdown documentation)		2020-10-14 14:42:00 +02:00
..
main.cpp	Moving backends code from examples/ to backends/ (step 6: update markdown documentation)	2020-10-14 14:42:00 +02:00
Makefile	Moving backends code from examples/ to backends/ (step 3: fixing project files)	2020-10-14 14:41:40 +02:00
README.md	Docs: Renamed all occurences of "binding" and "back-end" to "backend" in comments and documentations, for consistency.	2020-10-12 17:54:52 +02:00
shell_minimal.html	emscripten: replace shell_minimal.html with 'soft fullscreen' version	2019-04-17 11:59:26 +02:00

How to Build

You need to install Emscripten from https://emscripten.org/docs/getting_started/downloads.html, and have the environment variables set, as described in https://emscripten.org/docs/getting_started/downloads.html#installation-instructions
You may also refer to our Continuous Integration setup for Emscripten setup.
Depending on your configuration, in Windows you may need to run emsdk/emsdk_env.bat in your console to access the Emscripten command-line tools.
Then build using make while in the example_emscripten/ directory.

To run on a local machine:

Generally you may need a local webserver. Quoting https://emscripten.org/docs/getting_started:
"Unfortunately several browsers (including Chrome, Safari, and Internet Explorer) do not support file:// XHR requests, and can’t load extra files needed by the HTML (like a .wasm file, or packaged file data as mentioned lower down). For these browsers you’ll need to serve the files using a local webserver and then open http://localhost:8000/hello.html."
Emscripten SDK has a handy emrun command: emrun example_emscripten.html which will spawn a temporary local webserver. See https://emscripten.org/docs/compiling/Running-html-files-with-emrun.html for details.
Otherwise you may use Python builtin webserver: python -m http.server in Python 3 or python -m SimpleHTTPServer in Python 2. After doing that, you can visit http://localhost:8000/.

Emscripten 2.0 (August 2020) obsoleted the fastcomp backend, only llvm is supported.
Emscripten 1.39.0 (October 2019) obsoleted the BINARYEN_TRAP_MODE=clamp compilation flag which was required with version older than 1.39.0 to avoid rendering artefacts. See #2877 for details. If you use an older version, uncomment this line in the Makefile: #EMS += -s BINARYEN_TRAP_MODE=clamp