使用 WebGPU 构建应用

François Beaufort
François Beaufort
GitHub

对于 Web 开发者而言，WebGPU 是一种 Web 图形 API，可提供对 GPU 的统一快速访问。WebGPU 会公开现代硬件功能，并允许在 GPU 上执行渲染和计算操作，类似于 Direct3D 12、Metal 和 Vulkan。

虽然这确实是事实，但这个故事并不完整。WebGPU 是 Apple、Google、Intel、Mozilla 和 Microsoft 等多家大公司的共同努力成果。其中，有些人意识到，WebGPU 不仅仅是一个 JavaScript API，而是面向 Web 以外各个生态系统的开发者的跨平台图形 API。

为了实现主要用例，Chrome 113 中引入了 JavaScript API。不过，我们还开发了另一个重要的项目：webgpu.h C API。此 C 头文件列出了 WebGPU 的所有可用过程和数据结构。它可用作与平台无关的硬件抽象层，通过在不同平台上提供一致的接口，让您能够构建平台专用应用。

在本文档中，您将了解如何使用 WebGPU 编写一个可在 Web 和特定平台上运行的小型 C++ 应用。剧透警告：您只需对代码库进行最少的调整，便会在浏览器窗口和桌面窗口中看到相同的红色三角形。

显示 macOS 上浏览器窗口和桌面窗口中由 WebGPU 提供支持的红色三角形的屏幕截图。
浏览器窗口和桌面窗口中由 WebGPU 驱动的相同三角形。

工作原理

如需查看完成的应用，请查看 WebGPU 跨平台应用代码库。

该应用是一个极简的 C++ 示例，展示了如何使用 WebGPU 从单一代码库构建桌面应用和 Web 应用。在底层，它通过名为 webgpu_cpp.h 的 C++ 封装容器，使用 WebGPU 的 webgpu.h 作为平台无关的硬件抽象层。

在 Web 上，应用是针对 Emscripten 构建的，该库在 JavaScript API 之上实现了 webgpu.h 绑定。在 macOS 或 Windows 等特定平台上，此项目可以基于 Dawn（Chromium 的跨平台 WebGPU 实现）进行构建。值得注意的是，还有一个 Rust 实现 webgpu.h 的 wgpu-native，但本文档中未使用它。

开始使用

首先，您需要 C++ 编译器和 CMake 才能以标准方式处理跨平台 build。在专用文件夹中，创建 main.cpp 源文件和 CMakeLists.txt 构建文件。

main.cpp 文件目前应包含一个空的 main() 函数。

int main() {}

CMakeLists.txt 文件包含项目的基本信息。最后一行指定可执行文件名称为“app”，其源代码为 main.cpp。

cmake_minimum_required(VERSION 3.13) # CMake version check
project(app)                         # Create project "app"
set(CMAKE_CXX_STANDARD 20)           # Enable C++20 standard

add_executable(app "main.cpp")

运行 cmake -B build 以在“build/”子文件夹中创建 build 文件，并运行 cmake --build build 以实际构建应用并生成可执行文件。

# Build the app with CMake.
$ cmake -B build && cmake --build build

# Run the app.
$ ./build/app

应用会运行，但目前还没有输出，因为您需要找到一种在屏幕上绘制内容的方法。

获取黎明

如需绘制三角形，您可以利用 Dawn，即 Chromium 的跨平台 WebGPU 实现。其中包括用于绘制到屏幕的 GLFW C++ 库。下载 Dawn 的方法之一是将其作为 git 子模块添加到代码库中。以下命令会将其提取到“dawn/”子文件夹中。

$ git init
$ git submodule add https://dawn.googlesource.com/dawn

然后，将以下内容附加到 CMakeLists.txt 文件中：

  • CMake DAWN_FETCH_DEPENDENCIES 选项会提取所有 Dawn 依赖项。
  • 目标中包含 dawn/ 子文件夹。
  • 您的应用将依赖于 dawn::webgpu_dawn、glfw 和 webgpu_glfw 目标，以便您稍后在 main.cpp 文件中使用它们。
…
set(DAWN_FETCH_DEPENDENCIES ON)
add_subdirectory("dawn" EXCLUDE_FROM_ALL)
target_link_libraries(app PRIVATE dawn::webgpu_dawn glfw webgpu_glfw)

