      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

    // 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 descriptor::descriptor::DescriptorDesc;
    use descriptor::descriptor_set::DescriptorSet;
    use descriptor::descriptor_set::DescriptorSetDesc;

    /// A collection of descriptor set objects.
    pub unsafe trait DescriptorSetsCollection {
        fn into_vec(self) -> Vec<Box<dyn DescriptorSet + Send + Sync>>;

        /// Returns the number of descriptors in the set. Includes possibly empty descriptors.
        ///
        /// Returns `None` if the set is out of range.
        // TODO: remove ; user should just use `into_vec` instead
        fn num_bindings_in_set(&self, set: usize) -> Option<usize>;

        /// Returns the descriptor for the given binding of the given set.
        ///
        /// Returns `None` if out of range.
        // TODO: remove ; user should just use `into_vec` instead
        fn descriptor(&self, set: usize, binding: usize) -> Option<DescriptorDesc>;
    }

    unsafe impl DescriptorSetsCollection for () {
        #[inline]
        fn into_vec(self) -> Vec<Box<dyn DescriptorSet + Send + Sync>> {
            vec![]
        }

        #[inline]
        fn num_bindings_in_set(&self, _: usize) -> Option<usize> {
            None
        }

        #[inline]
        fn descriptor(&self, _: usize, _: usize) -> Option<DescriptorDesc> {
            None
        }
    }

    unsafe impl<T> DescriptorSetsCollection for T
        where T: DescriptorSet + Send + Sync + 'static
    {
        #[inline]
        fn into_vec(self) -> Vec<Box<dyn DescriptorSet + Send + Sync>> {
            vec![Box::new(self) as Box<_>]
        }

        #[inline]
        fn num_bindings_in_set(&self, set: usize) -> Option<usize> {
            match set {
                0 => Some(self.num_bindings()),
                _ => None,
            }
        }

        #[inline]
        fn descriptor(&self, set: usize, binding: usize) -> Option<DescriptorDesc> {
            match set {
                0 => self.descriptor(binding),
                _ => None,
            }
        }
    }

    unsafe impl<T> DescriptorSetsCollection for Vec<T>
        where T: DescriptorSet + Send + Sync + 'static
    {
        #[inline]
        fn into_vec(self) -> Vec<Box<dyn DescriptorSet + Send + Sync>> {
            let mut v = Vec::new();
            for o in self {
                v.push(Box::new(o) as Box<_>);
            }
            return v;
        }

        #[inline]
        fn num_bindings_in_set(&self, set: usize) -> Option<usize> {
            self.get(set).map(|x| x.num_bindings())
        }
        #[inline]
        fn descriptor(&self, set: usize, binding: usize) -> Option<DescriptorDesc> {
            self.get(set).and_then(|x| x.descriptor(binding))
        }
    }

    macro_rules! impl_collection {
        ($first:ident $(, $others:ident)+) => (
            unsafe impl<$first$(, $others)+> DescriptorSetsCollection for ($first, $($others),+)
                where $first: DescriptorSet + DescriptorSetDesc + Send + Sync + 'static
                      $(, $others: DescriptorSet + DescriptorSetDesc + Send + Sync + 'static)*
            {
                #[inline]
                fn into_vec(self) -> Vec<Box<dyn DescriptorSet + Send + Sync>> {
                    #![allow(non_snake_case)]

                    let ($first, $($others,)*) = self;

                    let mut list = Vec::new();
                    list.push(Box::new($first) as Box<_>);
                    $(
                        list.push(Box::new($others) as Box<_>);
                    )+
                    list
                }

                #[inline]
                fn num_bindings_in_set(&self, mut set: usize) -> Option<usize> {
                    #![allow(non_snake_case)]
                    #![allow(unused_mut)]       // For the `set` parameter.

                    if set == 0 {
                        return Some(self.0.num_bindings());
                    }

                    let &(_, $(ref $others,)*) = self;

                    $(
                        set -= 1;
                        if set == 0 {
                            return Some($others.num_bindings());
                        }
                    )*

                    None
                }

                #[inline]
                fn descriptor(&self, mut set: usize, binding: usize) -> Option<DescriptorDesc> {
                    #![allow(non_snake_case)]
                    #![allow(unused_mut)]       // For the `set` parameter.

                    if set == 0 {
                        return self.0.descriptor(binding);
                    }

                    let &(_, $(ref $others,)*) = self;

                    $(
                        set -= 1;
                        if set == 0 {
                            return $others.descriptor(binding);
                        }
                    )*

                    None
                }
            }

            impl_collection!($($others),+);
        );

        ($i:ident) => ();
    }

    impl_collection!(Z,
                     Y,
                     X,
                     W,
                     V,
                     U,
                     T,
                     S,
                     R,
                     Q,
                     P,
                     O,
                     N,
                     M,
                     L,
                     K,
                     J,
                     I,
                     H,
                     G,
                     F,
                     E,
                     D,
                     C,
                     B,
                     A);

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