@react-three/fiber 10.0.0-canary.2c50459 → 10.0.0-canary.9806389

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -8,8 +8,6 @@ import * as React$1 from 'react';
8
8
  import { ReactNode, Component, RefObject, JSX } from 'react';
9
9
  import { StoreApi } from 'zustand';
10
10
  import { UseBoundStoreWithEqualityFn } from 'zustand/traditional';
11
- import { FrameTimingState, FrameCallback as FrameCallback$1, SchedulerApi, UseFrameNextOptions, FrameNextControls } from '@pmndrs/scheduler';
12
- export { AddPhaseOptions, FrameControls, FrameNextControls, FrameTimingState, RootOptions, Scheduler, SchedulerApi, UseFrameNextOptions, UseFrameOptions, getScheduler } from '@pmndrs/scheduler';
13
11
  import { Options } from 'react-use-measure';
14
12
  import * as react_jsx_runtime from 'react/jsx-runtime';
15
13
  import { ThreeElement as ThreeElement$1, Euler as Euler$3 } from '@react-three/fiber';
@@ -294,33 +292,228 @@ interface VisibilityEntry {
294
292
  }
295
293
 
296
294
  //* Scheduler Types (useFrame) ==============================
297
- //
298
- // The generic, framework-agnostic scheduler types now live in @pmndrs/scheduler.
299
- // This file re-exports them and layers r3f's RootState-aware frame state on top,
300
- // so existing `#types` imports across the codebase keep resolving unchanged.
301
295
 
302
296
 
303
297
 
304
- // Frame State (r3f-specific) --------------------------------
298
+ // Public Options --------------------------------
305
299
 
306
300
  /**
307
- * State passed to useFrame callbacks (extends RootState with timing).
301
+ * Options for useFrame hook
302
+ */
303
+ interface UseFrameNextOptions {
304
+ /** Optional stable id for the job. Auto-generated if not provided */
305
+ id?: string
306
+ /** Named phase to run in. Default: 'update' */
307
+ phase?: string
308
+ /** Run before this phase or job id */
309
+ before?: string | string[]
310
+ /** Run after this phase or job id */
311
+ after?: string | string[]
312
+ /** Priority within phase. Higher runs first. Default: 0 */
313
+ priority?: number
314
+ /** Max frames per second for this job */
315
+ fps?: number
316
+ /** If true, skip frames when behind. If false, try to catch up. Default: true */
317
+ drop?: boolean
318
+ /** Enable/disable without unregistering. Default: true */
319
+ enabled?: boolean
320
+ }
321
+
322
+ /** Alias for UseFrameNextOptions */
323
+ type UseFrameOptions = UseFrameNextOptions
324
+
325
+ /**
326
+ * Options for addPhase
327
+ */
328
+ interface AddPhaseOptions {
329
+ /** Insert this phase before the specified phase */
330
+ before?: string
331
+ /** Insert this phase after the specified phase */
332
+ after?: string
333
+ }
334
+
335
+ // Frame State --------------------------------
336
+
337
+ /**
338
+ * Timing-only state for independent/outside mode (no RootState)
339
+ */
340
+ interface FrameTimingState {
341
+ /** High-resolution timestamp from RAF (ms) */
342
+ time: number
343
+ /** Time since last frame in seconds (for legacy compatibility with THREE.Clock) */
344
+ delta: number
345
+ /** Elapsed time since first frame in seconds (for legacy compatibility with THREE.Clock) */
346
+ elapsed: number
347
+ /** Incrementing frame counter */
348
+ frame: number
349
+ }
350
+
351
+ /**
352
+ * State passed to useFrame callbacks (extends RootState with timing)
308
353
  */
309
354
  interface FrameNextState extends RootState, FrameTimingState {}
310
355
 
311
356
  /** Alias for FrameNextState */
312
357
  type FrameState = FrameNextState
313
358
 
314
- // Callback Types (r3f-specific) --------------------------------
359
+ // Root Options --------------------------------
315
360
 
316
361
  /**
317
- * Callback function for useFrame. Receives the full r3f RootState plus timing.
362
+ * Options for registerRoot
318
363
  */
319
- type FrameNextCallback = FrameCallback$1<RootState>
364
+ interface RootOptions {
365
+ /** State provider for callbacks. Optional in independent mode. */
366
+ getState?: () => any
367
+ /** Error handler for job errors. Falls back to console.error if not provided. */
368
+ onError?: (error: Error) => void
369
+ }
370
+
371
+ // Callback Types --------------------------------
372
+
373
+ /**
374
+ * Callback function for useFrame
375
+ */
376
+ type FrameNextCallback = (state: FrameNextState, delta: number) => void
320
377
 
