      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

    // 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 device::DeviceOwned;
    use device::Queue;
    use swapchain::PresentRegion;
    use swapchain::Swapchain;
    use sync::Semaphore;

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

    /// Prototype for a submission that presents a swapchain on the screen.
    // TODO: example here
    pub struct SubmitPresentBuilder<'a> {
        wait_semaphores: SmallVec<[vk::Semaphore; 8]>,
        swapchains: SmallVec<[vk::SwapchainKHR; 4]>,
        image_indices: SmallVec<[u32; 4]>,
        present_regions: SmallVec<[vk::PresentRegionKHR; 4]>,
        rect_layers: SmallVec<[vk::RectLayerKHR; 4]>,
        marker: PhantomData<&'a ()>,
    }

    impl<'a> SubmitPresentBuilder<'a> {
        /// Builds a new empty `SubmitPresentBuilder`.
        #[inline]
        pub fn new() -> SubmitPresentBuilder<'a> {
            SubmitPresentBuilder {
                wait_semaphores: SmallVec::new(),
                swapchains: SmallVec::new(),
                image_indices: SmallVec::new(),
                present_regions: SmallVec::new(),
                rect_layers: SmallVec::new(),
                marker: PhantomData,
            }
        }

        /// Adds a semaphore to be waited upon before the presents are executed.
        ///
        /// # Safety
        ///
        /// - If you submit this builder, the semaphore must be kept alive until you are guaranteed
        ///   that the GPU has presented the swapchains.
        ///
        /// - 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 swapchains and semaphores must all belong to the same device.
        ///
        #[inline]
        pub unsafe fn add_wait_semaphore(&mut self, semaphore: &'a Semaphore) {
            self.wait_semaphores.push(semaphore.internal_object());
        }

        /// Adds an image of a swapchain to be presented.
        ///
        /// Allows to specify a present region.
        /// Areas outside the present region *can* be ignored by the Vulkan implementation for
        /// optimizations purposes.
        ///
        /// If `VK_KHR_incremental_present` is not enabled, the `present_region` parameter is ignored.
        ///
        /// # Safety
        ///
        /// - If you submit this builder, the swapchain must be kept alive until you are
        ///   guaranteed that the GPU has finished presenting.
        ///
        /// - The swapchains and semaphores must all belong to the same device.
        ///
        #[inline]
        pub unsafe fn add_swapchain<W>(&mut self, swapchain: &'a Swapchain<W>, image_num: u32,
                                       present_region: Option<&'a PresentRegion>) {
            debug_assert!(image_num < swapchain.num_images());

            if swapchain
                .device()
                .loaded_extensions()
                .khr_incremental_present
            {
                let vk_present_region = match present_region {
                    Some(present_region) => {
                        assert!(present_region.is_compatible_with(swapchain));
                        for rectangle in &present_region.rectangles {
                            self.rect_layers.push(rectangle.to_vk());
                        }
                        vk::PresentRegionKHR {
                            rectangleCount: present_region.rectangles.len() as u32,
                            // Set this to null for now; in submit fill it with self.rect_layers
                            pRectangles: ptr::null(),
                        }
                    },
                    None => {
                        vk::PresentRegionKHR {
                            rectangleCount: 0,
                            pRectangles: ptr::null(),
                        }
                    },
                };
                self.present_regions.push(vk_present_region);
            }

            self.swapchains.push(swapchain.internal_object());
            self.image_indices.push(image_num);
        }

        /// Submits the command. Calls `vkQueuePresentKHR`.
        ///
        /// # Panic
        ///
        /// Panics if no swapchain image has been added to the builder.
        ///
        pub fn submit(mut self, queue: &Queue) -> Result<(), SubmitPresentError> {
            unsafe {
                debug_assert_eq!(self.swapchains.len(), self.image_indices.len());
                assert!(!self.swapchains.is_empty(),
                        "Tried to submit a present command without any swapchain");

                let present_regions = {
                    if !self.present_regions.is_empty() {
                        debug_assert!(queue.device().loaded_extensions().khr_incremental_present);
                        debug_assert_eq!(self.swapchains.len(), self.present_regions.len());
                        let mut current_index = 0;
                        for present_region in &mut self.present_regions {
                            present_region.pRectangles = self.rect_layers[current_index ..].as_ptr();
                            current_index += present_region.rectangleCount as usize;
                        }
                        Some(vk::PresentRegionsKHR {
                                 sType: vk::STRUCTURE_TYPE_PRESENT_REGIONS_KHR,
                                 pNext: ptr::null(),
                                 swapchainCount: self.present_regions.len() as u32,
                                 pRegions: self.present_regions.as_ptr(),
                             })
                    } else {
                        None
                    }
                };

                let mut results = vec![vk::SUCCESS; self.swapchains.len()];

                let vk = queue.device().pointers();
                let queue = queue.internal_object_guard();

                let infos = vk::PresentInfoKHR {
                    sType: vk::STRUCTURE_TYPE_PRESENT_INFO_KHR,
                    pNext: present_regions
                        .as_ref()
                        .map(|pr| pr as *const vk::PresentRegionsKHR as *const _)
                        .unwrap_or(ptr::null()),
                    waitSemaphoreCount: self.wait_semaphores.len() as u32,
                    pWaitSemaphores: self.wait_semaphores.as_ptr(),
                    swapchainCount: self.swapchains.len() as u32,
                    pSwapchains: self.swapchains.as_ptr(),
                    pImageIndices: self.image_indices.as_ptr(),
                    pResults: results.as_mut_ptr(),
                };

                check_errors(vk.QueuePresentKHR(*queue, &infos))?;

                for result in results {
                    check_errors(result)?;
                }

                Ok(())
            }
        }
    }

    impl<'a> fmt::Debug for SubmitPresentBuilder<'a> {
        fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
            fmt.debug_struct("SubmitPresentBuilder")
                .field("wait_semaphores", &self.wait_semaphores)
                .field("swapchains", &self.swapchains)
                .field("image_indices", &self.image_indices)
                .finish()
        }
    }

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

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

        /// The surface is no longer accessible and must be recreated.
        SurfaceLost,

        /// The surface has changed in a way that makes the swapchain unusable. You must query the
        /// surface's new properties and recreate a new swapchain if you want to continue drawing.
        OutOfDate,
    }

    impl error::Error for SubmitPresentError {
        #[inline]
        fn description(&self) -> &str {
            match *self {
                SubmitPresentError::OomError(_) => "not enough memory",
                SubmitPresentError::DeviceLost => "the connection to the device has been lost",
                SubmitPresentError::SurfaceLost => "the surface of this swapchain is no longer valid",
                SubmitPresentError::OutOfDate => "the swapchain needs to be recreated",
            }
        }

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

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

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

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

        #[test]
        fn no_swapchain_added() {
            let (_, queue) = gfx_dev_and_queue!();
            assert_should_panic!("Tried to submit a present command without any swapchain", {
                let _ = SubmitPresentBuilder::new().submit(&queue);
            });
        }
    }

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