Skip to content

Commit

Permalink
[rs] Add readme and screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
kvark committed May 11, 2019
1 parent d8b3372 commit 2c1bdbd
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 0 deletions.
10 changes: 10 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
language: rust
sudo: false
os:
- linux
- osx
- windows

branches:
except:
- staging.tmp
21 changes: 21 additions & 0 deletions wgpu/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## 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)
[![Gitter](https://badges.gitter.im/gfx-rs/webgpu.svg)](https://gitter.im/gfx-rs/webgpu)

This is an idiomatic Rust wrapper over [wgpu-native](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.

## Gallery

![Cube](etc/example-cube.png) ![Shadow](etc/example-shadow.png)
![vange-rs](etc/vange-rs.png) ![Brawl](etc/brawl-attack.gif)

## Usage

The library requires one of the following features enabled in order to run any of the examples:
- "vulkan"
- "metal"
- "dx12"
- "dx11"

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.
Binary file added wgpu/etc/brawl-attack.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added wgpu/etc/example-cube.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added wgpu/etc/example-shadow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added wgpu/etc/vange-rs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2c1bdbd

Please sign in to comment.