321
378
  /** Alias for FrameNextCallback */
322
379
  type FrameCallback = FrameNextCallback
323
380
 
381
+ // Controls returned from useFrame --------------------------------
382
+
383
+ /**
384
+ * Controls object returned from useFrame hook
385
+ */
386
+ interface FrameNextControls {
387
+ /** The job's unique ID */
388
+ id: string
389
+ /** Access to the global scheduler for frame loop control */
390
+ scheduler: SchedulerApi
391
+ /** Manually step this job only (bypasses FPS limiting) */
392
+ step(timestamp?: number): void
393
+ /** Manually step ALL jobs in the scheduler */
394
+ stepAll(timestamp?: number): void
395
+ /** Pause this job (set enabled=false) */
396
+ pause(): void
397
+ /** Resume this job (set enabled=true) */
398
+ resume(): void
399
+ /** Reactive paused state - automatically triggers re-render when changed */
400
+ isPaused: boolean
401
+ }
402
+
403
+ /** Alias for FrameNextControls */
404
+ type FrameControls = FrameNextControls
405
+
406
+ // Scheduler Interface --------------------------------
407
+
408
+ /**
409
+ * Public interface for the global Scheduler
410
+ */
411
+ interface SchedulerApi {
412
+ //* Phase Management --------------------------------
413
+
414
+ /** Add a named phase to the scheduler */
415
+ addPhase(name: string, options?: AddPhaseOptions): void
416
+ /** Get the ordered list of phase names */
417
+ readonly phases: string[]
418
+ /** Check if a phase exists */
419
+ hasPhase(name: string): boolean
420
+
421
+ //* Root Management --------------------------------
422
+
423
+ /** Register a root (Canvas) with the scheduler. Returns unsubscribe function. */
424
+ registerRoot(id: string, options?: RootOptions): () => void
425
+ /** Unregister a root */
426
+ unregisterRoot(id: string): void
427
+ /** Generate a unique root ID */
428
+ generateRootId(): string
429
+ /** Get the number of registered roots */
430
+ getRootCount(): number
431
+ /** Check if any root is registered and ready */
432
+ readonly isReady: boolean
433
+ /** Subscribe to root-ready event. Fires immediately if already ready. Returns unsubscribe. */
434
+ onRootReady(callback: () => void): () => void
435
+
436
+ //* Job Registration --------------------------------
437
+
438
+ /** Register a job with the scheduler (returns unsubscribe function) */
439
+ register(
440
+ callback: FrameNextCallback,
441
+ options?: {
442
+ id?: string
443
+ rootId?: string
444
+ phase?: string
445
+ before?: string | string[]
446
+ after?: string | string[]
447
+ priority?: number
448
+ fps?: number
449
+ drop?: boolean
450
+ enabled?: boolean
451
+ },
452
+ ): () => void
453
+ /** Update a job's options */
454
+ updateJob(
455
+ id: string,
456
+ options: {
457
+ priority?: number
458
+ fps?: number
459
+ drop?: boolean
460
+ enabled?: boolean
461
+ phase?: string
462
+ before?: string | string[]
463
+ after?: string | string[]
464
+ },
465
+ ): void
466
+ /** Unregister a job by ID */
467
+ unregister(id: string, rootId?: string): void
468
+ /** Get the number of registered jobs */
469
+ getJobCount(): number
470
+ /** Get all job IDs */
471
+ getJobIds(): string[]
472
+
473
+ //* Global Jobs (for legacy addEffect/addAfterEffect) --------------------------------
474
+
475
+ /** Register a global job (runs once per frame, not per-root). Returns unsubscribe function. */
476
+ registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void
477
+
478
+ //* Idle Callbacks (for legacy addTail) --------------------------------
479
+
480
+ /** Register an idle callback (fires when loop stops). Returns unsubscribe function. */
481
+ onIdle(callback: (timestamp: number) => void): () => void
482
+
483
+ //* Frame Loop Control --------------------------------
484
+
485
+ /** Start the scheduler loop */
486
+ start(): void
487
+ /** Stop the scheduler loop */
488
+ stop(): void
489
+ /** Check if the scheduler is running */
490
+ readonly isRunning: boolean
491
+ /** Get/set the frameloop mode ('always', 'demand', 'never') */
492
+ frameloop: Frameloop
493
+ /** Independent mode - runs without Canvas, callbacks receive timing-only state */
494
+ independent: boolean
495
+
496
+ //* Manual Stepping --------------------------------
497
+
498
+ /** Manually step all jobs once (for frameloop='never' or testing) */
499
+ step(timestamp?: number): void
500
+ /** Manually step a single job by ID */
501
+ stepJob(id: string, timestamp?: number): void
502
+ /** Request frame(s) to be rendered (for frameloop='demand') */
503
+ invalidate(frames?: number): void
504
+
505
+ //* Per-Job Control --------------------------------
506
+
507
+ /** Check if a job is paused */
508
+ isJobPaused(id: string): boolean
509
+ /** Pause a job */
510
+ pauseJob(id: string): void
511
+ /** Resume a job */
512
+ resumeJob(id: string): void
513
+ /** Subscribe to job state changes (for reactive isPaused). Returns unsubscribe function. */
514
+ subscribeJobState(id: string, listener: () => void): () => void
515
+ }
516
+
324
517
  //* Buffer Types (useBuffers) ========================================
