update dear imgui from 1.92.6-docking to 1.92.7-docking

libs/imgui/examples/example_sdl3_wgpu/CMakeLists.txt

@@ -1,19 +1,24 @@
-# Building for desktop (WebGPU-native) with Dawn:
+# Building for desktop with Dawn:
 #  1. git clone https://github.com/google/dawn dawn
 #  2. cmake -B build -DIMGUI_DAWN_DIR=dawn
 #  3. cmake --build build
 # The resulting binary will be found at one of the following locations:
-#   * build/Debug/example_sdl3_wgpu[.exe]
-#   * build/example_sdl3_wgpu[.exe]
+#   * build/example_sdl3_wgpu[.exe] or build/Debug/example_sdl3_wgpu[.exe]
 
-# Building for desktop (WGPU-Native) with WGPU-Native:
+# Building for desktop with WGPU-Native:
 #  1. download WGPU-Native autogenerated binary modules for your platform/compiler from: https://github.com/gfx-rs/wgpu-native/releases
 #  2. unzip the downloaded file in your_preferred_folder
 #  3. cmake -B build -DIMGUI_WGPU_DIR=your_preferred_folder  ("full path" or "relative" starting from current directory)
 #  4. cmake --build build
 # The resulting binary will be found at one of the following locations:
-#   * build/Debug/example_sdl3_wgpu[.exe]
-#   * build/example_sdl3_wgpu[.exe]
+#   * build/example_sdl3_wgpu[.exe] or build/Debug/example_sdl3_wgpu[.exe]
+
+# Building for desktop with WGVK (MUCH EASIER)
+#  1. git clone https://github.com/manuel5975p/WGVK dawn
+#  2. cmake -B build -DIMGUI_WGVK_DIR=wgvk
+#  3. cmake --build build
+# The resulting binary will be found at one of the following locations:
+#   * build/example_sdl3_wgpu[.exe] or build/Debug/example_sdl3_wgpu[.exe]
 
 # Building for Emscripten:
 #  1. Install Emscripten SDK following the instructions: https://emscripten.org/docs/getting_started/downloads.html
@@ -55,27 +60,19 @@ if(EMSCRIPTEN)
     if(EMSCRIPTEN_VERSION VERSION_LESS "4.0.15")
         message(FATAL_ERROR "Using Emscripten with SDL3 needs Emscripten version >= 4.0.15")
     endif()
-    if(NOT IMGUI_EMSCRIPTEN_WEBGPU_FLAG) # if IMGUI_EMSCRIPTEN_WEBGPU_FLAG not used, set by current EMSCRIPTEN version
-        if(EMSCRIPTEN_VERSION VERSION_GREATER_EQUAL "4.0.10")
-            set(IMGUI_EMSCRIPTEN_WEBGPU_FLAG "--use-port=emdawnwebgpu" CACHE STRING "Choose between --use-port=emdawnwebgpu (Dawn implementation of EMSCRIPTEN) and -sUSE_WEBGPU=1 (WGPU implementation of EMSCRIPTEN, deprecated in 4.0.10): default to --use-port=emdawnwebgpu for EMSCRIPTEN >= 4.0.10")
-        else()
-            set(IMGUI_EMSCRIPTEN_WEBGPU_FLAG "-sUSE_WEBGPU=1" CACHE STRING "Use -sUSE_WEBGPU=1 for EMSCRIPTEN WGPU implementation")
-        endif()
-    else() # if IMGUI_EMSCRIPTEN_WEBGPU_FLAG used, check correct version
-        if(EMSCRIPTEN_VERSION VERSION_LESS "4.0.10" AND "${IMGUI_EMSCRIPTEN_WEBGPU_FLAG}" MATCHES "emdawnwebgpu")
-            # it's necessary EMSCRIPTEN >= v4.0.10 (although "--use-port=path/to/emdawnwebgpu.port.py" is supported/tested from v4.0.8)
-            message(FATAL_ERROR "emdawnwebgpu needs EMSCRIPTEN version >= 4.0.10")
-        endif()
-    endif()
+    # emdawnwebgpu was introduced in 4.0.10 so, due to the prior requirement, this will work
+    set(IMGUI_EMSCRIPTEN_WEBGPU_FLAG "--use-port=emdawnwebgpu" CACHE STRING "Default to --use-port=emdawnwebgpu. You can override to provide your own local port.")
 
     add_compile_options(-sDISABLE_EXCEPTION_CATCHING=1 -DIMGUI_DISABLE_FILE_FUNCTIONS=1)
 else() # Native/Desktop build
