Skip to main content

PaintOutcome

Struct PaintOutcome 

Source
pub struct PaintOutcome {
    pub needs_frame: bool,
    pub needs_layout: bool,
    pub needs_frame_paced_only: bool,
    pub paced_interval: Option<Duration>,
    pub paint_serial: u64,
}
Expand description

The result of a whole crate::app::RenderRoot::paint pass.

needs_frame is whether any widget advanced animation state during paint and asked (via PaintCtx::request_frame) to be re-invoked to continue. The shell turns it into another scheduled frame — the desktop shell via window.request_redraw(), the mobile shells implicitly through their continuous loop. Mirrors crate::event::EventOutcome’s needs_redraw.

needs_layout is whether any widget asked (via PaintCtx::request_layout) to have layout re-run next frame because its animation changed its layout, not just its paint. crate::app::RenderRoot::paint folds it into the render root’s pending crate::view::ChangeFlags (LAYOUT) so the next frame’s take_change_flags().needs_layout() reports it — driving the mobile intra-frame layout skip to relayout while the animation is in flight.

needs_frame_paced_only is the aggregated TickClass verdict: true only when a frame was requested and every request this frame was TickClass::CosmeticLoop (a pacable decorative loop), false the instant any TickClass::Transition request (including any request_layout) joined in. The mobile frame gate may throttle such a purely-cosmetic frame to a lower cadence; a false here means the frame runs every vsync as today. Only meaningful when needs_frame is true.

paced_interval is how fast that paced frame asked to be re-run: the MIN over every paced request this pass (see PaintCtx::request_frame_paced_at). Only meaningful alongside needs_frame_paced_only.

Fields§

§needs_frame: bool

Whether the shell should schedule another frame to continue an animation.

§needs_layout: bool

Whether the render root folded a layout-continuation request into its pending change flags (a widget called PaintCtx::request_layout). The root also folds LAYOUT for a pod an unpaced frame request or a trailing landing paint dirtied; that fold is not reported here.

§needs_frame_paced_only: bool

Whether a frame was requested and every request this frame was TickClass::CosmeticLoop — the paced-only state the mobile frame gate may throttle (see PaintCtx::needs_frame_paced_only). Meaningful only when needs_frame is set.

§paced_interval: Option<Duration>

The tightest (MIN) interval any paced request this frame named — see PaintCtx::paced_interval. None (no paced request) and Some(Duration::ZERO) (a bare PaintCtx::request_frame_paced) both mean “the theme’s own cosmetic_loop_rate”; a longer value asks the gate to pace this loop slower than that cap. Meaningful only alongside needs_frame_paced_only; a shell latches it beside that flag and hands it to the frame gate, which resolves it against the live theme’s cap.

§paint_serial: u64

The serial the render root minted for this paint (PaintCtx::paint_serial): 1 for a root’s first paint, one more for each paint after it. A shell carries it with the painted scene and hands it to the renderer before encoding that scene, so the resident-key ledger the renderer publishes names the last scene it committed (see crate::retained). 0 only from a Default outcome.

Trait Implementations§

Source§

impl Clone for PaintOutcome

Source§

fn clone(&self) -> PaintOutcome

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for PaintOutcome

Source§

impl Debug for PaintOutcome

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PaintOutcome

Source§

fn default() -> PaintOutcome

Returns the “default value” for a type. Read more
Source§

impl Eq for PaintOutcome

Source§

impl PartialEq for PaintOutcome

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PaintOutcome

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Brush for T
where T: Clone + PartialEq + Default + Debug,

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more