23 breaking releases
0.25.0 | Aug 23, 2024 |
---|---|
0.24.0 | Jul 20, 2024 |
0.23.0 | Mar 29, 2024 |
0.22.0 | Sep 15, 2023 |
0.2.3 | Nov 24, 2020 |
#617 in Graphics APIs
303 downloads per month
Used in 4 crates
(2 directly)
2MB
48K
SLoC
vulkanalia
Vulkan bindings for Rust.
Released under the Apache License 2.0.
Heavily inspired by the ash
crate.
Vulkan Tutorial
For users new to Vulkan, there is a complete adaptation of https://vulkan-tutorial.com by Alexander Overvoorde to use Rust and vulkanalia
instead of C++. The published version of this tutorial can be found here and the sources for the tutorial (including standalone working code examples for each chapter) are in this repository in the tutorial
directory.
Overview
vulkanalia-sys
consists of the Vulkan types and command signatures generated from the Vulkan API Registry. If you want to use the raw Vulkan API and are willing to handle function loading yourself you can use this crate.
vulkanalia
offers a fairly thin wrapper around vulkanalia-sys
that handles function loading for you and makes the Vulkan API somewhat less error prone and more idiomatic to use from Rust. For a detailed overview of how vulkanalia
wraps the Vulkan API, see the API Concepts
section of the Overview
chapter of the Vulkan tutorial which can be found here.
Cargo Features
The vulkanalia
crate has the following notable non-default Cargo features:
libloading
(non-default) – enables integration withlibloading
(adds theLibloadingLoader
struct which can be used to load the initial Vulkan commands from a Vulkan shared library)window
(non-default) – enables integration withraw-window-handle
(adds thewindow
module which can be used to create surfaces for windows from libraries that supportraw-window-handle
(e.g.,winit
)provisional
(non-default) – enables access to provisional Vulkan extensions (WARNING: these extensions are not guaranteed to be backwards compatible and are not intended to be used in production applications)
By default, the vulkanalia-sys
and vulkanalia
crates depend on the Rust standard library. However, by disabling the default features for these crates, you can use either of these crates in a no_std
environment. If you do this, the following features are of note:
no_std_error
(non-default): enables implementations of theError
trait for various error types invulkanalia
andvulkanalia-sys
when the defaultstd
feature is not enabled (the usage of theError
trait incore
is not yet stable and requires thecore-error
feature to be enabled)
Example
See the examples
directory for an implementation of the classic triangle example using vulkanalia
.