1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
#![doc(html_logo_url = "https://gitlab.com/Friz64/erupt/-/raw/master/logo.png")] //! Vulkan API bindings //! //! ## Features //! - Full Vulkan API coverage //! - First-class support for all extensions //! - High quality auto-generated function wrappers //! - A [utility module] aiding your use of this crate //! - [`VulkanResult`]: Idiomatic wrapper around a Vulkan Result //! - [`surface`]: Create a [`SurfaceKHR`] using a [`RawWindowHandle`] (adapted from [`ash-window`]) //! - [`allocator`]: Provides a basic Vulkan memory allocator, aiming to be *correct* //! - Generated code distributed into multiple modules //! - Function loading ([`EntryLoader`], [`InstanceLoader`], [`DeviceLoader`]) //! - Seperate `Flags` and `FlagBits` types //! - A high level `Builder` for every struct //! - Type-safe pointer chain support //! - `Default` and `Debug` implementation for every type //! - Confirmed support for Linux, Windows, macOS and Android //! - Complete auto-generation of everything except [`utils`] //! //! ## Example: Instance Creation //! ```rust ignore //! use erupt::{vk1_0, EntryLoader, InstanceLoader}; //! //! let entry = EntryLoader::new()?; //! //! let app_info = vk1_0::ApplicationInfoBuilder::new().api_version(vk1_0::make_version(1, 0, 0)); //! let instance_info = vk1_0::InstanceCreateInfoBuilder::new().application_info(&app_info); //! //! let instance = InstanceLoader::new(&entry, &instance_info, None)?; //! //! // ... //! //! instance.destroy_instance(None); //! ``` //! //! ## Additional examples //! - [triangle](https://gitlab.com/Friz64/erupt/-/blob/master/erupt_examples/src/bin/triangle.rs) //! - [pointer-chain](https://gitlab.com/Friz64/erupt/-/blob/master/erupt_examples/src/bin/pointer_chain.rs) //! - [version](https://gitlab.com/Friz64/erupt/-/blob/master/erupt_examples/src/bin/version.rs) //! - [compute](https://gitlab.com/Friz64/erupt/-/blob/master/erupt_examples/src/bin/compute.rs) //! //! ## Cargo Features //! - `surface` (enabled by default): Enables the [`surface`] module, adds [`raw-window-handle`] dependency //! - `loading` (enabled by default): Enables the [`EntryLoader::new`] function, adds [`libloading`] dependency //! //! ## FAQ //! ### Q: What's the difference between this, ash and vulkano? //! A: Vulkano is special because it provides hand-written Vulkan wrappers, which means that for example //! it has a special hand-written wrapper around a Vulkan `PhysicalDevice`. On the other hand ash and //! erupt both provide Vulkan API bindings too, but not exposing such *fancy* wrappers and instead //! focusing on having good bindings to the *raw* Vulkan API. //! //! The big selling points of erupt is that it has better documentation, high level function support for //! all extensions (which is only really relevant if you use those extensions), being fully generated //! and some more smaller improvements. On the other hand ash has a bigger existing community. //! //! ### Q: What does the number at the end of the version mean? //! A: It represents the Vulkan Header version this version of erupt was generated against and is purely //! informational. //! //! ## Thank you //! - [`ash`](https://crates.io/crates/ash) for helping inspiring and making this crate //! - [`libloading`](https://crates.io/crates/libloading) for providing symbol loading //! - [`ash-window`](https://crates.io/crates/ash-window) for providing a base for the [`surface`] module //! - [`bitflags`](https://crates.io/crates/bitflags) for providing a perfect bitflag macro //! - The Vulkan Community ❤️ //! - The Rust Community ❤️ //! //! ## Licensing //! //! The logo is the Volcano Emoji of [Twemoji](https://twemoji.twitter.com/) ([License](https://creativecommons.org/licenses/by/4.0/)). The name "erupt" was added on top of it. //! //! This project is licensed under the [zlib License](https://gitlab.com/Friz64/erupt/-/blob/master/LICENSE). //! //! [utility module]: https://docs.rs/erupt/*/erupt/utils/index.html //! [`VulkanResult`]: https://docs.rs/erupt/*/erupt/utils/struct.VulkanResult.html //! [`surface`]: https://docs.rs/erupt/*/erupt/utils/surface/index.html //! [`SurfaceKHR`]: https://docs.rs/erupt/*/erupt/extensions/khr_surface/struct.SurfaceKHR.html //! [`allocator`]: https://docs.rs/erupt/*/erupt/utils/allocator/index.html //! [`RawWindowHandle`]: https://docs.rs/raw-window-handle/*/raw_window_handle/enum.RawWindowHandle.html //! [`libloading`]: https://crates.io/crates/libloading //! [`raw-window-handle`]: https://crates.io/crates/raw-window-handle //! [`ash-window`]: https://crates.io/crates/ash-window //! [`EntryLoader`]: https://docs.rs/erupt/*/erupt/struct.EntryLoader.html //! [`EntryLoader::new`]: https://docs.rs/erupt/*/erupt/struct.EntryLoader.html#method.new //! [`InstanceLoader`]: https://docs.rs/erupt/*/erupt/struct.InstanceLoader.html //! [`DeviceLoader`]: https://docs.rs/erupt/*/erupt/struct.DeviceLoader.html //! [`utils`]: https://docs.rs/erupt/*/erupt/utils/index.html mod generated; pub mod utils; use fmt::Debug; pub use generated::*; use std::{ error::Error, ffi::CStr, fmt::{self, Display}, mem, ptr, }; pub use utils::loading::DefaultEntryLoader; /// Construct a `*const std::os::raw::c_char` from a string /// /// # Example /// ```ignore /// const LAYER_KHRONOS_VALIDATION: *const c_char = cstr!("VK_LAYER_KHRONOS_validation"); /// ``` #[macro_export] macro_rules! cstr { ($s:expr) => { concat!($s, "\0") as *const str as *const ::std::os::raw::c_char }; } /// Like `try!`, but for [`utils::VulkanResult`](utils/struct.VulkanResult.html) /// /// ```ignore /// unsafe fn example(device: &DeviceLoader) -> VulkanResult<(Semaphore, Semaphore)> { /// let create_info = SemaphoreCreateInfoBuilder::new(); /// /// let semaphore1 = try_vk!(device.create_semaphore(&create_info, None, None)); /// let semaphore2 = try_vk!(device.create_semaphore(&create_info, None, None)); /// VulkanResult::new_ok((semaphore1, semaphore2)) /// } /// ``` #[macro_export] macro_rules! try_vk { ($expr:expr) => { match $crate::utils::VulkanResult::result($expr) { Ok(value) => value, Err(raw) => return $crate::utils::VulkanResult::new_err(raw), } }; } // adapted from ash #[doc(hidden)] #[macro_export] macro_rules! non_dispatchable_handle { ($name:ident, $ty:ident, $doc:meta) => { #[$doc] #[repr(transparent)] #[derive(Eq, PartialEq, Ord, PartialOrd, Clone, Copy, Hash, Default)] pub struct $name(pub u64); impl $name { pub const TYPE: crate::vk1_0::ObjectType = crate::vk1_0::ObjectType::$ty; pub const fn null() -> $name { $name(0) } pub const fn is_null(&self) -> bool { self.0 == 0 } } impl std::fmt::Pointer for $name { fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { write!(f, "0x{:x}", self.0) } } impl std::fmt::Debug for $name { fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { write!(f, "0x{:x}", self.0) } } }; } // adapted from ash #[doc(hidden)] #[macro_export] macro_rules! dispatchable_handle { ($name:ident, $ty:ident, $doc:meta) => { #[$doc] #[repr(transparent)] #[derive(Eq, PartialEq, Ord, PartialOrd, Clone, Copy, Hash)] pub struct $name(pub *mut ()); impl $name { pub const TYPE: crate::vk1_0::ObjectType = crate::vk1_0::ObjectType::$ty; pub const fn null() -> Self { $name(std::ptr::null_mut()) } pub fn is_null(&self) -> bool { self.0.is_null() } } unsafe impl Send for $name {} unsafe impl Sync for $name {} impl Default for $name { fn default() -> $name { $name::null() } } impl std::fmt::Pointer for $name { fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { std::fmt::Pointer::fmt(&self.0, f) } } impl std::fmt::Debug for $name { fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { std::fmt::Debug::fmt(&self.0, f) } } }; } /// An error which can occur while initializing a loader #[derive(Debug)] pub enum LoaderError { /// A Vulkan function returned a negative `Result` value VulkanError(vk1_0::Result), /// A symbol was not available while it should have been SymbolNotAvailable, } impl Display for LoaderError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match self { LoaderError::VulkanError(err) => write!( f, "A Vulkan function returned a negative `Result` value: {}", err ), LoaderError::SymbolNotAvailable => { write!(f, "A symbol was not available while it should have been") } } } } impl Error for LoaderError {} impl<T> Debug for EntryLoader<T> { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "Entry") } } impl InstanceLoader { #[inline] pub fn new<T>( entry_loader: &EntryLoader<T>, create_info: &crate::vk1_0::InstanceCreateInfo, allocator: Option<&crate::vk1_0::AllocationCallbacks>, ) -> Result<InstanceLoader, LoaderError> { let instance = unsafe { entry_loader.create_instance(create_info, allocator, None) } .result() .map_err(LoaderError::VulkanError)?; let mut version = crate::vk1_0::make_version(1, 0, 0); if !create_info.p_application_info.is_null() { let user_version = unsafe { *create_info.p_application_info }.api_version; if user_version != 0 { version = user_version; } } unsafe { let symbol = |name| (entry_loader.get_instance_proc_addr)(instance, name); let enumerate_physical_devices: vk1_0::PFN_vkEnumeratePhysicalDevices = mem::transmute( symbol(crate::vk1_0::FN_ENUMERATE_PHYSICAL_DEVICES) .ok_or(crate::LoaderError::SymbolNotAvailable)?, ); let enumerate_device_extension_properties: vk1_0::PFN_vkEnumerateDeviceExtensionProperties = mem::transmute(symbol(crate::vk1_0::FN_ENUMERATE_DEVICE_EXTENSION_PROPERTIES) .ok_or(crate::LoaderError::SymbolNotAvailable)?); let mut physical_device_count = 0; let result = enumerate_physical_devices(instance, &mut physical_device_count, ptr::null_mut()); if result.0 < 0 { return Err(LoaderError::VulkanError(result)); } let mut physical_devices = vec![Default::default(); physical_device_count as usize]; let result = enumerate_physical_devices( instance, &mut physical_device_count, physical_devices.as_mut_ptr(), ); if result.0 < 0 { return Err(LoaderError::VulkanError(result)); } let mut all_device_extension_properties = Vec::new(); for physical_device in physical_devices { let mut property_count = 0; let result = enumerate_device_extension_properties( physical_device, ptr::null(), &mut property_count, ptr::null_mut(), ); if result.0 < 0 { return Err(LoaderError::VulkanError(result)); } let mut properties = vec![Default::default(); property_count as usize]; let result = enumerate_device_extension_properties( physical_device, ptr::null(), &mut property_count, properties.as_mut_ptr(), ); if result.0 < 0 { return Err(LoaderError::VulkanError(result)); } all_device_extension_properties.extend(properties.into_iter()); } let available_device_extensions: Vec<_> = all_device_extension_properties .iter() .map(|properties| CStr::from_ptr(properties.extension_name.as_ptr())) .collect(); let instance_enabled = InstanceEnabled::new( version, create_info.enabled_extension_count as usize, create_info.pp_enabled_extension_names, &available_device_extensions, )?; InstanceLoader::custom(entry_loader, instance, instance_enabled, symbol) } } } impl Debug for InstanceLoader { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { Debug::fmt(&self.handle, f) } } impl DeviceLoader { #[inline] pub fn new( instance_loader: &InstanceLoader, physical_device: crate::vk1_0::PhysicalDevice, create_info: &crate::vk1_0::DeviceCreateInfo, allocator: Option<&crate::vk1_0::AllocationCallbacks>, ) -> Result<DeviceLoader, LoaderError> { let device = unsafe { instance_loader.create_device(physical_device, create_info, allocator, None) } .result() .map_err(LoaderError::VulkanError)?; let device_enabled = unsafe { DeviceEnabled::new( create_info.enabled_extension_count as usize, create_info.pp_enabled_extension_names, ) }; unsafe { DeviceLoader::custom(instance_loader, device, device_enabled, |name| { (instance_loader.get_device_proc_addr)(device, name) }) } } } impl Debug for DeviceLoader { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { Debug::fmt(&self.handle, f) } } // Used by loaders to check for extensions #[inline] unsafe fn c_str_array_contains( array_length: usize, array: *const *const std::os::raw::c_char, contains: *const std::os::raw::c_char, ) -> bool { let contains = CStr::from_ptr(contains); for i in 0..array_length { if CStr::from_ptr(*array.add(i)) == contains { return true; } } false } /// Provides type-safe pointer chain support pub trait ExtendableFrom<'a, T> { /// Appends `other`'s pointer chain to the end of this pointer chain #[must_use] fn extend_from(mut self, other: &'a mut T) -> Self where Self: Sized, { unsafe { crate::append_ptr_chain(&mut self as *mut Self as _, other as *mut T as _); } self } } #[inline] unsafe fn append_ptr_chain( mut host: *mut vk1_0::BaseOutStructure, tail: *mut vk1_0::BaseOutStructure, ) { loop { let p_next = &mut (*host).p_next; if p_next.is_null() { *p_next = tail; break; } else { host = *p_next; } } }