     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

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

    use descriptor::pipeline_layout::PipelineLayoutAbstract;
    use descriptor::pipeline_layout::PipelineLayoutPushConstantsCompatible;

    /// Checks whether push constants are compatible with the pipeline.
    pub fn check_push_constants_validity<Pl, Pc>(pipeline: &Pl, push_constants: &Pc)
                                                 -> Result<(), CheckPushConstantsValidityError>
        where Pl: ?Sized + PipelineLayoutAbstract + PipelineLayoutPushConstantsCompatible<Pc>,
              Pc: ?Sized
    {
        if !pipeline.is_compatible(push_constants) {
            return Err(CheckPushConstantsValidityError::IncompatiblePushConstants);
        }

        Ok(())
    }

    /// Error that can happen when checking push constants validity.
    #[derive(Debug, Copy, Clone)]
    pub enum CheckPushConstantsValidityError {
        /// The push constants are incompatible with the pipeline layout.
        IncompatiblePushConstants,
    }

    impl error::Error for CheckPushConstantsValidityError {
        #[inline]
        fn description(&self) -> &str {
            match *self {
                CheckPushConstantsValidityError::IncompatiblePushConstants => {
                    "the push constants are incompatible with the pipeline layout"
                },
            }
        }
    }

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

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