aboutsummaryrefslogtreecommitdiff
path: root/src/instance/layers.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/instance/layers.rs')
-rw-r--r--src/instance/layers.rs194
1 files changed, 30 insertions, 164 deletions
diff --git a/src/instance/layers.rs b/src/instance/layers.rs
index 6c56090..3ea264b 100644
--- a/src/instance/layers.rs
+++ b/src/instance/layers.rs
@@ -7,79 +7,13 @@
// notice may not be copied, modified, or distributed except
// according to those terms.
-use std::error;
-use std::ffi::CStr;
-use std::fmt;
-use std::ptr;
-use std::vec::IntoIter;
-
-use crate::check_errors;
-use crate::instance::loader;
-use crate::instance::loader::LoadingError;
-use crate::Error;
-use crate::OomError;
use crate::Version;
-
-/// Queries the list of layers that are available when creating an instance.
-///
-/// On success, this function returns an iterator that produces
-/// [`LayerProperties`](struct.LayerProperties.html) objects. In order to enable a layer, you need
-/// to pass its name (returned by `LayerProperties::name()`) when creating the
-/// [`Instance`](struct.Instance.html).
-///
-/// This function returns an error if it failed to load the Vulkan library.
-///
-/// > **Note**: It is possible that one of the layers enumerated here is no longer available when
-/// > you create the `Instance`. This will lead to an error when calling `Instance::new`. The
-/// > author isn't aware of any situation where this would happen, but it is theoretically possible
-/// > according to the specifications.
-///
-/// # Example
-///
-/// ```no_run
-/// use vulkano::instance;
-///
-/// for layer in instance::layers_list().unwrap() {
-/// println!("Available layer: {}", layer.name());
-/// }
-/// ```
-pub fn layers_list() -> Result<LayersIterator, LayersListError> {
- layers_list_from_loader(loader::auto_loader()?)
-}
-
-/// Same as `layers_list()`, but allows specifying a loader.
-pub fn layers_list_from_loader<L>(
- ptrs: &loader::FunctionPointers<L>,
-) -> Result<LayersIterator, LayersListError>
-where
- L: loader::Loader,
-{
- unsafe {
- let fns = ptrs.fns();
-
- let mut num = 0;
- check_errors(
- fns.v1_0
- .enumerate_instance_layer_properties(&mut num, ptr::null_mut()),
- )?;
-
- let mut layers: Vec<ash::vk::LayerProperties> = Vec::with_capacity(num as usize);
- check_errors({
- fns.v1_0
- .enumerate_instance_layer_properties(&mut num, layers.as_mut_ptr())
- })?;
- layers.set_len(num as usize);
-
- Ok(LayersIterator {
- iter: layers.into_iter(),
- })
- }
-}
+use std::ffi::CStr;
/// Properties of a layer.
#[derive(Clone)]
pub struct LayerProperties {
- props: ash::vk::LayerProperties,
+ pub(crate) props: ash::vk::LayerProperties,
}
impl LayerProperties {
@@ -88,12 +22,14 @@ impl LayerProperties {
/// If you want to enable this layer on an instance, you need to pass this value to
/// `Instance::new`.
///
- /// # Example
+ /// # Examples
///
/// ```no_run
- /// use vulkano::instance;
+ /// use vulkano::VulkanLibrary;
///
- /// for layer in instance::layers_list().unwrap() {
+ /// let library = VulkanLibrary::new().unwrap();
+ ///
+ /// for layer in library.layer_properties().unwrap() {
/// println!("Layer name: {}", layer.name());
/// }
/// ```
@@ -110,12 +46,14 @@ impl LayerProperties {
///
/// This description is chosen by the layer itself.
///
- /// # Example
+ /// # Examples
///
/// ```no_run
- /// use vulkano::instance;
+ /// use vulkano::VulkanLibrary;
+ ///
+ /// let library = VulkanLibrary::new().unwrap();
///
- /// for layer in instance::layers_list().unwrap() {
+ /// for layer in library.layer_properties().unwrap() {
/// println!("Layer description: {}", layer.description());
/// }
/// ```
@@ -130,13 +68,14 @@ impl LayerProperties {
/// Returns the version of Vulkan supported by this layer.
///
- /// # Example
+ /// # Examples
///
/// ```no_run
- /// use vulkano::instance;
- /// use vulkano::instance::Version;
+ /// use vulkano::{Version, VulkanLibrary};
+ ///
+ /// let library = VulkanLibrary::new().unwrap();
///
- /// for layer in instance::layers_list().unwrap() {
+ /// for layer in library.layer_properties().unwrap() {
/// if layer.vulkan_version() >= Version::major_minor(2, 0) {
/// println!("Layer {} requires Vulkan 2.0", layer.name());
/// }
@@ -151,12 +90,14 @@ impl LayerProperties {
///
/// The number is chosen by the layer itself. It can be used for bug reports for example.
///
- /// # Example
+ /// # Examples
///
/// ```no_run
- /// use vulkano::instance;
+ /// use vulkano::VulkanLibrary;
///
- /// for layer in instance::layers_list().unwrap() {
+ /// let library = VulkanLibrary::new().unwrap();
+ ///
+ /// for layer in library.layer_properties().unwrap() {
/// println!("Layer {} - Version: {}", layer.name(), layer.implementation_version());
/// }
/// ```
@@ -166,97 +107,22 @@ impl LayerProperties {
}
}
-/// Error that can happen when loading the list of layers.
-#[derive(Clone, Debug)]
-pub enum LayersListError {
- /// Failed to load the Vulkan shared library.
- LoadingError(LoadingError),
- /// Not enough memory.
- OomError(OomError),
-}
-
-impl error::Error for LayersListError {
- #[inline]
- fn source(&self) -> Option<&(dyn error::Error + 'static)> {
- match *self {
- LayersListError::LoadingError(ref err) => Some(err),
- LayersListError::OomError(ref err) => Some(err),
- }
- }
-}
-
-impl fmt::Display for LayersListError {
- #[inline]
- fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
- write!(
- fmt,
- "{}",
- match *self {
- LayersListError::LoadingError(_) => "failed to load the Vulkan shared library",
- LayersListError::OomError(_) => "not enough memory available",
- }
- )
- }
-}
-
-impl From<OomError> for LayersListError {
- #[inline]
- fn from(err: OomError) -> LayersListError {
- LayersListError::OomError(err)
- }
-}
-
-impl From<LoadingError> for LayersListError {
- #[inline]
- fn from(err: LoadingError) -> LayersListError {
- LayersListError::LoadingError(err)
- }
-}
-
-impl From<Error> for LayersListError {
- #[inline]
- fn from(err: Error) -> LayersListError {
- match err {
- err @ Error::OutOfHostMemory => LayersListError::OomError(OomError::from(err)),
- err @ Error::OutOfDeviceMemory => LayersListError::OomError(OomError::from(err)),
- _ => panic!("unexpected error: {:?}", err),
- }
- }
-}
-
-/// Iterator that produces the list of layers that are available.
-// TODO: #[derive(Debug, Clone)]
-pub struct LayersIterator {
- iter: IntoIter<ash::vk::LayerProperties>,
-}
-
-impl Iterator for LayersIterator {
- type Item = LayerProperties;
-
- #[inline]
- fn next(&mut self) -> Option<LayerProperties> {
- self.iter.next().map(|p| LayerProperties { props: p })
- }
-
- #[inline]
- fn size_hint(&self) -> (usize, Option<usize>) {
- self.iter.size_hint()
- }
-}
-
-impl ExactSizeIterator for LayersIterator {}
-
#[cfg(test)]
mod tests {
- use crate::instance;
+ use crate::VulkanLibrary;
#[test]
fn layers_list() {
- let mut list = match instance::layers_list() {
+ let library = match VulkanLibrary::new() {
+ Ok(x) => x,
+ Err(_) => return,
+ };
+
+ let list = match library.layer_properties() {
Ok(l) => l,
Err(_) => return,
};
- while let Some(_) = list.next() {}
+ for _ in list {}
}
}
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-20 00:53:22 +0000