打开窗口

现在 Dawn 已可供使用，接下来使用 GLFW 在屏幕上绘制内容。webgpu_glfw 中包含此库是为了方便您编写与平台无关的窗口管理代码。

如需打开名为“WebGPU window”且分辨率为 512x512 的窗口，请按如下所示更新 main.cpp 文件。请注意，此处使用 glfwWindowHint() 是为了请求不进行任何特定的图形 API 初始化。

#include <GLFW/glfw3.h>

const uint32_t kWidth = 512;
const uint32_t kHeight = 512;

void Start() {
  if (!glfwInit()) {
    return;
  }

  glfwWindowHint(GLFW_CLIENT_API, GLFW_NO_API);
  GLFWwindow* window =
      glfwCreateWindow(kWidth, kHeight, "WebGPU window", nullptr, nullptr);

  while (!glfwWindowShouldClose(window)) {
    glfwPollEvents();
    // TODO: Render a triangle using WebGPU.
  }
}

int main() {
  Start();
}

现在，重新构建应用并像以前一样运行它会导致出现空白窗口。您取得了进步！

空白的 macOS 窗口的屏幕截图。
空白窗口。

获取 GPU 设备

在 JavaScript 中，navigator.gpu 是访问 GPU 的入口点。在 C++ 中，您需要手动创建一个用于相同用途的 wgpu::Instance 变量。为方便起见，请在 main.cpp 文件顶部声明 instance，并在 main() 内调用 wgpu::CreateInstance()。

…
#include <webgpu/webgpu_cpp.h>

wgpu::Instance instance;
…

int main() {
  instance = wgpu::CreateInstance();
  Start();
}

由于 JavaScript API 的形状，访问 GPU 是异步进行的。在 C++ 中，创建两个名为 GetAdapter() 和 GetDevice() 的辅助函数，分别返回一个带有 wgpu::Adapter 和 wgpu::Device 的回调函数。

#include <iostream>
…

void GetAdapter(void (*callback)(wgpu::Adapter)) {
  instance.RequestAdapter(
      nullptr,
      [](WGPURequestAdapterStatus status, WGPUAdapter cAdapter,
         const char* message, void* userdata) {
        if (status != WGPURequestAdapterStatus_Success) {
          exit(0);
        }
        wgpu::Adapter adapter = wgpu::Adapter::Acquire(cAdapter);
        reinterpret_cast<void (*)(wgpu::Adapter)>(userdata)(adapter);
  }, reinterpret_cast<void*>(callback));
}

void GetDevice(void (*callback)(wgpu::Device)) {
  adapter.RequestDevice(
      nullptr,
      [](WGPURequestDeviceStatus status, WGPUDevice cDevice,
          const char* message, void* userdata) {
        wgpu::Device device = wgpu::Device::Acquire(cDevice);
        device.SetUncapturedErrorCallback(
            [](WGPUErrorType type, const char* message, void* userdata) {
              std::cout << "Error: " << type << " - message: " << message;
            },
            nullptr);
        reinterpret_cast<void (*)(wgpu::Device)>(userdata)(device);
  }, reinterpret_cast<void*>(callback));
}

为方便访问，请在 main.cpp 文件顶部声明两个变量 wgpu::Adapter 和 wgpu::Device。更新 main() 函数以调用 GetAdapter() 并将其结果回调分配给 adapter，然后调用 GetDevice() 并将其结果回调分配给 device，最后调用 Start()。

wgpu::Adapter adapter;
wgpu::Device device;
…

int main() {
  instance = wgpu::CreateInstance();
  GetAdapter([](wgpu::Adapter a) {
    adapter = a;
    GetDevice([](wgpu::Device d) {
      device = d;
      Start();
    });
  });
}

绘制三角形

交换链不会在 JavaScript API 中公开，因为浏览器会负责处理它。在 C++ 中，您需要手动创建它。再次提醒一下，为方便起见，请在 main.cpp 文件顶部声明一个 wgpu::Surface 变量。在 Start() 中创建 GLFW 窗口后，调用实用的 wgpu::glfw::CreateSurfaceForWindow() 函数来创建 wgpu::Surface（类似于 HTML 画布），并通过调用 InitGraphics() 中的新辅助函数 ConfigureSurface() 对其进行配置。您还需要调用 surface.Present() 以在 while 循环中呈现下一个纹理。这不会产生任何可见效果，因为尚未进行任何渲染。