325
518
 
326
519
  /**
@@ -1325,6 +1518,146 @@ declare global {
1325
1518
  }
1326
1519
  }
1327
1520
 
1521
+ //* useFrameNext Types ==============================
1522
+
1523
+
1524
+
1525
+ //* Global Type Declarations ==============================
1526
+
1527
+ declare global {
1528
+ // Job --------------------------------
1529
+
1530
+ /**
1531
+ * Internal job representation in the scheduler
1532
+ */
1533
+ interface Job {
1534
+ /** Unique identifier */
1535
+ id: string
1536
+ /** The callback to execute */
1537
+ callback: FrameNextCallback
1538
+ /** Phase this job belongs to */
1539
+ phase: string
1540
+ /** Run before these phases/job ids */
1541
+ before: Set<string>
1542
+ /** Run after these phases/job ids */
1543
+ after: Set<string>
1544
+ /** Priority within phase (higher first) */
1545
+ priority: number
1546
+ /** Insertion order for deterministic tie-breaking */
1547
+ index: number
1548
+ /** Max FPS for this job (undefined = no limit) */
1549
+ fps?: number
1550
+ /** Drop frames when behind (true) or catch up (false) */
1551
+ drop: boolean
1552
+ /** Last run timestamp (ms) */
1553
+ lastRun?: number
1554
+ /** Whether job is enabled */
1555
+ enabled: boolean
1556
+ /** Internal flag: system jobs (like default render) don't block user render takeover */
1557
+ system?: boolean
1558
+ }
1559
+
1560
+ // Phase Graph --------------------------------
1561
+
1562
+ /**
1563
+ * A node in the phase graph
1564
+ */
1565
+ interface PhaseNode {
1566
+ /** Phase name */
1567
+ name: string
1568
+ /** Whether this was auto-generated from a before/after constraint */
1569
+ isAutoGenerated: boolean
1570
+ }
1571
+
1572
+ /**
1573
+ * Options for creating a job from hook options
1574
+ */
1575
+ interface JobOptions {
1576
+ id?: string
1577
+ phase?: string
1578
+ before?: string | string[]
1579
+ after?: string | string[]
1580
+ priority?: number
1581
+ fps?: number
1582
+ drop?: boolean
1583
+ enabled?: boolean
1584
+ }
1585
+
1586
+ // Frame Loop State --------------------------------
1587
+
1588
+ /**
1589
+ * Internal frame loop state
1590
+ */
1591
+ interface FrameLoopState {
1592
+ /** Whether the loop is running */
1593
+ running: boolean
1594
+ /** Current RAF handle */
1595
+ rafHandle: number | null
1596
+ /** Last frame timestamp in ms (null = uninitialized) */
1597
+ lastTime: number | null
1598
+ /** Frame counter */
1599
+ frameCount: number
1600
+ /** Elapsed time since first frame in ms */
1601
+ elapsedTime: number
1602
+ /** createdAt timestamp in ms */
1603
+ createdAt: number
1604
+ }
1605
+
1606
+ // Root Entry --------------------------------
1607
+
1608
+ /**
1609
+ * Internal representation of a registered root (Canvas).
1610
+ * Tracks jobs and manages rebuild state for this root.
1611
+ * @internal
1612
+ */
1613
+ interface RootEntry {
1614
+ /** Unique identifier for this root */
1615
+ id: string
1616
+ /** Function to get the root's current state. Returns any to support independent mode. */
1617
+ getState: () => any
1618
+ /** Map of job IDs to Job objects */
1619
+ jobs: Map<string, Job>
1620
+ /** Cached sorted job list for execution order */
1621
+ sortedJobs: Job[]
1622
+ /** Whether sortedJobs needs rebuilding */
1623
+ needsRebuild: boolean
1624
+ }
1625
+
1626
+ /**
1627
+ * Internal representation of a global job (deprecated API).
1628
+ * Global jobs run once per frame, not per-root.
1629
+ * Used by legacy addEffect/addAfterEffect APIs.
1630
+ * @internal
1631
+ * @deprecated Use useFrame with phases instead
1632
+ */
1633
+ interface GlobalJob {
1634
+ /** Unique identifier for this global job */
1635
+ id: string
1636
+ /** Callback invoked with RAF timestamp in ms */
1637
+ callback: (timestamp: number) => void
1638
+ }
1639
+
1640
+ // HMR Support --------------------------------
1641
+
1642
+ /**
1643
+ * Hot Module Replacement data structure for preserving scheduler state
1644
+ * @internal
1645
+ */
1646
+ interface HMRData {
1647
+ /** Shared data object for storing values across reloads */
1648
+ data: Record<string, any>
1649
+ /** Optional function to accept HMR updates */
1650
+ accept?: () => void
1651
+ }
1652
+
1653
+ // Default Phases --------------------------------
1654
+
1655
+ /**
1656
+ * Default phase names for the scheduler
1657
+ */
1658
+ type DefaultPhase = 'start' | 'input' | 'physics' | 'update' | 'render' | 'finish'
1659
+ }
1660
+
1328
1661
  type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
