learn-wgpu/docs/README.md

33 lines
1.8 KiB
Markdown
Raw Normal View History

2019-10-19 21:17:15 +00:00
# Introduction
## What is wgpu?
2019-10-19 22:01:59 +00:00
[Wgpu](https://github.com/gfx-rs/wgpu) is a Rust implementation of the [WebGPU API spec](https://gpuweb.github.io/gpuweb/). 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).
2019-10-19 21:17:15 +00:00
Wgpu is still in development, so some of this doc is subject to change.
## Why Rust?
2020-10-04 09:25:46 +00:00
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 convient Rust bindings that don't have to jump through any hoops. On top of that, I've been enjoying writing in Rust.
2019-10-19 21:17:15 +00:00
2019-10-19 22:01:59 +00:00
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](https://www.rust-lang.org/learn). You should also be familiar about [Cargo](https://doc.rust-lang.org/cargo/).
2020-11-24 06:29:52 +00:00
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
2021-03-20 13:35:03 +00:00
* I accept pull requests ([GitHub repo](https://github.com/sotrh/learn-wgpu)) for fixing issues with this tutorial such as typos, incorrect information, and other inconsistencies.
2020-11-24 06:29:52 +00:00
* 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](https://www.patreon.com/sotrh)!
2021-01-15 06:50:55 +00:00
## Special thanks to these patrons!
*In no particular order*
2021-03-11 03:36:23 +00:00
* Ben Anderson
* Ian Gowen
* Eliot Bolduc
2021-01-15 06:50:55 +00:00
* Paul E Hansen
* Lennart
* Gunstein Vatnar
* yutani
* David Laban