summaryrefslogtreecommitdiffstats
path: root/src/imgui/examples/example_emscripten_wgpu
diff options
context:
space:
mode:
authorNao Pross <np@0hm.ch>2024-02-12 14:52:43 +0100
committerNao Pross <np@0hm.ch>2024-02-12 14:52:43 +0100
commiteda5bc26f44ee9a6f83dcf8c91f17296d7fc509d (patch)
treebc2efa38ff4e350f9a111ac87065cd7ae9a911c7 /src/imgui/examples/example_emscripten_wgpu
downloadfsisotool-eda5bc26f44ee9a6f83dcf8c91f17296d7fc509d.tar.gz
fsisotool-eda5bc26f44ee9a6f83dcf8c91f17296d7fc509d.zip
Move into version control
Diffstat (limited to '')
-rw-r--r--src/imgui/examples/example_emscripten_wgpu/Makefile88
-rw-r--r--src/imgui/examples/example_emscripten_wgpu/README.md24
-rw-r--r--src/imgui/examples/example_emscripten_wgpu/main.cpp254
3 files changed, 366 insertions, 0 deletions
diff --git a/src/imgui/examples/example_emscripten_wgpu/Makefile b/src/imgui/examples/example_emscripten_wgpu/Makefile
new file mode 100644
index 0000000..5c79f0c
--- /dev/null
+++ b/src/imgui/examples/example_emscripten_wgpu/Makefile
@@ -0,0 +1,88 @@
+#
+# Makefile to use with emscripten
+# See https://emscripten.org/docs/getting_started/downloads.html
+# for installation instructions.
+#
+# This Makefile assumes you have loaded emscripten's environment.
+# (On Windows, you may need to execute emsdk_env.bat or encmdprompt.bat ahead)
+#
+# Running `make` will produce three files:
+# - web/index.html (current stored in the repository)
+# - web/index.js
+# - web/index.wasm
+#
+# All three are needed to run the demo.
+
+CC = emcc
+CXX = em++
+WEB_DIR = web
+EXE = $(WEB_DIR)/index.js
+IMGUI_DIR = ../..
+SOURCES = main.cpp
+SOURCES += $(IMGUI_DIR)/imgui.cpp $(IMGUI_DIR)/imgui_demo.cpp $(IMGUI_DIR)/imgui_draw.cpp $(IMGUI_DIR)/imgui_tables.cpp $(IMGUI_DIR)/imgui_widgets.cpp
+SOURCES += $(IMGUI_DIR)/backends/imgui_impl_glfw.cpp $(IMGUI_DIR)/backends/imgui_impl_wgpu.cpp
+OBJS = $(addsuffix .o, $(basename $(notdir $(SOURCES))))
+UNAME_S := $(shell uname -s)
+CPPFLAGS =
+LDFLAGS =
+EMS =
+
+##---------------------------------------------------------------------
+## EMSCRIPTEN OPTIONS
+##---------------------------------------------------------------------
+
+# ("EMS" options gets added to both CPPFLAGS and LDFLAGS, whereas some options are for linker only)
+EMS += -s DISABLE_EXCEPTION_CATCHING=1
+LDFLAGS += -s USE_GLFW=3 -s USE_WEBGPU=1
+LDFLAGS += -s WASM=1 -s ALLOW_MEMORY_GROWTH=1 -s NO_EXIT_RUNTIME=0 -s ASSERTIONS=1
+
+# Emscripten allows preloading a file or folder to be accessible at runtime.
+# The Makefile for this example project suggests embedding the misc/fonts/ folder into our application, it will then be accessible as "/fonts"
+# See documentation for more details: https://emscripten.org/docs/porting/files/packaging_files.html
+# (Default value is 0. Set to 1 to enable file-system and include the misc/fonts/ folder as part of the build.)
+USE_FILE_SYSTEM ?= 0
+ifeq ($(USE_FILE_SYSTEM), 0)
+LDFLAGS += -s NO_FILESYSTEM=1
+CPPFLAGS += -DIMGUI_DISABLE_FILE_FUNCTIONS
+endif
+ifeq ($(USE_FILE_SYSTEM), 1)
+LDFLAGS += --no-heap-copy --preload-file ../../misc/fonts@/fonts
+endif
+
+##---------------------------------------------------------------------
+## FINAL BUILD FLAGS
+##---------------------------------------------------------------------
+
+CPPFLAGS += -I$(IMGUI_DIR) -I$(IMGUI_DIR)/backends
+#CPPFLAGS += -g
+CPPFLAGS += -Wall -Wformat -Os $(EMS)
+#LDFLAGS += --shell-file shell_minimal.html
+LDFLAGS += $(EMS)
+
+##---------------------------------------------------------------------
+## BUILD RULES
+##---------------------------------------------------------------------
+
+%.o:%.cpp
+ $(CXX) $(CPPFLAGS) $(CXXFLAGS) -c -o $@ $<
+
+%.o:$(IMGUI_DIR)/%.cpp
+ $(CXX) $(CPPFLAGS) $(CXXFLAGS) -c -o $@ $<
+
+%.o:$(IMGUI_DIR)/backends/%.cpp
+ $(CXX) $(CPPFLAGS) $(CXXFLAGS) -c -o $@ $<
+
+all: $(EXE)
+ @echo Build complete for $(EXE)
+
+$(WEB_DIR):
+ mkdir $@
+
+serve: all
+ python3 -m http.server -d $(WEB_DIR)
+
+$(EXE): $(OBJS) $(WEB_DIR)
+ $(CXX) -o $@ $(OBJS) $(LDFLAGS)
+
+clean:
+ rm -f $(EXE) $(OBJS) $(WEB_DIR)/*.js $(WEB_DIR)/*.wasm $(WEB_DIR)/*.wasm.pre
diff --git a/src/imgui/examples/example_emscripten_wgpu/README.md b/src/imgui/examples/example_emscripten_wgpu/README.md
new file mode 100644
index 0000000..c4c4dec
--- /dev/null
+++ b/src/imgui/examples/example_emscripten_wgpu/README.md
@@ -0,0 +1,24 @@
+## 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
+
+- 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.
+
+- You may also refer to our [Continuous Integration setup](https://github.com/ocornut/imgui/tree/master/.github/workflows) for Emscripten setup.
+
+- Then build using `make` while in the `example_emscripten_wgpu/` directory.
+
+- Requires recent Emscripten as WGPU is still a work-in-progress API.
+
+## How to Run
+
+To run on a local machine:
+- Make sure your browse supports WGPU and it is enabled. WGPU is still WIP not enabled by default in most browser.
+- `make serve` will use Python3 to spawn a local webserver, you can then browse http://localhost:8000 to access your build.
+- Otherwise, generally you will need a local webserver:
+ - Quoting [https://emscripten.org/docs/getting_started](https://emscripten.org/docs/getting_started/Tutorial.html#generating-html):<br>
+_"Unfortunately several browsers (including Chrome, Safari, and Internet Explorer) do not support file:// [XHR](https://emscripten.org/docs/site/glossary.html#term-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](https://emscripten.org/docs/getting_started/FAQ.html#faq-local-webserver) and then open http://localhost:8000/hello.html."_
+ - Emscripten SDK has a handy `emrun` command: `emrun web/example_emscripten_opengl3.html --browser firefox` which will spawn a temporary local webserver (in Firefox). See https://emscripten.org/docs/compiling/Running-html-files-with-emrun.html for details.
+ - You may use Python 3 builtin webserver: `python -m http.server -d web` (this is what `make serve` uses).
+ - You may use Python 2 builtin webserver: `cd web && python -m SimpleHTTPServer`.
+ - If you are accessing the files over a network, certain browsers, such as Firefox, will restrict Gamepad API access to secure contexts only (e.g. https only).
diff --git a/src/imgui/examples/example_emscripten_wgpu/main.cpp b/src/imgui/examples/example_emscripten_wgpu/main.cpp
new file mode 100644
index 0000000..590453c
--- /dev/null
+++ b/src/imgui/examples/example_emscripten_wgpu/main.cpp
@@ -0,0 +1,254 @@
+// Dear ImGui: standalone example application for Emscripten, using GLFW + WebGPU
+// (Emscripten is a C++-to-javascript compiler, used to publish executables for the web. See https://emscripten.org/)
+
+// Learn about Dear ImGui:
+// - FAQ https://dearimgui.com/faq
+// - Getting Started https://dearimgui.com/getting-started
+// - Documentation https://dearimgui.com/docs (same as your local docs/ folder).
+// - Introduction, links and more at the top of imgui.cpp
+
+#include "imgui.h"
+#include "imgui_impl_glfw.h"
+#include "imgui_impl_wgpu.h"
+#include <stdio.h>
+#include <emscripten.h>
+#include <emscripten/html5.h>
+#include <emscripten/html5_webgpu.h>
+#include <GLFW/glfw3.h>
+#include <webgpu/webgpu.h>
+#include <webgpu/webgpu_cpp.h>
+
+// Global WebGPU required states
+static WGPUDevice wgpu_device = nullptr;
+static WGPUSurface wgpu_surface = nullptr;
+static WGPUTextureFormat wgpu_preferred_fmt = WGPUTextureFormat_RGBA8Unorm;
+static WGPUSwapChain wgpu_swap_chain = nullptr;
+static int wgpu_swap_chain_width = 0;
+static int wgpu_swap_chain_height = 0;
+
+// Forward declarations
+static void MainLoopStep(void* window);
+static bool InitWGPU();
+static void print_glfw_error(int error, const char* description);
+static void print_wgpu_error(WGPUErrorType error_type, const char* message, void*);
+
+// Main code
+int main(int, char**)
+{
+ glfwSetErrorCallback(print_glfw_error);
+ if (!glfwInit())
+ return 1;
+
+ // Make sure GLFW does not initialize any graphics context.
+ // This needs to be done explicitly later.
+ glfwWindowHint(GLFW_CLIENT_API, GLFW_NO_API);
+ GLFWwindow* window = glfwCreateWindow(1280, 720, "Dear ImGui GLFW+WebGPU example", nullptr, nullptr);
+ if (!window)
+ {
+ glfwTerminate();
+ return 1;
+ }
+
+ // Initialize the WebGPU environment
+ if (!InitWGPU())
+ {
+ if (window)
+ glfwDestroyWindow(window);
+ glfwTerminate();
+ return 1;
+ }
+ glfwShowWindow(window);
+
+ // Setup Dear ImGui context
+ IMGUI_CHECKVERSION();
+ ImGui::CreateContext();
+ ImGuiIO& io = ImGui::GetIO(); (void)io;
+ io.ConfigFlags |= ImGuiConfigFlags_NavEnableKeyboard; // Enable Keyboard Controls
+ io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad; // Enable Gamepad Controls
+
+ // For an Emscripten build we are disabling file-system access, so let's not attempt to do a fopen() of the imgui.ini file.
+ // You may manually call LoadIniSettingsFromMemory() to load settings from your own storage.
+ io.IniFilename = nullptr;
+
+ // Setup Dear ImGui style
+ ImGui::StyleColorsDark();
+ //ImGui::StyleColorsLight();
+
+ // Setup Platform/Renderer backends
+ ImGui_ImplGlfw_InitForOther(window, true);
+ ImGui_ImplGlfw_InstallEmscriptenCanvasResizeCallback("#canvas");
+ ImGui_ImplWGPU_Init(wgpu_device, 3, wgpu_preferred_fmt, WGPUTextureFormat_Undefined);
+
+ // Load Fonts
+ // - If no fonts are loaded, dear imgui will use the default font. You can also load multiple fonts and use ImGui::PushFont()/PopFont() to select them.
+ // - AddFontFromFileTTF() will return the ImFont* so you can store it if you need to select the font among multiple.
+ // - If the file cannot be loaded, the function will return a nullptr. Please handle those errors in your application (e.g. use an assertion, or display an error and quit).
+ // - The fonts will be rasterized at a given size (w/ oversampling) and stored into a texture when calling ImFontAtlas::Build()/GetTexDataAsXXXX(), which ImGui_ImplXXXX_NewFrame below will call.
+ // - Use '#define IMGUI_ENABLE_FREETYPE' in your imconfig file to use Freetype for higher quality font rendering.
+ // - Read 'docs/FONTS.md' for more instructions and details.
+ // - Remember that in C/C++ if you want to include a backslash \ in a string literal you need to write a double backslash \\ !
+ // - Emscripten allows preloading a file or folder to be accessible at runtime. See Makefile for details.
+ //io.Fonts->AddFontDefault();
+#ifndef IMGUI_DISABLE_FILE_FUNCTIONS
+ //io.Fonts->AddFontFromFileTTF("fonts/segoeui.ttf", 18.0f);
+ io.Fonts->AddFontFromFileTTF("fonts/DroidSans.ttf", 16.0f);
+ //io.Fonts->AddFontFromFileTTF("fonts/Roboto-Medium.ttf", 16.0f);
+ //io.Fonts->AddFontFromFileTTF("fonts/Cousine-Regular.ttf", 15.0f);
+ //io.Fonts->AddFontFromFileTTF("fonts/ProggyTiny.ttf", 10.0f);
+ //ImFont* font = io.Fonts->AddFontFromFileTTF("fonts/ArialUni.ttf", 18.0f, nullptr, io.Fonts->GetGlyphRangesJapanese());
+ //IM_ASSERT(font != nullptr);
+#endif
+
+ // This function will directly return and exit the main function.
+ // Make sure that no required objects get cleaned up.
+ // This way we can use the browsers 'requestAnimationFrame' to control the rendering.
+ emscripten_set_main_loop_arg(MainLoopStep, window, 0, false);
+
+ return 0;
+}
+
+static bool InitWGPU()
+{
+ wgpu_device = emscripten_webgpu_get_device();
+ if (!wgpu_device)
+ return false;
+
+ wgpuDeviceSetUncapturedErrorCallback(wgpu_device, print_wgpu_error, nullptr);
+
+ // Use C++ wrapper due to misbehavior in Emscripten.
+ // Some offset computation for wgpuInstanceCreateSurface in JavaScript
+ // seem to be inline with struct alignments in the C++ structure
+ wgpu::SurfaceDescriptorFromCanvasHTMLSelector html_surface_desc = {};
+ html_surface_desc.selector = "#canvas";
+
+ wgpu::SurfaceDescriptor surface_desc = {};
+ surface_desc.nextInChain = &html_surface_desc;
+
+ wgpu::Instance instance = wgpuCreateInstance(nullptr);
+ wgpu::Surface surface = instance.CreateSurface(&surface_desc);
+ wgpu::Adapter adapter = {};
+ wgpu_preferred_fmt = (WGPUTextureFormat)surface.GetPreferredFormat(adapter);
+ wgpu_surface = surface.Release();
+
+ return true;
+}
+
+static void MainLoopStep(void* window)
+{
+ ImGuiIO& io = ImGui::GetIO();
+
+ glfwPollEvents();
+
+ int width, height;
+ glfwGetFramebufferSize((GLFWwindow*)window, &width, &height);
+
+ // React to changes in screen size
+ if (width != wgpu_swap_chain_width && height != wgpu_swap_chain_height)
+ {
+ ImGui_ImplWGPU_InvalidateDeviceObjects();
+ if (wgpu_swap_chain)
+ wgpuSwapChainRelease(wgpu_swap_chain);
+ wgpu_swap_chain_width = width;
+ wgpu_swap_chain_height = height;
+ WGPUSwapChainDescriptor swap_chain_desc = {};
+ swap_chain_desc.usage = WGPUTextureUsage_RenderAttachment;
+ swap_chain_desc.format = wgpu_preferred_fmt;
+ swap_chain_desc.width = width;
+ swap_chain_desc.height = height;
+ swap_chain_desc.presentMode = WGPUPresentMode_Fifo;
+ wgpu_swap_chain = wgpuDeviceCreateSwapChain(wgpu_device, wgpu_surface, &swap_chain_desc);
+ ImGui_ImplWGPU_CreateDeviceObjects();
+ }
+
+ // Start the Dear ImGui frame
+ ImGui_ImplWGPU_NewFrame();
+ ImGui_ImplGlfw_NewFrame();
+ ImGui::NewFrame();
+
+ // Our state
+ // (we use static, which essentially makes the variable globals, as a convenience to keep the example code easy to follow)
+ static bool show_demo_window = true;
+ static bool show_another_window = false;
+ static ImVec4 clear_color = ImVec4(0.45f, 0.55f, 0.60f, 1.00f);
+
+ // 1. Show the big demo window (Most of the sample code is in ImGui::ShowDemoWindow()! You can browse its code to learn more about Dear ImGui!).
+ if (show_demo_window)
+ ImGui::ShowDemoWindow(&show_demo_window);
+
+ // 2. Show a simple window that we create ourselves. We use a Begin/End pair to create a named window.
+ {
+ static float f = 0.0f;
+ static int counter = 0;
+
+ ImGui::Begin("Hello, world!"); // Create a window called "Hello, world!" and append into it.
+
+ ImGui::Text("This is some useful text."); // Display some text (you can use a format strings too)
+ ImGui::Checkbox("Demo Window", &show_demo_window); // Edit bools storing our window open/close state
+ ImGui::Checkbox("Another Window", &show_another_window);
+
+ ImGui::SliderFloat("float", &f, 0.0f, 1.0f); // Edit 1 float using a slider from 0.0f to 1.0f
+ ImGui::ColorEdit3("clear color", (float*)&clear_color); // Edit 3 floats representing a color
+
+ if (ImGui::Button("Button")) // Buttons return true when clicked (most widgets return true when edited/activated)
+ counter++;
+ ImGui::SameLine();
+ ImGui::Text("counter = %d", counter);
+
+ ImGui::Text("Application average %.3f ms/frame (%.1f FPS)", 1000.0f / io.Framerate, io.Framerate);
+ ImGui::End();
+ }
+
+ // 3. Show another simple window.
+ if (show_another_window)
+ {
+ ImGui::Begin("Another Window", &show_another_window); // Pass a pointer to our bool variable (the window will have a closing button that will clear the bool when clicked)
+ ImGui::Text("Hello from another window!");
+ if (ImGui::Button("Close Me"))
+ show_another_window = false;
+ ImGui::End();
+ }
+
+ // Rendering
+ ImGui::Render();
+
+ WGPURenderPassColorAttachment color_attachments = {};
+ color_attachments.loadOp = WGPULoadOp_Clear;
+ color_attachments.storeOp = WGPUStoreOp_Store;
+ color_attachments.clearValue = { clear_color.x * clear_color.w, clear_color.y * clear_color.w, clear_color.z * clear_color.w, clear_color.w };
+ color_attachments.view = wgpuSwapChainGetCurrentTextureView(wgpu_swap_chain);
+ WGPURenderPassDescriptor render_pass_desc = {};
+ render_pass_desc.colorAttachmentCount = 1;
+ render_pass_desc.colorAttachments = &color_attachments;
+ render_pass_desc.depthStencilAttachment = nullptr;
+
+ WGPUCommandEncoderDescriptor enc_desc = {};
+ WGPUCommandEncoder encoder = wgpuDeviceCreateCommandEncoder(wgpu_device, &enc_desc);
+
+ WGPURenderPassEncoder pass = wgpuCommandEncoderBeginRenderPass(encoder, &render_pass_desc);
+ ImGui_ImplWGPU_RenderDrawData(ImGui::GetDrawData(), pass);
+ wgpuRenderPassEncoderEnd(pass);
+
+ WGPUCommandBufferDescriptor cmd_buffer_desc = {};
+ WGPUCommandBuffer cmd_buffer = wgpuCommandEncoderFinish(encoder, &cmd_buffer_desc);
+ WGPUQueue queue = wgpuDeviceGetQueue(wgpu_device);
+ wgpuQueueSubmit(queue, 1, &cmd_buffer);
+}
+
+static void print_glfw_error(int error, const char* description)
+{
+ printf("GLFW Error %d: %s\n", error, description);
+}
+
+static void print_wgpu_error(WGPUErrorType error_type, const char* message, void*)
+{
+ const char* error_type_lbl = "";
+ switch (error_type)
+ {
+ case WGPUErrorType_Validation: error_type_lbl = "Validation"; break;
+ case WGPUErrorType_OutOfMemory: error_type_lbl = "Out of memory"; break;
+ case WGPUErrorType_Unknown: error_type_lbl = "Unknown"; break;
+ case WGPUErrorType_DeviceLost: error_type_lbl = "Device lost"; break;
+ default: error_type_lbl = "Unknown";
+ }
+ printf("%s error: %s\n", error_type_lbl, message);
+}