wgpu/README.md

<img align="right" width="25%" src="logo.png">

This is an active GitHub mirror of the WebGPU implementation in Rust, which now lives in "gfx/wgpu" of [Mozilla-central](https://hg.mozilla.org/mozilla-central/file/tip/gfx/wgpu). Issues and pull requests are accepted, but some bidirectional synchronization may be involved.

# WebGPU

[![Matrix](https://img.shields.io/badge/Matrix-%23wgpu%3Amatrix.org-blueviolet.svg)](https://matrix.to/#/#wgpu:matrix.org)
[![Build Status](https://travis-ci.org/gfx-rs/wgpu.svg?branch=master)](https://travis-ci.org/gfx-rs/wgpu)
[![Crates.io](https://img.shields.io/crates/v/wgpu-core.svg?label=wgpu-core)](https://crates.io/crates/wgpu-core)
[![Crates.io](https://img.shields.io/crates/v/wgpu-native.svg?label=wgpu-native)](https://crates.io/crates/wgpu-native)

This is the core logic of an experimental [WebGPU](https://www.w3.org/community/gpu/) implementation. It's written in Rust and is based on [gfx-hal](https://github.com/gfx-rs/gfx) with help of [gfx-extras](https://github.com/gfx-rs/gfx-extras). See the upstream [WebGPU specification](https://gpuweb.github.io/gpuweb/) (work in progress).

The implementation consists of the following parts:

  - `wgpu-core` - internal Rust API for WebGPU implementations to use
  - `wgpu-types` - Rust types shared between `wgpu-core`, `wgpu-native`, and `wgpu-rs`

This repository is not meant for direct use by applications.
If you are looking for the user-facing Rust API, you need [wgpu-rs](https://github.com/gfx-rs/wgpu-rs).
If you are looking for the native implementation or bindings to the API in other languages, you need [wgpu-native](https://github.com/gfx-rs/wgpu-native).

## Supported Platforms

   API   |       Windows      |       Linux        |    macOS & iOS     |
  -----  | ------------------ | ------------------ | ------------------ |
  DX11   | :white_check_mark: |                    |                    |
  DX12   | :heavy_check_mark: |                    |                    |
  Vulkan | :heavy_check_mark: | :heavy_check_mark: |                    |
  Metal  |                    |                    | :heavy_check_mark: |
  OpenGL | :construction:     | :construction:     | :construction:     |
  
:heavy_check_mark: = Primary support — :white_check_mark: = Secondary support — :construction: = Unsupported, but support in progress
Readme update with a new logo 2020-01-24 15:21:59 +00:00			`<img align="right" width="25%" src="logo.png">`

			`This is an active GitHub mirror of the WebGPU implementation in Rust, which now lives in "gfx/wgpu" of [Mozilla-central](https://hg.mozilla.org/mozilla-central/file/tip/gfx/wgpu). Issues and pull requests are accepted, but some bidirectional synchronization may be involved.`
Readme update 2019-05-10 20:22:22 +00:00
Restructure the repo to host multiple crates 2018-09-19 01:14:04 +00:00			`# WebGPU`
Update logo and move bindings section 2020-03-03 03:40:04 +00:00
Readme update with a new logo 2020-01-24 15:21:59 +00:00			`[![Matrix](https://img.shields.io/badge/Matrix-%23wgpu%3Amatrix.org-blueviolet.svg)](https://matrix.to/#/#wgpu:matrix.org)`
			`[![Build Status](https://travis-ci.org/gfx-rs/wgpu.svg?branch=master)](https://travis-ci.org/gfx-rs/wgpu)`
			`[![Crates.io](https://img.shields.io/crates/v/wgpu-core.svg?label=wgpu-core)](https://crates.io/crates/wgpu-core)`
Readme update 2019-05-10 20:22:22 +00:00			`[![Crates.io](https://img.shields.io/crates/v/wgpu-native.svg?label=wgpu-native)](https://crates.io/crates/wgpu-native)`
Simple README 2018-09-14 13:23:15 +00:00
Remove wgpu-native and wgpu-remote 2020-04-17 02:35:59 +00:00			`This is the core logic of an experimental [WebGPU](https://www.w3.org/community/gpu/) implementation. It's written in Rust and is based on [gfx-hal](https://github.com/gfx-rs/gfx) with help of [gfx-extras](https://github.com/gfx-rs/gfx-extras). See the upstream [WebGPU specification](https://gpuweb.github.io/gpuweb/) (work in progress).`
Readme update with fixed links and components description 2018-09-26 14:54:26 +00:00
			`The implementation consists of the following parts:`
Update logo and move bindings section 2020-03-03 03:40:04 +00:00
Remove wgpu-native and wgpu-remote 2020-04-17 02:35:59 +00:00			- `wgpu-core` - internal Rust API for WebGPU implementations to use
			- `wgpu-types` - Rust types shared between `wgpu-core`, `wgpu-native`, and `wgpu-rs`
Document how to run examples 2019-02-06 11:32:39 +00:00
Remove wgpu-native and wgpu-remote 2020-04-17 02:35:59 +00:00			`This repository is not meant for direct use by applications.`
			`If you are looking for the user-facing Rust API, you need [wgpu-rs](https://github.com/gfx-rs/wgpu-rs).`
			`If you are looking for the native implementation or bindings to the API in other languages, you need [wgpu-native](https://github.com/gfx-rs/wgpu-native).`
Update logo and move bindings section 2020-03-03 03:40:04 +00:00
update README.md 2019-07-29 21:27:30 +00:00			`## Supported Platforms`
add framework files 2019-07-27 10:54:31 +00:00
update README.md 2019-07-29 21:27:30 +00:00			`API \| Windows \| Linux \| macOS & iOS \|`
			`----- \| ------------------ \| ------------------ \| ------------------ \|`
Readme update with a new logo 2020-01-24 15:21:59 +00:00			`DX11 \| :white_check_mark: \| \| \|`
update README.md 2019-07-29 21:27:30 +00:00			`DX12 \| :heavy_check_mark: \| \| \|`
			`Vulkan \| :heavy_check_mark: \| :heavy_check_mark: \| \|`
			`Metal \| \| \| :heavy_check_mark: \|`
Readme update with a new logo 2020-01-24 15:21:59 +00:00			`OpenGL \| :construction: \| :construction: \| :construction: \|`
Update Support Platforms table to have a key 2020-03-26 06:06:29 +00:00
			`:heavy_check_mark: = Primary support — :white_check_mark: = Secondary support — :construction: = Unsupported, but support in progress`