Merge branch 'develop'

.github/workflows/build-docs.yml

@@ -5,7 +5,6 @@ on:
   push:
     branches:
       - main
-      - develop
 
 jobs:
   build:

.github/workflows/build-wasm-emscripten.yml

@@ -15,6 +15,8 @@ jobs:
 
     - name: Install Emscripten
       uses: mymindstorm/setup-emsdk@v11
+      with:
+        version: 3.1.50
 
     - name: Configure CMake
       run: emcmake cmake -B ${{ github.workspace }}/build -DSL_BUILD_WAI=OFF -DSL_BUILD_WITH_OPENSSL=OFF -DSL_DOWNLOAD_DATA=OFF

.github/workflows/deploy-wasm-emscripten.yml

@@ -5,7 +5,6 @@ on:
   push:
     branches:
       - main
-      - develop
 
 jobs:
   deploy:
@@ -16,6 +15,8 @@ jobs:
 
     - name: Install Emscripten
       uses: mymindstorm/setup-emsdk@v11
+      with:
+        version: 3.1.50
 
     - name: Configure CMake
       run: emcmake cmake -B ${{ github.workspace }}/build -DSL_BUILD_WAI=OFF -DSL_BUILD_WITH_OPENSSL=OFF -DSL_DOWNLOAD_DATA=OFF -DCMAKE_BUILD_TYPE=Release

apps/app_demo_webgpu/AppDemoWebGPU.cpp

@@ -1,5 +1,5 @@
 //#############################################################################
-//  File:      app_demo_webgpu.cpp
+//  File:      AppDemoWebGPU.cpp
 //  Date:      Summer 2023
 //  Codestyle: https://github.com/cpvrlab/SLProject/wiki/SLProject-Coding-Style
 //  Authors:   Marino von Wattenwyl
@@ -8,7 +8,7 @@
 //#############################################################################
 
 //////////////////////////////////////////////////////////////////////////////
-// Please read the documentation for the WebGpuDemoApp struct further below //
+// Please read the documentation for the WebGPUDemoApp struct further below //
 //////////////////////////////////////////////////////////////////////////////
 
 #if defined(_WIN32)
@@ -39,6 +39,7 @@
 #include <cstdlib>
 #include <cstring>
 
+//-----------------------------------------------------------------------------
 #ifdef SYSTEM_DARWIN
 extern "C" void* createMetalLayer(void* window);
 #endif
@@ -52,7 +53,7 @@ extern "C" void* createMetalLayer(void* window);
         std::exit(1); \
     }
 //-----------------------------------------------------------------------------
-//! Application Struct WebGpuDemoApp with all global variables and documentation
+//! Application struct WebGPUDemoApp with all global variables and documentation
 /*!
 
 Overview:
@@ -65,13 +66,13 @@ compute functionality is available.
 The primary target for WebGPU was the Web as a replacement for the old WebGL API. This means that
 the specification is written for a JavaScript API. However, Google and Mozilla have decided to provide their in-browser
 implementations as native libraries, so we can use WebGPU in native apps written in C, C++ or Rust. The implementers
-have agreed on a common interface for their libraries in form of a header called `app_demo_webgpu.h`
+have agreed on a common interface for their libraries in form of a header called `webgpu.h`
 (https://github.com/webgpu-native/webgpu-headers/).
 
 There are currently three implementations of this header:
     - wgpu-native: Mozilla's implementation for Firefox, written in Rust
     - Dawn: Google's implementation for Chromium, written in C++
-    - Emscripten: Translates the app_demo_webgpu.h calls to JavaScript calls in the browser
+    - Emscripten: Translates webgpu.h calls to calls to the WebGPU JavaScript API in the browser
 
 WebGPU uses its own shader language called WGSL (WebGPU Shader Language). This is the only shader language supported
 in the browsers even though the native implementations also support SPIR-V.
@@ -245,7 +246,7 @@ Here's a list of things I've noticed are handled differently from Vulkan (as of
         problematic objects, suggests fixes and even generates a stack trace. I'm not sure what the overhead of
         this validation is, but I excpect there to be an option to turn it off in the future.
 */