-    if(NOT IMGUI_DAWN_DIR AND NOT IMGUI_WGPU_DIR) # if it's Native/Desktop build, IMGUI_DAWN_DIR or IMGUI_WGPU_DIR must be specified
-        message(FATAL_ERROR "Please specify the Dawn or WGPU base directory")
-    endif()
 
-    if(IMGUI_DAWN_DIR AND IMGUI_WGPU_DIR) # both IMGUI_DAWN_DIR and IMGUI_WGPU_DIR cannot be set
-        message(FATAL_ERROR "Please specify only one between Dawn / WGPU base directory")
+    # Check DAWN/WGPU/WGVK directory
+    # If it's Native/Desktop build, IMGUI_DAWN_DIR or IMGUI_WGPU_DIR or IMGUI_WGVK_DIR must be specified
+    if(NOT IMGUI_DAWN_DIR AND NOT IMGUI_WGPU_DIR AND NOT IMGUI_WGVK_DIR)
+        message(FATAL_ERROR "Please specify one of IMGUI_DAWN_DIR/IMGUI_WGPU_DIR/IMGUI_WGVK_DIR base directory.")
+    endif()
+    if((IMGUI_DAWN_DIR AND (IMGUI_WGPU_DIR OR IMGUI_WGVK_DIR)) OR (IMGUI_WGPU_DIR AND IMGUI_WGVK_DIR))
+        message(FATAL_ERROR "Please specify only one of IMGUI_DAWN_DIR/IMGUI_WGPU_DIR/IMGUI_WGVK_DIR base directory.")
     endif()
 
     if(APPLE) # Add SDL3 module to get Surface, with libs and file property for MacOS build
@@ -85,7 +82,7 @@ else() # Native/Desktop build
 
     find_package(SDL3 REQUIRED CONFIG REQUIRED COMPONENTS SDL3)
 
-    if(IMGUI_DAWN_DIR) # DAWN-Native build options
+    if(IMGUI_DAWN_DIR)
         list(APPEND CMAKE_PREFIX_PATH ${IMGUI_DAWN_DIR})
         find_package(Threads) # required from Dawn installation
         find_package(Dawn) # Search for a Dawn installation using IMGUI_DAWN_DIR in CMAKE_PREFIX_PATH
@@ -129,7 +126,9 @@ else() # Native/Desktop build
 
             set(LIBRARIES webgpu_dawn ${OS_LIBRARIES})
         endif()
-    else() # WGPU-Native build options
+    endif()
+
+    if(IMGUI_WGPU_DIR)
         set(WGPU_NATIVE_LIB_DIR ${IMGUI_WGPU_DIR}/lib)
         find_library(WGPU_LIBRARY NAMES libwgpu_native.a wgpu_native.lib wgpu_native HINTS ${WGPU_NATIVE_LIB_DIR} REQUIRED)
         if(WIN32)
@@ -140,6 +139,9 @@ else() # Native/Desktop build
 
         set(LIBRARIES ${WGPU_LIBRARY} ${OS_LIBRARIES})
     endif()
+
+    if(IMGUI_WGVK_DIR)
+    endif()
 endif()
 
 add_executable(${IMGUI_EXECUTABLE} ${IMGUI_EXAMPLE_SOURCE_FILES})
