Struct BrowserRenderTimer 

pub struct BrowserRenderTimer { /* private fields */ }

A render timer that ticks with the animation frames of the thread it is started on: the page, or the worker of a render thread.

Implementations

impl BrowserRenderTimer

pub fn new(is_background: bool) -> Arc<Self>

Creates the timer. is_background tells whether its ticks arrive on a thread other than the UI thread: such a timer is started by the thread that renders, with start_on_this_thread.

pub fn start_on_this_thread(&self)

Starts following the animation frames on the current thread. Does nothing when the timer is started already.

The thread has to live for as long as the timer is used: its frames arrive at the event loop of its worker, and so does a tick out of turn.

Trait Implementations

impl IRenderTimer for BrowserRenderTimer

fn request_tick_out_of_turn(&self)

Queues one tick for the thread the timer was started on, which runs it from its event loop without waiting for its next animation frame. Requests made before that tick has started are one request. The timestamp of the tick is read from the clock of the animation frames of that thread.

A request made to a background timer that is not started yet is kept: the thread that starts the timer ticks once when it does. (The thread of the page asks before it waits for a frame, and the render thread it started a moment ago may not have got that far.)

Does nothing when the caller is the thread that ticks (it cannot be waiting for itself), while no callback is set, and in a build without threads.

fn tick(&self) -> Option<RenderTimerTick>

Gets the callback to be invoked when the timer ticks.

fn set_tick(&self, value: Option<RenderTimerTick>)

Sets the callback to be invoked when the timer ticks.

fn runs_in_background(&self) -> bool

Indicates if the timer ticks on a non-UI thread.