Getting Started

Table of Contents:

• Prerequisites
  • Setting up the nightly toolchain
• Generating Rust glue
• Generating static library
• Running an example
  • Triangle
  • Compute
  • Remote

Prerequisites

Before getting started with wgpu, there are some necessary components that have to be installed and configured.

To build wgpu-native:

• Rust compiler
• (Windows only) Updated Windows SDK

To build native examples:

• C compiler which matches the Rust target (e.g. MSVC, Clang, or GCC)
• GLFW 3
• (Windows only) MSBuild

To ensure the examples run correctly, it's also useful to ensure drivers for any installed graphics APIs (e.g. Vulkan, DirectX 12, etc.) are up-to-date.

Generating Rust glue

TODO

Generating static library

Rust code can be compiled separately into a static library.

In the Makefile, the static library commands are prefixed by lib-.

To generate the wgpu static library, use the following command:

make lib-native

To generate the wgpu remote static library, use the following command:

make lib-remote

The static libraries will be located in the target folder in the root of the project.

Running an example

The examples are located under the examples directory. We are using a Makefile for running the examples.

In the Makefile, the example commands are prefixed by example-.

Triangle

To generate the Triangle example, use the following command:

make run-example-triangle

Compute

To generate the Compute example, use the following command:

make run-example-compute