Timer: Add connect()/disconnect(). (#1547)

* Update * Update three.js
three-types · Feb 23, 2025 · 198e1ca · 198e1ca
1 parent 68a335f
commit 198e1ca
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 7 deletions.
diff --git a/three.js b/three.js
diff --git a/types/three/examples/jsm/misc/Timer.d.ts b/types/three/examples/jsm/misc/Timer.d.ts
@@ -4,8 +4,8 @@
  *
  * - {@link Timer} has an {@link .update()} method that updates its internal state. That makes it possible to call
  *   {@link .getDelta()} and {@link .getElapsed()} multiple times per simulation step without getting different values.
- * - The class uses the Page Visibility API to avoid large time delta values when the app is inactive (e.g. tab switched
- *   or browser hidden).
+ * - The class can make use of the Page Visibility API to avoid large time delta values when the app is inactive (e.g.
+ *   tab switched or browser hidden).
  *
  * @example
  * const timer = new Timer();
@@ -22,12 +22,18 @@
  * @see https://threejs.org/examples/#webgl_morphtargets_sphere
  */
 export class Timer {
+    constructor();
+
+    /**
+     * Connects the timer to the given document. Calling this method is not mandatory to use the timer but enables the
+     * usage of the Page Visibility API to avoid large time delta values.
+     */
+    connect(document: Document): void;
+
     /**
-     * Whether to use the Page Visibility API to avoid large time delta values in inactive tabs or not.
-     * @default true
-     * @param usePageVisibilityAPI
+     * Disconnects the timer from the DOM and also disables the usage of the Page Visibility API.
      */
-    constructor(usePageVisibilityAPI?: boolean);
+    disconnect(): void;
 
     /**
      * Returns the time delta in seconds.
+12 −4		docs/examples/en/misc/Timer.html
+27 −12		examples/jsm/misc/Timer.js
+1 −0		examples/webgl_buffergeometry_lines.html
+1 −0		examples/webgl_geometry_dynamic.html
+1 −0		examples/webgl_morphtargets_sphere.html
+1 −0		examples/webgpu_display_stereo.html
+1 −0		examples/webgpu_postprocessing_difference.html
+1 −0		examples/webgpu_postprocessing_ssaa.html
+1 −0		examples/webgpu_tsl_vfx_linkedparticles.html