1329
1662
 
1330
1663
  interface MathRepresentation {
@@ -1824,14 +2157,376 @@ declare namespace useLoader {
1824
2157
  var loader: typeof getLoader;
1825
2158
  }
1826
2159
 
2160
+ /**
2161
+ * Global Singleton Scheduler - manages the frame loop and job execution for ALL R3F roots.
2162
+ *
2163
+ * Features:
2164
+ * - Single RAF loop for entire application
2165
+ * - Root registration (multiple Canvas support)
2166
+ * - Global phases for addEffect/addAfterEffect (deprecated)
2167
+ * - Per-root job management with phases, priorities, FPS throttling
2168
+ * - onIdle callbacks for addTail (deprecated)
2169
+ * - Demand mode support via invalidate()
2170
+ */
2171
+ declare class Scheduler {
2172
+ private static readonly INSTANCE_KEY;
2173
+ private static get instance();
2174
+ private static set instance(value);
2175
+ /**
2176
+ * Get the global scheduler instance (creates if doesn't exist).
2177
+ * Uses HMR data to preserve instance across hot reloads.
2178
+ * @returns {Scheduler} The singleton scheduler instance
2179
+ */
2180
+ static get(): Scheduler;
2181
+ /**
2182
+ * Reset the singleton instance. Stops the loop and clears all state.
2183
+ * Primarily used for testing to ensure clean state between tests.
2184
+ * @returns {void}
2185
+ */
2186
+ static reset(): void;
2187
+ private roots;
2188
+ private phaseGraph;
2189
+ private loopState;
2190
+ private stoppedTime;
2191
+ private nextRootIndex;
2192
+ private globalBeforeJobs;
2193
+ private globalAfterJobs;
2194
+ private nextGlobalIndex;
2195
+ private idleCallbacks;
2196
+ private nextJobIndex;
2197
+ private jobStateListeners;
2198
+ private pendingFrames;
2199
+ private _frameloop;
2200
+ private _independent;
2201
+ private errorHandler;
2202
+ private rootReadyCallbacks;
2203
+ get phases(): string[];
2204
+ get frameloop(): Frameloop;
2205
+ set frameloop(mode: Frameloop);
2206
+ get isRunning(): boolean;
2207
+ get isReady(): boolean;
2208
+ get independent(): boolean;
2209
+ set independent(value: boolean);
2210
+ constructor();
2211
+ /**
2212
+ * Register a root (Canvas) with the scheduler.
2213
+ * The first root to register starts the RAF loop (if frameloop='always').
2214
+ * @param {string} id - Unique identifier for this root
2215
+ * @param {RootOptions} [options] - Optional configuration with getState and onError callbacks
2216
+ * @returns {() => void} Unsubscribe function to remove this root
2217
+ */
2218
+ registerRoot(id: string, options?: RootOptions): () => void;
2219
+ /**
2220
+ * Unregister a root from the scheduler.
2221
+ * Cleans up all job state listeners for this root's jobs.
2222
+ * The last root to unregister stops the RAF loop.
2223
+ * @param {string} id - The root ID to unregister
2224
+ * @returns {void}
2225
+ */
2226
+ unregisterRoot(id: string): void;
2227
+ /**
2228
+ * Subscribe to be notified when a root becomes available.
2229
+ * Fires immediately if a root already exists.
2230
+ * @param {() => void} callback - Function called when first root registers
2231
+ * @returns {() => void} Unsubscribe function
2232
+ */
2233
+ onRootReady(callback: () => void): () => void;
2234
+ /**
2235
+ * Notify all registered root-ready callbacks.
2236
+ * Called when the first root registers.
2237
+ * @returns {void}
2238
+ * @private
2239
+ */
2240
+ private notifyRootReady;
2241
+ /**
2242
+ * Ensure a default root exists for independent mode.
2243
+ * Creates a minimal root with no state provider.
2244
+ * @returns {void}
2245
+ * @private
2246
+ */
2247
+ private ensureDefaultRoot;
2248
+ /**
2249
+ * Trigger error handling for job errors.
2250
+ * Uses the bound error handler if available, otherwise logs to console.
2251
+ * @param {Error} error - The error to handle
2252
+ * @returns {void}
2253
+ */
2254
+ triggerError(error: Error): void;
2255
+ /**
2256
+ * Add a named phase to the scheduler's execution order.
2257
+ * Marks all roots for rebuild to incorporate the new phase.
2258
+ * @param {string} name - The phase name (e.g., 'physics', 'postprocess')
2259
+ * @param {AddPhaseOptions} [options] - Positioning options (before/after other phases)
2260
+ * @returns {void}
2261
+ * @example
2262
+ * scheduler.addPhase('physics', { before: 'update' });
2263
+ * scheduler.addPhase('postprocess', { after: 'render' });
2264
+ */
2265
+ addPhase(name: string, options?: AddPhaseOptions): void;
2266
+ /**
2267
+ * Check if a phase exists in the scheduler.
2268
+ * @param {string} name - The phase name to check
2269
+ * @returns {boolean} True if the phase exists
2270
+ */
2271
+ hasPhase(name: string): boolean;
2272
+ /**
2273
+ * Register a global job that runs once per frame (not per-root).
2274
+ * Used internally by deprecated addEffect/addAfterEffect APIs.
2275
+ * @param {'before' | 'after'} phase - When to run: 'before' all roots or 'after' all roots
2276
+ * @param {string} id - Unique identifier for this global job
2277
+ * @param {(timestamp: number) => void} callback - Function called each frame with RAF timestamp
2278
+ * @returns {() => void} Unsubscribe function to remove this global job
2279
+ * @deprecated Use useFrame with phases instead
2280
+ */
2281
+ registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void;
2282
+ /**
2283
+ * Register an idle callback that fires when the loop stops.
2284
+ * Used internally by deprecated addTail API.
2285
+ * @param {(timestamp: number) => void} callback - Function called when loop becomes idle
2286
+ * @returns {() => void} Unsubscribe function to remove this idle callback
2287
+ * @deprecated Use demand mode with invalidate() instead
2288
+ */
2289
+ onIdle(callback: (timestamp: number) => void): () => void;
2290
+ /**
2291
+ * Notify all registered idle callbacks.
2292
+ * Called when the loop stops in demand mode.
2293
+ * @param {number} timestamp - The RAF timestamp when idle occurred
2294
+ * @returns {void}
2295
+ * @private
2296
+ */
2297
+ private notifyIdle;
2298
+ /**
2299
+ * Register a job (frame callback) with a specific root.
2300
+ * This is the core registration method used by useFrame internally.
2301
+ * @param {FrameNextCallback} callback - The function to call each frame
2302
+ * @param {JobOptions & { rootId?: string; system?: boolean }} [options] - Job configuration
2303
+ * @param {string} [options.rootId] - Target root ID (defaults to first registered root)
2304
+ * @param {string} [options.id] - Unique job ID (auto-generated if not provided)
2305
+ * @param {string} [options.phase] - Execution phase (defaults to 'update')
2306
+ * @param {number} [options.priority] - Priority within phase (higher = earlier, default 0)
2307
+ * @param {number} [options.fps] - FPS throttle limit
2308
+ * @param {boolean} [options.drop] - Drop frames when behind (default true)
2309
+ * @param {boolean} [options.enabled] - Whether job is active (default true)
2310
+ * @param {boolean} [options.system] - Internal flag for system jobs (not user-facing)
2311
+ * @returns {() => void} Unsubscribe function to remove this job
2312
+ */
2313
+ register(callback: FrameNextCallback, options?: JobOptions & {
2314
+ rootId?: string;
2315
+ system?: boolean;
2316
+ }): () => void;
2317
+ /**
2318
+ * Unregister a job by its ID.
2319
+ * Searches all roots if rootId is not provided.
2320
+ * @param {string} id - The job ID to unregister
2321
+ * @param {string} [rootId] - Optional root ID to search (searches all if not provided)
2322
+ * @returns {void}
2323
+ */
2324
+ unregister(id: string, rootId?: string): void;
2325
+ /**
2326
+ * Update a job's options dynamically.
2327
+ * Searches all roots to find the job by ID.
2328
+ * Phase/constraint changes trigger a rebuild of the sorted job list.
2329
+ * @param {string} id - The job ID to update
2330
+ * @param {Partial<JobOptions>} options - The options to update
2331
+ * @returns {void}
2332
+ */
2333
+ updateJob(id: string, options: Partial<JobOptions>): void;
2334
+ /**
2335
+ * Check if a job is currently paused (disabled).
2336
+ * @param {string} id - The job ID to check
2337
+ * @returns {boolean} True if the job exists and is paused
2338
+ */
2339
+ isJobPaused(id: string): boolean;
2340
+ /**
2341
+ * Subscribe to state changes for a specific job.
2342
+ * Listener is called when job is paused or resumed.
2343
+ * @param {string} id - The job ID to subscribe to
2344
+ * @param {() => void} listener - Callback invoked on state changes
2345
+ * @returns {() => void} Unsubscribe function
2346
+ */
2347
+ subscribeJobState(id: string, listener: () => void): () => void;
2348
+ /**
2349
+ * Notify all listeners that a job's state has changed.
2350
+ * @param {string} id - The job ID that changed
2351
+ * @returns {void}
2352
+ * @private
2353
+ */
2354
+ private notifyJobStateChange;
2355
+ /**
2356
+ * Pause a job by ID (sets enabled=false).
2357
+ * Notifies any subscribed state listeners.
2358
+ * @param {string} id - The job ID to pause
2359
+ * @returns {void}
2360
+ */
2361
+ pauseJob(id: string): void;
2362
+ /**
2363
+ * Resume a paused job by ID (sets enabled=true).
2364
+ * Resets job timing to prevent frame accumulation.
2365
+ * Notifies any subscribed state listeners.
2366
+ * @param {string} id - The job ID to resume
2367
+ * @returns {void}
2368
+ */
2369
+ resumeJob(id: string): void;
2370
+ /**
2371
+ * Start the requestAnimationFrame loop.
2372
+ * Resets timing state (elapsedTime, frameCount) on start.
2373
+ * No-op if already running.
2374
+ * @returns {void}
2375
+ */
2376
+ start(): void;
2377
+ /**
2378
+ * Stop the requestAnimationFrame loop.
2379
+ * Cancels any pending RAF callback.
2380
+ * No-op if not running.
2381
+ * @returns {void}
2382
+ */
2383
+ stop(): void;
2384
+ /**
2385
+ * Request frames to be rendered in demand mode.
2386
+ * Accumulates pending frames (capped at 60) and starts the loop if not running.
2387
+ * No-op if frameloop is not 'demand'.
2388
+ * @param {number} [frames=1] - Number of frames to request
2389
+ * @param {boolean} [stackFrames=false] - Whether to add frames to existing pending count
2390
+ * - `false` (default): Sets pending frames to the specified value (replaces existing count)
2391
+ * - `true`: Adds frames to existing pending count (useful for accumulating invalidations)
2392
+ * @returns {void}
2393
+ * @example
2394
+ * // Request a single frame render
2395
+ * scheduler.invalidate();
2396
+ *
2397
+ * @example
2398
+ * // Request 5 frames (e.g., for animations)
2399
+ * scheduler.invalidate(5);
2400
+ *
2401
+ * @example
2402
+ * // Set pending frames to exactly 3 (don't stack with existing)
2403
+ * scheduler.invalidate(3, false);
2404
+ *
2405
+ * @example
2406
+ * // Add 2 more frames to existing pending count
2407
+ * scheduler.invalidate(2, true);
2408
+ */
2409
+ invalidate(frames?: number, stackFrames?: boolean): void;
2410
+ /**
2411
+ * Reset timing state for deterministic testing.
2412
+ * Preserves jobs and roots but resets lastTime, frameCount, elapsedTime, etc.
2413
+ * @returns {void}
2414
+ */
2415
+ resetTiming(): void;
2416
+ /**
2417
+ * Manually execute a single frame for all roots.
2418
+ * Useful for frameloop='never' mode or testing scenarios.
2419
+ * @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
2420
+ * @returns {void}
2421
+ * @example
2422
+ * // Manual control mode
2423
+ * scheduler.frameloop = 'never';
2424
+ * scheduler.step(); // Execute one frame
2425
+ */
2426
+ step(timestamp?: number): void;
2427
+ /**
2428
+ * Manually execute a single job by its ID.
2429
+ * Useful for testing individual job callbacks in isolation.
2430
+ * @param {string} id - The job ID to step
2431
+ * @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
2432
+ * @returns {void}
2433
+ */
2434
+ stepJob(id: string, timestamp?: number): void;
2435
+ /**
2436
+ * Main RAF loop callback.
2437
+ * Executes frame, handles demand mode, and schedules next frame.
2438
+ * @param {number} timestamp - RAF timestamp in milliseconds
2439
+ * @returns {void}
2440
+ * @private
2441
+ */
2442
+ private loop;
2443
+ /**
2444
+ * Execute a single frame across all roots.
2445
+ * Order: globalBefore → each root's jobs → globalAfter
2446
+ * @param {number} timestamp - RAF timestamp in milliseconds
2447
+ * @returns {void}
2448
+ * @private
2449
+ */
2450
+ private executeFrame;
2451
+ /**
2452
+ * Run all global jobs from a job map.
2453
+ * Catches and logs errors without stopping execution.
2454
+ * @param {Map<string, GlobalJob>} jobs - The global jobs map to execute
2455
+ * @param {number} timestamp - RAF timestamp in milliseconds
2456
+ * @returns {void}
2457
+ * @private
2458
+ */
2459
+ private runGlobalJobs;
2460
+ /**
2461
+ * Execute all jobs for a single root in sorted order.
2462
+ * Rebuilds sorted job list if needed, then dispatches each job.
2463
+ * Errors are caught and propagated via triggerError.
2464
+ * @param {RootEntry} root - The root entry to tick
2465
+ * @param {number} timestamp - RAF timestamp in milliseconds
2466
+ * @param {number} delta - Time since last frame in seconds
2467
+ * @returns {void}
2468
+ * @private
2469
+ */
2470
+ private tickRoot;
2471
+ /**
2472
+ * Get the total number of registered jobs across all roots.
2473
+ * Includes both per-root jobs and global before/after jobs.
2474
+ * @returns {number} Total job count
2475
+ */
2476
+ getJobCount(): number;
2477
+ /**
2478
+ * Get all registered job IDs across all roots.
2479
+ * Includes both per-root jobs and global before/after jobs.
2480
+ * @returns {string[]} Array of all job IDs
2481
+ */
2482
+ getJobIds(): string[];
2483
+ /**
2484
+ * Get the number of registered roots (Canvas instances).
2485
+ * @returns {number} Number of registered roots
2486
+ */
2487
+ getRootCount(): number;
2488
+ /**
2489
+ * Check if any user (non-system) jobs are registered in a specific phase.
2490
+ * Used by the default render job to know if a user has taken over rendering.
2491
+ *
2492
+ * @param phase The phase to check
2493
+ * @param rootId Optional root ID to check (checks all roots if not provided)
2494
+ * @returns true if any user jobs exist in the phase
2495
+ */
2496
+ hasUserJobsInPhase(phase: string, rootId?: string): boolean;
2497
+ /**
2498
+ * Generate a unique root ID for automatic root registration.
2499
+ * @returns {string} A unique root ID in the format 'root_N'
2500
+ */
2501
+ generateRootId(): string;
2502
+ /**
2503
+ * Generate a unique job ID.
2504
+ * @returns {string} A unique job ID in the format 'job_N'
2505
+ * @private
2506
+ */
2507
+ private generateJobId;
2508
+ /**
2509
+ * Normalize before/after constraints to a Set.
2510
+ * Handles undefined, single string, or array inputs.
2511
+ * @param {string | string[] | undefined} value - The constraint value(s)
2512
+ * @returns {Set<string>} Normalized Set of constraint strings
2513
+ * @private
2514
+ */
2515
+ private normalizeConstraints;
2516
+ }
2517
+ /**
2518
+ * Get the global scheduler instance.
2519
+ * Creates one if it doesn't exist.
2520
+ */
2521
+ declare const getScheduler: () => Scheduler;
2522
+
1827
2523
  /**
1828
2524
  * Frame hook with phase-based ordering, priority, and FPS throttling.
1829
2525
  *
1830
- * Always delivers full RootState — works both inside and outside Canvas context:
1831
- * - Inside Canvas: Full RootState (renderer, scene, camera, etc.)
1832
- * - Outside Canvas: The job registers immediately but the callback is held until a
1833
- * Canvas adopts it, then runs with full RootState. For hostless / standalone
1834
- * frame loops with no Canvas, use `@pmndrs/scheduler` directly.
2526
+ * Works both inside and outside Canvas context:
2527
+ * - Inside Canvas: Full RootState (gl, scene, camera, etc.)
2528
+ * - Outside Canvas (waiting mode): Waits for Canvas to mount, then gets full state
2529
+ * - Outside Canvas (independent mode): Fires immediately with timing-only state
1835
2530
  *
1836
2531
  * Returns a controls object for manual stepping, pausing, and resuming.
1837
2532
  *
@@ -1848,16 +2543,16 @@ declare namespace useLoader {
1848
2543
  * useFrame((state, delta) => { ... }, { phase: 'physics' })
1849
2544
  *
1850
2545
  * @example
1851
- * // Outside Canvas - callback waits for a Canvas, then always has full state
2546
+ * // Outside Canvas - waits for Canvas to mount
1852
2547
  * function UI() {
1853
2548
  * useFrame((state, delta) => { syncUI(state.camera) });
1854
2549
  * return <button>...</button>;
1855
2550
  * }
1856
2551
  *
1857
2552
  * @example
1858
- * // Hostless / standalone loop (no Canvas) - use @pmndrs/scheduler directly
1859
- * import { getScheduler } from '@pmndrs/scheduler'
1860
- * getScheduler().register((state, delta) => { updateGame(delta) })
2553
+ * // Independent mode - no Canvas needed
2554
+ * getScheduler().independent = true;
2555
+ * useFrame((state, delta) => { updateGame(delta) });
1861
2556
  *
1862
2557
  * @example
1863
2558
  * // Scheduler-only access (no callback)
@@ -3710,5 +4405,5 @@ declare function isOnce(value: unknown): value is {
3710
4405
  */
3711
4406
  declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
3712
4407
 
3713
- export { Block, Canvas, Environment, EnvironmentCube, EnvironmentMap, EnvironmentPortal, ErrorBoundary, FROM_REF, IsObject, ONCE, Portal, R3F_BUILD_LEGACY, R3F_BUILD_WEBGPU, REACT_INTERNAL_PROPS, RESERVED_PROPS, three_d as ReactThreeFiber, Texture, _roots, act, addAfterEffect, addEffect, addTail, advance, applyProps, attach, buildGraph, calculateDpr, context, createEvents, createPointerEvents, createPortal, createRoot, createStore, detach, diffProps, dispose, createPointerEvents as events, extend, findInitialRoot, flushSync, fromRef, getInstanceProps, getPrimary, getPrimaryIds, getRootState, getUuidPrefix, hasConstructor, hasPrimary, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isFromRef, isObject3D, isOnce, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, once, prepare, presetsObj, reconciler, registerPrimary, removeInteractivity, resolve, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useMutableCallback, useRenderTarget, useStore, useTexture, useTextures, useThree, waitForPrimary };
3714
- export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferLike, BufferRecord, BufferStore, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DisposeOptions, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeProps, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootState, RootStore, SetBlock, Size, StorageLike, StorageRecord, StorageStore, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };
4408
+ export { Block, Canvas, Environment, EnvironmentCube, EnvironmentMap, EnvironmentPortal, ErrorBoundary, FROM_REF, IsObject, ONCE, Portal, R3F_BUILD_LEGACY, R3F_BUILD_WEBGPU, REACT_INTERNAL_PROPS, RESERVED_PROPS, three_d as ReactThreeFiber, Scheduler, Texture, _roots, act, addAfterEffect, addEffect, addTail, advance, applyProps, attach, buildGraph, calculateDpr, context, createEvents, createPointerEvents, createPortal, createRoot, createStore, detach, diffProps, dispose, createPointerEvents as events, extend, findInitialRoot, flushSync, fromRef, getInstanceProps, getPrimary, getPrimaryIds, getRootState, getScheduler, getUuidPrefix, hasConstructor, hasPrimary, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isFromRef, isObject3D, isOnce, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, once, prepare, presetsObj, reconciler, registerPrimary, removeInteractivity, resolve, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useMutableCallback, useRenderTarget, useStore, useTexture, useTextures, useThree, waitForPrimary };
4409
+ export type { Act, AddPhaseOptions, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferLike, BufferRecord, BufferStore, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DisposeOptions, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameControls, FrameNextCallback, FrameNextControls, FrameNextState, FrameState, FrameTimingState, Frameloop, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeProps, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootOptions, RootState, RootStore, SchedulerApi, SetBlock, Size, StorageLike, StorageRecord, StorageStore, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseFrameNextOptions, UseFrameOptions, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };