      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

    // Copyright (c) 2017 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 pipeline::vertex::VertexMemberTy;

    /// Implements the `Vertex` trait on a struct.
    // TODO: add example
    #[macro_export]
    macro_rules! impl_vertex {
        ($out:ty $(, $member:ident)*) => (
            #[allow(unsafe_code)]
            unsafe impl $crate::pipeline::vertex::Vertex for $out {
                #[inline(always)]
                fn member(name: &str) -> Option<$crate::pipeline::vertex::VertexMemberInfo> {
                    use std::ptr;
                    #[allow(unused_imports)]
                    use $crate::format::Format;
                    use $crate::pipeline::vertex::VertexMemberInfo;
                    use $crate::pipeline::vertex::VertexMemberTy;
                    use $crate::pipeline::vertex::VertexMember;

                    $(
                        if name == stringify!($member) {
                            let dummy = <$out>::default();
                            #[inline] fn f<T: VertexMember>(_: &T) -> (VertexMemberTy, usize) { T::format() }
                            let (ty, array_size) = f(&dummy.$member);

                            let dummy_ptr = (&dummy) as *const _;
                            let member_ptr = (&dummy.$member) as *const _;

                            return Some(VertexMemberInfo {
                                offset: member_ptr as usize - dummy_ptr as usize,
                                ty: ty,
                                array_size: array_size,
                            });
                        }
                    )*

                    None
                }
            }
        )
    }

    /// Trait for data types that can be used as vertex members. Used by the `impl_vertex!` macro.
    pub unsafe trait VertexMember {
        /// Returns the format and array size of the member.
        fn format() -> (VertexMemberTy, usize);
    }

    unsafe impl VertexMember for i8 {
        #[inline]
        fn format() -> (VertexMemberTy, usize) {
            (VertexMemberTy::I8, 1)
        }
    }

    unsafe impl VertexMember for u8 {
        #[inline]
        fn format() -> (VertexMemberTy, usize) {
            (VertexMemberTy::U8, 1)
        }
    }

    unsafe impl VertexMember for i16 {
        #[inline]
        fn format() -> (VertexMemberTy, usize) {
            (VertexMemberTy::I16, 1)
        }
    }

    unsafe impl VertexMember for u16 {
        #[inline]
        fn format() -> (VertexMemberTy, usize) {
            (VertexMemberTy::U16, 1)
        }
    }

    unsafe impl VertexMember for i32 {
        #[inline]
        fn format() -> (VertexMemberTy, usize) {
            (VertexMemberTy::I32, 1)
        }
    }

    unsafe impl VertexMember for u32 {
        #[inline]
        fn format() -> (VertexMemberTy, usize) {
            (VertexMemberTy::U32, 1)
        }
    }

    unsafe impl VertexMember for f32 {
        #[inline]
        fn format() -> (VertexMemberTy, usize) {
            (VertexMemberTy::F32, 1)
        }
    }

    unsafe impl VertexMember for f64 {
        #[inline]
        fn format() -> (VertexMemberTy, usize) {
            (VertexMemberTy::F64, 1)
        }
    }

    unsafe impl<T> VertexMember for (T,)
        where T: VertexMember
    {
        #[inline]
        fn format() -> (VertexMemberTy, usize) {
            <T as VertexMember>::format()
        }
    }

    unsafe impl<T> VertexMember for (T, T)
        where T: VertexMember
    {
        #[inline]
        fn format() -> (VertexMemberTy, usize) {
            let (ty, sz) = <T as VertexMember>::format();
            (ty, sz * 2)
        }
    }

    unsafe impl<T> VertexMember for (T, T, T)
        where T: VertexMember
    {
        #[inline]
        fn format() -> (VertexMemberTy, usize) {
            let (ty, sz) = <T as VertexMember>::format();
            (ty, sz * 3)
        }
    }

    unsafe impl<T> VertexMember for (T, T, T, T)
        where T: VertexMember
    {
        #[inline]
        fn format() -> (VertexMemberTy, usize) {
            let (ty, sz) = <T as VertexMember>::format();
            (ty, sz * 4)
        }
    }

    macro_rules! impl_vm_array {
        ($sz:expr) => (
            unsafe impl<T> VertexMember for [T; $sz]
                where T: VertexMember
            {
                #[inline]
                fn format() -> (VertexMemberTy, usize) {
                    let (ty, sz) = <T as VertexMember>::format();
                    (ty, sz * $sz)
                }
            }
        );
    }

    impl_vm_array!(1);
    impl_vm_array!(2);
    impl_vm_array!(3);
    impl_vm_array!(4);
    impl_vm_array!(5);
    impl_vm_array!(6);
    impl_vm_array!(7);
    impl_vm_array!(8);
    impl_vm_array!(9);
    impl_vm_array!(10);
    impl_vm_array!(11);
    impl_vm_array!(12);
    impl_vm_array!(13);
    impl_vm_array!(14);
    impl_vm_array!(15);
    impl_vm_array!(16);
    impl_vm_array!(32);
    impl_vm_array!(64);

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