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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,6 @@
1
- import * as three_webgpu from 'three/webgpu';
2
- import { RenderTarget, WebGPURenderer, CanvasTarget, Node, ShaderNodeObject, Euler as Euler$2, Color as Color$2, ColorRepresentation as ColorRepresentation$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, Loader as Loader$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Object3D, Frustum, OrthographicCamera, WebGPURendererParameters } from 'three/webgpu';
1
+ import * as three_examples_jsm_inspector_Inspector_js from 'three/examples/jsm/inspector/Inspector.js';
2
+ import * as webgpu from 'three/webgpu';
3
+ import { CubeRenderTarget, RenderTarget, WebGPURenderer, 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, WebGPURendererParameters } from 'three/webgpu';
3
4
  import { Inspector } from 'three/addons/inspector/Inspector.js';
4
5
  import * as THREE$1 from 'three';
5
6
  import { Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1 } from 'three';
@@ -7,9 +8,10 @@ import * as React$1 from 'react';
7
8
  import { ReactNode, Component, RefObject, JSX } from 'react';
8
9
  import { StoreApi } from 'zustand';
9
10
  import { UseBoundStoreWithEqualityFn } from 'zustand/traditional';
11
+ import { FrameTimingState, FrameCallback as FrameCallback$1, SchedulerApi, UseFrameNextOptions, FrameNextControls } from '@pmndrs/scheduler';
12
+ export { AddPhaseOptions, FrameControls, FrameNextControls, FrameTimingState, RootOptions, Scheduler, SchedulerApi, UseFrameNextOptions, UseFrameOptions, getScheduler } from '@pmndrs/scheduler';
10
13
  import { Options } from 'react-use-measure';
11
14
  import * as react_jsx_runtime from 'react/jsx-runtime';
12
- import { ThreeElement as ThreeElement$1, Euler as Euler$3 } from '@react-three/fiber';
13
15
  import { GroundedSkybox } from 'three/examples/jsm/objects/GroundedSkybox.js';
14
16
 
15
17
  function _mergeNamespaces(n, m) {
@@ -39,6 +41,8 @@ function _mergeNamespaces(n, m) {
39
41
  declare const R3F_BUILD_LEGACY = false;
40
42
  declare const R3F_BUILD_WEBGPU = true;
41
43
 
44
+ /** Lazily load the three Inspector. Keeps it out of the eager module graph — see note above. */
45
+ declare function loadInspector(): Promise<typeof three_examples_jsm_inspector_Inspector_js.Inspector>;
42
46
  declare const WebGLRenderer: {
43
47
  new (): {};
44
48
  };
@@ -47,17 +51,22 @@ type WebGLShadowMap = never;
47
51
 
48
52
  declare const WebGLRenderTarget: any;
49
53
 
54
+ declare const WebGLCubeRenderTarget: any;
55
+
50
56
  var THREE = /*#__PURE__*/_mergeNamespaces({
51
57
  __proto__: null,
58
+ CubeRenderTargetCompat: CubeRenderTarget,
52
59
  Inspector: Inspector,
53
60
  R3F_BUILD_LEGACY: R3F_BUILD_LEGACY,
54
61
  R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
55
62
  RenderTargetCompat: RenderTarget,
63
+ WebGLCubeRenderTarget: WebGLCubeRenderTarget,
56
64
  WebGLRenderTarget: WebGLRenderTarget,
57
65
  WebGLRenderer: WebGLRenderer,
58
66
  WebGLRendererParameters: WebGLRendererParameters,
59
- WebGLShadowMap: WebGLShadowMap
60
- }, [three_webgpu]);
67
+ WebGLShadowMap: WebGLShadowMap,
68
+ loadInspector: loadInspector
69
+ }, [webgpu]);
61
70
 
62
71
  //* Utility Types ==============================
63
72
 
