Struct rendy_frame::Frames

pub struct Frames<B: Backend> { /* fields omitted */ }

Timeline of frames, complete, pending and next.

Methods

impl<B> Frames<B> where
    B: Backend, 

pub fn new() -> Self

Create new Frames instance.

pub fn next(&self) -> Frame

Get next frame reference.

pub fn advance(&mut self, fences: Fences<B>)

Advance to the next frame. All fences of the next frame must be queued.

pub fn complete_upper_bound(&self) -> u64

Get upper bound of complete frames. All frames with index less than result of this function are complete.

pub fn is_complete(&self, frame: Frame) -> bool

Check if given frame is.

pub fn complete(&self, frame: Frame) -> Option<CompleteFrame>

Check if frame with specified index is complete.

pub fn wait_complete(
    &mut self,
    target: Frame,
    factory: &Factory<B>,
    free: impl FnMut(Fences<B>)
) -> CompleteFrame

Wait for completion of the frames until specified (inclusive) Returns proof.

Parameters

target - frame that must complete. factory - The factory.

Panics

This function will panic if target is greater than or equal to next frame.

pub fn dispose(self, factory: &mut Factory<B>)

Dispose of the Frames

pub fn range(&self) -> FramesRange

Get range of frame indices in this form: upper bound of finished frames .. next frame.

Trait Implementations

impl<B: Debug + Backend> Debug for Frames<B>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.