README.md

wgpu-crystal

Bindings to gfx-rs/wgpu-native for the Crystal programming language.

Installation

1. Add the dependency to your shard.yml:

   dependencies:
     wgpu:
      github: chances/wgpu-crystal

2. Run shards install

Usage

require "wgpu"

# TODO: Write usage instructions here

See the API documentation.

See the wgpu-native Usage instructions.

Development

TODO: Write development instructions here

Running examples

Headless

make example-headless

Headless Triangle

make example-triangle

Windowed Triangle

TODO: Add a windowed example

Ensure glfw3 is installed.

make example-glfw-triangle

Alignment with wgpu-native Releases

Release tags' major and minor version numbers align with those of wgpu-native. For example, the 0.9.* tags align with one of the 0.9.* releases of wgpu-native. See ./native.lock.yml for the specific native library target.

Contributing

1. Fork it (https://github.com/chances/wgpu-crystal/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• Chance Snow - creator and maintainer