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
#![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 the Vulkan API //! - [`VulkanResult`]: Idiomatic wrapper around a Vulkan Result //! - [`surface`]: Create a [`SurfaceKHR`] using a [`RawWindowHandle`] (adapted from [`ash-window`]) //! - Generated code distributed into multiple modules //! - Function loading ([`CoreLoader`], [`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 //! - Complete auto-generation of everything except [`utils`] //! //! # Example: Instance Creation //! ```rust //! use erupt::{vk1_0::*, CoreLoader, InstanceLoader}; //! //! let mut core = CoreLoader::new()?; //! core.load_vk1_0()?; //! //! let app_info = ApplicationInfoBuilder::new().api_version(erupt::make_version(1, 0, 0)); //! let instance_info = InstanceCreateInfoBuilder::new().application_info(&app_info); //! let instance_handle = core //! .create_instance(&instance_info, None, None) //! .expect("Failed to create instance"); //! //! let mut instance = InstanceLoader::new(&core, instance_handle)?; //! instance.load_vk1_0()?; //! //! // ... //! //! instance.destroy_instance(None); //! ``` //! //! # Additional examples //! - [triangle](https://gitlab.com/Friz64/erupt/-/blob/master/erupt-examples/src/triangle.rs) //! - [pointer-chain](https://gitlab.com/Friz64/erupt/-/blob/master/erupt-examples/src/pointer_chain.rs) //! - [version](https://gitlab.com/Friz64/erupt/-/blob/master/erupt-examples/src/version.rs) //! //! # Cargo Features //! - `surface`: Enables the [`surface`] module, adds [`raw-window-handle`] dependency (Enabled by default) //! - `libloading`: Enables the [`CoreLoader::new`] function, adds [`libloading`] dependency (Enabled by default) //! //! # Thank you //! - [`vk-parse`](https://crates.io/crates/vk-parse) for helping parse `vk.xml` in the [`generator`](https://gitlab.com/Friz64/erupt/-/tree/master/generator) //! - [`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 //! [`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 //! [`CoreLoader`]: https://docs.rs/erupt/*/erupt/struct.CoreLoader.html //! [`CoreLoader::new`]: https://docs.rs/erupt/*/erupt/struct.CoreLoader.html#method.new //! [`InstanceLoader`]: https://docs.rs/erupt/*/erupt/struct.CoreLoader.html //! [`DeviceLoader`]: https://docs.rs/erupt/*/erupt/struct.CoreLoader.html //! [`utils`]: https://docs.rs/erupt/*/erupt/utils/index.html mod generated; /// Utilities to make working with Vulkan easier pub mod utils; pub use generated::*; /// Construct a `*const std::os::raw::c_char` from a string /// /// # Example /// ``` /// 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 }; } // adapted from ash #[doc(hidden)] #[macro_export] macro_rules! non_dispatchable_handle { ($name:ident, $ty:ident, $doc_link: meta) => { #[repr(transparent)] #[derive(Eq, PartialEq, Ord, PartialOrd, Clone, Copy, Hash, Default)] #[$doc_link] 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! handle { ($name:ident, $ty:ident, $doc_link:meta) => { #[repr(transparent)] #[derive(Eq, PartialEq, Ord, PartialOrd, Clone, Copy, Hash)] #[$doc_link] pub struct $name(pub *mut u8); 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) } } }; } 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; } } } // from winapi #[doc(hidden)] #[allow(non_camel_case_types, non_snake_case)] pub struct SECURITY_ATTRIBUTES { pub nLength: u32, pub lpSecurityDescriptor: *mut std::ffi::c_void, pub bInheritHandle: i32, }