WebGPU でアプリをビルドする

François Beaufort
François Beaufort
GitHub

ウェブ デベロッパーにとって、WebGPU は GPU への統合された高速アクセスを提供するウェブ グラフィック API です。WebGPU は、最新のハードウェア機能を公開し、Direct3D 12、Metal、Vulkan と同様に、GPU でレンダリングと計算オペレーションを行うことができます。

これは事実ですが、このストーリーは不完全です。WebGPU は、Apple、Google、Intel、Mozilla、Microsoft などの大手企業による共同作業の成果です。中でも、WebGPU は JavaScript API ではなく、ウェブ以外のエコシステムのデベロッパーにとってクロス プラットフォーム グラフィック API になる可能性があることを認識しています。

主なユースケースを実現するため、Chrome 113 で JavaScript API が導入されました。ただし、これと並行して、もう 1 つの重要なプロジェクトである webgpu.h C API も開発されています。この C ヘッダー ファイルには、WebGPU で使用可能なすべてのプロシージャとデータ構造が一覧表示されます。これはプラットフォームに依存しないハードウェア抽象化レイヤとして機能し、さまざまなプラットフォームで一貫したインターフェースを提供することで、プラットフォーム固有のアプリケーションを構築できます。

このドキュメントでは、WebGPU を使用して、ウェブと特定のプラットフォームの両方で実行される小さな C++ アプリを作成する方法について説明します。ブラウザ ウィンドウとデスクトップ ウィンドウに表示される赤色の三角形が、コードベースに最小限の変更を加えるだけで表示されます。

macOS のブラウザ ウィンドウとデスクトップ ウィンドウに表示される、WebGPU による赤い三角形のスクリーンショット。
WebGPU を搭載した同じ三角形が、ブラウザ ウィンドウとデスクトップ ウィンドウで表示されます。

仕組み

完成したアプリケーションを確認するには、WebGPU クロスプラットフォーム アプリのリポジトリをご覧ください。

このアプリは、WebGPU を使用して 1 つのコードベースからデスクトップ アプリとウェブアプリを作成する方法を示す、ミニマルな C++ の例です。内部的には、webgpu_cpp.h という C++ ラッパーを介して、プラットフォームに依存しないハードウェア抽象化レイヤとして WebGPU の webgpu.h を使用します。

ウェブでは、アプリは Emscripten に対してビルドされます。Emscripten には、JavaScript API の上に webgpu.h を実装するバインディングがあります。macOS や Windows などの特定のプラットフォームでは、このプロジェクトは Chromium のクロスプラットフォーム WebGPU 実装である Dawn に対してビルドできます。webgpu.h の Rust 実装である wgpu-native も存在しますが、このドキュメントでは使用しません。

使ってみる

まず、クロスプラットフォーム ビルドを標準的な方法で処理するための C++ コンパイラと CMake が必要です。専用のフォルダ内に、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/」サブフォルダにビルドファイルを作成し、cmake --build build を実行して実際にアプリをビルドして実行可能ファイルを生成します。

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

# Run the app.
$ ./build/app

アプリは実行されますが、画面に描画する方法が必要なため、まだ出力がありません。

Dawn を入手する

三角形を描画するには、Chromium のクロス プラットフォーム WebGPU 実装である Dawn を利用できます。これには、画面に描画するための 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 に含まれているこのライブラリを使用すると、ウィンドウ管理についてプラットフォームに依存しないコードを記述できます。

解像度が 512x512 の「WebGPU ウィンドウ」という名前のウィンドウを開くには、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();
}

GPU へのアクセスは、JavaScript API の形状により非同期です。C++ で、GetAdapter() と GetDevice() という 2 つのヘルパー関数を作成し、それぞれ 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 ファイルの上部に 2 つの変数 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() 関数を呼び出して構成します。また、while ループで次のテクスチャを表示するために、surface.Present() を呼び出す必要があります。まだレンダリングが行われていないため、目に見える効果はありません。

#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 ウィンドウに表示された赤い三角形のスクリーンショット。
PC のウィンドウに表示される赤い三角形。

WebAssembly にコンパイルする

ブラウザ ウィンドウにこの赤い三角形を描画するように既存のコードベースを調整するために必要な最小限の変更を見てみましょう。繰り返しになりますが、このアプリは Emscripten に対してビルドされています。Emscripten は C/C++ プログラムを WebAssembly にコンパイルするためのツールです。このツールには、JavaScript API 上に webgpu.h を実装するバインディングがあります。

CMake 設定を更新する

Emscripten がインストールされたら、次のように CMakeLists.txt ビルドファイルを更新します。変更する必要があるのはハイライト表示されたコードのみです。

  • set_target_properties は、ターゲット ファイルに「html」ファイル拡張子を自動的に追加するために使用します。つまり、「app.html」ファイルを生成します。
  • Emscripten で WebGPU のサポートを有効にするには、USE_WEBGPU アプリリンク オプションが必要です。このファイルがないと、main.cpp ファイルは webgpu/webgpu_cpp.h ファイルにアクセスできません。
  • GLFW コードを再利用できるように、ここでは USE_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 キャンバス要素と一致させます。

while ループを使用する代わりに、emscripten_set_main_loop(Render) を呼び出して、ブラウザやモニタリングに合わせて適切な滑らかな速度で 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 シェル スクリプトを付加することです。今回は、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 API と webgpu_cpp.h API の安定性を改善しました。
  • Android と iOS での Dawn の初期サポート。

ご意見やご質問がある場合は、Emscripten の WebGPU に関する問題と Dawn に関する問題を報告してください。

リソース

このアプリのソースコードを参照してください。

WebGPU を使用して C++ でネイティブ 3D アプリケーションをゼロから作成する方法について詳しくは、Learn WebGPU for C++ のドキュメントと Dawn Native WebGPU の例をご覧ください。

Rust に興味がある場合は、WebGPU ベースの wgpu グラフィック ライブラリも利用できます。hello-triangle デモをご覧ください。

謝辞

この記事は、Corentin Wallez、Kai Ninomiya、Rachel Andrew が確認しました。

写真提供: Marc-Olivier Jodoin（Unsplash）。