     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

    // 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 smallvec::SmallVec;

    use command_buffer::submit::SubmitCommandBufferBuilder;
    use command_buffer::submit::SubmitPresentBuilder;
    use sync::PipelineStages;
    use sync::Semaphore;

    /// Prototype for a submission that waits on semaphores.
    ///
    /// This prototype can't actually be submitted because it doesn't correspond to anything in Vulkan.
    /// However you can convert it into another builder prototype through the `Into` trait.
    #[derive(Debug)]
    pub struct SubmitSemaphoresWaitBuilder<'a> {
        semaphores: SmallVec<[&'a Semaphore; 8]>,
    }

    impl<'a> SubmitSemaphoresWaitBuilder<'a> {
        /// Builds a new empty `SubmitSemaphoresWaitBuilder`.
        #[inline]
        pub fn new() -> SubmitSemaphoresWaitBuilder<'a> {
            SubmitSemaphoresWaitBuilder { semaphores: SmallVec::new() }
        }

        /// Adds an operation that waits on a semaphore.
        ///
        /// The semaphore must be signaled by a previous submission.
        #[inline]
        pub unsafe fn add_wait_semaphore(&mut self, semaphore: &'a Semaphore) {
            self.semaphores.push(semaphore);
        }

        /// Merges this builder with another builder.
        #[inline]
        pub fn merge(&mut self, mut other: SubmitSemaphoresWaitBuilder<'a>) {
            self.semaphores.extend(other.semaphores.drain());
        }
    }

    impl<'a> Into<SubmitCommandBufferBuilder<'a>> for SubmitSemaphoresWaitBuilder<'a> {
        #[inline]
        fn into(mut self) -> SubmitCommandBufferBuilder<'a> {
            unsafe {
                let mut builder = SubmitCommandBufferBuilder::new();
                for sem in self.semaphores.drain() {
                    builder.add_wait_semaphore(sem,
                                               PipelineStages {
                                                   // TODO: correct stages ; hard
                                                   all_commands: true,
                                                   ..PipelineStages::none()
                                               });
                }
                builder
            }
        }
    }

    impl<'a> Into<SubmitPresentBuilder<'a>> for SubmitSemaphoresWaitBuilder<'a> {
        #[inline]
        fn into(mut self) -> SubmitPresentBuilder<'a> {
            unsafe {
                let mut builder = SubmitPresentBuilder::new();
                for sem in self.semaphores.drain() {
                    builder.add_wait_semaphore(sem);
                }
                builder
            }
        }
    }

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