2016-02-18 08:33:06 +00:00
|
|
|
# Vulkano
|
|
|
|
|
|
2016-05-30 07:47:49 +00:00
|
|
|
**Note: requires Rust 1.9**. This library would highly benefit from multiple upcoming features in
|
2016-04-28 16:17:31 +00:00
|
|
|
Rust. Therefore it is likely that in the future you will need to update your version of Rust to
|
|
|
|
|
continue using vulkano.
|
2016-04-08 19:33:52 +00:00
|
|
|
|
2016-03-11 13:43:01 +00:00
|
|
|
Vulkano is a Rust wrapper around [the Vulkan graphics API](https://www.khronos.org/vulkan/).
|
|
|
|
|
It follows the Rust philosophy, which is that as long as you don't use unsafe code you shouldn't
|
|
|
|
|
be able to trigger any undefined behavior. In the case of Vulkan, this means that non-unsafe code
|
|
|
|
|
should always conform to valid API usage.
|
|
|
|
|
|
2016-04-12 16:38:21 +00:00
|
|
|
What does vulkano do?
|
|
|
|
|
|
|
|
|
|
- Provides a low-levelish API around Vulkan. It doesn't hide what it does, but provides some
|
2016-05-08 13:43:02 +00:00
|
|
|
comfort types.
|
2016-04-12 16:38:21 +00:00
|
|
|
- Plans to prevents all invalid API usages, even the most obscure ones. The purpose of vulkano
|
|
|
|
|
is not to draw a teapot, but to cover all possible usages of Vulkan and detect all the
|
|
|
|
|
possible problems. Invalid API usage is prevented thanks to both compile-time checks and
|
|
|
|
|
runtime checks.
|
|
|
|
|
- Handles synchronization on the GPU side for you, as this aspect of Vulkan is both annoying
|
|
|
|
|
to handle and error-prone. Dependencies between submissions are automatically detected, and
|
|
|
|
|
semaphores are managed automatically. The behavior of the library can be customized thanks
|
|
|
|
|
to unsafe trait implementations.
|
|
|
|
|
- Tries to be convenient to use. Nobody is going to use a library that requires you to browse
|
|
|
|
|
the documentation for hours for every single operation.
|
2016-03-11 13:43:01 +00:00
|
|
|
|
2016-03-28 13:40:13 +00:00
|
|
|
**Warning: this library breaks every five minutes for the moment.**
|
2016-02-20 12:05:44 +00:00
|
|
|
|
2016-09-01 12:41:29 +00:00
|
|
|
## [Documentation](https://docs.rs/vulkano)
|
|
|
|
|
|
|
|
|
|
[](https://docs.rs/vulkano)
|
2016-03-09 14:51:10 +00:00
|
|
|
|
2016-04-29 08:28:20 +00:00
|
|
|
To get started you are encouraged to read the examples in `examples/src/bin`, starting with
|
|
|
|
|
the `triangle` example.
|
|
|
|
|
|
2016-04-30 11:56:12 +00:00
|
|
|
## Structure
|
2016-02-19 16:36:45 +00:00
|
|
|
|
2016-04-28 16:18:48 +00:00
|
|
|
This repository contains four libraries:
|
2016-02-18 08:33:06 +00:00
|
|
|
|
|
|
|
|
- `vulkano` is the main one.
|
|
|
|
|
- `vulkano-shaders` can analyse SPIR-V shaders at compile-time.
|
2016-04-28 16:18:48 +00:00
|
|
|
- `vulkano-win` provides a safe link between vulkano and the `winit` library which can create
|
|
|
|
|
a window where to render to.
|
2016-04-12 16:38:21 +00:00
|
|
|
- `glsl-to-spirv` can compile GLSL to SPIR-V by wrapping around `glslang`.
|
2016-03-26 09:17:37 +00:00
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
Licensed under either of
|
|
|
|
|
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
|
|
|
|
|
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
|
|
|
|
|
at your option.
|
|
|
|
|
|
|
|
|
|
### Contribution
|
|
|
|
|
|
|
|
|
|
Unless you explicitly state otherwise, any contribution intentionally submitted
|
|
|
|
|
for inclusion in the work by you shall be dual licensed as above, without any
|
|
|
|
|
additional terms or conditions.
|
