Skip to main content

Swapchain

Trait Swapchain 

Source
pub trait Swapchain: VkHandle<Handle = VkSwapchainKHR> + DeviceChild {
    // Provided methods
    fn acquire_next(
        &mut self,
        timeout: Option<u64>,
        completion: CompletionHandlerMut<'_>,
    ) -> Result<u32> { ... }
    fn acquire_full_screen_exclusive_mode(&self) -> Result<()>
       where Self::ConcreteDevice: DeviceFullScreenExclusiveExtension { ... }
    fn release_full_screen_exclusive_mode(&self) -> Result<()>
       where Self::ConcreteDevice: DeviceFullScreenExclusiveExtension { ... }
    fn image_count(&self) -> Result<u32> { ... }
    fn images(
        &self,
        sink: &mut [MaybeUninit<VkImage>],
    ) -> Result<(u32, ArrayQueryResult)> { ... }
}

Provided Methods§

Source

fn acquire_next( &mut self, timeout: Option<u64>, completion: CompletionHandlerMut<'_>, ) -> Result<u32>

Available on crate feature Implements only.

Retrieve the index of the next available presentation image

§Failures

On failure, this command returns

  • VK_ERROR_OUT_OF_HOST_MEMORY
  • VK_ERROR_OUT_OF_DEVICE_MEMORY
  • VK_ERROR_DEVICE_LOST
  • VK_ERROR_OUT_OF_DATE_KHR
  • VK_ERROR_SURFACE_LOST_KHR
Source

fn acquire_full_screen_exclusive_mode(&self) -> Result<()>

Available on crate features Implements and VK_EXT_full_screen_exclusive only.

Acquire full-screen exclusive mode for a swapchain.

§Failures

On failure, this command returns

  • VK_ERROR_OUT_OF_HOST_MEMORY
  • VK_ERROR_OUT_OF_DEVICE_MEMORY
  • VK_ERROR_INITIALIZATION_FAILED
  • VK_ERROR_SURFACE_LOST_KHR
Source

fn release_full_screen_exclusive_mode(&self) -> Result<()>

Available on crate features Implements and VK_EXT_full_screen_exclusive only.

Release full-screen exclusive mode from a swapchain.

Source

fn image_count(&self) -> Result<u32>

Available on crate feature Implements only.

Obtain a count of the array of presentable images associated with a swapchain

§Failures

On failure, this command returns

Source

fn images( &self, sink: &mut [MaybeUninit<VkImage>], ) -> Result<(u32, ArrayQueryResult)>

Available on crate feature Implements only.

Obtain the array of presentable images associated with a swapchain

§Failures

On failure, this command returns

Implementations on Foreign Types§

Source§

impl<'s, T> Swapchain for &'s T
where T: Swapchain + ?Sized,

Source§

impl<'s, T> Swapchain for &'s mut T
where T: Swapchain + ?Sized,

Source§

impl<T> Swapchain for Box<T>
where T: Swapchain + ?Sized,

Source§

impl<T> Swapchain for Rc<T>
where T: Swapchain + ?Sized,

Source§

impl<T> Swapchain for Arc<T>
where T: Swapchain + ?Sized,

Source§

impl<T> Swapchain for ManuallyDrop<T>
where T: Swapchain,

Implementors§

Source§

impl<Device, Surface> Swapchain for SurfaceSwapchainObject<Device, Surface>
where Device: Device, Surface: VkHandle<Handle = VkSurfaceKHR>,