Struct Swapchain 

pub struct Swapchain { /* private fields */ }

the images a window shows, presented in turn

Implementations

impl Swapchain

pub fn rebuild(&mut self) -> Result<()>

(re)create the swapchain for the window’s size now; the old images may still be in use: waits for the queue to be idle (resizes are rare)

pub fn try_acquire(&mut self) -> Result<TryAcquire>

the next image to draw into, without waiting and without rebuilding (see TryAcquire)

pub fn acquire(&mut self) -> Result<Option<Frame>>

the next image to draw into; None while the window is minimised or has no area

pub fn view(&self, frame: &Frame) -> &TextureView

the frame’s image as a render target (Undefined at the start, Present at the end)

pub fn texture(&self, frame: &Frame) -> &Texture

the frame’s image (copies: SwapchainDesc::copy_src)

pub fn present<'a, I: IntoIterator<Item = CommandBuffer<'a>>>( &self, frame: Frame, cmds: I, ) -> Result<SubmitId>

submit the frame’s commands (they leave the image in Layout::Present) and show it

pub fn prepare(&mut self) -> Result<bool>

(Linux: the display has answered for the images; here nothing to wait for)

pub fn flush(&self) -> Result<bool>

(Linux: a frame reaches the window after the GPU finished it; here present has done that)

pub fn busy(&self) -> bool

(Linux: a frame is on its way to the window; here never)

pub fn next_look(&self, retry: u64) -> u64

when a frame that found NotReady should try again: retry (the caller’s time)

pub fn damage(&self, _rects: Option<&[[i32; 4]]>)

(Linux: what the next image changes, for the compositor; here the whole image counts)

pub fn resize(&mut self)

rebuild at the next acquire (the window’s size is also checked at every acquire)

pub fn set_present_mode(&mut self, m: PresentMode)

another present mode from the next acquire on (FIFO when the surface lacks it)

pub fn present_mode(&self) -> PresentMode

pub fn format(&self) -> Format

pub fn size(&self) -> (u32, u32)

the images’ size (0, 0 while the window has no area)

pub fn image_count(&self) -> usize

Trait Implementations

impl Drop for Swapchain

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.