Struct AnimationsActive 

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

Per-tick flag raised by animation drivers (hover / press tweens, opacity transitions, scroll inertia) while a value is still in motion.

Read by the window backend right after App::tick() to self-schedule a follow-up frame (RedrawScheduler.pending = true) so an in-flight animation keeps advancing without waiting for an unrelated OS event. Without this, the first tween frame paints and then the loop parks - the animation freezes mid-way until the next mouse move.

Any other driver that finishes a tick with work still in flight raises it the same way, for the same reason: a parked loop runs no system, so work that completes off the frame (a background decode, a reply a later tick has to deliver) needs the next tick scheduled or it lands nowhere.

Idle-quiescence contract: the flag is stored in an AtomicBool so several parallel animation systems can raise it via &Res without serialising. reset_animations_active clears it at the start of every tick (TickStage::Input, which is chained before TickStage::Systems where the drivers run), and each driver re-raises it only while it still has work left (progress strictly short of its target, non-zero velocity, an element still without the content it named). A driver keys its claim on something in the world rather than on its own bookkeeping, so the claim dies with that thing even when the work behind it never finishes. The moment every driver settles, none raises it, the flag stays false, and the scheduler parks - so there is no permanent vsync spin.

Implementations

impl AnimationsActive

pub fn request(&self)

Raise the flag: at least one animation still has motion this tick. Interior-mutable so animation systems can take a shared Res.

pub fn get(&self) -> bool

Read the current flag without clearing it. The window backend calls this after the tick to decide whether to re-arm the redraw.

pub fn clear(&self)

Clear the flag. Called by reset_animations_active at tick start.

Trait Implementations

impl Component for AnimationsActive

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::SparseSet

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns [ComponentRelationshipAccessor] required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add [ComponentHook] for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert [ComponentHook] for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard [ComponentHook] for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove [ComponentHook] for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn [ComponentHook] for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Debug for AnimationsActive

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

Formats the value using the given formatter.

impl Default for AnimationsActive

fn default() -> AnimationsActive

Returns the “default value” for a type.

impl Resource for AnimationsActive

where Self: Send + Sync + 'static,