@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.
@@ -1,5 +1,6 @@
1
+ import * as three_examples_jsm_inspector_Inspector_js from 'three/examples/jsm/inspector/Inspector.js';
1
2
  import * as three_webgpu from 'three/webgpu';
2
- import { RenderTarget, WebGPURenderer, CanvasTarget, Node, ShaderNodeObject, Euler as Euler$2, Color as Color$2, ColorRepresentation as ColorRepresentation$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, Loader as Loader$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Object3D, Frustum, OrthographicCamera, WebGPURendererParameters } from 'three/webgpu';
3
+ import { CubeRenderTarget, RenderTarget, WebGPURenderer, Node, StorageTexture, Storage3DTexture, StorageArrayTexture, Data3DTexture, CanvasTarget, Euler as Euler$2, Color as Color$2, ColorRepresentation as ColorRepresentation$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Object3D, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, Loader as Loader$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Frustum, OrthographicCamera, Matrix2, WebGPURendererParameters } from 'three/webgpu';
3
4
  import { Inspector } from 'three/addons/inspector/Inspector.js';
4
5
  import * as THREE$1 from 'three';
5
6
  import { Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1 } from 'three';
@@ -7,25 +8,12 @@ import * as React$1 from 'react';
7
8
  import { ReactNode, Component, RefObject, JSX } from 'react';
8
9
  import { StoreApi } from 'zustand';
9
10
  import { UseBoundStoreWithEqualityFn } from 'zustand/traditional';
11
+ import { FrameTimingState, FrameCallback as FrameCallback$1, SchedulerApi, UseFrameNextOptions, FrameNextControls } from '@pmndrs/scheduler';
12
+ export { AddPhaseOptions, FrameControls, FrameNextControls, FrameTimingState, RootOptions, Scheduler, SchedulerApi, UseFrameNextOptions, UseFrameOptions, getScheduler } from '@pmndrs/scheduler';
10
13
  import { Options } from 'react-use-measure';
11
14
  import * as react_jsx_runtime from 'react/jsx-runtime';
12
- import { ThreeElement as ThreeElement$1, Euler as Euler$3 } from '@react-three/fiber';
13
15
  import { GroundedSkybox } from 'three/examples/jsm/objects/GroundedSkybox.js';
14
16
 
15
- function _mergeNamespaces(n, m) {
16
- m.forEach(function (e) {
17
- e && typeof e !== 'string' && !Array.isArray(e) && Object.keys(e).forEach(function (k) {
18
- if (k !== 'default' && !(k in n)) {
19
- var d = Object.getOwnPropertyDescriptor(e, k);
20
- Object.defineProperty(n, k, d.get ? d : {
21
- enumerable: true,
22
- get: function () { return e[k]; }
23
- });
24
- }
25
- });
26
- });
27
- return Object.freeze(n);
28
- }
29
17
 
30
18
  /**
31
19
  * @fileoverview Internal Three.js re-exports - WEBGPU ONLY ENTRY
@@ -39,6 +27,8 @@ function _mergeNamespaces(n, m) {
39
27
  declare const R3F_BUILD_LEGACY = false;
40
28
  declare const R3F_BUILD_WEBGPU = true;
41
29
 
30
+ /** Lazily load the three Inspector. Keeps it out of the eager module graph — see note above. */
31
+ declare function loadInspector(): Promise<typeof three_examples_jsm_inspector_Inspector_js.Inspector>;
42
32
  declare const WebGLRenderer: {
43
33
  new (): {};
44
34
  };
@@ -47,17 +37,8 @@ type WebGLShadowMap = never;
47
37
 
48
38
  declare const WebGLRenderTarget: any;
49
39
 
50
- var THREE = /*#__PURE__*/_mergeNamespaces({
51
- __proto__: null,
52
- Inspector: Inspector,
53
- R3F_BUILD_LEGACY: R3F_BUILD_LEGACY,
54
- R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
55
- RenderTargetCompat: RenderTarget,
56
- WebGLRenderTarget: WebGLRenderTarget,
57
- WebGLRenderer: WebGLRenderer,
58
- WebGLRendererParameters: WebGLRendererParameters,
59
- WebGLShadowMap: WebGLShadowMap
60
- }, [three_webgpu]);
40
+ declare const WebGLCubeRenderTarget: any;
41
+
61
42
 
62
43
  //* Utility Types ==============================
63
44
 
