Full API Map

This file lists the stable v1.7.2 API surface by crate. For signatures, generic bounds, and exhaustive docs, use cargo doc --workspace --all-features or docs.rs/animato.

Install the facade:

[dependencies]
animato = "1.7.2"

animato-core

Purpose: foundational traits, interpolation, easing, and portable math.

Feature requirements: no facade feature required for the core re-exports.

Stable public items:

Item	Purpose
`Interpolate`	Implement `lerp(&self, other, t)` for custom values.
`Animatable`	Blanket marker for `Interpolate + Clone + 'static`.
`Update`	Advance state by `dt` seconds.
`Playable`	Object-safe animation abstraction for composition.
`Inspectable`	Object-safe runtime inspection abstraction for DevTools.
`AnimationKind`, `PlaybackState`, `AnimationIntrospection`	Shared inspection state model.
`Easing`	38 named and parameterized easing variants plus `Custom`.
`easing::*`	Free easing functions such as `ease_out_cubic`.
`Angle`	Shortest-path angle interpolation.
`Quaternion`	Unit quaternion slerp for 3D rotations.
`Mat4`	Affine transform interpolation by translation, rotation, and scale.
`Color`	Lightweight linear RGBA interpolation wrapper.

Example:

use animato::{Interpolate, Tween, Update};

#[derive(Clone)]
struct Size(f32);

impl Interpolate for Size {
    fn lerp(&self, other: &Self, t: f32) -> Self {
        Self(self.0 + (other.0 - self.0) * t)
    }
}

let mut tween = Tween::new(Size(10.0), Size(20.0)).duration(1.0).build();
tween.update(0.5);
assert_eq!(tween.value().0, 15.0);

animato-tween

Feature: tween.

Stable public items:

Item	Purpose
`Tween<T>`	Single-value animation.
`TweenBuilder<T>`	Consuming builder returned by `Tween::new`.
`TweenState`	`Idle`, `Running`, `Paused`, `Completed`.
`TweenSnapshot`	Batch-friendly read-only state view.
`Loop`	`Once`, `Times`, `Forever`, `PingPong`, `PingPongTimes`.
`Keyframe<T>`	A timed value with easing to the next frame.
`KeyframeTrack<T>`	Multi-stop animation track.
`Waveform`	Procedural sine, sawtooth, square, triangle, and noise values.
`StaggerPattern`, `GridOrigin`	Deterministic stagger delay calculations.
`snap_to`	Snap a numeric value to a grid.
`round_to`	Round a numeric value to decimal places.

Example:

use animato::{Easing, Loop, Tween, Update};

let mut tween = Tween::new(0.0_f32, 100.0)
    .duration(1.0)
    .easing(Easing::EaseInOutSine)
    .looping(Loop::PingPongTimes(2))
    .build();

tween.update(0.5);
assert!(tween.value() > 0.0);

animato-timeline

Feature: timeline.

Stable public items:

Item	Purpose
`Timeline`	Concurrent animation composition.
`TimelineState`	Playback state.
`At`	Entry placement: start, end, label, offset, absolute.
`Sequence`	Sequential timeline builder.
`AnimationGroup`	Parallel, sequence, and stagger groups as one `Playable`.
`stagger`	Build offset starts for a collection of animations.

Example:

use animato::{At, Timeline, Tween, Update};

let fade = Tween::new(0.0_f32, 1.0).duration(1.0).build();
let slide = Tween::new(0.0_f32, 100.0).duration(1.0).build();

let mut timeline = Timeline::new()
    .add("fade", fade, At::Start)
    .add("slide", slide, At::Label("fade"));

timeline.play();
timeline.update(0.5);
assert_eq!(timeline.get::<Tween<f32>>("slide").unwrap().value(), 50.0);

animato-spring

Feature: spring.

Stable public items:

