Skip to content

Commit 9f45069

Browse files
committed
update animate api docs
1 parent 318bc74 commit 9f45069

File tree

1 file changed

+2
-6
lines changed

1 file changed

+2
-6
lines changed

README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,8 @@ export interface CanvasCustomKeyframe extends Keyframe {
222222
export interface Animation {
223223
// Renders the current state of the animation.
224224
renderFrame: () => Path2D;
225+
// Renders the current state of the animation as points.
226+
renderPoints: () => Point[];
225227
// Immediately begin animating through the given keyframes.
226228
// Non-rendered keyframes from previous transitions are cancelled.
227229
transition: (...keyframes: (CanvasKeyframe | CanvasCustomKeyframe)[]) => void;
@@ -245,15 +247,9 @@ export const canvasPath: (timestampProvider?: TimestampProvider) => Animation;
245247
export interface WiggleOptions {
246248
// Speed of the wiggle movement. Higher is faster.
247249
speed: number;
248-
// Delay before the first wiggle frame.
249-
// Default: 0
250-
initialDelay?: number;
251250
// Length of the transition from the current state to the wiggle blob.
252251
// Default: 0
253252
initialTransition?: number;
254-
// Interpolation function.
255-
// Default: linear
256-
initialTimingFunction?: Keyframe["timingFunction"];
257253
}
258254
// Preset animation that produces natural-looking random movement.
259255
// The wiggle animation will continue indefinitely until the next transition.

0 commit comments

Comments
 (0)