@@ -151,6 +132,8 @@ interface IntersectionEvent<TSourceEvent> extends Intersection {
151
132
  unprojectedPoint: THREE$1.Vector3
152
133
  /** Normalized event coordinates */
153
134
  pointer: THREE$1.Vector2
135
+ /** pointerId of the original event for multiple pointer events */
136
+ pointerId: number
154
137
  /** Delta between first click and this event */
155
138
  delta: number
156
139
  /** The ray that pierced it */
@@ -227,6 +210,18 @@ interface EventHandlers {
227
210
  type FilterFunction = (items: THREE$1.Intersection[], state: RootState) => THREE$1.Intersection[]
228
211
  type ComputeFunction = (event: DomEvent, root: RootState, previous?: RootState) => void
229
212
 
213
+ /** Configuration for XR pointer registration (controllers/hands) */
214
+ interface XRPointerConfig {
215
+ /** Ray origin (updated each frame by XR system) */
216
+ ray: THREE$1.Ray
217
+ /** Optional: custom compute function for this pointer */
218
+ compute?: (state: RootState) => void
219
+ /** Pointer type identifier */
220
+ type: 'controller' | 'hand' | 'gaze'
221
+ /** Which hand (for controller/hand types) */
222
+ handedness?: 'left' | 'right'
223
+ }
224
+
230
225
  interface EventManager<TTarget> {
231
226
  /** Determines if the event layer is active */
232
227
  enabled: boolean
@@ -246,8 +241,21 @@ interface EventManager<TTarget> {
246
241
  disconnect?: () => void
247
242
  /** Triggers a onPointerMove with the last known event. This can be useful to enable raycasting without
248
243
  * explicit user interaction, for instance when the camera moves a hoverable object underneath the cursor.
244
+ * @param pointerId - Optional pointer ID to update specific pointer only
249
245
  */
250
- update?: () => void
246
+ update?: (pointerId?: number) => void
247
+ /** Defer pointer move raycasting to frame start (default: true) */
248
+ frameTimedRaycasts?: boolean
249
+ /** Always fire raycaster immediately on scroll events (default: true) */
250
+ alwaysFireOnScroll?: boolean
251
+ /** Automatically re-raycast every frame to detect hover changes from moving objects/camera (default: false) */
252
+ updateOnFrame?: boolean
253
+ /** Flush deferred pointer raycasts. Called by scheduler at frame start (input phase). */
254
+ flush?: () => void
255
+ /** Register an XR pointer (controller/hand). Returns assigned pointerId */
256
+ registerPointer?: (config: XRPointerConfig) => number
257
+ /** Unregister an XR pointer */
258
+ unregisterPointer?: (pointerId: number) => void
251
259
  }
252
260
 
253
261
  interface PointerCaptureTarget {
@@ -267,227 +275,116 @@ interface VisibilityEntry {
267
275
  }
268
276
 
269
277
  //* Scheduler Types (useFrame) ==============================
278
+ //
279
+ // The generic, framework-agnostic scheduler types now live in @pmndrs/scheduler.
280
+ // This file re-exports them and layers r3f's RootState-aware frame state on top,
281
+ // so existing `#types` imports across the codebase keep resolving unchanged.
270
282
 
271
283
 
272
284
 
273
- // Public Options --------------------------------
285
+ // Frame State (r3f-specific) --------------------------------
274
286
 
275
287
  /**
276
- * Options for useFrame hook
288
+ * State passed to useFrame callbacks (extends RootState with timing).
277
289
  */
278
- interface UseFrameNextOptions {
279
- /** Optional stable id for the job. Auto-generated if not provided */
280
- id?: string
281
- /** Named phase to run in. Default: 'update' */
282
- phase?: string
283
- /** Run before this phase or job id */
284
- before?: string | string[]
285
- /** Run after this phase or job id */
286
- after?: string | string[]
287
- /** Priority within phase. Higher runs first. Default: 0 */
288
- priority?: number
289
- /** Max frames per second for this job */
290
- fps?: number
291
- /** If true, skip frames when behind. If false, try to catch up. Default: true */
292
- drop?: boolean
293
- /** Enable/disable without unregistering. Default: true */
294
- enabled?: boolean
295
- }
290
+ interface FrameNextState extends RootState, FrameTimingState {}
296
291
 
297
- /** Alias for UseFrameNextOptions */
298
- type UseFrameOptions = UseFrameNextOptions
292
+ /** Alias for FrameNextState */
293
+ type FrameState = FrameNextState
294
+
295
+ // Callback Types (r3f-specific) --------------------------------
299
296
 
300
297
  /**
301
- * Options for addPhase
298
+ * Callback function for useFrame. Receives the full r3f RootState plus timing.
302
299
  */
303
- interface AddPhaseOptions {
304
- /** Insert this phase before the specified phase */
305
- before?: string
306
- /** Insert this phase after the specified phase */
307
- after?: string
308
- }
300
+ type FrameNextCallback = FrameCallback$1<RootState>
301
+
302
+ /** Alias for FrameNextCallback */
303
+ type FrameCallback = FrameNextCallback
309
304
 
310
- // Frame State --------------------------------
305
+ //* Buffer Types (useBuffers) ========================================
311
306
 
312
307
  /**
313
- * Timing-only state for independent/outside mode (no RootState)
308
+ * Buffer-like types for GPU compute and storage operations.
309
+ * Includes raw CPU arrays, Three.js buffer attributes, and TSL buffer nodes.
310
+ *
311
+ * @example
312
+ * ```tsx
313
+ * const { positions, velocities } = useBuffers(() => ({
314
+ * positions: instancedArray(count, 'vec3'), // StorageBufferNode
315
+ * velocities: new Float32Array(count * 3), // TypedArray
316
+ * }), 'particles')
317
+ * ```
314
318
  */
315
- interface FrameTimingState {
316
- /** High-resolution timestamp from RAF (ms) */
317
- time: number
318
- /** Time since last frame in seconds (for legacy compatibility with THREE.Clock) */
319
- delta: number
320
- /** Elapsed time since first frame in seconds (for legacy compatibility with THREE.Clock) */
321
- elapsed: number
322
- /** Incrementing frame counter */
323
- frame: number
324
- }
319
+ type BufferLike =
320
+ | Float32Array
321
+ | Uint32Array
322
+ | Int32Array
323
+ | Float64Array
324
+ | Uint8Array
325
+ | Int8Array
326
+ | Uint16Array
327
+ | Int16Array
328
+ | THREE$1.BufferAttribute // Base class for all buffer attributes
329
+ | THREE$1.InterleavedBufferAttribute
330
+ | Node // TSL buffer nodes (instancedArray, storage)
331
+
332
+ /** Flat record of buffer-like values (no nested scopes) */
333
+ type BufferRecord = Record<string, BufferLike>
325
334
 
326
335
  /**
327
- * State passed to useFrame callbacks (extends RootState with timing)
336
+ * Buffer store that can contain both root-level buffers and scoped buffer objects.
337
+ * Structure: { positions: Float32Array, particles: { vel: StorageBufferNode } }
328
338
  */
329
- interface FrameNextState extends RootState, FrameTimingState {}
330
-
331
- /** Alias for FrameNextState */
332
- type FrameState = FrameNextState
339
+ type BufferStore = Record<string, BufferLike | BufferRecord>
333
340
 
334
- // Root Options --------------------------------
341
+ //* Node Types (useNodes) ========================================
335
342
 
336
343
  /**
337
- * Options for registerRoot
344
+ * Every node representation `useNodes` accepts and `state.nodes` holds: three's real `Node`,
345
+ * the callable proxy `Fn()` returns, and the legacy structural shape (`uuid`/`nodeType`) older
346
+ * code passes through. Creators are constrained to this same type, so the shape a creator returns
347
+ * and the shape the store holds are one type by construction.
338
348
  */
339
- interface RootOptions {
340
- /** State provider for callbacks. Optional in independent mode. */
341
- getState?: () => any
342
- /** Error handler for job errors. Falls back to console.error if not provided. */
343
- onError?: (error: Error) => void
344
- }
349
+ type NodeLike = TSLNodeType | LegacyTSLNodeLike
345
350
 
346
- // Callback Types --------------------------------
351
+ /** Flat record of TSL nodes (no nested scopes) */
352
+ type NodeRecord<T extends NodeLike = NodeLike> = Record<string, T>
347
353
 
348
354
  /**
349
- * Callback function for useFrame
355
+ * Node store that can contain both root-level nodes and scoped node objects.
356
+ * Structure: { wobble: OperatorNode, fx: { blur: ShaderCallable } }
350
357
  */
351
- type FrameNextCallback = (state: FrameNextState, delta: number) => void
352
-
353
- /** Alias for FrameNextCallback */
354
- type FrameCallback = FrameNextCallback
358
+ type NodeStore = Record<string, NodeLike | NodeRecord>
355
359
 
356
- // Controls returned from useFrame --------------------------------
360
+ //* Storage Types (useGPUStorage) ========================================
357
361
 
358
362
  /**
359
- * Controls object returned from useFrame hook
363
+ * GPU storage types for texture-based storage operations.
364
+ * Includes Three.js storage textures and TSL storage texture nodes.
365
+ *
366
+ * @example
367
+ * ```tsx
368
+ * const { heightMap } = useGPUStorage(() => ({
369
+ * heightMap: new StorageTexture(512, 512),
370
+ * }), 'terrain')
371
+ * ```
360
372
  */
361
- interface FrameNextControls {
362
- /** The job's unique ID */
363
- id: string
364
- /** Access to the global scheduler for frame loop control */
365
- scheduler: SchedulerApi
366
- /** Manually step this job only (bypasses FPS limiting) */
367
- step(timestamp?: number): void
368
- /** Manually step ALL jobs in the scheduler */
369
- stepAll(timestamp?: number): void
370
- /** Pause this job (set enabled=false) */
371
- pause(): void
372
- /** Resume this job (set enabled=true) */
373
- resume(): void
374
- /** Reactive paused state - automatically triggers re-render when changed */
375
- isPaused: boolean
376
- }
377
-
378
- /** Alias for FrameNextControls */
379
- type FrameControls = FrameNextControls
373
+ type StorageLike =
374
+ | StorageTexture // 2D GPU storage texture
375
+ | Storage3DTexture // 3D GPU storage texture (volumes, fluid grids)
376
+ | StorageArrayTexture // 2D-array GPU storage texture
377
+ | Data3DTexture // 3D texture (can be used as storage)
378
+ | Node // TSL storage texture nodes (storageTexture)
380
379
 
381
- // Scheduler Interface --------------------------------
380
+ /** Flat record of storage-like values (no nested scopes) */
381
+ type StorageRecord = Record<string, StorageLike>
382
382
 
383
383
  /**
384
- * Public interface for the global Scheduler
384
+ * Storage store that can contain both root-level storage and scoped storage objects.
385
+ * Structure: { heightMap: StorageTexture, terrain: { normal: StorageTextureNode } }
385
386
  */
386
- interface SchedulerApi {
387
- //* Phase Management --------------------------------
388
-
389
- /** Add a named phase to the scheduler */
390
- addPhase(name: string, options?: AddPhaseOptions): void
391
- /** Get the ordered list of phase names */
392
- readonly phases: string[]
393
- /** Check if a phase exists */
394
- hasPhase(name: string): boolean
395
-
396
- //* Root Management --------------------------------
397
-
398
- /** Register a root (Canvas) with the scheduler. Returns unsubscribe function. */
399
- registerRoot(id: string, options?: RootOptions): () => void
400
- /** Unregister a root */
401
- unregisterRoot(id: string): void
402
- /** Generate a unique root ID */
403
- generateRootId(): string
404
- /** Get the number of registered roots */
405
- getRootCount(): number
406
- /** Check if any root is registered and ready */
407
- readonly isReady: boolean
408
- /** Subscribe to root-ready event. Fires immediately if already ready. Returns unsubscribe. */
409
- onRootReady(callback: () => void): () => void
410
-
411
- //* Job Registration --------------------------------
412
-
413
- /** Register a job with the scheduler (returns unsubscribe function) */
414
- register(
415
- callback: FrameNextCallback,
416
- options?: {
417
- id?: string
418
- rootId?: string
419
- phase?: string
420
- before?: string | string[]
421
- after?: string | string[]
422
- priority?: number
423
- fps?: number
424
- drop?: boolean
425
- enabled?: boolean
426
- },
427
- ): () => void
428
- /** Update a job's options */
429
- updateJob(
430
- id: string,
431
- options: {
432
- priority?: number
433
- fps?: number
434
- drop?: boolean
435
- enabled?: boolean
436
- phase?: string
437
- before?: string | string[]
438
- after?: string | string[]
439
- },
440
- ): void
441
- /** Unregister a job by ID */
442
- unregister(id: string, rootId?: string): void
443
- /** Get the number of registered jobs */
444
- getJobCount(): number
445
- /** Get all job IDs */
446
- getJobIds(): string[]
447
-
448
- //* Global Jobs (for legacy addEffect/addAfterEffect) --------------------------------
449
-
450
- /** Register a global job (runs once per frame, not per-root). Returns unsubscribe function. */
451
- registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void
452
-
453
- //* Idle Callbacks (for legacy addTail) --------------------------------
454
-
455
- /** Register an idle callback (fires when loop stops). Returns unsubscribe function. */
456
- onIdle(callback: (timestamp: number) => void): () => void
457
-
458
- //* Frame Loop Control --------------------------------
459
-
460
- /** Start the scheduler loop */
461
- start(): void
462
- /** Stop the scheduler loop */
463
- stop(): void
464
- /** Check if the scheduler is running */
465
- readonly isRunning: boolean
466
- /** Get/set the frameloop mode ('always', 'demand', 'never') */
467
- frameloop: Frameloop
468
- /** Independent mode - runs without Canvas, callbacks receive timing-only state */
469
- independent: boolean
470
-
471
- //* Manual Stepping --------------------------------
472
-
473
- /** Manually step all jobs once (for frameloop='never' or testing) */
474
- step(timestamp?: number): void
475
- /** Manually step a single job by ID */
476
- stepJob(id: string, timestamp?: number): void
477
- /** Request frame(s) to be rendered (for frameloop='demand') */
478
- invalidate(frames?: number): void
479
-
480
- //* Per-Job Control --------------------------------
481
-
482
- /** Check if a job is paused */
483
- isJobPaused(id: string): boolean
484
- /** Pause a job */
485
- pauseJob(id: string): void
486
- /** Resume a job */
487
- resumeJob(id: string): void
488
- /** Subscribe to job state changes (for reactive isPaused). Returns unsubscribe function. */
489
- subscribeJobState(id: string, listener: () => void): () => void
490
- }
387
+ type StorageStore = Record<string, StorageLike | StorageRecord>
491
388
 
492
389
  //* Renderer Types ========================================
493
390
 
@@ -502,6 +399,18 @@ type Subscription = {
502
399
  store: RootStore
503
400
  }
504
401
 
402
+ /** Per-pointer state for multi-touch and XR support */
403
+ type PointerState = {
404
+ /** Objects currently hovered by this pointer */
405
+ hovered: Map<string, ThreeEvent<DomEvent>>
406
+ /** Objects capturing this pointer */
407
+ captured: Map<THREE$1.Object3D, PointerCaptureTarget>
408
+ /** Initial click position [x, y] */
409
+ initialClick: [x: number, y: number]
410
+ /** Objects hit on initial click */
411
+ initialHits: THREE$1.Object3D[]
412
+ }
413
+
505
414
  type Dpr = number | [min: number, max: number]
506
415
 
507
416
  interface Size {
@@ -543,12 +452,21 @@ interface Performance {
543
452
 
544
453
  interface InternalState {
545
454
  interaction: THREE$1.Object3D[]
546
- hovered: Map<string, ThreeEvent<DomEvent>>
547
455
  subscribers: Subscription[]
456
+ /** Per-pointer state (hover, capture, click tracking) - replaces hovered, capturedMap, initialClick, initialHits */
457
+ pointerMap: Map<number, PointerState>
458
+ /** Pointers needing raycast this frame (used with frameTimedRaycasts) */
459
+ pointerDirty: Map<number, DomEvent>
460
+ /** Last event received (for events.update() compatibility) */
461
+ lastEvent: React$1.RefObject<DomEvent | null>
462
+ /** @deprecated Use pointerMap.get(pointerId).hovered instead */
463
+ hovered: Map<string, ThreeEvent<DomEvent>>
464
+ /** @deprecated Use pointerMap.get(pointerId).captured instead */
548
465
  capturedMap: Map<number, Map<THREE$1.Object3D, PointerCaptureTarget>>
466
+ /** @deprecated Use pointerMap.get(pointerId).initialClick instead */
549
467
  initialClick: [x: number, y: number]
468
+ /** @deprecated Use pointerMap.get(pointerId).initialHits instead */
550
469
  initialHits: THREE$1.Object3D[]
551
- lastEvent: React$1.RefObject<DomEvent | null>
552
470
  /** Visibility event registry (onFramed, onOccluded, onVisible) */
553
471
  visibilityRegistry: Map<string, VisibilityEntry>
554
472
  /** Whether occlusion queries are enabled (WebGPU only) */
@@ -567,6 +485,12 @@ interface InternalState {
567
485
  actualRenderer: R3FRenderer
568
486
  /** Global scheduler reference (for useFrame hook) */
569
487
  scheduler: SchedulerApi | null
488
+ /**
489
+ * Replaces `renderer.render(scene, camera)` in the default render job when set. Set it with
490
+ * `setRenderOverride(store, fn)`; the job keeps its fps throttle, error handling and user
491
+ * render-phase takeover. Used by `useRenderPipeline`.
492
+ */
493
+ renderOverride?: (() => void) | null
570
494
  /** This root's unique ID in the global scheduler */
571
495
  rootId?: string
572
496
  /** Function to unregister this root from the global scheduler */
@@ -574,14 +498,31 @@ interface InternalState {
574
498
  /** Container for child attachment (scene for root, original container for portals) */
575
499
  container?: THREE$1.Object3D
576
500
  /**
577
- * CanvasTarget for multi-canvas WebGPU rendering.
578
- * Created for all WebGPU canvases to support renderer sharing.
501
+ * The CanvasTarget this root sizes and renders through.
502
+ *
503
+ * A primary (`<Canvas id>`) owns the renderer's default target -- the one three itself built
504
+ * around the canvas element -- so sizing it is sizing the renderer. A secondary owns a target
505
+ * R3F created for its own element. Either way there is exactly one target per canvas element,
506
+ * and the canvas-target job makes it the renderer's active one before this root renders.
507
+ * Absent on WebGL and on an id-less WebGPU canvas, where the renderer is sized directly.
579
508
  * @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
580
509
  */
581
510
  canvasTarget?: CanvasTarget
511
+ /**
512
+ * Set when this root's canvas target has been resized and the backend's cached render pass
513
+ * descriptor (which holds a depth-stencil view built once per canvas) is therefore stale.
514
+ *
515
+ * Flushed by the canvas-target job in the `start` phase, which is the only place this root's
516
+ * target is guaranteed to be the renderer's active one — `backend.updateSize()` operates on
517
+ * whatever `getCanvasTarget()` returns, so calling it from the resize subscription would
518
+ * invalidate some other canvas's descriptor instead.
519
+ *
520
+ * @see https://github.com/pmndrs/react-three-fiber/issues/3847
521
+ */
522
+ canvasTargetSizeDirty?: boolean
582
523
  /**
583
524
  * Whether multi-canvas rendering is active.
584
- * True when any canvas uses `target` prop to share a renderer.
525
+ * True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
585
526
  * When true, setCanvasTarget is called before each render.
586
527
  */
587
528
  isMultiCanvas?: boolean
@@ -679,8 +620,8 @@ interface RootState {
679
620
  setSize: (width?: number, height?: number, top?: number, left?: number) => void
680
621
  /** Shortcut to manual setting the pixel ratio */
681
622
  setDpr: (dpr: Dpr) => void
682
- /** Shortcut to setting frameloop flags */
683
- setFrameloop: (frameloop: Frameloop) => void
623
+ /** Shortcut to setting frameloop flags. No args resets to 'always'. */
624
+ setFrameloop: (frameloop?: Frameloop) => void
684
625
  /** Set error state to propagate to error boundary */
685
626
  setError: (error: Error | null) => void
686
627
  /** Current error state (null when no error) */
@@ -688,13 +629,19 @@ interface RootState {
688
629
  /** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
689
630
  uniforms: UniformStore
690
631
  /** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
691
- nodes: Record<string, any>
692
- /** Global TSL texture nodes - use useTextures() hook for operations */
693
- textures: Map<string, any>
694
- /** WebGPU PostProcessing instance - use usePostProcessing() hook */
695
- postProcessing: any | null // THREE.PostProcessing when available
696
- /** Global TSL pass nodes for post-processing - use usePostProcessing() hook */
697
- passes: Record<string, any>
632
+ nodes: NodeStore
633
+ /** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
634
+ buffers: BufferStore
635
+ /** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
636
+ gpuStorage: StorageStore
637
+ /** Global Texture registry (key → Texture, usually keyed by URL) - use useTextures() hook for access + lifecycle */
638
+ textures: Map<string, THREE$1.Texture>
639
+ /** Internal: refcount per texture key, driven by mounted useTexture consumers (registry enrollment is on by default) */
640
+ _textureRefs: Map<string, number>
641
+ /** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
642
+ renderPipeline: ThreeRenderPipeline | null
643
+ /** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
644
+ passes: PassRecord
698
645
  /** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
699
646
  _hmrVersion: number
700
647
  /** Internal: whether setSize() has taken ownership of canvas dimensions */
@@ -743,6 +690,20 @@ interface Renderer {
743
690
  render: (scene: THREE$1.Scene, camera: THREE$1.Camera) => any
744
691
  }
745
692
 
693
+ //* Color Management Config ==============================
694
+
695
+ /**
696
+ * Color management configuration shared by both WebGL and WebGPU renderers.
697
+ */
698
+ interface ColorManagementConfig {
699
+ /**
700
+ * Color space assigned to 8-bit input textures (color maps).
701
+ * Defaults to sRGB. Most textures are authored in sRGB.
702
+ * @default THREE.SRGBColorSpace
703
+ */
704
+ textureColorSpace?: THREE$1.ColorSpace
705
+ }
706
+
746
707
  //* WebGL Renderer Props ==============================
747
708
 
748
709
  type DefaultGLProps = Omit<THREE$1.WebGLRendererParameters, 'canvas'> & {
@@ -753,7 +714,7 @@ type GLProps =
753
714
  | Renderer
754
715
  | ((defaultProps: DefaultGLProps) => Renderer)
755
716
  | ((defaultProps: DefaultGLProps) => Promise<Renderer>)
756
- | Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters>
717
+ | (Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters> & ColorManagementConfig)
757
718
 
758
719
  //* WebGPU Renderer Props ==============================
759
720
 
@@ -768,20 +729,27 @@ type DefaultRendererProps = {
768
729
  */
769
730
  interface CanvasSchedulerConfig {
770
731
  /**
771
- * Render this canvas after another canvas completes.
772
- * Pass the `id` of another canvas.
732
+ * Run this Canvas root before the referenced Canvas root id(s).
733
+ */
734
+ before?: string | string[]
735
+ /**
736
+ * Run this Canvas root after the referenced Canvas root id(s).
773
737
  */
774
- after?: string
738
+ after?: string | string[]
739
+ /**
740
+ * Numeric root order. Lower values run first.
741
+ */
742
+ order?: number
775
743
  /**
776
- * Limit this canvas's render rate (frames per second).
744
+ * Limit this Canvas's default render job (frames per second).
777
745
  */
778
746
  fps?: number
779
747
  }
780
748
 
781
749
  /**
782
- * Extended renderer configuration for multi-canvas support.
750
+ * Extended renderer configuration for multi-canvas support and color management.
783
751
  */
784
- interface RendererConfigExtended {
752
+ interface RendererConfigExtended extends ColorManagementConfig {
785
753
  /** Share renderer from another canvas (WebGPU only) */
786
754
  primaryCanvas?: string
787
755
  /** Canvas-level scheduler options */
@@ -846,8 +814,6 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
846
814
  * @see https://threejs.org/docs/#api/en/renderers/WebGLRenderer.shadowMap
847
815
  */
848
816
  shadows?: boolean | 'basic' | 'percentage' | 'soft' | 'variance' | Partial<THREE$1.WebGLShadowMap>
849
- /** Color space assigned to 8-bit input textures (color maps). Defaults to sRGB. Most textures are authored in sRGB. */
850
- textureColorSpace?: THREE$1.ColorSpace
851
817
  /** Creates an orthographic camera */
852
818
  orthographic?: boolean
853
819
  /**
@@ -862,14 +828,17 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
862
828
  performance?: Partial<Omit<Performance, 'regress'>>
863
829
  /** Target pixel ratio. Can clamp between a range: `[min, max]` */
864
830
  dpr?: Dpr
865
- /** Props that go into the default raycaster */
866
- raycaster?: Partial<THREE$1.Raycaster>
831
+ /**
832
+ * Props that go into the default raycaster. `params` is merged into the raycaster's defaults,
833
+ * so a single threshold can be set: `raycaster={{ params: { Points: { threshold: 0.2 } } }}`.
834
+ */
835
+ raycaster?: Partial<Omit<THREE$1.Raycaster, 'params'>> & { params?: Partial<THREE$1.RaycasterParameters> }
867
836
  /** A `THREE.Scene` instance or props that go into the default scene */
868
837
  scene?: THREE$1.Scene | Partial<THREE$1.Scene>
869
838
  /** A `THREE.Camera` instance or props that go into the default camera */
870
839
  camera?: CameraProps
871
840
  /** An R3F event manager to manage elements' pointer events */
872
- events?: (store: RootStore) => EventManager<HTMLElement>
841
+ events?: (store: RootStore) => EventManager<Element>
873
842
  /** Callback after the canvas has rendered (but not yet committed) */
874
843
  onCreated?: (state: RootState) => void
875
844
  /** Response for pointer clicks that have missed any target */
@@ -958,7 +927,6 @@ type InstanceProps<T = any, P = any> = ArgsProp<P> & {
958
927
  object?: T
959
928
  dispose?: null
960
929
  attach?: AttachType<T>
961
- onUpdate?: (self: T) => void
962
930
  }
963
931
 
964
932
  interface Instance<O = any> {
@@ -973,8 +941,6 @@ interface Instance<O = any> {
973
941
  attach?: AttachType<O>
974
942
  previousAttach?: any
975
943
  isHidden: boolean
976
- /** Deferred ref props to apply in commitMount */
977
- deferredRefs?: Array<{ prop: string; ref: React$1.RefObject<any> }>
978
944
  /** Set of props that have been applied via once() */
979
945
  appliedOnce?: Set<string>
980
946
  }
@@ -1100,7 +1066,7 @@ interface CanvasProps
1100
1066
  */
1101
1067
  resize?: Options
1102
1068
  /** The target where events are being subscribed to, default: the div that wraps canvas */
1103
- eventSource?: HTMLElement | React$1.RefObject<HTMLElement>
1069
+ eventSource?: Element | React$1.RefObject<Element | null>
1104
1070
  /** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
1105
1071
  eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
1106
1072
  /** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
@@ -1208,70 +1174,86 @@ interface LegacyRootState extends Omit<RootState, 'renderer' | 'internal'> {
1208
1174
 
1209
1175
  type RenderTargetOptions = RenderTargetOptions$1
1210
1176
 
1211
- //* Global Types ==============================
1177
+ //* Global TSL Types ==============================
1212
1178
 
1213
1179
  declare global {
1214
- /** Uniform node type - a Node with a value property (matches Three.js UniformNode) */
1215
- interface UniformNode<T = unknown> extends Node {
1216
- value: T
1217
- }
1218
-
1219
1180
  /**
1220
- * ShaderCallable - the return type of Fn()
1221
- * A callable shader function node that can be invoked with parameters.
1222
- * The function returns a ShaderNodeObject when called.
1223
- *
1224
- * @example
1225
- * ```tsx
1226
- * // Define a shader function
1227
- * const blendColorFn = Fn(([color1, color2, factor]) => {
1228
- * return mix(color1, color2, factor)
1229
- * })
1230
- *
1231
- * // Type when retrieving from nodes store
1232
- * const { blendColorFn } = nodes as { blendColorFn: ShaderCallable }
1233
- *
1234
- * // Or with specific return type
1235
- * const { myFn } = nodes as { myFn: ShaderCallable<THREE.Node> }
1236
- * ```
1181
+ * Broad callable-node fallback for dynamic store readers.
1182
+ * Creator hooks preserve the exact function signatures inferred from Three's `Fn`.
1237
1183
  */
1238
- type ShaderCallable<R extends Node = Node> = ((...params: unknown[]) => ShaderNodeObject<R>) & Node
1184
+ type CallableTSLNode = ((...params: never[]) => unknown) & {
1185
+ readonly shaderNode: unknown
1186
+ readonly id: number
1187
+ }
1239
1188
 
1240
- /**
1241
- * ShaderNodeRef - a ShaderNodeObject wrapper around a Node
1242
- * This is the common return type for TSL operations (add, mul, sin, etc.)
1243
- *
1244
- * @example
1245
- * ```tsx
1246
- * const { wobble } = nodes as { wobble: ShaderNodeRef }
1247
- * ```
1248
- */
1249
- type ShaderNodeRef<T extends Node = Node> = ShaderNodeObject<T>
1189
+ /** Legacy structural node accepted when at least one historical marker exists. */
1190
+ type LegacyTSLNodeLike = {
1191
+ label?: ((label: string) => unknown) | string
1192
+ setName?: (name: string) => unknown
1193
+ } & ({ uuid: string | undefined; nodeType?: string | null } | { uuid?: string; nodeType: string | null | undefined })
1194
+
1195
+ /** Node type accepted by broad dynamic node-store readers. */
1196
+ type TSLNodeType = three_webgpu.Node | CallableTSLNode
1250
1197
 
1251
1198
  /**
1252
- * TSLNodeType - Union of all common TSL node types
1253
- * Used by ScopedStore to properly type node access from the store.
1254
- *
1255
- * Includes:
1256
- * - Node: base Three.js node type
1257
- * - ShaderCallable: function nodes created with Fn()
1258
- * - ShaderNodeObject: wrapped nodes from TSL operations (sin, mul, mix, etc.)
1259
- *
1260
- * @example
1261
- * ```tsx
1262
- * // In useLocalNodes, nodes are typed as TSLNodeType
1263
- * const { positionNode, blendColorFn } = useLocalNodes(({ nodes }) => ({
1264
- * positionNode: nodes.myPosition, // Works - Node is in union
1265
- * blendColorFn: nodes.myFn, // Works - ShaderCallable is in union
1266
- * }))
1267
- *
1268
- * // Can narrow with type guard or assertion when needed
1269
- * if (typeof blendColorFn === 'function') {
1270
- * blendColorFn(someColor, 0.5)
1271
- * }
1272
- * ```
1199
+ * Derive Three's shader node type from an existing node or a supported raw input.
1200
+ * Existing InputNode generics take precedence over structural value normalization.
1201
+ * Both generics must be inferred because Three's UniformNode intersects an unknown-typed
1202
+ * InputNode base with its concrete InputNode specialization.
1273
1203
  */
1274
- type TSLNodeType = Node | ShaderCallable<Node> | ShaderNodeObject<Node>
1204
+ type UniformNodeType<T> = T extends three_webgpu.UniformNode<infer TNodeType, infer _TValue>
1205
+ ? TNodeType
1206
+ : T extends three_webgpu.InputNode<infer TNodeType, infer _TValue>
1207
+ ? TNodeType
1208
+ : T extends number
1209
+ ? 'float'
1210
+ : T extends boolean
1211
+ ? 'bool'
1212
+ : T extends string | three_webgpu.Color | { r: number; g: number; b: number }
1213
+ ? 'color'
1214
+ : T extends three_webgpu.Vector4 | { x: number; y: number; z: number; w: number }
1215
+ ? 'vec4'
1216
+ : T extends three_webgpu.Vector3 | { x: number; y: number; z: number }
1217
+ ? 'vec3'
1218
+ : T extends three_webgpu.Vector2 | { x: number; y: number }
1219
+ ? 'vec2'
1220
+ : T extends three_webgpu.Matrix4
1221
+ ? 'mat4'
1222
+ : T extends three_webgpu.Matrix3
1223
+ ? 'mat3'
1224
+ : T extends three_webgpu.Matrix2
1225
+ ? 'mat2'
1226
+ : unknown
1227
+
1228
+ /** Derive the normalized JavaScript value stored by a uniform node. */
1229
+ type UniformNodeValue<T> = T extends three_webgpu.UniformNode<infer _TNodeType, infer TValue>
1230
+ ? TValue
1231
+ : T extends three_webgpu.InputNode<infer _TNodeType, infer TValue>
1232
+ ? TValue
1233
+ : T extends string | { r: number; g: number; b: number }
1234
+ ? three_webgpu.Color
1235
+ : T extends { x: number; y: number; z: number; w: number }
1236
+ ? three_webgpu.Vector4
1237
+ : T extends { x: number; y: number; z: number }
1238
+ ? three_webgpu.Vector3
1239
+ : T extends { x: number; y: number }
1240
+ ? three_webgpu.Vector2
1241
+ : T extends number
1242
+ ? number
1243
+ : T extends boolean
1244
+ ? boolean
1245
+ : T
1246
+
1247
+ /** Three's exact UniformNode with shader and value generics derived from an input. */
1248
+ type UniformNodeFor<T> = three_webgpu.UniformNode<UniformNodeType<T>, UniformNodeValue<T>>
1249
+
1250
+ /** Preserve every input key while mapping values to exact Three uniform nodes. */
1251
+ type UniformNodesFor<T extends UniformInputRecord> = {
1252
+ [K in keyof T]: UniformNodeFor<T[K]>
1253
+ }
1254
+
1255
+ /** Backward-compatible single-parameter uniform alias. */
1256
+ type UniformNode<T = unknown> = UniformNodeFor<T>
1275
1257
 
1276
1258
  /** Flat record of uniform nodes (no nested scopes) */
1277
1259
  type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
@@ -1296,7 +1278,7 @@ declare global {
1296
1278
  * Acceptable input values for useUniforms - raw values that get converted to UniformNodes
1297
1279
  * Supports:
1298
1280
  * - Primitives: number, string (color), boolean
1299
- * - Three.js types: Color, Vector2/3/4, Matrix3/4, Euler, Quaternion
1281
+ * - Three.js types: Color, Vector2/3/4, Matrix2/3/4
1300
1282
  * - Plain objects: { x, y, z, w } converted to vectors
1301
1283
  * - TSL nodes: color(), vec3(), float() for type casting
1302
1284
  * - UniformNode: existing uniforms (reused as-is)
@@ -1309,226 +1291,124 @@ declare global {
1309
1291
  | three_webgpu.Vector2
1310
1292
  | three_webgpu.Vector3
1311
1293
  | three_webgpu.Vector4
1294
+ | three_webgpu.Matrix2
1312
1295
  | three_webgpu.Matrix3
1313
1296
  | three_webgpu.Matrix4
1314
- | three_webgpu.Euler
1315
- | three_webgpu.Quaternion
1316
- | { x: number; y?: number; z?: number; w?: number } // Plain objects converted to vectors
1317
- | Node // TSL nodes like color(), vec3(), float() for type casting
1297
+ | { x: number; y: number }
1298
+ | { x: number; y: number; z: number }
1299
+ | { x: number; y: number; z: number; w: number }
1300
+ | { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
1301
+ | three_webgpu.Node // TSL nodes like color(), vec3(), float() for type casting
1318
1302
  | UniformNode
1319
1303
 
1320
1304
  /** Input record for useUniforms - accepts raw values or UniformNodes */
1321
1305
  type UniformInputRecord = Record<string, UniformValue>
1322
1306
  }
1323
1307
 
1324
- //* Module Augmentation ==============================
1325
-
1326
- declare module 'three/tsl' {
1308
+ declare global {
1327
1309
  /**
1328
- * Fn with array parameter destructuring
1329
- * @example Fn(([uv, skew]) => { ... })
1310
+ * three's own render pipeline type. Named here so the rest of R3F refers to three's shape
1311
+ * rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
1312
+ * is r185, so the new name is the only one.
1330
1313
  */
1331
- export function Fn<R extends Node = Node>(
1332
- jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
1333
- ): ShaderCallable<R>
1314
+ type ThreeRenderPipeline = three_webgpu.RenderPipeline
1334
1315
 
1335
1316
  /**
1336
- * Fn with object parameter destructuring
1337
- * @example Fn(({ color, intensity }) => { ... })
1317
+ * The pass `useRenderPipeline` creates for you: three's own `PassNode`, as returned by
1318
+ * `pass(scene, camera)` from `three/tsl`. Referenced from three so members like
1319
+ * `getTextureNode`, `setMRT` and `dispose` track the installed version.
1338
1320
  */
1339
- export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
1340
- jsFunc: (inputs: T) => ShaderNodeObject<R>,
1341
- ): ShaderCallable<R>
1321
+ type ScenePassNode = three_webgpu.PassNode
1342
1322
 
1343
1323
  /**
1344
- * Fn with array params + layout
1345
- * @example Fn(([a, b]) => { ... }, { layout: [...] })
1324
+ * Pass record - stores TSL pass nodes for render pipeline.
1325
+ *
1326
+ * `scenePass` is the only key the library owns. It is optional here because this is also the
1327
+ * shape of `state.passes`, which is `{}` before the pipeline exists and again after `reset()`
1328
+ * or `clearPasses()`. Inside the callbacks it is always present; see
1329
+ * {@link RenderPipelineCallbackState}.
1330
+ *
1331
+ * Every other key is user-registered, via a callback's return value. Those are TSL nodes of
1332
+ * any kind, not only passes: texture reads of an MRT attachment, effect nodes, extra
1333
+ * `pass()` instances. `Node` is the common base, so that is the bound. Narrow at the call
1334
+ * site when you need a member, e.g. `passes.velocity as TextureNode`.
1335
+ *
1336
+ * The index signature admits `undefined` because a key may simply not be registered, and
1337
+ * because the optional `scenePass` must be assignable to it: under `skipLibCheck: false` an
1338
+ * optional property whose type excludes `undefined` from the index signature is an error
1339
+ * (TS2411) for every consumer compiling these declarations.
1346
1340
  */
1347
- export function Fn<R extends Node = Node>(
1348
- jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
1349
- layout: { layout?: unknown },
1350
- ): ShaderCallable<R>
1341
+ interface PassRecord {
1342
+ scenePass?: ScenePassNode
1343
+ [key: string]: three_webgpu.Node | undefined
1344
+ }
1351
1345
 
1352
1346
  /**
1353
- * Fn with object params + layout
1347
+ * State passed to pipeline callbacks after the active pipeline has been created.
1348
+ *
1349
+ * `passes.scenePass` is required here: the hook installs the default scene pass before either
1350
+ * callback runs, so callbacks can use it without a guard or a cast.
1351
+ *
1352
+ * `renderer` is narrowed to `WebGPURenderer` and `isLegacy` to `false`: the hook throws under
1353
+ * the legacy renderer before either callback can run, so a callback never sees WebGL.
1354
1354
  */
1355
- export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
1356
- jsFunc: (inputs: T) => ShaderNodeObject<R>,
1357
- layout: { layout?: unknown },
1358
- ): ShaderCallable<R>
1359
- }
1360
-
1361
- /**
1362
- * PostProcessing Types for usePostProcessing hook (WebGPU only)
1363
- */
1364
-
1365
-
1355
+ type RenderPipelineCallbackState = RootState & {
1356
+ renderPipeline: ThreeRenderPipeline
1357
+ passes: PassRecord & { scenePass: ScenePassNode }
1358
+ renderer: three_webgpu.WebGPURenderer
1359
+ isLegacy: false
1360
+ }
1366
1361
 
1367
- declare global {
1368
- /** Pass record - stores TSL pass nodes for post-processing */
1369
- type PassRecord = Record<string, any>
1362
+ /**
1363
+ * What a callback may return to register entries into `state.passes`.
1364
+ *
1365
+ * `scenePass` is reserved. The hook owns that entry and its lifecycle: it caches the pass it
1366
+ * created, and `rebuild()` / `reset()` dispose that cached pass. A callback overwriting the
1367
+ * store entry would leave the store pointing at a node the hook never disposes, and the hook
1368
+ * disposing a pass nothing references. So returning it is a type error.
1369
+ */
1370
+ type RegisteredPasses = Record<string, three_webgpu.Node> & { scenePass?: never }
1370
1371
 
1371
1372
  /** Setup callback - runs first to configure MRT, create additional passes */
1372
- type PostProcessingSetupCallback = (state: RootState) => PassRecord | void
1373
+ type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
1373
1374
 
1374
1375
  /** Main callback - runs second to configure outputNode, create effect passes */
1375
- type PostProcessingMainCallback = (state: RootState) => PassRecord | void
1376
+ type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
1376
1377
 
1377
- /** Return type for usePostProcessing hook */
1378
- interface UsePostProcessingReturn {
1378
+ /** The imperative half of useRenderPipeline's return value, present in every state */
1379
+ interface UseRenderPipelineActions {
1379
1380
  /** Current passes from state */
1380
1381
  passes: PassRecord
1381
- /** PostProcessing instance (null if not initialized) */
1382
- postProcessing: any | null // THREE.PostProcessing
1383
1382
  /** Clear all passes from state */
1384
1383
  clearPasses: () => void
1385
- /** Reset PostProcessing entirely (clears PP + passes) */
1384
+ /** Reset RenderPipeline entirely (clears PP + passes) */
1386
1385
  reset: () => void
1387
1386
  /** Re-run setup/main callbacks with current closure values */
1388
1387
  rebuild: () => void
1389
- /** True when PostProcessing is configured and ready */
1390
- isReady: boolean
1391
- }
1392
- }
1393
-
1394
- //* useFrameNext Types ==============================
1395
-
1396
-
1397
-
1398
- //* Global Type Declarations ==============================
1399
-
1400
- declare global {
1401
- // Job --------------------------------
1402
-
1403
- /**
1404
- * Internal job representation in the scheduler
1405
- */
1406
- interface Job {
1407
- /** Unique identifier */
1408
- id: string
1409
- /** The callback to execute */
1410
- callback: FrameNextCallback
1411
- /** Phase this job belongs to */
1412
- phase: string
1413
- /** Run before these phases/job ids */
1414
- before: Set<string>
1415
- /** Run after these phases/job ids */
1416
- after: Set<string>
1417
- /** Priority within phase (higher first) */
1418
- priority: number
1419
- /** Insertion order for deterministic tie-breaking */
1420
- index: number
1421
- /** Max FPS for this job (undefined = no limit) */
1422
- fps?: number
1423
- /** Drop frames when behind (true) or catch up (false) */
1424
- drop: boolean
1425
- /** Last run timestamp (ms) */
1426
- lastRun?: number
1427
- /** Whether job is enabled */
1428
- enabled: boolean
1429
- /** Internal flag: system jobs (like default render) don't block user render takeover */
1430
- system?: boolean
1431
- }
1432
-
1433
- // Phase Graph --------------------------------
1434
-
1435
- /**
1436
- * A node in the phase graph
1437
- */
1438
- interface PhaseNode {
1439
- /** Phase name */
1440
- name: string
1441
- /** Whether this was auto-generated from a before/after constraint */
1442
- isAutoGenerated: boolean
1443
- }
1444
-
1445
- /**
1446
- * Options for creating a job from hook options
1447
- */
1448
- interface JobOptions {
1449
- id?: string
1450
- phase?: string
1451
- before?: string | string[]
1452
- after?: string | string[]
1453
- priority?: number
1454
- fps?: number
1455
- drop?: boolean
1456
- enabled?: boolean
1457
- }
1458
-
1459
- // Frame Loop State --------------------------------
1460
-
1461
- /**
1462
- * Internal frame loop state
1463
- */
1464
- interface FrameLoopState {
1465
- /** Whether the loop is running */
1466
- running: boolean
1467
- /** Current RAF handle */
1468
- rafHandle: number | null
1469
- /** Last frame timestamp in ms (null = uninitialized) */
1470
- lastTime: number | null
1471
- /** Frame counter */
1472
- frameCount: number
1473
- /** Elapsed time since first frame in ms */
1474
- elapsedTime: number
1475
- /** createdAt timestamp in ms */
1476
- createdAt: number
1477
- }
1478
-
1479
- // Root Entry --------------------------------
1480
-
1481
- /**
1482
- * Internal representation of a registered root (Canvas).
1483
- * Tracks jobs and manages rebuild state for this root.
1484
- * @internal
1485
- */
1486
- interface RootEntry {
1487
- /** Unique identifier for this root */
1488
- id: string
1489
- /** Function to get the root's current state. Returns any to support independent mode. */
1490
- getState: () => any
1491
- /** Map of job IDs to Job objects */
1492
- jobs: Map<string, Job>
1493
- /** Cached sorted job list for execution order */
1494
- sortedJobs: Job[]
1495
- /** Whether sortedJobs needs rebuilding */
1496
- needsRebuild: boolean
1497
- }
1498
-
1499
- /**
1500
- * Internal representation of a global job (deprecated API).
1501
- * Global jobs run once per frame, not per-root.
1502
- * Used by legacy addEffect/addAfterEffect APIs.
1503
- * @internal
1504
- * @deprecated Use useFrame with phases instead
1505
- */
1506
- interface GlobalJob {
1507
- /** Unique identifier for this global job */
1508
- id: string
1509
- /** Callback invoked with RAF timestamp in ms */
1510
- callback: (timestamp: number) => void
1511
- }
1512
-
1513
- // HMR Support --------------------------------
1514
-
1515
- /**
1516
- * Hot Module Replacement data structure for preserving scheduler state
1517
- * @internal
1518
- */
1519
- interface HMRData {
1520
- /** Shared data object for storing values across reloads */
1521
- data: Record<string, any>
1522
- /** Optional function to accept HMR updates */
1523
- accept?: () => void
1524
1388
  }
1525
1389
 
1526
- // Default Phases --------------------------------
1527
-
1528
1390
  /**
1529
- * Default phase names for the scheduler
1391
+ * Return type for useRenderPipeline hook, discriminated on `isReady`.
1392
+ *
1393
+ * `if (isReady)` narrows `renderPipeline` to non-null, which is what the docs already tell
1394
+ * callers to check. `passes.scenePass` deliberately stays optional in the ready branch:
1395
+ * `clearPasses()` empties the record while leaving the pipeline in place.
1530
1396
  */
1531
- type DefaultPhase = 'start' | 'input' | 'physics' | 'update' | 'render' | 'finish'
1397
+ type UseRenderPipelineReturn = UseRenderPipelineActions &
1398
+ (
1399
+ | {
1400
+ /** True when RenderPipeline is configured and ready */
1401
+ isReady: true
1402
+ /** RenderPipeline instance */
1403
+ renderPipeline: ThreeRenderPipeline
1404
+ }
1405
+ | {
1406
+ /** False until the pipeline has been created */
1407
+ isReady: false
1408
+ /** Not initialized yet, or torn down by reset() */
1409
+ renderPipeline: null
1410
+ }
1411
+ )
1532
1412
  }
1533
1413
 
1534
1414
  type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
@@ -1607,10 +1487,11 @@ type TSLNodeInput = { nodeType?: string | null; uuid?: string } | null
1607
1487
 
1608
1488
  /**
1609
1489
  * For node material properties (colorNode, positionNode, etc.), accept broader types
1610
- * since @types/three has broken inheritance for TSL node subclasses.
1490
+ * since @types/three has broken inheritance for TSL node subclasses. NodeClass requires
1491
+ * `nodeType`, so this structural key test remains neutral to the selected Three entry.
1611
1492
  */
1612
1493
  type NodeProps<P> = {
1613
- [K in keyof P as P[K] extends Node | null ? K : never]?: TSLNodeInput
1494
+ [K in keyof P as NonNullable<P[K]> extends { nodeType: string | null } ? K : never]?: TSLNodeInput
1614
1495
  }
1615
1496
 
1616
1497
  interface ReactProps<P> {
@@ -1631,11 +1512,29 @@ type ThreeToJSXElements<T extends Record<string, any>> = {
1631
1512
  [K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
1632
1513
  }
1633
1514
 
1515
+ /** Method names of Object3D, excluded from the `primitive` element's typed props. */
1516
+ type Object3DMethod = NonNullable<
1517
+ {
1518
+ [K in keyof Object3D]-?: Object3D[K] extends (...args: any[]) => any ? K : never
1519
+ }[keyof Object3D]
1520
+ >
1521
+
1634
1522
  type ThreeExports = typeof import('three/webgpu')
1635
1523
  type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
1636
1524
 
1637
1525
  interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
1638
- primitive: Omit<ThreeElement<any>, 'args'> & { object: object }
1526
+ /**
1527
+ * `primitive` wraps a pre-existing object, so its props cannot be derived from one class.
1528
+ * Events are typed from `EventHandlers` (`onClick={(e) => ...}` infers `e`), the ref is
1529
+ * untyped, and any other prop is accepted and applied to the object by name. Object3D's own
1530
+ * methods are left out of the typed surface: they return `this`, so a subclass element's
1531
+ * props (`ThreeElements['group']`) could not be spread onto a primitive otherwise.
1532
+ */
1533
+ primitive: Omit<ThreeElement<typeof Object3D>, 'args' | 'object' | 'ref' | Object3DMethod> & {
1534
+ object: object
1535
+ ref?: React.Ref<any>
1536
+ [prop: string]: unknown
1537
+ }
1639
1538
  // Conflicts with DOM types can be accessed through a three* prefix
1640
1539
  threeAudio: ThreeElementsImpl['audio']
1641
1540
  threeSource: ThreeElementsImpl['source']
@@ -1676,6 +1575,7 @@ type three_d_Matrix3 = Matrix3;
1676
1575
  type three_d_Matrix4 = Matrix4;
1677
1576
  type three_d_MutableOrReadonlyParameters<T extends (...args: any) => any> = MutableOrReadonlyParameters<T>;
1678
1577
  type three_d_NodeProps<P> = NodeProps<P>;
1578
+ type three_d_Object3DMethod = Object3DMethod;
1679
1579
  type three_d_Quaternion = Quaternion;
1680
1580
  type three_d_RaycastableRepresentation = RaycastableRepresentation;
1681
1581
  type three_d_ReactProps<P> = ReactProps<P>;
@@ -1690,7 +1590,7 @@ type three_d_Vector3 = Vector3;
1690
1590
  type three_d_Vector4 = Vector4;
1691
1591
  type three_d_VectorRepresentation = VectorRepresentation;
1692
1592
  declare namespace three_d {
1693
- 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 };
1593
+ 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 };
1694
1594
  }
1695
1595
 
1696
1596
  /**
@@ -1700,7 +1600,7 @@ declare namespace three_d {
1700
1600
  * a single WebGPURenderer using Three.js CanvasTarget API.
1701
1601
  *
1702
1602
  * Primary canvas: Has `id` prop, creates its own renderer, registers here
1703
- * Secondary canvas: Has `target="id"` prop, shares primary's renderer via CanvasTarget
1603
+ * Secondary canvas: Has `renderer={{ primaryCanvas: 'id' }}`, shares primary's renderer via CanvasTarget
1704
1604
  */
1705
1605
 
1706
1606
  interface PrimaryCanvasEntry {
@@ -1768,12 +1668,23 @@ type EnvironmentLoaderProps = {
1768
1668
  * const texture = useEnvironment({ preset: 'sunset' })
1769
1669
  * ```
1770
1670
  */
1771
- declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown> | CubeTexture;
1671
+ declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown, THREE$1.TextureEventMap> | CubeTexture<unknown>;
1772
1672
  declare namespace useEnvironment {
1773
1673
  var preload: (preloadOptions?: EnvironmentLoaderPreloadOptions) => void;
1774
1674
  var clear: (clearOptions?: EnvironmentLoaderClearOptions) => void;
1775
1675
  }
1776
- type EnvironmentLoaderPreloadOptions = Omit<EnvironmentLoaderProps, 'encoding'>;
1676
+ /**
1677
+ * Options accepted by `useEnvironment.preload`.
1678
+ *
1679
+ * `colorSpace` is deliberately omitted: preload only warms the loader cache, and colorSpace is
1680
+ * applied to the texture by `useEnvironment()` at use time, per consumer. Accepting it here would
1681
+ * advertise an option this function silently ignores.
1682
+ *
1683
+ * This previously read `Omit<…, 'encoding'>` — omitting a key that does not exist on
1684
+ * `EnvironmentLoaderProps`, a leftover from three's pre-`colorSpace` `encoding` API. That made the
1685
+ * type equivalent to the full props, so `colorSpace` was accepted and then dropped on the floor.
1686
+ */
1687
+ type EnvironmentLoaderPreloadOptions = Omit<EnvironmentLoaderProps, 'colorSpace'>;
1777
1688
  type EnvironmentLoaderClearOptions = Pick<EnvironmentLoaderProps, 'files' | 'preset'>;
1778
1689
 
1779
1690
  /**
@@ -1817,9 +1728,9 @@ type EnvironmentProps = {
1817
1728
  blur?: number;
1818
1729
  backgroundBlurriness?: number;
1819
1730
  backgroundIntensity?: number;
1820
- backgroundRotation?: Euler$3;
1731
+ backgroundRotation?: Euler;
1821
1732
  environmentIntensity?: number;
1822
- environmentRotation?: Euler$3;
1733
+ environmentRotation?: Euler;
1823
1734
  map?: Texture$1;
1824
1735
  preset?: PresetsType;
1825
1736
  scene?: Scene | React$1.RefObject<Scene>;
@@ -1903,7 +1814,7 @@ declare function EnvironmentCube({ background, scene, blur, backgroundBlurriness
1903
1814
  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;
1904
1815
  declare module '@react-three/fiber' {
1905
1816
  interface ThreeElements {
1906
- groundProjectedEnvImpl: ThreeElement$1<typeof GroundedSkybox>;
1817
+ groundProjectedEnvImpl: ThreeElement<typeof GroundedSkybox>;
1907
1818
  }
1908
1819
  }
1909
1820
  /**
@@ -2003,12 +1914,68 @@ declare module '@react-three/fiber' {
2003
1914
  */
2004
1915
  declare function Environment(props: EnvironmentProps): react_jsx_runtime.JSX.Element;
2005
1916
 
1917
+ /**
1918
+ * Moves every trace of interactivity from one object to its replacement, for reconstruction.
1919
+ *
1920
+ * When `args` or a `primitive`'s `object` changes, R3F builds a new three object and keeps the same
1921
+ * instance. Removing the old object from the interaction state and registering the new one from
1922
+ * scratch makes events *work* again (#3778), but it forgets what was in flight: a pointer resting on
1923
+ * the object fires a second `onPointerEnter` without ever having left, and an active pointer capture
1924
+ * is dropped mid-drag. Rewriting the references instead keeps the interaction continuous across a
1925
+ * swap the user never asked to see (#3744).
1926
+ *
1927
+ * Captures are re-keyed rather than released, so the DOM-level capture on `captureData.target` is
1928
+ * left alone — releasing and re-acquiring it is precisely the glitch being avoided.
1929
+ *
1930
+ * Visibility handlers are deliberately not transferred: that registry is keyed by `object.uuid`, so
1931
+ * the replacement re-registers itself through `applyProps`. The old entry is dropped here so it
1932
+ * cannot outlive the object it described.
1933
+ */
1934
+ declare function swapInteractivity(store: RootStore, object: Object3D, newObject: Object3D): void;
2006
1935
  declare function removeInteractivity(store: RootStore, object: Object3D): void;
2007
1936
  declare function createEvents(store: RootStore): {
2008
1937
  handlePointer: (name: string) => (event: DomEvent) => void;
1938
+ flushDeferredPointers: () => void;
1939
+ processDeferredPointer: (event: DomEvent, pointerId: number) => void;
2009
1940
  };
2010
1941
  /** Default R3F event manager for web */
2011
- declare function createPointerEvents(store: RootStore): EventManager<HTMLElement>;
1942
+ declare function createPointerEvents(store: RootStore): EventManager<Element>;
1943
+
1944
+ interface RootExtension {
1945
+ /** Unique name. Registering the same name again replaces the entry (HMR-safe); roots it already
1946
+ * set up are not set up a second time, but get the new entry's dispose and hmr. */
1947
+ name: string;
1948
+ /**
1949
+ * Called once per root, after its renderer exists and before `onCreated` and the first frame.
1950
+ * `isLegacy` and `primaryStore` are known by then, so an extension can skip WebGL roots or defer
1951
+ * to the primary canvas. Return fields to merge into the root's state, or nothing.
1952
+ */
1953
+ setup?(store: RootStore): Partial<RootState> | void;
1954
+ /** Called when a root this extension set up unmounts. */
1955
+ dispose?(store: RootStore): void;
1956
+ /** Called when `<Canvas>` detects hot module replacement (skipped with `hmr={false}`). */
1957
+ hmr?(store: RootStore): void;
1958
+ }
1959
+ /**
1960
+ * Register an extension. It is set up on every live root immediately, and on every root created
1961
+ * afterwards. Returns a function that unregisters it: new roots are no longer set up, while roots
1962
+ * it already set up keep its state and still get its dispose when they unmount.
1963
+ */
1964
+ declare function registerRootExtension(extension: RootExtension): () => void;
1965
+ /**
1966
+ * Point a root's default render job at a different render function, or back at
1967
+ * `renderer.render(scene, camera)` with `null`.
1968
+ *
1969
+ * The default job keeps everything else: the Canvas `fps` throttle, error propagation to the error
1970
+ * boundary, and backing off when a user `useFrame(..., { phase: 'render' })` job takes over.
1971
+ */
1972
+ declare function setRenderOverride(store: RootStore, render: (() => void) | null): void;
1973
+
1974
+ /**
1975
+ * Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
1976
+ * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
1977
+ */
1978
+ declare function useStore(): RootStore;
2012
1979
 
2013
1980
  /**
2014
1981
  * Gets or creates a memoized loader instance from a loader constructor or returns the loader if it's already an instance.
@@ -2021,419 +1988,13 @@ declare function getLoader<L extends LoaderLike | ConstructorRepresentation<Load
2021
1988
  * Note: this hook's caller must be wrapped with `React.Suspense`
2022
1989
  * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useloader
2023
1990
  */
2024
- 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>;
1991
+ 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>;
2025
1992
  declare namespace useLoader {
2026
- var preload: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void) => void;
2027
- var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I) => void;
1993
+ 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;
1994
+ var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, cacheKey?: InputLike) => void;
2028
1995
  var loader: typeof getLoader;
2029
1996
  }
2030
1997
 
2031
- /**
2032
- * Global Singleton Scheduler - manages the frame loop and job execution for ALL R3F roots.
2033
- *
2034
- * Features:
2035
- * - Single RAF loop for entire application
2036
- * - Root registration (multiple Canvas support)
2037
- * - Global phases for addEffect/addAfterEffect (deprecated)
2038
- * - Per-root job management with phases, priorities, FPS throttling
2039
- * - onIdle callbacks for addTail (deprecated)
2040
- * - Demand mode support via invalidate()
2041
- */
2042
- declare class Scheduler {
2043
- private static readonly INSTANCE_KEY;
2044
- private static get instance();
2045
- private static set instance(value);
2046
- /**
2047
- * Get the global scheduler instance (creates if doesn't exist).
2048
- * Uses HMR data to preserve instance across hot reloads.
2049
- * @returns {Scheduler} The singleton scheduler instance
2050
- */
2051
- static get(): Scheduler;
2052
- /**
2053
- * Reset the singleton instance. Stops the loop and clears all state.
2054
- * Primarily used for testing to ensure clean state between tests.
2055
- * @returns {void}
2056
- */
2057
- static reset(): void;
2058
- private roots;
2059
- private phaseGraph;
2060
- private loopState;
2061
- private stoppedTime;
2062
- private nextRootIndex;
2063
- private globalBeforeJobs;
2064
- private globalAfterJobs;
2065
- private nextGlobalIndex;
2066
- private idleCallbacks;
2067
- private nextJobIndex;
2068
- private jobStateListeners;
2069
- private pendingFrames;
2070
- private _frameloop;
2071
- private _independent;
2072
- private errorHandler;
2073
- private rootReadyCallbacks;
2074
- get phases(): string[];
2075
- get frameloop(): Frameloop;
2076
- set frameloop(mode: Frameloop);
2077
- get isRunning(): boolean;
2078
- get isReady(): boolean;
2079
- get independent(): boolean;
2080
- set independent(value: boolean);
2081
- constructor();
2082
- /**
2083
- * Register a root (Canvas) with the scheduler.
2084
- * The first root to register starts the RAF loop (if frameloop='always').
2085
- * @param {string} id - Unique identifier for this root
2086
- * @param {RootOptions} [options] - Optional configuration with getState and onError callbacks
2087
- * @returns {() => void} Unsubscribe function to remove this root
2088
- */
2089
- registerRoot(id: string, options?: RootOptions): () => void;
2090
- /**
2091
- * Unregister a root from the scheduler.
2092
- * Cleans up all job state listeners for this root's jobs.
2093
- * The last root to unregister stops the RAF loop.
2094
- * @param {string} id - The root ID to unregister
2095
- * @returns {void}
2096
- */
2097
- unregisterRoot(id: string): void;
2098
- /**
2099
- * Subscribe to be notified when a root becomes available.
2100
- * Fires immediately if a root already exists.
2101
- * @param {() => void} callback - Function called when first root registers
2102
- * @returns {() => void} Unsubscribe function
2103
- */
2104
- onRootReady(callback: () => void): () => void;
2105
- /**
2106
- * Notify all registered root-ready callbacks.
2107
- * Called when the first root registers.
2108
- * @returns {void}
2109
- * @private
2110
- */
2111
- private notifyRootReady;
2112
- /**
2113
- * Ensure a default root exists for independent mode.
2114
- * Creates a minimal root with no state provider.
2115
- * @returns {void}
2116
- * @private
2117
- */
2118
- private ensureDefaultRoot;
2119
- /**
2120
- * Trigger error handling for job errors.
2121
- * Uses the bound error handler if available, otherwise logs to console.
2122
- * @param {Error} error - The error to handle
2123
- * @returns {void}
2124
- */
2125
- triggerError(error: Error): void;
2126
- /**
2127
- * Add a named phase to the scheduler's execution order.
2128
- * Marks all roots for rebuild to incorporate the new phase.
2129
- * @param {string} name - The phase name (e.g., 'physics', 'postprocess')
2130
- * @param {AddPhaseOptions} [options] - Positioning options (before/after other phases)
2131
- * @returns {void}
2132
- * @example
2133
- * scheduler.addPhase('physics', { before: 'update' });
2134
- * scheduler.addPhase('postprocess', { after: 'render' });
2135
- */
2136
- addPhase(name: string, options?: AddPhaseOptions): void;
2137
- /**
2138
- * Check if a phase exists in the scheduler.
2139
- * @param {string} name - The phase name to check
2140
- * @returns {boolean} True if the phase exists
2141
- */
2142
- hasPhase(name: string): boolean;
2143
- /**
2144
- * Register a global job that runs once per frame (not per-root).
2145
- * Used internally by deprecated addEffect/addAfterEffect APIs.
2146
- * @param {'before' | 'after'} phase - When to run: 'before' all roots or 'after' all roots
2147
- * @param {string} id - Unique identifier for this global job
2148
- * @param {(timestamp: number) => void} callback - Function called each frame with RAF timestamp
2149
- * @returns {() => void} Unsubscribe function to remove this global job
2150
- * @deprecated Use useFrame with phases instead
2151
- */
2152
- registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void;
2153
- /**
2154
- * Register an idle callback that fires when the loop stops.
2155
- * Used internally by deprecated addTail API.
2156
- * @param {(timestamp: number) => void} callback - Function called when loop becomes idle
2157
- * @returns {() => void} Unsubscribe function to remove this idle callback
2158
- * @deprecated Use demand mode with invalidate() instead
2159
- */
2160
- onIdle(callback: (timestamp: number) => void): () => void;
2161
- /**
2162
- * Notify all registered idle callbacks.
2163
- * Called when the loop stops in demand mode.
2164
- * @param {number} timestamp - The RAF timestamp when idle occurred
2165
- * @returns {void}
2166
- * @private
2167
- */
2168
- private notifyIdle;
2169
- /**
2170
- * Register a job (frame callback) with a specific root.
2171
- * This is the core registration method used by useFrame internally.
2172
- * @param {FrameNextCallback} callback - The function to call each frame
2173
- * @param {JobOptions & { rootId?: string; system?: boolean }} [options] - Job configuration
2174
- * @param {string} [options.rootId] - Target root ID (defaults to first registered root)
2175
- * @param {string} [options.id] - Unique job ID (auto-generated if not provided)
2176
- * @param {string} [options.phase] - Execution phase (defaults to 'update')
2177
- * @param {number} [options.priority] - Priority within phase (higher = earlier, default 0)
2178
- * @param {number} [options.fps] - FPS throttle limit
2179
- * @param {boolean} [options.drop] - Drop frames when behind (default true)
2180
- * @param {boolean} [options.enabled] - Whether job is active (default true)
2181
- * @param {boolean} [options.system] - Internal flag for system jobs (not user-facing)
2182
- * @returns {() => void} Unsubscribe function to remove this job
2183
- */
2184
- register(callback: FrameNextCallback, options?: JobOptions & {
2185
- rootId?: string;
2186
- system?: boolean;
2187
- }): () => void;
2188
- /**
2189
- * Unregister a job by its ID.
2190
- * Searches all roots if rootId is not provided.
2191
- * @param {string} id - The job ID to unregister
2192
- * @param {string} [rootId] - Optional root ID to search (searches all if not provided)
2193
- * @returns {void}
2194
- */
2195
- unregister(id: string, rootId?: string): void;
2196
- /**
2197
- * Update a job's options dynamically.
2198
- * Searches all roots to find the job by ID.
2199
- * Phase/constraint changes trigger a rebuild of the sorted job list.
2200
- * @param {string} id - The job ID to update
2201
- * @param {Partial<JobOptions>} options - The options to update
2202
- * @returns {void}
2203
- */
2204
- updateJob(id: string, options: Partial<JobOptions>): void;
2205
- /**
2206
- * Check if a job is currently paused (disabled).
2207
- * @param {string} id - The job ID to check
2208
- * @returns {boolean} True if the job exists and is paused
2209
- */
2210
- isJobPaused(id: string): boolean;
2211
- /**
2212
- * Subscribe to state changes for a specific job.
2213
- * Listener is called when job is paused or resumed.
2214
- * @param {string} id - The job ID to subscribe to
2215
- * @param {() => void} listener - Callback invoked on state changes
2216
- * @returns {() => void} Unsubscribe function
2217
- */
2218
- subscribeJobState(id: string, listener: () => void): () => void;
2219
- /**
2220
- * Notify all listeners that a job's state has changed.
2221
- * @param {string} id - The job ID that changed
2222
- * @returns {void}
2223
- * @private
2224
- */
2225
- private notifyJobStateChange;
2226
- /**
2227
- * Pause a job by ID (sets enabled=false).
2228
- * Notifies any subscribed state listeners.
2229
- * @param {string} id - The job ID to pause
2230
- * @returns {void}
2231
- */
2232
- pauseJob(id: string): void;
2233
- /**
2234
- * Resume a paused job by ID (sets enabled=true).
2235
- * Resets job timing to prevent frame accumulation.
2236
- * Notifies any subscribed state listeners.
2237
- * @param {string} id - The job ID to resume
2238
- * @returns {void}
2239
- */
2240
- resumeJob(id: string): void;
2241
- /**
2242
- * Start the requestAnimationFrame loop.
2243
- * Resets timing state (elapsedTime, frameCount) on start.
2244
- * No-op if already running.
2245
- * @returns {void}
2246
- */
2247
- start(): void;
2248
- /**
2249
- * Stop the requestAnimationFrame loop.
2250
- * Cancels any pending RAF callback.
2251
- * No-op if not running.
2252
- * @returns {void}
2253
- */
2254
- stop(): void;
2255
- /**
2256
- * Request frames to be rendered in demand mode.
2257
- * Accumulates pending frames (capped at 60) and starts the loop if not running.
2258
- * No-op if frameloop is not 'demand'.
2259
- * @param {number} [frames=1] - Number of frames to request
2260
- * @param {boolean} [stackFrames=false] - Whether to add frames to existing pending count
2261
- * - `false` (default): Sets pending frames to the specified value (replaces existing count)
2262
- * - `true`: Adds frames to existing pending count (useful for accumulating invalidations)
2263
- * @returns {void}
2264
- * @example
2265
- * // Request a single frame render
2266
- * scheduler.invalidate();
2267
- *
2268
- * @example
2269
- * // Request 5 frames (e.g., for animations)
2270
- * scheduler.invalidate(5);
2271
- *
2272
- * @example
2273
- * // Set pending frames to exactly 3 (don't stack with existing)
2274
- * scheduler.invalidate(3, false);
2275
- *
2276
- * @example
2277
- * // Add 2 more frames to existing pending count
2278
- * scheduler.invalidate(2, true);
2279
- */
2280
- invalidate(frames?: number, stackFrames?: boolean): void;
2281
- /**
2282
- * Reset timing state for deterministic testing.
2283
- * Preserves jobs and roots but resets lastTime, frameCount, elapsedTime, etc.
2284
- * @returns {void}
2285
- */
2286
- resetTiming(): void;
2287
- /**
2288
- * Manually execute a single frame for all roots.
2289
- * Useful for frameloop='never' mode or testing scenarios.
2290
- * @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
2291
- * @returns {void}
2292
- * @example
2293
- * // Manual control mode
2294
- * scheduler.frameloop = 'never';
2295
- * scheduler.step(); // Execute one frame
2296
- */
2297
- step(timestamp?: number): void;
2298
- /**
2299
- * Manually execute a single job by its ID.
2300
- * Useful for testing individual job callbacks in isolation.
2301
- * @param {string} id - The job ID to step
2302
- * @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
2303
- * @returns {void}
2304
- */
2305
- stepJob(id: string, timestamp?: number): void;
2306
- /**
2307
- * Main RAF loop callback.
2308
- * Executes frame, handles demand mode, and schedules next frame.
2309
- * @param {number} timestamp - RAF timestamp in milliseconds
2310
- * @returns {void}
2311
- * @private
2312
- */
2313
- private loop;
2314
- /**
2315
- * Execute a single frame across all roots.
2316
- * Order: globalBefore → each root's jobs → globalAfter
2317
- * @param {number} timestamp - RAF timestamp in milliseconds
2318
- * @returns {void}
2319
- * @private
2320
- */
2321
- private executeFrame;
2322
- /**
2323
- * Run all global jobs from a job map.
2324
- * Catches and logs errors without stopping execution.
2325
- * @param {Map<string, GlobalJob>} jobs - The global jobs map to execute
2326
- * @param {number} timestamp - RAF timestamp in milliseconds
2327
- * @returns {void}
2328
- * @private
2329
- */
2330
- private runGlobalJobs;
2331
- /**
2332
- * Execute all jobs for a single root in sorted order.
2333
- * Rebuilds sorted job list if needed, then dispatches each job.
2334
- * Errors are caught and propagated via triggerError.
2335
- * @param {RootEntry} root - The root entry to tick
2336
- * @param {number} timestamp - RAF timestamp in milliseconds
2337
- * @param {number} delta - Time since last frame in seconds
2338
- * @returns {void}
2339
- * @private
2340
- */
2341
- private tickRoot;
2342
- /**
2343
- * Get the total number of registered jobs across all roots.
2344
- * Includes both per-root jobs and global before/after jobs.
2345
- * @returns {number} Total job count
2346
- */
2347
- getJobCount(): number;
2348
- /**
2349
- * Get all registered job IDs across all roots.
2350
- * Includes both per-root jobs and global before/after jobs.
2351
- * @returns {string[]} Array of all job IDs
2352
- */
2353
- getJobIds(): string[];
2354
- /**
2355
- * Get the number of registered roots (Canvas instances).
2356
- * @returns {number} Number of registered roots
2357
- */
2358
- getRootCount(): number;
2359
- /**
2360
- * Check if any user (non-system) jobs are registered in a specific phase.
2361
- * Used by the default render job to know if a user has taken over rendering.
2362
- *
2363
- * @param phase The phase to check
2364
- * @param rootId Optional root ID to check (checks all roots if not provided)
2365
- * @returns true if any user jobs exist in the phase
2366
- */
2367
- hasUserJobsInPhase(phase: string, rootId?: string): boolean;
2368
- /**
2369
- * Generate a unique root ID for automatic root registration.
2370
- * @returns {string} A unique root ID in the format 'root_N'
2371
- */
2372
- generateRootId(): string;
2373
- /**
2374
- * Generate a unique job ID.
2375
- * @returns {string} A unique job ID in the format 'job_N'
2376
- * @private
2377
- */
2378
- private generateJobId;
2379
- /**
2380
- * Normalize before/after constraints to a Set.
2381
- * Handles undefined, single string, or array inputs.
2382
- * @param {string | string[] | undefined} value - The constraint value(s)
2383
- * @returns {Set<string>} Normalized Set of constraint strings
2384
- * @private
2385
- */
2386
- private normalizeConstraints;
2387
- }
2388
- /**
2389
- * Get the global scheduler instance.
2390
- * Creates one if it doesn't exist.
2391
- */
2392
- declare const getScheduler: () => Scheduler;
2393
-
2394
- /**
2395
- * Frame hook with phase-based ordering, priority, and FPS throttling.
2396
- *
2397
- * Works both inside and outside Canvas context:
2398
- * - Inside Canvas: Full RootState (gl, scene, camera, etc.)
2399
- * - Outside Canvas (waiting mode): Waits for Canvas to mount, then gets full state
2400
- * - Outside Canvas (independent mode): Fires immediately with timing-only state
2401
- *
2402
- * Returns a controls object for manual stepping, pausing, and resuming.
2403
- *
2404
- * @param callback - Function called each frame with (state, delta). Optional if you only need scheduler access.
2405
- * @param priorityOrOptions - Either a priority number (backwards compat) or options object
2406
- * @returns Controls object with step(), stepAll(), pause(), resume(), isPaused, id, scheduler
2407
- *
2408
- * @example
2409
- * // Simple priority (backwards compat)
2410
- * useFrame((state, delta) => { ... }, 5)
2411
- *
2412
- * @example
2413
- * // With phase-based ordering
2414
- * useFrame((state, delta) => { ... }, { phase: 'physics' })
2415
- *
2416
- * @example
2417
- * // Outside Canvas - waits for Canvas to mount
2418
- * function UI() {
2419
- * useFrame((state, delta) => { syncUI(state.camera) });
2420
- * return <button>...</button>;
2421
- * }
2422
- *
2423
- * @example
2424
- * // Independent mode - no Canvas needed
2425
- * getScheduler().independent = true;
2426
- * useFrame((state, delta) => { updateGame(delta) });
2427
- *
2428
- * @example
2429
- * // Scheduler-only access (no callback)
2430
- * const { scheduler } = useFrame()
2431
- * scheduler.pauseJob('some-job-id')
2432
- *
2433
- * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useframe
2434
- */
2435
- declare function useFrame(callback?: FrameNextCallback, priorityOrOptions?: number | UseFrameNextOptions): FrameNextControls;
2436
-
2437
1998
  declare const IsObject: (url: unknown) => url is Record<string, string>;
2438
1999
  type TextureArray<T> = T extends string[] ? Texture$1[] : never;
2439
2000
  type TextureRecord<T> = T extends Record<string, string> ? {
@@ -2446,11 +2007,16 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
2446
2007
  /** Callback when texture(s) finish loading */
2447
2008
  onLoad?: (texture: MappedTextureType<Url>) => void;
2448
2009
  /**
2449
- * Cache the texture in R3F's global state for access via useTextures().
2450
- * When true:
2010
+ * Register the texture(s) in R3F's global texture registry for access via useTextures().
2011
+ * When true (the default):
2451
2012
  * - Textures persist until explicitly disposed
2452
- * - Returns existing cached textures if available (preserving modifications like colorSpace)
2453
- * @default false
2013
+ * - On mount, returns existing registered textures if available (preserving modifications like colorSpace)
2014
+ *
2015
+ * Reads are taken once at mount — a mounted `useTexture` does not re-render when the registry
2016
+ * changes. To react to registry swaps, use `useTextures(s => s.get(key))` instead.
2017
+ *
2018
+ * Pass `false` to opt out of registry enrollment entirely.
2019
+ * @default true
2454
2020
  */
2455
2021
  cache?: boolean;
2456
2022
  };
@@ -2474,15 +2040,18 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
2474
2040
  * normal: '/normal.png'
2475
2041
  * })
2476
2042
  *
2477
- * // With caching - returns same texture object across components
2478
- * // Modifications (colorSpace, wrapS, etc.) are preserved
2479
- * const diffuse = useTexture('/diffuse.png', { cache: true })
2043
+ * // Textures are registered in the global registry by default — the same texture
2044
+ * // object is shared across components and modifications (colorSpace, wrapS, etc.) are preserved
2045
+ * const diffuse = useTexture('/diffuse.png')
2480
2046
  * diffuse.colorSpace = THREE.SRGBColorSpace
2481
2047
  *
2482
2048
  * // Another component gets the SAME texture with colorSpace already set
2483
- * const sameDiffuse = useTexture('/diffuse.png', { cache: true })
2049
+ * const sameDiffuse = useTexture('/diffuse.png')
2050
+ *
2051
+ * // Opt out of registry enrollment for a one-off texture
2052
+ * const scratch = useTexture('/scratch.png', { cache: false })
2484
2053
  *
2485
- * // Access cache directly
2054
+ * // Access the registry directly
2486
2055
  * const { get } = useTextures()
2487
2056
  * const cached = get('/diffuse.png')
2488
2057
  * ```
@@ -2499,63 +2068,80 @@ declare const Texture: ({ children, input, onLoad, cache, }: {
2499
2068
  cache?: boolean;
2500
2069
  }) => react_jsx_runtime.JSX.Element;
2501
2070
 
2502
- type TextureEntry = Texture$1 | {
2503
- value: Texture$1;
2504
- [key: string]: any;
2071
+ /** Accepted shapes for a registry read: a single key, a list of keys, or a name→key map. */
2072
+ type TextureInput = string | string[] | Record<string, string>;
2073
+ /** Result of a `get()` read, mirroring the input shape. */
2074
+ type TextureResult<Input extends TextureInput> = Input extends string ? Texture$1 | undefined : Input extends string[] ? (Texture$1 | undefined)[] : {
2075
+ [K in keyof Input]: Texture$1 | undefined;
2505
2076
  };
2077
+ /** Options for `dispose()`. */
2078
+ interface DisposeOptions {
2079
+ /** Dispose even if the texture still has active references (default false). */
2080
+ force?: boolean;
2081
+ }
2506
2082
  interface UseTexturesReturn {
2507
- /** Map of all textures currently in cache */
2508
- textures: Map<string, TextureEntry>;
2509
- /** Get a specific texture by key (usually URL) */
2510
- get: (key: string) => TextureEntry | undefined;
2511
- /** Check if a texture exists in cache */
2512
- has: (key: string) => boolean;
2513
- /** Add a texture to the cache */
2514
- add: (key: string, value: TextureEntry) => void;
2515
- /** Add multiple textures to the cache */
2516
- addMultiple: (items: Map<string, TextureEntry> | Record<string, TextureEntry>) => void;
2517
- /** Remove a texture from cache (does NOT dispose GPU resources) */
2518
- remove: (key: string) => void;
2519
- /** Remove multiple textures from cache */
2520
- removeMultiple: (keys: string[]) => void;
2521
- /** Dispose a texture's GPU resources and remove from cache */
2522
- dispose: (key: string) => void;
2523
- /** Dispose multiple textures */
2524
- disposeMultiple: (keys: string[]) => void;
2525
- /** Dispose ALL cached textures - use with caution */
2526
- disposeAll: () => void;
2083
+ /** The live registry Map (key → Texture). Treat as read-only. */
2084
+ readonly all: Map<string, Texture$1>;
2085
+ /** Read one texture, an array of textures, or a name→texture record (mirrors the input shape). */
2086
+ get<Input extends TextureInput>(input: Input): TextureResult<Input>;
2087
+ /** Check whether a key exists in the registry. */
2088
+ has(key: string): boolean;
2089
+ /**
2090
+ * Register a texture (or a record of textures) that has no URL — e.g. a render
2091
+ * target or procedural texture. URL-loaded textures are registered automatically
2092
+ * by `useTexture` (registry enrollment is on by default).
2093
+ */
2094
+ add(key: string, texture: Texture$1): void;
2095
+ add(record: Record<string, Texture$1>): void;
2096
+ /**
2097
+ * Dispose a texture's GPU resources and remove it from the registry.
2098
+ * Refcount-aware: if the key is still in use by a mounted `useTexture` consumer it is
2099
+ * skipped (with a warning) unless `{ force: true }` is passed.
2100
+ * @returns true if disposed, false if skipped.
2101
+ */
2102
+ dispose(key: string, options?: DisposeOptions): boolean;
2103
+ /** Dispose every texture in the registry and clear it. Use on scene teardown. */
2104
+ disposeAll(): void;
2527
2105
  }
2528
2106
  /**
2529
- * Hook for managing the global texture cache in R3F state.
2107
+ * Reactive Texture registry — load once with `useTexture`, reach the textures from anywhere.
2108
+ *
2109
+ * This is a registry of plain `Texture` objects (not TSL nodes), so the same texture can feed
2110
+ * a material map, a heightmap sampler, or anything else. It does **not** load — pair it with
2111
+ * `useTexture` for loading (registry enrollment is on by default); `useTextures` is for access and lifecycle.
2530
2112
  *
2531
- * Textures are stored in a Map with URL/path keys for efficient lookup.
2532
- * Useful for sharing texture references across materials and components.
2113
+ * The returned handle is **reactive**: the calling component re-renders when the registry
2114
+ * changes. Pass a selector to scope the subscription to a single read.
2533
2115
  *
2534
2116
  * @example
2535
2117
  * ```tsx
2536
- * const { textures, add, get, remove, has, dispose } = useTextures()
2118
+ * // Load + register once (anywhere in the tree) — registered by default
2119
+ * useTexture({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
2537
2120
  *
2538
- * // Check if texture is already cached
2539
- * if (!has('/textures/diffuse.png')) {
2540
- * // Load with useTexture and cache: true, or manually add
2541
- * const tex = useTexture('/textures/diffuse.png', { cache: true })
2542
- * }
2543
- *
2544
- * // Access cached texture from anywhere
2545
- * const diffuse = get('/textures/diffuse.png')
2546
- * if (diffuse) material.map = diffuse
2121
+ * // Reach them from another component — record form lands straight into a material
2122
+ * const { map, normalMap } = useTextures().get({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
2123
+ * return <meshStandardMaterial map={map} normalMap={normalMap} />
2547
2124
  *
2548
- * // Remove from cache only (texture still in GPU memory)
2549
- * remove('/textures/old.png')
2125
+ * // A set of heightmaps at once
2126
+ * const [a, b, c] = useTextures().get(['/h0.png', '/h1.png', '/h2.png'])
2550
2127
  *
2551
- * // Fully dispose (frees GPU memory + removes from cache)
2552
- * dispose('/textures/unused.png')
2128
+ * // Register a non-URL texture (render target / procedural)
2129
+ * useTextures().add('rt-main', renderTarget.texture)
2553
2130
  *
2554
- * // Nuclear option - dispose everything
2555
- * disposeAll()
2131
+ * // Deliberate GPU cleanup (refcount-aware; force to override)
2132
+ * useTextures().dispose('/diffuse.jpg')
2133
+ * useTextures().disposeAll() // scene teardown
2556
2134
  * ```
2135
+ *
2136
+ * @remarks
2137
+ * **Future expansion:** an imperative async loader (e.g. `await useTextures().load('/x.jpg')`) is
2138
+ * intentionally not included yet. It would let non-React code (loading screens, dynamic streaming)
2139
+ * populate the registry without Suspense, at the cost of putting loading back into this hook. It
2140
+ * will be added only if a concrete consumer needs imperative loading; for now, loading lives in
2141
+ * `useTexture`.
2557
2142
  */
2558
2143
  declare function useTextures(): UseTexturesReturn;
2144
+ declare function useTextures<T>(selector: (registry: UseTexturesReturn) => T): T;
2559
2145
 
2560
2146
  /**
2561
2147
  * Creates a render target compatible with the current renderer.
@@ -2585,20 +2171,10 @@ declare function useTextures(): UseTexturesReturn;
2585
2171
  * const fbo = useRenderTarget(512, 256, { samples: 4 })
2586
2172
  * ```
2587
2173
  */
2588
- declare function useRenderTarget(options?: RenderTargetOptions): RenderTarget | WebGLRenderTarget;
2589
- declare function useRenderTarget(size: number, options?: RenderTargetOptions): RenderTarget | WebGLRenderTarget;
2590
- declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): RenderTarget | WebGLRenderTarget;
2174
+ declare function useRenderTarget(options?: RenderTargetOptions): RenderTarget;
2175
+ declare function useRenderTarget(size: number, options?: RenderTargetOptions): RenderTarget;
2176
+ declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): RenderTarget;
2591
2177
 
2592
- /**
2593
- * Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
2594
- * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
2595
- */
2596
- declare function useStore(): RootStore;
2597
- /**
2598
- * Accesses R3F's internal state, containing renderer, canvas, scene, etc.
2599
- * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usethree
2600
- */
2601
- declare function useThree<T = RootState>(selector?: (state: RootState) => T, equalityFn?: <T>(state: T, newState: T) => boolean): T;
2602
2178
  /**
2603
2179
  * Exposes an object's {@link Instance}.
2604
2180
  * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#useInstanceHandle
@@ -2674,7 +2250,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
2674
2250
  * Invalidates the view, requesting a frame to be rendered.
2675
2251
  * In demand mode, this triggers the scheduler to run frames.
2676
2252
  *
2677
- * @param state - Optional root state (ignored in new scheduler, kept for backwards compat)
2253
+ * With a state argument, only that root's jobs run on the requested frames; other
2254
+ * roots on 'demand' stay idle. Without one, every registered root is invalidated.
2255
+ *
2256
+ * @param state - Optional root state; targets the invalidation at that root
2678
2257
  * @param frames - Number of frames to request (default: 1)
2679
2258
  * @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
2680
2259
  *
@@ -2685,14 +2264,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
2685
2264
  * Advances the frameloop and runs render effects.
2686
2265
  * Useful for when manually rendering via `frameloop="never"`.
2687
2266
  *
2267
+ * With a state argument, only that root is stepped. Without one, every
2268
+ * registered root is stepped for backwards compatibility.
2269
+ *
2688
2270
  * @param timestamp - The timestamp to use for this frame
2689
2271
  * @param runGlobalEffects - Ignored (kept for backwards compat, global effects always run)
2690
- * @param state - Ignored (kept for backwards compat)
2691
- * @param frame - Ignored (kept for backwards compat)
2272
+ * @param state - Optional root state; targets the manual step at that root
2692
2273
  *
2693
2274
  * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
2694
2275
  */
2695
- declare function advance(timestamp: number): void;
2276
+ declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
2696
2277
 
2697
2278
  /* eslint-disable @definitelytyped/no-unnecessary-generics */
2698
2279
  declare function ReactReconciler<
@@ -3737,6 +3318,7 @@ declare namespace ReactReconciler {
3737
3318
 
3738
3319
  declare function extend<T extends ConstructorRepresentation>(objects: T): React$1.ExoticComponent<ThreeElement<T>>;
3739
3320
  declare function extend<T extends Catalogue>(objects: T): void;
3321
+ declare function extend(objects: Record<string, unknown>): void;
3740
3322
  declare const reconciler: ReactReconciler.Reconciler<RootStore, Instance<any>, void, Instance<any>, never, any>;
3741
3323
 
3742
3324
  declare const isRenderer: (def: any) => boolean;
@@ -3761,13 +3343,9 @@ declare function Portal({ children, container, state }: PortalProps): JSX.Elemen
3761
3343
  declare function flushSync<R>(fn: () => R): R;
3762
3344
 
3763
3345
  declare const context: React$1.Context<RootStore>;
3346
+
3764
3347
  declare const createStore: (invalidate: (state?: RootState, frames?: number, stackFrames?: boolean) => void, advance: (timestamp: number, runGlobalEffects?: boolean, state?: RootState, frame?: XRFrame) => void) => RootStore;
3765
3348
 
3766
- /**
3767
- * Safely flush async effects when testing, simulating a legacy root.
3768
- * @deprecated Import from React instead. import { act } from 'react'
3769
- */
3770
- declare const act: typeof React$1.act;
3771
3349
  /**
3772
3350
  * An SSR-friendly useLayoutEffect.
3773
3351
  *
@@ -4019,7 +3597,7 @@ declare function getInstanceProps<T = any>(pendingProps: Record<string, unknown>
4019
3597
  declare function prepare<T = any>(target: T, root: RootStore, type: string, props: Instance<T>['props']): Instance<T>;
4020
3598
  /**
4021
3599
  * Triggers an update for an instance.
4022
- * Calls onUpdate callback and invalidates the frame if necessary.
3600
+ * Invalidates the frame if the root is in demand mode.
4023
3601
  *
4024
3602
  * @param instance - Instance to invalidate
4025
3603
  */
@@ -4185,29 +3763,44 @@ declare const hasConstructor: (object: unknown) => object is {
4185
3763
  * Used to identify values that should be resolved from refs after mount.
4186
3764
  */
4187
3765
  declare const FROM_REF: unique symbol;
3766
+ /** The marker `fromRef()` returns; resolved by the reconciler in `commitMount`. */
3767
+ interface FromRefMarker<T = unknown, R = T> {
3768
+ [FROM_REF]: React$1.RefObject<T | null>;
3769
+ /** Optional transform applied to the resolved ref before assignment. */
3770
+ transform?: (value: T) => R;
3771
+ }
4188
3772
  /**
4189
3773
  * Defers prop application until the referenced object is available.
4190
3774
  * Useful for props like `target` that need sibling refs to be populated.
4191
3775
  *
3776
+ * Only top-level props on a three element are resolved: a marker nested inside another value
3777
+ * (an array, an options object) is never seen. When the prop needs the sibling *wrapped* rather
3778
+ * than assigned as-is, pass a `transform`; it runs once the ref is populated and its result is
3779
+ * what gets assigned.
3780
+ *
4192
3781
  * @param ref - React ref object to resolve at mount time
4193
- * @returns A marker value that applyProps will resolve after mount
3782
+ * @param transform - Optional mapping from the resolved object to the value the prop expects
3783
+ * @returns A marker value that the reconciler resolves after mount
4194
3784
  *
4195
3785
  * @example
4196
3786
  * const targetRef = useRef<THREE.Object3D>(null)
4197
3787
  *
4198
3788
  * <group ref={targetRef} position={[-3, -2, -15]} />
4199
3789
  * <spotLight target={fromRef(targetRef)} intensity={100} />
3790
+ *
3791
+ * @example
3792
+ * // Wrap the sibling: a node material's lightsNode needs a LightsNode, not the light itself
3793
+ * <meshPhongNodeMaterial lightsNode={fromRef(lightRef, (light) => lights([light]))} />
4200
3794
  */
4201
3795
  declare function fromRef<T>(ref: React$1.RefObject<T | null>): T;
3796
+ declare function fromRef<T, R>(ref: React$1.RefObject<T | null>, transform: (value: T) => R): R;
4202
3797
  /**
4203
3798
  * Type guard to check if a value is a fromRef marker.
4204
3799
  *
4205
3800
  * @param value - Value to check
4206
3801
  * @returns True if value is a fromRef marker
4207
3802
  */
4208
- declare function isFromRef(value: unknown): value is {
4209
- [FROM_REF]: React$1.RefObject<any>;
4210
- };
3803
+ declare function isFromRef(value: unknown): value is FromRefMarker<any, unknown>;
4211
3804
 
4212
3805
  /**
4213
3806
  * Symbol marker for mount-only method calls.
@@ -4234,7 +3827,15 @@ declare const ONCE: unique symbol;
4234
3827
  * // No arguments
4235
3828
  * <geometry center={once()} />
4236
3829
  */
4237
- declare function once<T>(...args: T[]): T;
3830
+ declare function once<A extends unknown[]>(...args: A): OnceValue<A>;
3831
+ /**
3832
+ * What `once(...args)` is typed as, so the marker is assignable to the prop it targets:
3833
+ * the single argument itself (`rotateX={once(angle)}`), the argument tuple for multi-argument
3834
+ * methods (`translate={once(x, y, z)}`), or `true` for a bare call (`center={once()}`).
3835
+ *
3836
+ * The runtime value is always the marker object; only the declared type follows the prop.
3837
+ */
3838
+ type OnceValue<A extends unknown[]> = A extends [] ? true : A extends [infer Single] ? Single : A;
4238
3839
  /**
4239
3840
  * Type guard to check if a value is a once marker.
4240
3841
  *
@@ -4245,11 +3846,8 @@ declare function isOnce(value: unknown): value is {
4245
3846
  [ONCE]: any[] | true;
4246
3847
  };
4247
3848
 
4248
- /**
4249
- * A DOM canvas which accepts threejs elements as children.
4250
- * @see https://docs.pmnd.rs/react-three-fiber/api/canvas
4251
- */
4252
- declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
3849
+ /** Distinguishes a resource leaf from a nested resource scope. */
3850
+ type ResourceLeafGuard<T> = (value: unknown) => value is T;
4253
3851
 
4254
3852
  /**
4255
3853
  * ScopedStore - Type-safe wrapper for nested stores (uniforms, nodes)
@@ -4271,42 +3869,43 @@ declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
4271
3869
  * ```
4272
3870
  */
4273
3871
 
4274
- /** Keys reserved for methods (excluded from index signature) */
4275
- type MethodKeys = 'scope' | 'has' | 'keys';
4276
3872
  /**
4277
3873
  * Type-safe wrapper interface for accessing nested store data.
4278
3874
  * Property access returns `T` (assumes leaf node).
4279
3875
  * Use `.scope(key)` for nested object access.
4280
3876
  *
4281
- * Uses mapped type with key filtering to exclude method names from index signature,
4282
- * allowing methods to have their correct return types.
4283
3877
  */
4284
- type ScopedStoreType<T> = {
4285
- /** Direct property access returns the leaf type T (method keys excluded) */
4286
- readonly [K in string as K extends MethodKeys ? never : K]: T;
4287
- } & {
3878
+ type ScopedStoreMethods<TLeaf> = {
4288
3879
  /** Access a nested scope by key. Returns empty wrapper if scope doesn't exist. */
4289
- scope(key: string): ScopedStoreType<T>;
3880
+ scope<TScope extends Record<string, TLeaf> = Record<string, TLeaf>>(key: string): ScopedStoreType<TLeaf, TScope>;
4290
3881
  /** Check if a key exists in the store */
4291
3882
  has(key: string): boolean;
4292
3883
  /** Get all keys in the store */
4293
3884
  keys(): string[];
4294
3885
  };
3886
+ type ScopedStoreType<TLeaf, TEntries extends Record<string, TLeaf> = Record<string, TLeaf>> = Readonly<TEntries> & ScopedStoreMethods<TLeaf>;
3887
+ interface ScopedStoreData<TLeaf> {
3888
+ [key: string]: TLeaf | ScopedStoreData<TLeaf>;
3889
+ }
4295
3890
  /**
4296
3891
  * Create a type-safe ScopedStore wrapper around store data.
4297
3892
  * @param data - The raw store data (uniforms or nodes from RootState)
4298
3893
  * @returns A ScopedStoreType wrapper with type-safe access
4299
3894
  */
4300
- declare function createScopedStore<T>(data: Record<string, any>): ScopedStoreType<T>;
3895
+ declare function createScopedStore<TLeaf>(data: ScopedStoreData<TLeaf>, isLeaf: ResourceLeafGuard<TLeaf>): ScopedStoreType<TLeaf>;
4301
3896
  /**
4302
3897
  * State type passed to creator functions with ScopedStore wrappers.
4303
- * Provides type-safe access to uniforms and nodes without manual casting.
3898
+ * Provides type-safe access to uniforms, nodes, buffers, and gpuStorage without manual casting.
4304
3899
  */
4305
- type CreatorState = Omit<RootState, 'uniforms' | 'nodes'> & {
3900
+ type CreatorState = Omit<RootState, 'uniforms' | 'nodes' | 'buffers' | 'gpuStorage'> & {
4306
3901
  /** Type-safe uniform access - property access returns UniformNode */
4307
3902
  uniforms: ScopedStoreType<UniformNode>;
4308
- /** Type-safe node access - property access returns TSLNodeType (Node | ShaderCallable | ShaderNodeObject) */
4309
- nodes: ScopedStoreType<TSLNodeType>;
3903
+ /** Type-safe node access for real, callable, and legacy structural nodes */
3904
+ nodes: ScopedStoreType<NodeLike>;
3905
+ /** Type-safe buffer access - property access returns BufferLike (TypedArrays, BufferAttributes, TSL nodes) */
3906
+ buffers: ScopedStoreType<BufferLike>;
3907
+ /** Type-safe GPU storage access - property access returns StorageLike (StorageTexture, TSL nodes) */
3908
+ gpuStorage: ScopedStoreType<StorageLike>;
4310
3909
  };
4311
3910
 
4312
3911
  /** Creator function that returns uniform inputs (can be raw values or UniformNodes) */
@@ -4318,22 +3917,26 @@ type ClearUniformsFn = (scope?: string) => void;
4318
3917
  /** Function signature for rebuildUniforms util */
4319
3918
  type RebuildUniformsFn = (scope?: string) => void;
4320
3919
  /** Return type with utils included */
4321
- type UniformsWithUtils<T extends UniformRecord = UniformRecord> = T & {
3920
+ type UniformsWithUtils<T extends UniformRecord | UniformStore = UniformRecord> = T & {
4322
3921
  removeUniforms: RemoveUniformsFn;
4323
3922
  clearUniforms: ClearUniformsFn;
4324
3923
  rebuildUniforms: RebuildUniformsFn;
4325
3924
  };
4326
- declare function useUniforms(): UniformsWithUtils<UniformRecord & Record<string, UniformRecord>>;
3925
+ declare function useUniforms<T extends UniformInputRecord>(creator: UniformCreator<T>): UniformsWithUtils<UniformNodesFor<T>>;
3926
+ declare function useUniforms<T extends UniformInputRecord>(creator: UniformCreator<T>, scope: string): UniformsWithUtils<UniformNodesFor<T>>;
3927
+ declare function useUniforms<T extends UniformInputRecord>(uniforms: T): UniformsWithUtils<UniformNodesFor<T>>;
3928
+ declare function useUniforms<T extends UniformInputRecord>(uniforms: T, scope: string): UniformsWithUtils<UniformNodesFor<T>>;
3929
+ declare function useUniforms(): UniformsWithUtils<UniformStore>;
4327
3930
  declare function useUniforms(scope: string): UniformsWithUtils;
4328
- declare function useUniforms<T extends UniformInputRecord>(creator: UniformCreator<T>): UniformsWithUtils<UniformRecord<UniformNode>>;
4329
- declare function useUniforms<T extends UniformInputRecord>(creator: UniformCreator<T>, scope: string): UniformsWithUtils<UniformRecord<UniformNode>>;
4330
- declare function useUniforms<T extends UniformInputRecord>(uniforms: T): UniformsWithUtils<UniformRecord<UniformNode>>;
4331
- declare function useUniforms<T extends UniformInputRecord>(uniforms: T, scope: string): UniformsWithUtils<UniformRecord<UniformNode>>;
3931
+ declare function useUniforms<T extends UniformInputRecord>(scope?: string): UniformsWithUtils<UniformNodesFor<T>>;
4332
3932
  /**
4333
3933
  * Global rebuildUniforms function for HMR integration.
4334
- * Clears cached uniforms and increments _hmrVersion to trigger re-creation.
3934
+ * Invalidates cached uniforms and increments _hmrVersion to trigger re-creation.
4335
3935
  * Call this when HMR is detected to refresh all uniform creators.
4336
3936
  *
3937
+ * Resolves to the primary store so shared TSL resources rebuild on the
3938
+ * authoritative store.
3939
+ *
4337
3940
  * @param store - The R3F store (from useStore or context)
4338
3941
  * @param scope - Optional scope to rebuild ('root' for root only, string for specific scope, undefined for all)
4339
3942
  */
@@ -4356,47 +3959,28 @@ declare function clearRootUniforms(set: ReturnType<typeof useStore>['setState'])
4356
3959
 
4357
3960
  /**
4358
3961
  * Supported uniform value types:
4359
- * - Raw values: number, boolean, Vector2, Vector3, Vector4, Color, Matrix3, Matrix4
3962
+ * - Raw values: number, boolean, Vector2, Vector3, Vector4, Color, Matrix2, Matrix3, Matrix4
4360
3963
  * - String colors: '#ff0000', 'red', 'rgb(255,0,0)' (auto-converted to Color)
4361
3964
  * - TSL nodes: color(), vec3(), float(), etc. (for type casting)
4362
3965
  * - UniformNode: existing uniforms (reused as-is)
4363
3966
  */
4364
- type UniformValue = number | boolean | string | Vector2$1 | Vector3$1 | Vector4$1 | Color$2 | Matrix3$1 | Matrix4$1 | Node | UniformNode;
4365
- /**
4366
- * Widen literal types to their base types:
4367
- * - 0 → number
4368
- * - true → boolean
4369
- * - '#ff0000' → Color (string colors are converted to Color objects)
4370
- * - Node → Node (TSL nodes passed through for uniform type casting)
4371
- */
4372
- type Widen<T> = T extends number ? number : T extends boolean ? boolean : T extends string ? Color$2 : T;
4373
- declare function useUniform<T extends UniformValue>(name: string): UniformNode<T>;
4374
- declare function useUniform<T extends UniformValue>(name: string, value: T): UniformNode<Widen<T>>;
3967
+ type UniformValue = number | boolean | string | Vector2$1 | Vector3$1 | Vector4$1 | Color$2 | Matrix2 | Matrix3$1 | Matrix4$1 | Node | UniformNode;
3968
+ declare function useUniform<T extends UniformValue = UniformValue>(name: string): UniformNodeFor<T>;
3969
+ declare function useUniform<T extends UniformValue>(name: string, value: T): UniformNodeFor<T>;
4375
3970
 
4376
3971
  /**
4377
- * Minimal interface for TSL nodes.
4378
- * Used instead of Three.js's Node type because the @types/three definitions
4379
- * have inconsistencies where OperatorNode, ConstNode, etc. don't properly
4380
- * extend Node with all required properties.
3972
+ * Every node representation a creator may return. The definition lives with the store types as
3973
+ * `NodeLike`, so the shape creators return and the shape `state.nodes` holds are one type by
3974
+ * construction: three's real `Node`, the callable proxy `Fn()` returns, or the legacy structural
3975
+ * `{ uuid, nodeType }` shape.
4381
3976
  */
4382
- interface TSLNodeLike {
4383
- uuid?: string;
4384
- nodeType?: string | null;
4385
- /** label method for chaining - sets the node's label and returns self */
4386
- label?: ((label: string) => TSLNodeLike) | string;
4387
- setName?: (name: string) => this;
4388
- }
4389
- /** TSL node type - alias for compatibility */
3977
+ type TSLNodeLike = NodeLike;
3978
+
3979
+ /** Backward-compatible alias covering every accepted node representation. */
4390
3980
  type TSLNode = TSLNodeLike;
4391
- /**
4392
- * A record of TSL nodes - allows mixed node types (OperatorNode, ConstNode, etc.)
4393
- * Uses TSLNodeLike for broader compatibility with Three.js's TSL type definitions.
4394
- */
4395
- type NodeRecord<T extends TSLNodeLike = TSLNodeLike> = Record<string, T>;
4396
3981
  /**
4397
3982
  * Creator function that returns a record of nodes.
4398
- * Uses TSLNodeLike constraint to allow mixed node types
4399
- * (e.g., { n: OperatorNode; color: ConstNode<Color> }) to pass type checking.
3983
+ * Exact creator return inference is preserved within the compatible node constraint.
4400
3984
  */
4401
3985
  type NodeCreator<T extends Record<string, TSLNodeLike>> = (state: CreatorState) => T;
4402
3986
  /** Function signature for removeNodes util */
@@ -4406,20 +3990,25 @@ type ClearNodesFn = (scope?: string) => void;
4406
3990
  /** Function signature for rebuildNodes util */
4407
3991
  type RebuildNodesFn = (scope?: string) => void;
4408
3992
  /** Return type with utils included */
4409
- type NodesWithUtils<T extends Record<string, TSLNodeLike> = Record<string, TSLNodeLike>> = T & {
3993
+ type NodesWithUtils<T extends Record<string, unknown> = NodeRecord> = T & {
4410
3994
  removeNodes: RemoveNodesFn;
4411
3995
  clearNodes: ClearNodesFn;
4412
3996
  rebuildNodes: RebuildNodesFn;
4413
3997
  };
4414
- declare function useNodes(): NodesWithUtils<Record<string, TSLNodeLike> & Record<string, Record<string, TSLNodeLike>>>;
4415
- declare function useNodes(scope: string): NodesWithUtils<Record<string, TSLNodeLike>>;
4416
- declare function useNodes<T extends Record<string, TSLNodeLike>>(creator: NodeCreator<T>): NodesWithUtils<T>;
4417
- declare function useNodes<T extends Record<string, TSLNodeLike>>(creator: NodeCreator<T>, scope: string): NodesWithUtils<T>;
3998
+ declare function useNodes(): NodesWithUtils<NodeStore>;
3999
+ declare function useNodes(scope: string): NodesWithUtils<NodeRecord>;
4000
+ declare function useNodes<T extends NodeRecord>(scope?: string): NodesWithUtils<T>;
4001
+ declare function useNodes<T extends NodeRecord>(creator: NodeCreator<T>): NodesWithUtils<T>;
4002
+ declare function useNodes<T extends NodeRecord>(creator: NodeCreator<T>, scope: string): NodesWithUtils<T>;
4003
+ declare function useNodes(creatorOrScope?: NodeCreator<NodeRecord> | string, scope?: string): NodesWithUtils<Record<string, unknown>>;
4418
4004
  /**
4419
4005
  * Global rebuildNodes function for HMR integration.
4420
- * Clears cached nodes and increments _hmrVersion to trigger re-creation.
4006
+ * Invalidates cached nodes and increments _hmrVersion to trigger re-creation.
4421
4007
  * Call this when HMR is detected to refresh all node creators.
4422
4008
  *
4009
+ * Resolves to the primary store so shared TSL resources rebuild on the
4010
+ * authoritative store.
4011
+ *
4423
4012
  * @param store - The R3F store (from useStore or context)
4424
4013
  * @param scope - Optional scope to rebuild ('root' for root only, string for specific scope, undefined for all)
4425
4014
  */
@@ -4470,6 +4059,107 @@ type LocalNodeCreator<T extends Record<string, unknown>> = (state: CreatorState)
4470
4059
  */
4471
4060
  declare function useLocalNodes<T extends Record<string, unknown>>(creator: LocalNodeCreator<T>): T;
4472
4061
 
4062
+ /**
4063
+ * A record of buffer-like values - allows mixed types (TypedArrays, BufferAttributes, TSL nodes)
4064
+ */
4065
+ type BufferRecordType<T extends BufferLike = BufferLike> = Record<string, T>;
4066
+ /**
4067
+ * Creator function that returns a record of buffers.
4068
+ * Receives CreatorState with access to existing buffers, gpuStorage, uniforms, nodes, etc.
4069
+ */
4070
+ type BufferCreator<T extends Record<string, BufferLike>> = (state: CreatorState) => T;
4071
+ /** Function signature for removeBuffers util */
4072
+ type RemoveBuffersFn = (names: string | string[], scope?: string) => void;
4073
+ /** Function signature for clearBuffers util */
4074
+ type ClearBuffersFn = (scope?: string) => void;
4075
+ /** Function signature for rebuildBuffers util */
4076
+ type RebuildBuffersFn = (scope?: string) => void;
4077
+ /** Function signature for disposeBuffers util - releases GPU resources */
4078
+ type DisposeBuffersFn = (names: string | string[], scope?: string) => void;
4079
+ /** Return type with utils included */
4080
+ type BuffersWithUtils<T extends BufferRecordType | BufferStore = BufferRecordType> = T & {
4081
+ removeBuffers: RemoveBuffersFn;
4082
+ clearBuffers: ClearBuffersFn;
4083
+ rebuildBuffers: RebuildBuffersFn;
4084
+ disposeBuffers: DisposeBuffersFn;
4085
+ };
4086
+ declare function useBuffers(): BuffersWithUtils<BufferStore>;
4087
+ declare function useBuffers(scope: string): BuffersWithUtils<Record<string, BufferLike>>;
4088
+ declare function useBuffers<T extends Record<string, BufferLike>>(scope?: string): BuffersWithUtils<T>;
4089
+ declare function useBuffers<T extends Record<string, BufferLike>>(creator: BufferCreator<T>): BuffersWithUtils<T>;
4090
+ declare function useBuffers<T extends Record<string, BufferLike>>(creator: BufferCreator<T>, scope: string): BuffersWithUtils<T>;
4091
+ /**
4092
+ * Global rebuildBuffers function for HMR integration.
4093
+ * Invalidates cached buffers and increments _hmrVersion to trigger re-creation.
4094
+ * Call this when HMR is detected to refresh all buffer creators.
4095
+ *
4096
+ * Resolves to the primary store so shared TSL resources rebuild on the
4097
+ * authoritative store.
4098
+ *
4099
+ * @param store - The R3F store (from useStore or context)
4100
+ * @param scope - Optional scope to rebuild ('root' for root only, string for specific scope, undefined for all)
4101
+ */
4102
+ declare function rebuildAllBuffers(store: ReturnType<typeof useStore>, scope?: string): void;
4103
+
4104
+ /**
4105
+ * A record of storage-like values - allows mixed types (StorageTexture, Storage3DTexture, TSL nodes)
4106
+ */
4107
+ type StorageRecordType<T extends StorageLike = StorageLike> = Record<string, T>;
4108
+ /**
4109
+ * Creator function that returns a record of GPU storage objects.
4110
+ * Receives CreatorState with access to existing buffers, gpuStorage, uniforms, nodes, etc.
4111
+ */
4112
+ type StorageCreator<T extends Record<string, StorageLike>> = (state: CreatorState) => T;
4113
+ /** Function signature for removeStorage util */
4114
+ type RemoveStorageFn = (names: string | string[], scope?: string) => void;
4115
+ /** Function signature for clearStorage util */
4116
+ type ClearStorageFn = (scope?: string) => void;
4117
+ /** Function signature for rebuildStorage util */
4118
+ type RebuildStorageFn = (scope?: string) => void;
4119
+ /** Function signature for disposeStorage util - releases GPU resources */
4120
+ type DisposeStorageFn = (names: string | string[], scope?: string) => void;
4121
+ /** Return type with utils included */
4122
+ type StorageWithUtils<T extends StorageRecordType | StorageStore = StorageRecordType> = T & {
4123
+ removeStorage: RemoveStorageFn;
4124
+ clearStorage: ClearStorageFn;
4125
+ rebuildStorage: RebuildStorageFn;
4126
+ disposeStorage: DisposeStorageFn;
4127
+ };
4128
+ declare function useGPUStorage(): StorageWithUtils<StorageStore>;
4129
+ declare function useGPUStorage(scope: string): StorageWithUtils<Record<string, StorageLike>>;
4130
+ declare function useGPUStorage<T extends Record<string, StorageLike>>(scope?: string): StorageWithUtils<T>;
4131
+ declare function useGPUStorage<T extends Record<string, StorageLike>>(creator: StorageCreator<T>): StorageWithUtils<T>;
4132
+ declare function useGPUStorage<T extends Record<string, StorageLike>>(creator: StorageCreator<T>, scope: string): StorageWithUtils<T>;
4133
+ /**
4134
+ * Global rebuildStorage function for HMR integration.
4135
+ * Invalidates cached storage and increments _hmrVersion to trigger re-creation.
4136
+ * Call this when HMR is detected to refresh all storage creators.
4137
+ *
4138
+ * Resolves to the primary store so shared TSL resources rebuild on the
4139
+ * authoritative store.
4140
+ *
4141
+ * @param store - The R3F store (from useStore or context)
4142
+ * @param scope - Optional scope to rebuild ('root' for root only, string for specific scope, undefined for all)
4143
+ */
4144
+ declare function rebuildAllStorage(store: ReturnType<typeof useStore>, scope?: string): void;
4145
+
4146
+ /**
4147
+ * Re-export from core - useTextures is now a core R3F hook (a reactive Texture registry).
4148
+ *
4149
+ * This file maintains backwards compatibility for existing webgpu imports.
4150
+ */
4151
+
4152
+ /**
4153
+ * @deprecated The registry now stores plain `Texture` objects, not TSL nodes. Use `Texture` directly.
4154
+ * Kept as an alias for backwards compatibility.
4155
+ */
4156
+ type TextureEntry = Texture$1;
4157
+ /**
4158
+ * @deprecated The registry now stores plain `Texture` objects, not TSL nodes. Use `Texture` directly.
4159
+ * Kept as an alias for backwards compatibility.
4160
+ */
4161
+ type TextureNode = Texture$1;
4162
+
4473
4163
  interface TextureOperations {
4474
4164
  add: (key: string, value: any) => void;
4475
4165
  addMultiple: (items: Map<string, any> | Record<string, any>) => void;
@@ -4479,32 +4169,36 @@ interface TextureOperations {
4479
4169
  declare function createTextureOperations(set: StoreApi<RootState>['setState']): TextureOperations;
4480
4170
 
4481
4171
  /**
4482
- * Hook for managing WebGPU PostProcessing with automatic scenePass setup.
4172
+ * Hook for managing WebGPU RenderPipeline with automatic scenePass setup.
4483
4173
  *
4484
4174
  * Features:
4485
- * - Creates PostProcessing instance if not exists
4175
+ * - Creates RenderPipeline instance if not exists
4486
4176
  * - Creates default scenePass (no MRT) automatically
4487
4177
  * - Callbacks receive full RootState for flexibility
4488
4178
  * - No auto-cleanup on unmount - use reset() for explicit cleanup
4489
4179
  * - Scene/camera changes trigger scenePass recreation
4180
+ * - A replaced scenePass is disposed once the new graph is installed, so rebuild() does not
4181
+ * strand its render target (and MRT attachments) on the GPU
4182
+ * - Any run that changes the output node sets RenderPipeline.needsUpdate, so rebuild() actually
4183
+ * recompiles instead of silently keeping the first compiled graph
4490
4184
  *
4491
4185
  * @param mainCB - Main callback to configure outputNode and create effect passes
4492
4186
  * @param setupCB - Optional setup callback to configure MRT on scenePass
4493
- * @returns { passes, postProcessing, clearPasses, reset, rebuild }
4187
+ * @returns { passes, renderPipeline, clearPasses, reset, rebuild }
4494
4188
  *
4495
4189
  * @example
4496
4190
  * ```tsx
4497
4191
  * // Simple effect
4498
- * usePostProcessing(({ postProcessing, passes }) => {
4499
- * postProcessing.outputNode = bloom(passes.scenePass.getTextureNode())
4192
+ * useRenderPipeline(({ renderPipeline, passes }) => {
4193
+ * renderPipeline.outputNode = bloom(passes.scenePass.getTextureNode())
4500
4194
  * })
4501
4195
  *
4502
4196
  * // With MRT setup
4503
- * usePostProcessing(
4504
- * ({ postProcessing, passes }) => {
4197
+ * useRenderPipeline(
4198
+ * ({ renderPipeline, passes }) => {
4505
4199
  * const beauty = passes.scenePass.getTextureNode().toInspector('Color')
4506
4200
  * const vel = passes.scenePass.getTextureNode('velocity')
4507
- * postProcessing.outputNode = motionBlur(beauty, vel)
4201
+ * renderPipeline.outputNode = motionBlur(beauty, vel)
4508
4202
  * },
4509
4203
  * ({ passes }) => {
4510
4204
  * passes.scenePass.setMRT(mrt({ output, velocity }))
@@ -4512,10 +4206,10 @@ declare function createTextureOperations(set: StoreApi<RootState>['setState']):
4512
4206
  * )
4513
4207
  *
4514
4208
  * // Read-only access
4515
- * const { postProcessing, passes } = usePostProcessing()
4209
+ * const { renderPipeline, passes } = useRenderPipeline()
4516
4210
  * ```
4517
4211
  */
4518
- declare function usePostProcessing(mainCB?: PostProcessingMainCallback, setupCB?: PostProcessingSetupCallback): UsePostProcessingReturn;
4212
+ declare function useRenderPipeline(mainCB?: RenderPipelineMainCallback, setupCB?: RenderPipelineSetupCallback): UseRenderPipelineReturn;
4519
4213
 
4520
4214
  //* Renderer Props ========================================
4521
4215
 
@@ -4564,5 +4258,32 @@ interface WebGPURootState extends Omit<RootState, 'renderer' | 'gl' | 'internal'
4564
4258
  internal: WebGPUInternalState
4565
4259
  }
4566
4260
 
4567
- 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, clearNodeScope, clearRootNodes, clearRootUniforms, clearScope, context, createEvents, createPointerEvents, createPortal, createRoot, createScopedStore, createStore, createTextureOperations, 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, rebuildAllNodes, rebuildAllUniforms, reconciler, registerPrimary, removeInteractivity, removeNodes, removeUniforms, resolve, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useLocalNodes, useMutableCallback, useNodes, usePostProcessing, useRenderTarget, useStore, useTexture, useTextures, useThree, useUniform, useUniforms, waitForPrimary };
4568
- export type { Act, AddPhaseOptions, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, ClearNodesFn, ClearUniformsFn, Color, ComputeFunction, ConstructorRepresentation, CreatorState, 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, WebGPUInternalState as InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, LocalNodeCreator, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeCreator, NodeProps, NodeRecord, NodesWithUtils, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, WebGPUR3FRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, RebuildNodesFn, RebuildUniformsFn, ReconcilerRoot, RemoveNodesFn, RemoveUniformsFn, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootOptions, WebGPURootState as RootState, RootStore, SchedulerApi, ScopedStoreType, SetBlock, Size, Subscription, TSLNode, TSLNodeInput, TextureEntry, TextureOperations, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UniformCreator, UniformValue, UniformsWithUtils, UseFrameNextOptions, UseFrameOptions, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, WebGPUDefaultProps, WebGPUProps, WebGPUShadowConfig, XRManager };
4261
+ /**
4262
+ * @fileoverview WebGPU entry point - WebGPU only, no legacy WebGL
4263
+ *
4264
+ * This entry point is for apps that want to use ONLY WebGPURenderer.
4265
+ * Includes WebGPU-specific hooks (useUniforms, useNodes, useTextures).
4266
+ * Auto-extends THREE with WebGPU node materials (MeshBasicNodeMaterial, etc.)
4267
+ *
4268
+ * Usage:
4269
+ * import { Canvas, useFrame, useUniforms } from '@react-three/fiber/webgpu'
4270
+ */
4271
+
4272
+ /** `useThree` narrowed to WebGPU state — `state.renderer` is a `WebGPURenderer`. */
4273
+ type UseThreeWebGPU = <T = WebGPURootState>(selector?: (state: WebGPURootState) => T, equalityFn?: <U>(state: U, newState: U) => boolean) => T;
4274
+ /** `useFrame` narrowed to WebGPU state — the callback's `state.renderer` is a `WebGPURenderer`. */
4275
+ type UseFrameWebGPU = (callback?: FrameCallback$1<WebGPURootState>, priorityOrOptions?: number | UseFrameNextOptions) => FrameNextControls;
4276
+ declare const useThree: UseThreeWebGPU;
4277
+ declare const useFrame: UseFrameWebGPU;
4278
+
4279
+ /** Canvas props on the WebGPU entry: `onCreated` receives `WebGPURootState`. */
4280
+ type WebGPUCanvasProps = Omit<CanvasProps, 'onCreated'> & {
4281
+ /** Callback after the canvas has rendered (but not yet committed); `state.renderer` is a `WebGPURenderer` */
4282
+ onCreated?: (state: WebGPURootState) => void;
4283
+ };
4284
+
4285
+ /** `Canvas` narrowed to WebGPU state — the same component, `onCreated` typed against `WebGPURootState`. */
4286
+ declare const Canvas: (props: WebGPUCanvasProps) => JSX.Element;
4287
+
4288
+ 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, clearNodeScope, clearRootNodes, clearRootUniforms, clearScope, context, createEvents, createPointerEvents, createPortal, createRoot, createScopedStore, createStore, createTextureOperations, 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, rebuildAllBuffers, rebuildAllNodes, rebuildAllStorage, rebuildAllUniforms, reconciler, registerPrimary, registerRootExtension, removeInteractivity, removeNodes, removeUniforms, resolve, setRenderOverride, swapInteractivity, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useBuffers, useEnvironment, useFrame, useGPUStorage, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useLocalNodes, useMutableCallback, useNodes, useRenderPipeline, useRenderTarget, useStore, useTexture, useTextures, useThree, useUniform, useUniforms, waitForPrimary };
4289
+ export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferCreator, BufferLike, BufferRecord, BufferStore, BuffersWithUtils, Camera, CameraProps, WebGPUCanvasProps as CanvasProps, CanvasSchedulerConfig, Catalogue, ClearBuffersFn, ClearNodesFn, ClearStorageFn, ClearUniformsFn, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, CreatorState, DefaultGLProps, DefaultRendererProps, Disposable, DisposeBuffersFn, DisposeOptions, DisposeStorageFn, 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, WebGPUInternalState as InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, LocalNodeCreator, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeCreator, NodeLike, NodeProps, NodeRecord, NodeStore, NodesWithUtils, NonFunctionKeys, Object3DMethod, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, OnceValue, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, WebGPUR3FRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, RebuildBuffersFn, RebuildNodesFn, RebuildStorageFn, RebuildUniformsFn, ReconcilerRoot, RemoveBuffersFn, RemoveNodesFn, RemoveStorageFn, RemoveUniformsFn, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootExtension, WebGPURootState as RootState, RootStore, ScopedStoreType, SetBlock, Size, StorageCreator, StorageLike, StorageRecord, StorageStore, StorageWithUtils, Subscription, TSLNode, TSLNodeInput, TSLNodeLike, TextureEntry, TextureInput, TextureNode, TextureOperations, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UniformCreator, UniformValue, UniformsWithUtils, UseFrameWebGPU, UseTextureOptions, UseTexturesReturn, UseThreeWebGPU, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, WebGPUCanvasProps, WebGPUDefaultProps, WebGPUProps, WebGPUShadowConfig, XRManager, XRPointerConfig };