Comparison to other well-known Graphics APIs in Rust ecosystem.
Please note that by the current date none of the known projects in the ecosystem(including Vulkano)
reached stable release versions and the final design goals, their APIs are changing from time
to time in a breakable way too, and there could be bugs and unfinished features too.
However, most of the projects mentioned above are already established definitive structures, all
feature breaking changes will likely be straightforward to fix in user code, and most of them
are maintained. As such we can recommend using any of them in the 3rd party code.
The choice depends on the end project's goals and requirements, and we recommend examining
their actual set of features and API capabilities beforehand.
We started collecting this list just recently and it would be appreciated if you help us by
contributing(opening a PR) into [README.md](https://github.com/vulkano-rs/vulkano/blob/master/README.md).
We would love to help you keep your project in sync with the most recent changes in Vulkano
if you give us feedback by adding your project to this list.
Thanks in advance!
To get started you are encouraged to use the following resources:
- - - - -
Contributions are very welcome! Feel free to submit pull requests, to open questions and topics
in the [Issues](https://github.com/vulkano-rs/vulkano/issues) section.
The project was initially developed by Pierre Krieger(Tomaka), who established Vulkano's base
design goals, and the code structure. In the meantime, development is driven by Vulkano
**New Pull Requests are usually scheduled for review by the end of each week.**
The older PRs that are already in review have priority over the new ones. We are trying to push
development forward as quick as possible, but the review process sometimes takes time,
please be patient as the maintainers need time to check everything properly.
If something needs to get promoted urgently, please ping current Vulkano
maintainer([@Eliah-Lakhin](https://github.com/Eliah-Lakhin/)) in the PR's
or Issue's comments.
If your change adds, removes or modifies a trait or a function, please
specify changelog entries **in the Pull Request description**(not in the changelog file directly).
They will be transferred to the changelog right after the PR merge.
Every PR must pass tests in order to be merged to `master`.
Minor releases are usually happening between 1 to 3 months averagely depending on grow
of unreleased and breaking changes in `master`
This repository contains four libraries:
- ---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.
We would love to mention some members, who put significant contributions to this project:
Vulkano uses [shaderc-rs](https://github.com/google/shaderc-rs) for shader compilation. Refer to shaderc-rs documentation to provide a pre-built libshaderc for faster build times.
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.
Unless you provide libshaderc, in order to build libshaderc with the shaderc-sys crate, the following tools must be installed and available on `PATH`:
These requirements can be either installed with your favourite package manager or with installers
from the projects' websites. Below are some examples of ways to set up.
windows-gnu toolchain is not supported but you can instead cross-compile to windows-gnu from windows-msvc
Steps 1 and 2 are to workaround https://github.com/rust-lang/rust/issues/49078 by using the same mingw that rust uses.
Use your package manager to install the required dev-tools and Vulkan drivers
For example on ubuntu:
sudo apt-get install build-essential git python cmake libvulkan-dev vulkan-utils
On arch based system
sudo pacman -Sy base-devel git python cmake vulkan-devel --noconfirm
Vulkan is not natively supported by macOS and iOS. However, there exists [MoltenVK](https://github.com/KhronosGroup/MoltenVK)
an open-source 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 with MoltenVK is to install the
[Vulkan SDK for macOS](https://vulkan.lunarg.com/sdk/home). There are [installation instructions](https://vulkan.lunarg.com/doc/sdk/latest/mac/getting_started.html) on the LunarG website.
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.
Licensed under either of
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.
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.
What does vulkano do?