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 833d18ff05 explaining why imgui-demo and pong are still broken 3 years ago
code explaining why imgui-demo and pong are still broken 3 years ago
docs explaining why imgui-demo and pong are still broken 3 years ago
.gitignore debugging tutorials 9 and 10 3 years ago
.travis.yml travis now installs libasound2-dev 3 years ago
Cargo.lock explaining why imgui-demo and pong are still broken 3 years ago
Cargo.toml reworked swapchain tutorial to use surface 3 years ago
FEATURES.md tutorial4-buffer 5 years ago
LICENSE.md license 4 years ago
deploy.sh updated deploy.sh to cleanup dist git repo 4 years ago
package-lock.json Bump url-parse from 1.5.1 to 1.5.3 3 years ago
package.json finished lighting rewrite 4 years ago
run-all.sh Remove unnecessary comment 3 years ago
rustfmt.toml rustfmt 4 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 about Cargo.

I'm using this project as a way to learn wgpu myself, so I might miss some important details, or explain things wrong. 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

  • Jan Šipr
  • Danny McGee
  • Bernard Llanos
  • Ken Kochis
  • Aron Granberg
  • Ben Anderson
  • Ian Gowen
  • Paul E Hansen
  • Lennart
  • Gunstein Vatnar
  • David Laban