File tree Expand file tree Collapse file tree 2 files changed +13
-2
lines changed Expand file tree Collapse file tree 2 files changed +13
-2
lines changed Original file line number Diff line number Diff line change @@ -39,6 +39,12 @@ export type Maybe<T> = T | undefined;
39
39
* function returns false, the animation loop will be stopped (via
40
40
* {@link GenArtAPI.stop}), otherwise the loop continues until stopped
41
41
* explicitly.
42
+ *
43
+ * @remarks
44
+ * Arguments are information sourced from {@link TimeProvider.now}.
45
+ *
46
+ * @param time
47
+ * @param frame
42
48
*/
43
49
export type UpdateFn = ( time : number , frame : number ) => boolean ;
44
50
Original file line number Diff line number Diff line change @@ -17,8 +17,13 @@ export interface TimeProvider {
17
17
*/
18
18
next ( fn : ( time : number , frame : number ) => void ) : void ;
19
19
/**
20
- * Returns tuple of current `[time, frame]` (where `time` is in
21
- * milliseconds and `frame` the current frame number)
20
+ * Returns tuple of current `[time, frame]` (where `time` is the current
21
+ * frame's number of milliseconds since start and `frame` the current frame
22
+ * number).
23
+ *
24
+ * @remarks
25
+ * Function is idempotent when called during a single frame update. Can also
26
+ * be called via `$genart.timeProvider.now()`.
22
27
*/
23
28
now ( ) : [ number , number ] ;
24
29
}
You can’t perform that action at this time.
0 commit comments