oxframe_core/
lib.rs

1//! Core of oxframe: signals, tweens, easing and a deterministic,
2//! single-threaded coroutine executor.
3//!
4//! > **Status:** oxframe is under very active development. The API is not stable yet and
5//! > may change from version to version. Pin the exact version in your Cargo.toml and check
6//! > the [changelog](https://github.com/oxygenframe/oxframe-sdk/blob/main/CHANGELOG.md)
7//! > before upgrading.
8//!
9//! An animation is an `async fn`; every `.await` on a [`Tween`],
10//! [`wait_for`] or [`next_frame`] is a frame boundary. One poll of the root
11//! future is exactly one frame, with a fixed `dt = 1 / fps`.
12
13#![warn(missing_docs)]
14
15mod color;
16mod ease;
17mod executor;
18mod flow;
19mod frame;
20mod lerp;
21mod paint;
22mod path;
23mod runtime;
24mod signal;
25mod slides;
26mod sound;
27mod transition;
28mod tween;
29
30pub use color::Color;
31pub use ease::{CubicBezier, Ease, presets};
32pub use ease::{bounce_in, bounce_in_out, bounce_out, elastic_in, elastic_in_out, elastic_out};
33pub use executor::Executor;
34#[allow(deprecated)]
35pub use flow::all_vec;
36pub use flow::{
37    All, Animation, Any, BoxFuture, Branches, Delayed, IntoAll, JoinHandle, VecBranches, WaitFor,
38    all, any, loop_while, next_frame, repeat, sequence, spawn, stagger, wait_for, wait_until,
39};
40pub use frame::{FrameSource, Image};
41pub use lerp::{Lerp, Transform};
42pub use paint::{BlendMode, Gradient, GradientKind};
43pub use runtime::{
44    SeededRng, begin_transition, dt, ease_named, fps, frame, has_previous, meta_snapshot, now,
45    random, random_range, time, tunable, with_rng,
46};
47pub use transition::{Blend, Dir, Kind, LayerPose, Recorded, ShaderTransition};
48
49pub use rand;
50pub use signal::Signal;
51pub use slides::{SlideMark, notes, slide_break};
52pub use sound::{SoundClip, VoiceLine, end_sound, record_sound, record_voice};
53pub use tween::{Seconds, Tween};
54
55pub use kurbo::{self, Affine, BezPath, Point, Vec2};
56
57/// Times are compared with this tolerance so that sums of `f64` seconds
58/// (`0.1 + 0.2`) land on the frame they were meant for.
59pub const TIME_EPSILON: f64 = 1e-9;
oxframe_core/lib.rs

oxframe_core/
lib.rs
