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

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