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

    //! Low-level builders that allow submitting an operation to a queue.
    //!
    //! In order to submit an operation to the GPU, you must use one of the builder structs of this
    //! module. These structs are low-level and unsafe, and are mostly used to implement other parts
    //! of vulkano, so you are encouraged to not use them directly.

    pub use self::bind_sparse::SubmitBindSparseBatchBuilder;
    pub use self::bind_sparse::SubmitBindSparseBufferBindBuilder;
    pub use self::bind_sparse::SubmitBindSparseBuilder;
    pub use self::bind_sparse::SubmitBindSparseError;
    pub use self::bind_sparse::SubmitBindSparseImageBindBuilder;
    pub use self::bind_sparse::SubmitBindSparseImageOpaqueBindBuilder;
    pub use self::queue_present::SubmitPresentBuilder;
    pub use self::queue_present::SubmitPresentError;
    pub use self::queue_submit::SubmitCommandBufferBuilder;
    pub use self::queue_submit::SubmitCommandBufferError;
    pub use self::semaphores_wait::SubmitSemaphoresWaitBuilder;

    mod bind_sparse;
    mod queue_present;
    mod queue_submit;
    mod semaphores_wait;

    /// Contains all the possible submission builders.
    #[derive(Debug)]
    pub enum SubmitAnyBuilder<'a> {
        Empty,
        SemaphoresWait(SubmitSemaphoresWaitBuilder<'a>),
        CommandBuffer(SubmitCommandBufferBuilder<'a>),
        QueuePresent(SubmitPresentBuilder<'a>),
        BindSparse(SubmitBindSparseBuilder<'a>),
    }

    impl<'a> SubmitAnyBuilder<'a> {
        /// Returns true if equal to `SubmitAnyBuilder::Empty`.
        #[inline]
        pub fn is_empty(&self) -> bool {
            match self {
                &SubmitAnyBuilder::Empty => true,
                _ => false,
            }
        }
    }

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