Item	Purpose
`Spring`	One-dimensional damped spring.
`SpringN<T>`	Component spring for decomposable values.
`SpringConfig`	Stiffness, damping, mass, epsilon presets.
`Integrator`	Semi-implicit Euler or RK4.
`Decompose`	Sealed component decomposition trait.
`Spring::from_velocity`	Start from release velocity for fling-to-snap motion.
`Spring::energy`, `Spring::overshoot_count`	Diagnostics for advanced spring motion.

Example:

use animato::{Spring, SpringConfig, Update};

let mut spring = Spring::new(SpringConfig::snappy());
spring.set_target(1.0);
while spring.update(1.0 / 60.0) {}
assert!(spring.is_settled());

animato-path

Feature: path.

Stable public items:

Item	Purpose
`PathEvaluate`	Position, tangent, rotation, length.
`QuadBezier`, `CubicBezierCurve`	Bezier path primitives.
`CatmullRomSpline`, `PolyPath`	Smooth point paths.
`LineSegment`, `EllipticalArc`, `PathSegment`	Compound path segments.
`PathCommand`, `SvgPathParser`, `SvgPathError`	SVG path parser.
`MotionPath`, `MotionPathTween`, `MotionPathTweenBuilder`	Path animation.
`MorphPath`, `resample`	Shape morphing.
`DrawSvg`, `DrawValues`	Stroke draw animation values.

Example:

use animato::{CubicBezierCurve, MotionPathTween, Update};

let curve = CubicBezierCurve::new([0.0, 0.0], [50.0, 100.0], [150.0, -100.0], [200.0, 0.0]);
let mut motion = MotionPathTween::new(curve).duration(1.0).build();
motion.update(0.5);
let [x, _y] = motion.value();
assert!(x > 0.0);

animato-physics

Feature: physics.

Stable public items:

Item	Purpose
`Inertia`, `InertiaN<T>`	Friction deceleration after input.
`InertiaConfig`, `InertiaBounds`	Inertia tuning and bounds.
`PointerData`	Pointer sample.
`DragAxis`, `DragConstraints`, `DragState`	Drag tracking and release velocity.
`GestureConfig`, `GestureRecognizer`, `Gesture`, `SwipeDirection`	Gesture recognition.

Example:

use animato::{Inertia, InertiaConfig, Update};

let mut inertia = Inertia::new(InertiaConfig::smooth());
inertia.kick(400.0);
inertia.update(1.0 / 60.0);
assert!(inertia.position() > 0.0);

animato-color

Feature: color.

Stable public items:

Item	Purpose
`InLab<C>`	Interpolate through CIE Lab.
`InOklch<C>`	Interpolate through Oklch.
`InLinear<C>`	Interpolate in linear light.
`palette`	Re-export of the `palette` crate.

Example:

use animato::{palette::Srgb, InLab, Tween, Update};

let mut tween = Tween::new(
    InLab::new(Srgb::new(1.0, 0.0, 0.0)),
    InLab::new(Srgb::new(0.0, 0.0, 1.0)),
)
.duration(1.0)
.build();
tween.update(0.5);
let midpoint = tween.value().into_inner();
assert!(midpoint.red > 0.0 || midpoint.blue > 0.0);

animato-driver

Feature: driver.

Stable public items:

Item	Purpose
`AnimationDriver`, `AnimationId`	Own and tick many `Update` values.
`DriverSnapshot`, `DriverFrameProfile`, `AnimationUpdateCost`	DevTools snapshot and profiling data.
`Clock`	Abstract source of frame delta.
`WallClock`, `ManualClock`, `MockClock`	Hosted, manual, and test clocks.
`ScrollDriver`, `ScrollClock`	Drive animations from scroll position.
`AnimationRecorder`, `RecordedTrack`, `RecordedSample`	Capture and replay scalar frame values.
`RecorderError`	JSON/binary import errors.

Example:

use animato::{AnimationDriver, Easing, Tween};

let mut driver = AnimationDriver::new();
let id = driver.add(Tween::new(0.0_f32, 1.0).duration(1.0).easing(Easing::Linear).build());
driver.tick(1.0);
assert!(!driver.is_active(id));

