      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

    // 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.

    // The `Version` object is reexported from the `instance` module.

    use std::cmp::Ordering;
    use std::fmt;

    /// Represents an API version of Vulkan.
    #[derive(Copy, Clone, PartialEq, Eq)]
    pub struct Version {
        /// Major version number.
        pub major: u16,
        /// Minor version number.
        pub minor: u16,
        /// Patch version number.
        pub patch: u16,
    }

    impl fmt::Debug for Version {
        fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
            write!(formatter, "{}.{}.{}", self.major, self.minor, self.patch)
        }
    }

    impl fmt::Display for Version {
        fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
            fmt::Debug::fmt(self, formatter)
        }
    }

    impl PartialOrd for Version {
        #[inline]
        fn partial_cmp(&self, other: &Version) -> Option<Ordering> {
            Some(self.cmp(other))
        }
    }

    impl Ord for Version {
        fn cmp(&self, other: &Version) -> Ordering {
            match self.major.cmp(&other.major) {
                Ordering::Equal => (),
                o => return o,
            };

            match self.minor.cmp(&other.minor) {
                Ordering::Equal => (),
                o => return o,
            };

            self.patch.cmp(&other.patch)
        }
    }

    impl Version {
        /// Turns a version number given by Vulkan into a `Version` struct.
        #[inline]
        pub fn from_vulkan_version(value: u32) -> Version {
            Version {
                major: ((value & 0xffc00000) >> 22) as u16,
                minor: ((value & 0x003ff000) >> 12) as u16,
                patch: (value & 0x00000fff) as u16,
            }
        }

        /// Turns a `Version` into a version number accepted by Vulkan.
        ///
        /// # Panic
        ///
        /// Panics if the values in the `Version` are out of acceptable range.
        #[inline]
        pub fn into_vulkan_version(&self) -> u32 {
            assert!(self.major <= 0x3ff);
            assert!(self.minor <= 0x3ff);
            assert!(self.patch <= 0xfff);

            (self.major as u32) << 22 | (self.minor as u32) << 12 | (self.patch as u32)
        }
    }

    #[cfg(test)]
    mod tests {
        use super::Version;

        #[test]
        fn into_vk_version() {
            let version = Version {
                major: 1,
                minor: 0,
                patch: 0,
            };
            assert_eq!(version.into_vulkan_version(), 0x400000);
        }

        #[test]
        fn greater_major() {
            let v1 = Version {
                major: 1,
                minor: 0,
                patch: 0,
            };
            let v2 = Version {
                major: 2,
                minor: 0,
                patch: 0,
            };
            assert!(v2 > v1);
        }

        #[test]
        fn greater_minor() {
            let v1 = Version {
                major: 1,
                minor: 1,
                patch: 0,
            };
            let v2 = Version {
                major: 1,
                minor: 3,
                patch: 0,
            };
            assert!(v2 > v1);
        }

        #[test]
        fn greater_patch() {
            let v1 = Version {
                major: 1,
                minor: 0,
                patch: 4,
            };
            let v2 = Version {
                major: 1,
                minor: 0,
                patch: 5,
            };
            assert!(v2 > v1);
        }
    }

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