Expand description
Pure, deterministic timeline evaluation.
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 a timeline transition, composition time for a composition step.
- 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, as
evaluate_audioreports them, held in anAudioSpanScratchand read back without 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.
- 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, 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, never pixels.
- Node
Paint - What a box draws under its content.
- Node
Visual - How a box and its subtree are drawn after layout.
- Shapes
Plan - A content tree, its parts that do not animate evaluated once.
- Sides
- A length on each side of a box, as a fraction of the picture’s shorter side.
- 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 generator’s tree, planned once: what a shapes or layout generator evaluates each frame from. Other generators need none.
- Node
Content - A box’s content.
- Plan
Error - Why a composition’s output cannot be drawn.
- StepOp
- The operation of a
Step. Inputs are indices of earlier steps.
Constants§
- MAX_
PLAN_ BYTES - Most bytes the compiled composition plans of one project hold together,
as
Steps estimate them: each step, its node path, and the heap its settings use (keyframes, parameter and resource names, masks, layers, gradient stops). A project’s plans are those of every composition a clip or composition source shows; past this, none of them is drawn (PlanError::TooLarge). The steps are what validation counts, at mostMAX_INLINED_NODES; this bounds how large each may be, which inlining multiplies.
Functions§
- 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 geometry at
time: a mask’s outline, or a content tree’s. - evaluate_
item - One item at
time. Opacities, trims, and roundness are clamped to0..=1and lengths to zero or more, as an overshooting curve could carry them past. - evaluate_
items - A whole content tree at
time, without a plan. - frame_
needs - Describes all source frames needed at a timestamp.
- picture_
source_ time - The source instant a clip’s picture shows at timeline
time: its time map read with the reverse and ping-pong mirror of one project frame atframe_rate, exactly as evaluation draws it. - plan_
composition - Compiles
composition’s output into steps, as a clip’s composition: its clip nodes draw the clip’s picture.compositionsresolves group nodes andsourcesmedia nodes, which may name generated or composition sources. - plan_
source_ composition - Compiles
compositionas a composition source draws it: likeplan_composition, but a clip node or group input is an error, since no clip or group node feeds it. - sample_
effect_ param - Samples one effect parameter with the project’s keyframe semantics.
- sample_
hold - Samples a value that does not interpolate: the last keyframe at or
before
time, else the first. - sample_
insets - Samples per-side lengths, each side as [
sample_size] samples one. - sample_
length - Samples a layout length. Validation makes every keyframe one kind (a plan’s lengths are fractions or percents); were they not, the left keyframe’s kind is kept.
- sample_
paint - Samples an animated paint. Colors interpolate premultiplied, as effect
colors do, and gradient points, radii, angles, and stop offsets
numerically; offsets are then kept in order within
0..=1and a radius positive, as an overshooting curve could carry them past. Validation keeps the keyframes alike in kind, stops, and spread; were they not, the left keyframe’s paint is held. - sample_
path - Samples an animated path: every point and tangent moves along a straight
line between keyframes, in
f64. Validation keeps the keyframes alike in structure; were they not, the left keyframe’s path is held. - sample_
point - Samples a position that may move along spatial curves.
- sample_
scalar - Samples one animated scalar with the project’s keyframe semantics.
- sample_
vec2 - Samples one animated two-dimensional value with the project’s keyframe
semantics; see
sample_scalar. A position that may follow spatial curves is sampled withsample_point. - sample_
visual - Evaluates visual properties at a timestamp: a clip’s at timeline time,
a transform node’s at composition time.
aspectis the width over the height of the space the position is normalized in (the canvas), in which a position moving along a spatial curve is measured.