@@ -162,7 +164,6 @@ endif()
 # IMGUI_IMPL_WEBGPU_BACKEND_DAWN/WGPU internal define is set according to:
 #   EMSCRIPTEN: by used FLAG
 #     --use-port=emdawnwebgpu --> IMGUI_IMPL_WEBGPU_BACKEND_DAWN enabled (+EMSCRIPTEN)
-#     -sUSE_WEBGPU=1          --> IMGUI_IMPL_WEBGPU_BACKEND_WGPU enabled (+EMSCRIPTEN)
 #   NATIVE: by used SDK installation directory
 #     if IMGUI_DAWN_DIR is valid --> IMGUI_IMPL_WEBGPU_BACKEND_DAWN enabled
 #     if IMGUI_WGPU_DIR is valid --> IMGUI_IMPL_WEBGPU_BACKEND_WGPU enabled
@@ -173,21 +174,26 @@ if(NOT EMSCRIPTEN) # WegGPU-Native settings
         if(NOT Dawn_FOUND)
             target_link_libraries(${IMGUI_EXECUTABLE} INTERFACE webgpu_cpp)
         endif()
-    else()
+    endif()
+    if(IMGUI_WGPU_DIR)
         target_compile_definitions(${IMGUI_EXECUTABLE} PUBLIC "IMGUI_IMPL_WEBGPU_BACKEND_WGPU")
         target_include_directories(${IMGUI_EXECUTABLE} PUBLIC ${IMGUI_WGPU_DIR}/include)
     endif()
+    if(IMGUI_WGVK_DIR)
+        target_sources(${IMGUI_EXECUTABLE} PRIVATE ${IMGUI_WGVK_DIR}/src/wgvk.c)
+        target_compile_definitions(${IMGUI_EXECUTABLE} PUBLIC "IMGUI_IMPL_WEBGPU_BACKEND_WGVK")
+        target_include_directories(${IMGUI_EXECUTABLE} PUBLIC ${IMGUI_WGVK_DIR}/include)
+        if (MSVC)
+           target_compile_options(${IMGUI_EXECUTABLE} PUBLIC /std:clatest /experimental:c11atomics)
+        endif()
+    endif()
 
     target_link_libraries(${IMGUI_EXECUTABLE} PUBLIC ${LIBRARIES} SDL3::SDL3)
 else() # Emscripten settings
     set(CMAKE_EXECUTABLE_SUFFIX ".html")
 
-    if("${IMGUI_EMSCRIPTEN_WEBGPU_FLAG}" MATCHES "emdawnwebgpu")
-        target_compile_options(${IMGUI_EXECUTABLE} PUBLIC "${IMGUI_EMSCRIPTEN_WEBGPU_FLAG}")
-        target_compile_definitions(${IMGUI_EXECUTABLE} PUBLIC "IMGUI_IMPL_WEBGPU_BACKEND_DAWN")
-    else()
-        target_compile_definitions(${IMGUI_EXECUTABLE} PUBLIC "IMGUI_IMPL_WEBGPU_BACKEND_WGPU")
-    endif()
+    target_compile_options(${IMGUI_EXECUTABLE} PUBLIC "${IMGUI_EMSCRIPTEN_WEBGPU_FLAG}")
+    target_compile_definitions(${IMGUI_EXECUTABLE} PUBLIC "IMGUI_IMPL_WEBGPU_BACKEND_DAWN")
     message(STATUS "Using ${IMGUI_EMSCRIPTEN_WEBGPU_FLAG} WebGPU implementation")
 
     target_compile_options(${IMGUI_EXECUTABLE} PUBLIC "-sUSE_SDL=3")

libs/imgui/examples/example_sdl3_wgpu/Makefile.emscripten

@@ -19,8 +19,8 @@ WEB_DIR = web
 EXE = $(WEB_DIR)/index.html
 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_sdl3.cpp $(IMGUI_DIR)/backends/imgui_impl_wgpu.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
 OBJS = $(addsuffix .o, $(basename $(notdir $(SOURCES))))
 UNAME_S := $(shell uname -s)
 CPPFLAGS =