Inspectable animations can be registered for DevTools:

use animato::{AnimationDriver, Tween};

let mut driver = AnimationDriver::new();
driver.add_inspectable("opacity", Tween::new(0.0_f32, 1.0).duration(1.0).build());
driver.tick(0.5);
assert_eq!(driver.snapshots().len(), 1);

animato-gpu

Feature: gpu.

Stable public items:

Item	Purpose
`GpuAnimationBatch`	Batch `Tween<f32>` values.
`GpuBackend`	Active backend, GPU or CPU fallback.
`GpuBatchError`	GPU initialization and dispatch errors.

Example:

use animato::{GpuAnimationBatch, Tween};

let mut batch = GpuAnimationBatch::new_cpu();
batch.push(Tween::new(0.0_f32, 1.0).duration(1.0).build());
batch.tick(0.5);
assert_eq!(batch.read_back().len(), 1);

animato-bevy

Feature: bevy.

Stable public items include AnimatoPlugin, AnimatoTween<T>, AnimatoSpring<T>, AnimationChannel, AnimationLabel, TweenCompleted, SpringSettled, AnimatoTweenPlugin<T>, AnimatoSpringPlugin<T>, and AnimatoSet.

Use bevy.md for complete setup because examples require Bevy's app runtime and transform components.

animato-wasm

Features: wasm, optional wasm-dom.

Stable public items include RafDriver, ScrollSmoother, and with wasm-dom: FlipState, FlipAnimation, LayoutAnimator, SharedElementTransition, SplitText, SplitMode, Draggable, Observer, and ObserverEvent.

Use wasm.md for browser setup.

animato-leptos

Features: leptos, plus one app mode feature such as leptos-csr, leptos-hydrate, or leptos-ssr.

Stable public items include use_tween, use_spring, use_timeline, use_keyframes, TweenHandle, SpringHandle, TimelineHandle, KeyframeHandle, use_scroll_progress, use_scroll_trigger, use_scroll_velocity, SmoothScroll, AnimatePresence, PresenceAnimation, PageTransition, TransitionMode, AnimatedFor, use_drag, use_gesture, use_pinch, use_swipe, AnimatedStyle, css_tween, css_spring, is_hydrating, use_client_only, and SsrFallback.

AnimatedFor accepts move_duration, move_easing, move_delay, stagger_delay, gap, and item_class in addition to enter and exit presence configuration. In v1.7.2, removed keyed rows remain mounted until the configured exit duration and stagger complete; surviving rows then run their FLIP movement.

Use leptos.md for app setup and examples.

animato-dioxus

Features: dioxus, plus renderer-specific helpers such as dioxus-web, dioxus-desktop, dioxus-router, or dioxus-native.

The facade re-exports these at the crate root when dioxus is enabled by itself. If another framework integration is also enabled, use animato::dioxus::* for the Dioxus namespace.

Stable public items include use_tween, use_spring, use_timeline, use_keyframes, TweenHandle, SpringHandle, TimelineHandle, KeyframeHandle, use_motion, MotionHandle, MotionConfig, AnimatedStyle, css_tween, css_spring, AnimatePresence, PresenceAnimation, PageTransition, TransitionMode, AnimatedFor, use_scroll_progress, use_scroll_trigger, use_scroll_velocity, use_drag, use_gesture, use_pinch, use_swipe, PlatformAdapter, AnimationBackend, use_window_animation, use_window_spring, and WindowAnimationHandle.

Use dioxus.md for app setup, renderer features, and examples.

animato-yew

Features: yew, plus one app mode feature such as yew-csr, yew-hydration, or yew-ssr. Agent coordination is behind yew-agent.

The facade re-exports these at the crate root when yew is enabled by itself. If another framework integration is also enabled, use animato::yew::*.

