5ddcce24c6
It was recently discovered in rust-lang/rust#50781 that `Self: Trait` bounds in trait methods are really not object-safe. This will be made into a warning by rust-lang/rust#50966, and vulkano will be affected by the warning . Thankfully the fix looks simple, by just moving `fn len` from `BufferAccess` to being directly in `TypedBufferAccess`. |
||
|---|---|---|
| examples | ||
| glsl-to-spirv | ||
| vk-sys | ||
| vulkano | ||
| vulkano-shader-derive | ||
| vulkano-shaders | ||
| vulkano-win | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| .gitmodules | ||
| .rustfmt.toml | ||
| .travis.yml | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| DESIGN.md | ||
| LICENSE-APACHE | ||
| LICENSE-MIT | ||
| logo.png | ||
| README.md | ||
| TROUBLES.md | ||
Vulkano
See also vulkano.rs.
Vulkano is a Rust wrapper around the Vulkan graphics API. 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.
What does vulkano do?
- Provides a low-levelish API around Vulkan. It doesn't hide what it does, but provides some comfort types.
- Plans to prevent all invalid API usages, even the most obscure ones. The purpose of vulkano is not to simply let you draw a teapot, but to cover all possible usages of Vulkan and detect all the possible problems in order to write robust programs. Invalid API usage is prevented thanks to both compile-time checks and runtime checks.
- Can handle synchronization on the GPU side for you (unless you choose do that yourself), 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.
Note that in general vulkano does not require you to install the official Vulkan SDK. This is not something specific to vulkano (you don't need the SDK to write programs that use Vulkan, even without vulkano), but many people are unaware of that and install the SDK thinking that it is required. However, macOS and iOS platforms do require a little more Vulkan setup since it is not natively supported. See below for more details.
Development status
Vulkano is still in heavy development and doesn't yet meet its goals of being very robust. However the general structure of the library is most likely definitive, and all future breaking changes will likely be straight-forward to fix in user code.
Documentation
To get started you are encouraged to read the examples in
the vulkano-examples repository, starting with
the triangle example.
macOS and iOS Setup
Vulkan is not natively supported by macOS and iOS. However, there exists MoltenVK a Vulkan implementation on top of Apple's Metal API. This allows vulkano to build and run on macOS and iOS platforms.
The easiest way to get vulkano up and running on macOS is to install the
Vulkan SDK for macOS. Vulkano will by default, as it does on
other platforms, look for libvulkan.1.dylib (included as part of the SDK). Note that it is still
possible to link with the MoltenVK framework (as vulkano did in previous versions) by adding the
appropriate cargo output lines to your build script and implementing your own
vulkano::instance::loader::Loader that calls the MoltenVK vkGetInstanceProcAddr implementation.
On iOS vulkano links directly to the MoltenVK framework. There is nothing else to do besides installing it. Note that the Vulkan SDK for macOS also comes with the iOS framework.
Donate
Contributing
Contributions are welcome! Feel free to submit pull requests.
Pull requests that fix bugs or improve documentation are likely to be quickly reviewed, while pull requests that add features or change the API may be more controversial and take more time.
If your change adds, removes or modifies a trait or a function, please add an entry to the
CHANGELOG.md file as part of your pull request.
Structure
This repository contains six libraries:
vulkanois the main one.vulkano-shaderscan analyse SPIR-V shaders at compile-time.vulkano-shader-deriveprovides a custom derive that invokesvulkano-shaders. It lets you easily integrate your GLSL shaders within the rest of your source code.vulkano-winprovides a safe link between vulkano and thewinitlibrary which can create a window to render to.glsl-to-spirvcan compile GLSL to SPIR-V by wrapping aroundglslang.glsl-to-spirvis an implementation detail that you don't need to use manually if you use vulkano.vk-syscontains raw bindings for Vulkan. You can use it even if you don't care about vulkano.
Once procedural macros are stabilized in Rust, the vulkano-shaders and vulkano-shader-derive
crates will be merged with the vulkano crate. The glsl-to-spirv crate is an implementation
detail of vulkano and is not supposed to be used directly if you use vulkano. You are, however,
free to use it if you want to write an alternative to vulkano.
In order to run tests, run cargo test --all at the root of the repository. Make sure your Vulkan
driver is up to date before doing so.
License
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (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.