@react-three/fiber 10.0.0-canary.2b511a5 → 10.0.0-canary.39882dd

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
@@ -1,16 +1,18 @@
1
+ import * as three_examples_jsm_inspector_Inspector_js from 'three/examples/jsm/inspector/Inspector.js';
1
2
  import * as three_webgpu from 'three/webgpu';
2
- import { RenderTarget, WebGPURenderer, CanvasTarget, Node, ShaderNodeObject, Euler as Euler$2, Color as Color$2, ColorRepresentation as ColorRepresentation$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, Loader as Loader$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Object3D, Frustum, OrthographicCamera } from 'three/webgpu';
3
+ import { CubeRenderTarget, RenderTarget, WebGPURenderer, Node, StorageTexture, Data3DTexture, CanvasTarget, ShaderNodeObject, Euler as Euler$2, Color as Color$2, ColorRepresentation as ColorRepresentation$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, Loader as Loader$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Object3D, Frustum, OrthographicCamera } from 'three/webgpu';
3
4
  import * as THREE$1 from 'three';
4
- import { WebGLRenderTarget, WebGLRenderer, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1 } from 'three';
5
+ import { WebGLCubeRenderTarget, WebGLRenderTarget, WebGLRenderer, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1 } from 'three';
5
6
  import { WebGLRendererParameters } from 'three/src/renderers/WebGLRenderer.js';
6
7
  import { Inspector } from 'three/addons/inspector/Inspector.js';
7
8
  import * as React$1 from 'react';
8
9
  import { ReactNode, Component, RefObject, JSX } from 'react';
9
10
  import { StoreApi } from 'zustand';
10
11
  import { UseBoundStoreWithEqualityFn } from 'zustand/traditional';
12
+ import { FrameTimingState, FrameCallback as FrameCallback$1, SchedulerApi, UseFrameNextOptions, FrameNextControls } from '@pmndrs/scheduler';
13
+ export { AddPhaseOptions, FrameControls, FrameNextControls, FrameTimingState, RootOptions, Scheduler, SchedulerApi, UseFrameNextOptions, UseFrameOptions, getScheduler } from '@pmndrs/scheduler';
11
14
  import { Options } from 'react-use-measure';
12
15
  import * as react_jsx_runtime from 'react/jsx-runtime';
13
- import { ThreeElement as ThreeElement$1, Euler as Euler$3 } from '@react-three/fiber';
14
16
  import { GroundedSkybox } from 'three/examples/jsm/objects/GroundedSkybox.js';
15
17
 