@@ -151,6 +160,8 @@ interface IntersectionEvent<TSourceEvent> extends Intersection {
151
160
  unprojectedPoint: THREE$1.Vector3
152
161
  /** Normalized event coordinates */
153
162
  pointer: THREE$1.Vector2
163
+ /** pointerId of the original event for multiple pointer events */
164
+ pointerId: number
154
165
  /** Delta between first click and this event */
155
166
  delta: number
156
167
  /** The ray that pierced it */
@@ -227,6 +238,18 @@ interface EventHandlers {
227
238
  type FilterFunction = (items: THREE$1.Intersection[], state: RootState) => THREE$1.Intersection[]
228
239
  type ComputeFunction = (event: DomEvent, root: RootState, previous?: RootState) => void
229
240
 
241
+ /** Configuration for XR pointer registration (controllers/hands) */
242
+ interface XRPointerConfig {
243
+ /** Ray origin (updated each frame by XR system) */
244
+ ray: THREE$1.Ray
245
+ /** Optional: custom compute function for this pointer */
246
+ compute?: (state: RootState) => void
247
+ /** Pointer type identifier */
248
+ type: 'controller' | 'hand' | 'gaze'
249
+ /** Which hand (for controller/hand types) */
250
+ handedness?: 'left' | 'right'
251
+ }
252
+
230
253
  interface EventManager<TTarget> {
231
254
  /** Determines if the event layer is active */
232
255
  enabled: boolean
@@ -246,8 +269,21 @@ interface EventManager<TTarget> {
246
269
  disconnect?: () => void
247
270
  /** Triggers a onPointerMove with the last known event. This can be useful to enable raycasting without
248
271
  * explicit user interaction, for instance when the camera moves a hoverable object underneath the cursor.
272
+ * @param pointerId - Optional pointer ID to update specific pointer only
249
273
  */
250
- update?: () => void
274
+ update?: (pointerId?: number) => void
275
+ /** Defer pointer move raycasting to frame start (default: true) */
276
+ frameTimedRaycasts?: boolean
277
+ /** Always fire raycaster immediately on scroll events (default: true) */
278
+ alwaysFireOnScroll?: boolean
279
+ /** Automatically re-raycast every frame to detect hover changes from moving objects/camera (default: false) */
280
+ updateOnFrame?: boolean
281
+ /** Flush deferred pointer raycasts. Called by scheduler at frame start (input phase). */
282
+ flush?: () => void
283
+ /** Register an XR pointer (controller/hand). Returns assigned pointerId */
284
+ registerPointer?: (config: XRPointerConfig) => number
285
+ /** Unregister an XR pointer */
286
+ unregisterPointer?: (pointerId: number) => void
251
287
  }
252
288
 
253
289
  interface PointerCaptureTarget {
@@ -267,228 +303,33 @@ interface VisibilityEntry {
267
303
  }
268
304
 
269
305
  //* Scheduler Types (useFrame) ==============================
306
+ //
307
+ // The generic, framework-agnostic scheduler types now live in @pmndrs/scheduler.
308
+ // This file re-exports them and layers r3f's RootState-aware frame state on top,
309
+ // so existing `#types` imports across the codebase keep resolving unchanged.
270
310
 
271
311
 
272
312
 
273
- // Public Options --------------------------------
274
-
275
- /**
276
- * Options for useFrame hook
277
- */
278
- interface UseFrameNextOptions {
279
- /** Optional stable id for the job. Auto-generated if not provided */
280
- id?: string
281
- /** Named phase to run in. Default: 'update' */
282
- phase?: string
283
- /** Run before this phase or job id */
284
- before?: string | string[]
285
- /** Run after this phase or job id */
286
- after?: string | string[]
287
- /** Priority within phase. Higher runs first. Default: 0 */
288
- priority?: number
289
- /** Max frames per second for this job */
290
- fps?: number
291
- /** If true, skip frames when behind. If false, try to catch up. Default: true */
292
- drop?: boolean
293
- /** Enable/disable without unregistering. Default: true */
294
- enabled?: boolean
295
- }
296
-
297
- /** Alias for UseFrameNextOptions */
298
- type UseFrameOptions = UseFrameNextOptions
313
+ // Frame State (r3f-specific) --------------------------------
299
314
 
300
315
  /**
301
- * Options for addPhase
302
- */
303
- interface AddPhaseOptions {
304
- /** Insert this phase before the specified phase */
305
- before?: string
306
- /** Insert this phase after the specified phase */
307
- after?: string
308
- }
309
-
310
- // Frame State --------------------------------
311
-
312
- /**
313
- * Timing-only state for independent/outside mode (no RootState)
314
- */
315
- interface FrameTimingState {
316
- /** High-resolution timestamp from RAF (ms) */
317
- time: number
318
- /** Time since last frame in seconds (for legacy compatibility with THREE.Clock) */
319
- delta: number
320
- /** Elapsed time since first frame in seconds (for legacy compatibility with THREE.Clock) */
321
- elapsed: number
322
- /** Incrementing frame counter */
323
- frame: number
324
- }
325
-
326
- /**
327
- * State passed to useFrame callbacks (extends RootState with timing)
316
+ * State passed to useFrame callbacks (extends RootState with timing).
328
317
  */
329
318
  interface FrameNextState extends RootState, FrameTimingState {}
330
319
 
331
320
  /** Alias for FrameNextState */
332
321
  type FrameState = FrameNextState
333
322
 
334
- // Root Options --------------------------------
335
-
336
- /**
337
- * Options for registerRoot
338
- */
339
- interface RootOptions {
340
- /** State provider for callbacks. Optional in independent mode. */
341
- getState?: () => any
342
- /** Error handler for job errors. Falls back to console.error if not provided. */
343
- onError?: (error: Error) => void
344
- }
345
-
346
- // Callback Types --------------------------------
323
+ // Callback Types (r3f-specific) --------------------------------
347
324
 
348
325
  /**
349
- * Callback function for useFrame
326
+ * Callback function for useFrame. Receives the full r3f RootState plus timing.
350
327
  */
351
- type FrameNextCallback = (state: FrameNextState, delta: number) => void
328
+ type FrameNextCallback = FrameCallback$1<RootState>
352
329
 
353
330
  /** Alias for FrameNextCallback */
354
331
  type FrameCallback = FrameNextCallback
355
332
 
356
- // Controls returned from useFrame --------------------------------
357
-
358
- /**
359
- * Controls object returned from useFrame hook
360
- */
361
- interface FrameNextControls {
362
- /** The job's unique ID */
363
- id: string
364
- /** Access to the global scheduler for frame loop control */
365
- scheduler: SchedulerApi
366
- /** Manually step this job only (bypasses FPS limiting) */
367
- step(timestamp?: number): void
368
- /** Manually step ALL jobs in the scheduler */
369
- stepAll(timestamp?: number): void
370
- /** Pause this job (set enabled=false) */
371
- pause(): void
372
- /** Resume this job (set enabled=true) */
373
- resume(): void
374
- /** Reactive paused state - automatically triggers re-render when changed */
375
- isPaused: boolean
376
- }
377
-
378
- /** Alias for FrameNextControls */
379
- type FrameControls = FrameNextControls
380
-
381
- // Scheduler Interface --------------------------------
382
-
383
- /**
384
- * Public interface for the global Scheduler
385
- */
386
- interface SchedulerApi {
387
- //* Phase Management --------------------------------
388
-
389
- /** Add a named phase to the scheduler */
390
- addPhase(name: string, options?: AddPhaseOptions): void
391
- /** Get the ordered list of phase names */
392
- readonly phases: string[]
393
- /** Check if a phase exists */
394
- hasPhase(name: string): boolean
395
-
396
- //* Root Management --------------------------------
397
-
398
- /** Register a root (Canvas) with the scheduler. Returns unsubscribe function. */
399
- registerRoot(id: string, options?: RootOptions): () => void
400
- /** Unregister a root */
401
- unregisterRoot(id: string): void
402
- /** Generate a unique root ID */
403
- generateRootId(): string
404
- /** Get the number of registered roots */
405
- getRootCount(): number
406
- /** Check if any root is registered and ready */
407
- readonly isReady: boolean
408
- /** Subscribe to root-ready event. Fires immediately if already ready. Returns unsubscribe. */
409
- onRootReady(callback: () => void): () => void
410
-
411
- //* Job Registration --------------------------------
412
-
413
- /** Register a job with the scheduler (returns unsubscribe function) */
414
- register(
415
- callback: FrameNextCallback,
416
- options?: {
417
- id?: string
418
- rootId?: string
419
- phase?: string
420
- before?: string | string[]
421
- after?: string | string[]
422
- priority?: number
423
- fps?: number
424
- drop?: boolean
425
- enabled?: boolean
426
- },
427
- ): () => void
428
- /** Update a job's options */
429
- updateJob(
430
- id: string,
431
- options: {
432
- priority?: number
433
- fps?: number
434
- drop?: boolean
435
- enabled?: boolean
436
- phase?: string
437
- before?: string | string[]
438
- after?: string | string[]
439
- },
440
- ): void
441
- /** Unregister a job by ID */
442
- unregister(id: string, rootId?: string): void
443
- /** Get the number of registered jobs */
444
- getJobCount(): number
445
- /** Get all job IDs */
446
- getJobIds(): string[]
447
-
448
- //* Global Jobs (for legacy addEffect/addAfterEffect) --------------------------------
449
-
450
- /** Register a global job (runs once per frame, not per-root). Returns unsubscribe function. */
451
- registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void
452
-
453
- //* Idle Callbacks (for legacy addTail) --------------------------------
454
-
455
- /** Register an idle callback (fires when loop stops). Returns unsubscribe function. */
456
- onIdle(callback: (timestamp: number) => void): () => void
457
-
458
- //* Frame Loop Control --------------------------------
459
-
460
- /** Start the scheduler loop */
461
- start(): void
462
- /** Stop the scheduler loop */
463
- stop(): void
464
- /** Check if the scheduler is running */
465
- readonly isRunning: boolean
466
- /** Get/set the frameloop mode ('always', 'demand', 'never') */
467
- frameloop: Frameloop
468
- /** Independent mode - runs without Canvas, callbacks receive timing-only state */
469
- independent: boolean
470
-
471
- //* Manual Stepping --------------------------------
472
-
473
- /** Manually step all jobs once (for frameloop='never' or testing) */
474
- step(timestamp?: number): void
475
- /** Manually step a single job by ID */
476
- stepJob(id: string, timestamp?: number): void
477
- /** Request frame(s) to be rendered (for frameloop='demand') */
478
- invalidate(frames?: number): void
479
-
480
- //* Per-Job Control --------------------------------
481
-
482
- /** Check if a job is paused */
483
- isJobPaused(id: string): boolean
484
- /** Pause a job */
485
- pauseJob(id: string): void
486
- /** Resume a job */
487
- resumeJob(id: string): void
488
- /** Subscribe to job state changes (for reactive isPaused). Returns unsubscribe function. */
489
- subscribeJobState(id: string, listener: () => void): () => void
490
- }
491
-
492
333
  //* Renderer Types ========================================
493
334
 
494
335
  /** Default renderer type - union of WebGL and WebGPU renderers */
@@ -502,6 +343,18 @@ type Subscription = {
502
343
  store: RootStore
503
344
  }
504
345
 
346
+ /** Per-pointer state for multi-touch and XR support */
347
+ type PointerState = {
348
+ /** Objects currently hovered by this pointer */
349
+ hovered: Map<string, ThreeEvent<DomEvent>>
350
+ /** Objects capturing this pointer */
351
+ captured: Map<THREE$1.Object3D, PointerCaptureTarget>
352
+ /** Initial click position [x, y] */
353
+ initialClick: [x: number, y: number]
354
+ /** Objects hit on initial click */
355
+ initialHits: THREE$1.Object3D[]
356
+ }
357
+
505
358
  type Dpr = number | [min: number, max: number]
506
359
 
507
360
  interface Size {
@@ -543,12 +396,21 @@ interface Performance {
543
396
 
544
397
  interface InternalState {
545
398
  interaction: THREE$1.Object3D[]
546
- hovered: Map<string, ThreeEvent<DomEvent>>
547
399
  subscribers: Subscription[]
400
+ /** Per-pointer state (hover, capture, click tracking) - replaces hovered, capturedMap, initialClick, initialHits */
401
+ pointerMap: Map<number, PointerState>
402
+ /** Pointers needing raycast this frame (used with frameTimedRaycasts) */
403
+ pointerDirty: Map<number, DomEvent>
404
+ /** Last event received (for events.update() compatibility) */
405
+ lastEvent: React$1.RefObject<DomEvent | null>
406
+ /** @deprecated Use pointerMap.get(pointerId).hovered instead */
407
+ hovered: Map<string, ThreeEvent<DomEvent>>
408
+ /** @deprecated Use pointerMap.get(pointerId).captured instead */
548
409
  capturedMap: Map<number, Map<THREE$1.Object3D, PointerCaptureTarget>>
410
+ /** @deprecated Use pointerMap.get(pointerId).initialClick instead */
549
411
  initialClick: [x: number, y: number]
412
+ /** @deprecated Use pointerMap.get(pointerId).initialHits instead */
550
413
  initialHits: THREE$1.Object3D[]
551
- lastEvent: React$1.RefObject<DomEvent | null>
552
414
  /** Visibility event registry (onFramed, onOccluded, onVisible) */
553
415
  visibilityRegistry: Map<string, VisibilityEntry>
554
416
  /** Whether occlusion queries are enabled (WebGPU only) */
@@ -567,6 +429,12 @@ interface InternalState {
567
429
  actualRenderer: R3FRenderer
568
430
  /** Global scheduler reference (for useFrame hook) */
569
431
  scheduler: SchedulerApi | null
432
+ /**
433
+ * Replaces `renderer.render(scene, camera)` in the default render job when set. Set it with
434
+ * `setRenderOverride(store, fn)`; the job keeps its fps throttle, error handling and user
435
+ * render-phase takeover. Used by `useRenderPipeline`.
436
+ */
437
+ renderOverride?: (() => void) | null
570
438
  /** This root's unique ID in the global scheduler */
571
439
  rootId?: string
572
440
  /** Function to unregister this root from the global scheduler */
@@ -574,14 +442,31 @@ interface InternalState {
574
442
  /** Container for child attachment (scene for root, original container for portals) */
575
443
  container?: THREE$1.Object3D
576
444
  /**
577
- * CanvasTarget for multi-canvas WebGPU rendering.
578
- * Created for all WebGPU canvases to support renderer sharing.
445
+ * The CanvasTarget this root sizes and renders through.
446
+ *
447
+ * A primary (`<Canvas id>`) owns the renderer's default target -- the one three itself built
448
+ * around the canvas element -- so sizing it is sizing the renderer. A secondary owns a target
449
+ * R3F created for its own element. Either way there is exactly one target per canvas element,
450
+ * and the canvas-target job makes it the renderer's active one before this root renders.
451
+ * Absent on WebGL and on an id-less WebGPU canvas, where the renderer is sized directly.
579
452
  * @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
580
453
  */
581
454
  canvasTarget?: CanvasTarget
455
+ /**
456
+ * Set when this root's canvas target has been resized and the backend's cached render pass
457
+ * descriptor (which holds a depth-stencil view built once per canvas) is therefore stale.
458
+ *
459
+ * Flushed by the canvas-target job in the `start` phase, which is the only place this root's
460
+ * target is guaranteed to be the renderer's active one — `backend.updateSize()` operates on
461
+ * whatever `getCanvasTarget()` returns, so calling it from the resize subscription would
462
+ * invalidate some other canvas's descriptor instead.
463
+ *
464
+ * @see https://github.com/pmndrs/react-three-fiber/issues/3847
465
+ */
466
+ canvasTargetSizeDirty?: boolean
582
467
  /**
583
468
  * Whether multi-canvas rendering is active.
584
- * True when any canvas uses `target` prop to share a renderer.
469
+ * True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
585
470
  * When true, setCanvasTarget is called before each render.
586
471
  */
587
472
  isMultiCanvas?: boolean
@@ -617,12 +502,13 @@ interface RootState {
617
502
  /** Get current state */
618
503
  get: StoreApi<RootState>['getState']
619
504
  /**
620
- * Reference to the authoritative store for shared TSL resources (uniforms, nodes, etc).
505
+ * The store of the canvas that owns this root's renderer.
621
506
  * - For primary/independent canvases: points to its own store (self-reference)
622
507
  * - For secondary canvases: points to the primary canvas's store
508
+ * - Portals copy it from their parent
623
509
  *
624
- * Hooks like useNodes/useUniforms should read from primaryStore to ensure
625
- * consistent shared state across all canvases sharing a renderer.
510
+ * Anything shared per renderer rather than per canvas (e.g. @react-three/tsl's resources)
511
+ * resolves through it.
626
512
  */
627
513
  primaryStore: RootStore
628
514
  /** @deprecated Use `renderer` instead. The instance of the renderer (typed as WebGLRenderer for backwards compat) */
@@ -679,24 +565,16 @@ interface RootState {
679
565
  setSize: (width?: number, height?: number, top?: number, left?: number) => void
680
566
  /** Shortcut to manual setting the pixel ratio */
681
567
  setDpr: (dpr: Dpr) => void
682
- /** Shortcut to setting frameloop flags */
683
- setFrameloop: (frameloop: Frameloop) => void
568
+ /** Shortcut to setting frameloop flags. No args resets to 'always'. */
569
+ setFrameloop: (frameloop?: Frameloop) => void
684
570
  /** Set error state to propagate to error boundary */
685
571
  setError: (error: Error | null) => void
686
572
  /** Current error state (null when no error) */
687
573
  error: Error | null
688
- /** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
689
- uniforms: UniformStore
690
- /** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
691
- nodes: Record<string, any>
692
- /** Global TSL texture nodes - use useTextures() hook for operations */
693
- textures: Map<string, any>
694
- /** WebGPU PostProcessing instance - use usePostProcessing() hook */
695
- postProcessing: any | null // THREE.PostProcessing when available
696
- /** Global TSL pass nodes for post-processing - use usePostProcessing() hook */
697
- passes: Record<string, any>
698
- /** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
699
- _hmrVersion: number
574
+ /** Global Texture registry (key → Texture, usually keyed by URL) - use useTextures() hook for access + lifecycle */
575
+ textures: Map<string, THREE$1.Texture>
576
+ /** Internal: refcount per texture key, driven by mounted useTexture consumers (registry enrollment is on by default) */
577
+ _textureRefs: Map<string, number>
700
578
  /** Internal: whether setSize() has taken ownership of canvas dimensions */
701
579
  _sizeImperative: boolean
702
580
  /** Internal: stored size props from Canvas for reset functionality */
@@ -743,6 +621,20 @@ interface Renderer {
743
621
  render: (scene: THREE$1.Scene, camera: THREE$1.Camera) => any
744
622
  }
745
623
 
624
+ //* Color Management Config ==============================
625
+
626
+ /**
627
+ * Color management configuration shared by both WebGL and WebGPU renderers.
628
+ */
629
+ interface ColorManagementConfig {
630
+ /**
631
+ * Color space assigned to 8-bit input textures (color maps).
632
+ * Defaults to sRGB. Most textures are authored in sRGB.
633
+ * @default THREE.SRGBColorSpace
634
+ */
635
+ textureColorSpace?: THREE$1.ColorSpace
636
+ }
637
+
746
638
  //* WebGL Renderer Props ==============================
747
639
 
748
640
  type DefaultGLProps = Omit<THREE$1.WebGLRendererParameters, 'canvas'> & {
@@ -753,7 +645,7 @@ type GLProps =
753
645
  | Renderer
754
646
  | ((defaultProps: DefaultGLProps) => Renderer)
755
647
  | ((defaultProps: DefaultGLProps) => Promise<Renderer>)
756
- | Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters>
648
+ | (Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters> & ColorManagementConfig)
757
649
 
758
650
  //* WebGPU Renderer Props ==============================
759
651
 
@@ -768,20 +660,27 @@ type DefaultRendererProps = {
768
660
  */
769
661
  interface CanvasSchedulerConfig {
770
662
  /**
771
- * Render this canvas after another canvas completes.
772
- * Pass the `id` of another canvas.
663
+ * Run this Canvas root before the referenced Canvas root id(s).
664
+ */
665
+ before?: string | string[]
666
+ /**
667
+ * Run this Canvas root after the referenced Canvas root id(s).
668
+ */
669
+ after?: string | string[]
670
+ /**
671
+ * Numeric root order. Lower values run first.
773
672
  */
774
- after?: string
673
+ order?: number
775
674
  /**
776
- * Limit this canvas's render rate (frames per second).
675
+ * Limit this Canvas's default render job (frames per second).
777
676
  */
778
677
  fps?: number
779
678
  }
780
679
 
781
680
  /**
782
- * Extended renderer configuration for multi-canvas support.
681
+ * Extended renderer configuration for multi-canvas support and color management.
783
682
  */
784
- interface RendererConfigExtended {
683
+ interface RendererConfigExtended extends ColorManagementConfig {
785
684
  /** Share renderer from another canvas (WebGPU only) */
786
685
  primaryCanvas?: string
787
686
  /** Canvas-level scheduler options */
@@ -846,8 +745,6 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
846
745
  * @see https://threejs.org/docs/#api/en/renderers/WebGLRenderer.shadowMap
847
746
  */
848
747
  shadows?: boolean | 'basic' | 'percentage' | 'soft' | 'variance' | Partial<THREE$1.WebGLShadowMap>
849
- /** Color space assigned to 8-bit input textures (color maps). Defaults to sRGB. Most textures are authored in sRGB. */
850
- textureColorSpace?: THREE$1.ColorSpace
851
748
  /** Creates an orthographic camera */
852
749
  orthographic?: boolean
853
750
  /**
@@ -862,14 +759,17 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
862
759
  performance?: Partial<Omit<Performance, 'regress'>>
863
760
  /** Target pixel ratio. Can clamp between a range: `[min, max]` */
864
761
  dpr?: Dpr
865
- /** Props that go into the default raycaster */
866
- raycaster?: Partial<THREE$1.Raycaster>
762
+ /**
763
+ * Props that go into the default raycaster. `params` is merged into the raycaster's defaults,
764
+ * so a single threshold can be set: `raycaster={{ params: { Points: { threshold: 0.2 } } }}`.
765
+ */
766
+ raycaster?: Partial<Omit<THREE$1.Raycaster, 'params'>> & { params?: Partial<THREE$1.RaycasterParameters> }
867
767
  /** A `THREE.Scene` instance or props that go into the default scene */
868
768
  scene?: THREE$1.Scene | Partial<THREE$1.Scene>
869
769
  /** A `THREE.Camera` instance or props that go into the default camera */
870
770
  camera?: CameraProps
871
771
  /** An R3F event manager to manage elements' pointer events */
872
- events?: (store: RootStore) => EventManager<HTMLElement>
772
+ events?: (store: RootStore) => EventManager<Element>
873
773
  /** Callback after the canvas has rendered (but not yet committed) */
874
774
  onCreated?: (state: RootState) => void
875
775
  /** Response for pointer clicks that have missed any target */
@@ -958,7 +858,6 @@ type InstanceProps<T = any, P = any> = ArgsProp<P> & {
958
858
  object?: T
959
859
  dispose?: null
960
860
  attach?: AttachType<T>
961
- onUpdate?: (self: T) => void
962
861
  }
963
862
 
964
863
  interface Instance<O = any> {
@@ -973,8 +872,6 @@ interface Instance<O = any> {
973
872
  attach?: AttachType<O>
974
873
  previousAttach?: any
975
874
  isHidden: boolean
976
- /** Deferred ref props to apply in commitMount */
977
- deferredRefs?: Array<{ prop: string; ref: React$1.RefObject<any> }>
978
875
  /** Set of props that have been applied via once() */
979
876
  appliedOnce?: Set<string>
980
877
  }
@@ -1100,7 +997,7 @@ interface CanvasProps
1100
997
  */
1101
998
  resize?: Options
1102
999
  /** The target where events are being subscribed to, default: the div that wraps canvas */
1103
- eventSource?: HTMLElement | React$1.RefObject<HTMLElement>
1000
+ eventSource?: Element | React$1.RefObject<Element | null>
1104
1001
  /** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
1105
1002
  eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
1106
1003
  /** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
@@ -1208,329 +1105,6 @@ interface LegacyRootState extends Omit<RootState, 'renderer' | 'internal'> {
1208
1105
 
1209
1106
  type RenderTargetOptions = RenderTargetOptions$1
1210
1107
 
1211
- //* Global Types ==============================
1212
-
1213
- declare global {
1214
- /** Uniform node type - a Node with a value property (matches Three.js UniformNode) */
1215
- interface UniformNode<T = unknown> extends Node {
1216
- value: T
1217
- }
1218
-
1219
- /**
1220
- * ShaderCallable - the return type of Fn()
1221
- * A callable shader function node that can be invoked with parameters.
1222
- * The function returns a ShaderNodeObject when called.
1223
- *
1224
- * @example
1225
- * ```tsx
1226
- * // Define a shader function
1227
- * const blendColorFn = Fn(([color1, color2, factor]) => {
1228
- * return mix(color1, color2, factor)
1229
- * })
1230
- *
1231
- * // Type when retrieving from nodes store
1232
- * const { blendColorFn } = nodes as { blendColorFn: ShaderCallable }
1233
- *
1234
- * // Or with specific return type
1235
- * const { myFn } = nodes as { myFn: ShaderCallable<THREE.Node> }
1236
- * ```
1237
- */
1238
- type ShaderCallable<R extends Node = Node> = ((...params: unknown[]) => ShaderNodeObject<R>) & Node
1239
-
1240
- /**
1241
- * ShaderNodeRef - a ShaderNodeObject wrapper around a Node
1242
- * This is the common return type for TSL operations (add, mul, sin, etc.)
1243
- *
1244
- * @example
1245
- * ```tsx
1246
- * const { wobble } = nodes as { wobble: ShaderNodeRef }
1247
- * ```
1248
- */
1249
- type ShaderNodeRef<T extends Node = Node> = ShaderNodeObject<T>
1250
-
1251
- /**
1252
- * TSLNodeType - Union of all common TSL node types
1253
- * Used by ScopedStore to properly type node access from the store.
1254
- *
1255
- * Includes:
1256
- * - Node: base Three.js node type
1257
- * - ShaderCallable: function nodes created with Fn()
1258
- * - ShaderNodeObject: wrapped nodes from TSL operations (sin, mul, mix, etc.)
1259
- *
1260
- * @example
1261
- * ```tsx
1262
- * // In useLocalNodes, nodes are typed as TSLNodeType
1263
- * const { positionNode, blendColorFn } = useLocalNodes(({ nodes }) => ({
1264
- * positionNode: nodes.myPosition, // Works - Node is in union
1265
- * blendColorFn: nodes.myFn, // Works - ShaderCallable is in union
1266
- * }))
1267
- *
1268
- * // Can narrow with type guard or assertion when needed
1269
- * if (typeof blendColorFn === 'function') {
1270
- * blendColorFn(someColor, 0.5)
1271
- * }
1272
- * ```
1273
- */
1274
- type TSLNodeType = Node | ShaderCallable<Node> | ShaderNodeObject<Node>
1275
-
1276
- /** Flat record of uniform nodes (no nested scopes) */
1277
- type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
1278
-
1279
- /**
1280
- * Uniform store that can contain both root-level uniforms and scoped uniform objects
1281
- * Used by state.uniforms which has structure like:
1282
- * { uTime: UniformNode, player: { uHealth: UniformNode }, enemy: { uHealth: UniformNode } }
1283
- */
1284
- type UniformStore = Record<string, UniformNode | UniformRecord>
1285
-
1286
- /**
1287
- * Helper to safely access a uniform node from the store.
1288
- * Use this when accessing state.uniforms to get proper typing.
1289
- * @example
1290
- * const uTime = uniforms.uTime as UniformNode<number>
1291
- * const uColor = uniforms.uColor as UniformNode<import('three/webgpu').Color>
1292
- */
1293
- type GetUniform<T = unknown> = UniformNode<T>
1294
-
1295
- /**
1296
- * Acceptable input values for useUniforms - raw values that get converted to UniformNodes
1297
- * Supports:
1298
- * - Primitives: number, string (color), boolean
1299
- * - Three.js types: Color, Vector2/3/4, Matrix3/4, Euler, Quaternion
1300
- * - Plain objects: { x, y, z, w } converted to vectors
1301
- * - TSL nodes: color(), vec3(), float() for type casting
1302
- * - UniformNode: existing uniforms (reused as-is)
1303
- */
1304
- type UniformValue =
1305
- | number
1306
- | string
1307
- | boolean
1308
- | three_webgpu.Color
1309
- | three_webgpu.Vector2
1310
- | three_webgpu.Vector3
1311
- | three_webgpu.Vector4
1312
- | three_webgpu.Matrix3
1313
- | three_webgpu.Matrix4
1314
- | three_webgpu.Euler
1315
- | three_webgpu.Quaternion
1316
- | { x: number; y?: number; z?: number; w?: number } // Plain objects converted to vectors
1317
- | Node // TSL nodes like color(), vec3(), float() for type casting
1318
- | UniformNode
1319
-
1320
- /** Input record for useUniforms - accepts raw values or UniformNodes */
1321
- type UniformInputRecord = Record<string, UniformValue>
1322
- }
1323
-
1324
- //* Module Augmentation ==============================
1325
-
1326
- declare module 'three/tsl' {
1327
- /**
1328
- * Fn with array parameter destructuring
1329
- * @example Fn(([uv, skew]) => { ... })
1330
- */
1331
- export function Fn<R extends Node = Node>(
1332
- jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
1333
- ): ShaderCallable<R>
1334
-
1335
- /**
1336
- * Fn with object parameter destructuring
1337
- * @example Fn(({ color, intensity }) => { ... })
1338
- */
1339
- export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
1340
- jsFunc: (inputs: T) => ShaderNodeObject<R>,
1341
- ): ShaderCallable<R>
1342
-
1343
- /**
1344
- * Fn with array params + layout
1345
- * @example Fn(([a, b]) => { ... }, { layout: [...] })
1346
- */
1347
- export function Fn<R extends Node = Node>(
1348
- jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
1349
- layout: { layout?: unknown },
1350
- ): ShaderCallable<R>
1351
-
1352
- /**
1353
- * Fn with object params + layout
1354
- */
1355
- export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
1356
- jsFunc: (inputs: T) => ShaderNodeObject<R>,
1357
- layout: { layout?: unknown },
1358
- ): ShaderCallable<R>
1359
- }
1360
-
1361
- /**
1362
- * PostProcessing Types for usePostProcessing hook (WebGPU only)
1363
- */
1364
-
1365
-
1366
-
1367
- declare global {
1368
- /** Pass record - stores TSL pass nodes for post-processing */
1369
- type PassRecord = Record<string, any>
1370
-
1371
- /** Setup callback - runs first to configure MRT, create additional passes */
1372
- type PostProcessingSetupCallback = (state: RootState) => PassRecord | void
1373
-
1374
- /** Main callback - runs second to configure outputNode, create effect passes */
1375
- type PostProcessingMainCallback = (state: RootState) => PassRecord | void
1376
-
1377
- /** Return type for usePostProcessing hook */
1378
- interface UsePostProcessingReturn {
1379
- /** Current passes from state */
1380
- passes: PassRecord
1381
- /** PostProcessing instance (null if not initialized) */
1382
- postProcessing: any | null // THREE.PostProcessing
1383
- /** Clear all passes from state */
1384
- clearPasses: () => void
1385
- /** Reset PostProcessing entirely (clears PP + passes) */
1386
- reset: () => void
1387
- /** Re-run setup/main callbacks with current closure values */
1388
- rebuild: () => void
1389
- /** True when PostProcessing is configured and ready */
1390
- isReady: boolean
1391
- }
1392
- }
1393
-
1394
- //* useFrameNext Types ==============================
1395
-
1396
-
1397
-
1398
- //* Global Type Declarations ==============================
1399
-
1400
- declare global {
1401
- // Job --------------------------------
1402
-
1403
- /**
1404
- * Internal job representation in the scheduler
1405
- */
1406
- interface Job {
1407
- /** Unique identifier */
1408
- id: string
1409
- /** The callback to execute */
1410
- callback: FrameNextCallback
1411
- /** Phase this job belongs to */
1412
- phase: string
1413
- /** Run before these phases/job ids */
1414
- before: Set<string>
1415
- /** Run after these phases/job ids */
1416
- after: Set<string>
1417
- /** Priority within phase (higher first) */
1418
- priority: number
1419
- /** Insertion order for deterministic tie-breaking */
1420
- index: number
1421
- /** Max FPS for this job (undefined = no limit) */
1422
- fps?: number
1423
- /** Drop frames when behind (true) or catch up (false) */
1424
- drop: boolean
1425
- /** Last run timestamp (ms) */
1426
- lastRun?: number
1427
- /** Whether job is enabled */
1428
- enabled: boolean
1429
- /** Internal flag: system jobs (like default render) don't block user render takeover */
1430
- system?: boolean
1431
- }
1432
-
1433
- // Phase Graph --------------------------------
1434
-
1435
- /**
1436
- * A node in the phase graph
1437
- */
1438
- interface PhaseNode {
1439
- /** Phase name */
1440
- name: string
1441
- /** Whether this was auto-generated from a before/after constraint */
1442
- isAutoGenerated: boolean
1443
- }
1444
-
1445
- /**
1446
- * Options for creating a job from hook options
1447
- */
1448
- interface JobOptions {
1449
- id?: string
1450
- phase?: string
1451
- before?: string | string[]
1452
- after?: string | string[]
1453
- priority?: number
1454
- fps?: number
1455
- drop?: boolean
1456
- enabled?: boolean
1457
- }
1458
-
1459
- // Frame Loop State --------------------------------
1460
-
1461
- /**
1462
- * Internal frame loop state
1463
- */
1464
- interface FrameLoopState {
1465
- /** Whether the loop is running */
1466
- running: boolean
1467
- /** Current RAF handle */
1468
- rafHandle: number | null
1469
- /** Last frame timestamp in ms (null = uninitialized) */
1470
- lastTime: number | null
1471
- /** Frame counter */
1472
- frameCount: number
1473
- /** Elapsed time since first frame in ms */
1474
- elapsedTime: number
1475
- /** createdAt timestamp in ms */
1476
- createdAt: number
1477
- }
1478
-
1479
- // Root Entry --------------------------------
1480
-
1481
- /**
1482
- * Internal representation of a registered root (Canvas).
1483
- * Tracks jobs and manages rebuild state for this root.
1484
- * @internal
1485
- */
1486
- interface RootEntry {
1487
- /** Unique identifier for this root */
1488
- id: string
1489
- /** Function to get the root's current state. Returns any to support independent mode. */
1490
- getState: () => any
1491
- /** Map of job IDs to Job objects */
1492
- jobs: Map<string, Job>
1493
- /** Cached sorted job list for execution order */
1494
- sortedJobs: Job[]
1495
- /** Whether sortedJobs needs rebuilding */
1496
- needsRebuild: boolean
1497
- }
1498
-
1499
- /**
1500
- * Internal representation of a global job (deprecated API).
1501
- * Global jobs run once per frame, not per-root.
1502
- * Used by legacy addEffect/addAfterEffect APIs.
1503
- * @internal
1504
- * @deprecated Use useFrame with phases instead
1505
- */
1506
- interface GlobalJob {
1507
- /** Unique identifier for this global job */
1508
- id: string
1509
- /** Callback invoked with RAF timestamp in ms */
1510
- callback: (timestamp: number) => void
1511
- }
1512
-
1513
- // HMR Support --------------------------------
1514
-
1515
- /**
1516
- * Hot Module Replacement data structure for preserving scheduler state
1517
- * @internal
1518
- */
1519
- interface HMRData {
1520
- /** Shared data object for storing values across reloads */
1521
- data: Record<string, any>
1522
- /** Optional function to accept HMR updates */
1523
- accept?: () => void
1524
- }
1525
-
1526
- // Default Phases --------------------------------
1527
-
1528
- /**
1529
- * Default phase names for the scheduler
1530
- */
1531
- type DefaultPhase = 'start' | 'input' | 'physics' | 'update' | 'render' | 'finish'
1532
- }
1533
-
1534
1108
  type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
1535
1109
 
1536
1110
  interface MathRepresentation {
@@ -1607,10 +1181,11 @@ type TSLNodeInput = { nodeType?: string | null; uuid?: string } | null
1607
1181
 
1608
1182
  /**
1609
1183
  * For node material properties (colorNode, positionNode, etc.), accept broader types
1610
- * since @types/three has broken inheritance for TSL node subclasses.
1184
+ * since @types/three has broken inheritance for TSL node subclasses. NodeClass requires
1185
+ * `nodeType`, so this structural key test remains neutral to the selected Three entry.
1611
1186
  */
1612
1187
  type NodeProps<P> = {
1613
- [K in keyof P as P[K] extends Node | null ? K : never]?: TSLNodeInput
1188
+ [K in keyof P as NonNullable<P[K]> extends { nodeType: string | null } ? K : never]?: TSLNodeInput
1614
1189
  }
1615
1190
 
1616
1191
  interface ReactProps<P> {
@@ -1631,11 +1206,29 @@ type ThreeToJSXElements<T extends Record<string, any>> = {
1631
1206
  [K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
1632
1207
  }
1633
1208
 
1209
+ /** Method names of Object3D, excluded from the `primitive` element's typed props. */
1210
+ type Object3DMethod = NonNullable<
1211
+ {
1212
+ [K in keyof Object3D]-?: Object3D[K] extends (...args: any[]) => any ? K : never
1213
+ }[keyof Object3D]
1214
+ >
1215
+
1634
1216
  type ThreeExports = typeof THREE
1635
1217
  type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
1636
1218
 
1637
1219
  interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
1638
- primitive: Omit<ThreeElement<any>, 'args'> & { object: object }
1220
+ /**
1221
+ * `primitive` wraps a pre-existing object, so its props cannot be derived from one class.
1222
+ * Events are typed from `EventHandlers` (`onClick={(e) => ...}` infers `e`), the ref is
1223
+ * untyped, and any other prop is accepted and applied to the object by name. Object3D's own
1224
+ * methods are left out of the typed surface: they return `this`, so a subclass element's
1225
+ * props (`ThreeElements['group']`) could not be spread onto a primitive otherwise.
1226
+ */
1227
+ primitive: Omit<ThreeElement<typeof Object3D>, 'args' | 'object' | 'ref' | Object3DMethod> & {
1228
+ object: object
1229
+ ref?: React.Ref<any>
1230
+ [prop: string]: unknown
1231
+ }
1639
1232
  // Conflicts with DOM types can be accessed through a three* prefix
1640
1233
  threeAudio: ThreeElementsImpl['audio']
1641
1234
  threeSource: ThreeElementsImpl['source']
@@ -1676,6 +1269,7 @@ type three_d_Matrix3 = Matrix3;
1676
1269
  type three_d_Matrix4 = Matrix4;
1677
1270
  type three_d_MutableOrReadonlyParameters<T extends (...args: any) => any> = MutableOrReadonlyParameters<T>;
1678
1271
  type three_d_NodeProps<P> = NodeProps<P>;
1272
+ type three_d_Object3DMethod = Object3DMethod;
1679
1273
  type three_d_Quaternion = Quaternion;
1680
1274
  type three_d_RaycastableRepresentation = RaycastableRepresentation;
1681
1275
  type three_d_ReactProps<P> = ReactProps<P>;
@@ -1690,7 +1284,7 @@ type three_d_Vector3 = Vector3;
1690
1284
  type three_d_Vector4 = Vector4;
1691
1285
  type three_d_VectorRepresentation = VectorRepresentation;
1692
1286
  declare namespace three_d {
1693
- export type { three_d_Color as Color, three_d_ElementProps as ElementProps, three_d_Euler as Euler, three_d_EventProps as EventProps, three_d_GeometryProps as GeometryProps, three_d_GeometryTransformProps as GeometryTransformProps, three_d_Layers as Layers, three_d_MathProps as MathProps, three_d_MathRepresentation as MathRepresentation, three_d_MathType as MathType, three_d_MathTypes as MathTypes, three_d_Matrix3 as Matrix3, three_d_Matrix4 as Matrix4, three_d_MutableOrReadonlyParameters as MutableOrReadonlyParameters, three_d_NodeProps as NodeProps, three_d_Quaternion as Quaternion, three_d_RaycastableRepresentation as RaycastableRepresentation, three_d_ReactProps as ReactProps, three_d_TSLNodeInput as TSLNodeInput, three_d_ThreeElement as ThreeElement, three_d_ThreeElements as ThreeElements, three_d_ThreeElementsImpl as ThreeElementsImpl, three_d_ThreeExports as ThreeExports, three_d_ThreeToJSXElements as ThreeToJSXElements, three_d_Vector2 as Vector2, three_d_Vector3 as Vector3, three_d_Vector4 as Vector4, three_d_VectorRepresentation as VectorRepresentation };
1287
+ export type { three_d_Color as Color, three_d_ElementProps as ElementProps, three_d_Euler as Euler, three_d_EventProps as EventProps, three_d_GeometryProps as GeometryProps, three_d_GeometryTransformProps as GeometryTransformProps, three_d_Layers as Layers, three_d_MathProps as MathProps, three_d_MathRepresentation as MathRepresentation, three_d_MathType as MathType, three_d_MathTypes as MathTypes, three_d_Matrix3 as Matrix3, three_d_Matrix4 as Matrix4, three_d_MutableOrReadonlyParameters as MutableOrReadonlyParameters, three_d_NodeProps as NodeProps, three_d_Object3DMethod as Object3DMethod, three_d_Quaternion as Quaternion, three_d_RaycastableRepresentation as RaycastableRepresentation, three_d_ReactProps as ReactProps, three_d_TSLNodeInput as TSLNodeInput, three_d_ThreeElement as ThreeElement, three_d_ThreeElements as ThreeElements, three_d_ThreeElementsImpl as ThreeElementsImpl, three_d_ThreeExports as ThreeExports, three_d_ThreeToJSXElements as ThreeToJSXElements, three_d_Vector2 as Vector2, three_d_Vector3 as Vector3, three_d_Vector4 as Vector4, three_d_VectorRepresentation as VectorRepresentation };
1694
1288
  }
1695
1289
 
1696
1290
  /**
@@ -1700,7 +1294,7 @@ declare namespace three_d {
1700
1294
  * a single WebGPURenderer using Three.js CanvasTarget API.
1701
1295
  *
1702
1296
  * Primary canvas: Has `id` prop, creates its own renderer, registers here
1703
- * Secondary canvas: Has `target="id"` prop, shares primary's renderer via CanvasTarget
1297
+ * Secondary canvas: Has `renderer={{ primaryCanvas: 'id' }}`, shares primary's renderer via CanvasTarget
1704
1298
  */
1705
1299
 
1706
1300
  interface PrimaryCanvasEntry {
@@ -1768,12 +1362,23 @@ type EnvironmentLoaderProps = {
1768
1362
  * const texture = useEnvironment({ preset: 'sunset' })
1769
1363
  * ```
1770
1364
  */
1771
- declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown> | CubeTexture;
1365
+ declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown, THREE$1.TextureEventMap> | CubeTexture<unknown>;
1772
1366
  declare namespace useEnvironment {
1773
1367
  var preload: (preloadOptions?: EnvironmentLoaderPreloadOptions) => void;
1774
1368
  var clear: (clearOptions?: EnvironmentLoaderClearOptions) => void;
1775
1369
  }
1776
- type EnvironmentLoaderPreloadOptions = Omit<EnvironmentLoaderProps, 'encoding'>;
1370
+ /**
1371
+ * Options accepted by `useEnvironment.preload`.
1372
+ *
1373
+ * `colorSpace` is deliberately omitted: preload only warms the loader cache, and colorSpace is
1374
+ * applied to the texture by `useEnvironment()` at use time, per consumer. Accepting it here would
1375
+ * advertise an option this function silently ignores.
1376
+ *
1377
+ * This previously read `Omit<…, 'encoding'>` — omitting a key that does not exist on
1378
+ * `EnvironmentLoaderProps`, a leftover from three's pre-`colorSpace` `encoding` API. That made the
1379
+ * type equivalent to the full props, so `colorSpace` was accepted and then dropped on the floor.
1380
+ */
1381
+ type EnvironmentLoaderPreloadOptions = Omit<EnvironmentLoaderProps, 'colorSpace'>;
1777
1382
  type EnvironmentLoaderClearOptions = Pick<EnvironmentLoaderProps, 'files' | 'preset'>;
1778
1383
 
1779
1384
  /**
@@ -1817,9 +1422,9 @@ type EnvironmentProps = {
1817
1422
  blur?: number;
1818
1423
  backgroundBlurriness?: number;
1819
1424
  backgroundIntensity?: number;
1820
- backgroundRotation?: Euler$3;
1425
+ backgroundRotation?: Euler;
1821
1426
  environmentIntensity?: number;
1822
- environmentRotation?: Euler$3;
1427
+ environmentRotation?: Euler;
1823
1428
  map?: Texture$1;
1824
1429
  preset?: PresetsType;
1825
1430
  scene?: Scene | React$1.RefObject<Scene>;
@@ -1903,7 +1508,7 @@ declare function EnvironmentCube({ background, scene, blur, backgroundBlurriness
1903
1508
  declare function EnvironmentPortal({ children, near, far, resolution, frames, map, background, blur, backgroundBlurriness, backgroundIntensity, backgroundRotation, environmentIntensity, environmentRotation, scene, files, path, preset, extensions, }: EnvironmentProps): react_jsx_runtime.JSX.Element;
1904
1509
  declare module '@react-three/fiber' {
1905
1510
  interface ThreeElements {
1906
- groundProjectedEnvImpl: ThreeElement$1<typeof GroundedSkybox>;
1511
+ groundProjectedEnvImpl: ThreeElement<typeof GroundedSkybox>;
1907
1512
  }
1908
1513
  }
1909
1514
  /**
@@ -2003,12 +1608,68 @@ declare module '@react-three/fiber' {
2003
1608
  */
2004
1609
  declare function Environment(props: EnvironmentProps): react_jsx_runtime.JSX.Element;
2005
1610
 
1611
+ /**
1612
+ * Moves every trace of interactivity from one object to its replacement, for reconstruction.
1613
+ *
1614
+ * When `args` or a `primitive`'s `object` changes, R3F builds a new three object and keeps the same
1615
+ * instance. Removing the old object from the interaction state and registering the new one from
1616
+ * scratch makes events *work* again (#3778), but it forgets what was in flight: a pointer resting on
1617
+ * the object fires a second `onPointerEnter` without ever having left, and an active pointer capture
1618
+ * is dropped mid-drag. Rewriting the references instead keeps the interaction continuous across a
1619
+ * swap the user never asked to see (#3744).
1620
+ *
1621
+ * Captures are re-keyed rather than released, so the DOM-level capture on `captureData.target` is
1622
+ * left alone — releasing and re-acquiring it is precisely the glitch being avoided.
1623
+ *
1624
+ * Visibility handlers are deliberately not transferred: that registry is keyed by `object.uuid`, so
1625
+ * the replacement re-registers itself through `applyProps`. The old entry is dropped here so it
1626
+ * cannot outlive the object it described.
1627
+ */
1628
+ declare function swapInteractivity(store: RootStore, object: Object3D, newObject: Object3D): void;
2006
1629
  declare function removeInteractivity(store: RootStore, object: Object3D): void;
2007
1630
  declare function createEvents(store: RootStore): {
2008
1631
  handlePointer: (name: string) => (event: DomEvent) => void;
1632
+ flushDeferredPointers: () => void;
1633
+ processDeferredPointer: (event: DomEvent, pointerId: number) => void;
2009
1634
  };
2010
1635
  /** Default R3F event manager for web */
2011
- declare function createPointerEvents(store: RootStore): EventManager<HTMLElement>;
1636
+ declare function createPointerEvents(store: RootStore): EventManager<Element>;
1637
+
1638
+ interface RootExtension {
1639
+ /** Unique name. Registering the same name again replaces the entry (HMR-safe); roots it already
1640
+ * set up are not set up a second time, but get the new entry's dispose and hmr. */
1641
+ name: string;
1642
+ /**
1643
+ * Called once per root, after its renderer exists and before `onCreated` and the first frame.
1644
+ * `isLegacy` and `primaryStore` are known by then, so an extension can skip WebGL roots or defer
1645
+ * to the primary canvas. Return fields to merge into the root's state, or nothing.
1646
+ */
1647
+ setup?(store: RootStore): Partial<RootState> | void;
1648
+ /** Called when a root this extension set up unmounts. */
1649
+ dispose?(store: RootStore): void;
1650
+ /** Called when `<Canvas>` detects hot module replacement (skipped with `hmr={false}`). */
1651
+ hmr?(store: RootStore): void;
1652
+ }
1653
+ /**
1654
+ * Register an extension. It is set up on every live root immediately, and on every root created
1655
+ * afterwards. Returns a function that unregisters it: new roots are no longer set up, while roots
1656
+ * it already set up keep its state and still get its dispose when they unmount.
1657
+ */
1658
+ declare function registerRootExtension(extension: RootExtension): () => void;
1659
+ /**
1660
+ * Point a root's default render job at a different render function, or back at
1661
+ * `renderer.render(scene, camera)` with `null`.
1662
+ *
1663
+ * The default job keeps everything else: the Canvas `fps` throttle, error propagation to the error
1664
+ * boundary, and backing off when a user `useFrame(..., { phase: 'render' })` job takes over.
1665
+ */
1666
+ declare function setRenderOverride(store: RootStore, render: (() => void) | null): void;
1667
+
1668
+ /**
1669
+ * Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
1670
+ * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
1671
+ */
1672
+ declare function useStore(): RootStore;
2012
1673
 
2013
1674
  /**
2014
1675
  * Gets or creates a memoized loader instance from a loader constructor or returns the loader if it's already an instance.
@@ -2021,419 +1682,13 @@ declare function getLoader<L extends LoaderLike | ConstructorRepresentation<Load
2021
1682
  * Note: this hook's caller must be wrapped with `React.Suspense`
2022
1683
  * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useloader
2023
1684
  */
2024
- declare function useLoader<I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void): I extends any[] ? LoaderResult<L>[] : LoaderResult<L>;
1685
+ declare function useLoader<I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void, cacheKey?: InputLike): I extends any[] ? LoaderResult<L>[] : LoaderResult<L>;
2025
1686
  declare namespace useLoader {
2026
- var preload: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void) => void;
2027
- var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I) => void;
1687
+ 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;
1688
+ var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, cacheKey?: InputLike) => void;
2028
1689
  var loader: typeof getLoader;
2029
1690
  }
2030
1691
 
2031
- /**
2032
- * Global Singleton Scheduler - manages the frame loop and job execution for ALL R3F roots.
2033
- *
2034
- * Features:
2035
- * - Single RAF loop for entire application
2036
- * - Root registration (multiple Canvas support)
2037
- * - Global phases for addEffect/addAfterEffect (deprecated)
2038
- * - Per-root job management with phases, priorities, FPS throttling
2039
- * - onIdle callbacks for addTail (deprecated)
2040
- * - Demand mode support via invalidate()
2041
- */
2042
- declare class Scheduler {
2043
- private static readonly INSTANCE_KEY;
2044
- private static get instance();
2045
- private static set instance(value);
2046
- /**
2047
- * Get the global scheduler instance (creates if doesn't exist).
2048
- * Uses HMR data to preserve instance across hot reloads.
2049
- * @returns {Scheduler} The singleton scheduler instance
2050
- */
2051
- static get(): Scheduler;
2052
- /**
2053
- * Reset the singleton instance. Stops the loop and clears all state.
2054
- * Primarily used for testing to ensure clean state between tests.
2055
- * @returns {void}
2056
- */
2057
- static reset(): void;
2058
- private roots;
2059
- private phaseGraph;
2060
- private loopState;
2061
- private stoppedTime;
2062
- private nextRootIndex;
2063
- private globalBeforeJobs;
2064
- private globalAfterJobs;
2065
- private nextGlobalIndex;
2066
- private idleCallbacks;
2067
- private nextJobIndex;
2068
- private jobStateListeners;
2069
- private pendingFrames;
2070
- private _frameloop;
2071
- private _independent;
2072
- private errorHandler;
2073
- private rootReadyCallbacks;
2074
- get phases(): string[];
2075
- get frameloop(): Frameloop;
2076
- set frameloop(mode: Frameloop);
2077
- get isRunning(): boolean;
2078
- get isReady(): boolean;
2079
- get independent(): boolean;
2080
- set independent(value: boolean);
2081
- constructor();
2082
- /**
2083
- * Register a root (Canvas) with the scheduler.
2084
- * The first root to register starts the RAF loop (if frameloop='always').
2085
- * @param {string} id - Unique identifier for this root
2086
- * @param {RootOptions} [options] - Optional configuration with getState and onError callbacks
2087
- * @returns {() => void} Unsubscribe function to remove this root
2088
- */
2089
- registerRoot(id: string, options?: RootOptions): () => void;
2090
- /**
2091
- * Unregister a root from the scheduler.
2092
- * Cleans up all job state listeners for this root's jobs.
2093
- * The last root to unregister stops the RAF loop.
2094
- * @param {string} id - The root ID to unregister
2095
- * @returns {void}
2096
- */
2097
- unregisterRoot(id: string): void;
2098
- /**
2099
- * Subscribe to be notified when a root becomes available.
2100
- * Fires immediately if a root already exists.
2101
- * @param {() => void} callback - Function called when first root registers
2102
- * @returns {() => void} Unsubscribe function
2103
- */
2104
- onRootReady(callback: () => void): () => void;
2105
- /**
2106
- * Notify all registered root-ready callbacks.
2107
- * Called when the first root registers.
2108
- * @returns {void}
2109
- * @private
2110
- */
2111
- private notifyRootReady;
2112
- /**
2113
- * Ensure a default root exists for independent mode.
2114
- * Creates a minimal root with no state provider.
2115
- * @returns {void}
2116
- * @private
2117
- */
2118
- private ensureDefaultRoot;
2119
- /**
2120
- * Trigger error handling for job errors.
2121
- * Uses the bound error handler if available, otherwise logs to console.
2122
- * @param {Error} error - The error to handle
2123
- * @returns {void}
2124
- */
2125
- triggerError(error: Error): void;
2126
- /**
2127
- * Add a named phase to the scheduler's execution order.
2128
- * Marks all roots for rebuild to incorporate the new phase.
2129
- * @param {string} name - The phase name (e.g., 'physics', 'postprocess')
2130
- * @param {AddPhaseOptions} [options] - Positioning options (before/after other phases)
2131
- * @returns {void}
2132
- * @example
2133
- * scheduler.addPhase('physics', { before: 'update' });
2134
- * scheduler.addPhase('postprocess', { after: 'render' });
2135
- */
2136
- addPhase(name: string, options?: AddPhaseOptions): void;
2137
- /**
2138
- * Check if a phase exists in the scheduler.
2139
- * @param {string} name - The phase name to check
2140
- * @returns {boolean} True if the phase exists
2141
- */
2142
- hasPhase(name: string): boolean;
2143
- /**
2144
- * Register a global job that runs once per frame (not per-root).
2145
- * Used internally by deprecated addEffect/addAfterEffect APIs.
2146
- * @param {'before' | 'after'} phase - When to run: 'before' all roots or 'after' all roots
2147
- * @param {string} id - Unique identifier for this global job
2148
- * @param {(timestamp: number) => void} callback - Function called each frame with RAF timestamp
2149
- * @returns {() => void} Unsubscribe function to remove this global job
2150
- * @deprecated Use useFrame with phases instead
2151
- */
2152
- registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void;
2153
- /**
2154
- * Register an idle callback that fires when the loop stops.
2155
- * Used internally by deprecated addTail API.
2156
- * @param {(timestamp: number) => void} callback - Function called when loop becomes idle
2157
- * @returns {() => void} Unsubscribe function to remove this idle callback
2158
- * @deprecated Use demand mode with invalidate() instead
2159
- */
2160
- onIdle(callback: (timestamp: number) => void): () => void;
2161
- /**
2162
- * Notify all registered idle callbacks.
2163
- * Called when the loop stops in demand mode.
2164
- * @param {number} timestamp - The RAF timestamp when idle occurred
2165
- * @returns {void}
2166
- * @private
2167
- */
2168
- private notifyIdle;
2169
- /**
2170
- * Register a job (frame callback) with a specific root.
2171
- * This is the core registration method used by useFrame internally.
2172
- * @param {FrameNextCallback} callback - The function to call each frame
2173
- * @param {JobOptions & { rootId?: string; system?: boolean }} [options] - Job configuration
2174
- * @param {string} [options.rootId] - Target root ID (defaults to first registered root)
2175
- * @param {string} [options.id] - Unique job ID (auto-generated if not provided)
2176
- * @param {string} [options.phase] - Execution phase (defaults to 'update')
2177
- * @param {number} [options.priority] - Priority within phase (higher = earlier, default 0)
2178
- * @param {number} [options.fps] - FPS throttle limit
2179
- * @param {boolean} [options.drop] - Drop frames when behind (default true)
2180
- * @param {boolean} [options.enabled] - Whether job is active (default true)
2181
- * @param {boolean} [options.system] - Internal flag for system jobs (not user-facing)
2182
- * @returns {() => void} Unsubscribe function to remove this job
2183
- */
2184
- register(callback: FrameNextCallback, options?: JobOptions & {
2185
- rootId?: string;
2186
- system?: boolean;
2187
- }): () => void;
2188
- /**
2189
- * Unregister a job by its ID.
2190
- * Searches all roots if rootId is not provided.
2191
- * @param {string} id - The job ID to unregister
2192
- * @param {string} [rootId] - Optional root ID to search (searches all if not provided)
2193
- * @returns {void}
2194
- */
2195
- unregister(id: string, rootId?: string): void;
2196
- /**
2197
- * Update a job's options dynamically.
2198
- * Searches all roots to find the job by ID.
2199
- * Phase/constraint changes trigger a rebuild of the sorted job list.
2200
- * @param {string} id - The job ID to update
2201
- * @param {Partial<JobOptions>} options - The options to update
2202
- * @returns {void}
2203
- */
2204
- updateJob(id: string, options: Partial<JobOptions>): void;
2205
- /**
2206
- * Check if a job is currently paused (disabled).
2207
- * @param {string} id - The job ID to check
2208
- * @returns {boolean} True if the job exists and is paused
2209
- */
2210
- isJobPaused(id: string): boolean;
2211
- /**
2212
- * Subscribe to state changes for a specific job.
2213
- * Listener is called when job is paused or resumed.
2214
- * @param {string} id - The job ID to subscribe to
2215
- * @param {() => void} listener - Callback invoked on state changes
2216
- * @returns {() => void} Unsubscribe function
2217
- */
2218
- subscribeJobState(id: string, listener: () => void): () => void;
2219
- /**
2220
- * Notify all listeners that a job's state has changed.
2221
- * @param {string} id - The job ID that changed
2222
- * @returns {void}
2223
- * @private
2224
- */
2225
- private notifyJobStateChange;
2226
- /**
2227
- * Pause a job by ID (sets enabled=false).
2228
- * Notifies any subscribed state listeners.
2229
- * @param {string} id - The job ID to pause
2230
- * @returns {void}
2231
- */
2232
- pauseJob(id: string): void;
2233
- /**
2234
- * Resume a paused job by ID (sets enabled=true).
2235
- * Resets job timing to prevent frame accumulation.
2236
- * Notifies any subscribed state listeners.
2237
- * @param {string} id - The job ID to resume
2238
- * @returns {void}
2239
- */
2240
- resumeJob(id: string): void;
2241
- /**
2242
- * Start the requestAnimationFrame loop.
2243
- * Resets timing state (elapsedTime, frameCount) on start.
2244
- * No-op if already running.
2245
- * @returns {void}
2246
- */
2247
- start(): void;
2248
- /**
2249
- * Stop the requestAnimationFrame loop.
2250
- * Cancels any pending RAF callback.
2251
- * No-op if not running.
2252
- * @returns {void}
2253
- */
2254
- stop(): void;
2255
- /**
2256
- * Request frames to be rendered in demand mode.
2257
- * Accumulates pending frames (capped at 60) and starts the loop if not running.
2258
- * No-op if frameloop is not 'demand'.
2259
- * @param {number} [frames=1] - Number of frames to request
2260
- * @param {boolean} [stackFrames=false] - Whether to add frames to existing pending count
2261
- * - `false` (default): Sets pending frames to the specified value (replaces existing count)
2262
- * - `true`: Adds frames to existing pending count (useful for accumulating invalidations)
2263
- * @returns {void}
2264
- * @example
2265
- * // Request a single frame render
2266
- * scheduler.invalidate();
2267
- *
2268
- * @example
2269
- * // Request 5 frames (e.g., for animations)
2270
- * scheduler.invalidate(5);
2271
- *
2272
- * @example
2273
- * // Set pending frames to exactly 3 (don't stack with existing)
2274
- * scheduler.invalidate(3, false);
2275
- *
2276
- * @example
2277
- * // Add 2 more frames to existing pending count
2278
- * scheduler.invalidate(2, true);
2279
- */
2280
- invalidate(frames?: number, stackFrames?: boolean): void;
2281
- /**
2282
- * Reset timing state for deterministic testing.
2283
- * Preserves jobs and roots but resets lastTime, frameCount, elapsedTime, etc.
2284
- * @returns {void}
2285
- */
2286
- resetTiming(): void;
2287
- /**
2288
- * Manually execute a single frame for all roots.
2289
- * Useful for frameloop='never' mode or testing scenarios.
2290
- * @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
2291
- * @returns {void}
2292
- * @example
2293
- * // Manual control mode
2294
- * scheduler.frameloop = 'never';
2295
- * scheduler.step(); // Execute one frame
2296
- */
2297
- step(timestamp?: number): void;
2298
- /**
2299
- * Manually execute a single job by its ID.
2300
- * Useful for testing individual job callbacks in isolation.
2301
- * @param {string} id - The job ID to step
2302
- * @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
2303
- * @returns {void}
2304
- */
2305
- stepJob(id: string, timestamp?: number): void;
2306
- /**
2307
- * Main RAF loop callback.
2308
- * Executes frame, handles demand mode, and schedules next frame.
2309
- * @param {number} timestamp - RAF timestamp in milliseconds
2310
- * @returns {void}
2311
- * @private
2312
- */
2313
- private loop;
2314
- /**
2315
- * Execute a single frame across all roots.
2316
- * Order: globalBefore → each root's jobs → globalAfter
2317
- * @param {number} timestamp - RAF timestamp in milliseconds
2318
- * @returns {void}
2319
- * @private
2320
- */
2321
- private executeFrame;
2322
- /**
2323
- * Run all global jobs from a job map.
2324
- * Catches and logs errors without stopping execution.
2325
- * @param {Map<string, GlobalJob>} jobs - The global jobs map to execute
2326
- * @param {number} timestamp - RAF timestamp in milliseconds
2327
- * @returns {void}
2328
- * @private
2329
- */
2330
- private runGlobalJobs;
2331
- /**
2332
- * Execute all jobs for a single root in sorted order.
2333
- * Rebuilds sorted job list if needed, then dispatches each job.
2334
- * Errors are caught and propagated via triggerError.
2335
- * @param {RootEntry} root - The root entry to tick
2336
- * @param {number} timestamp - RAF timestamp in milliseconds
2337
- * @param {number} delta - Time since last frame in seconds
2338
- * @returns {void}
2339
- * @private
2340
- */
2341
- private tickRoot;
2342
- /**
2343
- * Get the total number of registered jobs across all roots.
2344
- * Includes both per-root jobs and global before/after jobs.
2345
- * @returns {number} Total job count
2346
- */
2347
- getJobCount(): number;
2348
- /**
2349
- * Get all registered job IDs across all roots.
2350
- * Includes both per-root jobs and global before/after jobs.
2351
- * @returns {string[]} Array of all job IDs
2352
- */
2353
- getJobIds(): string[];
2354
- /**
2355
- * Get the number of registered roots (Canvas instances).
2356
- * @returns {number} Number of registered roots
2357
- */
2358
- getRootCount(): number;
2359
- /**
2360
- * Check if any user (non-system) jobs are registered in a specific phase.
2361
- * Used by the default render job to know if a user has taken over rendering.
2362
- *
2363
- * @param phase The phase to check
2364
- * @param rootId Optional root ID to check (checks all roots if not provided)
2365
- * @returns true if any user jobs exist in the phase
2366
- */
2367
- hasUserJobsInPhase(phase: string, rootId?: string): boolean;
2368
- /**
2369
- * Generate a unique root ID for automatic root registration.
2370
- * @returns {string} A unique root ID in the format 'root_N'
2371
- */
2372
- generateRootId(): string;
2373
- /**
2374
- * Generate a unique job ID.
2375
- * @returns {string} A unique job ID in the format 'job_N'
2376
- * @private
2377
- */
2378
- private generateJobId;
2379
- /**
2380
- * Normalize before/after constraints to a Set.
2381
- * Handles undefined, single string, or array inputs.
2382
- * @param {string | string[] | undefined} value - The constraint value(s)
2383
- * @returns {Set<string>} Normalized Set of constraint strings
2384
- * @private
2385
- */
2386
- private normalizeConstraints;
2387
- }
2388
- /**
2389
- * Get the global scheduler instance.
2390
- * Creates one if it doesn't exist.
2391
- */
2392
- declare const getScheduler: () => Scheduler;
2393
-
2394
- /**
2395
- * Frame hook with phase-based ordering, priority, and FPS throttling.
2396
- *
2397
- * Works both inside and outside Canvas context:
2398
- * - Inside Canvas: Full RootState (gl, scene, camera, etc.)
2399
- * - Outside Canvas (waiting mode): Waits for Canvas to mount, then gets full state
2400
- * - Outside Canvas (independent mode): Fires immediately with timing-only state
2401
- *
2402
- * Returns a controls object for manual stepping, pausing, and resuming.
2403
- *
2404
- * @param callback - Function called each frame with (state, delta). Optional if you only need scheduler access.
2405
- * @param priorityOrOptions - Either a priority number (backwards compat) or options object
2406
- * @returns Controls object with step(), stepAll(), pause(), resume(), isPaused, id, scheduler
2407
- *
2408
- * @example
2409
- * // Simple priority (backwards compat)
2410
- * useFrame((state, delta) => { ... }, 5)
2411
- *
2412
- * @example
2413
- * // With phase-based ordering
2414
- * useFrame((state, delta) => { ... }, { phase: 'physics' })
2415
- *
2416
- * @example
2417
- * // Outside Canvas - waits for Canvas to mount
2418
- * function UI() {
2419
- * useFrame((state, delta) => { syncUI(state.camera) });
2420
- * return <button>...</button>;
2421
- * }
2422
- *
2423
- * @example
2424
- * // Independent mode - no Canvas needed
2425
- * getScheduler().independent = true;
2426
- * useFrame((state, delta) => { updateGame(delta) });
2427
- *
2428
- * @example
2429
- * // Scheduler-only access (no callback)
2430
- * const { scheduler } = useFrame()
2431
- * scheduler.pauseJob('some-job-id')
2432
- *
2433
- * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useframe
2434
- */
2435
- declare function useFrame(callback?: FrameNextCallback, priorityOrOptions?: number | UseFrameNextOptions): FrameNextControls;
2436
-
2437
1692
  declare const IsObject: (url: unknown) => url is Record<string, string>;
2438
1693
  type TextureArray<T> = T extends string[] ? Texture$1[] : never;
2439
1694
  type TextureRecord<T> = T extends Record<string, string> ? {
@@ -2446,11 +1701,16 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
2446
1701
  /** Callback when texture(s) finish loading */
2447
1702
  onLoad?: (texture: MappedTextureType<Url>) => void;
2448
1703
  /**
2449
- * Cache the texture in R3F's global state for access via useTextures().
2450
- * When true:
1704
+ * Register the texture(s) in R3F's global texture registry for access via useTextures().
1705
+ * When true (the default):
2451
1706
  * - Textures persist until explicitly disposed
2452
- * - Returns existing cached textures if available (preserving modifications like colorSpace)
2453
- * @default false
1707
+ * - On mount, returns existing registered textures if available (preserving modifications like colorSpace)
1708
+ *
1709
+ * Reads are taken once at mount — a mounted `useTexture` does not re-render when the registry
1710
+ * changes. To react to registry swaps, use `useTextures(s => s.get(key))` instead.
1711
+ *
1712
+ * Pass `false` to opt out of registry enrollment entirely.
1713
+ * @default true
2454
1714
  */
2455
1715
  cache?: boolean;
2456
1716
  };
@@ -2474,15 +1734,18 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
2474
1734
  * normal: '/normal.png'
2475
1735
  * })
2476
1736
  *
2477
- * // With caching - returns same texture object across components
2478
- * // Modifications (colorSpace, wrapS, etc.) are preserved
2479
- * const diffuse = useTexture('/diffuse.png', { cache: true })
1737
+ * // Textures are registered in the global registry by default — the same texture
1738
+ * // object is shared across components and modifications (colorSpace, wrapS, etc.) are preserved
1739
+ * const diffuse = useTexture('/diffuse.png')
2480
1740
  * diffuse.colorSpace = THREE.SRGBColorSpace
2481
1741
  *
2482
1742
  * // Another component gets the SAME texture with colorSpace already set
2483
- * const sameDiffuse = useTexture('/diffuse.png', { cache: true })
1743
+ * const sameDiffuse = useTexture('/diffuse.png')
1744
+ *
1745
+ * // Opt out of registry enrollment for a one-off texture
1746
+ * const scratch = useTexture('/scratch.png', { cache: false })
2484
1747
  *
2485
- * // Access cache directly
1748
+ * // Access the registry directly
2486
1749
  * const { get } = useTextures()
2487
1750
  * const cached = get('/diffuse.png')
2488
1751
  * ```
@@ -2499,63 +1762,80 @@ declare const Texture: ({ children, input, onLoad, cache, }: {
2499
1762
  cache?: boolean;
2500
1763
  }) => react_jsx_runtime.JSX.Element;
2501
1764
 
2502
- type TextureEntry = Texture$1 | {
2503
- value: Texture$1;
2504
- [key: string]: any;
1765
+ /** Accepted shapes for a registry read: a single key, a list of keys, or a name→key map. */
1766
+ type TextureInput = string | string[] | Record<string, string>;
1767
+ /** Result of a `get()` read, mirroring the input shape. */
1768
+ type TextureResult<Input extends TextureInput> = Input extends string ? Texture$1 | undefined : Input extends string[] ? (Texture$1 | undefined)[] : {
1769
+ [K in keyof Input]: Texture$1 | undefined;
2505
1770
  };
1771
+ /** Options for `dispose()`. */
1772
+ interface DisposeOptions {
1773
+ /** Dispose even if the texture still has active references (default false). */
1774
+ force?: boolean;
1775
+ }
2506
1776
  interface UseTexturesReturn {
2507
- /** Map of all textures currently in cache */
2508
- textures: Map<string, TextureEntry>;
2509
- /** Get a specific texture by key (usually URL) */
2510
- get: (key: string) => TextureEntry | undefined;
2511
- /** Check if a texture exists in cache */
2512
- has: (key: string) => boolean;
2513
- /** Add a texture to the cache */
2514
- add: (key: string, value: TextureEntry) => void;
2515
- /** Add multiple textures to the cache */
2516
- addMultiple: (items: Map<string, TextureEntry> | Record<string, TextureEntry>) => void;
2517
- /** Remove a texture from cache (does NOT dispose GPU resources) */
2518
- remove: (key: string) => void;
2519
- /** Remove multiple textures from cache */
2520
- removeMultiple: (keys: string[]) => void;
2521
- /** Dispose a texture's GPU resources and remove from cache */
2522
- dispose: (key: string) => void;
2523
- /** Dispose multiple textures */
2524
- disposeMultiple: (keys: string[]) => void;
2525
- /** Dispose ALL cached textures - use with caution */
2526
- disposeAll: () => void;
1777
+ /** The live registry Map (key → Texture). Treat as read-only. */
1778
+ readonly all: Map<string, Texture$1>;
1779
+ /** Read one texture, an array of textures, or a name→texture record (mirrors the input shape). */
1780
+ get<Input extends TextureInput>(input: Input): TextureResult<Input>;
1781
+ /** Check whether a key exists in the registry. */
1782
+ has(key: string): boolean;
1783
+ /**
1784
+ * Register a texture (or a record of textures) that has no URL — e.g. a render
1785
+ * target or procedural texture. URL-loaded textures are registered automatically
1786
+ * by `useTexture` (registry enrollment is on by default).
1787
+ */
1788
+ add(key: string, texture: Texture$1): void;
1789
+ add(record: Record<string, Texture$1>): void;
1790
+ /**
1791
+ * Dispose a texture's GPU resources and remove it from the registry.
1792
+ * Refcount-aware: if the key is still in use by a mounted `useTexture` consumer it is
1793
+ * skipped (with a warning) unless `{ force: true }` is passed.
1794
+ * @returns true if disposed, false if skipped.
1795
+ */
1796
+ dispose(key: string, options?: DisposeOptions): boolean;
1797
+ /** Dispose every texture in the registry and clear it. Use on scene teardown. */
1798
+ disposeAll(): void;
2527
1799
  }
2528
1800
  /**
2529
- * Hook for managing the global texture cache in R3F state.
1801
+ * Reactive Texture registry — load once with `useTexture`, reach the textures from anywhere.
2530
1802
  *
2531
- * Textures are stored in a Map with URL/path keys for efficient lookup.
2532
- * Useful for sharing texture references across materials and components.
1803
+ * This is a registry of plain `Texture` objects (not TSL nodes), so the same texture can feed
1804
+ * a material map, a heightmap sampler, or anything else. It does **not** load — pair it with
1805
+ * `useTexture` for loading (registry enrollment is on by default); `useTextures` is for access and lifecycle.
1806
+ *
1807
+ * The returned handle is **reactive**: the calling component re-renders when the registry
1808
+ * changes. Pass a selector to scope the subscription to a single read.
2533
1809
  *
2534
1810
  * @example
2535
1811
  * ```tsx
2536
- * const { textures, add, get, remove, has, dispose } = useTextures()
2537
- *
2538
- * // Check if texture is already cached
2539
- * if (!has('/textures/diffuse.png')) {
2540
- * // Load with useTexture and cache: true, or manually add
2541
- * const tex = useTexture('/textures/diffuse.png', { cache: true })
2542
- * }
1812
+ * // Load + register once (anywhere in the tree) — registered by default
1813
+ * useTexture({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
2543
1814
  *
2544
- * // Access cached texture from anywhere
2545
- * const diffuse = get('/textures/diffuse.png')
2546
- * if (diffuse) material.map = diffuse
1815
+ * // Reach them from another component — record form lands straight into a material
1816
+ * const { map, normalMap } = useTextures().get({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
1817
+ * return <meshStandardMaterial map={map} normalMap={normalMap} />
2547
1818
  *
2548
- * // Remove from cache only (texture still in GPU memory)
2549
- * remove('/textures/old.png')
1819
+ * // A set of heightmaps at once
1820
+ * const [a, b, c] = useTextures().get(['/h0.png', '/h1.png', '/h2.png'])
2550
1821
  *
2551
- * // Fully dispose (frees GPU memory + removes from cache)
2552
- * dispose('/textures/unused.png')
1822
+ * // Register a non-URL texture (render target / procedural)
1823
+ * useTextures().add('rt-main', renderTarget.texture)
2553
1824
  *
2554
- * // Nuclear option - dispose everything
2555
- * disposeAll()
1825
+ * // Deliberate GPU cleanup (refcount-aware; force to override)
1826
+ * useTextures().dispose('/diffuse.jpg')
1827
+ * useTextures().disposeAll() // scene teardown
2556
1828
  * ```
1829
+ *
1830
+ * @remarks
1831
+ * **Future expansion:** an imperative async loader (e.g. `await useTextures().load('/x.jpg')`) is
1832
+ * intentionally not included yet. It would let non-React code (loading screens, dynamic streaming)
1833
+ * populate the registry without Suspense, at the cost of putting loading back into this hook. It
1834
+ * will be added only if a concrete consumer needs imperative loading; for now, loading lives in
1835
+ * `useTexture`.
2557
1836
  */
2558
1837
  declare function useTextures(): UseTexturesReturn;
1838
+ declare function useTextures<T>(selector: (registry: UseTexturesReturn) => T): T;
2559
1839
 
2560
1840
  /**
2561
1841
  * Creates a render target compatible with the current renderer.
@@ -2585,20 +1865,10 @@ declare function useTextures(): UseTexturesReturn;
2585
1865
  * const fbo = useRenderTarget(512, 256, { samples: 4 })
2586
1866
  * ```
2587
1867
  */
2588
- declare function useRenderTarget(options?: RenderTargetOptions): RenderTarget | WebGLRenderTarget;
2589
- declare function useRenderTarget(size: number, options?: RenderTargetOptions): RenderTarget | WebGLRenderTarget;
2590
- declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): RenderTarget | WebGLRenderTarget;
1868
+ declare function useRenderTarget(options?: RenderTargetOptions): RenderTarget;
1869
+ declare function useRenderTarget(size: number, options?: RenderTargetOptions): RenderTarget;
1870
+ declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): RenderTarget;
2591
1871
 
2592
- /**
2593
- * Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
2594
- * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
2595
- */
2596
- declare function useStore(): RootStore;
2597
- /**
2598
- * Accesses R3F's internal state, containing renderer, canvas, scene, etc.
2599
- * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usethree
2600
- */
2601
- declare function useThree<T = RootState>(selector?: (state: RootState) => T, equalityFn?: <T>(state: T, newState: T) => boolean): T;
2602
1872
  /**
2603
1873
  * Exposes an object's {@link Instance}.
2604
1874
  * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#useInstanceHandle
@@ -2674,7 +1944,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
2674
1944
  * Invalidates the view, requesting a frame to be rendered.
2675
1945
  * In demand mode, this triggers the scheduler to run frames.
2676
1946
  *
2677
- * @param state - Optional root state (ignored in new scheduler, kept for backwards compat)
1947
+ * With a state argument, only that root's jobs run on the requested frames; other
1948
+ * roots on 'demand' stay idle. Without one, every registered root is invalidated.
1949
+ *
1950
+ * @param state - Optional root state; targets the invalidation at that root
2678
1951
  * @param frames - Number of frames to request (default: 1)
2679
1952
  * @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
2680
1953
  *
@@ -2685,14 +1958,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
2685
1958
  * Advances the frameloop and runs render effects.
2686
1959
  * Useful for when manually rendering via `frameloop="never"`.
2687
1960
  *
1961
+ * With a state argument, only that root is stepped. Without one, every
1962
+ * registered root is stepped for backwards compatibility.
1963
+ *
2688
1964
  * @param timestamp - The timestamp to use for this frame
2689
1965
  * @param runGlobalEffects - Ignored (kept for backwards compat, global effects always run)
2690
- * @param state - Ignored (kept for backwards compat)
2691
- * @param frame - Ignored (kept for backwards compat)
1966
+ * @param state - Optional root state; targets the manual step at that root
2692
1967
  *
2693
1968
  * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
2694
1969
  */
2695
- declare function advance(timestamp: number): void;
1970
+ declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
2696
1971
 
2697
1972
  /* eslint-disable @definitelytyped/no-unnecessary-generics */
2698
1973
  declare function ReactReconciler<
@@ -3737,6 +3012,7 @@ declare namespace ReactReconciler {
3737
3012
 
3738
3013
  declare function extend<T extends ConstructorRepresentation>(objects: T): React$1.ExoticComponent<ThreeElement<T>>;
3739
3014
  declare function extend<T extends Catalogue>(objects: T): void;
3015
+ declare function extend(objects: Record<string, unknown>): void;
3740
3016
  declare const reconciler: ReactReconciler.Reconciler<RootStore, Instance<any>, void, Instance<any>, never, any>;
3741
3017
 
3742
3018
  declare const isRenderer: (def: any) => boolean;
@@ -3761,13 +3037,9 @@ declare function Portal({ children, container, state }: PortalProps): JSX.Elemen
3761
3037
  declare function flushSync<R>(fn: () => R): R;
3762
3038
 
3763
3039
  declare const context: React$1.Context<RootStore>;
3040
+
3764
3041
  declare const createStore: (invalidate: (state?: RootState, frames?: number, stackFrames?: boolean) => void, advance: (timestamp: number, runGlobalEffects?: boolean, state?: RootState, frame?: XRFrame) => void) => RootStore;
3765
3042
 
3766
- /**
3767
- * Safely flush async effects when testing, simulating a legacy root.
3768
- * @deprecated Import from React instead. import { act } from 'react'
3769
- */
3770
- declare const act: typeof React$1.act;
3771
3043
  /**
3772
3044
  * An SSR-friendly useLayoutEffect.
3773
3045
  *
@@ -4019,7 +3291,7 @@ declare function getInstanceProps<T = any>(pendingProps: Record<string, unknown>
4019
3291
  declare function prepare<T = any>(target: T, root: RootStore, type: string, props: Instance<T>['props']): Instance<T>;
4020
3292
  /**
4021
3293
  * Triggers an update for an instance.
4022
- * Calls onUpdate callback and invalidates the frame if necessary.
3294
+ * Invalidates the frame if the root is in demand mode.
4023
3295
  *
4024
3296
  * @param instance - Instance to invalidate
4025
3297
  */
@@ -4185,29 +3457,44 @@ declare const hasConstructor: (object: unknown) => object is {
4185
3457
  * Used to identify values that should be resolved from refs after mount.
4186
3458
  */
4187
3459
  declare const FROM_REF: unique symbol;
3460
+ /** The marker `fromRef()` returns; resolved by the reconciler in `commitMount`. */
3461
+ interface FromRefMarker<T = unknown, R = T> {
3462
+ [FROM_REF]: React$1.RefObject<T | null>;
3463
+ /** Optional transform applied to the resolved ref before assignment. */
3464
+ transform?: (value: T) => R;
3465
+ }
4188
3466
  /**
4189
3467
  * Defers prop application until the referenced object is available.
4190
3468
  * Useful for props like `target` that need sibling refs to be populated.
4191
3469
  *
3470
+ * Only top-level props on a three element are resolved: a marker nested inside another value
3471
+ * (an array, an options object) is never seen. When the prop needs the sibling *wrapped* rather
3472
+ * than assigned as-is, pass a `transform`; it runs once the ref is populated and its result is
3473
+ * what gets assigned.
3474
+ *
4192
3475
  * @param ref - React ref object to resolve at mount time
4193
- * @returns A marker value that applyProps will resolve after mount
3476
+ * @param transform - Optional mapping from the resolved object to the value the prop expects
3477
+ * @returns A marker value that the reconciler resolves after mount
4194
3478
  *
4195
3479
  * @example
4196
3480
  * const targetRef = useRef<THREE.Object3D>(null)
4197
3481
  *
4198
3482
  * <group ref={targetRef} position={[-3, -2, -15]} />
4199
3483
  * <spotLight target={fromRef(targetRef)} intensity={100} />
3484
+ *
3485
+ * @example
3486
+ * // Wrap the sibling: a node material's lightsNode needs a LightsNode, not the light itself
3487
+ * <meshPhongNodeMaterial lightsNode={fromRef(lightRef, (light) => lights([light]))} />
4200
3488
  */
4201
3489
  declare function fromRef<T>(ref: React$1.RefObject<T | null>): T;
3490
+ declare function fromRef<T, R>(ref: React$1.RefObject<T | null>, transform: (value: T) => R): R;
4202
3491
  /**
4203
3492
  * Type guard to check if a value is a fromRef marker.
4204
3493
  *
4205
3494
  * @param value - Value to check
4206
3495
  * @returns True if value is a fromRef marker
4207
3496
  */
4208
- declare function isFromRef(value: unknown): value is {
4209
- [FROM_REF]: React$1.RefObject<any>;
4210
- };
3497
+ declare function isFromRef(value: unknown): value is FromRefMarker<any, unknown>;
4211
3498
 
4212
3499
  /**
4213
3500
  * Symbol marker for mount-only method calls.
@@ -4234,7 +3521,15 @@ declare const ONCE: unique symbol;
4234
3521
  * // No arguments
4235
3522
  * <geometry center={once()} />
4236
3523
  */
4237
- declare function once<T>(...args: T[]): T;
3524
+ declare function once<A extends unknown[]>(...args: A): OnceValue<A>;
3525
+ /**
3526
+ * What `once(...args)` is typed as, so the marker is assignable to the prop it targets:
3527
+ * the single argument itself (`rotateX={once(angle)}`), the argument tuple for multi-argument
3528
+ * methods (`translate={once(x, y, z)}`), or `true` for a bare call (`center={once()}`).
3529
+ *
3530
+ * The runtime value is always the marker object; only the declared type follows the prop.
3531
+ */
3532
+ type OnceValue<A extends unknown[]> = A extends [] ? true : A extends [infer Single] ? Single : A;
4238
3533
  /**
4239
3534
  * Type guard to check if a value is a once marker.
4240
3535
  *
@@ -4246,229 +3541,21 @@ declare function isOnce(value: unknown): value is {
4246
3541
  };
4247
3542
 
4248
3543
  /**
4249
- * A DOM canvas which accepts threejs elements as children.
4250
- * @see https://docs.pmnd.rs/react-three-fiber/api/canvas
4251
- */
4252
- declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
4253
-
4254
- /**
4255
- * ScopedStore - Type-safe wrapper for nested stores (uniforms, nodes)
4256
- *
4257
- * Provides TypeScript-friendly access to uniform/node stores where the runtime
4258
- * structure is `Record<string, T | Record<string, T>>` (leaf nodes or nested scopes).
4259
- *
4260
- * The wrapper uses a Proxy to:
4261
- * 1. Return `T` for property access (type assumption: assumes leaf node)
4262
- * 2. Provide `.scope(key)` method for explicit nested access
4263
- * 3. Support iteration methods: has(), keys(), Object.keys(), for...in
4264
- *
4265
- * @example
4266
- * ```tsx
4267
- * useLocalNodes(({ uniforms }) => ({
4268
- * wobble: sin(uniforms.uTime.mul(2)), // No cast needed!
4269
- * playerHealth: uniforms.scope('player').uHealth // Explicit scope access
4270
- * }))
4271
- * ```
4272
- */
4273
-
4274
- /** Keys reserved for methods (excluded from index signature) */
4275
- type MethodKeys = 'scope' | 'has' | 'keys';
4276
- /**
4277
- * Type-safe wrapper interface for accessing nested store data.
4278
- * Property access returns `T` (assumes leaf node).
4279
- * Use `.scope(key)` for nested object access.
4280
- *
4281
- * Uses mapped type with key filtering to exclude method names from index signature,
4282
- * allowing methods to have their correct return types.
4283
- */
4284
- type ScopedStoreType<T> = {
4285
- /** Direct property access returns the leaf type T (method keys excluded) */
4286
- readonly [K in string as K extends MethodKeys ? never : K]: T;
4287
- } & {
4288
- /** Access a nested scope by key. Returns empty wrapper if scope doesn't exist. */
4289
- scope(key: string): ScopedStoreType<T>;
4290
- /** Check if a key exists in the store */
4291
- has(key: string): boolean;
4292
- /** Get all keys in the store */
4293
- keys(): string[];
4294
- };
4295
- /**
4296
- * Create a type-safe ScopedStore wrapper around store data.
4297
- * @param data - The raw store data (uniforms or nodes from RootState)
4298
- * @returns A ScopedStoreType wrapper with type-safe access
4299
- */
4300
- declare function createScopedStore<T>(data: Record<string, any>): ScopedStoreType<T>;
4301
- /**
4302
- * State type passed to creator functions with ScopedStore wrappers.
4303
- * Provides type-safe access to uniforms and nodes without manual casting.
4304
- */
4305
- type CreatorState = Omit<RootState, 'uniforms' | 'nodes'> & {
4306
- /** Type-safe uniform access - property access returns UniformNode */
4307
- uniforms: ScopedStoreType<UniformNode>;
4308
- /** Type-safe node access - property access returns TSLNodeType (Node | ShaderCallable | ShaderNodeObject) */
4309
- nodes: ScopedStoreType<TSLNodeType>;
4310
- };
4311
-
4312
- /** Creator function that returns uniform inputs (can be raw values or UniformNodes) */
4313
- type UniformCreator<T extends UniformInputRecord = UniformInputRecord> = (state: CreatorState) => T;
4314
- /** Function signature for removeUniforms util */
4315
- type RemoveUniformsFn = (names: string | string[], scope?: string) => void;
4316
- /** Function signature for clearUniforms util */
4317
- type ClearUniformsFn = (scope?: string) => void;
4318
- /** Function signature for rebuildUniforms util */
4319
- type RebuildUniformsFn = (scope?: string) => void;
4320
- /** Return type with utils included */
4321
- type UniformsWithUtils<T extends UniformRecord = UniformRecord> = T & {
4322
- removeUniforms: RemoveUniformsFn;
4323
- clearUniforms: ClearUniformsFn;
4324
- rebuildUniforms: RebuildUniformsFn;
4325
- };
4326
- declare function useUniforms(): UniformsWithUtils<UniformRecord & Record<string, UniformRecord>>;
4327
- declare function useUniforms(scope: string): UniformsWithUtils;
4328
- declare function useUniforms<T extends UniformInputRecord>(creator: UniformCreator<T>): UniformsWithUtils<UniformRecord<UniformNode>>;
4329
- declare function useUniforms<T extends UniformInputRecord>(creator: UniformCreator<T>, scope: string): UniformsWithUtils<UniformRecord<UniformNode>>;
4330
- declare function useUniforms<T extends UniformInputRecord>(uniforms: T): UniformsWithUtils<UniformRecord<UniformNode>>;
4331
- declare function useUniforms<T extends UniformInputRecord>(uniforms: T, scope: string): UniformsWithUtils<UniformRecord<UniformNode>>;
4332
- /**
4333
- * Global rebuildUniforms function for HMR integration.
4334
- * Clears cached uniforms and increments _hmrVersion to trigger re-creation.
4335
- * Call this when HMR is detected to refresh all uniform creators.
3544
+ * Re-export from core - useTextures is now a core R3F hook (a reactive Texture registry).
4336
3545
  *
4337
- * @param store - The R3F store (from useStore or context)
4338
- * @param scope - Optional scope to rebuild ('root' for root only, string for specific scope, undefined for all)
3546
+ * This file maintains backwards compatibility for existing webgpu imports.
4339
3547
  */
4340
- declare function rebuildAllUniforms(store: ReturnType<typeof useStore>, scope?: string): void;
4341
- /**
4342
- * Remove uniforms by name from root level or a scope
4343
- * @deprecated Use `const { removeUniforms } = useUniforms()` instead
4344
- */
4345
- declare function removeUniforms(set: ReturnType<typeof useStore>['setState'], names: string[], scope?: string): void;
4346
- /**
4347
- * Clear all uniforms from a scope (removes the entire scope object)
4348
- * @deprecated Use `const { clearUniforms } = useUniforms()` instead
4349
- */
4350
- declare function clearScope(set: ReturnType<typeof useStore>['setState'], scope: string): void;
4351
- /**
4352
- * Clear all root-level uniforms (preserves scopes)
4353
- * @deprecated Use `const { clearUniforms } = useUniforms()` with `clearUniforms('root')` instead
4354
- */
4355
- declare function clearRootUniforms(set: ReturnType<typeof useStore>['setState']): void;
4356
3548
 
4357
3549
  /**
4358
- * Supported uniform value types:
4359
- * - Raw values: number, boolean, Vector2, Vector3, Vector4, Color, Matrix3, Matrix4
4360
- * - String colors: '#ff0000', 'red', 'rgb(255,0,0)' (auto-converted to Color)
4361
- * - TSL nodes: color(), vec3(), float(), etc. (for type casting)
4362
- * - UniformNode: existing uniforms (reused as-is)
3550
+ * @deprecated The registry now stores plain `Texture` objects, not TSL nodes. Use `Texture` directly.
3551
+ * Kept as an alias for backwards compatibility.
4363
3552
  */
4364
- type UniformValue = number | boolean | string | Vector2$1 | Vector3$1 | Vector4$1 | Color$2 | Matrix3$1 | Matrix4$1 | Node | UniformNode;
3553
+ type TextureEntry = Texture$1;
4365
3554
  /**
4366
- * Widen literal types to their base types:
4367
- * - 0 → number
4368
- * - true → boolean
4369
- * - '#ff0000' → Color (string colors are converted to Color objects)
4370
- * - Node → Node (TSL nodes passed through for uniform type casting)
3555
+ * @deprecated The registry now stores plain `Texture` objects, not TSL nodes. Use `Texture` directly.
3556
+ * Kept as an alias for backwards compatibility.
4371
3557
  */
4372
- type Widen<T> = T extends number ? number : T extends boolean ? boolean : T extends string ? Color$2 : T;
4373
- declare function useUniform<T extends UniformValue>(name: string): UniformNode<T>;
4374
- declare function useUniform<T extends UniformValue>(name: string, value: T): UniformNode<Widen<T>>;
4375
-
4376
- /**
4377
- * Minimal interface for TSL nodes.
4378
- * Used instead of Three.js's Node type because the @types/three definitions
4379
- * have inconsistencies where OperatorNode, ConstNode, etc. don't properly
4380
- * extend Node with all required properties.
4381
- */
4382
- interface TSLNodeLike {
4383
- uuid?: string;
4384
- nodeType?: string | null;
4385
- /** label method for chaining - sets the node's label and returns self */
4386
- label?: ((label: string) => TSLNodeLike) | string;
4387
- setName?: (name: string) => this;
4388
- }
4389
- /** TSL node type - alias for compatibility */
4390
- type TSLNode = TSLNodeLike;
4391
- /**
4392
- * A record of TSL nodes - allows mixed node types (OperatorNode, ConstNode, etc.)
4393
- * Uses TSLNodeLike for broader compatibility with Three.js's TSL type definitions.
4394
- */
4395
- type NodeRecord<T extends TSLNodeLike = TSLNodeLike> = Record<string, T>;
4396
- /**
4397
- * Creator function that returns a record of nodes.
4398
- * Uses TSLNodeLike constraint to allow mixed node types
4399
- * (e.g., { n: OperatorNode; color: ConstNode<Color> }) to pass type checking.
4400
- */
4401
- type NodeCreator<T extends Record<string, TSLNodeLike>> = (state: CreatorState) => T;
4402
- /** Function signature for removeNodes util */
4403
- type RemoveNodesFn = (names: string | string[], scope?: string) => void;
4404
- /** Function signature for clearNodes util */
4405
- type ClearNodesFn = (scope?: string) => void;
4406
- /** Function signature for rebuildNodes util */
4407
- type RebuildNodesFn = (scope?: string) => void;
4408
- /** Return type with utils included */
4409
- type NodesWithUtils<T extends Record<string, TSLNodeLike> = Record<string, TSLNodeLike>> = T & {
4410
- removeNodes: RemoveNodesFn;
4411
- clearNodes: ClearNodesFn;
4412
- rebuildNodes: RebuildNodesFn;
4413
- };
4414
- declare function useNodes(): NodesWithUtils<Record<string, TSLNodeLike> & Record<string, Record<string, TSLNodeLike>>>;
4415
- declare function useNodes(scope: string): NodesWithUtils<Record<string, TSLNodeLike>>;
4416
- declare function useNodes<T extends Record<string, TSLNodeLike>>(creator: NodeCreator<T>): NodesWithUtils<T>;
4417
- declare function useNodes<T extends Record<string, TSLNodeLike>>(creator: NodeCreator<T>, scope: string): NodesWithUtils<T>;
4418
- /**
4419
- * Global rebuildNodes function for HMR integration.
4420
- * Clears cached nodes and increments _hmrVersion to trigger re-creation.
4421
- * Call this when HMR is detected to refresh all node creators.
4422
- *
4423
- * @param store - The R3F store (from useStore or context)
4424
- * @param scope - Optional scope to rebuild ('root' for root only, string for specific scope, undefined for all)
4425
- */
4426
- declare function rebuildAllNodes(store: ReturnType<typeof useStore>, scope?: string): void;
4427
- /**
4428
- * Remove nodes by name from root level or a scope
4429
- * @deprecated Use `const { removeNodes } = useNodes()` instead
4430
- */
4431
- declare function removeNodes(set: ReturnType<typeof useStore>['setState'], names: string[], scope?: string): void;
4432
- /**
4433
- * Clear all nodes from a scope (removes the entire scope object)
4434
- * @deprecated Use `const { clearNodes } = useNodes()` instead
4435
- */
4436
- declare function clearNodeScope(set: ReturnType<typeof useStore>['setState'], scope: string): void;
4437
- /**
4438
- * Clear all root-level nodes (preserves scopes)
4439
- * @deprecated Use `const { clearNodes } = useNodes()` with `clearNodes('root')` instead
4440
- */
4441
- declare function clearRootNodes(set: ReturnType<typeof useStore>['setState']): void;
4442
-
4443
- /** Creator receives CreatorState with ScopedStore wrappers for type-safe access. Returns any record. */
4444
- type LocalNodeCreator<T extends Record<string, unknown>> = (state: CreatorState) => T;
4445
- /**
4446
- * Creates local values that rebuild when uniforms, nodes, or textures change.
4447
- *
4448
- * Unlike `useNodes`, this does NOT register to the global store.
4449
- * Use for component-specific nodes/values that depend on shared resources.
4450
- *
4451
- * @example
4452
- * ```tsx
4453
- * // Destructure what you need from state
4454
- * const { wobble, uTime } = useLocalNodes(({ uniforms, nodes }) => ({
4455
- * wobble: sin(uniforms.uTime.mul(2)),
4456
- * uTime: uniforms.uTime, // can return uniforms too
4457
- * }))
4458
- *
4459
- * // Or access anything else from RootState
4460
- * const { scaled } = useLocalNodes(({ camera, nodes }) => ({
4461
- * scaled: nodes.basePos.mul(camera.zoom),
4462
- * }))
4463
- *
4464
- * // Type-safe uniform access
4465
- * const { colorNode } = useLocalNodes(({ uniforms }) => {
4466
- * const uValue = uniforms.myUniform as UniformNode<number>
4467
- * return { colorNode: mix(colorA, colorB, uValue) }
4468
- * })
4469
- * ```
4470
- */
4471
- declare function useLocalNodes<T extends Record<string, unknown>>(creator: LocalNodeCreator<T>): T;
3558
+ type TextureNode = Texture$1;
4472
3559
 
4473
3560
  interface TextureOperations {
4474
3561
  add: (key: string, value: any) => void;
@@ -4478,45 +3565,6 @@ interface TextureOperations {
4478
3565
  }
4479
3566
  declare function createTextureOperations(set: StoreApi<RootState>['setState']): TextureOperations;
4480
3567
 
4481
- /**
4482
- * Hook for managing WebGPU PostProcessing with automatic scenePass setup.
4483
- *
4484
- * Features:
4485
- * - Creates PostProcessing instance if not exists
4486
- * - Creates default scenePass (no MRT) automatically
4487
- * - Callbacks receive full RootState for flexibility
4488
- * - No auto-cleanup on unmount - use reset() for explicit cleanup
4489
- * - Scene/camera changes trigger scenePass recreation
4490
- *
4491
- * @param mainCB - Main callback to configure outputNode and create effect passes
4492
- * @param setupCB - Optional setup callback to configure MRT on scenePass
4493
- * @returns { passes, postProcessing, clearPasses, reset, rebuild }
4494
- *
4495
- * @example
4496
- * ```tsx
4497
- * // Simple effect
4498
- * usePostProcessing(({ postProcessing, passes }) => {
4499
- * postProcessing.outputNode = bloom(passes.scenePass.getTextureNode())
4500
- * })
4501
- *
4502
- * // With MRT setup
4503
- * usePostProcessing(
4504
- * ({ postProcessing, passes }) => {
4505
- * const beauty = passes.scenePass.getTextureNode().toInspector('Color')
4506
- * const vel = passes.scenePass.getTextureNode('velocity')
4507
- * postProcessing.outputNode = motionBlur(beauty, vel)
4508
- * },
4509
- * ({ passes }) => {
4510
- * passes.scenePass.setMRT(mrt({ output, velocity }))
4511
- * }
4512
- * )
4513
- *
4514
- * // Read-only access
4515
- * const { postProcessing, passes } = usePostProcessing()
4516
- * ```
4517
- */
4518
- declare function usePostProcessing(mainCB?: PostProcessingMainCallback, setupCB?: PostProcessingSetupCallback): UsePostProcessingReturn;
4519
-
4520
3568
  //* Renderer Props ========================================
4521
3569
 
4522
3570
  type WebGPUDefaultProps = Omit<WebGPURendererParameters, 'canvas'> & BaseRendererProps
@@ -4564,5 +3612,33 @@ interface WebGPURootState extends Omit<RootState, 'renderer' | 'gl' | 'internal'
4564
3612
  internal: WebGPUInternalState
4565
3613
  }
4566
3614
 
4567
- export { Block, Canvas, Environment, EnvironmentCube, EnvironmentMap, EnvironmentPortal, ErrorBoundary, FROM_REF, IsObject, ONCE, Portal, R3F_BUILD_LEGACY, R3F_BUILD_WEBGPU, REACT_INTERNAL_PROPS, RESERVED_PROPS, three_d as ReactThreeFiber, Scheduler, Texture, _roots, act, addAfterEffect, addEffect, addTail, advance, applyProps, attach, buildGraph, calculateDpr, clearNodeScope, clearRootNodes, clearRootUniforms, clearScope, context, createEvents, createPointerEvents, createPortal, createRoot, createScopedStore, createStore, createTextureOperations, detach, diffProps, dispose, createPointerEvents as events, extend, findInitialRoot, flushSync, fromRef, getInstanceProps, getPrimary, getPrimaryIds, getRootState, getScheduler, getUuidPrefix, hasConstructor, hasPrimary, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isFromRef, isObject3D, isOnce, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, once, prepare, presetsObj, rebuildAllNodes, rebuildAllUniforms, reconciler, registerPrimary, removeInteractivity, removeNodes, removeUniforms, resolve, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useLocalNodes, useMutableCallback, useNodes, usePostProcessing, useRenderTarget, useStore, useTexture, useTextures, useThree, useUniform, useUniforms, waitForPrimary };
4568
- export type { Act, AddPhaseOptions, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, ClearNodesFn, ClearUniformsFn, Color, ComputeFunction, ConstructorRepresentation, CreatorState, DefaultGLProps, DefaultRendererProps, Disposable, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameControls, FrameNextCallback, FrameNextControls, FrameNextState, FrameState, FrameTimingState, Frameloop, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, WebGPUInternalState as InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, LocalNodeCreator, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeCreator, NodeProps, NodeRecord, NodesWithUtils, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, WebGPUR3FRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, RebuildNodesFn, RebuildUniformsFn, ReconcilerRoot, RemoveNodesFn, RemoveUniformsFn, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootOptions, WebGPURootState as RootState, RootStore, SchedulerApi, ScopedStoreType, SetBlock, Size, Subscription, TSLNode, TSLNodeInput, TextureEntry, TextureOperations, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UniformCreator, UniformValue, UniformsWithUtils, UseFrameNextOptions, UseFrameOptions, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, WebGPUDefaultProps, WebGPUProps, WebGPUShadowConfig, XRManager };
3615
+ /**
3616
+ * @fileoverview WebGPU entry point - WebGPU only, no legacy WebGL
3617
+ *
3618
+ * This entry point is for apps that want to use ONLY WebGPURenderer.
3619
+ * Auto-extends THREE with WebGPU node materials (MeshBasicNodeMaterial, etc.)
3620
+ * The TSL resource hooks (useUniforms, useNodes, useRenderPipeline, ...) are in @react-three/tsl.
3621
+ *
3622
+ * Usage:
3623
+ * import { Canvas, useFrame } from '@react-three/fiber/webgpu'
3624
+ * import { useUniforms } from '@react-three/tsl'
3625
+ */
3626
+
3627
+ /** `useThree` narrowed to WebGPU state — `state.renderer` is a `WebGPURenderer`. */
3628
+ type UseThreeWebGPU = <T = WebGPURootState>(selector?: (state: WebGPURootState) => T, equalityFn?: <U>(state: U, newState: U) => boolean) => T;
3629
+ /** `useFrame` narrowed to WebGPU state — the callback's `state.renderer` is a `WebGPURenderer`. */
3630
+ type UseFrameWebGPU = (callback?: FrameCallback$1<WebGPURootState>, priorityOrOptions?: number | UseFrameNextOptions) => FrameNextControls;
3631
+ declare const useThree: UseThreeWebGPU;
3632
+ declare const useFrame: UseFrameWebGPU;
3633
+
3634
+ /** Canvas props on the WebGPU entry: `onCreated` receives `WebGPURootState`. */
3635
+ type WebGPUCanvasProps = Omit<CanvasProps, 'onCreated'> & {
3636
+ /** Callback after the canvas has rendered (but not yet committed); `state.renderer` is a `WebGPURenderer` */
3637
+ onCreated?: (state: WebGPURootState) => void;
3638
+ };
3639
+
3640
+ /** `Canvas` narrowed to WebGPU state — the same component, `onCreated` typed against `WebGPURootState`. */
3641
+ declare const Canvas: (props: WebGPUCanvasProps) => JSX.Element;
3642
+
3643
+ 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, createTextureOperations, detach, diffProps, dispose, createPointerEvents as events, extend, findInitialRoot, flushSync, fromRef, getInstanceProps, getPrimary, getPrimaryIds, getRootState, getUuidPrefix, hasConstructor, hasPrimary, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isFromRef, isObject3D, isOnce, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, once, prepare, presetsObj, 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 };
3644
+ export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, RootState as BaseRootState, Bridge, Camera, CameraProps, WebGPUCanvasProps as CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DisposeOptions, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, FromRefMarker, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, WebGPUInternalState as InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeProps, NonFunctionKeys, Object3DMethod, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, OnceValue, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, WebGPUR3FRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootExtension, WebGPURootState as RootState, RootStore, SetBlock, Size, Subscription, TSLNodeInput, TextureEntry, TextureInput, TextureNode, TextureOperations, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseFrameWebGPU, UseTextureOptions, UseTexturesReturn, UseThreeWebGPU, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, WebGPUCanvasProps, WebGPUDefaultProps, WebGPUProps, WebGPUShadowConfig, XRManager, XRPointerConfig };