Rhyoea is a Vulkan API bindings for Rust programming language.

This repository contains common code across Rhyoea modules.

Offline documentation:

cargo doc

Online documentation

lib.rs:

Rhyoea is a Vulkan API bindings for Rust programming language

Vulkan is a low-overhead, cross-platform 3D graphics and computing API. Vulkan targets high-performance realtime 3D graphics applications such as video games and interactive media across all platforms. Compared to OpenGL and Direct3D 11, and like Direct3D 12 and Metal, Vulkan is intended to offer higher performance and more balanced CPU/GPU usage.

Environnement

This section itemize how to prepare the developement environnement

Rhyoea use the nightly rust version, with many components. You should install it by RustUp

$ curl https://sh.rustup.rs -sSf | sh
$ rustup install nightly

How to use the library

Add this in your Cargo.toml:

[dependencies]
rhyoea-common = "^0"

Developpement

$ git clone --recurse-submodules git@gitlab.com:ametha/rhyoea-common.git
$ cd rhyoea-common
$ rustup override set nightly # Set the nightly rust version
$ cargo test # Run tests

New features

The implementation of a new feature follows the steps:

1. Create an issue on Gitlab
2. The maintener project assign and tag the issue
3. Create the merge request
4. Pull the branch
5. Work on the branch
6. Push the branch
7. Send a notification to maintener project (@ajeser)
8. Merge the request