@react-three/fiber 10.0.0-canary.dbbe704 → 10.0.0-canary.dc0ec15

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/legacy.d.ts CHANGED
@@ -1,30 +1,17 @@
1
1
  import * as THREE$1 from 'three';
2
- import { WebGLRenderTarget, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Node as Node$1, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Object3D, Frustum, OrthographicCamera } from 'three';
2
+ import { WebGLCubeRenderTarget, WebGLRenderTarget, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Object3D, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Frustum, OrthographicCamera } from 'three';
3
3
  import * as React$1 from 'react';
4
4
  import { ReactNode, Component, RefObject, JSX } from 'react';
5
5
  import * as three_webgpu from 'three/webgpu';
6
- import { WebGPURenderer as WebGPURenderer$1, CanvasTarget, Node, ShaderNodeObject } from 'three/webgpu';
6
+ import { WebGPURenderer as WebGPURenderer$1, Node, StorageTexture, Storage3DTexture, StorageArrayTexture, Data3DTexture, CanvasTarget } from 'three/webgpu';
7
7
  import { StoreApi } from 'zustand';
8
8
  import { UseBoundStoreWithEqualityFn } from 'zustand/traditional';
9
+ import { FrameTimingState, FrameCallback as FrameCallback$1, SchedulerApi, UseFrameNextOptions, FrameNextControls } from '@pmndrs/scheduler';
10
+ export { AddPhaseOptions, FrameControls, FrameNextControls, FrameTimingState, RootOptions, Scheduler, SchedulerApi, UseFrameNextOptions, UseFrameOptions, getScheduler } from '@pmndrs/scheduler';
9
11
  import { Options } from 'react-use-measure';
10
12
  import * as react_jsx_runtime from 'react/jsx-runtime';
11
- import { ThreeElement as ThreeElement$1, Euler as Euler$2 } from '@react-three/fiber';
12
13
  import { GroundedSkybox } from 'three/examples/jsm/objects/GroundedSkybox.js';
13
14
 
14
- function _mergeNamespaces(n, m) {
15
- m.forEach(function (e) {
16
- e && typeof e !== 'string' && !Array.isArray(e) && Object.keys(e).forEach(function (k) {
17
- if (k !== 'default' && !(k in n)) {
18
- var d = Object.getOwnPropertyDescriptor(e, k);
19
- Object.defineProperty(n, k, d.get ? d : {
20
- enumerable: true,
21
- get: function () { return e[k]; }
22
- });
23
- }
24
- });
25
- });
26
- return Object.freeze(n);
27
- }
28
15
 
29
16
  /**
30
17
  * @fileoverview Internal Three.js re-exports - LEGACY ENTRY
@@ -37,24 +24,17 @@ function _mergeNamespaces(n, m) {
37
24
  declare const R3F_BUILD_LEGACY = true;
38
25
  declare const R3F_BUILD_WEBGPU = false;
39
26
 
40
- declare const Inspector: {
41
- new (): {};
42
- };
43
- declare const WebGPURenderer: {
44
- new (): {};
45
- };
27
+ type Inspector = never;
28
+ /** Not available on the legacy (WebGL-only) entry. */
29
+ declare function loadInspector(): Promise<never>;
30
+ declare class WebGPURenderer {
31
+ constructor();
32
+ }
46
33
 
47
34
  declare const RenderTarget: any;
48
35
 
49
- var THREE = /*#__PURE__*/_mergeNamespaces({
50
- __proto__: null,
51
- Inspector: Inspector,
52
- R3F_BUILD_LEGACY: R3F_BUILD_LEGACY,
53
- R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
54
- RenderTarget: RenderTarget,
55
- RenderTargetCompat: WebGLRenderTarget,
56
- WebGPURenderer: WebGPURenderer
57
- }, [THREE$1]);
36
+ declare const CubeRenderTarget: any;
37
+
58
38
 
59
39
  //* Utility Types ==============================
60
40
 
