[−][src]Crate rhyoea
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.
Reading Suggestions
If you start under Rhyoea, you should read the examples. The instance module is the entry point.
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 = "^1"
Developpement
$ git clone git@framagit.org:ametha/aquaengine/rhyoea.git
$ cd rhyoea
$ rustup override set nightly # Set the nightly rust version
$ cargo test # Run tests
New features
The implementation of a new feature follows the steps:
- Create an issue on
FramaGit
- The maintener project assign and tag the issue
- Create the merge request
- Pull the branch
- Work on the branch
- Push the branch
- Send a notification to maintener project (@jeser)
- Merge the request
Modules
builder | TODO: Doc |
debug | Handle the messages from Vulkan |
extends | Extends Vulkan |
instance | The primary connection between your application and the Vulkan library. |
result | The result types |
Enums
VkStructureType | Structure types supported by the Vulkan API |