mirror of
https://github.com/storytold/wgpu.git
synced 2026-11-19 22:11:01 +01:00
Merge #390
390: Example feature matrix r=cwfitzgerald a=kvark This PR introduces a feature matrix to show what feature can be found in which example. I expect we'll be linking to it a lot :) It also renames the `describe` example so that we can distinguish easily between ones that are framework-based and standalone ones (starting with "hello"). Concerns: - the star may be a bit too bleak... I haven't found a better one that would be short to type (choosing a long one means editing is uncomfortable). - sometimes hard to figure out what deserves a feature in the table and what not... still a win to have at least something here - we need to do something with `capture`, see #387, but I haven't figured out what exactly also r? @rukai Co-authored-by: Dzmitry Malyshau <kvarkus@gmail.com>
This commit is contained in:
commit
214e49725c
3 files changed
+43
-2
No files matched your search
@@ -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>
|
||||
```
|
||||
@@ -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
|
||||
File renamed without changes.
Reference in new issue
Block a user