Struct display_link::DisplayLink

pub struct DisplayLink(_);

DisplayLink is a timer object used to synchronize drawing with the refresh rate of the display.

Implementations

impl DisplayLink

pub fn new<F>(callback: F) -> Option<Self>where
    F: 'static + FnMut(Instant) + Send,

Creates a new DisplayLink with a callback that will be invoked with the Instant the screen will next refresh.

The returned DisplayLink will be in a paused state. Returns None if a DisplayLink could not be created.

Panic

If the callback panics, the process will be aborted.

pub fn is_paused(&self) -> bool

Returns true if the DisplayLink is currently paused.

pub fn pause(&mut self) -> Result<(), PauseError>

Pauses the DisplayLink.

A paused DisplayLink will not invoke it’s callback. On iOS, it is necessary to pause the DisplayLink in response to events like backgrounding.

pub fn resume(&mut self) -> Result<(), ResumeError>

Resumes the DisplayLink.

Trait Implementations

impl Debug for DisplayLink

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

Formats the value using the given formatter.