nordic-dev.net/vulkano
nordic-dev.net/vulkano
2
0
Fork 0
mirror of https://github.com/vulkano-rs/vulkano.git synced 2024-11-25 16:25:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix warning when running cargo doc (#1016)

Browse Source
This commit is contained in:
Lucas Kent 2018-08-11 20:50:31 +10:00 committed by GitHub
parent d80d5a6791
commit ef8bbecc5e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
vulkano/src/swapchain/mod.rs
View File

@ -219,7 +219,7 @@
//! //!
//! ## Acquiring and presenting images //! ## Acquiring and presenting images
//! //!
//! Once you created a swapchain and retreived all the images that belong to it (see previous //! Once you created a swapchain and retrieved all the images that belong to it (see previous
//! section), you can draw on it. This is done in three steps: //! section), you can draw on it. This is done in three steps:
//! //!
//! - Call `swapchain::acquire_next_image`. This function will return the index of the image //! - Call `swapchain::acquire_next_image`. This function will return the index of the image
@ -232,12 +232,25 @@
//! the implementation that you are finished drawing to the image and that it can queue a //! the implementation that you are finished drawing to the image and that it can queue a
//! command to present the image on the screen after the draw operations are finished. //! command to present the image on the screen after the draw operations are finished.
//! //!
//! TODO: add example here //! ```
//! use vulkano::swapchain;
//! use vulkano::sync::GpuFuture;
//! # let queue: ::std::sync::Arc<::vulkano::device::Queue> = return;
//! # let mut swapchain: ::std::sync::Arc<swapchain::Swapchain<()>> = return;
//! // let mut (swapchain, images) = Swapchain::new(...);
//! loop { //! loop {
//! let index = swapchain::acquire_next_image(None).unwrap(); //! # let mut command_buffer: ::vulkano::command_buffer::AutoCommandBuffer<()> = return;
//! draw(images[index]); //! let (image_num, acquire_future)
//! swapchain::present(queue, index).unwrap(); //! = swapchain::acquire_next_image(swapchain.clone(), None).unwrap();
//!
//! // The command_buffer contains the draw commands that modify the framebuffer
//! // constructed from images[image_num]
//! acquire_future
//! .then_execute(queue.clone(), command_buffer).unwrap()
//! .then_swapchain_present(queue.clone(), swapchain.clone(), image_num)
//! .then_signal_fence_and_flush().unwrap();
//! } //! }
//! ```
//! //!
//! ## Recreating a swapchain //! ## Recreating a swapchain
//! //!
@ -253,7 +266,6 @@
//! TODO: suboptimal stuff //! TODO: suboptimal stuff
//! //!
//! ``` //! ```
//! # use std::time::Duration;
//! use vulkano::swapchain; //! use vulkano::swapchain;
//! use vulkano::swapchain::AcquireError; //! use vulkano::swapchain::AcquireError;
//! use vulkano::sync::GpuFuture; //! use vulkano::sync::GpuFuture;
@ -282,9 +294,7 @@
//! let final_future = acq_future //! let final_future = acq_future
//! // .then_execute(...) //! // .then_execute(...)
//! .then_swapchain_present(queue.clone(), swapchain.clone(), index) //! .then_swapchain_present(queue.clone(), swapchain.clone(), index)
//! .then_signal_fence(); //! .then_signal_fence_and_flush().unwrap(); // TODO: PresentError?
//!
//! final_future.flush().unwrap(); // TODO: PresentError?
//! } //! }
//! ``` //! ```
//! //!