Stable public items include use_tween, use_spring, use_timeline, use_keyframes, TweenHandle, SpringHandle, TimelineHandle, KeyframeHandle, AnimatedStyle, use_css_tween, use_css_spring, css_tween, css_spring, use_scroll_progress, use_scroll_trigger, use_scroll_velocity, SmoothScroll, PresenceAnimation, AnimatePresence, TransitionMode, PageTransition, use_route_transition_key, route_transition_key, AnimatedFor, AnimatedForProps, stable_key, DragConfig, DragHandle, PinchHandle, SwipeConfig, SwipeEvent, use_drag, use_gesture, use_pinch, use_swipe, AnimationAgent, AnimationAgentHandle, AgentTweenSpec, AgentSpringSpec, AgentInput, AgentOutput, and use_animation_agent.

Use yew.md for app setup and examples.

animato-devtools

Feature: devtools, with optional panel features devtools-web-panel, devtools-egui-panel, and devtools-tui-panel.

Stable public items:

Item	Purpose
`TimelineInspector`, `AnimationSnapshot`	Capture active inspectable animations from `AnimationDriver`.
`EasingCurveEditor`	Generate easing samples, compare curves, and edit cubic-bezier points.
`SpringVisualizer`, `SpringFrame`	Simulate springs and expose position/velocity history.
`RecorderControls`	Start, stop, clear, export, import, and replay recordings.
`PerformanceMonitor`, `AnimationCostRecord`	Rolling FPS, frame budget, and per-animation update costs.
`DevToolsState`	Shared visibility/state model for panel adapters.
`DevToolsWebPanel`, `DevToolsEguiPanel`, `DevToolsTuiPanel`	Optional panel adapters.

Example:

use animato::{AnimationDriver, TimelineInspector, Tween};

let mut driver = AnimationDriver::new();
driver.add_inspectable("fade", Tween::new(0.0_f32, 1.0).duration(1.0).build());
driver.tick(0.25);

let mut inspector = TimelineInspector::new();
inspector.capture(&driver);
assert_eq!(inspector.snapshots().len(), 1);

Use devtools.md for setup and examples.

animato-js

Feature: js on the Rust facade; JavaScript apps install @aarambhdevhub/animato-core.

Stable JavaScript exports include Tween, Tween2D, Tween3D, Tween4D, KeyframeTrack, KeyframeTrack2D, KeyframeTrack3D, KeyframeTrack4D, Spring, Spring2D, Spring3D, Spring4D, Timeline, RafDriver, ScrollDriver, MotionPath, MorphPath, Inertia, Inertia2D, DragState, GestureRecognizer, ColorTween, ScrollSmoother, FlipAnimation, LayoutAnimator, SplitText, Draggable, Observer, and TweenBatch, Angle, Quaternion, Mat4, AngleTween, QuaternionTween, Mat4Tween, Waveform, StaggerPattern, AnimationGroup, AnimationRecorder, TimelineInspector, EasingCurveEditor, SpringVisualizer, PerformanceMonitor, and DevToolsState.

Utility exports include version, initAnimato, availableEasings, ease, parseEasing, snapTo, roundTo, and interpolateColor.

Example:

import init, { Tween, RafDriver } from "@aarambhdevhub/animato-core";

await init();

const tween = new Tween(0, 100, 0.5);
tween.setEasing("easeOutCubic");

const driver = new RafDriver();
driver.addTween(tween);
driver.tick(16.67);

Use javascript.md for package setup and examples.

Navigation Menu

Uh oh!

Full API Map

animato-core

animato-tween

animato-timeline

animato-spring

animato-path

animato-physics

animato-color

animato-driver

animato-gpu

animato-bevy

animato-wasm

animato-leptos

animato-dioxus

animato-yew

animato-devtools

animato-js

Related Docs

Uh oh!

FilesExpand file tree

api-full.md

Latest commit

History

api-full.md

File metadata and controls

Full API Map

animato-core

animato-tween

animato-timeline

animato-spring

animato-path

animato-physics

animato-color

animato-driver

animato-gpu

animato-bevy

animato-wasm

animato-leptos

animato-dioxus

animato-yew

animato-devtools

animato-js

Related Docs