#include <webgpu/webgpu_glfw.h>
…

wgpu::Surface surface;
wgpu::TextureFormat format;

void ConfigureSurface() {
  wgpu::SurfaceCapabilities capabilities;
  surface.GetCapabilities(adapter, &capabilities);
  format = capabilities.formats[0];

  wgpu::SurfaceConfiguration config{
      .device = device,
      .format = format,
      .width = kWidth,
      .height = kHeight};
  surface.Configure(&config);
}

void InitGraphics() {
  ConfigureSurface();
}

void Render() {
  // TODO: Render a triangle using WebGPU.
}

void Start() {
  …
  surface = wgpu::glfw::CreateSurfaceForWindow(instance, window);

  InitGraphics();

  while (!glfwWindowShouldClose(window)) {
    glfwPollEvents();
    Render();
    surface.Present();
    instance.ProcessEvents();
  }
}

现在，可以使用以下代码创建渲染流水线了。为方便访问，请在 main.cpp 文件顶部声明一个 wgpu::RenderPipeline 变量，并在 InitGraphics() 中调用辅助函数 CreateRenderPipeline()。

wgpu::RenderPipeline pipeline;
…

const char shaderCode[] = R"(
    @vertex fn vertexMain(@builtin(vertex_index) i : u32) ->
      @builtin(position) vec4f {
        const pos = array(vec2f(0, 1), vec2f(-1, -1), vec2f(1, -1));
        return vec4f(pos[i], 0, 1);
    }
    @fragment fn fragmentMain() -> @location(0) vec4f {
        return vec4f(1, 0, 0, 1);
    }
)";

void CreateRenderPipeline() {
  wgpu::ShaderModuleWGSLDescriptor wgslDesc{};
  wgslDesc.code = shaderCode;

  wgpu::ShaderModuleDescriptor shaderModuleDescriptor{
      .nextInChain = &wgslDesc};
  wgpu::ShaderModule shaderModule =
      device.CreateShaderModule(&shaderModuleDescriptor);

  wgpu::ColorTargetState colorTargetState{.format = format};

  wgpu::FragmentState fragmentState{.module = shaderModule,
                                    .targetCount = 1,
                                    .targets = &colorTargetState};

  wgpu::RenderPipelineDescriptor descriptor{
      .vertex = {.module = shaderModule},
      .fragment = &fragmentState};
  pipeline = device.CreateRenderPipeline(&descriptor);
}

void InitGraphics() {
  …
  CreateRenderPipeline();
}

最后，在每个帧调用的 Render() 函数中向 GPU 发送渲染命令。

void Render() {
  wgpu::SurfaceTexture surfaceTexture;
  surface.GetCurrentTexture(&surfaceTexture);

  wgpu::RenderPassColorAttachment attachment{
      .view = surfaceTexture.texture.CreateView(),
      .loadOp = wgpu::LoadOp::Clear,
      .storeOp = wgpu::StoreOp::Store};

  wgpu::RenderPassDescriptor renderpass{.colorAttachmentCount = 1,
                                        .colorAttachments = &attachment};

  wgpu::CommandEncoder encoder = device.CreateCommandEncoder();
  wgpu::RenderPassEncoder pass = encoder.BeginRenderPass(&renderpass);
  pass.SetPipeline(pipeline);
  pass.Draw(3);
  pass.End();
  wgpu::CommandBuffer commands = encoder.Finish();
  device.GetQueue().Submit(1, &commands);
}

现在，使用 CMake 重新构建应用并运行该应用，窗口中会显示期待已久的红色三角形！休息一下吧，您值得。

macOS 窗口中显示红色三角形的屏幕截图。
桌面窗口中的红色三角形。

编译为 WebAssembly

现在，我们来看看调整现有代码库以在浏览器窗口中绘制此红色三角形所需的最少更改。同样，该应用是针对 Emscripten 构建的，这是一个用于将 C/C++ 程序编译为 WebAssembly 的工具，它在 JavaScript API 之上实现了 webgpu.h 的绑定。

更新 CMake 设置