@@ -148,6 +128,8 @@ interface IntersectionEvent<TSourceEvent> extends Intersection {
148
128
  unprojectedPoint: THREE$1.Vector3
149
129
  /** Normalized event coordinates */
150
130
  pointer: THREE$1.Vector2
131
+ /** pointerId of the original event for multiple pointer events */
132
+ pointerId: number
151
133
  /** Delta between first click and this event */
152
134
  delta: number
153
135
  /** The ray that pierced it */
@@ -224,6 +206,18 @@ interface EventHandlers {
224
206
  type FilterFunction = (items: THREE$1.Intersection[], state: RootState) => THREE$1.Intersection[]
225
207
  type ComputeFunction = (event: DomEvent, root: RootState, previous?: RootState) => void
226
208
 
209
+ /** Configuration for XR pointer registration (controllers/hands) */
210
+ interface XRPointerConfig {
211
+ /** Ray origin (updated each frame by XR system) */
212
+ ray: THREE$1.Ray
213
+ /** Optional: custom compute function for this pointer */
214
+ compute?: (state: RootState) => void
215
+ /** Pointer type identifier */
216
+ type: 'controller' | 'hand' | 'gaze'
217
+ /** Which hand (for controller/hand types) */
218
+ handedness?: 'left' | 'right'
219
+ }
220
+
227
221
  interface EventManager<TTarget> {
228
222
  /** Determines if the event layer is active */
229
223
  enabled: boolean
@@ -243,8 +237,21 @@ interface EventManager<TTarget> {
243
237
  disconnect?: () => void
244
238
  /** Triggers a onPointerMove with the last known event. This can be useful to enable raycasting without
245
239
  * explicit user interaction, for instance when the camera moves a hoverable object underneath the cursor.
240
+ * @param pointerId - Optional pointer ID to update specific pointer only
246
241
  */
247
- update?: () => void
242
+ update?: (pointerId?: number) => void
243
+ /** Defer pointer move raycasting to frame start (default: true) */
244
+ frameTimedRaycasts?: boolean
245
+ /** Always fire raycaster immediately on scroll events (default: true) */
246
+ alwaysFireOnScroll?: boolean
247
+ /** Automatically re-raycast every frame to detect hover changes from moving objects/camera (default: false) */
248
+ updateOnFrame?: boolean
249
+ /** Flush deferred pointer raycasts. Called by scheduler at frame start (input phase). */
250
+ flush?: () => void
251
+ /** Register an XR pointer (controller/hand). Returns assigned pointerId */
252
+ registerPointer?: (config: XRPointerConfig) => number
253
+ /** Unregister an XR pointer */
254
+ unregisterPointer?: (pointerId: number) => void
248
255
  }
249
256
 
250
257
  interface PointerCaptureTarget {
@@ -264,227 +271,116 @@ interface VisibilityEntry {
264
271
  }
265
272
 
266
273
  //* Scheduler Types (useFrame) ==============================
274
+ //
275
+ // The generic, framework-agnostic scheduler types now live in @pmndrs/scheduler.
276
+ // This file re-exports them and layers r3f's RootState-aware frame state on top,
277
+ // so existing `#types` imports across the codebase keep resolving unchanged.
267
278
 
268
279
 
269
280
 
270
- // Public Options --------------------------------
281
+ // Frame State (r3f-specific) --------------------------------
271
282
 
272
283
  /**
273
- * Options for useFrame hook
284
+ * State passed to useFrame callbacks (extends RootState with timing).
274
285
  */
275
- interface UseFrameNextOptions {
276
- /** Optional stable id for the job. Auto-generated if not provided */
277
- id?: string
278
- /** Named phase to run in. Default: 'update' */
279
- phase?: string
280
- /** Run before this phase or job id */
281
- before?: string | string[]
282
- /** Run after this phase or job id */
283
- after?: string | string[]
284
- /** Priority within phase. Higher runs first. Default: 0 */
285
- priority?: number
286
- /** Max frames per second for this job */
287
- fps?: number
288
- /** If true, skip frames when behind. If false, try to catch up. Default: true */
289
- drop?: boolean
290
- /** Enable/disable without unregistering. Default: true */
291
- enabled?: boolean
292
- }
286
+ interface FrameNextState extends RootState, FrameTimingState {}
293
287
 
294
- /** Alias for UseFrameNextOptions */
295
- type UseFrameOptions = UseFrameNextOptions
288
+ /** Alias for FrameNextState */
289
+ type FrameState = FrameNextState
290
+
291
+ // Callback Types (r3f-specific) --------------------------------
296
292
 
297
293
  /**
298
- * Options for addPhase
294
+ * Callback function for useFrame. Receives the full r3f RootState plus timing.
299
295
  */
300
- interface AddPhaseOptions {
301
- /** Insert this phase before the specified phase */
302
- before?: string
303
- /** Insert this phase after the specified phase */
304
- after?: string
305
- }
296
+ type FrameNextCallback = FrameCallback$1<RootState>
306
297
 
307
- // Frame State --------------------------------
298
+ /** Alias for FrameNextCallback */
299
+ type FrameCallback = FrameNextCallback
300
+
301
+ //* Buffer Types (useBuffers) ========================================
308
302
 
309
303
  /**
310
- * Timing-only state for independent/outside mode (no RootState)
304
+ * Buffer-like types for GPU compute and storage operations.
305
+ * Includes raw CPU arrays, Three.js buffer attributes, and TSL buffer nodes.
306
+ *
307
+ * @example
308
+ * ```tsx
309
+ * const { positions, velocities } = useBuffers(() => ({
310
+ * positions: instancedArray(count, 'vec3'), // StorageBufferNode
311
+ * velocities: new Float32Array(count * 3), // TypedArray
312
+ * }), 'particles')
313
+ * ```
311
314
  */
312
- interface FrameTimingState {
313
- /** High-resolution timestamp from RAF (ms) */
314
- time: number
315
- /** Time since last frame in seconds (for legacy compatibility with THREE.Clock) */
316
- delta: number
317
- /** Elapsed time since first frame in seconds (for legacy compatibility with THREE.Clock) */
318
- elapsed: number
319
- /** Incrementing frame counter */
320
- frame: number
321
- }
315
+ type BufferLike =
316
+ | Float32Array
317
+ | Uint32Array
318
+ | Int32Array
319
+ | Float64Array
320
+ | Uint8Array
321
+ | Int8Array
322
+ | Uint16Array
323
+ | Int16Array
324
+ | THREE$1.BufferAttribute // Base class for all buffer attributes
325
+ | THREE$1.InterleavedBufferAttribute
326
+ | Node // TSL buffer nodes (instancedArray, storage)
327
+
328
+ /** Flat record of buffer-like values (no nested scopes) */
329
+ type BufferRecord = Record<string, BufferLike>
322
330
 
323
331
  /**
324
- * State passed to useFrame callbacks (extends RootState with timing)
332
+ * Buffer store that can contain both root-level buffers and scoped buffer objects.
333
+ * Structure: { positions: Float32Array, particles: { vel: StorageBufferNode } }
325
334
  */
326
- interface FrameNextState extends RootState, FrameTimingState {}
335
+ type BufferStore = Record<string, BufferLike | BufferRecord>
327
336
 
328
- /** Alias for FrameNextState */
329
- type FrameState = FrameNextState
330
-
331
- // Root Options --------------------------------
337
+ //* Node Types (useNodes) ========================================
332
338
 
333
339
  /**
334
- * Options for registerRoot
340
+ * Every node representation `useNodes` accepts and `state.nodes` holds: three's real `Node`,
341
+ * the callable proxy `Fn()` returns, and the legacy structural shape (`uuid`/`nodeType`) older
342
+ * code passes through. Creators are constrained to this same type, so the shape a creator returns
343
+ * and the shape the store holds are one type by construction.
335
344
  */
336
- interface RootOptions {
337
- /** State provider for callbacks. Optional in independent mode. */
338
- getState?: () => any
339
- /** Error handler for job errors. Falls back to console.error if not provided. */
340
- onError?: (error: Error) => void
341
- }
345
+ type NodeLike = TSLNodeType | LegacyTSLNodeLike
342
346
 
343
- // Callback Types --------------------------------
347
+ /** Flat record of TSL nodes (no nested scopes) */
348
+ type NodeRecord<T extends NodeLike = NodeLike> = Record<string, T>
344
349
 
345
350
  /**
346
- * Callback function for useFrame
351
+ * Node store that can contain both root-level nodes and scoped node objects.
352
+ * Structure: { wobble: OperatorNode, fx: { blur: ShaderCallable } }
347
353
  */
348
- type FrameNextCallback = (state: FrameNextState, delta: number) => void
349
-
350
- /** Alias for FrameNextCallback */
351
- type FrameCallback = FrameNextCallback
354
+ type NodeStore = Record<string, NodeLike | NodeRecord>
352
355
 
353
- // Controls returned from useFrame --------------------------------
356
+ //* Storage Types (useGPUStorage) ========================================
354
357
 
355
358
  /**
356
- * Controls object returned from useFrame hook
359
+ * GPU storage types for texture-based storage operations.
360
+ * Includes Three.js storage textures and TSL storage texture nodes.
361
+ *
362
+ * @example
363
+ * ```tsx
364
+ * const { heightMap } = useGPUStorage(() => ({
365
+ * heightMap: new StorageTexture(512, 512),
366
+ * }), 'terrain')
367
+ * ```
357
368
  */
358
- interface FrameNextControls {
359
- /** The job's unique ID */
360
- id: string
361
- /** Access to the global scheduler for frame loop control */
362
- scheduler: SchedulerApi
363
- /** Manually step this job only (bypasses FPS limiting) */
364
- step(timestamp?: number): void
365
- /** Manually step ALL jobs in the scheduler */
366
- stepAll(timestamp?: number): void
367
- /** Pause this job (set enabled=false) */
368
- pause(): void
369
- /** Resume this job (set enabled=true) */
370
- resume(): void
371
- /** Reactive paused state - automatically triggers re-render when changed */
372
- isPaused: boolean
373
- }
369
+ type StorageLike =
370
+ | StorageTexture // 2D GPU storage texture
371
+ | Storage3DTexture // 3D GPU storage texture (volumes, fluid grids)
372
+ | StorageArrayTexture // 2D-array GPU storage texture
373
+ | Data3DTexture // 3D texture (can be used as storage)
374
+ | Node // TSL storage texture nodes (storageTexture)
374
375
 
375
- /** Alias for FrameNextControls */
376
- type FrameControls = FrameNextControls
377
-
378
- // Scheduler Interface --------------------------------
376
+ /** Flat record of storage-like values (no nested scopes) */
377
+ type StorageRecord = Record<string, StorageLike>
379
378
 
380
379
  /**
381
- * Public interface for the global Scheduler
380
+ * Storage store that can contain both root-level storage and scoped storage objects.
381
+ * Structure: { heightMap: StorageTexture, terrain: { normal: StorageTextureNode } }
382
382
  */
383
- interface SchedulerApi {
384
- //* Phase Management --------------------------------
385
-
386
- /** Add a named phase to the scheduler */
387
- addPhase(name: string, options?: AddPhaseOptions): void
388
- /** Get the ordered list of phase names */
389
- readonly phases: string[]
390
- /** Check if a phase exists */
391
- hasPhase(name: string): boolean
392
-
393
- //* Root Management --------------------------------
394
-
395
- /** Register a root (Canvas) with the scheduler. Returns unsubscribe function. */
396
- registerRoot(id: string, options?: RootOptions): () => void
397
- /** Unregister a root */
398
- unregisterRoot(id: string): void
399
- /** Generate a unique root ID */
400
- generateRootId(): string
401
- /** Get the number of registered roots */
402
- getRootCount(): number
403
- /** Check if any root is registered and ready */
404
- readonly isReady: boolean
405
- /** Subscribe to root-ready event. Fires immediately if already ready. Returns unsubscribe. */
406
- onRootReady(callback: () => void): () => void
407
-
408
- //* Job Registration --------------------------------
409
-
410
- /** Register a job with the scheduler (returns unsubscribe function) */
411
- register(
412
- callback: FrameNextCallback,
413
- options?: {
414
- id?: string
415
- rootId?: string
416
- phase?: string
417
- before?: string | string[]
418
- after?: string | string[]
419
- priority?: number
420
- fps?: number
421
- drop?: boolean
422
- enabled?: boolean
423
- },
424
- ): () => void
425
- /** Update a job's options */
426
- updateJob(
427
- id: string,
428
- options: {
429
- priority?: number
430
- fps?: number
431
- drop?: boolean
432
- enabled?: boolean
433
- phase?: string
434
- before?: string | string[]
435
- after?: string | string[]
436
- },
437
- ): void
438
- /** Unregister a job by ID */
439
- unregister(id: string, rootId?: string): void
440
- /** Get the number of registered jobs */
441
- getJobCount(): number
442
- /** Get all job IDs */
443
- getJobIds(): string[]
444
-
445
- //* Global Jobs (for legacy addEffect/addAfterEffect) --------------------------------
446
-
447
- /** Register a global job (runs once per frame, not per-root). Returns unsubscribe function. */
448
- registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void
449
-
450
- //* Idle Callbacks (for legacy addTail) --------------------------------
451
-
452
- /** Register an idle callback (fires when loop stops). Returns unsubscribe function. */
453
- onIdle(callback: (timestamp: number) => void): () => void
454
-
455
- //* Frame Loop Control --------------------------------
456
-
457
- /** Start the scheduler loop */
458
- start(): void
459
- /** Stop the scheduler loop */
460
- stop(): void
461
- /** Check if the scheduler is running */
462
- readonly isRunning: boolean
463
- /** Get/set the frameloop mode ('always', 'demand', 'never') */
464
- frameloop: Frameloop
465
- /** Independent mode - runs without Canvas, callbacks receive timing-only state */
466
- independent: boolean
467
-
468
- //* Manual Stepping --------------------------------
469
-
470
- /** Manually step all jobs once (for frameloop='never' or testing) */
471
- step(timestamp?: number): void
472
- /** Manually step a single job by ID */
473
- stepJob(id: string, timestamp?: number): void
474
- /** Request frame(s) to be rendered (for frameloop='demand') */
475
- invalidate(frames?: number): void
476
-
477
- //* Per-Job Control --------------------------------
478
-
479
- /** Check if a job is paused */
480
- isJobPaused(id: string): boolean
481
- /** Pause a job */
482
- pauseJob(id: string): void
483
- /** Resume a job */
484
- resumeJob(id: string): void
485
- /** Subscribe to job state changes (for reactive isPaused). Returns unsubscribe function. */
486
- subscribeJobState(id: string, listener: () => void): () => void
487
- }
383
+ type StorageStore = Record<string, StorageLike | StorageRecord>
488
384
 
489
385
  //* Renderer Types ========================================
490
386
 
@@ -499,6 +395,18 @@ type Subscription = {
499
395
  store: RootStore
500
396
  }
501
397
 
398
+ /** Per-pointer state for multi-touch and XR support */
399
+ type PointerState = {
400
+ /** Objects currently hovered by this pointer */
401
+ hovered: Map<string, ThreeEvent<DomEvent>>
402
+ /** Objects capturing this pointer */
403
+ captured: Map<THREE$1.Object3D, PointerCaptureTarget>
404
+ /** Initial click position [x, y] */
405
+ initialClick: [x: number, y: number]
406
+ /** Objects hit on initial click */
407
+ initialHits: THREE$1.Object3D[]
408
+ }
409
+
502
410
  type Dpr = number | [min: number, max: number]
503
411
 
504
412
  interface Size {
@@ -540,12 +448,21 @@ interface Performance {
540
448
 
541
449
  interface InternalState {
542
450
  interaction: THREE$1.Object3D[]
543
- hovered: Map<string, ThreeEvent<DomEvent>>
544
451
  subscribers: Subscription[]
452
+ /** Per-pointer state (hover, capture, click tracking) - replaces hovered, capturedMap, initialClick, initialHits */
453
+ pointerMap: Map<number, PointerState>
454
+ /** Pointers needing raycast this frame (used with frameTimedRaycasts) */
455
+ pointerDirty: Map<number, DomEvent>
456
+ /** Last event received (for events.update() compatibility) */
457
+ lastEvent: React$1.RefObject<DomEvent | null>
458
+ /** @deprecated Use pointerMap.get(pointerId).hovered instead */
459
+ hovered: Map<string, ThreeEvent<DomEvent>>
460
+ /** @deprecated Use pointerMap.get(pointerId).captured instead */
545
461
  capturedMap: Map<number, Map<THREE$1.Object3D, PointerCaptureTarget>>
462
+ /** @deprecated Use pointerMap.get(pointerId).initialClick instead */
546
463
  initialClick: [x: number, y: number]
464
+ /** @deprecated Use pointerMap.get(pointerId).initialHits instead */
547
465
  initialHits: THREE$1.Object3D[]
548
- lastEvent: React$1.RefObject<DomEvent | null>
549
466
  /** Visibility event registry (onFramed, onOccluded, onVisible) */
550
467
  visibilityRegistry: Map<string, VisibilityEntry>
551
468
  /** Whether occlusion queries are enabled (WebGPU only) */
@@ -564,6 +481,12 @@ interface InternalState {
564
481
  actualRenderer: R3FRenderer
565
482
  /** Global scheduler reference (for useFrame hook) */
566
483
  scheduler: SchedulerApi | null
484
+ /**
485
+ * Replaces `renderer.render(scene, camera)` in the default render job when set. Set it with
486
+ * `setRenderOverride(store, fn)`; the job keeps its fps throttle, error handling and user
487
+ * render-phase takeover. Used by `useRenderPipeline`.
488
+ */
489
+ renderOverride?: (() => void) | null
567
490
  /** This root's unique ID in the global scheduler */
568
491
  rootId?: string
569
492
  /** Function to unregister this root from the global scheduler */
@@ -571,14 +494,31 @@ interface InternalState {
571
494
  /** Container for child attachment (scene for root, original container for portals) */
572
495
  container?: THREE$1.Object3D
573
496
  /**
574
- * CanvasTarget for multi-canvas WebGPU rendering.
575
- * Created for all WebGPU canvases to support renderer sharing.
497
+ * The CanvasTarget this root sizes and renders through.
498
+ *
499
+ * A primary (`<Canvas id>`) owns the renderer's default target -- the one three itself built
500
+ * around the canvas element -- so sizing it is sizing the renderer. A secondary owns a target
501
+ * R3F created for its own element. Either way there is exactly one target per canvas element,
502
+ * and the canvas-target job makes it the renderer's active one before this root renders.
503
+ * Absent on WebGL and on an id-less WebGPU canvas, where the renderer is sized directly.
576
504
  * @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
577
505
  */
578
506
  canvasTarget?: CanvasTarget
507
+ /**
508
+ * Set when this root's canvas target has been resized and the backend's cached render pass
509
+ * descriptor (which holds a depth-stencil view built once per canvas) is therefore stale.
510
+ *
511
+ * Flushed by the canvas-target job in the `start` phase, which is the only place this root's
512
+ * target is guaranteed to be the renderer's active one — `backend.updateSize()` operates on
513
+ * whatever `getCanvasTarget()` returns, so calling it from the resize subscription would
514
+ * invalidate some other canvas's descriptor instead.
515
+ *
516
+ * @see https://github.com/pmndrs/react-three-fiber/issues/3847
517
+ */
518
+ canvasTargetSizeDirty?: boolean
579
519
  /**
580
520
  * Whether multi-canvas rendering is active.
581
- * True when any canvas uses `target` prop to share a renderer.
521
+ * True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
582
522
  * When true, setCanvasTarget is called before each render.
583
523
  */
584
524
  isMultiCanvas?: boolean
@@ -676,8 +616,8 @@ interface RootState {
676
616
  setSize: (width?: number, height?: number, top?: number, left?: number) => void
677
617
  /** Shortcut to manual setting the pixel ratio */
678
618
  setDpr: (dpr: Dpr) => void
679
- /** Shortcut to setting frameloop flags */
680
- setFrameloop: (frameloop: Frameloop) => void
619
+ /** Shortcut to setting frameloop flags. No args resets to 'always'. */
620
+ setFrameloop: (frameloop?: Frameloop) => void
681
621
  /** Set error state to propagate to error boundary */
682
622
  setError: (error: Error | null) => void
683
623
  /** Current error state (null when no error) */
@@ -685,13 +625,19 @@ interface RootState {
685
625
  /** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
686
626
  uniforms: UniformStore
687
627
  /** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
688
- nodes: Record<string, any>
689
- /** Global TSL texture nodes - use useTextures() hook for operations */
690
- textures: Map<string, any>
691
- /** WebGPU PostProcessing instance - use usePostProcessing() hook */
692
- postProcessing: any | null // THREE.PostProcessing when available
693
- /** Global TSL pass nodes for post-processing - use usePostProcessing() hook */
694
- passes: Record<string, any>
628
+ nodes: NodeStore
629
+ /** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
630
+ buffers: BufferStore
631
+ /** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
632
+ gpuStorage: StorageStore
633
+ /** Global Texture registry (key → Texture, usually keyed by URL) - use useTextures() hook for access + lifecycle */
634
+ textures: Map<string, THREE$1.Texture>
635
+ /** Internal: refcount per texture key, driven by mounted useTexture consumers (registry enrollment is on by default) */
636
+ _textureRefs: Map<string, number>
637
+ /** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
638
+ renderPipeline: ThreeRenderPipeline | null
639
+ /** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
640
+ passes: PassRecord
695
641
  /** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
696
642
  _hmrVersion: number
697
643
  /** Internal: whether setSize() has taken ownership of canvas dimensions */
@@ -740,6 +686,20 @@ interface Renderer {
740
686
  render: (scene: THREE$1.Scene, camera: THREE$1.Camera) => any
741
687
  }
742
688
 
689
+ //* Color Management Config ==============================
690
+
691
+ /**
692
+ * Color management configuration shared by both WebGL and WebGPU renderers.
693
+ */
694
+ interface ColorManagementConfig {
695
+ /**
696
+ * Color space assigned to 8-bit input textures (color maps).
697
+ * Defaults to sRGB. Most textures are authored in sRGB.
698
+ * @default THREE.SRGBColorSpace
699
+ */
700
+ textureColorSpace?: THREE$1.ColorSpace
701
+ }
702
+
743
703
  //* WebGL Renderer Props ==============================
744
704
 
745
705
  type DefaultGLProps = Omit<THREE$1.WebGLRendererParameters, 'canvas'> & {
@@ -750,7 +710,7 @@ type GLProps =
750
710
  | Renderer
751
711
  | ((defaultProps: DefaultGLProps) => Renderer)
752
712
  | ((defaultProps: DefaultGLProps) => Promise<Renderer>)
753
- | Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters>
713
+ | (Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters> & ColorManagementConfig)
754
714
 
755
715
  //* WebGPU Renderer Props ==============================
756
716
 
@@ -765,20 +725,27 @@ type DefaultRendererProps = {
765
725
  */
766
726
  interface CanvasSchedulerConfig {
767
727
  /**
768
- * Render this canvas after another canvas completes.
769
- * Pass the `id` of another canvas.
728
+ * Run this Canvas root before the referenced Canvas root id(s).
770
729
  */
771
- after?: string
730
+ before?: string | string[]
731
+ /**
732
+ * Run this Canvas root after the referenced Canvas root id(s).
733
+ */
734
+ after?: string | string[]
735
+ /**
736
+ * Numeric root order. Lower values run first.
737
+ */
738
+ order?: number
772
739
  /**
773
- * Limit this canvas's render rate (frames per second).
740
+ * Limit this Canvas's default render job (frames per second).
774
741
  */
775
742
  fps?: number
776
743
  }
777
744
 
778
745
  /**
779
- * Extended renderer configuration for multi-canvas support.
746
+ * Extended renderer configuration for multi-canvas support and color management.
780
747
  */
781
- interface RendererConfigExtended {
748
+ interface RendererConfigExtended extends ColorManagementConfig {
782
749
  /** Share renderer from another canvas (WebGPU only) */
783
750
  primaryCanvas?: string
784
751
  /** Canvas-level scheduler options */
@@ -843,8 +810,6 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
843
810
  * @see https://threejs.org/docs/#api/en/renderers/WebGLRenderer.shadowMap
844
811
  */
845
812
  shadows?: boolean | 'basic' | 'percentage' | 'soft' | 'variance' | Partial<THREE$1.WebGLShadowMap>
846
- /** Color space assigned to 8-bit input textures (color maps). Defaults to sRGB. Most textures are authored in sRGB. */
847
- textureColorSpace?: THREE$1.ColorSpace
848
813
  /** Creates an orthographic camera */
849
814
  orthographic?: boolean
850
815
  /**
@@ -859,14 +824,17 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
859
824
  performance?: Partial<Omit<Performance, 'regress'>>
860
825
  /** Target pixel ratio. Can clamp between a range: `[min, max]` */
861
826
  dpr?: Dpr
862
- /** Props that go into the default raycaster */
863
- raycaster?: Partial<THREE$1.Raycaster>
827
+ /**
828
+ * Props that go into the default raycaster. `params` is merged into the raycaster's defaults,
829
+ * so a single threshold can be set: `raycaster={{ params: { Points: { threshold: 0.2 } } }}`.
830
+ */
831
+ raycaster?: Partial<Omit<THREE$1.Raycaster, 'params'>> & { params?: Partial<THREE$1.RaycasterParameters> }
864
832
  /** A `THREE.Scene` instance or props that go into the default scene */
865
833
  scene?: THREE$1.Scene | Partial<THREE$1.Scene>
866
834
  /** A `THREE.Camera` instance or props that go into the default camera */
867
835
  camera?: CameraProps
868
836
  /** An R3F event manager to manage elements' pointer events */
869
- events?: (store: RootStore) => EventManager<HTMLElement>
837
+ events?: (store: RootStore) => EventManager<Element>
870
838
  /** Callback after the canvas has rendered (but not yet committed) */
871
839
  onCreated?: (state: RootState) => void
872
840
  /** Response for pointer clicks that have missed any target */
@@ -955,7 +923,6 @@ type InstanceProps<T = any, P = any> = ArgsProp<P> & {
955
923
  object?: T
956
924
  dispose?: null
957
925
  attach?: AttachType<T>
958
- onUpdate?: (self: T) => void
959
926
  }
960
927
 
961
928
  interface Instance<O = any> {
@@ -970,8 +937,6 @@ interface Instance<O = any> {
970
937
  attach?: AttachType<O>
971
938
  previousAttach?: any
972
939
  isHidden: boolean
973
- /** Deferred ref props to apply in commitMount */
974
- deferredRefs?: Array<{ prop: string; ref: React$1.RefObject<any> }>
975
940
  /** Set of props that have been applied via once() */
976
941
  appliedOnce?: Set<string>
977
942
  }
@@ -1097,7 +1062,7 @@ interface CanvasProps
1097
1062
  */
1098
1063
  resize?: Options
1099
1064
  /** The target where events are being subscribed to, default: the div that wraps canvas */
1100
- eventSource?: HTMLElement | React$1.RefObject<HTMLElement>
1065
+ eventSource?: Element | React$1.RefObject<Element | null>
1101
1066
  /** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
1102
1067
  eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
1103
1068
  /** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
@@ -1205,70 +1170,86 @@ interface LegacyRootState extends Omit<RootState, 'renderer' | 'internal'> {
1205
1170
 
1206
1171
  type RenderTargetOptions = RenderTargetOptions$1
1207
1172
 
1208
- //* Global Types ==============================
1173
+ //* Global TSL Types ==============================
1209
1174
 
1210
1175
  declare global {
1211
- /** Uniform node type - a Node with a value property (matches Three.js UniformNode) */
1212
- interface UniformNode<T = unknown> extends Node {
1213
- value: T
1214
- }
1215
-
1216
1176
  /**
1217
- * ShaderCallable - the return type of Fn()
1218
- * A callable shader function node that can be invoked with parameters.
1219
- * The function returns a ShaderNodeObject when called.
1220
- *
1221
- * @example
1222
- * ```tsx
1223
- * // Define a shader function
1224
- * const blendColorFn = Fn(([color1, color2, factor]) => {
1225
- * return mix(color1, color2, factor)
1226
- * })
1227
- *
1228
- * // Type when retrieving from nodes store
1229
- * const { blendColorFn } = nodes as { blendColorFn: ShaderCallable }
1230
- *
1231
- * // Or with specific return type
1232
- * const { myFn } = nodes as { myFn: ShaderCallable<THREE.Node> }
1233
- * ```
1177
+ * Broad callable-node fallback for dynamic store readers.
1178
+ * Creator hooks preserve the exact function signatures inferred from Three's `Fn`.
1234
1179
  */
1235
- type ShaderCallable<R extends Node = Node> = ((...params: unknown[]) => ShaderNodeObject<R>) & Node
1180
+ type CallableTSLNode = ((...params: never[]) => unknown) & {
1181
+ readonly shaderNode: unknown
1182
+ readonly id: number
1183
+ }
1236
1184
 
1237
- /**
1238
- * ShaderNodeRef - a ShaderNodeObject wrapper around a Node
1239
- * This is the common return type for TSL operations (add, mul, sin, etc.)
1240
- *
1241
- * @example
1242
- * ```tsx
1243
- * const { wobble } = nodes as { wobble: ShaderNodeRef }
1244
- * ```
1245
- */
1246
- type ShaderNodeRef<T extends Node = Node> = ShaderNodeObject<T>
1185
+ /** Legacy structural node accepted when at least one historical marker exists. */
1186
+ type LegacyTSLNodeLike = {
1187
+ label?: ((label: string) => unknown) | string
1188
+ setName?: (name: string) => unknown
1189
+ } & ({ uuid: string | undefined; nodeType?: string | null } | { uuid?: string; nodeType: string | null | undefined })
1190
+
1191
+ /** Node type accepted by broad dynamic node-store readers. */
1192
+ type TSLNodeType = three_webgpu.Node | CallableTSLNode
1247
1193
 
1248
1194
  /**
1249
- * TSLNodeType - Union of all common TSL node types
1250
- * Used by ScopedStore to properly type node access from the store.
1251
- *
1252
- * Includes:
1253
- * - Node: base Three.js node type
1254
- * - ShaderCallable: function nodes created with Fn()
1255
- * - ShaderNodeObject: wrapped nodes from TSL operations (sin, mul, mix, etc.)
1256
- *
1257
- * @example
1258
- * ```tsx
1259
- * // In useLocalNodes, nodes are typed as TSLNodeType
1260
- * const { positionNode, blendColorFn } = useLocalNodes(({ nodes }) => ({
1261
- * positionNode: nodes.myPosition, // Works - Node is in union
1262
- * blendColorFn: nodes.myFn, // Works - ShaderCallable is in union
1263
- * }))
1264
- *
1265
- * // Can narrow with type guard or assertion when needed
1266
- * if (typeof blendColorFn === 'function') {
1267
- * blendColorFn(someColor, 0.5)
1268
- * }
1269
- * ```
1195
+ * Derive Three's shader node type from an existing node or a supported raw input.
1196
+ * Existing InputNode generics take precedence over structural value normalization.
1197
+ * Both generics must be inferred because Three's UniformNode intersects an unknown-typed
1198
+ * InputNode base with its concrete InputNode specialization.
1270
1199
  */
1271
- type TSLNodeType = Node | ShaderCallable<Node> | ShaderNodeObject<Node>
1200
+ type UniformNodeType<T> = T extends three_webgpu.UniformNode<infer TNodeType, infer _TValue>
1201
+ ? TNodeType
1202
+ : T extends three_webgpu.InputNode<infer TNodeType, infer _TValue>
1203
+ ? TNodeType
1204
+ : T extends number
1205
+ ? 'float'
1206
+ : T extends boolean
1207
+ ? 'bool'
1208
+ : T extends string | three_webgpu.Color | { r: number; g: number; b: number }
1209
+ ? 'color'
1210
+ : T extends three_webgpu.Vector4 | { x: number; y: number; z: number; w: number }
1211
+ ? 'vec4'
1212
+ : T extends three_webgpu.Vector3 | { x: number; y: number; z: number }
1213
+ ? 'vec3'
1214
+ : T extends three_webgpu.Vector2 | { x: number; y: number }
1215
+ ? 'vec2'
1216
+ : T extends three_webgpu.Matrix4
1217
+ ? 'mat4'
1218
+ : T extends three_webgpu.Matrix3
1219
+ ? 'mat3'
1220
+ : T extends three_webgpu.Matrix2
1221
+ ? 'mat2'
1222
+ : unknown
1223
+
1224
+ /** Derive the normalized JavaScript value stored by a uniform node. */
1225
+ type UniformNodeValue<T> = T extends three_webgpu.UniformNode<infer _TNodeType, infer TValue>
1226
+ ? TValue
1227
+ : T extends three_webgpu.InputNode<infer _TNodeType, infer TValue>
1228
+ ? TValue
1229
+ : T extends string | { r: number; g: number; b: number }
1230
+ ? three_webgpu.Color
1231
+ : T extends { x: number; y: number; z: number; w: number }
1232
+ ? three_webgpu.Vector4
1233
+ : T extends { x: number; y: number; z: number }
1234
+ ? three_webgpu.Vector3
1235
+ : T extends { x: number; y: number }
1236
+ ? three_webgpu.Vector2
1237
+ : T extends number
1238
+ ? number
1239
+ : T extends boolean
1240
+ ? boolean
1241
+ : T
1242
+
1243
+ /** Three's exact UniformNode with shader and value generics derived from an input. */
1244
+ type UniformNodeFor<T> = three_webgpu.UniformNode<UniformNodeType<T>, UniformNodeValue<T>>
1245
+
1246
+ /** Preserve every input key while mapping values to exact Three uniform nodes. */
1247
+ type UniformNodesFor<T extends UniformInputRecord> = {
1248
+ [K in keyof T]: UniformNodeFor<T[K]>
1249
+ }
1250
+
1251
+ /** Backward-compatible single-parameter uniform alias. */
1252
+ type UniformNode<T = unknown> = UniformNodeFor<T>
1272
1253
 
1273
1254
  /** Flat record of uniform nodes (no nested scopes) */
1274
1255
  type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
@@ -1293,7 +1274,7 @@ declare global {
1293
1274
  * Acceptable input values for useUniforms - raw values that get converted to UniformNodes
1294
1275
  * Supports:
1295
1276
  * - Primitives: number, string (color), boolean
1296
- * - Three.js types: Color, Vector2/3/4, Matrix3/4, Euler, Quaternion
1277
+ * - Three.js types: Color, Vector2/3/4, Matrix2/3/4
1297
1278
  * - Plain objects: { x, y, z, w } converted to vectors
1298
1279
  * - TSL nodes: color(), vec3(), float() for type casting
1299
1280
  * - UniformNode: existing uniforms (reused as-is)
@@ -1306,226 +1287,124 @@ declare global {
1306
1287
  | three_webgpu.Vector2
1307
1288
  | three_webgpu.Vector3
1308
1289
  | three_webgpu.Vector4
1290
+ | three_webgpu.Matrix2
1309
1291
  | three_webgpu.Matrix3
1310
1292
  | three_webgpu.Matrix4
1311
- | three_webgpu.Euler
1312
- | three_webgpu.Quaternion
1313
- | { x: number; y?: number; z?: number; w?: number } // Plain objects converted to vectors
1314
- | Node // TSL nodes like color(), vec3(), float() for type casting
1293
+ | { x: number; y: number }
1294
+ | { x: number; y: number; z: number }
1295
+ | { x: number; y: number; z: number; w: number }
1296
+ | { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
1297
+ | three_webgpu.Node // TSL nodes like color(), vec3(), float() for type casting
1315
1298
  | UniformNode
1316
1299
 
1317
1300
  /** Input record for useUniforms - accepts raw values or UniformNodes */
1318
1301
  type UniformInputRecord = Record<string, UniformValue>
1319
1302
  }
1320
1303
 
1321
- //* Module Augmentation ==============================
1322
-
1323
- declare module 'three/tsl' {
1304
+ declare global {
1324
1305
  /**
1325
- * Fn with array parameter destructuring
1326
- * @example Fn(([uv, skew]) => { ... })
1306
+ * three's own render pipeline type. Named here so the rest of R3F refers to three's shape
1307
+ * rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
1308
+ * is r185, so the new name is the only one.
1327
1309
  */
1328
- export function Fn<R extends Node = Node>(
1329
- jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
1330
- ): ShaderCallable<R>
1310
+ type ThreeRenderPipeline = three_webgpu.RenderPipeline
1331
1311
 
1332
1312
  /**
1333
- * Fn with object parameter destructuring
1334
- * @example Fn(({ color, intensity }) => { ... })
1313
+ * The pass `useRenderPipeline` creates for you: three's own `PassNode`, as returned by
1314
+ * `pass(scene, camera)` from `three/tsl`. Referenced from three so members like
1315
+ * `getTextureNode`, `setMRT` and `dispose` track the installed version.
1335
1316
  */
1336
- export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
1337
- jsFunc: (inputs: T) => ShaderNodeObject<R>,
1338
- ): ShaderCallable<R>
1317
+ type ScenePassNode = three_webgpu.PassNode
1339
1318
 
1340
1319
  /**
1341
- * Fn with array params + layout
1342
- * @example Fn(([a, b]) => { ... }, { layout: [...] })
1320
+ * Pass record - stores TSL pass nodes for render pipeline.
1321
+ *
1322
+ * `scenePass` is the only key the library owns. It is optional here because this is also the
1323
+ * shape of `state.passes`, which is `{}` before the pipeline exists and again after `reset()`
1324
+ * or `clearPasses()`. Inside the callbacks it is always present; see
1325
+ * {@link RenderPipelineCallbackState}.
1326
+ *
1327
+ * Every other key is user-registered, via a callback's return value. Those are TSL nodes of
1328
+ * any kind, not only passes: texture reads of an MRT attachment, effect nodes, extra
1329
+ * `pass()` instances. `Node` is the common base, so that is the bound. Narrow at the call
1330
+ * site when you need a member, e.g. `passes.velocity as TextureNode`.
1331
+ *
1332
+ * The index signature admits `undefined` because a key may simply not be registered, and
1333
+ * because the optional `scenePass` must be assignable to it: under `skipLibCheck: false` an
1334
+ * optional property whose type excludes `undefined` from the index signature is an error
1335
+ * (TS2411) for every consumer compiling these declarations.
1343
1336
  */
1344
- export function Fn<R extends Node = Node>(
1345
- jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
1346
- layout: { layout?: unknown },
1347
- ): ShaderCallable<R>
1337
+ interface PassRecord {
1338
+ scenePass?: ScenePassNode
1339
+ [key: string]: three_webgpu.Node | undefined
1340
+ }
1348
1341
 
1349
1342
  /**
1350
- * Fn with object params + layout
1343
+ * State passed to pipeline callbacks after the active pipeline has been created.
1344
+ *
1345
+ * `passes.scenePass` is required here: the hook installs the default scene pass before either
1346
+ * callback runs, so callbacks can use it without a guard or a cast.
1347
+ *
1348
+ * `renderer` is narrowed to `WebGPURenderer` and `isLegacy` to `false`: the hook throws under
1349
+ * the legacy renderer before either callback can run, so a callback never sees WebGL.
1351
1350
  */
1352
- export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
1353
- jsFunc: (inputs: T) => ShaderNodeObject<R>,
1354
- layout: { layout?: unknown },
1355
- ): ShaderCallable<R>
1356
- }
1357
-
1358
- /**
1359
- * PostProcessing Types for usePostProcessing hook (WebGPU only)
1360
- */
1361
-
1362
-
1351
+ type RenderPipelineCallbackState = RootState & {
1352
+ renderPipeline: ThreeRenderPipeline
1353
+ passes: PassRecord & { scenePass: ScenePassNode }
1354
+ renderer: three_webgpu.WebGPURenderer
1355
+ isLegacy: false
1356
+ }
1363
1357
 
1364
- declare global {
1365
- /** Pass record - stores TSL pass nodes for post-processing */
1366
- type PassRecord = Record<string, any>
1358
+ /**
1359
+ * What a callback may return to register entries into `state.passes`.
1360
+ *
1361
+ * `scenePass` is reserved. The hook owns that entry and its lifecycle: it caches the pass it
1362
+ * created, and `rebuild()` / `reset()` dispose that cached pass. A callback overwriting the
1363
+ * store entry would leave the store pointing at a node the hook never disposes, and the hook
1364
+ * disposing a pass nothing references. So returning it is a type error.
1365
+ */
1366
+ type RegisteredPasses = Record<string, three_webgpu.Node> & { scenePass?: never }
1367
1367
 
1368
1368
  /** Setup callback - runs first to configure MRT, create additional passes */
1369
- type PostProcessingSetupCallback = (state: RootState) => PassRecord | void
1369
+ type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
1370
1370
 
1371
1371
  /** Main callback - runs second to configure outputNode, create effect passes */
1372
- type PostProcessingMainCallback = (state: RootState) => PassRecord | void
1372
+ type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
1373
1373
 
1374
- /** Return type for usePostProcessing hook */
1375
- interface UsePostProcessingReturn {
1374
+ /** The imperative half of useRenderPipeline's return value, present in every state */
1375
+ interface UseRenderPipelineActions {
1376
1376
  /** Current passes from state */
1377
1377
  passes: PassRecord
1378
- /** PostProcessing instance (null if not initialized) */
1379
- postProcessing: any | null // THREE.PostProcessing
1380
1378
  /** Clear all passes from state */
1381
1379
  clearPasses: () => void
1382
- /** Reset PostProcessing entirely (clears PP + passes) */
1380
+ /** Reset RenderPipeline entirely (clears PP + passes) */
1383
1381
  reset: () => void
1384
1382
  /** Re-run setup/main callbacks with current closure values */
1385
1383
  rebuild: () => void
1386
- /** True when PostProcessing is configured and ready */
1387
- isReady: boolean
1388
1384
  }
1389
- }
1390
-
1391
- //* useFrameNext Types ==============================
1392
-
1393
-
1394
-
1395
- //* Global Type Declarations ==============================
1396
-
1397
- declare global {
1398
- // Job --------------------------------
1399
1385
 
1400
1386
  /**
1401
- * Internal job representation in the scheduler
1402
- */
1403
- interface Job {
1404
- /** Unique identifier */
1405
- id: string
1406
- /** The callback to execute */
1407
- callback: FrameNextCallback
1408
- /** Phase this job belongs to */
1409
- phase: string
1410
- /** Run before these phases/job ids */
1411
- before: Set<string>
1412
- /** Run after these phases/job ids */
1413
- after: Set<string>
1414
- /** Priority within phase (higher first) */
1415
- priority: number
1416
- /** Insertion order for deterministic tie-breaking */
1417
- index: number
1418
- /** Max FPS for this job (undefined = no limit) */
1419
- fps?: number
1420
- /** Drop frames when behind (true) or catch up (false) */
1421
- drop: boolean
1422
- /** Last run timestamp (ms) */
1423
- lastRun?: number
1424
- /** Whether job is enabled */
1425
- enabled: boolean
1426
- /** Internal flag: system jobs (like default render) don't block user render takeover */
1427
- system?: boolean
1428
- }
1429
-
1430
- // Phase Graph --------------------------------
1431
-
1432
- /**
1433
- * A node in the phase graph
1434
- */
1435
- interface PhaseNode {
1436
- /** Phase name */
1437
- name: string
1438
- /** Whether this was auto-generated from a before/after constraint */
1439
- isAutoGenerated: boolean
1440
- }
1441
-
1442
- /**
1443
- * Options for creating a job from hook options
1444
- */
1445
- interface JobOptions {
1446
- id?: string
1447
- phase?: string
1448
- before?: string | string[]
1449
- after?: string | string[]
1450
- priority?: number
1451
- fps?: number
1452
- drop?: boolean
1453
- enabled?: boolean
1454
- }
1455
-
1456
- // Frame Loop State --------------------------------
1457
-
1458
- /**
1459
- * Internal frame loop state
1460
- */
1461
- interface FrameLoopState {
1462
- /** Whether the loop is running */
1463
- running: boolean
1464
- /** Current RAF handle */
1465
- rafHandle: number | null
1466
- /** Last frame timestamp in ms (null = uninitialized) */
1467
- lastTime: number | null
1468
- /** Frame counter */
1469
- frameCount: number
1470
- /** Elapsed time since first frame in ms */
1471
- elapsedTime: number
1472
- /** createdAt timestamp in ms */
1473
- createdAt: number
1474
- }
1475
-
1476
- // Root Entry --------------------------------
1477
-
1478
- /**
1479
- * Internal representation of a registered root (Canvas).
1480
- * Tracks jobs and manages rebuild state for this root.
1481
- * @internal
1482
- */
1483
- interface RootEntry {
1484
- /** Unique identifier for this root */
1485
- id: string
1486
- /** Function to get the root's current state. Returns any to support independent mode. */
1487
- getState: () => any
1488
- /** Map of job IDs to Job objects */
1489
- jobs: Map<string, Job>
1490
- /** Cached sorted job list for execution order */
1491
- sortedJobs: Job[]
1492
- /** Whether sortedJobs needs rebuilding */
1493
- needsRebuild: boolean
1494
- }
1495
-
1496
- /**
1497
- * Internal representation of a global job (deprecated API).
1498
- * Global jobs run once per frame, not per-root.
1499
- * Used by legacy addEffect/addAfterEffect APIs.
1500
- * @internal
1501
- * @deprecated Use useFrame with phases instead
1502
- */
1503
- interface GlobalJob {
1504
- /** Unique identifier for this global job */
1505
- id: string
1506
- /** Callback invoked with RAF timestamp in ms */
1507
- callback: (timestamp: number) => void
1508
- }
1509
-
1510
- // HMR Support --------------------------------
1511
-
1512
- /**
1513
- * Hot Module Replacement data structure for preserving scheduler state
1514
- * @internal
1515
- */
1516
- interface HMRData {
1517
- /** Shared data object for storing values across reloads */
1518
- data: Record<string, any>
1519
- /** Optional function to accept HMR updates */
1520
- accept?: () => void
1521
- }
1522
-
1523
- // Default Phases --------------------------------
1524
-
1525
- /**
1526
- * Default phase names for the scheduler
1387
+ * Return type for useRenderPipeline hook, discriminated on `isReady`.
1388
+ *
1389
+ * `if (isReady)` narrows `renderPipeline` to non-null, which is what the docs already tell
1390
+ * callers to check. `passes.scenePass` deliberately stays optional in the ready branch:
1391
+ * `clearPasses()` empties the record while leaving the pipeline in place.
1527
1392
  */
1528
- type DefaultPhase = 'start' | 'input' | 'physics' | 'update' | 'render' | 'finish'
1393
+ type UseRenderPipelineReturn = UseRenderPipelineActions &
1394
+ (
1395
+ | {
1396
+ /** True when RenderPipeline is configured and ready */
1397
+ isReady: true
1398
+ /** RenderPipeline instance */
1399
+ renderPipeline: ThreeRenderPipeline
1400
+ }
1401
+ | {
1402
+ /** False until the pipeline has been created */
1403
+ isReady: false
1404
+ /** Not initialized yet, or torn down by reset() */
1405
+ renderPipeline: null
1406
+ }
1407
+ )
1529
1408
  }
1530
1409
 
1531
1410
  type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
@@ -1604,10 +1483,11 @@ type TSLNodeInput = { nodeType?: string | null; uuid?: string } | null
1604
1483
 
1605
1484
  /**
1606
1485
  * For node material properties (colorNode, positionNode, etc.), accept broader types
1607
- * since @types/three has broken inheritance for TSL node subclasses.
1486
+ * since @types/three has broken inheritance for TSL node subclasses. NodeClass requires
1487
+ * `nodeType`, so this structural key test remains neutral to the selected Three entry.
1608
1488
  */
1609
1489
  type NodeProps<P> = {
1610
- [K in keyof P as P[K] extends Node$1 | null ? K : never]?: TSLNodeInput
1490
+ [K in keyof P as NonNullable<P[K]> extends { nodeType: string | null } ? K : never]?: TSLNodeInput
1611
1491
  }
1612
1492
 
1613
1493
  interface ReactProps<P> {
@@ -1628,11 +1508,29 @@ type ThreeToJSXElements<T extends Record<string, any>> = {
1628
1508
  [K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
1629
1509
  }
1630
1510
 
1511
+ /** Method names of Object3D, excluded from the `primitive` element's typed props. */
1512
+ type Object3DMethod = NonNullable<
1513
+ {
1514
+ [K in keyof Object3D]-?: Object3D[K] extends (...args: any[]) => any ? K : never
1515
+ }[keyof Object3D]
1516
+ >
1517
+
1631
1518
  type ThreeExports = typeof import('three')
1632
1519
  type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
1633
1520
 
1634
1521
  interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
1635
- primitive: Omit<ThreeElement<any>, 'args'> & { object: object }
1522
+ /**
1523
+ * `primitive` wraps a pre-existing object, so its props cannot be derived from one class.
1524
+ * Events are typed from `EventHandlers` (`onClick={(e) => ...}` infers `e`), the ref is
1525
+ * untyped, and any other prop is accepted and applied to the object by name. Object3D's own
1526
+ * methods are left out of the typed surface: they return `this`, so a subclass element's
1527
+ * props (`ThreeElements['group']`) could not be spread onto a primitive otherwise.
1528
+ */
1529
+ primitive: Omit<ThreeElement<typeof Object3D>, 'args' | 'object' | 'ref' | Object3DMethod> & {
1530
+ object: object
1531
+ ref?: React.Ref<any>
1532
+ [prop: string]: unknown
1533
+ }
1636
1534
  // Conflicts with DOM types can be accessed through a three* prefix
1637
1535
  threeAudio: ThreeElementsImpl['audio']
1638
1536
  threeSource: ThreeElementsImpl['source']
@@ -1673,6 +1571,7 @@ type three_d_Matrix3 = Matrix3;
1673
1571
  type three_d_Matrix4 = Matrix4;
1674
1572
  type three_d_MutableOrReadonlyParameters<T extends (...args: any) => any> = MutableOrReadonlyParameters<T>;
1675
1573
  type three_d_NodeProps<P> = NodeProps<P>;
1574
+ type three_d_Object3DMethod = Object3DMethod;
1676
1575
  type three_d_Quaternion = Quaternion;
1677
1576
  type three_d_RaycastableRepresentation = RaycastableRepresentation;
1678
1577
  type three_d_ReactProps<P> = ReactProps<P>;
@@ -1687,7 +1586,7 @@ type three_d_Vector3 = Vector3;
1687
1586
  type three_d_Vector4 = Vector4;
1688
1587
  type three_d_VectorRepresentation = VectorRepresentation;
1689
1588
  declare namespace three_d {
1690
- export type { three_d_Color as Color, three_d_ElementProps as ElementProps, three_d_Euler as Euler, three_d_EventProps as EventProps, three_d_GeometryProps as GeometryProps, three_d_GeometryTransformProps as GeometryTransformProps, three_d_Layers as Layers, three_d_MathProps as MathProps, three_d_MathRepresentation as MathRepresentation, three_d_MathType as MathType, three_d_MathTypes as MathTypes, three_d_Matrix3 as Matrix3, three_d_Matrix4 as Matrix4, three_d_MutableOrReadonlyParameters as MutableOrReadonlyParameters, three_d_NodeProps as NodeProps, three_d_Quaternion as Quaternion, three_d_RaycastableRepresentation as RaycastableRepresentation, three_d_ReactProps as ReactProps, three_d_TSLNodeInput as TSLNodeInput, three_d_ThreeElement as ThreeElement, three_d_ThreeElements as ThreeElements, three_d_ThreeElementsImpl as ThreeElementsImpl, three_d_ThreeExports as ThreeExports, three_d_ThreeToJSXElements as ThreeToJSXElements, three_d_Vector2 as Vector2, three_d_Vector3 as Vector3, three_d_Vector4 as Vector4, three_d_VectorRepresentation as VectorRepresentation };
1589
+ export type { three_d_Color as Color, three_d_ElementProps as ElementProps, three_d_Euler as Euler, three_d_EventProps as EventProps, three_d_GeometryProps as GeometryProps, three_d_GeometryTransformProps as GeometryTransformProps, three_d_Layers as Layers, three_d_MathProps as MathProps, three_d_MathRepresentation as MathRepresentation, three_d_MathType as MathType, three_d_MathTypes as MathTypes, three_d_Matrix3 as Matrix3, three_d_Matrix4 as Matrix4, three_d_MutableOrReadonlyParameters as MutableOrReadonlyParameters, three_d_NodeProps as NodeProps, three_d_Object3DMethod as Object3DMethod, three_d_Quaternion as Quaternion, three_d_RaycastableRepresentation as RaycastableRepresentation, three_d_ReactProps as ReactProps, three_d_TSLNodeInput as TSLNodeInput, three_d_ThreeElement as ThreeElement, three_d_ThreeElements as ThreeElements, three_d_ThreeElementsImpl as ThreeElementsImpl, three_d_ThreeExports as ThreeExports, three_d_ThreeToJSXElements as ThreeToJSXElements, three_d_Vector2 as Vector2, three_d_Vector3 as Vector3, three_d_Vector4 as Vector4, three_d_VectorRepresentation as VectorRepresentation };
1691
1590
  }
1692
1591
 
1693
1592
  /**
@@ -1697,7 +1596,7 @@ declare namespace three_d {
1697
1596
  * a single WebGPURenderer using Three.js CanvasTarget API.
1698
1597
  *
1699
1598
  * Primary canvas: Has `id` prop, creates its own renderer, registers here
1700
- * Secondary canvas: Has `target="id"` prop, shares primary's renderer via CanvasTarget
1599
+ * Secondary canvas: Has `renderer={{ primaryCanvas: 'id' }}`, shares primary's renderer via CanvasTarget
1701
1600
  */
1702
1601
 
1703
1602
  interface PrimaryCanvasEntry {
@@ -1765,12 +1664,23 @@ type EnvironmentLoaderProps = {
1765
1664
  * const texture = useEnvironment({ preset: 'sunset' })
1766
1665
  * ```
1767
1666
  */
1768
- declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown> | CubeTexture;
1667
+ declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown, THREE$1.TextureEventMap> | CubeTexture<unknown>;
1769
1668
  declare namespace useEnvironment {
1770
1669
  var preload: (preloadOptions?: EnvironmentLoaderPreloadOptions) => void;
1771
1670
  var clear: (clearOptions?: EnvironmentLoaderClearOptions) => void;
1772
1671
  }
1773
- type EnvironmentLoaderPreloadOptions = Omit<EnvironmentLoaderProps, 'encoding'>;
1672
+ /**
1673
+ * Options accepted by `useEnvironment.preload`.
1674
+ *
1675
+ * `colorSpace` is deliberately omitted: preload only warms the loader cache, and colorSpace is
1676
+ * applied to the texture by `useEnvironment()` at use time, per consumer. Accepting it here would
1677
+ * advertise an option this function silently ignores.
1678
+ *
1679
+ * This previously read `Omit<…, 'encoding'>` — omitting a key that does not exist on
1680
+ * `EnvironmentLoaderProps`, a leftover from three's pre-`colorSpace` `encoding` API. That made the
1681
+ * type equivalent to the full props, so `colorSpace` was accepted and then dropped on the floor.
1682
+ */
1683
+ type EnvironmentLoaderPreloadOptions = Omit<EnvironmentLoaderProps, 'colorSpace'>;
1774
1684
  type EnvironmentLoaderClearOptions = Pick<EnvironmentLoaderProps, 'files' | 'preset'>;
1775
1685
 
1776
1686
  /**
@@ -1814,9 +1724,9 @@ type EnvironmentProps = {
1814
1724
  blur?: number;
1815
1725
  backgroundBlurriness?: number;
1816
1726
  backgroundIntensity?: number;
1817
- backgroundRotation?: Euler$2;
1727
+ backgroundRotation?: Euler;
1818
1728
  environmentIntensity?: number;
1819
- environmentRotation?: Euler$2;
1729
+ environmentRotation?: Euler;
1820
1730
  map?: Texture$1;
1821
1731
  preset?: PresetsType;
1822
1732
  scene?: Scene | React$1.RefObject<Scene>;
@@ -1900,7 +1810,7 @@ declare function EnvironmentCube({ background, scene, blur, backgroundBlurriness
1900
1810
  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;
1901
1811
  declare module '@react-three/fiber' {
1902
1812
  interface ThreeElements {
1903
- groundProjectedEnvImpl: ThreeElement$1<typeof GroundedSkybox>;
1813
+ groundProjectedEnvImpl: ThreeElement<typeof GroundedSkybox>;
1904
1814
  }
1905
1815
  }
1906
1816
  /**
@@ -2000,12 +1910,68 @@ declare module '@react-three/fiber' {
2000
1910
  */
2001
1911
  declare function Environment(props: EnvironmentProps): react_jsx_runtime.JSX.Element;
2002
1912
 
1913
+ /**
1914
+ * Moves every trace of interactivity from one object to its replacement, for reconstruction.
1915
+ *
1916
+ * When `args` or a `primitive`'s `object` changes, R3F builds a new three object and keeps the same
1917
+ * instance. Removing the old object from the interaction state and registering the new one from
1918
+ * scratch makes events *work* again (#3778), but it forgets what was in flight: a pointer resting on
1919
+ * the object fires a second `onPointerEnter` without ever having left, and an active pointer capture
1920
+ * is dropped mid-drag. Rewriting the references instead keeps the interaction continuous across a
1921
+ * swap the user never asked to see (#3744).
1922
+ *
1923
+ * Captures are re-keyed rather than released, so the DOM-level capture on `captureData.target` is
1924
+ * left alone — releasing and re-acquiring it is precisely the glitch being avoided.
1925
+ *
1926
+ * Visibility handlers are deliberately not transferred: that registry is keyed by `object.uuid`, so
1927
+ * the replacement re-registers itself through `applyProps`. The old entry is dropped here so it
1928
+ * cannot outlive the object it described.
1929
+ */
1930
+ declare function swapInteractivity(store: RootStore, object: Object3D, newObject: Object3D): void;
2003
1931
  declare function removeInteractivity(store: RootStore, object: Object3D): void;
2004
1932
  declare function createEvents(store: RootStore): {
2005
1933
  handlePointer: (name: string) => (event: DomEvent) => void;
1934
+ flushDeferredPointers: () => void;
1935
+ processDeferredPointer: (event: DomEvent, pointerId: number) => void;
2006
1936
  };
2007
1937
  /** Default R3F event manager for web */
2008
- declare function createPointerEvents(store: RootStore): EventManager<HTMLElement>;
1938
+ declare function createPointerEvents(store: RootStore): EventManager<Element>;
1939
+
1940
+ interface RootExtension {
1941
+ /** Unique name. Registering the same name again replaces the entry (HMR-safe); roots it already
1942
+ * set up are not set up a second time, but get the new entry's dispose and hmr. */
1943
+ name: string;
1944
+ /**
1945
+ * Called once per root, after its renderer exists and before `onCreated` and the first frame.
1946
+ * `isLegacy` and `primaryStore` are known by then, so an extension can skip WebGL roots or defer
1947
+ * to the primary canvas. Return fields to merge into the root's state, or nothing.
1948
+ */
1949
+ setup?(store: RootStore): Partial<RootState> | void;
1950
+ /** Called when a root this extension set up unmounts. */
1951
+ dispose?(store: RootStore): void;
1952
+ /** Called when `<Canvas>` detects hot module replacement (skipped with `hmr={false}`). */
1953
+ hmr?(store: RootStore): void;
1954
+ }
1955
+ /**
1956
+ * Register an extension. It is set up on every live root immediately, and on every root created
1957
+ * afterwards. Returns a function that unregisters it: new roots are no longer set up, while roots
1958
+ * it already set up keep its state and still get its dispose when they unmount.
1959
+ */
1960
+ declare function registerRootExtension(extension: RootExtension): () => void;
1961
+ /**
1962
+ * Point a root's default render job at a different render function, or back at
1963
+ * `renderer.render(scene, camera)` with `null`.
1964
+ *
1965
+ * The default job keeps everything else: the Canvas `fps` throttle, error propagation to the error
1966
+ * boundary, and backing off when a user `useFrame(..., { phase: 'render' })` job takes over.
1967
+ */
1968
+ declare function setRenderOverride(store: RootStore, render: (() => void) | null): void;
1969
+
1970
+ /**
1971
+ * Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
1972
+ * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
1973
+ */
1974
+ declare function useStore(): RootStore;
2009
1975
 
2010
1976
  /**
2011
1977
  * Gets or creates a memoized loader instance from a loader constructor or returns the loader if it's already an instance.
@@ -2018,419 +1984,13 @@ declare function getLoader<L extends LoaderLike | ConstructorRepresentation<Load
2018
1984
  * Note: this hook's caller must be wrapped with `React.Suspense`
2019
1985
  * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useloader
2020
1986
  */
2021
- 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>;
1987
+ 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>;
2022
1988
  declare namespace useLoader {
2023
- var preload: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void) => void;
2024
- var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I) => void;
1989
+ 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;
1990
+ var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, cacheKey?: InputLike) => void;
2025
1991
  var loader: typeof getLoader;
2026
1992
  }
2027
1993
 
2028
- /**
2029
- * Global Singleton Scheduler - manages the frame loop and job execution for ALL R3F roots.
2030
- *
2031
- * Features:
2032
- * - Single RAF loop for entire application
2033
- * - Root registration (multiple Canvas support)
2034
- * - Global phases for addEffect/addAfterEffect (deprecated)
2035
- * - Per-root job management with phases, priorities, FPS throttling
2036
- * - onIdle callbacks for addTail (deprecated)
2037
- * - Demand mode support via invalidate()
2038
- */
2039
- declare class Scheduler {
2040
- private static readonly INSTANCE_KEY;
2041
- private static get instance();
2042
- private static set instance(value);
2043
- /**
2044
- * Get the global scheduler instance (creates if doesn't exist).
2045
- * Uses HMR data to preserve instance across hot reloads.
2046
- * @returns {Scheduler} The singleton scheduler instance
2047
- */
2048
- static get(): Scheduler;
2049
- /**
2050
- * Reset the singleton instance. Stops the loop and clears all state.
2051
- * Primarily used for testing to ensure clean state between tests.
2052
- * @returns {void}
2053
- */
2054
- static reset(): void;
2055
- private roots;
2056
- private phaseGraph;
2057
- private loopState;
2058
- private stoppedTime;
2059
- private nextRootIndex;
2060
- private globalBeforeJobs;
2061
- private globalAfterJobs;
2062
- private nextGlobalIndex;
2063
- private idleCallbacks;
2064
- private nextJobIndex;
2065
- private jobStateListeners;
2066
- private pendingFrames;
2067
- private _frameloop;
2068
- private _independent;
2069
- private errorHandler;
2070
- private rootReadyCallbacks;
2071
- get phases(): string[];
2072
- get frameloop(): Frameloop;
2073
- set frameloop(mode: Frameloop);
2074
- get isRunning(): boolean;
2075
- get isReady(): boolean;
2076
- get independent(): boolean;
2077
- set independent(value: boolean);
2078
- constructor();
2079
- /**
2080
- * Register a root (Canvas) with the scheduler.
2081
- * The first root to register starts the RAF loop (if frameloop='always').
2082
- * @param {string} id - Unique identifier for this root
2083
- * @param {RootOptions} [options] - Optional configuration with getState and onError callbacks
2084
- * @returns {() => void} Unsubscribe function to remove this root
2085
- */
2086
- registerRoot(id: string, options?: RootOptions): () => void;
2087
- /**
2088
- * Unregister a root from the scheduler.
2089
- * Cleans up all job state listeners for this root's jobs.
2090
- * The last root to unregister stops the RAF loop.
2091
- * @param {string} id - The root ID to unregister
2092
- * @returns {void}
2093
- */
2094
- unregisterRoot(id: string): void;
2095
- /**
2096
- * Subscribe to be notified when a root becomes available.
2097
- * Fires immediately if a root already exists.
2098
- * @param {() => void} callback - Function called when first root registers
2099
- * @returns {() => void} Unsubscribe function
2100
- */
2101
- onRootReady(callback: () => void): () => void;
2102
- /**
2103
- * Notify all registered root-ready callbacks.
2104
- * Called when the first root registers.
2105
- * @returns {void}
2106
- * @private
2107
- */
2108
- private notifyRootReady;
2109
- /**
2110
- * Ensure a default root exists for independent mode.
2111
- * Creates a minimal root with no state provider.
2112
- * @returns {void}
2113
- * @private
2114
- */
2115
- private ensureDefaultRoot;
2116
- /**
2117
- * Trigger error handling for job errors.
2118
- * Uses the bound error handler if available, otherwise logs to console.
2119
- * @param {Error} error - The error to handle
2120
- * @returns {void}
2121
- */
2122
- triggerError(error: Error): void;
2123
- /**
2124
- * Add a named phase to the scheduler's execution order.
2125
- * Marks all roots for rebuild to incorporate the new phase.
2126
- * @param {string} name - The phase name (e.g., 'physics', 'postprocess')
2127
- * @param {AddPhaseOptions} [options] - Positioning options (before/after other phases)
2128
- * @returns {void}
2129
- * @example
2130
- * scheduler.addPhase('physics', { before: 'update' });
2131
- * scheduler.addPhase('postprocess', { after: 'render' });
2132
- */
2133
- addPhase(name: string, options?: AddPhaseOptions): void;
2134
- /**
2135
- * Check if a phase exists in the scheduler.
2136
- * @param {string} name - The phase name to check
2137
- * @returns {boolean} True if the phase exists
2138
- */
2139
- hasPhase(name: string): boolean;
2140
- /**
2141
- * Register a global job that runs once per frame (not per-root).
2142
- * Used internally by deprecated addEffect/addAfterEffect APIs.
2143
- * @param {'before' | 'after'} phase - When to run: 'before' all roots or 'after' all roots
2144
- * @param {string} id - Unique identifier for this global job
2145
- * @param {(timestamp: number) => void} callback - Function called each frame with RAF timestamp
2146
- * @returns {() => void} Unsubscribe function to remove this global job
2147
- * @deprecated Use useFrame with phases instead
2148
- */
2149
- registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void;
2150
- /**
2151
- * Register an idle callback that fires when the loop stops.
2152
- * Used internally by deprecated addTail API.
2153
- * @param {(timestamp: number) => void} callback - Function called when loop becomes idle
2154
- * @returns {() => void} Unsubscribe function to remove this idle callback
2155
- * @deprecated Use demand mode with invalidate() instead
2156
- */
2157
- onIdle(callback: (timestamp: number) => void): () => void;
2158
- /**
2159
- * Notify all registered idle callbacks.
2160
- * Called when the loop stops in demand mode.
2161
- * @param {number} timestamp - The RAF timestamp when idle occurred
2162
- * @returns {void}
2163
- * @private
2164
- */
2165
- private notifyIdle;
2166
- /**
2167
- * Register a job (frame callback) with a specific root.
2168
- * This is the core registration method used by useFrame internally.
2169
- * @param {FrameNextCallback} callback - The function to call each frame
2170
- * @param {JobOptions & { rootId?: string; system?: boolean }} [options] - Job configuration
2171
- * @param {string} [options.rootId] - Target root ID (defaults to first registered root)
2172
- * @param {string} [options.id] - Unique job ID (auto-generated if not provided)
2173
- * @param {string} [options.phase] - Execution phase (defaults to 'update')
2174
- * @param {number} [options.priority] - Priority within phase (higher = earlier, default 0)
2175
- * @param {number} [options.fps] - FPS throttle limit
2176
- * @param {boolean} [options.drop] - Drop frames when behind (default true)
2177
- * @param {boolean} [options.enabled] - Whether job is active (default true)
2178
- * @param {boolean} [options.system] - Internal flag for system jobs (not user-facing)
2179
- * @returns {() => void} Unsubscribe function to remove this job
2180
- */
2181
- register(callback: FrameNextCallback, options?: JobOptions & {
2182
- rootId?: string;
2183
- system?: boolean;
2184
- }): () => void;
2185
- /**
2186
- * Unregister a job by its ID.
2187
- * Searches all roots if rootId is not provided.
2188
- * @param {string} id - The job ID to unregister
2189
- * @param {string} [rootId] - Optional root ID to search (searches all if not provided)
2190
- * @returns {void}
2191
- */
2192
- unregister(id: string, rootId?: string): void;
2193
- /**
2194
- * Update a job's options dynamically.
2195
- * Searches all roots to find the job by ID.
2196
- * Phase/constraint changes trigger a rebuild of the sorted job list.
2197
- * @param {string} id - The job ID to update
2198
- * @param {Partial<JobOptions>} options - The options to update
2199
- * @returns {void}
2200
- */
2201
- updateJob(id: string, options: Partial<JobOptions>): void;
2202
- /**
2203
- * Check if a job is currently paused (disabled).
2204
- * @param {string} id - The job ID to check
2205
- * @returns {boolean} True if the job exists and is paused
2206
- */
2207
- isJobPaused(id: string): boolean;
2208
- /**
2209
- * Subscribe to state changes for a specific job.
2210
- * Listener is called when job is paused or resumed.
2211
- * @param {string} id - The job ID to subscribe to
2212
- * @param {() => void} listener - Callback invoked on state changes
2213
- * @returns {() => void} Unsubscribe function
2214
- */
2215
- subscribeJobState(id: string, listener: () => void): () => void;
2216
- /**
2217
- * Notify all listeners that a job's state has changed.
2218
- * @param {string} id - The job ID that changed
2219
- * @returns {void}
2220
- * @private
2221
- */
2222
- private notifyJobStateChange;
2223
- /**
2224
- * Pause a job by ID (sets enabled=false).
2225
- * Notifies any subscribed state listeners.
2226
- * @param {string} id - The job ID to pause
2227
- * @returns {void}
2228
- */
2229
- pauseJob(id: string): void;
2230
- /**
2231
- * Resume a paused job by ID (sets enabled=true).
2232
- * Resets job timing to prevent frame accumulation.
2233
- * Notifies any subscribed state listeners.
2234
- * @param {string} id - The job ID to resume
2235
- * @returns {void}
2236
- */
2237
- resumeJob(id: string): void;
2238
- /**
2239
- * Start the requestAnimationFrame loop.
2240
- * Resets timing state (elapsedTime, frameCount) on start.
2241
- * No-op if already running.
2242
- * @returns {void}
2243
- */
2244
- start(): void;
2245
- /**
2246
- * Stop the requestAnimationFrame loop.
2247
- * Cancels any pending RAF callback.
2248
- * No-op if not running.
2249
- * @returns {void}
2250
- */
2251
- stop(): void;
2252
- /**
2253
- * Request frames to be rendered in demand mode.
2254
- * Accumulates pending frames (capped at 60) and starts the loop if not running.
2255
- * No-op if frameloop is not 'demand'.
2256
- * @param {number} [frames=1] - Number of frames to request
2257
- * @param {boolean} [stackFrames=false] - Whether to add frames to existing pending count
2258
- * - `false` (default): Sets pending frames to the specified value (replaces existing count)
2259
- * - `true`: Adds frames to existing pending count (useful for accumulating invalidations)
2260
- * @returns {void}
2261
- * @example
2262
- * // Request a single frame render
2263
- * scheduler.invalidate();
2264
- *
2265
- * @example
2266
- * // Request 5 frames (e.g., for animations)
2267
- * scheduler.invalidate(5);
2268
- *
2269
- * @example
2270
- * // Set pending frames to exactly 3 (don't stack with existing)
2271
- * scheduler.invalidate(3, false);
2272
- *
2273
- * @example
2274
- * // Add 2 more frames to existing pending count
2275
- * scheduler.invalidate(2, true);
2276
- */
2277
- invalidate(frames?: number, stackFrames?: boolean): void;
2278
- /**
2279
- * Reset timing state for deterministic testing.
2280
- * Preserves jobs and roots but resets lastTime, frameCount, elapsedTime, etc.
2281
- * @returns {void}
2282
- */
2283
- resetTiming(): void;
2284
- /**
2285
- * Manually execute a single frame for all roots.
2286
- * Useful for frameloop='never' mode or testing scenarios.
2287
- * @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
2288
- * @returns {void}
2289
- * @example
2290
- * // Manual control mode
2291
- * scheduler.frameloop = 'never';
2292
- * scheduler.step(); // Execute one frame
2293
- */
2294
- step(timestamp?: number): void;
2295
- /**
2296
- * Manually execute a single job by its ID.
2297
- * Useful for testing individual job callbacks in isolation.
2298
- * @param {string} id - The job ID to step
2299
- * @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
2300
- * @returns {void}
2301
- */
2302
- stepJob(id: string, timestamp?: number): void;
2303
- /**
2304
- * Main RAF loop callback.
2305
- * Executes frame, handles demand mode, and schedules next frame.
2306
- * @param {number} timestamp - RAF timestamp in milliseconds
2307
- * @returns {void}
2308
- * @private
2309
- */
2310
- private loop;
2311
- /**
2312
- * Execute a single frame across all roots.
2313
- * Order: globalBefore → each root's jobs → globalAfter
2314
- * @param {number} timestamp - RAF timestamp in milliseconds
2315
- * @returns {void}
2316
- * @private
2317
- */
2318
- private executeFrame;
2319
- /**
2320
- * Run all global jobs from a job map.
2321
- * Catches and logs errors without stopping execution.
2322
- * @param {Map<string, GlobalJob>} jobs - The global jobs map to execute
2323
- * @param {number} timestamp - RAF timestamp in milliseconds
2324
- * @returns {void}
2325
- * @private
2326
- */
2327
- private runGlobalJobs;
2328
- /**
2329
- * Execute all jobs for a single root in sorted order.
2330
- * Rebuilds sorted job list if needed, then dispatches each job.
2331
- * Errors are caught and propagated via triggerError.
2332
- * @param {RootEntry} root - The root entry to tick
2333
- * @param {number} timestamp - RAF timestamp in milliseconds
2334
- * @param {number} delta - Time since last frame in seconds
2335
- * @returns {void}
2336
- * @private
2337
- */
2338
- private tickRoot;
2339
- /**
2340
- * Get the total number of registered jobs across all roots.
2341
- * Includes both per-root jobs and global before/after jobs.
2342
- * @returns {number} Total job count
2343
- */
2344
- getJobCount(): number;
2345
- /**
2346
- * Get all registered job IDs across all roots.
2347
- * Includes both per-root jobs and global before/after jobs.
2348
- * @returns {string[]} Array of all job IDs
2349
- */
2350
- getJobIds(): string[];
2351
- /**
2352
- * Get the number of registered roots (Canvas instances).
2353
- * @returns {number} Number of registered roots
2354
- */
2355
- getRootCount(): number;
2356
- /**
2357
- * Check if any user (non-system) jobs are registered in a specific phase.
2358
- * Used by the default render job to know if a user has taken over rendering.
2359
- *
2360
- * @param phase The phase to check
2361
- * @param rootId Optional root ID to check (checks all roots if not provided)
2362
- * @returns true if any user jobs exist in the phase
2363
- */
2364
- hasUserJobsInPhase(phase: string, rootId?: string): boolean;
2365
- /**
2366
- * Generate a unique root ID for automatic root registration.
2367
- * @returns {string} A unique root ID in the format 'root_N'
2368
- */
2369
- generateRootId(): string;
2370
- /**
2371
- * Generate a unique job ID.
2372
- * @returns {string} A unique job ID in the format 'job_N'
2373
- * @private
2374
- */
2375
- private generateJobId;
2376
- /**
2377
- * Normalize before/after constraints to a Set.
2378
- * Handles undefined, single string, or array inputs.
2379
- * @param {string | string[] | undefined} value - The constraint value(s)
2380
- * @returns {Set<string>} Normalized Set of constraint strings
2381
- * @private
2382
- */
2383
- private normalizeConstraints;
2384
- }
2385
- /**
2386
- * Get the global scheduler instance.
2387
- * Creates one if it doesn't exist.
2388
- */
2389
- declare const getScheduler: () => Scheduler;
2390
-
2391
- /**
2392
- * Frame hook with phase-based ordering, priority, and FPS throttling.
2393
- *
2394
- * Works both inside and outside Canvas context:
2395
- * - Inside Canvas: Full RootState (gl, scene, camera, etc.)
2396
- * - Outside Canvas (waiting mode): Waits for Canvas to mount, then gets full state
2397
- * - Outside Canvas (independent mode): Fires immediately with timing-only state
2398
- *
2399
- * Returns a controls object for manual stepping, pausing, and resuming.
2400
- *
2401
- * @param callback - Function called each frame with (state, delta). Optional if you only need scheduler access.
2402
- * @param priorityOrOptions - Either a priority number (backwards compat) or options object
2403
- * @returns Controls object with step(), stepAll(), pause(), resume(), isPaused, id, scheduler
2404
- *
2405
- * @example
2406
- * // Simple priority (backwards compat)
2407
- * useFrame((state, delta) => { ... }, 5)
2408
- *
2409
- * @example
2410
- * // With phase-based ordering
2411
- * useFrame((state, delta) => { ... }, { phase: 'physics' })
2412
- *
2413
- * @example
2414
- * // Outside Canvas - waits for Canvas to mount
2415
- * function UI() {
2416
- * useFrame((state, delta) => { syncUI(state.camera) });
2417
- * return <button>...</button>;
2418
- * }
2419
- *
2420
- * @example
2421
- * // Independent mode - no Canvas needed
2422
- * getScheduler().independent = true;
2423
- * useFrame((state, delta) => { updateGame(delta) });
2424
- *
2425
- * @example
2426
- * // Scheduler-only access (no callback)
2427
- * const { scheduler } = useFrame()
2428
- * scheduler.pauseJob('some-job-id')
2429
- *
2430
- * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useframe
2431
- */
2432
- declare function useFrame(callback?: FrameNextCallback, priorityOrOptions?: number | UseFrameNextOptions): FrameNextControls;
2433
-
2434
1994
  declare const IsObject: (url: unknown) => url is Record<string, string>;
2435
1995
  type TextureArray<T> = T extends string[] ? Texture$1[] : never;
2436
1996
  type TextureRecord<T> = T extends Record<string, string> ? {
@@ -2443,11 +2003,16 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
2443
2003
  /** Callback when texture(s) finish loading */
2444
2004
  onLoad?: (texture: MappedTextureType<Url>) => void;
2445
2005
  /**
2446
- * Cache the texture in R3F's global state for access via useTextures().
2447
- * When true:
2006
+ * Register the texture(s) in R3F's global texture registry for access via useTextures().
2007
+ * When true (the default):
2448
2008
  * - Textures persist until explicitly disposed
2449
- * - Returns existing cached textures if available (preserving modifications like colorSpace)
2450
- * @default false
2009
+ * - On mount, returns existing registered textures if available (preserving modifications like colorSpace)
2010
+ *
2011
+ * Reads are taken once at mount — a mounted `useTexture` does not re-render when the registry
2012
+ * changes. To react to registry swaps, use `useTextures(s => s.get(key))` instead.
2013
+ *
2014
+ * Pass `false` to opt out of registry enrollment entirely.
2015
+ * @default true
2451
2016
  */
2452
2017
  cache?: boolean;
2453
2018
  };
@@ -2471,15 +2036,18 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
2471
2036
  * normal: '/normal.png'
2472
2037
  * })
2473
2038
  *
2474
- * // With caching - returns same texture object across components
2475
- * // Modifications (colorSpace, wrapS, etc.) are preserved
2476
- * const diffuse = useTexture('/diffuse.png', { cache: true })
2039
+ * // Textures are registered in the global registry by default — the same texture
2040
+ * // object is shared across components and modifications (colorSpace, wrapS, etc.) are preserved
2041
+ * const diffuse = useTexture('/diffuse.png')
2477
2042
  * diffuse.colorSpace = THREE.SRGBColorSpace
2478
2043
  *
2479
2044
  * // Another component gets the SAME texture with colorSpace already set
2480
- * const sameDiffuse = useTexture('/diffuse.png', { cache: true })
2045
+ * const sameDiffuse = useTexture('/diffuse.png')
2046
+ *
2047
+ * // Opt out of registry enrollment for a one-off texture
2048
+ * const scratch = useTexture('/scratch.png', { cache: false })
2481
2049
  *
2482
- * // Access cache directly
2050
+ * // Access the registry directly
2483
2051
  * const { get } = useTextures()
2484
2052
  * const cached = get('/diffuse.png')
2485
2053
  * ```
@@ -2496,63 +2064,80 @@ declare const Texture: ({ children, input, onLoad, cache, }: {
2496
2064
  cache?: boolean;
2497
2065
  }) => react_jsx_runtime.JSX.Element;
2498
2066
 
2499
- type TextureEntry = Texture$1 | {
2500
- value: Texture$1;
2501
- [key: string]: any;
2067
+ /** Accepted shapes for a registry read: a single key, a list of keys, or a name→key map. */
2068
+ type TextureInput = string | string[] | Record<string, string>;
2069
+ /** Result of a `get()` read, mirroring the input shape. */
2070
+ type TextureResult<Input extends TextureInput> = Input extends string ? Texture$1 | undefined : Input extends string[] ? (Texture$1 | undefined)[] : {
2071
+ [K in keyof Input]: Texture$1 | undefined;
2502
2072
  };
2073
+ /** Options for `dispose()`. */
2074
+ interface DisposeOptions {
2075
+ /** Dispose even if the texture still has active references (default false). */
2076
+ force?: boolean;
2077
+ }
2503
2078
  interface UseTexturesReturn {
2504
- /** Map of all textures currently in cache */
2505
- textures: Map<string, TextureEntry>;
2506
- /** Get a specific texture by key (usually URL) */
2507
- get: (key: string) => TextureEntry | undefined;
2508
- /** Check if a texture exists in cache */
2509
- has: (key: string) => boolean;
2510
- /** Add a texture to the cache */
2511
- add: (key: string, value: TextureEntry) => void;
2512
- /** Add multiple textures to the cache */
2513
- addMultiple: (items: Map<string, TextureEntry> | Record<string, TextureEntry>) => void;
2514
- /** Remove a texture from cache (does NOT dispose GPU resources) */
2515
- remove: (key: string) => void;
2516
- /** Remove multiple textures from cache */
2517
- removeMultiple: (keys: string[]) => void;
2518
- /** Dispose a texture's GPU resources and remove from cache */
2519
- dispose: (key: string) => void;
2520
- /** Dispose multiple textures */
2521
- disposeMultiple: (keys: string[]) => void;
2522
- /** Dispose ALL cached textures - use with caution */
2523
- disposeAll: () => void;
2079
+ /** The live registry Map (key → Texture). Treat as read-only. */
2080
+ readonly all: Map<string, Texture$1>;
2081
+ /** Read one texture, an array of textures, or a name→texture record (mirrors the input shape). */
2082
+ get<Input extends TextureInput>(input: Input): TextureResult<Input>;
2083
+ /** Check whether a key exists in the registry. */
2084
+ has(key: string): boolean;
2085
+ /**
2086
+ * Register a texture (or a record of textures) that has no URL — e.g. a render
2087
+ * target or procedural texture. URL-loaded textures are registered automatically
2088
+ * by `useTexture` (registry enrollment is on by default).
2089
+ */
2090
+ add(key: string, texture: Texture$1): void;
2091
+ add(record: Record<string, Texture$1>): void;
2092
+ /**
2093
+ * Dispose a texture's GPU resources and remove it from the registry.
2094
+ * Refcount-aware: if the key is still in use by a mounted `useTexture` consumer it is
2095
+ * skipped (with a warning) unless `{ force: true }` is passed.
2096
+ * @returns true if disposed, false if skipped.
2097
+ */
2098
+ dispose(key: string, options?: DisposeOptions): boolean;
2099
+ /** Dispose every texture in the registry and clear it. Use on scene teardown. */
2100
+ disposeAll(): void;
2524
2101
  }
2525
2102
  /**
2526
- * Hook for managing the global texture cache in R3F state.
2103
+ * Reactive Texture registry — load once with `useTexture`, reach the textures from anywhere.
2527
2104
  *
2528
- * Textures are stored in a Map with URL/path keys for efficient lookup.
2529
- * Useful for sharing texture references across materials and components.
2105
+ * This is a registry of plain `Texture` objects (not TSL nodes), so the same texture can feed
2106
+ * a material map, a heightmap sampler, or anything else. It does **not** load — pair it with
2107
+ * `useTexture` for loading (registry enrollment is on by default); `useTextures` is for access and lifecycle.
2108
+ *
2109
+ * The returned handle is **reactive**: the calling component re-renders when the registry
2110
+ * changes. Pass a selector to scope the subscription to a single read.
2530
2111
  *
2531
2112
  * @example
2532
2113
  * ```tsx
2533
- * const { textures, add, get, remove, has, dispose } = useTextures()
2534
- *
2535
- * // Check if texture is already cached
2536
- * if (!has('/textures/diffuse.png')) {
2537
- * // Load with useTexture and cache: true, or manually add
2538
- * const tex = useTexture('/textures/diffuse.png', { cache: true })
2539
- * }
2114
+ * // Load + register once (anywhere in the tree) — registered by default
2115
+ * useTexture({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
2540
2116
  *
2541
- * // Access cached texture from anywhere
2542
- * const diffuse = get('/textures/diffuse.png')
2543
- * if (diffuse) material.map = diffuse
2117
+ * // Reach them from another component — record form lands straight into a material
2118
+ * const { map, normalMap } = useTextures().get({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
2119
+ * return <meshStandardMaterial map={map} normalMap={normalMap} />
2544
2120
  *
2545
- * // Remove from cache only (texture still in GPU memory)
2546
- * remove('/textures/old.png')
2121
+ * // A set of heightmaps at once
2122
+ * const [a, b, c] = useTextures().get(['/h0.png', '/h1.png', '/h2.png'])
2547
2123
  *
2548
- * // Fully dispose (frees GPU memory + removes from cache)
2549
- * dispose('/textures/unused.png')
2124
+ * // Register a non-URL texture (render target / procedural)
2125
+ * useTextures().add('rt-main', renderTarget.texture)
2550
2126
  *
2551
- * // Nuclear option - dispose everything
2552
- * disposeAll()
2127
+ * // Deliberate GPU cleanup (refcount-aware; force to override)
2128
+ * useTextures().dispose('/diffuse.jpg')
2129
+ * useTextures().disposeAll() // scene teardown
2553
2130
  * ```
2131
+ *
2132
+ * @remarks
2133
+ * **Future expansion:** an imperative async loader (e.g. `await useTextures().load('/x.jpg')`) is
2134
+ * intentionally not included yet. It would let non-React code (loading screens, dynamic streaming)
2135
+ * populate the registry without Suspense, at the cost of putting loading back into this hook. It
2136
+ * will be added only if a concrete consumer needs imperative loading; for now, loading lives in
2137
+ * `useTexture`.
2554
2138
  */
2555
2139
  declare function useTextures(): UseTexturesReturn;
2140
+ declare function useTextures<T>(selector: (registry: UseTexturesReturn) => T): T;
2556
2141
 
2557
2142
  /**
2558
2143
  * Creates a render target compatible with the current renderer.
@@ -2582,20 +2167,10 @@ declare function useTextures(): UseTexturesReturn;
2582
2167
  * const fbo = useRenderTarget(512, 256, { samples: 4 })
2583
2168
  * ```
2584
2169
  */
2585
- declare function useRenderTarget(options?: RenderTargetOptions): RenderTarget | WebGLRenderTarget;
2586
- declare function useRenderTarget(size: number, options?: RenderTargetOptions): RenderTarget | WebGLRenderTarget;
2587
- declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): RenderTarget | WebGLRenderTarget;
2170
+ declare function useRenderTarget(options?: RenderTargetOptions): WebGLRenderTarget;
2171
+ declare function useRenderTarget(size: number, options?: RenderTargetOptions): WebGLRenderTarget;
2172
+ declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): WebGLRenderTarget;
2588
2173
 
2589
- /**
2590
- * Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
2591
- * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
2592
- */
2593
- declare function useStore(): RootStore;
2594
- /**
2595
- * Accesses R3F's internal state, containing renderer, canvas, scene, etc.
2596
- * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usethree
2597
- */
2598
- declare function useThree<T = RootState>(selector?: (state: RootState) => T, equalityFn?: <T>(state: T, newState: T) => boolean): T;
2599
2174
  /**
2600
2175
  * Exposes an object's {@link Instance}.
2601
2176
  * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#useInstanceHandle
@@ -2671,7 +2246,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
2671
2246
  * Invalidates the view, requesting a frame to be rendered.
2672
2247
  * In demand mode, this triggers the scheduler to run frames.
2673
2248
  *
2674
- * @param state - Optional root state (ignored in new scheduler, kept for backwards compat)
2249
+ * With a state argument, only that root's jobs run on the requested frames; other
2250
+ * roots on 'demand' stay idle. Without one, every registered root is invalidated.
2251
+ *
2252
+ * @param state - Optional root state; targets the invalidation at that root
2675
2253
  * @param frames - Number of frames to request (default: 1)
2676
2254
  * @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
2677
2255
  *
@@ -2682,14 +2260,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
2682
2260
  * Advances the frameloop and runs render effects.
2683
2261
  * Useful for when manually rendering via `frameloop="never"`.
2684
2262
  *
2263
+ * With a state argument, only that root is stepped. Without one, every
2264
+ * registered root is stepped for backwards compatibility.
2265
+ *
2685
2266
  * @param timestamp - The timestamp to use for this frame
2686
2267
  * @param runGlobalEffects - Ignored (kept for backwards compat, global effects always run)
2687
- * @param state - Ignored (kept for backwards compat)
2688
- * @param frame - Ignored (kept for backwards compat)
2268
+ * @param state - Optional root state; targets the manual step at that root
2689
2269
  *
2690
2270
  * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
2691
2271
  */
2692
- declare function advance(timestamp: number): void;
2272
+ declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
2693
2273
 
2694
2274
  /* eslint-disable @definitelytyped/no-unnecessary-generics */
2695
2275
  declare function ReactReconciler<
@@ -3734,6 +3314,7 @@ declare namespace ReactReconciler {
3734
3314
 
3735
3315
  declare function extend<T extends ConstructorRepresentation>(objects: T): React$1.ExoticComponent<ThreeElement<T>>;
3736
3316
  declare function extend<T extends Catalogue>(objects: T): void;
3317
+ declare function extend(objects: Record<string, unknown>): void;
3737
3318
  declare const reconciler: ReactReconciler.Reconciler<RootStore, Instance<any>, void, Instance<any>, never, any>;
3738
3319
 
3739
3320
  declare const isRenderer: (def: any) => boolean;
@@ -3758,13 +3339,9 @@ declare function Portal({ children, container, state }: PortalProps): JSX.Elemen
3758
3339
  declare function flushSync<R>(fn: () => R): R;
3759
3340
 
3760
3341
  declare const context: React$1.Context<RootStore>;
3342
+
3761
3343
  declare const createStore: (invalidate: (state?: RootState, frames?: number, stackFrames?: boolean) => void, advance: (timestamp: number, runGlobalEffects?: boolean, state?: RootState, frame?: XRFrame) => void) => RootStore;
3762
3344
 
3763
- /**
3764
- * Safely flush async effects when testing, simulating a legacy root.
3765
- * @deprecated Import from React instead. import { act } from 'react'
3766
- */
3767
- declare const act: typeof React$1.act;
3768
3345
  /**
3769
3346
  * An SSR-friendly useLayoutEffect.
3770
3347
  *
@@ -4016,7 +3593,7 @@ declare function getInstanceProps<T = any>(pendingProps: Record<string, unknown>
4016
3593
  declare function prepare<T = any>(target: T, root: RootStore, type: string, props: Instance<T>['props']): Instance<T>;
4017
3594
  /**
4018
3595
  * Triggers an update for an instance.
4019
- * Calls onUpdate callback and invalidates the frame if necessary.
3596
+ * Invalidates the frame if the root is in demand mode.
4020
3597
  *
4021
3598
  * @param instance - Instance to invalidate
4022
3599
  */
@@ -4182,29 +3759,44 @@ declare const hasConstructor: (object: unknown) => object is {
4182
3759
  * Used to identify values that should be resolved from refs after mount.
4183
3760
  */
4184
3761
  declare const FROM_REF: unique symbol;
3762
+ /** The marker `fromRef()` returns; resolved by the reconciler in `commitMount`. */
3763
+ interface FromRefMarker<T = unknown, R = T> {
3764
+ [FROM_REF]: React$1.RefObject<T | null>;
3765
+ /** Optional transform applied to the resolved ref before assignment. */
3766
+ transform?: (value: T) => R;
3767
+ }
4185
3768
  /**
4186
3769
  * Defers prop application until the referenced object is available.
4187
3770
  * Useful for props like `target` that need sibling refs to be populated.
4188
3771
  *
3772
+ * Only top-level props on a three element are resolved: a marker nested inside another value
3773
+ * (an array, an options object) is never seen. When the prop needs the sibling *wrapped* rather
3774
+ * than assigned as-is, pass a `transform`; it runs once the ref is populated and its result is
3775
+ * what gets assigned.
3776
+ *
4189
3777
  * @param ref - React ref object to resolve at mount time
4190
- * @returns A marker value that applyProps will resolve after mount
3778
+ * @param transform - Optional mapping from the resolved object to the value the prop expects
3779
+ * @returns A marker value that the reconciler resolves after mount
4191
3780
  *
4192
3781
  * @example
4193
3782
  * const targetRef = useRef<THREE.Object3D>(null)
4194
3783
  *
4195
3784
  * <group ref={targetRef} position={[-3, -2, -15]} />
4196
3785
  * <spotLight target={fromRef(targetRef)} intensity={100} />
3786
+ *
3787
+ * @example
3788
+ * // Wrap the sibling: a node material's lightsNode needs a LightsNode, not the light itself
3789
+ * <meshPhongNodeMaterial lightsNode={fromRef(lightRef, (light) => lights([light]))} />
4197
3790
  */
4198
3791
  declare function fromRef<T>(ref: React$1.RefObject<T | null>): T;
3792
+ declare function fromRef<T, R>(ref: React$1.RefObject<T | null>, transform: (value: T) => R): R;
4199
3793
  /**
4200
3794
  * Type guard to check if a value is a fromRef marker.
4201
3795
  *
4202
3796
  * @param value - Value to check
4203
3797
  * @returns True if value is a fromRef marker
4204
3798
  */
4205
- declare function isFromRef(value: unknown): value is {
4206
- [FROM_REF]: React$1.RefObject<any>;
4207
- };
3799
+ declare function isFromRef(value: unknown): value is FromRefMarker<any, unknown>;
4208
3800
 
4209
3801
  /**
4210
3802
  * Symbol marker for mount-only method calls.
@@ -4231,7 +3823,15 @@ declare const ONCE: unique symbol;
4231
3823
  * // No arguments
4232
3824
  * <geometry center={once()} />
4233
3825
  */
4234
- declare function once<T>(...args: T[]): T;
3826
+ declare function once<A extends unknown[]>(...args: A): OnceValue<A>;
3827
+ /**
3828
+ * What `once(...args)` is typed as, so the marker is assignable to the prop it targets:
3829
+ * the single argument itself (`rotateX={once(angle)}`), the argument tuple for multi-argument
3830
+ * methods (`translate={once(x, y, z)}`), or `true` for a bare call (`center={once()}`).
3831
+ *
3832
+ * The runtime value is always the marker object; only the declared type follows the prop.
3833
+ */
3834
+ type OnceValue<A extends unknown[]> = A extends [] ? true : A extends [infer Single] ? Single : A;
4235
3835
  /**
4236
3836
  * Type guard to check if a value is a once marker.
4237
3837
  *
@@ -4243,10 +3843,31 @@ declare function isOnce(value: unknown): value is {
4243
3843
  };
4244
3844
 
4245
3845
  /**
4246
- * A DOM canvas which accepts threejs elements as children.
4247
- * @see https://docs.pmnd.rs/react-three-fiber/api/canvas
3846
+ * @fileoverview Legacy entry point - WebGL only
3847
+ *
3848
+ * This entry point is for apps that want to use the legacy WebGLRenderer.
3849
+ * No WebGPU features are available from this import path.
3850
+ * Auto-extends THREE with WebGL-only constructors (no node materials).
3851
+ *
3852
+ * Usage:
3853
+ * import { Canvas, useFrame } from '@react-three/fiber/legacy'
4248
3854
  */
4249
- declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
4250
3855
 
4251
- 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 };
4252
- 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, LegacyInternalState as 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, LegacyRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootOptions, LegacyRootState as 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 };
3856
+ /** `useThree` narrowed to legacy state — `state.renderer` is a `WebGLRenderer`. */
3857
+ type UseThreeLegacy = <T = LegacyRootState>(selector?: (state: LegacyRootState) => T, equalityFn?: <U>(state: U, newState: U) => boolean) => T;
3858
+ /** `useFrame` narrowed to legacy state — the callback's `state.renderer` is a `WebGLRenderer`. */
3859
+ type UseFrameLegacy = (callback?: FrameCallback$1<LegacyRootState>, priorityOrOptions?: number | UseFrameNextOptions) => FrameNextControls;
3860
+ declare const useThree: UseThreeLegacy;
3861
+ declare const useFrame: UseFrameLegacy;
3862
+
3863
+ /** Canvas props on the legacy entry: `onCreated` receives `LegacyRootState`. */
3864
+ type LegacyCanvasProps = Omit<CanvasProps, 'onCreated'> & {
3865
+ /** Callback after the canvas has rendered (but not yet committed); `state.renderer` is a `WebGLRenderer` */
3866
+ onCreated?: (state: LegacyRootState) => void;
3867
+ };
3868
+
3869
+ /** `Canvas` narrowed to legacy state — the same component, `onCreated` typed against `LegacyRootState`. */
3870
+ declare const Canvas: (props: LegacyCanvasProps) => JSX.Element;
3871
+
3872
+ 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, registerRootExtension, removeInteractivity, resolve, setRenderOverride, swapInteractivity, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useMutableCallback, useRenderTarget, useStore, useTexture, useTextures, useThree, waitForPrimary };
3873
+ export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferLike, BufferRecord, BufferStore, Camera, CameraProps, LegacyCanvasProps as 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, FromRefMarker, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, LegacyInternalState as InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyCanvasProps, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeLike, NodeProps, NodeRecord, NodeStore, NonFunctionKeys, Object3DMethod, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, OnceValue, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, LegacyRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootExtension, LegacyRootState as RootState, RootStore, SetBlock, Size, StorageLike, StorageRecord, StorageStore, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseFrameLegacy, UseTextureOptions, UseTexturesReturn, UseThreeLegacy, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };