Expand description
Pure, deterministic timeline evaluation.
Modules§
- edit
- The edit operations
remove_ranges,split_atandbake, which apply data to a project once.
Structs§
- Active
Audio Clip - One audio clip overlapping an evaluated timeline span.
- Active
Caption - The cue one caption track shows at a timestamp.
- Active
Clip - A visible or audible clip mapped to its source timestamp.
- Active
Composition - A clip’s composition at one timeline timestamp.
- Active
Effect - One effect invocation at one timestamp (timeline time for transitions, composition time for composition steps).
- Active
Index - A precomputed interval index for a validated project snapshot.
- Active
Transition - A transition evaluated at one timeline timestamp.
- Audio
Span - The clips of one span, read from an
AudioSpanScratchwithout copying. - Audio
Span Desc - Audio activity over one half-open timeline span.
- Audio
Span Scratch - Reusable working memory for
evaluate_audio_in. - Composition
Plan - A composition’s output, drawn by steps in dependency order.
- Correction
- A similarity of a clip’s picture, sampled from a correction’s data set.
- Data
Index - Data sets and clips by id, with each set’s displayed picture size.
- Effect
Param Value - One effect parameter’s value at a timeline timestamp.
- Evaluated
Layout - A layout tree with every value sampled.
- Evaluated
Node - One box with its values sampled. Lengths are fractions of the picture’s shorter side.
- Evaluated
Text - A text node’s sampled text and the style it inherits.
- Evaluated
Visual - Visual properties evaluated at one timeline timestamp.
- Frame
Desc - A timestamp-specific composition description with no GPU handles.
- Frame
Need - A source-frame request emitted for host prefetch and decode scheduling.
- Layout
Plan - A layout tree, evaluated once when it does not animate.
- Node
Layout - A box’s sampled box-model, flex and grid values. Lengths are fractions or percents.
- Node
Paint - What a box draws under its content.
- Node
Visual - How a box and its subtree are drawn after layout.
- Sample
Context - What a sampled value reads data through, the project’s data sets and the clock of its place.
- Sampled
Animator - An animator’s selector and properties at one time.
- Shapes
Plan - A content tree with its static parts evaluated once.
- Sides
- A length on each side of a box, as a fraction of the picture’s shorter side.
- Source
Read - One reader of a source over an export range (
ActiveIndex::source_reads). - Step
- One node of a composition, with its inputs resolved to earlier steps.
- Step
Layer - One layer of a
StepOp::Merge.
Enums§
- Eval
Error - An evaluator failure.
- Generator
Plan - A shapes or layout generator’s tree, planned once. Other generators need none.
- Node
Content - A box’s content.
- Plan
Error - Why a composition’s output cannot be drawn.
- Sampled
Selector - A selector at one time.
- StepOp
- The operation of a
Step. Inputs are indices of earlier steps.
Constants§
- MAX_
PLAN_ BYTES - Most bytes all compiled composition plans of one project may hold together, estimated per
Step(node path plus settings heap). Past this none draws (PlanError::TooLarge).
Functions§
- bound_
kind - The kind of the data set
bindingfollows, if it exists. - bound_
scalar - A scalar binding’s value at
time, remapped;Nonewithout a value. - bound_
vec2 - A two-component binding’s value at
time, a point in its space plus its offset or a scalar in both components.Nonewithout a value. - caption_
cues - The cues a caption track shows, its own or its
from_wordswords grouped in timeline time. - contained_
picture - The displayed picture’s size as a fraction of a canvas-shaped layer it is contain-fitted into, as the renderer centres it.
- correction_
at clip’s correction at timelinetime, if it has one with a value there.- evaluate
- Evaluates visual and audio clip descriptions at one timeline timestamp.
- evaluate_
audio - Evaluates every audible clip overlapping a half-open timeline span.
- evaluate_
audio_ in - Evaluates the same clips as
evaluate_audiointo reusable memory. - evaluate_
geometry - A mask’s outline or a content tree’s geometry at
time;contextresolves mask bindings. - evaluate_
item - One item at
time. Opacities, trims and roundness clamp to0..=1and lengths to>= 0, since an overshooting curve can carry them past. - evaluate_
items - A whole content tree at
time, without a plan. - frame_
needs - Describes all source frames needed at a timestamp.
- hash_
sampled_ animators - Feeds every value of
animatorstohash. - next_
data_ change - The first tick after
afterat which a timeline-time binding can read another sample: a sample time passing under the reader’s time map, or a loop pass starting. Between two such ticks aholdbinding is constant and alinearone changes linearly with timeline time.Nonewhen the value never changes again. - picture_
source_ time - The source instant a clip’s picture shows at timeline
time, mirroring by project frames atframe_rateexactly as evaluation draws it. - plan_
composition - Compiles
composition’s output into steps as a clip’s composition, where clip nodes draw the clip’s picture.compositionsresolves group nodes andsourcesresolves media nodes. - plan_
source_ composition - Compiles
compositionas a composition source. Likeplan_composition, but clip nodes and group inputs are errors because nothing feeds them. - sample_
channel - The value of
channelattime,aritynumbers, with the data rules:holdtakes the sample at or beforetime,linearinterpolates between two known neighbours, a lost sample holds the last known value, and times outside the samples clamp.Nonewhen the channel has no known value. - sample_
effect_ param - Samples one effect parameter with the project’s keyframe semantics.
- sample_
hold - Samples a non-interpolating value: the last keyframe at or before
time, else the first. - sample_
insets - Samples per-side lengths like
sample_size. - sample_
length - Samples a layout length. Mismatched keyframe kinds keep the left kind.
- sample_
paint - Samples an animated paint. Colors interpolate premultiplied; gradient geometry and stop
offsets interpolate numerically, then offsets are kept ordered in
0..=1and radii positive. Mismatched keyframes hold the left paint. - sample_
path - Samples an animated path, interpolating points and tangents linearly in
f64. Mismatched keyframe structures hold the left path. - sample_
point - Samples a position that may move along spatial curves.
- sample_
rgba - Samples an animated color, interpolated premultiplied.
- sample_
scalar - Samples one animated scalar with the project’s keyframe semantics.
- sample_
text_ animators animatorssampled attime, in order.- sample_
vec2 - Samples an animated 2D value like
sample_scalar. Usesample_pointfor positions that may follow spatial curves. - sample_
visual - Evaluates visual properties at a timestamp.
aspectis the canvas width over height, used to measure motion along spatial curves;contextresolves data bindings. - source_
instant_ to_ timeline - The timeline times at which a clip’s picture reaches source time
instant: per stretch over which the shown time moves one way, the first tick at which it has reachedinstantin that stretch’s direction, if the stretch passes it. A freeze passes nothing. - source_
range_ to_ timeline - The timeline ranges of a clip at which its picture shows a source time in
[range_start, range_end), the full preimage ofpicture_source_time.