alex/ash
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Document crate features in library docs (#627)

Browse source
This commit is contained in:
lilly lizard 2022-05-29 12:40:10 +00:00 committed by GitHub
parent 6308470479
commit c6f8da0515
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
ash/Cargo.toml
View file

@ -20,7 +20,7 @@ default = ["loaded", "debug"]
linked = []
# Support searching for the Vulkan loader manually at runtime.
loaded = ["libloading"]
# Whether Vulkan structs should implement Debug
# Whether Vulkan structs should implement Debug.
debug = []
[package.metadata.release]

6
ash/src/lib.rs
View file

@ -33,6 +33,12 @@
//! Load the Vulkan library linked at compile time using [`Entry::linked()`], or load it at runtime
//! using [`Entry::load()`], which uses `libloading`. If you want to perform entry point loading
//! yourself, call [`Entry::from_static_fn()`].
//!
//! ## Crate features
//!
//! * **debug** (default): Whether Vulkan structs should implement `Debug`.
//! * **loaded** (default): Support searching for the Vulkan loader manually at runtime.
//! * **linked**: Link the Vulkan loader at compile time.
pub use crate::device::Device;
pub use crate::entry::Entry;