nordic-dev.net/wgpu
nordic-dev.net/wgpu
2
0
Fork 0
mirror of https://github.com/gfx-rs/wgpu.git synced 2024-11-25 08:13:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

update README.md

Browse Source
This commit is contained in:
Timo de Kort 2019-07-29 23:27:30 +02:00
parent 50454d43df
commit 939ed8dc7a
1 changed files with 10 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -13,44 +13,17 @@ The implementation consists of the following parts:
2. `wgpu-remote` - remoting layer to work with WebGPU across the process boundary
3. `ffi` - the C headers generated by [cbindgen](https://github.com/eqrion/cbindgen) for both of the libraries
Supported platforms:
- Vulkan on Windows and Linux
- D3D12 and D3D11 on Windows
- Metal on macOS and iOS
## Supported Platforms
API | Windows | Linux | macOS & iOS |
----- | ------------------ | ------------------ | ------------------ |
DX11 | :heavy_check_mark: | | |
DX12 | :heavy_check_mark: | | |
Vulkan | :heavy_check_mark: | :heavy_check_mark: | |
Metal | | | :heavy_check_mark: |
## Usage
This repository contains C-language examples that link to the native library targets and perform basic rendering and computation.
This repository contains C-language examples that link to the native library targets and perform basic rendering and computation. Please refer to our [Getting Started](https://github.com/gfx-rs/wgpu/wiki/Getting-Started#getting-started) page at the wiki for more information.
### Prerequisites
- C compiler
- GLFW 3
- Rust nightly toolchain
```bash
rustup toolchain install nightly
```
- [Cbindgen](https://github.com/eqrion/cbindgen)
```bash
cargo install cbindgen
```
### Running an example
The examples are located under the [examples](examples) directory. We are using a [Makefile](Makefile) for running the examples.
#### Triangle
```bash
make example-triangle
```
#### Compute
```bash
make example-compute
```
#### Remote
```bash
make example-remote
```
The idiomatic Rust wrapper lives in https://github.com/gfx-rs/wgpu-rs and provides a number of more [complex examples](https://github.com/gfx-rs/wgpu-rs/tree/master/examples) to get a feel of the API.
The idiomatic Rust wrapper lives in https://github.com/gfx-rs/wgpu-rs and provides a number of more [complex examples](https://github.com/gfx-rs/wgpu-rs/tree/master/examples) to get a feel of the API.