@@ -40,11 +40,7 @@ LDFLAGS += -s ASYNCIFY=1
 LDFLAGS += -s NO_EXIT_RUNTIME=0
 LDFLAGS += -s ASSERTIONS=1
 
-# (1) Using legacy WebGPU implementation (Emscripten < 4.0.10)
-#EMS += -DIMGUI_IMPL_WEBGPU_BACKEND_WGPU
-#LDFLAGS += -s USE_WEBGPU=1
-
-# or (2) Using newer Dawn-based WebGPU port (Emscripten >= 4.0.10)
+# Using Dawn-based WebGPU port (requires Emscripten >= 4.0.10)
 EMS += --use-port=emdawnwebgpu
 LDFLAGS += --use-port=emdawnwebgpu
 

libs/imgui/examples/example_sdl3_wgpu/README.md

@@ -60,14 +60,10 @@ For the WASM code produced by Emscripten to work correctly, it will also be nece
 CMake checks the EMSCRIPEN version then:
    - if EMS >= 4.0.10 uses `--use-port=emdawnwebgpu` flag to build  
       - it set `IMGUI_IMPL_WEBGPU_BACKEND_DAWN` compiler define 
-   - if EMS < 4.0.10 uses `-sUSE_WEBGPU=1` flag to build
-      - it set `IMGUI_IMPL_WEBGPU_BACKEND_WGPU` compiler define 
-
-#### Generate Emscripten forcing `-sUSE_WEBGPU=1` deprecated flag even with EMS >= 4.0.10
-- `emcmake cmake -G Ninja -DIMGUI_EMSCRIPTEN_WEBGPU_FLAG="-sUSE_WEBGPU=1" -B where_to_build_dir`
-   - it set `IMGUI_IMPL_WEBGPU_BACKEND_WGPU` compiler define 
+   - if EMS < 4.0.10 the build aborts (`-sUSE_WEBGPU=1` is no longer supported by our examples and our WGPU backend
 
 #### Generate Emscripten using external WebGPU library (emdawnwebgpu_pkg)
+
 - `emcmake cmake -G Ninja -DIMGUI_EMSCRIPTEN_WEBGPU_FLAG="--use-port=path_to_emdawnwebgpu_pkg" -B where_to_build_dir`
    - it set `IMGUI_IMPL_WEBGPU_BACKEND_DAWN` compiler define 
    - *To use external WebGPU library it's necessary to have EMS >= 4.0.10 or the minimum requirements specified by the package:*

libs/imgui/examples/example_sdl3_wgpu/main.cpp

@@ -20,9 +20,6 @@
 #ifdef __EMSCRIPTEN__
 #include <emscripten.h>
 #include <emscripten/html5.h>
-#if defined(IMGUI_IMPL_WEBGPU_BACKEND_WGPU)
-#include <emscripten/html5_webgpu.h>
-#endif
 #include "../libs/emscripten/emscripten_mainloop_stub.h"
 #endif
 
@@ -64,6 +61,8 @@ int main(int, char**)
     // Create SDL window graphics context
     float main_scale = SDL_GetDisplayContentScale(SDL_GetPrimaryDisplay());
     SDL_WindowFlags window_flags = SDL_WINDOW_RESIZABLE;
+    wgpu_surface_width = (int)(wgpu_surface_width * main_scale);
+    wgpu_surface_height = (int)(wgpu_surface_height * main_scale);
     SDL_Window* window = SDL_CreateWindow("Dear ImGui SDL3+WebGPU example", wgpu_surface_width, wgpu_surface_height, window_flags);
     if (window == nullptr)
     {
@@ -338,20 +337,10 @@ static WGPUDevice RequestDevice(wgpu::Instance& instance, wgpu::Adapter& adapter
     IM_ASSERT(acquired_device != nullptr && waitStatusDevice == wgpu::WaitStatus::Success && "Error on Device request");
     return acquired_device.MoveToCHandle();
 }
-#elif defined(IMGUI_IMPL_WEBGPU_BACKEND_WGPU)
-#ifdef __EMSCRIPTEN__
-// Adapter and device initialization via JS
-EM_ASYNC_JS( void, getAdapterAndDeviceViaJS, (),
-{
-    if (!navigator.gpu)
-        throw Error("WebGPU not supported.");
-    const adapter = await navigator.gpu.requestAdapter();
-    const device = await adapter.requestDevice();
-    Module.preinitializedWebGPUDevice = device;
-} );
-#else // __EMSCRIPTEN__
+#elif defined(IMGUI_IMPL_WEBGPU_BACKEND_WGPU) || defined(IMGUI_IMPL_WEBGPU_BACKEND_WGVK)
 static void handle_request_adapter(WGPURequestAdapterStatus status, WGPUAdapter adapter, WGPUStringView message, void* userdata1, void* userdata2)
 {
+    IM_UNUSED(userdata2);
     if (status == WGPURequestAdapterStatus_Success)
     {
         WGPUAdapter* extAdapter = (WGPUAdapter*)userdata1;
@@ -365,6 +354,7 @@ static void handle_request_adapter(WGPURequestAdapterStatus status, WGPUAdapter
 
 static void handle_request_device(WGPURequestDeviceStatus status, WGPUDevice device, WGPUStringView message, void* userdata1, void* userdata2)
 {
+    IM_UNUSED(userdata2);
     if (status == WGPURequestDeviceStatus_Success)
     {
         WGPUDevice* extDevice = (WGPUDevice*)userdata1;
@@ -380,27 +370,32 @@ static WGPUAdapter RequestAdapter(WGPUInstance& instance)
 {
     WGPURequestAdapterOptions adapter_options = {};
 
-    WGPUAdapter local_adapter;
+    WGPUAdapter local_adapter = nullptr;
     WGPURequestAdapterCallbackInfo adapterCallbackInfo = {};
+    adapterCallbackInfo.mode = WGPUCallbackMode_WaitAnyOnly;
     adapterCallbackInfo.callback = handle_request_adapter;
     adapterCallbackInfo.userdata1 = &local_adapter;
 
-    wgpuInstanceRequestAdapter(instance, &adapter_options, adapterCallbackInfo);
+    WGPUFuture future = wgpuInstanceRequestAdapter(instance, &adapter_options, adapterCallbackInfo);
+    WGPUFutureWaitInfo waitInfo = { future, false };
+    wgpuInstanceWaitAny(instance, 1, &waitInfo, ~0ull);
     IM_ASSERT(local_adapter && "Error on Adapter request");
     return local_adapter;
 }
 
-static WGPUDevice RequestDevice(WGPUAdapter& adapter)
+static WGPUDevice RequestDevice(WGPUInstance& instance, WGPUAdapter& adapter)
 {
-    WGPUDevice local_device;
+    WGPUDevice local_device = nullptr;
     WGPURequestDeviceCallbackInfo deviceCallbackInfo = {};
+    deviceCallbackInfo.mode = WGPUCallbackMode_WaitAnyOnly;
     deviceCallbackInfo.callback = handle_request_device;
     deviceCallbackInfo.userdata1 = &local_device;
-    wgpuAdapterRequestDevice(adapter, nullptr, deviceCallbackInfo);
+    WGPUFuture future = wgpuAdapterRequestDevice(adapter, nullptr, deviceCallbackInfo);
+    WGPUFutureWaitInfo waitInfo = { future, false };
+    wgpuInstanceWaitAny(instance, 1, &waitInfo, ~0ull);
     IM_ASSERT(local_device && "Error on Device request");
     return local_device;
 }
-#endif // __EMSCRIPTEN__
 #endif // IMGUI_IMPL_WEBGPU_BACKEND_WGPU
 
 static bool InitWGPU(SDL_Window* window)
@@ -444,35 +439,24 @@ static bool InitWGPU(SDL_Window* window)
     preferred_fmt = surface_capabilities.formats[0];
 
     // WGPU backend: Adapter and Device acquisition, Surface creation
-#elif defined(IMGUI_IMPL_WEBGPU_BACKEND_WGPU)
-    wgpu_instance = wgpuCreateInstance(nullptr);
+#elif defined(IMGUI_IMPL_WEBGPU_BACKEND_WGPU) || defined(IMGUI_IMPL_WEBGPU_BACKEND_WGVK)
+    WGPUInstanceDescriptor instanceDesc = {};
+    WGPUInstanceFeatureName timedWaitAny = WGPUInstanceFeatureName_TimedWaitAny;
+    instanceDesc.requiredFeatureCount = 1;
+    instanceDesc.requiredFeatures = &timedWaitAny;
+    wgpu_instance = wgpuCreateInstance(&instanceDesc);
 
-#ifdef __EMSCRIPTEN__
-    getAdapterAndDeviceViaJS();
-
-    wgpu_device = emscripten_webgpu_get_device();
-    IM_ASSERT(wgpu_device != nullptr && "Error creating the Device");
-
-    WGPUSurfaceDescriptorFromCanvasHTMLSelector html_surface_desc = {};
-    html_surface_desc.chain.sType = WGPUSType_SurfaceDescriptorFromCanvasHTMLSelector;
-    html_surface_desc.selector = "#canvas";
-
-    WGPUSurfaceDescriptor surface_desc = {};
-    surface_desc.nextInChain = &html_surface_desc.chain;
-
-    // Create the surface.
-    wgpu_surface = wgpuInstanceCreateSurface(wgpu_instance, &surface_desc);
-    preferred_fmt = wgpuSurfaceGetPreferredFormat(wgpu_surface, {} /* adapter */);
-#else // __EMSCRIPTEN__
+#if defined(IMGUI_IMPL_WEBGPU_BACKEND_WGPU)
     wgpuSetLogCallback(
         [](WGPULogLevel level, WGPUStringView msg, void* userdata) { fprintf(stderr, "%s: %.*s\n", ImGui_ImplWGPU_GetLogLevelName(level), (int)msg.length, msg.data); }, nullptr
     );
     wgpuSetLogLevel(WGPULogLevel_Warn);
+#endif
 
     WGPUAdapter adapter = RequestAdapter(wgpu_instance);
     ImGui_ImplWGPU_DebugPrintAdapterInfo(adapter);
 
-    wgpu_device = RequestDevice(adapter);
+    wgpu_device = RequestDevice(wgpu_instance, adapter);
 
     // Create the surface.
     wgpu_surface = CreateWGPUSurface(wgpu_instance, window);
@@ -483,7 +467,6 @@ static bool InitWGPU(SDL_Window* window)
     wgpuSurfaceGetCapabilities(wgpu_surface, adapter, &surface_capabilities);
 
     preferred_fmt = surface_capabilities.formats[0];
-#endif // __EMSCRIPTEN__
 #endif // IMGUI_IMPL_WEBGPU_BACKEND_WGPU
 
     wgpu_surface_configuration.presentMode = WGPUPresentMode_Fifo;
@@ -513,7 +496,7 @@ static bool InitWGPU(SDL_Window* window)
 #include <windows.h>
 #endif
 
-static WGPUSurface CreateWGPUSurface(const WGPUInstance& instance, SDL_Window* window)
+WGPUSurface CreateWGPUSurface(const WGPUInstance& instance, SDL_Window* window)
 {
     SDL_PropertiesID propertiesID = SDL_GetWindowProperties(window);
 
@@ -549,7 +532,7 @@ static WGPUSurface CreateWGPUSurface(const WGPUInstance& instance, SDL_Window* w
     }
 #else
 #error "Unsupported WebGPU native platform!"
-#endif
     return nullptr;
+#endif
 }
 #endif // #ifndef __EMSCRIPTEN__