vulkano/README.md

37 lines
1.3 KiB
Markdown
Raw Normal View History

2016-02-18 08:33:06 +00:00
# Vulkano
2016-04-08 19:33:52 +00:00
**Note: requires Rust 1.8**
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.
Vulkano is *not* a high level library. It provides only the minimal features required to make
using the Vulkan API safe.
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-03-13 05:49:25 +00:00
## [Documentation](http://tomaka.github.io/vulkano/vulkano/index.html)
2016-03-09 14:51:10 +00:00
## [Differences between Vulkan and vulkano](FEATURES.md)
2016-02-18 08:33:06 +00:00
This repository contains three libraries:
- `vulkano` is the main one.
- `vulkano-shaders` can analyse SPIR-V shaders at compile-time.
- `glsl-to-spirv` can compile GLSL to SPIR-V.
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.