Struct Swapchain 

pub struct Swapchain { /* private fields */ }

the images a window shows, presented in turn

Implementations

impl Swapchain

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

the images for the size the window has now, without waiting (any thread)

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

the frame on its way: finished by the GPU -> it goes to the window; -> still on its way

pub fn busy(&self) -> bool

a frame is on its way to the window: flush soon

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

when a frame that found NotReady should try again: soon when the GPU is drawing; when the display’s answer is overdue if it has not given it (the answer itself ends the wait earlier); else retry, the caller’s time

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

the images to the display, its answer there (the window loop’s thread)

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

what the next presented image changes against the last one: rectangles x, y, w, h (None: all)

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, rebuilt when stale; waits (the display is pumped, events stay queued); 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); it goes to the window when the GPU has finished it (flush)

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

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

pub fn drm_format(&self) -> (u32, u64)

the images’ DRM format and modifier (tests, traces)

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.