WebGPU でアプリをビルドする

François Beaufort
François Beaufort
GitHub

WebGPU はウェブ デベロッパー向けに開発されたウェブ グラフィック API で、 制限します。WebGPU では最新のハードウェア機能が使用でき、レンダリングを可能に GPU での計算オペレーション（Direct3D 12、Metal、Vulkan と同様）

事実であるものの、この話は完全ではありません。WebGPU は、 大手企業（Apple、Google、Intel、Mozilla、 Microsoftそのなかで認識した JavaScript API ではなく、クロスプラットフォームのグラフィックスを ウェブ以外のエコシステムのデベロッパー向け API。

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

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

<ph type="x-smartling-placeholder">
</ph> macOS のブラウザ ウィンドウとデスクトップ ウィンドウに表示された、WebGPU を利用した赤い三角形のスクリーンショット <ph type="x-smartling-placeholder">
</ph> ブラウザ ウィンドウとデスクトップ ウィンドウで、WebGPU により同じ三角形が表示されている。

仕組み

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

WebGPU を使用して単一のコードベースからデスクトップ アプリとウェブアプリを構築する方法を示す、シンプルな 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

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

夜明け

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

「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();
}

アプリを再ビルドして以前と同様に実行すると、空のウィンドウが表示されます。順調に進んでいます！

<ph type="x-smartling-placeholder">
</ph> 空の macOS ウィンドウのスクリーンショット <ph type="x-smartling-placeholder">
</ph> 空のウィンドウ。

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 ファイルの先頭で wgpu::Adapter と wgpu::Device の 2 つの変数を宣言します。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 でアプリを再ビルドして実行すると、待望の赤い三角形がウィンドウに表示されます。一息つきましょう。

<ph type="x-smartling-placeholder">
</ph> macOS ウィンドウに表示された赤い三角形のスクリーンショット。 <ph type="x-smartling-placeholder">
</ph> デスクトップ ウィンドウに表示された赤い三角形。

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
<ph type="x-smartling-placeholder">
</ph> ブラウザ ウィンドウに表示された赤い三角形のスクリーンショット。
ブラウザ ウィンドウに表示されている赤い三角形。

次のステップ

今後の流れ:

  • webgpu.h API と webgpu_cpp.h API の安定化機能を改善しました。
  • Android と iOS 向けの Dawn の初期サポート。

それまでは、Emscripten の WebGPU に関する問題、および Dawn に関する問題、ご提案やご質問をお寄せください。

リソース

このアプリのソースコードを自由に確認できます。

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

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

謝辞

この記事は、Corentin Wallez、Kai Ninomiya、Rachel Andrew がレビューしました。

写真撮影: Marc-Olivier Jodoin（出典: Unsplash）