-struct WebGpuDemoApp
+struct WebGPUDemoApp
 {
     GLFWwindow* window        = nullptr;
     int         surfaceWidth  = 0;
@@ -305,7 +306,7 @@ struct alignas(16) ShaderUniformData
 //-----------------------------------------------------------------------------
 static_assert(sizeof(ShaderUniformData) % 16 == 0, "uniform data size must be a multiple of 16");
 //-----------------------------------------------------------------------------
-void reconfigureSurface(WebGpuDemoApp& app)
+void reconfigureSurface(WebGPUDemoApp& app)
 {
     // Get the window size from the GLFW window.
     glfwGetWindowSize(app.window, &app.surfaceWidth, &app.surfaceHeight);
@@ -337,7 +338,7 @@ void reconfigureSurface(WebGpuDemoApp& app)
     WEBGPU_DEMO_LOG("[WebGPU] Depth texture view re-created");
 }
 //-----------------------------------------------------------------------------
-void onPaint(WebGpuDemoApp& app)
+void onPaint(WebGPUDemoApp& app)
 {
     if (app.surfaceWidth == 0 || app.surfaceHeight == 0)
         return;
@@ -486,12 +487,12 @@ void onPaint(WebGpuDemoApp& app)
 //-----------------------------------------------------------------------------
 void onResize(GLFWwindow* window, int width, int height)
 {
-    WebGpuDemoApp& app = *((WebGpuDemoApp*)glfwGetWindowUserPointer(window));
+    WebGPUDemoApp& app = *((WebGPUDemoApp*)glfwGetWindowUserPointer(window));
     reconfigureSurface(app);
     onPaint(app);
 }
 //-----------------------------------------------------------------------------
-void initGLFW(WebGpuDemoApp& app)
+void initGLFW(WebGPUDemoApp& app)
 {
     // === Initialize GLFW ===
 
@@ -537,10 +538,11 @@ void handleDeviceRequest(WGPURequestDeviceStatus status,
     *outDevice            = device;
 }
 //-----------------------------------------------------------------------------
-void initWebGPU(WebGpuDemoApp& app)
+void initWebGPU(WebGPUDemoApp& app)
 {
     // === Create a WebGPU instance ===
-    // The instance is the root interface to WebGPU through which we create all other WebGPU resources.
+    // The instance is the root interface to WebGPU through which we create
+    // all other WebGPU resources.
 
     app.instance = wgpuCreateInstance(nullptr);
     WEBGPU_DEMO_CHECK(app.instance, "[WebGPU] Failed to create instance");
@@ -590,7 +592,10 @@ void initWebGPU(WebGpuDemoApp& app)
     deviceDesc.requiredLimits       = &requiredLimits;
     deviceDesc.defaultQueue.label   = "Demo Queue";
 
-    wgpuAdapterRequestDevice(app.adapter, &deviceDesc, handleDeviceRequest, &app.device);
+    wgpuAdapterRequestDevice(app.adapter,
+                             &deviceDesc,
+                             handleDeviceRequest,
+                             &app.device);
 
     // === Acquire a WebGPU queue ===
     // The queue is where the commands for the GPU are submitted to.
@@ -632,10 +637,14 @@ void initWebGPU(WebGpuDemoApp& app)
 
     // Query the surface capabilities from the adapter.
     WGPUSurfaceCapabilities surfaceCapabilities;
-    wgpuSurfaceGetCapabilities(app.surface, app.adapter, &surfaceCapabilities);
+    wgpuSurfaceGetCapabilities(app.surface,
+                               app.adapter,
+                               &surfaceCapabilities);
 
     // Get the window size from the GLFW window.
-    glfwGetFramebufferSize(app.window, &app.surfaceWidth, &app.surfaceHeight);
+    glfwGetFramebufferSize(app.window,
+                           &app.surfaceWidth,
+                           &app.surfaceHeight);
 
     app.surfaceConfig             = {};
     app.surfaceConfig.device      = app.device;
@@ -705,7 +714,11 @@ void initWebGPU(WebGpuDemoApp& app)
     WEBGPU_DEMO_LOG("[WebGPU] Vertex buffer created");
 
     // Upload the data to the GPU.
-    wgpuQueueWriteBuffer(app.queue, app.vertexBuffer, 0, vertexData.data(), app.vertexDataSize);
+    wgpuQueueWriteBuffer(app.queue,
+                         app.vertexBuffer,
+                         0,
+                         vertexData.data(),
+                         app.vertexDataSize);
 
     // === Create the index buffer ===
 
@@ -733,7 +746,11 @@ void initWebGPU(WebGpuDemoApp& app)
     WEBGPU_DEMO_CHECK(app.indexBuffer, "[WebGPU] Failed to create index buffer");
     WEBGPU_DEMO_LOG("[WebGPU] Index buffer created");
 
-    wgpuQueueWriteBuffer(app.queue, app.indexBuffer, 0, indexData.data(), app.indexDataSize);
+    wgpuQueueWriteBuffer(app.queue,
+                         app.indexBuffer,
+                         0,
+                         indexData.data(),
+                         app.indexDataSize);
 
     // === Create the uniform buffer ===
 
@@ -747,7 +764,11 @@ void initWebGPU(WebGpuDemoApp& app)
     WEBGPU_DEMO_LOG("[WebGPU] Uniform buffer created");
 
     ShaderUniformData uniformData = {};
-    wgpuQueueWriteBuffer(app.queue, app.uniformBuffer, 0, &uniformData, sizeof(ShaderUniformData));
+    wgpuQueueWriteBuffer(app.queue,
+                         app.uniformBuffer,
+                         0,
+                         &uniformData,
+                         sizeof(ShaderUniformData));
 
     // === Create the depth texture ===
 
@@ -831,7 +852,8 @@ void initWebGPU(WebGpuDemoApp& app)
     for (unsigned mipLevel = 0; mipLevel < textureDesc.mipLevelCount; mipLevel++)
     {
         cv::Mat  mipLevelImage;
-        cv::Size cvSize(static_cast<int>(mipLevelSize.width), static_cast<int>(mipLevelSize.height));
+        cv::Size cvSize(static_cast<int>(mipLevelSize.width),
+                        static_cast<int>(mipLevelSize.height));
         cv::resize(image, mipLevelImage, cvSize);
 
         std::size_t mipLevelBytes = 4ull * mipLevelSize.width * mipLevelSize.height;
@@ -841,7 +863,12 @@ void initWebGPU(WebGpuDemoApp& app)
         pixelDataLayout.rowsPerImage = mipLevelSize.height;
 
         // Upload the data to the GPU.
-        wgpuQueueWriteTexture(app.queue, &destination, mipLevelImage.data, mipLevelBytes, &pixelDataLayout, &mipLevelSize);
+        wgpuQueueWriteTexture(app.queue,
+                              &destination,
+                              mipLevelImage.data,
+                              mipLevelBytes,
+                              &pixelDataLayout,
+                              &mipLevelSize);
 
         // Scale the image down for the next mip level.
         mipLevelSize.width /= 2;
@@ -980,7 +1007,8 @@ void initWebGPU(WebGpuDemoApp& app)
     bindGroupLayoutDesc.entryCount                    = bindGroupLayoutEntries.size();
     bindGroupLayoutDesc.entries                       = bindGroupLayoutEntries.data();
 
-    app.bindGroupLayout = wgpuDeviceCreateBindGroupLayout(app.device, &bindGroupLayoutDesc);
+    app.bindGroupLayout = wgpuDeviceCreateBindGroupLayout(app.device,
+                                                          &bindGroupLayoutDesc);
     WEBGPU_DEMO_CHECK(app.bindGroupLayout, "[WebGPU] Failed to create bind group layout");
     WEBGPU_DEMO_LOG("[WebGPU] Bind group layout created");
 
@@ -1045,7 +1073,9 @@ void initWebGPU(WebGpuDemoApp& app)
     uvAttribute.offset              = 6 * sizeof(float);
     uvAttribute.shaderLocation      = 2;
 
-    std::vector<WGPUVertexAttribute> vertexAttributes = {positionAttribute, normalAttribute, uvAttribute};
+    std::vector<WGPUVertexAttribute> vertexAttributes = {positionAttribute,
+                                                         normalAttribute,
+                                                         uvAttribute};
 
     // Description of the vertex buffer layout for the vertex shader stage
     WGPUVertexBufferLayout vertexBufferLayout = {};
@@ -1114,7 +1144,7 @@ void initWebGPU(WebGpuDemoApp& app)
     WEBGPU_DEMO_LOG("[WebGPU] Render pipeline created");
 }
 //-----------------------------------------------------------------------------
-void deinitWebGPU(WebGpuDemoApp& app)
+void deinitWebGPU(WebGPUDemoApp& app)
 {
     // === Release all WebGPU resources ===
 
@@ -1145,7 +1175,7 @@ void deinitWebGPU(WebGpuDemoApp& app)
     WEBGPU_DEMO_LOG("[WebGPU] Resources released");
 }
 //-----------------------------------------------------------------------------
-void deinitGLFW(WebGpuDemoApp& app)
+void deinitGLFW(WebGPUDemoApp& app)
 {
     // === Destroy the window and terminate GLFW ===
 
@@ -1156,7 +1186,7 @@ void deinitGLFW(WebGpuDemoApp& app)
 //-----------------------------------------------------------------------------
 int main(int argc, const char* argv[])
 {
-    WebGpuDemoApp app;
+    WebGPUDemoApp app;
 
     initGLFW(app);
     initWebGPU(app);
@@ -1184,6 +1214,7 @@ int main(int argc, const char* argv[])
         lastCursorY = cursorY;
 
         onPaint(app);
+
         glfwPollEvents();
     }