Interface: Frame
Defined in: core/types.ts:16
The data that the engine gives to each effect in one frame.
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
dt | readonly | number | The time since the last frame, in frames at 60 fps. The maximum value is 3. | core/types.ts:18 |
height | readonly | number | The CSS height of the canvas. | core/types.ts:26 |
reducedMotion | readonly | boolean | True if the effects must use reduced motion. | core/types.ts:22 |
scrollX | readonly | number | The horizontal scroll offset of the page or the container. | core/types.ts:28 |
scrollY | readonly | number | The vertical scroll offset of the page or the container. | core/types.ts:30 |
time | readonly | number | The time of the frame in milliseconds, from the scheduler. | core/types.ts:20 |
width | readonly | number | The CSS width of the canvas. | core/types.ts:24 |