mirror of
https://github.com/gfx-rs/wgpu.git
synced 2024-11-27 01:03:41 +00:00
[rs] Update readme
This commit is contained in:
parent
e09b8d58a7
commit
39072c80d4
@ -1,10 +1,15 @@
|
||||
## wgpu-rs
|
||||
<img align="right" width="25%" src="logo.png">
|
||||
|
||||
# wgpu-rs
|
||||
|
||||
[![Build Status](https://travis-ci.org/gfx-rs/wgpu-rs.svg)](https://travis-ci.org/gfx-rs/wgpu-rs)
|
||||
[![Crates.io](https://img.shields.io/crates/v/wgpu.svg)](https://crates.io/crates/wgpu)
|
||||
[![Docs.rs](https://docs.rs/wgpu/badge.svg)](https://docs.rs/wgpu)
|
||||
[![Matrix](https://img.shields.io/matrix/wgpu:matrix.org)](https://matrix.to/#/#wgpu:matrix.org)
|
||||
|
||||
This is an idiomatic Rust wrapper over [wgpu-core](https://github.com/gfx-rs/wgpu). It's designed to be suitable for general purpose graphics and computation needs of Rust community. It currently only works for the native platform, in the future aims to support WASM/Emscripten platforms as well.
|
||||
wgpu-rs is an idiomatic Rust wrapper over [wgpu-core](https://github.com/gfx-rs/wgpu). It's designed to be suitable for general purpose graphics and computation needs of Rust community.
|
||||
|
||||
Currently wgpu-rs works on native platforms, but [WASM support is currently being added](https://github.com/gfx-rs/wgpu-rs/issues/101) as well.
|
||||
|
||||
## Gallery
|
||||
|
||||
@ -13,46 +18,48 @@ This is an idiomatic Rust wrapper over [wgpu-core](https://github.com/gfx-rs/wgp
|
||||
|
||||
## Usage
|
||||
|
||||
### Running an example
|
||||
All examples are located under the [examples](examples) directory. We are using the default syntax for running examples, as found in the [Cargo](https://doc.rust-lang.org/cargo/reference/manifest.html#examples) documentation.
|
||||
### How to Run Examples
|
||||
|
||||
All examples are located under the [examples](examples) directory.
|
||||
|
||||
These examples use the default syntax for running examples, as found in the [Cargo](https://doc.rust-lang.org/cargo/reference/manifest.html#examples) documentation. For example, to run the `cube` example:
|
||||
|
||||
```bash
|
||||
cargo run --example cube
|
||||
```
|
||||
|
||||
#### Hello Compute
|
||||
The `hello-triangle` and `hello-compute` examples show bare-bones setup without any helper code. For `hello-compute`, pass 4 numbers separated by spaces as arguments:
|
||||
|
||||
`hello-*` examples show barebones setup without any helper code.
|
||||
|
||||
For "hello-compute", pass 4 numbers separated by spaces as arguments:
|
||||
```bash
|
||||
cargo run --example hello-compute 1 2 3 4
|
||||
```
|
||||
|
||||
More examples can be found under the [examples](examples) directory.
|
||||
|
||||
## Friends
|
||||
|
||||
Shout out to the following projects that work best with wgpu-rs:
|
||||
- [wgpu_glyph](https://github.com/hecrj/wgpu_glyph) - for your text-y rendering needs
|
||||
- [coffee](https://github.com/hecrj/coffee) - a whole 2D engine
|
||||
- [iced](https://github.com/hecrj/iced) - a cross-platform GUI library
|
||||
- [rgx](https://github.com/cloudhead/rgx) - a 2D graphics library
|
||||
- [imgui-wgpu](https://github.com/Yatekii/imgui-wgpu-rs) - Dear ImGui interfacing
|
||||
- [pixels](https://github.com/parasyte/pixels) - the easiest way to create a hardware-accelerated pixel frame buffer
|
||||
- [kas](https://github.com/dhardy/kas) - tooKit Abstraction System
|
||||
- [oxiditor](https://github.com/Ruddle/oxidator) - RTS game engine
|
||||
|
||||
- [wgpu_glyph](https://github.com/hecrj/wgpu_glyph) - for your text-y rendering needs
|
||||
- [coffee](https://github.com/hecrj/coffee) - a whole 2D engine
|
||||
- [iced](https://github.com/hecrj/iced) - a cross-platform GUI library
|
||||
- [rgx](https://github.com/cloudhead/rgx) - a 2D graphics library
|
||||
- [imgui-wgpu](https://github.com/Yatekii/imgui-wgpu-rs) - Dear ImGui interfacing
|
||||
- [pixels](https://github.com/parasyte/pixels) - the easiest way to create a hardware-accelerated pixel frame buffer
|
||||
- [kas](https://github.com/dhardy/kas) - tooKit Abstraction System
|
||||
- [oxiditor](https://github.com/Ruddle/oxidator) - RTS game engine
|
||||
|
||||
Also, libraries that have support for wgpu-rs:
|
||||
- [conrod](https://github.com/PistonDevelopers/conrod) - shader-based UI
|
||||
- [lyon](https://github.com/nical/lyon) - a path tessellation library
|
||||
|
||||
- [conrod](https://github.com/PistonDevelopers/conrod) - shader-based UI
|
||||
- [lyon](https://github.com/nical/lyon) - a path tessellation library
|
||||
|
||||
## Development
|
||||
|
||||
If you need to test local fixes to gfx-rs or other dependencies, the simplest way is to add a Cargo patch. For example, when working on DX12 backend on Windows, you can check out the "hal-0.2" branch of gfx-rs repo and add this to the end of "Cargo.toml":
|
||||
|
||||
```toml
|
||||
[patch.crates-io]
|
||||
gfx-backend-dx12 = { path = "../gfx/src/backend/dx12" }
|
||||
gfx-hal = { path = "../gfx/src/hal" }
|
||||
```
|
||||
|
||||
If a version needs to be changed, you need to to do `cargo update -p gfx-backend-dx12`.
|
||||
|
BIN
wgpu/logo.png
Normal file
BIN
wgpu/logo.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 37 KiB |
Loading…
Reference in New Issue
Block a user