16
18
  function _mergeNamespaces(n, m) {
@@ -46,15 +48,22 @@ function _mergeNamespaces(n, m) {
46
48
  declare const R3F_BUILD_LEGACY = true;
47
49
  declare const R3F_BUILD_WEBGPU = true;
48
50
 
51
+ /** Lazily load the three Inspector. Keeps it out of the eager module graph — see note above. */
52
+ declare function loadInspector(): Promise<typeof three_examples_jsm_inspector_Inspector_js.Inspector>;
53
+
49
54
  var THREE = /*#__PURE__*/_mergeNamespaces({
50
55
  __proto__: null,
56
+ CubeRenderTarget: CubeRenderTarget,
57
+ CubeRenderTargetCompat: CubeRenderTarget,
51
58
  Inspector: Inspector,
52
59
  R3F_BUILD_LEGACY: R3F_BUILD_LEGACY,
53
60
  R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
54
61
  RenderTargetCompat: RenderTarget,
62
+ WebGLCubeRenderTarget: WebGLCubeRenderTarget,
55
63
  WebGLRenderTarget: WebGLRenderTarget,
56
64
  WebGLRenderer: WebGLRenderer,
57
- WebGLRendererParameters: WebGLRendererParameters
65
+ WebGLRendererParameters: WebGLRendererParameters,
66
+ loadInspector: loadInspector
58
67
  }, [three_webgpu]);
59
68
 
60
69
  //* Utility Types ==============================
@@ -149,6 +158,8 @@ interface IntersectionEvent<TSourceEvent> extends Intersection {
149
158
  unprojectedPoint: THREE$1.Vector3
150
159
  /** Normalized event coordinates */
151
160
  pointer: THREE$1.Vector2
161
+ /** pointerId of the original event for multiple pointer events */
162
+ pointerId: number
152
163
  /** Delta between first click and this event */
153
164
  delta: number
154
165
  /** The ray that pierced it */
@@ -225,6 +236,18 @@ interface EventHandlers {
225
236
  type FilterFunction = (items: THREE$1.Intersection[], state: RootState) => THREE$1.Intersection[]
226
237
  type ComputeFunction = (event: DomEvent, root: RootState, previous?: RootState) => void
227
238
 
239
+ /** Configuration for XR pointer registration (controllers/hands) */
240
+ interface XRPointerConfig {
241
+ /** Ray origin (updated each frame by XR system) */
242
+ ray: THREE$1.Ray
243
+ /** Optional: custom compute function for this pointer */
244
+ compute?: (state: RootState) => void
245
+ /** Pointer type identifier */
246
+ type: 'controller' | 'hand' | 'gaze'
247
+ /** Which hand (for controller/hand types) */
248
+ handedness?: 'left' | 'right'
249
+ }
250
+
228
251
  interface EventManager<TTarget> {
229
252
  /** Determines if the event layer is active */
230
253
  enabled: boolean
@@ -244,8 +267,21 @@ interface EventManager<TTarget> {
244
267
  disconnect?: () => void
245
268
  /** Triggers a onPointerMove with the last known event. This can be useful to enable raycasting without
246
269
  * explicit user interaction, for instance when the camera moves a hoverable object underneath the cursor.
270
+ * @param pointerId - Optional pointer ID to update specific pointer only
247
271
  */
248
- update?: () => void
272
+ update?: (pointerId?: number) => void
273
+ /** Defer pointer move raycasting to frame start (default: true) */
274
+ frameTimedRaycasts?: boolean
275
+ /** Always fire raycaster immediately on scroll events (default: true) */
276
+ alwaysFireOnScroll?: boolean
277
+ /** Automatically re-raycast every frame to detect hover changes from moving objects/camera (default: false) */
278
+ updateOnFrame?: boolean
279
+ /** Flush deferred pointer raycasts. Called by scheduler at frame start (input phase). */
280
+ flush?: () => void
281
+ /** Register an XR pointer (controller/hand). Returns assigned pointerId */
282
+ registerPointer?: (config: XRPointerConfig) => number
283
+ /** Unregister an XR pointer */
284
+ unregisterPointer?: (pointerId: number) => void
249
285
  }
250
286
 
251
287
  interface PointerCaptureTarget {
@@ -265,227 +301,94 @@ interface VisibilityEntry {
265
301
  }
266
302
 
267
303
  //* Scheduler Types (useFrame) ==============================
304
+ //
305
+ // The generic, framework-agnostic scheduler types now live in @pmndrs/scheduler.
306
+ // This file re-exports them and layers r3f's RootState-aware frame state on top,
307
+ // so existing `#types` imports across the codebase keep resolving unchanged.
268
308
 
269
309
 
270
310
 
271
- // Public Options --------------------------------
272
-
273
- /**
274
- * Options for useFrame hook
275
- */
276
- interface UseFrameNextOptions {
277
- /** Optional stable id for the job. Auto-generated if not provided */
278
- id?: string
279
- /** Named phase to run in. Default: 'update' */
280
- phase?: string
281
- /** Run before this phase or job id */
282
- before?: string | string[]
283
- /** Run after this phase or job id */
284
- after?: string | string[]
285
- /** Priority within phase. Higher runs first. Default: 0 */
286
- priority?: number
287
- /** Max frames per second for this job */
288
- fps?: number
289
- /** If true, skip frames when behind. If false, try to catch up. Default: true */
290
- drop?: boolean
291
- /** Enable/disable without unregistering. Default: true */
292
- enabled?: boolean
293
- }
294
-
295
- /** Alias for UseFrameNextOptions */
296
- type UseFrameOptions = UseFrameNextOptions
311
+ // Frame State (r3f-specific) --------------------------------
297
312
 
298
313
  /**
299
- * Options for addPhase
314
+ * State passed to useFrame callbacks (extends RootState with timing).
300
315
  */
301
- interface AddPhaseOptions {
302
- /** Insert this phase before the specified phase */
303
- before?: string
304
- /** Insert this phase after the specified phase */
305
- after?: string
306
- }
316
+ interface FrameNextState extends RootState, FrameTimingState {}
307
317
 
308
- // Frame State --------------------------------
318
+ /** Alias for FrameNextState */
319
+ type FrameState = FrameNextState
309
320
 
310
- /**
311
- * Timing-only state for independent/outside mode (no RootState)
312
- */
313
- interface FrameTimingState {
314
- /** High-resolution timestamp from RAF (ms) */
315
- time: number
316
- /** Time since last frame in seconds (for legacy compatibility with THREE.Clock) */
317
- delta: number
318
- /** Elapsed time since first frame in seconds (for legacy compatibility with THREE.Clock) */
319
- elapsed: number
320
- /** Incrementing frame counter */
321
- frame: number
322
- }
321
+ // Callback Types (r3f-specific) --------------------------------
323
322
 
324
323
  /**
325
- * State passed to useFrame callbacks (extends RootState with timing)
324
+ * Callback function for useFrame. Receives the full r3f RootState plus timing.
326
325
  */
327
- interface FrameNextState extends RootState, FrameTimingState {}
326
+ type FrameNextCallback = FrameCallback$1<RootState>
328
327
 
329
- /** Alias for FrameNextState */
330
- type FrameState = FrameNextState
328
+ /** Alias for FrameNextCallback */
329
+ type FrameCallback = FrameNextCallback
331
330
 
332
- // Root Options --------------------------------
331
+ //* Buffer Types (useBuffers) ========================================
333
332
 
334
333
  /**
335
- * Options for registerRoot
334
+ * Buffer-like types for GPU compute and storage operations.
335
+ * Includes raw CPU arrays, Three.js buffer attributes, and TSL buffer nodes.
336
+ *
337
+ * @example
338
+ * ```tsx
339
+ * const { positions, velocities } = useBuffers(() => ({
340
+ * positions: instancedArray(count, 'vec3'), // StorageBufferNode
341
+ * velocities: new Float32Array(count * 3), // TypedArray
342
+ * }), 'particles')
343
+ * ```
336
344
  */
337
- interface RootOptions {
338
- /** State provider for callbacks. Optional in independent mode. */
339
- getState?: () => any
340
- /** Error handler for job errors. Falls back to console.error if not provided. */
341
- onError?: (error: Error) => void
342
- }
345
+ type BufferLike =
346
+ | Float32Array
347
+ | Uint32Array
348
+ | Int32Array
349
+ | Float64Array
350
+ | Uint8Array
351
+ | Int8Array
352
+ | Uint16Array
353
+ | Int16Array
354
+ | THREE$1.BufferAttribute // Base class for all buffer attributes
355
+ | Node // TSL buffer nodes (instancedArray, storage)
343
356
 
344
- // Callback Types --------------------------------
357
+ /** Flat record of buffer-like values (no nested scopes) */
358
+ type BufferRecord = Record<string, BufferLike>
345
359
 
346
360
  /**
347
- * Callback function for useFrame
361
+ * Buffer store that can contain both root-level buffers and scoped buffer objects.
362
+ * Structure: { positions: Float32Array, particles: { vel: StorageBufferNode } }
348
363
  */
349
- type FrameNextCallback = (state: FrameNextState, delta: number) => void
364
+ type BufferStore = Record<string, BufferLike | BufferRecord>
350
365
 
351
- /** Alias for FrameNextCallback */
352
- type FrameCallback = FrameNextCallback
353
-
354
- // Controls returned from useFrame --------------------------------
366
+ //* Storage Types (useGPUStorage) ========================================
355
367
 
356
368
  /**
357
- * Controls object returned from useFrame hook
369
+ * GPU storage types for texture-based storage operations.
370
+ * Includes Three.js storage textures and TSL storage texture nodes.
371
+ *
372
+ * @example
373
+ * ```tsx
374
+ * const { heightMap } = useGPUStorage(() => ({
375
+ * heightMap: new StorageTexture(512, 512),
376
+ * }), 'terrain')
377
+ * ```
358
378
  */
359
- interface FrameNextControls {
360
- /** The job's unique ID */
361
- id: string
362
- /** Access to the global scheduler for frame loop control */
363
- scheduler: SchedulerApi
364
- /** Manually step this job only (bypasses FPS limiting) */
365
- step(timestamp?: number): void
366
- /** Manually step ALL jobs in the scheduler */
367
- stepAll(timestamp?: number): void
368
- /** Pause this job (set enabled=false) */
369
- pause(): void
370
- /** Resume this job (set enabled=true) */
371
- resume(): void
372
- /** Reactive paused state - automatically triggers re-render when changed */
373
- isPaused: boolean
374
- }
379
+ type StorageLike =
380
+ | StorageTexture // GPU storage texture
381
+ | Data3DTexture // 3D texture (can be used as storage)
382
+ | Node // TSL storage texture nodes (storageTexture)
375
383
 
376
- /** Alias for FrameNextControls */
377
- type FrameControls = FrameNextControls
378
-
379
- // Scheduler Interface --------------------------------
384
+ /** Flat record of storage-like values (no nested scopes) */
385
+ type StorageRecord = Record<string, StorageLike>
380
386
 
381
387
  /**
382
- * Public interface for the global Scheduler
388
+ * Storage store that can contain both root-level storage and scoped storage objects.
389
+ * Structure: { heightMap: StorageTexture, terrain: { normal: StorageTextureNode } }
383
390
  */
384
- interface SchedulerApi {
385
- //* Phase Management --------------------------------
386
-
387
- /** Add a named phase to the scheduler */
388
- addPhase(name: string, options?: AddPhaseOptions): void
389
- /** Get the ordered list of phase names */
390
- readonly phases: string[]
391
- /** Check if a phase exists */
392
- hasPhase(name: string): boolean
393
-
394
- //* Root Management --------------------------------
395
-
396
- /** Register a root (Canvas) with the scheduler. Returns unsubscribe function. */
397
- registerRoot(id: string, options?: RootOptions): () => void
398
- /** Unregister a root */
399
- unregisterRoot(id: string): void
400
- /** Generate a unique root ID */
401
- generateRootId(): string
402
- /** Get the number of registered roots */
403
- getRootCount(): number
404
- /** Check if any root is registered and ready */
405
- readonly isReady: boolean
406
- /** Subscribe to root-ready event. Fires immediately if already ready. Returns unsubscribe. */
407
- onRootReady(callback: () => void): () => void
408
-
409
- //* Job Registration --------------------------------
410
-
411
- /** Register a job with the scheduler (returns unsubscribe function) */
412
- register(
413
- callback: FrameNextCallback,
414
- options?: {
415
- id?: string
416
- rootId?: string
417
- phase?: string
418
- before?: string | string[]
419
- after?: string | string[]
420
- priority?: number
421
- fps?: number
422
- drop?: boolean
423
- enabled?: boolean
424
- },
425
- ): () => void
426
- /** Update a job's options */
427
- updateJob(
428
- id: string,
429
- options: {
430
- priority?: number
431
- fps?: number
432
- drop?: boolean
433
- enabled?: boolean
434
- phase?: string
435
- before?: string | string[]
436
- after?: string | string[]
437
- },
438
- ): void
439
- /** Unregister a job by ID */
440
- unregister(id: string, rootId?: string): void
441
- /** Get the number of registered jobs */
442
- getJobCount(): number
443
- /** Get all job IDs */
444
- getJobIds(): string[]
445
-
446
- //* Global Jobs (for legacy addEffect/addAfterEffect) --------------------------------
447
-
448
- /** Register a global job (runs once per frame, not per-root). Returns unsubscribe function. */
449
- registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void
450
-
451
- //* Idle Callbacks (for legacy addTail) --------------------------------
452
-
453
- /** Register an idle callback (fires when loop stops). Returns unsubscribe function. */
454
- onIdle(callback: (timestamp: number) => void): () => void
455
-
456
- //* Frame Loop Control --------------------------------
457
-
458
- /** Start the scheduler loop */
459
- start(): void
460
- /** Stop the scheduler loop */
461
- stop(): void
462
- /** Check if the scheduler is running */
463
- readonly isRunning: boolean
464
- /** Get/set the frameloop mode ('always', 'demand', 'never') */
465
- frameloop: Frameloop
466
- /** Independent mode - runs without Canvas, callbacks receive timing-only state */
467
- independent: boolean
468
-
469
- //* Manual Stepping --------------------------------
470
-
471
- /** Manually step all jobs once (for frameloop='never' or testing) */
472
- step(timestamp?: number): void
473
- /** Manually step a single job by ID */
474
- stepJob(id: string, timestamp?: number): void
475
- /** Request frame(s) to be rendered (for frameloop='demand') */
476
- invalidate(frames?: number): void
477
-
478
- //* Per-Job Control --------------------------------
479
-
480
- /** Check if a job is paused */
481
- isJobPaused(id: string): boolean
482
- /** Pause a job */
483
- pauseJob(id: string): void
484
- /** Resume a job */
485
- resumeJob(id: string): void
486
- /** Subscribe to job state changes (for reactive isPaused). Returns unsubscribe function. */
487
- subscribeJobState(id: string, listener: () => void): () => void
488
- }
391
+ type StorageStore = Record<string, StorageLike | StorageRecord>
489
392
 
490
393
  //* Renderer Types ========================================
491
394
 
@@ -500,6 +403,18 @@ type Subscription = {
500
403
  store: RootStore
501
404
  }
502
405
 
406
+ /** Per-pointer state for multi-touch and XR support */
407
+ type PointerState = {
408
+ /** Objects currently hovered by this pointer */
409
+ hovered: Map<string, ThreeEvent<DomEvent>>
410
+ /** Objects capturing this pointer */
411
+ captured: Map<THREE$1.Object3D, PointerCaptureTarget>
412
+ /** Initial click position [x, y] */
413
+ initialClick: [x: number, y: number]
414
+ /** Objects hit on initial click */
415
+ initialHits: THREE$1.Object3D[]
416
+ }
417
+
503
418
  type Dpr = number | [min: number, max: number]
504
419
 
505
420
  interface Size {
@@ -541,12 +456,21 @@ interface Performance {
541
456
 
542
457
  interface InternalState {
543
458
  interaction: THREE$1.Object3D[]
544
- hovered: Map<string, ThreeEvent<DomEvent>>
545
459
  subscribers: Subscription[]
460
+ /** Per-pointer state (hover, capture, click tracking) - replaces hovered, capturedMap, initialClick, initialHits */
461
+ pointerMap: Map<number, PointerState>
462
+ /** Pointers needing raycast this frame (used with frameTimedRaycasts) */
463
+ pointerDirty: Map<number, DomEvent>
464
+ /** Last event received (for events.update() compatibility) */
465
+ lastEvent: React$1.RefObject<DomEvent | null>
466
+ /** @deprecated Use pointerMap.get(pointerId).hovered instead */
467
+ hovered: Map<string, ThreeEvent<DomEvent>>
468
+ /** @deprecated Use pointerMap.get(pointerId).captured instead */
546
469
  capturedMap: Map<number, Map<THREE$1.Object3D, PointerCaptureTarget>>
470
+ /** @deprecated Use pointerMap.get(pointerId).initialClick instead */
547
471
  initialClick: [x: number, y: number]
472
+ /** @deprecated Use pointerMap.get(pointerId).initialHits instead */
548
473
  initialHits: THREE$1.Object3D[]
549
- lastEvent: React$1.RefObject<DomEvent | null>
550
474
  /** Visibility event registry (onFramed, onOccluded, onVisible) */
551
475
  visibilityRegistry: Map<string, VisibilityEntry>
552
476
  /** Whether occlusion queries are enabled (WebGPU only) */
@@ -577,9 +501,21 @@ interface InternalState {
577
501
  * @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
578
502
  */
579
503
  canvasTarget?: CanvasTarget
504
+ /**
505
+ * Set when this root's canvas target has been resized and the backend's cached render pass
506
+ * descriptor (which holds a depth-stencil view built once per canvas) is therefore stale.
507
+ *
508
+ * Flushed by the canvas-target job in the `start` phase, which is the only place this root's
509
+ * target is guaranteed to be the renderer's active one — `backend.updateSize()` operates on
510
+ * whatever `getCanvasTarget()` returns, so calling it from the resize subscription would
511
+ * invalidate some other canvas's descriptor instead.
512
+ *
513
+ * @see https://github.com/pmndrs/react-three-fiber/issues/3847
514
+ */
515
+ canvasTargetSizeDirty?: boolean
580
516
  /**
581
517
  * Whether multi-canvas rendering is active.
582
- * True when any canvas uses `target` prop to share a renderer.
518
+ * True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
583
519
  * When true, setCanvasTarget is called before each render.
584
520
  */
585
521
  isMultiCanvas?: boolean
@@ -677,8 +613,8 @@ interface RootState {
677
613
  setSize: (width?: number, height?: number, top?: number, left?: number) => void
678
614
  /** Shortcut to manual setting the pixel ratio */
679
615
  setDpr: (dpr: Dpr) => void
680
- /** Shortcut to setting frameloop flags */
681
- setFrameloop: (frameloop: Frameloop) => void
616
+ /** Shortcut to setting frameloop flags. No args resets to 'always'. */
617
+ setFrameloop: (frameloop?: Frameloop) => void
682
618
  /** Set error state to propagate to error boundary */
683
619
  setError: (error: Error | null) => void
684
620
  /** Current error state (null when no error) */
@@ -687,11 +623,17 @@ interface RootState {
687
623
  uniforms: UniformStore
688
624
  /** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
689
625
  nodes: Record<string, any>
690
- /** Global TSL texture nodes - use useTextures() hook for operations */
691
- textures: Map<string, any>
692
- /** WebGPU PostProcessing instance - use usePostProcessing() hook */
693
- postProcessing: any | null // THREE.PostProcessing when available
694
- /** Global TSL pass nodes for post-processing - use usePostProcessing() hook */
626
+ /** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
627
+ buffers: BufferStore
628
+ /** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
629
+ gpuStorage: StorageStore
630
+ /** Global Texture registry (key → Texture, usually keyed by URL) - use useTextures() hook for access + lifecycle */
631
+ textures: Map<string, THREE$1.Texture>
632
+ /** Internal: refcount per texture key, driven by mounted useTexture consumers (registry enrollment is on by default) */
633
+ _textureRefs: Map<string, number>
634
+ /** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
635
+ renderPipeline: ThreeRenderPipeline | null
636
+ /** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
695
637
  passes: Record<string, any>
696
638
  /** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
697
639
  _hmrVersion: number
@@ -741,6 +683,20 @@ interface Renderer {
741
683
  render: (scene: THREE$1.Scene, camera: THREE$1.Camera) => any
742
684
  }
743
685
 
686
+ //* Color Management Config ==============================
687
+
688
+ /**
689
+ * Color management configuration shared by both WebGL and WebGPU renderers.
690
+ */
691
+ interface ColorManagementConfig {
692
+ /**
693
+ * Color space assigned to 8-bit input textures (color maps).
694
+ * Defaults to sRGB. Most textures are authored in sRGB.
695
+ * @default THREE.SRGBColorSpace
696
+ */
697
+ textureColorSpace?: THREE$1.ColorSpace
698
+ }
699
+
744
700
  //* WebGL Renderer Props ==============================
745
701
 
746
702
  type DefaultGLProps = Omit<THREE$1.WebGLRendererParameters, 'canvas'> & {
@@ -751,7 +707,7 @@ type GLProps =
751
707
  | Renderer
752
708
  | ((defaultProps: DefaultGLProps) => Renderer)
753
709
  | ((defaultProps: DefaultGLProps) => Promise<Renderer>)
754
- | Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters>
710
+ | (Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters> & ColorManagementConfig)
755
711
 
756
712
  //* WebGPU Renderer Props ==============================
757
713
 
@@ -766,20 +722,27 @@ type DefaultRendererProps = {
766
722
  */
767
723
  interface CanvasSchedulerConfig {
768
724
  /**
769
- * Render this canvas after another canvas completes.
770
- * Pass the `id` of another canvas.
725
+ * Run this Canvas root before the referenced Canvas root id(s).
726
+ */
727
+ before?: string | string[]
728
+ /**
729
+ * Run this Canvas root after the referenced Canvas root id(s).
730
+ */
731
+ after?: string | string[]
732
+ /**
733
+ * Numeric root order. Lower values run first.
771
734
  */
772
- after?: string
735
+ order?: number
773
736
  /**
774
- * Limit this canvas's render rate (frames per second).
737
+ * Limit this Canvas's default render job (frames per second).
775
738
  */
776
739
  fps?: number
777
740
  }
778
741
 
779
742
  /**
780
- * Extended renderer configuration for multi-canvas support.
743
+ * Extended renderer configuration for multi-canvas support and color management.
781
744
  */
782
- interface RendererConfigExtended {
745
+ interface RendererConfigExtended extends ColorManagementConfig {
783
746
  /** Share renderer from another canvas (WebGPU only) */
784
747
  primaryCanvas?: string
785
748
  /** Canvas-level scheduler options */
@@ -844,8 +807,6 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
844
807
  * @see https://threejs.org/docs/#api/en/renderers/WebGLRenderer.shadowMap
845
808
  */
846
809
  shadows?: boolean | 'basic' | 'percentage' | 'soft' | 'variance' | Partial<THREE$1.WebGLShadowMap>
847
- /** Color space assigned to 8-bit input textures (color maps). Defaults to sRGB. Most textures are authored in sRGB. */
848
- textureColorSpace?: THREE$1.ColorSpace
849
810
  /** Creates an orthographic camera */
850
811
  orthographic?: boolean
851
812
  /**
@@ -971,8 +932,6 @@ interface Instance<O = any> {
971
932
  attach?: AttachType<O>
972
933
  previousAttach?: any
973
934
  isHidden: boolean
974
- /** Deferred ref props to apply in commitMount */
975
- deferredRefs?: Array<{ prop: string; ref: React$1.RefObject<any> }>
976
935
  /** Set of props that have been applied via once() */
977
936
  appliedOnce?: Set<string>
978
937
  }
@@ -1098,7 +1057,7 @@ interface CanvasProps
1098
1057
  */
1099
1058
  resize?: Options
1100
1059
  /** The target where events are being subscribed to, default: the div that wraps canvas */
1101
- eventSource?: HTMLElement | React$1.RefObject<HTMLElement>
1060
+ eventSource?: HTMLElement | React$1.RefObject<HTMLElement | null>
1102
1061
  /** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
1103
1062
  eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
1104
1063
  /** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
@@ -1209,10 +1168,21 @@ type RenderTargetOptions = RenderTargetOptions$1
1209
1168
  //* Global Types ==============================
1210
1169
 
1211
1170
  declare global {
1212
- /** Uniform node type - a Node with a value property (matches Three.js UniformNode) */
1213
- interface UniformNode<T = unknown> extends Node {
1214
- value: T
1215
- }
1171
+ /**
1172
+ * Uniform node type.
1173
+ *
1174
+ * This is three's own `UniformNode`, not a re-declaration of it. It previously was a
1175
+ * hand-rolled `interface UniformNode<T> extends Node { value: T }`, which shadowed the real
1176
+ * exported type globally — so R3F's ~58 references resolved to an approximation that was
1177
+ * missing members three actually ships (`setName` among them) and had drifted to the wrong
1178
+ * arity when three made `UniformNode` two-parameter.
1179
+ *
1180
+ * three's signature is `UniformNode<TNodeType, TValue>`. R3F only ever varies the value type,
1181
+ * so the node type is fixed to `unknown` and the single parameter is kept for call-site
1182
+ * ergonomics. The result is three's structural type, so members stay in sync with the
1183
+ * installed three instead of needing to be mirrored by hand.
1184
+ */
1185
+ type UniformNode<T = unknown> = three_webgpu.UniformNode<unknown, T>
1216
1186
 
1217
1187
  /**
1218
1188
  * ShaderCallable - the return type of Fn()
@@ -1312,6 +1282,7 @@ declare global {
1312
1282
  | three_webgpu.Euler
1313
1283
  | three_webgpu.Quaternion
1314
1284
  | { x: number; y?: number; z?: number; w?: number } // Plain objects converted to vectors
1285
+ | { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
1315
1286
  | Node // TSL nodes like color(), vec3(), float() for type casting
1316
1287
  | UniformNode
1317
1288
 
@@ -1356,179 +1327,45 @@ declare module 'three/tsl' {
1356
1327
  ): ShaderCallable<R>
1357
1328
  }
1358
1329
 
1359
- /**
1360
- * PostProcessing Types for usePostProcessing hook (WebGPU only)
1361
- */
1362
-
1363
-
1364
-
1365
1330
  declare global {
1366
- /** Pass record - stores TSL pass nodes for post-processing */
1331
+ /**
1332
+ * three's own render pipeline type. Named here so the rest of R3F refers to three's shape
1333
+ * rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
1334
+ * is r185, so the new name is the only one.
1335
+ */
1336
+ type ThreeRenderPipeline = three_webgpu.RenderPipeline
1337
+
1338
+ /** Pass record - stores TSL pass nodes for render pipeline */
1367
1339
  type PassRecord = Record<string, any>
1368
1340
 
1341
+ /** State passed to pipeline callbacks after the active pipeline has been created */
1342
+ type RenderPipelineCallbackState = RootState & {
1343
+ renderPipeline: ThreeRenderPipeline
1344
+ }
1345
+
1369
1346
  /** Setup callback - runs first to configure MRT, create additional passes */
1370
- type PostProcessingSetupCallback = (state: RootState) => PassRecord | void
1347
+ type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => PassRecord | void
1371
1348
 
1372
1349
  /** Main callback - runs second to configure outputNode, create effect passes */
1373
- type PostProcessingMainCallback = (state: RootState) => PassRecord | void
1350
+ type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => PassRecord | void
1374
1351
 
1375
- /** Return type for usePostProcessing hook */
1376
- interface UsePostProcessingReturn {
1352
+ /** Return type for useRenderPipeline hook */
1353
+ interface UseRenderPipelineReturn {
1377
1354
  /** Current passes from state */
1378
1355
  passes: PassRecord
1379
- /** PostProcessing instance (null if not initialized) */
1380
- postProcessing: any | null // THREE.PostProcessing
1356
+ /** RenderPipeline instance (null if not initialized) */
1357
+ renderPipeline: ThreeRenderPipeline | null
1381
1358
  /** Clear all passes from state */
1382
1359
  clearPasses: () => void
1383
- /** Reset PostProcessing entirely (clears PP + passes) */
1360
+ /** Reset RenderPipeline entirely (clears PP + passes) */
1384
1361
  reset: () => void
1385
1362
  /** Re-run setup/main callbacks with current closure values */
1386
1363
  rebuild: () => void
1387
- /** True when PostProcessing is configured and ready */
1364
+ /** True when RenderPipeline is configured and ready */
1388
1365
  isReady: boolean
1389
1366
  }
1390
1367
  }
1391
1368
 
1392
- //* useFrameNext Types ==============================
1393
-
1394
-
1395
-
1396
- //* Global Type Declarations ==============================
1397
-
1398
- declare global {
1399
- // Job --------------------------------
1400
-
1401
- /**
1402
- * Internal job representation in the scheduler
1403
- */
1404
- interface Job {
1405
- /** Unique identifier */
1406
- id: string
1407
- /** The callback to execute */
1408
- callback: FrameNextCallback
1409
- /** Phase this job belongs to */
1410
- phase: string
1411
- /** Run before these phases/job ids */
1412
- before: Set<string>
1413
- /** Run after these phases/job ids */
1414
- after: Set<string>
1415
- /** Priority within phase (higher first) */
1416
- priority: number
1417
- /** Insertion order for deterministic tie-breaking */
1418
- index: number
1419
- /** Max FPS for this job (undefined = no limit) */
1420
- fps?: number
1421
- /** Drop frames when behind (true) or catch up (false) */
1422
- drop: boolean
1423
- /** Last run timestamp (ms) */
1424
- lastRun?: number
1425
- /** Whether job is enabled */
1426
- enabled: boolean
1427
- /** Internal flag: system jobs (like default render) don't block user render takeover */
1428
- system?: boolean
1429
- }
1430
-
1431
- // Phase Graph --------------------------------
1432
-
1433
- /**
1434
- * A node in the phase graph
1435
- */
1436
- interface PhaseNode {
1437
- /** Phase name */
1438
- name: string
1439
- /** Whether this was auto-generated from a before/after constraint */
1440
- isAutoGenerated: boolean
1441
- }
1442
-
1443
- /**
1444
- * Options for creating a job from hook options
1445
- */
1446
- interface JobOptions {
1447
- id?: string
1448
- phase?: string
1449
- before?: string | string[]
1450
- after?: string | string[]
1451
- priority?: number
1452
- fps?: number
1453
- drop?: boolean
1454
- enabled?: boolean
1455
- }
1456
-
1457
- // Frame Loop State --------------------------------
1458
-
1459
- /**
1460
- * Internal frame loop state
1461
- */
1462
- interface FrameLoopState {
1463
- /** Whether the loop is running */
1464
- running: boolean
1465
- /** Current RAF handle */
1466
- rafHandle: number | null
1467
- /** Last frame timestamp in ms (null = uninitialized) */
1468
- lastTime: number | null
1469
- /** Frame counter */
1470
- frameCount: number
1471
- /** Elapsed time since first frame in ms */
1472
- elapsedTime: number
1473
- /** createdAt timestamp in ms */
1474
- createdAt: number
1475
- }
1476
-
1477
- // Root Entry --------------------------------
1478
-
1479
- /**
1480
- * Internal representation of a registered root (Canvas).
1481
- * Tracks jobs and manages rebuild state for this root.
1482
- * @internal
1483
- */
1484
- interface RootEntry {
1485
- /** Unique identifier for this root */
1486
- id: string
1487
- /** Function to get the root's current state. Returns any to support independent mode. */
1488
- getState: () => any
1489
- /** Map of job IDs to Job objects */
1490
- jobs: Map<string, Job>
1491
- /** Cached sorted job list for execution order */
1492
- sortedJobs: Job[]
1493
- /** Whether sortedJobs needs rebuilding */
1494
- needsRebuild: boolean
1495
- }
1496
-
1497
- /**
1498
- * Internal representation of a global job (deprecated API).
1499
- * Global jobs run once per frame, not per-root.
1500
- * Used by legacy addEffect/addAfterEffect APIs.
1501
- * @internal
1502
- * @deprecated Use useFrame with phases instead
1503
- */
1504
- interface GlobalJob {
1505
- /** Unique identifier for this global job */
1506
- id: string
1507
- /** Callback invoked with RAF timestamp in ms */
1508
- callback: (timestamp: number) => void
1509
- }
1510
-
1511
- // HMR Support --------------------------------
1512
-
1513
- /**
1514
- * Hot Module Replacement data structure for preserving scheduler state
1515
- * @internal
1516
- */
1517
- interface HMRData {
1518
- /** Shared data object for storing values across reloads */
1519
- data: Record<string, any>
1520
- /** Optional function to accept HMR updates */
1521
- accept?: () => void
1522
- }
1523
-
1524
- // Default Phases --------------------------------
1525
-
1526
- /**
1527
- * Default phase names for the scheduler
1528
- */
1529
- type DefaultPhase = 'start' | 'input' | 'physics' | 'update' | 'render' | 'finish'
1530
- }
1531
-
1532
1369
  type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
1533
1370
 
1534
1371
  interface MathRepresentation {
@@ -1698,7 +1535,7 @@ declare namespace three_d {
1698
1535
  * a single WebGPURenderer using Three.js CanvasTarget API.
1699
1536
  *
1700
1537
  * Primary canvas: Has `id` prop, creates its own renderer, registers here
1701
- * Secondary canvas: Has `target="id"` prop, shares primary's renderer via CanvasTarget
1538
+ * Secondary canvas: Has `renderer={{ primaryCanvas: 'id' }}`, shares primary's renderer via CanvasTarget
1702
1539
  */
1703
1540
 
1704
1541
  interface PrimaryCanvasEntry {
@@ -1766,12 +1603,23 @@ type EnvironmentLoaderProps = {
1766
1603
  * const texture = useEnvironment({ preset: 'sunset' })
1767
1604
  * ```
1768
1605
  */
1769
- declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown> | CubeTexture;
1606
+ declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown, THREE$1.TextureEventMap> | CubeTexture<unknown>;
1770
1607
  declare namespace useEnvironment {
1771
1608
  var preload: (preloadOptions?: EnvironmentLoaderPreloadOptions) => void;
1772
1609
  var clear: (clearOptions?: EnvironmentLoaderClearOptions) => void;
1773
1610
  }
1774
- type EnvironmentLoaderPreloadOptions = Omit<EnvironmentLoaderProps, 'encoding'>;
1611
+ /**
1612
+ * Options accepted by `useEnvironment.preload`.
1613
+ *
1614
+ * `colorSpace` is deliberately omitted: preload only warms the loader cache, and colorSpace is
1615
+ * applied to the texture by `useEnvironment()` at use time, per consumer. Accepting it here would
1616
+ * advertise an option this function silently ignores.
1617
+ *
1618
+ * This previously read `Omit<…, 'encoding'>` — omitting a key that does not exist on
1619
+ * `EnvironmentLoaderProps`, a leftover from three's pre-`colorSpace` `encoding` API. That made the
1620
+ * type equivalent to the full props, so `colorSpace` was accepted and then dropped on the floor.
1621
+ */
1622
+ type EnvironmentLoaderPreloadOptions = Omit<EnvironmentLoaderProps, 'colorSpace'>;
1775
1623
  type EnvironmentLoaderClearOptions = Pick<EnvironmentLoaderProps, 'files' | 'preset'>;
1776
1624
 
1777
1625
  /**
@@ -1815,9 +1663,9 @@ type EnvironmentProps = {
1815
1663
  blur?: number;
1816
1664
  backgroundBlurriness?: number;
1817
1665
  backgroundIntensity?: number;
1818
- backgroundRotation?: Euler$3;
1666
+ backgroundRotation?: Euler;
1819
1667
  environmentIntensity?: number;
1820
- environmentRotation?: Euler$3;
1668
+ environmentRotation?: Euler;
1821
1669
  map?: Texture$1;
1822
1670
  preset?: PresetsType;
1823
1671
  scene?: Scene | React$1.RefObject<Scene>;
@@ -1901,7 +1749,7 @@ declare function EnvironmentCube({ background, scene, blur, backgroundBlurriness
1901
1749
  declare function EnvironmentPortal({ children, near, far, resolution, frames, map, background, blur, backgroundBlurriness, backgroundIntensity, backgroundRotation, environmentIntensity, environmentRotation, scene, files, path, preset, extensions, }: EnvironmentProps): react_jsx_runtime.JSX.Element;
1902
1750
  declare module '@react-three/fiber' {
1903
1751
  interface ThreeElements {
1904
- groundProjectedEnvImpl: ThreeElement$1<typeof GroundedSkybox>;
1752
+ groundProjectedEnvImpl: ThreeElement<typeof GroundedSkybox>;
1905
1753
  }
1906
1754
  }
1907
1755
  /**
@@ -2001,9 +1849,29 @@ declare module '@react-three/fiber' {
2001
1849
  */
2002
1850
  declare function Environment(props: EnvironmentProps): react_jsx_runtime.JSX.Element;
2003
1851
 
1852
+ /**
1853
+ * Moves every trace of interactivity from one object to its replacement, for reconstruction.
1854
+ *
1855
+ * When `args` or a `primitive`'s `object` changes, R3F builds a new three object and keeps the same
1856
+ * instance. Removing the old object from the interaction state and registering the new one from
1857
+ * scratch makes events *work* again (#3778), but it forgets what was in flight: a pointer resting on
1858
+ * the object fires a second `onPointerEnter` without ever having left, and an active pointer capture
1859
+ * is dropped mid-drag. Rewriting the references instead keeps the interaction continuous across a
1860
+ * swap the user never asked to see (#3744).
1861
+ *
1862
+ * Captures are re-keyed rather than released, so the DOM-level capture on `captureData.target` is
1863
+ * left alone — releasing and re-acquiring it is precisely the glitch being avoided.
1864
+ *
1865
+ * Visibility handlers are deliberately not transferred: that registry is keyed by `object.uuid`, so
1866
+ * the replacement re-registers itself through `applyProps`. The old entry is dropped here so it
1867
+ * cannot outlive the object it described.
1868
+ */
1869
+ declare function swapInteractivity(store: RootStore, object: Object3D, newObject: Object3D): void;
2004
1870
  declare function removeInteractivity(store: RootStore, object: Object3D): void;
2005
1871
  declare function createEvents(store: RootStore): {
2006
1872
  handlePointer: (name: string) => (event: DomEvent) => void;
1873
+ flushDeferredPointers: () => void;
1874
+ processDeferredPointer: (event: DomEvent, pointerId: number) => void;
2007
1875
  };
2008
1876
  /** Default R3F event manager for web */
2009
1877
  declare function createPointerEvents(store: RootStore): EventManager<HTMLElement>;
@@ -2019,389 +1887,27 @@ declare function getLoader<L extends LoaderLike | ConstructorRepresentation<Load
2019
1887
  * Note: this hook's caller must be wrapped with `React.Suspense`
2020
1888
  * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useloader
2021
1889
  */
2022
- declare function useLoader<I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void): I extends any[] ? LoaderResult<L>[] : LoaderResult<L>;
1890
+ declare function useLoader<I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void, cacheKey?: InputLike): I extends any[] ? LoaderResult<L>[] : LoaderResult<L>;
2023
1891
  declare namespace useLoader {
2024
- var preload: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void) => void;
2025
- var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I) => void;
1892
+ var preload: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void, cacheKey?: InputLike) => void;
1893
+ var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, cacheKey?: InputLike) => void;
2026
1894
  var loader: typeof getLoader;
2027
1895
  }
2028
1896
 
2029
- /**
2030
- * Global Singleton Scheduler - manages the frame loop and job execution for ALL R3F roots.
2031
- *
2032
- * Features:
2033
- * - Single RAF loop for entire application
2034
- * - Root registration (multiple Canvas support)
2035
- * - Global phases for addEffect/addAfterEffect (deprecated)
2036
- * - Per-root job management with phases, priorities, FPS throttling
2037
- * - onIdle callbacks for addTail (deprecated)
2038
- * - Demand mode support via invalidate()
2039
- */
2040
- declare class Scheduler {
2041
- private static readonly INSTANCE_KEY;
2042
- private static get instance();
2043
- private static set instance(value);
2044
- /**
2045
- * Get the global scheduler instance (creates if doesn't exist).
2046
- * Uses HMR data to preserve instance across hot reloads.
2047
- * @returns {Scheduler} The singleton scheduler instance
2048
- */
2049
- static get(): Scheduler;
2050
- /**
2051
- * Reset the singleton instance. Stops the loop and clears all state.
2052
- * Primarily used for testing to ensure clean state between tests.
2053
- * @returns {void}
2054
- */
2055
- static reset(): void;
2056
- private roots;
2057
- private phaseGraph;
2058
- private loopState;
2059
- private stoppedTime;
2060
- private nextRootIndex;
2061
- private globalBeforeJobs;
2062
- private globalAfterJobs;
2063
- private nextGlobalIndex;
2064
- private idleCallbacks;
2065
- private nextJobIndex;
2066
- private jobStateListeners;
2067
- private pendingFrames;
2068
- private _frameloop;
2069
- private _independent;
2070
- private errorHandler;
2071
- private rootReadyCallbacks;
2072
- get phases(): string[];
2073
- get frameloop(): Frameloop;
2074
- set frameloop(mode: Frameloop);
2075
- get isRunning(): boolean;
2076
- get isReady(): boolean;
2077
- get independent(): boolean;
2078
- set independent(value: boolean);
2079
- constructor();
2080
- /**
2081
- * Register a root (Canvas) with the scheduler.
2082
- * The first root to register starts the RAF loop (if frameloop='always').
2083
- * @param {string} id - Unique identifier for this root
2084
- * @param {RootOptions} [options] - Optional configuration with getState and onError callbacks
2085
- * @returns {() => void} Unsubscribe function to remove this root
2086
- */
2087
- registerRoot(id: string, options?: RootOptions): () => void;
2088
- /**
2089
- * Unregister a root from the scheduler.
2090
- * Cleans up all job state listeners for this root's jobs.
2091
- * The last root to unregister stops the RAF loop.
2092
- * @param {string} id - The root ID to unregister
2093
- * @returns {void}
2094
- */
2095
- unregisterRoot(id: string): void;
2096
- /**
2097
- * Subscribe to be notified when a root becomes available.
2098
- * Fires immediately if a root already exists.
2099
- * @param {() => void} callback - Function called when first root registers
2100
- * @returns {() => void} Unsubscribe function
2101
- */
2102
- onRootReady(callback: () => void): () => void;
2103
- /**
2104
- * Notify all registered root-ready callbacks.
2105
- * Called when the first root registers.
2106
- * @returns {void}
2107
- * @private
2108
- */
2109
- private notifyRootReady;
2110
- /**
2111
- * Ensure a default root exists for independent mode.
2112
- * Creates a minimal root with no state provider.
2113
- * @returns {void}
2114
- * @private
2115
- */
2116
- private ensureDefaultRoot;
2117
- /**
2118
- * Trigger error handling for job errors.
2119
- * Uses the bound error handler if available, otherwise logs to console.
2120
- * @param {Error} error - The error to handle
2121
- * @returns {void}
2122
- */
2123
- triggerError(error: Error): void;
2124
- /**
2125
- * Add a named phase to the scheduler's execution order.
2126
- * Marks all roots for rebuild to incorporate the new phase.
2127
- * @param {string} name - The phase name (e.g., 'physics', 'postprocess')
2128
- * @param {AddPhaseOptions} [options] - Positioning options (before/after other phases)
2129
- * @returns {void}
2130
- * @example
2131
- * scheduler.addPhase('physics', { before: 'update' });
2132
- * scheduler.addPhase('postprocess', { after: 'render' });
2133
- */
2134
- addPhase(name: string, options?: AddPhaseOptions): void;
2135
- /**
2136
- * Check if a phase exists in the scheduler.
2137
- * @param {string} name - The phase name to check
2138
- * @returns {boolean} True if the phase exists
2139
- */
2140
- hasPhase(name: string): boolean;
2141
- /**
2142
- * Register a global job that runs once per frame (not per-root).
2143
- * Used internally by deprecated addEffect/addAfterEffect APIs.
2144
- * @param {'before' | 'after'} phase - When to run: 'before' all roots or 'after' all roots
2145
- * @param {string} id - Unique identifier for this global job
2146
- * @param {(timestamp: number) => void} callback - Function called each frame with RAF timestamp
2147
- * @returns {() => void} Unsubscribe function to remove this global job
2148
- * @deprecated Use useFrame with phases instead
2149
- */
2150
- registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void;
2151
- /**
2152
- * Register an idle callback that fires when the loop stops.
2153
- * Used internally by deprecated addTail API.
2154
- * @param {(timestamp: number) => void} callback - Function called when loop becomes idle
2155
- * @returns {() => void} Unsubscribe function to remove this idle callback
2156
- * @deprecated Use demand mode with invalidate() instead
2157
- */
2158
- onIdle(callback: (timestamp: number) => void): () => void;
2159
- /**
2160
- * Notify all registered idle callbacks.
2161
- * Called when the loop stops in demand mode.
2162
- * @param {number} timestamp - The RAF timestamp when idle occurred
2163
- * @returns {void}
2164
- * @private
2165
- */
2166
- private notifyIdle;
2167
- /**
2168
- * Register a job (frame callback) with a specific root.
2169
- * This is the core registration method used by useFrame internally.
2170
- * @param {FrameNextCallback} callback - The function to call each frame
2171
- * @param {JobOptions & { rootId?: string; system?: boolean }} [options] - Job configuration
2172
- * @param {string} [options.rootId] - Target root ID (defaults to first registered root)
2173
- * @param {string} [options.id] - Unique job ID (auto-generated if not provided)
2174
- * @param {string} [options.phase] - Execution phase (defaults to 'update')
2175
- * @param {number} [options.priority] - Priority within phase (higher = earlier, default 0)
2176
- * @param {number} [options.fps] - FPS throttle limit
2177
- * @param {boolean} [options.drop] - Drop frames when behind (default true)
2178
- * @param {boolean} [options.enabled] - Whether job is active (default true)
2179
- * @param {boolean} [options.system] - Internal flag for system jobs (not user-facing)
2180
- * @returns {() => void} Unsubscribe function to remove this job
2181
- */
2182
- register(callback: FrameNextCallback, options?: JobOptions & {
2183
- rootId?: string;
2184
- system?: boolean;
2185
- }): () => void;
2186
- /**
2187
- * Unregister a job by its ID.
2188
- * Searches all roots if rootId is not provided.
2189
- * @param {string} id - The job ID to unregister
2190
- * @param {string} [rootId] - Optional root ID to search (searches all if not provided)
2191
- * @returns {void}
2192
- */
2193
- unregister(id: string, rootId?: string): void;
2194
- /**
2195
- * Update a job's options dynamically.
2196
- * Searches all roots to find the job by ID.
2197
- * Phase/constraint changes trigger a rebuild of the sorted job list.
2198
- * @param {string} id - The job ID to update
2199
- * @param {Partial<JobOptions>} options - The options to update
2200
- * @returns {void}
2201
- */
2202
- updateJob(id: string, options: Partial<JobOptions>): void;
2203
- /**
2204
- * Check if a job is currently paused (disabled).
2205
- * @param {string} id - The job ID to check
2206
- * @returns {boolean} True if the job exists and is paused
2207
- */
2208
- isJobPaused(id: string): boolean;
2209
- /**
2210
- * Subscribe to state changes for a specific job.
2211
- * Listener is called when job is paused or resumed.
2212
- * @param {string} id - The job ID to subscribe to
2213
- * @param {() => void} listener - Callback invoked on state changes
2214
- * @returns {() => void} Unsubscribe function
2215
- */
2216
- subscribeJobState(id: string, listener: () => void): () => void;
2217
- /**
2218
- * Notify all listeners that a job's state has changed.
2219
- * @param {string} id - The job ID that changed
2220
- * @returns {void}
2221
- * @private
2222
- */
2223
- private notifyJobStateChange;
2224
- /**
2225
- * Pause a job by ID (sets enabled=false).
2226
- * Notifies any subscribed state listeners.
2227
- * @param {string} id - The job ID to pause
2228
- * @returns {void}
2229
- */
2230
- pauseJob(id: string): void;
2231
- /**
2232
- * Resume a paused job by ID (sets enabled=true).
2233
- * Resets job timing to prevent frame accumulation.
2234
- * Notifies any subscribed state listeners.
2235
- * @param {string} id - The job ID to resume
2236
- * @returns {void}
2237
- */
2238
- resumeJob(id: string): void;
2239
- /**
2240
- * Start the requestAnimationFrame loop.
2241
- * Resets timing state (elapsedTime, frameCount) on start.
2242
- * No-op if already running.
2243
- * @returns {void}
2244
- */
2245
- start(): void;
2246
- /**
2247
- * Stop the requestAnimationFrame loop.
2248
- * Cancels any pending RAF callback.
2249
- * No-op if not running.
2250
- * @returns {void}
2251
- */
2252
- stop(): void;
2253
- /**
2254
- * Request frames to be rendered in demand mode.
2255
- * Accumulates pending frames (capped at 60) and starts the loop if not running.
2256
- * No-op if frameloop is not 'demand'.
2257
- * @param {number} [frames=1] - Number of frames to request
2258
- * @param {boolean} [stackFrames=false] - Whether to add frames to existing pending count
2259
- * - `false` (default): Sets pending frames to the specified value (replaces existing count)
2260
- * - `true`: Adds frames to existing pending count (useful for accumulating invalidations)
2261
- * @returns {void}
2262
- * @example
2263
- * // Request a single frame render
2264
- * scheduler.invalidate();
2265
- *
2266
- * @example
2267
- * // Request 5 frames (e.g., for animations)
2268
- * scheduler.invalidate(5);
2269
- *
2270
- * @example
2271
- * // Set pending frames to exactly 3 (don't stack with existing)
2272
- * scheduler.invalidate(3, false);
2273
- *
2274
- * @example
2275
- * // Add 2 more frames to existing pending count
2276
- * scheduler.invalidate(2, true);
2277
- */
2278
- invalidate(frames?: number, stackFrames?: boolean): void;
2279
- /**
2280
- * Reset timing state for deterministic testing.
2281
- * Preserves jobs and roots but resets lastTime, frameCount, elapsedTime, etc.
2282
- * @returns {void}
2283
- */
2284
- resetTiming(): void;
2285
- /**
2286
- * Manually execute a single frame for all roots.
2287
- * Useful for frameloop='never' mode or testing scenarios.
2288
- * @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
2289
- * @returns {void}
2290
- * @example
2291
- * // Manual control mode
2292
- * scheduler.frameloop = 'never';
2293
- * scheduler.step(); // Execute one frame
2294
- */
2295
- step(timestamp?: number): void;
2296
- /**
2297
- * Manually execute a single job by its ID.
2298
- * Useful for testing individual job callbacks in isolation.
2299
- * @param {string} id - The job ID to step
2300
- * @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
2301
- * @returns {void}
2302
- */
2303
- stepJob(id: string, timestamp?: number): void;
2304
- /**
2305
- * Main RAF loop callback.
2306
- * Executes frame, handles demand mode, and schedules next frame.
2307
- * @param {number} timestamp - RAF timestamp in milliseconds
2308
- * @returns {void}
2309
- * @private
2310
- */
2311
- private loop;
2312
- /**
2313
- * Execute a single frame across all roots.
2314
- * Order: globalBefore → each root's jobs → globalAfter
2315
- * @param {number} timestamp - RAF timestamp in milliseconds
2316
- * @returns {void}
2317
- * @private
2318
- */
2319
- private executeFrame;
2320
- /**
2321
- * Run all global jobs from a job map.
2322
- * Catches and logs errors without stopping execution.
2323
- * @param {Map<string, GlobalJob>} jobs - The global jobs map to execute
2324
- * @param {number} timestamp - RAF timestamp in milliseconds
2325
- * @returns {void}
2326
- * @private
2327
- */
2328
- private runGlobalJobs;
2329
- /**
2330
- * Execute all jobs for a single root in sorted order.
2331
- * Rebuilds sorted job list if needed, then dispatches each job.
2332
- * Errors are caught and propagated via triggerError.
2333
- * @param {RootEntry} root - The root entry to tick
2334
- * @param {number} timestamp - RAF timestamp in milliseconds
2335
- * @param {number} delta - Time since last frame in seconds
2336
- * @returns {void}
2337
- * @private
2338
- */
2339
- private tickRoot;
2340
- /**
2341
- * Get the total number of registered jobs across all roots.
2342
- * Includes both per-root jobs and global before/after jobs.
2343
- * @returns {number} Total job count
2344
- */
2345
- getJobCount(): number;
2346
- /**
2347
- * Get all registered job IDs across all roots.
2348
- * Includes both per-root jobs and global before/after jobs.
2349
- * @returns {string[]} Array of all job IDs
2350
- */
2351
- getJobIds(): string[];
2352
- /**
2353
- * Get the number of registered roots (Canvas instances).
2354
- * @returns {number} Number of registered roots
2355
- */
2356
- getRootCount(): number;
2357
- /**
2358
- * Check if any user (non-system) jobs are registered in a specific phase.
2359
- * Used by the default render job to know if a user has taken over rendering.
2360
- *
2361
- * @param phase The phase to check
2362
- * @param rootId Optional root ID to check (checks all roots if not provided)
2363
- * @returns true if any user jobs exist in the phase
2364
- */
2365
- hasUserJobsInPhase(phase: string, rootId?: string): boolean;
2366
- /**
2367
- * Generate a unique root ID for automatic root registration.
2368
- * @returns {string} A unique root ID in the format 'root_N'
2369
- */
2370
- generateRootId(): string;
2371
- /**
2372
- * Generate a unique job ID.
2373
- * @returns {string} A unique job ID in the format 'job_N'
2374
- * @private
2375
- */
2376
- private generateJobId;
2377
- /**
2378
- * Normalize before/after constraints to a Set.
2379
- * Handles undefined, single string, or array inputs.
2380
- * @param {string | string[] | undefined} value - The constraint value(s)
2381
- * @returns {Set<string>} Normalized Set of constraint strings
2382
- * @private
2383
- */
2384
- private normalizeConstraints;
2385
- }
2386
- /**
2387
- * Get the global scheduler instance.
2388
- * Creates one if it doesn't exist.
2389
- */
2390
- declare const getScheduler: () => Scheduler;
2391
-
2392
1897
  /**
2393
1898
  * Frame hook with phase-based ordering, priority, and FPS throttling.
2394
1899
  *
2395
- * Works both inside and outside Canvas context:
2396
- * - Inside Canvas: Full RootState (gl, scene, camera, etc.)
2397
- * - Outside Canvas (waiting mode): Waits for Canvas to mount, then gets full state
2398
- * - Outside Canvas (independent mode): Fires immediately with timing-only state
1900
+ * Always delivers full RootState — works both inside and outside Canvas context:
1901
+ * - Inside Canvas: Full RootState (renderer, scene, camera, etc.)
1902
+ * - Outside Canvas: The job registers immediately but the callback is held until a
1903
+ * Canvas adopts it, then runs with full RootState. For hostless / standalone
1904
+ * frame loops with no Canvas, use `@pmndrs/scheduler` directly.
2399
1905
  *
2400
1906
  * Returns a controls object for manual stepping, pausing, and resuming.
2401
1907
  *
2402
1908
  * @param callback - Function called each frame with (state, delta). Optional if you only need scheduler access.
2403
1909
  * @param priorityOrOptions - Either a priority number (backwards compat) or options object
2404
- * @returns Controls object with step(), stepAll(), pause(), resume(), isPaused, id, scheduler
1910
+ * @returns Controls object with step(), stepAll(), invalidate(), pause(), resume(), isPaused, id, rootId, scheduler
2405
1911
  *
2406
1912
  * @example
2407
1913
  * // Simple priority (backwards compat)
@@ -2412,16 +1918,16 @@ declare const getScheduler: () => Scheduler;
2412
1918
  * useFrame((state, delta) => { ... }, { phase: 'physics' })
2413
1919
  *
2414
1920
  * @example
2415
- * // Outside Canvas - waits for Canvas to mount
1921
+ * // Outside Canvas - callback waits for a Canvas, then always has full state
2416
1922
  * function UI() {
2417
1923
  * useFrame((state, delta) => { syncUI(state.camera) });
2418
1924
  * return <button>...</button>;
2419
1925
  * }
2420
1926
  *
2421
1927
  * @example
2422
- * // Independent mode - no Canvas needed
2423
- * getScheduler().independent = true;
2424
- * useFrame((state, delta) => { updateGame(delta) });
1928
+ * // Hostless / standalone loop (no Canvas) - use @pmndrs/scheduler directly
1929
+ * import { getScheduler } from '@pmndrs/scheduler'
1930
+ * getScheduler().register((state, delta) => { updateGame(delta) })
2425
1931
  *
2426
1932
  * @example
2427
1933
  * // Scheduler-only access (no callback)
@@ -2444,11 +1950,16 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
2444
1950
  /** Callback when texture(s) finish loading */
2445
1951
  onLoad?: (texture: MappedTextureType<Url>) => void;
2446
1952
  /**
2447
- * Cache the texture in R3F's global state for access via useTextures().
2448
- * When true:
1953
+ * Register the texture(s) in R3F's global texture registry for access via useTextures().
1954
+ * When true (the default):
2449
1955
  * - Textures persist until explicitly disposed
2450
- * - Returns existing cached textures if available (preserving modifications like colorSpace)
2451
- * @default false
1956
+ * - On mount, returns existing registered textures if available (preserving modifications like colorSpace)
1957
+ *
1958
+ * Reads are taken once at mount — a mounted `useTexture` does not re-render when the registry
1959
+ * changes. To react to registry swaps, use `useTextures(s => s.get(key))` instead.
1960
+ *
1961
+ * Pass `false` to opt out of registry enrollment entirely.
1962
+ * @default true
2452
1963
  */
2453
1964
  cache?: boolean;
2454
1965
  };
@@ -2472,15 +1983,18 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
2472
1983
  * normal: '/normal.png'
2473
1984
  * })
2474
1985
  *
2475
- * // With caching - returns same texture object across components
2476
- * // Modifications (colorSpace, wrapS, etc.) are preserved
2477
- * const diffuse = useTexture('/diffuse.png', { cache: true })
1986
+ * // Textures are registered in the global registry by default — the same texture
1987
+ * // object is shared across components and modifications (colorSpace, wrapS, etc.) are preserved
1988
+ * const diffuse = useTexture('/diffuse.png')
2478
1989
  * diffuse.colorSpace = THREE.SRGBColorSpace
2479
1990
  *
2480
1991
  * // Another component gets the SAME texture with colorSpace already set
2481
- * const sameDiffuse = useTexture('/diffuse.png', { cache: true })
1992
+ * const sameDiffuse = useTexture('/diffuse.png')
2482
1993
  *
2483
- * // Access cache directly
1994
+ * // Opt out of registry enrollment for a one-off texture
1995
+ * const scratch = useTexture('/scratch.png', { cache: false })
1996
+ *
1997
+ * // Access the registry directly
2484
1998
  * const { get } = useTextures()
2485
1999
  * const cached = get('/diffuse.png')
2486
2000
  * ```
@@ -2497,63 +2011,80 @@ declare const Texture: ({ children, input, onLoad, cache, }: {
2497
2011
  cache?: boolean;
2498
2012
  }) => react_jsx_runtime.JSX.Element;
2499
2013
 
2500
- type TextureEntry = Texture$1 | {
2501
- value: Texture$1;
2502
- [key: string]: any;
2014
+ /** Accepted shapes for a registry read: a single key, a list of keys, or a name→key map. */
2015
+ type TextureInput = string | string[] | Record<string, string>;
2016
+ /** Result of a `get()` read, mirroring the input shape. */
2017
+ type TextureResult<Input extends TextureInput> = Input extends string ? Texture$1 | undefined : Input extends string[] ? (Texture$1 | undefined)[] : {
2018
+ [K in keyof Input]: Texture$1 | undefined;
2503
2019
  };
2020
+ /** Options for `dispose()`. */
2021
+ interface DisposeOptions {
2022
+ /** Dispose even if the texture still has active references (default false). */
2023
+ force?: boolean;
2024
+ }
2504
2025
  interface UseTexturesReturn {
2505
- /** Map of all textures currently in cache */
2506
- textures: Map<string, TextureEntry>;
2507
- /** Get a specific texture by key (usually URL) */
2508
- get: (key: string) => TextureEntry | undefined;
2509
- /** Check if a texture exists in cache */
2510
- has: (key: string) => boolean;
2511
- /** Add a texture to the cache */
2512
- add: (key: string, value: TextureEntry) => void;
2513
- /** Add multiple textures to the cache */
2514
- addMultiple: (items: Map<string, TextureEntry> | Record<string, TextureEntry>) => void;
2515
- /** Remove a texture from cache (does NOT dispose GPU resources) */
2516
- remove: (key: string) => void;
2517
- /** Remove multiple textures from cache */
2518
- removeMultiple: (keys: string[]) => void;
2519
- /** Dispose a texture's GPU resources and remove from cache */
2520
- dispose: (key: string) => void;
2521
- /** Dispose multiple textures */
2522
- disposeMultiple: (keys: string[]) => void;
2523
- /** Dispose ALL cached textures - use with caution */
2524
- disposeAll: () => void;
2026
+ /** The live registry Map (key → Texture). Treat as read-only. */
2027
+ readonly all: Map<string, Texture$1>;
2028
+ /** Read one texture, an array of textures, or a name→texture record (mirrors the input shape). */
2029
+ get<Input extends TextureInput>(input: Input): TextureResult<Input>;
2030
+ /** Check whether a key exists in the registry. */
2031
+ has(key: string): boolean;
2032
+ /**
2033
+ * Register a texture (or a record of textures) that has no URL — e.g. a render
2034
+ * target or procedural texture. URL-loaded textures are registered automatically
2035
+ * by `useTexture` (registry enrollment is on by default).
2036
+ */
2037
+ add(key: string, texture: Texture$1): void;
2038
+ add(record: Record<string, Texture$1>): void;
2039
+ /**
2040
+ * Dispose a texture's GPU resources and remove it from the registry.
2041
+ * Refcount-aware: if the key is still in use by a mounted `useTexture` consumer it is
2042
+ * skipped (with a warning) unless `{ force: true }` is passed.
2043
+ * @returns true if disposed, false if skipped.
2044
+ */
2045
+ dispose(key: string, options?: DisposeOptions): boolean;
2046
+ /** Dispose every texture in the registry and clear it. Use on scene teardown. */
2047
+ disposeAll(): void;
2525
2048
  }
2526
2049
  /**
2527
- * Hook for managing the global texture cache in R3F state.
2050
+ * Reactive Texture registry — load once with `useTexture`, reach the textures from anywhere.
2528
2051
  *
2529
- * Textures are stored in a Map with URL/path keys for efficient lookup.
2530
- * Useful for sharing texture references across materials and components.
2052
+ * This is a registry of plain `Texture` objects (not TSL nodes), so the same texture can feed
2053
+ * a material map, a heightmap sampler, or anything else. It does **not** load — pair it with
2054
+ * `useTexture` for loading (registry enrollment is on by default); `useTextures` is for access and lifecycle.
2055
+ *
2056
+ * The returned handle is **reactive**: the calling component re-renders when the registry
2057
+ * changes. Pass a selector to scope the subscription to a single read.
2531
2058
  *
2532
2059
  * @example
2533
2060
  * ```tsx
2534
- * const { textures, add, get, remove, has, dispose } = useTextures()
2061
+ * // Load + register once (anywhere in the tree) — registered by default
2062
+ * useTexture({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
2535
2063
  *
2536
- * // Check if texture is already cached
2537
- * if (!has('/textures/diffuse.png')) {
2538
- * // Load with useTexture and cache: true, or manually add
2539
- * const tex = useTexture('/textures/diffuse.png', { cache: true })
2540
- * }
2064
+ * // Reach them from another component — record form lands straight into a material
2065
+ * const { map, normalMap } = useTextures().get({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
2066
+ * return <meshStandardMaterial map={map} normalMap={normalMap} />
2541
2067
  *
2542
- * // Access cached texture from anywhere
2543
- * const diffuse = get('/textures/diffuse.png')
2544
- * if (diffuse) material.map = diffuse
2068
+ * // A set of heightmaps at once
2069
+ * const [a, b, c] = useTextures().get(['/h0.png', '/h1.png', '/h2.png'])
2545
2070
  *
2546
- * // Remove from cache only (texture still in GPU memory)
2547
- * remove('/textures/old.png')
2071
+ * // Register a non-URL texture (render target / procedural)
2072
+ * useTextures().add('rt-main', renderTarget.texture)
2548
2073
  *
2549
- * // Fully dispose (frees GPU memory + removes from cache)
2550
- * dispose('/textures/unused.png')
2551
- *
2552
- * // Nuclear option - dispose everything
2553
- * disposeAll()
2074
+ * // Deliberate GPU cleanup (refcount-aware; force to override)
2075
+ * useTextures().dispose('/diffuse.jpg')
2076
+ * useTextures().disposeAll() // scene teardown
2554
2077
  * ```
2078
+ *
2079
+ * @remarks
2080
+ * **Future expansion:** an imperative async loader (e.g. `await useTextures().load('/x.jpg')`) is
2081
+ * intentionally not included yet. It would let non-React code (loading screens, dynamic streaming)
2082
+ * populate the registry without Suspense, at the cost of putting loading back into this hook. It
2083
+ * will be added only if a concrete consumer needs imperative loading; for now, loading lives in
2084
+ * `useTexture`.
2555
2085
  */
2556
2086
  declare function useTextures(): UseTexturesReturn;
2087
+ declare function useTextures<T>(selector: (registry: UseTexturesReturn) => T): T;
2557
2088
 
2558
2089
  /**
2559
2090
  * Creates a render target compatible with the current renderer.
@@ -2583,9 +2114,9 @@ declare function useTextures(): UseTexturesReturn;
2583
2114
  * const fbo = useRenderTarget(512, 256, { samples: 4 })
2584
2115
  * ```
2585
2116
  */
2586
- declare function useRenderTarget(options?: RenderTargetOptions): RenderTarget | WebGLRenderTarget;
2587
- declare function useRenderTarget(size: number, options?: RenderTargetOptions): RenderTarget | WebGLRenderTarget;
2588
- declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): RenderTarget | WebGLRenderTarget;
2117
+ declare function useRenderTarget(options?: RenderTargetOptions): RenderTarget;
2118
+ declare function useRenderTarget(size: number, options?: RenderTargetOptions): RenderTarget;
2119
+ declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): RenderTarget;
2589
2120
 
2590
2121
  /**
2591
2122
  * Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
@@ -2672,7 +2203,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
2672
2203
  * Invalidates the view, requesting a frame to be rendered.
2673
2204
  * In demand mode, this triggers the scheduler to run frames.
2674
2205
  *
2675
- * @param state - Optional root state (ignored in new scheduler, kept for backwards compat)
2206
+ * With a state argument, only that root's jobs run on the requested frames; other
2207
+ * roots on 'demand' stay idle. Without one, every registered root is invalidated.
2208
+ *
2209
+ * @param state - Optional root state; targets the invalidation at that root
2676
2210
  * @param frames - Number of frames to request (default: 1)
2677
2211
  * @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
2678
2212
  *
@@ -2683,14 +2217,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
2683
2217
  * Advances the frameloop and runs render effects.
2684
2218
  * Useful for when manually rendering via `frameloop="never"`.
2685
2219
  *
2220
+ * With a state argument, only that root is stepped. Without one, every
2221
+ * registered root is stepped for backwards compatibility.
2222
+ *
2686
2223
  * @param timestamp - The timestamp to use for this frame
2687
2224
  * @param runGlobalEffects - Ignored (kept for backwards compat, global effects always run)
2688
- * @param state - Ignored (kept for backwards compat)
2689
- * @param frame - Ignored (kept for backwards compat)
2225
+ * @param state - Optional root state; targets the manual step at that root
2690
2226
  *
2691
2227
  * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
2692
2228
  */
2693
- declare function advance(timestamp: number): void;
2229
+ declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
2694
2230
 
2695
2231
  /* eslint-disable @definitelytyped/no-unnecessary-generics */
2696
2232
  declare function ReactReconciler<
@@ -3761,11 +3297,6 @@ declare function flushSync<R>(fn: () => R): R;
3761
3297
  declare const context: React$1.Context<RootStore>;
3762
3298
  declare const createStore: (invalidate: (state?: RootState, frames?: number, stackFrames?: boolean) => void, advance: (timestamp: number, runGlobalEffects?: boolean, state?: RootState, frame?: XRFrame) => void) => RootStore;
3763
3299
 
3764
- /**
3765
- * Safely flush async effects when testing, simulating a legacy root.
3766
- * @deprecated Import from React instead. import { act } from 'react'
3767
- */
3768
- declare const act: typeof React$1.act;
3769
3300
  /**
3770
3301
  * An SSR-friendly useLayoutEffect.
3771
3302
  *
@@ -4249,5 +3780,5 @@ declare function isOnce(value: unknown): value is {
4249
3780
  */
4250
3781
  declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
4251
3782
 
4252
- 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 };
4253
- export type { Act, AddPhaseOptions, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, 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, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootOptions, RootState, RootStore, SchedulerApi, SetBlock, Size, Subscription, TSLNodeInput, TextureEntry, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseFrameNextOptions, UseFrameOptions, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager };
3783
+ 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, 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, swapInteractivity, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useMutableCallback, useRenderTarget, useStore, useTexture, useTextures, useThree, waitForPrimary };
3784
+ 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 };