Struct Painter 

pub struct Painter(/* private fields */);

A component’s line back to the view that paints it.

Component state that outlives a render — a hover fade, a gesture — has to name its view, because event-dispatch context cannot resolve one and the only alternative left is refreshing the whole window. Holding a Painter is what makes the two sanctioned frame requests reachable, and it is the one surface to review when asking who in the library can ask for a frame.

Implementations

impl Painter

pub fn of<T: 'static>(cx: &Context<'_, T>) -> Self

The view this render belongs to. Take it once, where the state is built, and keep it for as long as the state lives.

pub fn notify(self, cx: &mut App)

Redraw this view once.

pub fn lease(self, fps: f32, until: Duration, cx: &mut App)

Claim fps redraws a second, lapsing until from now unless something renews it. One timer serves the whole app: it wakes only when a view is owed a frame, notifies that view alone, and parks when the last claim lapses.

This is the drive for any repeating animation, yours included. gpui’s with_animation(…).repeat() asks the window for a frame at the display’s rate for as long as it stays mounted, and one such element is enough to hold the whole window there.

Renew it from render — that is what makes a claim self-cancelling, since an element that unmounts stops renewing and drops off. The rate is a per-view minimum of everything claiming it, so a 60fps claim never drags a 30fps one up with it.

pub fn woken(self, cx: &App) -> bool

Whether the clock is what asked for the render running now, rather than the app. True only in the render a tick provoked: the clock clears what this view is owed when it notifies, and the render’s own [lease] is what puts it back. Read it before renewing.

Trait Implementations

impl Clone for Painter

fn clone(&self) -> Painter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Painter

impl Debug for Painter

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

Formats the value using the given formatter.

impl Eq for Painter

impl From<EntityId> for Painter

fn from(view: EntityId) -> Self

Converts to this type from the input type.

impl From<Painter> for EntityId

fn from(painter: Painter) -> Self

Converts to this type from the input type.

impl Hash for Painter

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Painter

fn eq(&self, other: &Painter) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Painter