remotion
Version:
Render videos in React
24 lines (23 loc) • 1.35 kB
TypeScript
import { SpringConfig } from './spring-utils';
/**
* Calculates a position based on physical parameters, start and end value, and time.
* @link https://www.remotion.dev/docs/spring
* @param {number} frame The current time value. Most of the time you want to pass in the return value of useCurrentFrame.
* @param {number} fps The framerate at which the animation runs. Pass in the value obtained by `useVideoConfig()`.
* @param {?Object} config optional object that allows you to customize the physical properties of the animation.
* @param {number} [config.mass=1] The weight of the spring. If you reduce the mass, the animation becomes faster!
* @param {number} [config.damping=10] How hard the animation decelerates.
* @param {number} [config.stiffness=100] Affects bounciness of the animation.
* @param {boolean} [config.overshootClamping=false] Whether to prevent the animation going beyond the target value.
* @param {?number} from The initial value of the animation. Default `0`
* @param {?number} to The end value of the animation. Default `1`
*/
export declare function spring({ frame, fps, config, from, to, }: {
frame: number;
fps: number;
config?: Partial<SpringConfig>;
from?: number;
to?: number;
}): number;
export { measureSpring } from './measure-spring';
export { SpringConfig } from './spring-utils';