      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

    // 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::error;
    use std::fmt;
    use std::str;

    use Error;
    use OomError;
    use instance::loader::LoadingError;

    macro_rules! extensions {
        ($sname:ident, $rawname:ident, $($ext:ident => $s:expr,)*) => (
            /// List of extensions that are enabled or available.
            #[derive(Copy, Clone, PartialEq, Eq)]
            #[allow(missing_docs)]
            pub struct $sname {
                $(
                    pub $ext: bool,
                )*

                /// This field ensures that an instance of this `Extensions` struct
                /// can only be created through Vulkano functions and the update
                /// syntax. This way, extensions can be added to Vulkano without
                /// breaking existing code.
                pub _unbuildable: Unbuildable,
            }

            impl $sname {
                /// Returns an `Extensions` object with all members set to `false`.
                #[inline]
                pub fn none() -> $sname {
                    $sname {
                        $($ext: false,)*
                        _unbuildable: Unbuildable(())
                    }
                }

                /// Returns the union of this list and another list.
                #[inline]
                pub fn union(&self, other: &$sname) -> $sname {
                    $sname {
                        $(
                            $ext: self.$ext || other.$ext,
                        )*
                        _unbuildable: Unbuildable(())
                    }
                }

                /// Returns the intersection of this list and another list.
                #[inline]
                pub fn intersection(&self, other: &$sname) -> $sname {
                    $sname {
                        $(
                            $ext: self.$ext && other.$ext,
                        )*
                        _unbuildable: Unbuildable(())
                    }
                }

                /// Returns the difference of another list from this list.
                #[inline]
                pub fn difference(&self, other: &$sname) -> $sname {
                    $sname {
                        $(
                            $ext: self.$ext && !other.$ext,
                        )*
                        _unbuildable: Unbuildable(())
                    }
                }
            }

            impl fmt::Debug for $sname {
                #[allow(unused_assignments)]
                fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
                    write!(f, "[")?;

                    let mut first = true;

                    $(
                        if self.$ext {
                            if !first { write!(f, ", ")? }
                            else { first = false; }
                            f.write_str(str::from_utf8($s).unwrap())?;
                        }
                    )*

                    write!(f, "]")
                }
            }

            /// Set of extensions, not restricted to those vulkano knows about.
            ///
            /// This is useful when interacting with external code that has statically-unknown extension
            /// requirements.
            #[derive(Clone, Eq, PartialEq)]
            pub struct $rawname(HashSet<CString>);

            impl $rawname {
                /// Constructs an extension set containing the supplied extensions.
                pub fn new<I>(extensions: I) -> Self
                    where I: IntoIterator<Item=CString>
                {
                    $rawname(extensions.into_iter().collect())
                }

                /// Constructs an empty extension set.
                pub fn none() -> Self { $rawname(HashSet::new()) }

                /// Adds an extension to the set if it is not already present.
                pub fn insert(&mut self, extension: CString) {
                    self.0.insert(extension);
                }

                /// Returns the intersection of this set and another.
                pub fn intersection(&self, other: &Self) -> Self {
                    $rawname(self.0.intersection(&other.0).cloned().collect())
                }

                /// Returns the difference of another set from this one.
                pub fn difference(&self, other: &Self) -> Self {
                    $rawname(self.0.difference(&other.0).cloned().collect())
                }

                /// Returns the union of both extension sets
                pub fn union(&self, other: &Self) -> Self {
                    $rawname(self.0.union(&other.0).cloned().collect())
                }

                // TODO: impl Iterator
                pub fn iter(&self) -> ::std::collections::hash_set::Iter<CString> { self.0.iter() }
            }

            impl fmt::Debug for $rawname {
                #[allow(unused_assignments)]
                fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
                    self.0.fmt(f)
                }
            }

            impl FromIterator<CString> for $rawname {
                fn from_iter<T>(iter: T) -> Self
                    where T: IntoIterator<Item = CString>
                {
                    $rawname(iter.into_iter().collect())
                }
            }

            impl<'a> From<&'a $sname> for $rawname {
                fn from(x: &'a $sname) -> Self {
                    let mut data = HashSet::new();
                    $(if x.$ext { data.insert(CString::new(&$s[..]).unwrap()); })*
                    $rawname(data)
                }
            }

            impl<'a> From<&'a $rawname> for $sname {
                fn from(x: &'a $rawname) -> Self {
                    let mut extensions = $sname::none();
                    $(
                        if x.0.iter().any(|x| x.as_bytes() == &$s[..]) {
                            extensions.$ext = true;
                        }
                    )*
                    extensions
                }
            }
        );
    }

    /// Error that can happen when loading the list of layers.
    #[derive(Clone, Debug)]
    pub enum SupportedExtensionsError {
        /// Failed to load the Vulkan shared library.
        LoadingError(LoadingError),
        /// Not enough memory.
        OomError(OomError),
    }

    impl error::Error for SupportedExtensionsError {
        #[inline]
        fn description(&self) -> &str {
            match *self {
                SupportedExtensionsError::LoadingError(_) => "failed to load the Vulkan shared library",
                SupportedExtensionsError::OomError(_) => "not enough memory available",
            }
        }

        #[inline]
        fn cause(&self) -> Option<&dyn error::Error> {
            match *self {
                SupportedExtensionsError::LoadingError(ref err) => Some(err),
                SupportedExtensionsError::OomError(ref err) => Some(err),
            }
        }
    }

    impl fmt::Display for SupportedExtensionsError {
        #[inline]
        fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
            write!(fmt, "{}", error::Error::description(self))
        }
    }

    impl From<OomError> for SupportedExtensionsError {
        #[inline]
        fn from(err: OomError) -> SupportedExtensionsError {
            SupportedExtensionsError::OomError(err)
        }
    }

    impl From<LoadingError> for SupportedExtensionsError {
        #[inline]
        fn from(err: LoadingError) -> SupportedExtensionsError {
            SupportedExtensionsError::LoadingError(err)
        }
    }

    impl From<Error> for SupportedExtensionsError {
        #[inline]
        fn from(err: Error) -> SupportedExtensionsError {
            match err {
                err @ Error::OutOfHostMemory => {
                    SupportedExtensionsError::OomError(OomError::from(err))
                },
                err @ Error::OutOfDeviceMemory => {
                    SupportedExtensionsError::OomError(OomError::from(err))
                },
                _ => panic!("unexpected error: {:?}", err),
            }
        }
    }

# 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`)