[rs] Example feature matrix

This commit is contained in:
Dzmitry Malyshau 2020-06-18 12:41:38 -04:00
parent 8bceed45a8
commit d121c7237e
3 changed files with 43 additions and 2 deletions

41
wgpu/examples/README.md Normal file
View File

@ -0,0 +1,41 @@
## Structure
For the simplest examples without using any helping code (see `framework.rs` here), check out:
- `hello ` for printing adapter information
- `hello-triangle` for graphics and presentation
- `hello-compute` for pure computing
Notably, `capture` example show rendering without a surface/window. It reads back the contents and saves them to a file.
All framework-based examples render to the window.
## Feature matrix
| Feature | boids | cube | mipmap | msaa-line | shadow | skybox | texture-arrays | water |
| ---------------------- | ------ | ------ | ------ | --------- | ------ | ------ | -------------- | ------ |
| vertex attributes | :star: | :star: | :star: | :star: | :star: | | :star: | :star: |
| instancing | :star: | | | | | | | |
| lines and points | | | | :star: | | | | |
| sampled color textures | :star: | :star: | :star: | | | :star: | :star: | :star: |
| storage textures | :star: | | | | | | | |
| binding array | | | | | | | :star: | |
| comparison samplers | | | | | :star: | | | |
| subresource views | | | :star: | | :star: | | | |
| cubemaps | | | | | | :star: | | |
| multisampling | | | | :star: | | | | |
| off-screen rendering | | | | | :star: | | | :star: |
| stencil testing | | | | | | | | |
| depth testing | | | | | :star: | | | :star: |
| read-only depth | | | | | | | | :star: |
| blending | | | | | | | | :star: |
| render bundles | | | | :star: | | | | :star: |
| compute passes | :star: | | | | | | | |
| optional extensions | | | | | | | :star: | |
| - binding indexing | | | | | | | :star: | |
| WGSL shaders | | | | | | | | |
## Hacking
You can record an API trace any of the framework-based examples by starting them as:
```sh
mkdir -p trace && WGPU_TRACE=trace cargo run --features trace --example <example-name>
```

View File

@ -1,11 +1,11 @@
# describe
# hello
This example prints output describing the adapter in use.
## To Run
```
cargo run --example describe
cargo run --example hello
```
## Example output