mirror of
https://github.com/storytold/wgpu.git
synced 2026-11-19 14:01:08 +01:00
Readme update
This commit is contained in:
1 parent
6ce9cbd679
commit
5eda162748
4 files changed
+11
-50
No files matched your search
@@ -1,45 +1,25 @@
|
||||
This is an active Github mirror of the WebGPU native implementation in Rust, which now lives in [Mozilla-central](https://hg.mozilla.org/mozilla-central). Issues and pull requests are accepted, but we merge them in m-c manually and then sync to Github instead of landing directly here.
|
||||
|
||||
---
|
||||
# WebGPU
|
||||
[](https://travis-ci.org/gfx-rs/wgpu)
|
||||
[](https://crates.io/crates/wgpu)
|
||||
[](https://crates.io/crates/wgpu-native)
|
||||
[](https://gitter.im/gfx-rs/webgpu)
|
||||
|
||||
This is an experimental [WebGPU](https://www.w3.org/community/gpu/) implementation as a native static library. It's written in Rust and is based on [gfx-hal](https://github.com/gfx-rs/gfx) and [satellite](https://github.com/gfx-rs/gfx-memory) libraries. The corresponding WebIDL specification can be found at [gpuweb project](https://github.com/gpuweb/gpuweb/blob/master/spec/index.bs).
|
||||
This is an experimental [WebGPU](https://www.w3.org/community/gpu/) implementation as a native static library. It's written in Rust and is based on [gfx-hal](https://github.com/gfx-rs/gfx) and [Rendy](https://github.com/amethyst/rendy) libraries. The corresponding WebIDL specification can be found at [gpuweb project](https://github.com/gpuweb/gpuweb/blob/master/spec/index.bs).
|
||||
|
||||
The implementation consists of the following parts:
|
||||
- `wgpu-native` - the native implementation of WebGPU as a C API library
|
||||
- `wgpu-remote` - remoting layer to work with WebGPU across the process boundary
|
||||
- `wgpu-rs` - idiomatic Rust wrapper of the native library
|
||||
1. `wgpu-native` - the native implementation of WebGPU as a C API library
|
||||
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
|
||||
|
||||
## Examples
|
||||
## Usage
|
||||
|
||||
 
|
||||
This repository contains C-language examples that link to the native library targets and perform basic rendering and computation. You can test them with `make`.
|
||||
|
||||
To run an example, simply `cd` to the `examples` or `gfx-examples` directory, then use `cargo run` with `--features {backend}` to specify the backend (where `{backend}` is either `vulkan`, `dx12`, `dx11` or `metal`). For example:
|
||||
|
||||
```bash
|
||||
# Clone the wgpu repository
|
||||
git clone https://github.com/gfx-rs/wgpu
|
||||
# Change directory to `examples`
|
||||
cd wgpu/examples
|
||||
# Vulkan (Linux/Windows)
|
||||
cargo run --bin hello_triangle --features vulkan
|
||||
# Metal (macOS/iOS)
|
||||
cargo run --bin hello_triangle --features metal
|
||||
# DirectX12 (Windows)
|
||||
cargo run --bin hello_triangle --features dx12
|
||||
|
||||
cd ../gfx-examples
|
||||
# Vulkan (Linux/Windows)
|
||||
cargo run --bin cube --features vulkan
|
||||
# Metal (macOS/iOS)
|
||||
cargo run --bin cube --features metal
|
||||
# DirectX12 (Windows)
|
||||
cargo run --bin cube --features dx12
|
||||
```
|
||||
|
||||
These examples assume that necessary dependencies for the graphics backend are already installed. For more information about installation and usage, refer to the [Getting Started](https://github.com/gfx-rs/gfx/blob/master/info/getting_started.md) gfx-rs guide.
|
||||
The idiomatic Rust wrapper lives in https://github.com/gfx-rs/wgpu-rs and provides a number of more complex examples to get a feel of the API.
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 27 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 30 KiB |
@@ -1,19 +0,0 @@
|
||||
lunarg_core_validation.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG
|
||||
lunarg_core_validation.report_flags = error,warn,perf
|
||||
lunarg_core_validation.log_filename = stdout
|
||||
|
||||
lunarg_object_tracker.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG
|
||||
lunarg_object_tracker.report_flags = error,warn,perf
|
||||
lunarg_object_tracker.log_filename = stdout
|
||||
|
||||
lunarg_parameter_validation.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG
|
||||
lunarg_parameter_validation.report_flags = error,warn,perf
|
||||
lunarg_parameter_validation.log_filename = stdout
|
||||
|
||||
google_threading.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG
|
||||
google_threading.report_flags = error,warn,perf
|
||||
google_threading.log_filename = stdout
|
||||
|
||||
google_unique_objects.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG
|
||||
google_unique_objects.report_flags = error,warn,perf
|
||||
google_unique_objects.log_filename = stdout
|
||||
Reference in new issue
Block a user