      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

    // Copyright (c) 2016 The vulkano developers
    // Licensed under the Apache License, Version 2.0
    // <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT
    // license <LICENSE-MIT or http://opensource.org/licenses/MIT>,
    // at your option. All files in the project carrying such
    // notice may not be copied, modified, or distributed except
    // according to those terms.

    use std::collections::HashSet;
    use std::ffi::{CStr, CString};
    use std::fmt;
    use std::iter::FromIterator;
    use std::ptr;
    use std::str;

    use VulkanObject;
    use check_errors;
    use instance::PhysicalDevice;
    use extensions::SupportedExtensionsError;
    use vk;

    macro_rules! device_extensions {
        ($sname:ident, $rawname:ident, $($ext:ident => $s:expr,)*) => (
            extensions! {
                $sname, $rawname,
                $( $ext => $s,)*
            }

            impl $rawname {
                /// See the docs of supported_by_device().
                pub fn supported_by_device_raw(physical_device: PhysicalDevice) -> Result<Self, SupportedExtensionsError> {
                    let vk = physical_device.instance().pointers();

                    let properties: Vec<vk::ExtensionProperties> = unsafe {
                        let mut num = 0;
                        check_errors(vk.EnumerateDeviceExtensionProperties(
                            physical_device.internal_object(), ptr::null(), &mut num, ptr::null_mut()
                        ))?;

                        let mut properties = Vec::with_capacity(num as usize);
                        check_errors(vk.EnumerateDeviceExtensionProperties(
                            physical_device.internal_object(), ptr::null(), &mut num, properties.as_mut_ptr()
                        ))?;
                        properties.set_len(num as usize);
                        properties
                    };
                    Ok($rawname(properties.iter().map(|x| unsafe { CStr::from_ptr(x.extensionName.as_ptr()) }.to_owned()).collect()))
                }

                /// Returns an `Extensions` object with extensions supported by the `PhysicalDevice`.
                pub fn supported_by_device(physical_device: PhysicalDevice) -> Self {
                    match $rawname::supported_by_device_raw(physical_device) {
                        Ok(l) => l,
                        Err(SupportedExtensionsError::LoadingError(_)) => unreachable!(),
                        Err(SupportedExtensionsError::OomError(e)) => panic!("{:?}", e),
                    }
                }
            }

            impl $sname {
                /// See the docs of supported_by_device().
                pub fn supported_by_device_raw(physical_device: PhysicalDevice) -> Result<Self, SupportedExtensionsError> {
                    let vk = physical_device.instance().pointers();

                    let properties: Vec<vk::ExtensionProperties> = unsafe {
                        let mut num = 0;
                        check_errors(vk.EnumerateDeviceExtensionProperties(
                            physical_device.internal_object(), ptr::null(), &mut num, ptr::null_mut()
                        ))?;

                        let mut properties = Vec::with_capacity(num as usize);
                        check_errors(vk.EnumerateDeviceExtensionProperties(
                            physical_device.internal_object(), ptr::null(), &mut num, properties.as_mut_ptr()
                        ))?;
                        properties.set_len(num as usize);
                        properties
                    };

                    let mut extensions = $sname::none();
                    for property in properties {
                        let name = unsafe { CStr::from_ptr(property.extensionName.as_ptr()) };
                        $(
                            // TODO: Check specVersion?
                            if name.to_bytes() == &$s[..] {
                                extensions.$ext = true;
                            }
                        )*
                    }

                    Ok(extensions)
                }

                /// Returns an `Extensions` object with extensions supported by the `PhysicalDevice`.
                pub fn supported_by_device(physical_device: PhysicalDevice) -> Self {
                    match $sname::supported_by_device_raw(physical_device) {
                        Ok(l) => l,
                        Err(SupportedExtensionsError::LoadingError(_)) => unreachable!(),
                        Err(SupportedExtensionsError::OomError(e)) => panic!("{:?}", e),
                    }
                }
            }
        );
    }

    device_extensions! {
        DeviceExtensions,
        RawDeviceExtensions,
        khr_swapchain => b"VK_KHR_swapchain",
        khr_display_swapchain => b"VK_KHR_display_swapchain",
        khr_sampler_mirror_clamp_to_edge => b"VK_KHR_sampler_mirror_clamp_to_edge",
        khr_maintenance1 => b"VK_KHR_maintenance1",
        khr_get_memory_requirements2 => b"VK_KHR_get_memory_requirements2",
        khr_dedicated_allocation => b"VK_KHR_dedicated_allocation",
        khr_incremental_present => b"VK_KHR_incremental_present",
        ext_debug_marker => b"VK_EXT_debug_marker",
    }

    /// This helper type can only be instantiated inside this module.
    /// See `*Extensions::_unbuildable`.
    #[doc(hidden)]
    #[derive(Debug, Copy, Clone, PartialEq, Eq)]
    pub struct Unbuildable(());

    #[cfg(test)]
    mod tests {
        use device::{DeviceExtensions, RawDeviceExtensions};

        #[test]
        fn empty_extensions() {
            let d: RawDeviceExtensions = (&DeviceExtensions::none()).into();
            assert!(d.iter().next().is_none());
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)