Skip to content

Interface: Frame ​

Defined in: core/types.ts:16

The data that the engine gives to each effect in one frame.

Properties ​

PropertyModifierTypeDescriptionDefined in
dtreadonlynumberThe time since the last frame, in frames at 60 fps. The maximum value is 3.core/types.ts:18
heightreadonlynumberThe CSS height of the canvas.core/types.ts:26
reducedMotionreadonlybooleanTrue if the effects must use reduced motion.core/types.ts:22
scrollXreadonlynumberThe horizontal scroll offset of the page or the container.core/types.ts:28
scrollYreadonlynumberThe vertical scroll offset of the page or the container.core/types.ts:30
timereadonlynumberThe time of the frame in milliseconds, from the scheduler.core/types.ts:20
widthreadonlynumberThe CSS width of the canvas.core/types.ts:24