      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
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361

    // 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 smallvec::SmallVec;
    use std::error;
    use std::fmt;
    use std::marker::PhantomData;
    use std::ptr;

    use command_buffer::sys::UnsafeCommandBuffer;
    use device::Queue;
    use sync::Fence;
    use sync::PipelineStages;
    use sync::Semaphore;

    use Error;
    use OomError;
    use SynchronizedVulkanObject;
    use VulkanObject;
    use check_errors;
    use vk;

    /// Prototype for a submission that executes command buffers.
    // TODO: example here
    #[derive(Debug)]
    pub struct SubmitCommandBufferBuilder<'a> {
        wait_semaphores: SmallVec<[vk::Semaphore; 16]>,
        destination_stages: SmallVec<[vk::PipelineStageFlags; 8]>,
        signal_semaphores: SmallVec<[vk::Semaphore; 16]>,
        command_buffers: SmallVec<[vk::CommandBuffer; 4]>,
        fence: vk::Fence,
        marker: PhantomData<&'a ()>,
    }

    impl<'a> SubmitCommandBufferBuilder<'a> {
        /// Builds a new empty `SubmitCommandBufferBuilder`.
        #[inline]
        pub fn new() -> SubmitCommandBufferBuilder<'a> {
            SubmitCommandBufferBuilder {
                wait_semaphores: SmallVec::new(),
                destination_stages: SmallVec::new(),
                signal_semaphores: SmallVec::new(),
                command_buffers: SmallVec::new(),
                fence: 0,
                marker: PhantomData,
            }
        }

        /// Returns true if this builder will signal a fence when submitted.
        ///
        /// # Example
        ///
        /// ```
        /// use vulkano::command_buffer::submit::SubmitCommandBufferBuilder;
        /// use vulkano::sync::Fence;
        /// # let device: std::sync::Arc<vulkano::device::Device> = return;
        ///
        /// unsafe {
        ///     let fence = Fence::from_pool(device.clone()).unwrap();
        ///
        ///     let mut builder = SubmitCommandBufferBuilder::new();
        ///     assert!(!builder.has_fence());
        ///     builder.set_fence_signal(&fence);
        ///     assert!(builder.has_fence());
        /// }
        /// ```
        #[inline]
        pub fn has_fence(&self) -> bool {
            self.fence != 0
        }

        /// Adds an operation that signals a fence after this submission ends.
        ///
        /// # Example
        ///
        /// ```
        /// use std::time::Duration;
        /// use vulkano::command_buffer::submit::SubmitCommandBufferBuilder;
        /// use vulkano::sync::Fence;
        /// # let device: std::sync::Arc<vulkano::device::Device> = return;
        /// # let queue: std::sync::Arc<vulkano::device::Queue> = return;
        ///
        /// unsafe {
        ///     let fence = Fence::from_pool(device.clone()).unwrap();
        ///
        ///     let mut builder = SubmitCommandBufferBuilder::new();
        ///     builder.set_fence_signal(&fence);
        ///
        ///     builder.submit(&queue).unwrap();
        ///
        ///     // We must not destroy the fence before it is signaled.
        ///     fence.wait(Some(Duration::from_secs(5))).unwrap();
        /// }
        /// ```
        ///
        /// # Safety
        ///
        /// - The fence must not be signaled at the time when you call `submit()`.
        ///
        /// - If you use the fence for multiple submissions, only one at a time must be executed by the
        ///   GPU. In other words, you must submit one, wait for the fence to be signaled, then reset
        ///   the fence, and then only submit the second.
        ///
        /// - If you submit this builder, the fence must be kept alive until it is signaled by the GPU.
        ///   Destroying the fence earlier is an undefined behavior.
        ///
        /// - The fence, command buffers, and semaphores must all belong to the same device.
        ///
        #[inline]
        pub unsafe fn set_fence_signal(&mut self, fence: &'a Fence) {
            self.fence = fence.internal_object();
        }

        /// Adds a semaphore to be waited upon before the command buffers are executed.
        ///
        /// Only the given `stages` of the command buffers added afterwards will wait upon
        /// the semaphore. Other stages not included in `stages` can execute before waiting.
        ///
        /// # Safety
        ///
        /// - The stages must be supported by the device.
        ///
        /// - If you submit this builder, the semaphore must be kept alive until you are guaranteed
        ///   that the GPU has at least started executing the command buffers.
        ///
        /// - If you submit this builder, no other queue must be waiting on these semaphores. In other
        ///   words, each semaphore signal can only correspond to one semaphore wait.
        ///
        /// - If you submit this builder, the semaphores must be signaled when the queue execution
        ///   reaches this submission, or there must be one or more submissions in queues that are
        ///   going to signal these semaphores. In other words, you must not block the queue with
        ///   semaphores that can't get signaled.
        ///
        /// - The fence, command buffers, and semaphores must all belong to the same device.
        ///
        #[inline]
        pub unsafe fn add_wait_semaphore(&mut self, semaphore: &'a Semaphore, stages: PipelineStages) {
            debug_assert!(stages.into_vulkan_bits() != 0);
            // TODO: debug assert that the device supports the stages
            self.wait_semaphores.push(semaphore.internal_object());
            self.destination_stages.push(stages.into_vulkan_bits());
        }

        /// Adds a command buffer that is executed as part of this command.
        ///
        /// The command buffers are submitted in the order in which they are added.
        ///
        /// # Safety
        ///
        /// - If you submit this builder, the command buffer must be kept alive until you are
        ///   guaranteed that the GPU has finished executing it.
        ///
        /// - Any calls to vkCmdSetEvent, vkCmdResetEvent or vkCmdWaitEvents that have been recorded
        ///   into the command buffer must not reference any VkEvent that is referenced by any of
        ///   those commands that is pending execution on another queue.
        ///   TODO: rephrase ^ ?
        ///
        /// - The fence, command buffers, and semaphores must all belong to the same device.
        ///
        /// TODO: more here
        ///
        #[inline]
        pub unsafe fn add_command_buffer<P>(&mut self, command_buffer: &'a UnsafeCommandBuffer<P>) {
            self.command_buffers.push(command_buffer.internal_object());
        }

        /// Returns the number of semaphores to signal.
        ///
        /// In other words, this is the number of times `add_signal_semaphore` has been called.
        #[inline]
        pub fn num_signal_semaphores(&self) -> usize {
            self.signal_semaphores.len()
        }

        /// Adds a semaphore that is going to be signaled at the end of the submission.
        ///
        /// # Safety
        ///
        /// - If you submit this builder, the semaphore must be kept alive until you are guaranteed
        ///   that the GPU has finished executing this submission.
        ///
        /// - The semaphore must be in the unsignaled state when queue execution reaches this
        ///   submission.
        ///
        /// - The fence, command buffers, and semaphores must all belong to the same device.
        ///
        #[inline]
        pub unsafe fn add_signal_semaphore(&mut self, semaphore: &'a Semaphore) {
            self.signal_semaphores.push(semaphore.internal_object());
        }

        /// Submits the command buffer to the given queue.
        ///
        /// > **Note**: This is an expensive operation, so you may want to merge as many builders as
        /// > possible together and avoid submitting them one by one.
        ///
        pub fn submit(self, queue: &Queue) -> Result<(), SubmitCommandBufferError> {
            unsafe {
                let vk = queue.device().pointers();
                let queue = queue.internal_object_guard();

                debug_assert_eq!(self.wait_semaphores.len(), self.destination_stages.len());

                let batch = vk::SubmitInfo {
                    sType: vk::STRUCTURE_TYPE_SUBMIT_INFO,
                    pNext: ptr::null(),
                    waitSemaphoreCount: self.wait_semaphores.len() as u32,
                    pWaitSemaphores: self.wait_semaphores.as_ptr(),
                    pWaitDstStageMask: self.destination_stages.as_ptr(),
                    commandBufferCount: self.command_buffers.len() as u32,
                    pCommandBuffers: self.command_buffers.as_ptr(),
                    signalSemaphoreCount: self.signal_semaphores.len() as u32,
                    pSignalSemaphores: self.signal_semaphores.as_ptr(),
                };

                check_errors(vk.QueueSubmit(*queue, 1, &batch, self.fence))?;
                Ok(())
            }
        }

        /// Merges this builder with another builder.
        ///
        /// # Panic
        ///
        /// Panics if both builders have a fence already set.
        // TODO: create multiple batches instead
        pub fn merge(mut self, other: Self) -> Self {
            assert!(self.fence == 0 || other.fence == 0,
                    "Can't merge two queue submits that both have a fence");

            self.wait_semaphores.extend(other.wait_semaphores);
            self.destination_stages.extend(other.destination_stages); // TODO: meh? will be solved if we submit multiple batches
            self.signal_semaphores.extend(other.signal_semaphores);
            self.command_buffers.extend(other.command_buffers);

            if self.fence == 0 {
                self.fence = other.fence;
            }

            self
        }
    }

    /// Error that can happen when submitting the prototype.
    #[derive(Copy, Clone, Debug, PartialEq, Eq)]
    #[repr(u32)]
    pub enum SubmitCommandBufferError {
        /// Not enough memory.
        OomError(OomError),

        /// The connection to the device has been lost.
        DeviceLost,
    }

    impl error::Error for SubmitCommandBufferError {
        #[inline]
        fn description(&self) -> &str {
            match *self {
                SubmitCommandBufferError::OomError(_) => "not enough memory",
                SubmitCommandBufferError::DeviceLost => "the connection to the device has been lost",
            }
        }

        #[inline]
        fn cause(&self) -> Option<&dyn error::Error> {
            match *self {
                SubmitCommandBufferError::OomError(ref err) => Some(err),
                _ => None,
            }
        }
    }

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

    impl From<Error> for SubmitCommandBufferError {
        #[inline]
        fn from(err: Error) -> SubmitCommandBufferError {
            match err {
                err @ Error::OutOfHostMemory => SubmitCommandBufferError::OomError(OomError::from(err)),
                err @ Error::OutOfDeviceMemory =>
                    SubmitCommandBufferError::OomError(OomError::from(err)),
                Error::DeviceLost => SubmitCommandBufferError::DeviceLost,
                _ => panic!("unexpected error: {:?}", err),
            }
        }
    }

    #[cfg(test)]
    mod tests {
        use super::*;
        use std::time::Duration;
        use sync::Fence;

        #[test]
        fn empty_submit() {
            let (device, queue) = gfx_dev_and_queue!();
            let builder = SubmitCommandBufferBuilder::new();
            builder.submit(&queue).unwrap();
        }

        #[test]
        fn signal_fence() {
            unsafe {
                let (device, queue) = gfx_dev_and_queue!();

                let fence = Fence::alloc(device.clone()).unwrap();
                assert!(!fence.ready().unwrap());

                let mut builder = SubmitCommandBufferBuilder::new();
                builder.set_fence_signal(&fence);

                builder.submit(&queue).unwrap();
                fence.wait(Some(Duration::from_secs(5))).unwrap();
                assert!(fence.ready().unwrap());
            }
        }

        #[test]
        fn has_fence() {
            unsafe {
                let (device, queue) = gfx_dev_and_queue!();

                let fence = Fence::alloc(device.clone()).unwrap();

                let mut builder = SubmitCommandBufferBuilder::new();
                assert!(!builder.has_fence());
                builder.set_fence_signal(&fence);
                assert!(builder.has_fence());
            }
        }

        #[test]
        fn merge_both_have_fences() {
            unsafe {
                let (device, _) = gfx_dev_and_queue!();

                let fence1 = Fence::alloc(device.clone()).unwrap();
                let fence2 = Fence::alloc(device.clone()).unwrap();

                let mut builder1 = SubmitCommandBufferBuilder::new();
                builder1.set_fence_signal(&fence1);
                let mut builder2 = SubmitCommandBufferBuilder::new();
                builder2.set_fence_signal(&fence2);

                assert_should_panic!("Can't merge two queue submits that both have a fence", {
                    let _ = builder1.merge(builder2);
                });
            }
        }
    }

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