Guide for using gfx-rs's wgpu library.
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Go to file
Ben Hansen ef6ec265d8 Merge branch 'master' into web2 2 years ago
.cargo more-testing 2 years ago
.github/workflows trying to fix wasm deploy 2 years ago
code Merge branch 'master' into web2 2 years ago
docs Merge branch 'master' into web2 2 years ago
run-wasm more-testing 2 years ago
.gitignore finally migrated tutorial9 code 2 years ago
Cargo.lock updated intermediate tutorial docs and removing tutorial13 for maintenance 2 years ago
Cargo.toml more-testing 2 years ago
FEATURES.md some fixes to web 2 years ago
LICENSE.md license 4 years ago
build-wasm.sh updated intermediate tutorial docs and removing tutorial13 for maintenance 2 years ago
index.template.html wasm is building 3 years ago
package-lock.json updating package-lock.json 2 years ago
package.json working on tutorial9 2 years ago
run-all.sh tutorials 1-9 now work with wasm 2 years ago
rustfmt.toml rustfmt 4 years ago
yarn.lock web examples working with vuepress 2 years ago

docs/README.md

Introduction

What is wgpu?

Wgpu is a Rust implementation of the WebGPU API spec. WebGPU is a specification published by the GPU for the Web Community Group. It aims to allow web code access to GPU functions in a safe and reliable manner. It does this by mimicking the Vulkan API, and translating that down to whatever API the host hardware is using (ie. DirectX, Metal, Vulkan).

Wgpu is still in development, so some of this doc is subject to change.

Why Rust?

Wgpu actually has C bindings to allow you to write C/C++ code with it, as well as use other languages that interface with C. That being said, wgpu is written in Rust, and it has some convenient Rust bindings that don't have to jump through any hoops. On top of that, I've been enjoying writing in Rust.

You should be fairly familiar with Rust before using this tutorial as I won't go into much detail on Rust syntax. If you're not super comfortable with Rust you can review the Rust tutorial. You should also be familiar with Cargo.

I'm using this project to learn wgpu myself, so I might miss some important details, or explain things badly. I'm always open to constructive feedback.

Contribution and Support

  • I accept pull requests (GitHub repo) for fixing issues with this tutorial such as typos, incorrect information, and other inconsistencies.
  • Due to wgpu's rapidly changing api, I'm not accepting any new pull requests for showcase demos.
  • If you want to support me directly, check out my patreon!

Special thanks to these patrons!

In no particular order

  • Zeh Fernando
  • The toddling chaos
  • Jan Šipr
  • Bernard Llanos
  • Aron Granberg
  • Ian Gowen
  • Paul E Hansen
  • Lennart
  • Gunstein Vatnar
  • David Laban