安装 Emscripten 后，请按如下方式更新 CMakeLists.txt build 文件。您只需更改突出显示的代码。

  • set_target_properties 用于自动向目标文件添加“html”文件扩展名。也就是说，您将生成一个“app.html”文件。
  • 必须使用 USE_WEBGPU 应用链接选项才能在 Emscripten 中启用 WebGPU 支持。否则，您的 main.cpp 文件将无法访问 webgpu/webgpu_cpp.h 文件。
  • 此处还需要 USE_GLFW app link 选项，以便您重复使用 GLFW 代码。
cmake_minimum_required(VERSION 3.13) # CMake version check
project(app)                         # Create project "app"
set(CMAKE_CXX_STANDARD 20)           # Enable C++20 standard

add_executable(app "main.cpp")

if(EMSCRIPTEN)
  set_target_properties(app PROPERTIES SUFFIX ".html")
  target_link_options(app PRIVATE "-sUSE_WEBGPU=1" "-sUSE_GLFW=3")
else()
  set(DAWN_FETCH_DEPENDENCIES ON)
  add_subdirectory("dawn" EXCLUDE_FROM_ALL)
  target_link_libraries(app PRIVATE dawn::webgpu_dawn glfw webgpu_glfw)
endif()

更新代码

在 Emscripten 中，创建 wgpu::surface 需要 HTML 画布元素。为此，请调用 instance.CreateSurface() 并指定 #canvas 选择器，以匹配 Emscripten 生成的 HTML 网页中的相应 HTML 画布元素。

请调用 emscripten_set_main_loop(Render)（而非使用 while 循环），以确保以适当的平滑速率调用 Render() 函数，使其与浏览器和监视器保持一致。

#include <GLFW/glfw3.h>
#include <webgpu/webgpu_cpp.h>
#include <iostream>
#if defined(__EMSCRIPTEN__)
#include <emscripten/emscripten.h>
#else
#include <webgpu/webgpu_glfw.h>
#endif

void Start() {
  if (!glfwInit()) {
    return;
  }

  glfwWindowHint(GLFW_CLIENT_API, GLFW_NO_API);
  GLFWwindow* window =
      glfwCreateWindow(kWidth, kHeight, "WebGPU window", nullptr, nullptr);

#if defined(__EMSCRIPTEN__)
  wgpu::SurfaceDescriptorFromCanvasHTMLSelector canvasDesc{};
  canvasDesc.selector = "#canvas";

  wgpu::SurfaceDescriptor surfaceDesc{.nextInChain = &canvasDesc};
  surface = instance.CreateSurface(&surfaceDesc);
#else
  surface = wgpu::glfw::CreateSurfaceForWindow(instance, window);
#endif

  InitGraphics();

#if defined(__EMSCRIPTEN__)
  emscripten_set_main_loop(Render, 0, false);
#else
  while (!glfwWindowShouldClose(window)) {
    glfwPollEvents();
    Render();
    surface.Present();
    instance.ProcessEvents();
  }
#endif
}

使用 Emscripten 构建应用

使用 Emscripten 构建应用时，只需对 cmake 命令添加神奇的 emcmake shell 脚本即可。这次，请在 build-web 子文件夹中生成应用并启动 HTTP 服务器。最后，打开浏览器并访问 build-web/app.html。

# Build the app with Emscripten.
$ emcmake cmake -B build-web && cmake --build build-web

# Start a HTTP server.
$ npx http-server
浏览器窗口中红色三角形的屏幕截图。
浏览器窗口中的红色三角形。

后续步骤

未来将发生以下变化：

  • 改进了 webgpu.h 和 webgpu_cpp.h API 的稳定性。
  • 对 Android 和 iOS 的 Dawn 初始支持。

与此同时，请提交 Emscripten 的 WebGPU 问题和 Dawn 问题，并附上建议和问题。

资源

您可以随时探索此应用的源代码。

如果您想深入了解如何使用 WebGPU 从头开始使用 C++ 创建原生 3D 应用，请参阅“了解适用于 C++ 的 WebGPU”文档和 Dawn 原生 WebGPU 示例。

如果您对 Rust 感兴趣，还可以探索基于 WebGPU 的 wgpu 图形库。查看他们的 hello-triangle 演示。

致谢

本文由 Corentin Wallez、Kai Ninomiya 和 Rachel Andrew 审核。

照片由 Unsplash 用户 Marc-Olivier Jodoin 拍摄。