jWebGPU

A Java-based WebGPU binding that works across Desktop, Mobile, and Web platforms.

Demo

Android

Platform status:

Backend	Emscripten	Windows	Linux	Mac	Android	iOS
wgpu-native	❌	✅	✅	✅	✅	❌
	-	x86_64	x86_64	x86_64 arm64	x86 x86_64 arm64_v8a armeabi_v7a	TODO
Dawn	✅	✅	❌	❌	❌	❌
	wasm	x86_64	-	-	-	-

Naming Conventions

To help you navigate the jWebGPU library, here are the naming conventions used for classes, enums, and methods:

• Custom Classes: Start with WGPU (e.g., WGPU, WGPUAndroidWindow).
• WebGPU Classes: Start with WGPU (e.g., WGPUAdapter, WGPUDevice).
• WebGPU Enums: Start with WGPU (e.g., WGPUTextureFormat, WGPUPowerPreference).
• Methods Requiring Arrays: Start with WGPUVector (e.g., WGPUVectorTextureFormat, WGPUVectorInt).

Memory Management and Static Obtain Methods

Most classes in jWebGPU, except for opaque pointer classes, provide a static obtain method. This method returns a global, reusable object to minimize allocations in both Java and native memory, eliminating the need for disposal. Developers should use the obtain method whenever possible to reuse these global instances. However, if a unique class instance with a separate memory address is required, developers must create a new instance explicitly.

Build Steps

Change LibExt.exampleUseRepoLibs to false. Set to true only if you want to try the demo without building.

1. Download Dependencies
   Grab all the dependency files. They'll be saved in webgpu/webgpu-wgpu/build.

./gradlew :webgpu:webgpu-download:webgpu_download_glfw_windows
./gradlew :webgpu:webgpu-download:webgpu_download_emdawnwebgpu
./gradlew :webgpu:webgpu-download:webgpu_download_windows_x86_64_wgpu
./gradlew :webgpu:webgpu-download:webgpu_download_windows_x86_64_dawn
./gradlew :webgpu:webgpu-download:webgpu_download_windows_aarch64_wgpu
./gradlew :webgpu:webgpu-download:webgpu_download_macos_x86_64_wgpu
./gradlew :webgpu:webgpu-download:webgpu_download_macos_aarch64_wgpu
./gradlew :webgpu:webgpu-download:webgpu_download_linux_x86_wgpu
./gradlew :webgpu:webgpu-download:webgpu_download_linux_aarch64_wgpu
./gradlew :webgpu:webgpu-download:webgpu_download_android_x86_wgpu
./gradlew :webgpu:webgpu-download:webgpu_download_android_i686_wgpu
./gradlew :webgpu:webgpu-download:webgpu_download_android_armv7_wgpu
./gradlew :webgpu:webgpu-download:webgpu_download_android_aarch64_wgpu

2. Build Bindings for All Platforms
   Make sure your PC is set up to build for each platform.
   The native files will end up in webgpu/webgpu-build/build/C++/libs.

// Windows requires Visual Studio 2022 C++
./gradlew :webgpu:webgpu-build:webgpu_build_project_windows64_wgpu
./gradlew :webgpu:webgpu-build:webgpu_build_project_windows64_dawn

// TeaVM requires Emscripten
./gradlew :webgpu:webgpu-build:webgpu_build_project_teavm_dawn

// Android requires NDK
./gradlew :webgpu:webgpu-build:webgpu_build_project_android_wgpu

3. Run or Install the Demo App
   Try out the demo with these commands:

./gradlew :demos:app:desktop:webgpu_demo_app_run_desktop
./gradlew :demos:app:teavm:webgpu_demo_app_run_teavm
./gradlew :demos:app:android:installDebug