@react-three/fiber 10.0.0-canary.aecbafb → 10.0.0-canary.b6c54f2

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,5 @@
1
1
  import * as three_webgpu from 'three/webgpu';
2
- import { RenderTarget, WebGPURenderer, Node, StorageTexture, Data3DTexture, CanvasTarget, ShaderNodeObject, Euler as Euler$2, Color as Color$2, ColorRepresentation as ColorRepresentation$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, Loader as Loader$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Object3D, Frustum, OrthographicCamera, WebGPURendererParameters } from 'three/webgpu';
2
+ import { CubeRenderTarget, RenderTarget, WebGPURenderer, Node, StorageTexture, Data3DTexture, CanvasTarget, ShaderNodeObject, Euler as Euler$2, Color as Color$2, ColorRepresentation as ColorRepresentation$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, Loader as Loader$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Object3D, Frustum, OrthographicCamera, WebGPURendererParameters } from 'three/webgpu';
3
3
  import { Inspector } from 'three/addons/inspector/Inspector.js';
4
4
  import * as THREE$1 from 'three';
5
5
  import { Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1 } from 'three';
@@ -7,6 +7,8 @@ import * as React$1 from 'react';
7
7
  import { ReactNode, Component, RefObject, JSX } from 'react';
8
8
  import { StoreApi } from 'zustand';
9
9
  import { UseBoundStoreWithEqualityFn } from 'zustand/traditional';
10
+ import { FrameTimingState, FrameCallback as FrameCallback$1, SchedulerApi, UseFrameNextOptions, FrameNextControls } from '@pmndrs/scheduler';
11
+ export { AddPhaseOptions, FrameControls, FrameNextControls, FrameTimingState, RootOptions, Scheduler, SchedulerApi, UseFrameNextOptions, UseFrameOptions, getScheduler } from '@pmndrs/scheduler';
10
12
  import { Options } from 'react-use-measure';
11
13
  import * as react_jsx_runtime from 'react/jsx-runtime';
12
14
  import { ThreeElement as ThreeElement$1, Euler as Euler$3 } from '@react-three/fiber';
@@ -47,12 +49,16 @@ type WebGLShadowMap = never;
47
49
 
48
50
  declare const WebGLRenderTarget: any;
49
51
 
52
+ declare const WebGLCubeRenderTarget: any;
53
+
50
54
  var THREE = /*#__PURE__*/_mergeNamespaces({
51
55
  __proto__: null,
56
+ CubeRenderTargetCompat: CubeRenderTarget,
52
57
  Inspector: Inspector,
53
58
  R3F_BUILD_LEGACY: R3F_BUILD_LEGACY,
54
59
  R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
55
60
  RenderTargetCompat: RenderTarget,
61
+ WebGLCubeRenderTarget: WebGLCubeRenderTarget,
56
62
  WebGLRenderTarget: WebGLRenderTarget,
57
63
  WebGLRenderer: WebGLRenderer,
58
64
  WebGLRendererParameters: WebGLRendererParameters,
@@ -294,228 +300,33 @@ interface VisibilityEntry {
294
300
  }
295
301
 
296
302
  //* Scheduler Types (useFrame) ==============================
303
+ //
304
+ // The generic, framework-agnostic scheduler types now live in @pmndrs/scheduler.
305
+ // This file re-exports them and layers r3f's RootState-aware frame state on top,
306
+ // so existing `#types` imports across the codebase keep resolving unchanged.
297
307
 
298
308
 
299
309
 
300
- // Public Options --------------------------------
301
-
302
- /**
303
- * Options for useFrame hook
304
- */
305
- interface UseFrameNextOptions {
306
- /** Optional stable id for the job. Auto-generated if not provided */
307
- id?: string
308
- /** Named phase to run in. Default: 'update' */
309
- phase?: string
310
- /** Run before this phase or job id */
311
- before?: string | string[]
312
- /** Run after this phase or job id */
313
- after?: string | string[]
314
- /** Priority within phase. Higher runs first. Default: 0 */
315
- priority?: number
316
- /** Max frames per second for this job */
317
- fps?: number
318
- /** If true, skip frames when behind. If false, try to catch up. Default: true */
319
- drop?: boolean
320
- /** Enable/disable without unregistering. Default: true */
321
- enabled?: boolean
322
- }
323
-
324
- /** Alias for UseFrameNextOptions */
325
- type UseFrameOptions = UseFrameNextOptions
310
+ // Frame State (r3f-specific) --------------------------------
326
311
 
327
312
  /**
328
- * Options for addPhase
329
- */
330
- interface AddPhaseOptions {
331
- /** Insert this phase before the specified phase */
332
- before?: string
333
- /** Insert this phase after the specified phase */
334
- after?: string
335
- }
336
-
337
- // Frame State --------------------------------
338
-
339
- /**
340
- * Timing-only state for independent/outside mode (no RootState)
341
- */
342
- interface FrameTimingState {
343
- /** High-resolution timestamp from RAF (ms) */
344
- time: number
345
- /** Time since last frame in seconds (for legacy compatibility with THREE.Clock) */
346
- delta: number
347
- /** Elapsed time since first frame in seconds (for legacy compatibility with THREE.Clock) */
348
- elapsed: number
349
- /** Incrementing frame counter */
350
- frame: number
351
- }
352
-
353
- /**
354
- * State passed to useFrame callbacks (extends RootState with timing)
313
+ * State passed to useFrame callbacks (extends RootState with timing).
355
314
  */
356
315
  interface FrameNextState extends RootState, FrameTimingState {}
357
316
 
358
317
  /** Alias for FrameNextState */
359
318
  type FrameState = FrameNextState
360
319
 
361
- // Root Options --------------------------------
362
-
363
- /**
364
- * Options for registerRoot
365
- */
366
- interface RootOptions {
367
- /** State provider for callbacks. Optional in independent mode. */
368
- getState?: () => any
369
- /** Error handler for job errors. Falls back to console.error if not provided. */
370
- onError?: (error: Error) => void
371
- }
372
-
373
- // Callback Types --------------------------------
320
+ // Callback Types (r3f-specific) --------------------------------
374
321
 
375
322
  /**
376
- * Callback function for useFrame
323
+ * Callback function for useFrame. Receives the full r3f RootState plus timing.
377
324
  */
378
- type FrameNextCallback = (state: FrameNextState, delta: number) => void
325
+ type FrameNextCallback = FrameCallback$1<RootState>
379
326
 
380
327
  /** Alias for FrameNextCallback */
381
328
  type FrameCallback = FrameNextCallback
382
329
 
383
- // Controls returned from useFrame --------------------------------
384
-
385
- /**
386
- * Controls object returned from useFrame hook
387
- */
388
- interface FrameNextControls {
389
- /** The job's unique ID */
390
- id: string
391
- /** Access to the global scheduler for frame loop control */
392
- scheduler: SchedulerApi
393
- /** Manually step this job only (bypasses FPS limiting) */
394
- step(timestamp?: number): void
395
- /** Manually step ALL jobs in the scheduler */
396
- stepAll(timestamp?: number): void
397
- /** Pause this job (set enabled=false) */
398
- pause(): void
399
- /** Resume this job (set enabled=true) */
400
- resume(): void
401
- /** Reactive paused state - automatically triggers re-render when changed */
402
- isPaused: boolean
403
- }
404
-
405
- /** Alias for FrameNextControls */
406
- type FrameControls = FrameNextControls
407
-
408
- // Scheduler Interface --------------------------------
409
-
410
- /**
411
- * Public interface for the global Scheduler
412
- */
413
- interface SchedulerApi {
414
- //* Phase Management --------------------------------
415
-
416
- /** Add a named phase to the scheduler */
417
- addPhase(name: string, options?: AddPhaseOptions): void
418
- /** Get the ordered list of phase names */
419
- readonly phases: string[]
420
- /** Check if a phase exists */
421
- hasPhase(name: string): boolean
422
-
423
- //* Root Management --------------------------------
424
-
425
- /** Register a root (Canvas) with the scheduler. Returns unsubscribe function. */
426
- registerRoot(id: string, options?: RootOptions): () => void
427
- /** Unregister a root */
428
- unregisterRoot(id: string): void
429
- /** Generate a unique root ID */
430
- generateRootId(): string
431
- /** Get the number of registered roots */
432
- getRootCount(): number
433
- /** Check if any root is registered and ready */
434
- readonly isReady: boolean
435
- /** Subscribe to root-ready event. Fires immediately if already ready. Returns unsubscribe. */
436
- onRootReady(callback: () => void): () => void
437
-
438
- //* Job Registration --------------------------------
439
-
440
- /** Register a job with the scheduler (returns unsubscribe function) */
441
- register(
442
- callback: FrameNextCallback,
443
- options?: {
444
- id?: string
445
- rootId?: string
446
- phase?: string
447
- before?: string | string[]
448
- after?: string | string[]
449
- priority?: number
450
- fps?: number
451
- drop?: boolean
452
- enabled?: boolean
453
- },
454
- ): () => void
455
- /** Update a job's options */
456
- updateJob(
457
- id: string,
458
- options: {
459
- priority?: number
460
- fps?: number
461
- drop?: boolean
462
- enabled?: boolean
463
- phase?: string
464
- before?: string | string[]
465
- after?: string | string[]
466
- },
467
- ): void
468
- /** Unregister a job by ID */
469
- unregister(id: string, rootId?: string): void
470
- /** Get the number of registered jobs */
471
- getJobCount(): number
472
- /** Get all job IDs */
473
- getJobIds(): string[]
474
-
475
- //* Global Jobs (for legacy addEffect/addAfterEffect) --------------------------------
476
-
477
- /** Register a global job (runs once per frame, not per-root). Returns unsubscribe function. */
478
- registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void
479
-
480
- //* Idle Callbacks (for legacy addTail) --------------------------------
481
-
482
- /** Register an idle callback (fires when loop stops). Returns unsubscribe function. */
483
- onIdle(callback: (timestamp: number) => void): () => void
484
-
485
- //* Frame Loop Control --------------------------------
486
-
487
- /** Start the scheduler loop */
488
- start(): void
489
- /** Stop the scheduler loop */
490
- stop(): void
491
- /** Check if the scheduler is running */
492
- readonly isRunning: boolean
493
- /** Get/set the frameloop mode ('always', 'demand', 'never') */
494
- frameloop: Frameloop
495
- /** Independent mode - runs without Canvas, callbacks receive timing-only state */
496
- independent: boolean
497
-
498
- //* Manual Stepping --------------------------------
499
-
500
- /** Manually step all jobs once (for frameloop='never' or testing) */
501
- step(timestamp?: number): void
502
- /** Manually step a single job by ID */
503
- stepJob(id: string, timestamp?: number): void
504
- /** Request frame(s) to be rendered (for frameloop='demand') */
505
- invalidate(frames?: number): void
506
-
507
- //* Per-Job Control --------------------------------
508
-
509
- /** Check if a job is paused */
510
- isJobPaused(id: string): boolean
511
- /** Pause a job */
512
- pauseJob(id: string): void
513
- /** Resume a job */
514
- resumeJob(id: string): void
515
- /** Subscribe to job state changes (for reactive isPaused). Returns unsubscribe function. */
516
- subscribeJobState(id: string, listener: () => void): () => void
517
- }
518
-
519
330
  //* Buffer Types (useBuffers) ========================================
520
331
 
521
332
  /**
@@ -691,7 +502,7 @@ interface InternalState {
691
502
  canvasTarget?: CanvasTarget
692
503
  /**
693
504
  * Whether multi-canvas rendering is active.
694
- * True when any canvas uses `target` prop to share a renderer.
505
+ * True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
695
506
  * When true, setCanvasTarget is called before each render.
696
507
  */
697
508
  isMultiCanvas?: boolean
@@ -789,8 +600,8 @@ interface RootState {
789
600
  setSize: (width?: number, height?: number, top?: number, left?: number) => void
790
601
  /** Shortcut to manual setting the pixel ratio */
791
602
  setDpr: (dpr: Dpr) => void
792
- /** Shortcut to setting frameloop flags */
793
- setFrameloop: (frameloop: Frameloop) => void
603
+ /** Shortcut to setting frameloop flags. No args resets to 'always'. */
604
+ setFrameloop: (frameloop?: Frameloop) => void
794
605
  /** Set error state to propagate to error boundary */
795
606
  setError: (error: Error | null) => void
796
607
  /** Current error state (null when no error) */
@@ -803,10 +614,12 @@ interface RootState {
803
614
  buffers: BufferStore
804
615
  /** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
805
616
  gpuStorage: StorageStore
806
- /** Global TSL texture nodes - use useTextures() hook for operations */
807
- textures: Map<string, any>
617
+ /** Global Texture registry (key → Texture, usually keyed by URL) - use useTextures() hook for access + lifecycle */
618
+ textures: Map<string, THREE$1.Texture>
619
+ /** Internal: refcount per texture key, driven by mounted useTexture consumers (registry enrollment is on by default) */
620
+ _textureRefs: Map<string, number>
808
621
  /** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
809
- renderPipeline: any | null // THREE.PostProcessing (will be THREE.RenderPipeline in future Three.js release)
622
+ renderPipeline: ThreeRenderPipeline | null
810
623
  /** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
811
624
  passes: Record<string, any>
812
625
  /** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
@@ -857,6 +670,20 @@ interface Renderer {
857
670
  render: (scene: THREE$1.Scene, camera: THREE$1.Camera) => any
858
671
  }
859
672
 
673
+ //* Color Management Config ==============================
674
+
675
+ /**
676
+ * Color management configuration shared by both WebGL and WebGPU renderers.
677
+ */
678
+ interface ColorManagementConfig {
679
+ /**
680
+ * Color space assigned to 8-bit input textures (color maps).
681
+ * Defaults to sRGB. Most textures are authored in sRGB.
682
+ * @default THREE.SRGBColorSpace
683
+ */
684
+ textureColorSpace?: THREE$1.ColorSpace
685
+ }
686
+
860
687
  //* WebGL Renderer Props ==============================
861
688
 
862
689
  type DefaultGLProps = Omit<THREE$1.WebGLRendererParameters, 'canvas'> & {
@@ -867,7 +694,7 @@ type GLProps =
867
694
  | Renderer
868
695
  | ((defaultProps: DefaultGLProps) => Renderer)
869
696
  | ((defaultProps: DefaultGLProps) => Promise<Renderer>)
870
- | Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters>
697
+ | (Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters> & ColorManagementConfig)
871
698
 
872
699
  //* WebGPU Renderer Props ==============================
873
700
 
@@ -893,9 +720,9 @@ interface CanvasSchedulerConfig {
893
720
  }
894
721
 
895
722
  /**
896
- * Extended renderer configuration for multi-canvas support.
723
+ * Extended renderer configuration for multi-canvas support and color management.
897
724
  */
898
- interface RendererConfigExtended {
725
+ interface RendererConfigExtended extends ColorManagementConfig {
899
726
  /** Share renderer from another canvas (WebGPU only) */
900
727
  primaryCanvas?: string
901
728
  /** Canvas-level scheduler options */
@@ -960,8 +787,6 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
960
787
  * @see https://threejs.org/docs/#api/en/renderers/WebGLRenderer.shadowMap
961
788
  */
962
789
  shadows?: boolean | 'basic' | 'percentage' | 'soft' | 'variance' | Partial<THREE$1.WebGLShadowMap>
963
- /** Color space assigned to 8-bit input textures (color maps). Defaults to sRGB. Most textures are authored in sRGB. */
964
- textureColorSpace?: THREE$1.ColorSpace
965
790
  /** Creates an orthographic camera */
966
791
  orthographic?: boolean
967
792
  /**
@@ -1087,8 +912,6 @@ interface Instance<O = any> {
1087
912
  attach?: AttachType<O>
1088
913
  previousAttach?: any
1089
914
  isHidden: boolean
1090
- /** Deferred ref props to apply in commitMount */
1091
- deferredRefs?: Array<{ prop: string; ref: React$1.RefObject<any> }>
1092
915
  /** Set of props that have been applied via once() */
1093
916
  appliedOnce?: Set<string>
1094
917
  }
@@ -1214,7 +1037,7 @@ interface CanvasProps
1214
1037
  */
1215
1038
  resize?: Options
1216
1039
  /** The target where events are being subscribed to, default: the div that wraps canvas */
1217
- eventSource?: HTMLElement | React$1.RefObject<HTMLElement>
1040
+ eventSource?: HTMLElement | React$1.RefObject<HTMLElement | null>
1218
1041
  /** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
1219
1042
  eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
1220
1043
  /** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
@@ -1325,10 +1148,21 @@ type RenderTargetOptions = RenderTargetOptions$1
1325
1148
  //* Global Types ==============================
1326
1149
 
1327
1150
  declare global {
1328
- /** Uniform node type - a Node with a value property (matches Three.js UniformNode) */
1329
- interface UniformNode<T = unknown> extends Node {
1330
- value: T
1331
- }
1151
+ /**
1152
+ * Uniform node type.
1153
+ *
1154
+ * This is three's own `UniformNode`, not a re-declaration of it. It previously was a
1155
+ * hand-rolled `interface UniformNode<T> extends Node { value: T }`, which shadowed the real
1156
+ * exported type globally — so R3F's ~58 references resolved to an approximation that was
1157
+ * missing members three actually ships (`setName` among them) and had drifted to the wrong
1158
+ * arity when three made `UniformNode` two-parameter.
1159
+ *
1160
+ * three's signature is `UniformNode<TNodeType, TValue>`. R3F only ever varies the value type,
1161
+ * so the node type is fixed to `unknown` and the single parameter is kept for call-site
1162
+ * ergonomics. The result is three's structural type, so members stay in sync with the
1163
+ * installed three instead of needing to be mirrored by hand.
1164
+ */
1165
+ type UniformNode<T = unknown> = three_webgpu.UniformNode<unknown, T>
1332
1166
 
1333
1167
  /**
1334
1168
  * ShaderCallable - the return type of Fn()
@@ -1473,13 +1307,14 @@ declare module 'three/tsl' {
1473
1307
  ): ShaderCallable<R>
1474
1308
  }
1475
1309
 
1476
- /**
1477
- * RenderPipeline Types for useRenderPipeline hook (WebGPU only)
1478
- */
1479
-
1480
-
1481
-
1482
1310
  declare global {
1311
+ /**
1312
+ * three's own render pipeline type. Named here so the rest of R3F refers to three's shape
1313
+ * rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
1314
+ * is r185, so the new name is the only one.
1315
+ */
1316
+ type ThreeRenderPipeline = three_webgpu.RenderPipeline
1317
+
1483
1318
  /** Pass record - stores TSL pass nodes for render pipeline */
1484
1319
  type PassRecord = Record<string, any>
1485
1320
 
@@ -1494,7 +1329,7 @@ declare global {
1494
1329
  /** Current passes from state */
1495
1330
  passes: PassRecord
1496
1331
  /** RenderPipeline instance (null if not initialized) */
1497
- renderPipeline: any | null // THREE.PostProcessing (will be THREE.RenderPipeline in future Three.js release)
1332
+ renderPipeline: ThreeRenderPipeline | null
1498
1333
  /** Clear all passes from state */
1499
1334
  clearPasses: () => void
1500
1335
  /** Reset RenderPipeline entirely (clears PP + passes) */
@@ -1506,146 +1341,6 @@ declare global {
1506
1341
  }
1507
1342
  }
1508
1343
 
1509
- //* useFrameNext Types ==============================
1510
-
1511
-
1512
-
1513
- //* Global Type Declarations ==============================
1514
-
1515
- declare global {
1516
- // Job --------------------------------
1517
-
1518
- /**
1519
- * Internal job representation in the scheduler
1520
- */
1521
- interface Job {
1522
- /** Unique identifier */
1523
- id: string
1524
- /** The callback to execute */
1525
- callback: FrameNextCallback
1526
- /** Phase this job belongs to */
1527
- phase: string
1528
- /** Run before these phases/job ids */
1529
- before: Set<string>
1530
- /** Run after these phases/job ids */
1531
- after: Set<string>
1532
- /** Priority within phase (higher first) */
1533
- priority: number
1534
- /** Insertion order for deterministic tie-breaking */
1535
- index: number
1536
- /** Max FPS for this job (undefined = no limit) */
1537
- fps?: number
1538
- /** Drop frames when behind (true) or catch up (false) */
1539
- drop: boolean
1540
- /** Last run timestamp (ms) */
1541
- lastRun?: number
1542
- /** Whether job is enabled */
1543
- enabled: boolean
1544
- /** Internal flag: system jobs (like default render) don't block user render takeover */
1545
- system?: boolean
1546
- }
1547
-
1548
- // Phase Graph --------------------------------
1549
-
1550
- /**
1551
- * A node in the phase graph
1552
- */
1553
- interface PhaseNode {
1554
- /** Phase name */
1555
- name: string
1556
- /** Whether this was auto-generated from a before/after constraint */
1557
- isAutoGenerated: boolean
1558
- }
1559
-
1560
- /**
1561
- * Options for creating a job from hook options
1562
- */
1563
- interface JobOptions {
1564
- id?: string
1565
- phase?: string
1566
- before?: string | string[]
1567
- after?: string | string[]
1568
- priority?: number
1569
- fps?: number
1570
- drop?: boolean
1571
- enabled?: boolean
1572
- }
1573
-
1574
- // Frame Loop State --------------------------------
1575
-
1576
- /**
1577
- * Internal frame loop state
1578
- */
1579
- interface FrameLoopState {
1580
- /** Whether the loop is running */
1581
- running: boolean
1582
- /** Current RAF handle */
1583
- rafHandle: number | null
1584
- /** Last frame timestamp in ms (null = uninitialized) */
1585
- lastTime: number | null
1586
- /** Frame counter */
1587
- frameCount: number
1588
- /** Elapsed time since first frame in ms */
1589
- elapsedTime: number
1590
- /** createdAt timestamp in ms */
1591
- createdAt: number
1592
- }
1593
-
1594
- // Root Entry --------------------------------
1595
-
1596
- /**
1597
- * Internal representation of a registered root (Canvas).
1598
- * Tracks jobs and manages rebuild state for this root.
1599
- * @internal
1600
- */
1601
- interface RootEntry {
1602
- /** Unique identifier for this root */
1603
- id: string
1604
- /** Function to get the root's current state. Returns any to support independent mode. */
1605
- getState: () => any
1606
- /** Map of job IDs to Job objects */
1607
- jobs: Map<string, Job>
1608
- /** Cached sorted job list for execution order */
1609
- sortedJobs: Job[]
1610
- /** Whether sortedJobs needs rebuilding */
1611
- needsRebuild: boolean
1612
- }
1613
-
1614
- /**
1615
- * Internal representation of a global job (deprecated API).
1616
- * Global jobs run once per frame, not per-root.
1617
- * Used by legacy addEffect/addAfterEffect APIs.
1618
- * @internal
1619
- * @deprecated Use useFrame with phases instead
1620
- */
1621
- interface GlobalJob {
1622
- /** Unique identifier for this global job */
1623
- id: string
1624
- /** Callback invoked with RAF timestamp in ms */
1625
- callback: (timestamp: number) => void
1626
- }
1627
-
1628
- // HMR Support --------------------------------
1629
-
1630
- /**
1631
- * Hot Module Replacement data structure for preserving scheduler state
1632
- * @internal
1633
- */
1634
- interface HMRData {
1635
- /** Shared data object for storing values across reloads */
1636
- data: Record<string, any>
1637
- /** Optional function to accept HMR updates */
1638
- accept?: () => void
1639
- }
1640
-
1641
- // Default Phases --------------------------------
1642
-
1643
- /**
1644
- * Default phase names for the scheduler
1645
- */
1646
- type DefaultPhase = 'start' | 'input' | 'physics' | 'update' | 'render' | 'finish'
1647
- }
1648
-
1649
1344
  type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
1650
1345
 
1651
1346
  interface MathRepresentation {
@@ -1815,7 +1510,7 @@ declare namespace three_d {
1815
1510
  * a single WebGPURenderer using Three.js CanvasTarget API.
1816
1511
  *
1817
1512
  * Primary canvas: Has `id` prop, creates its own renderer, registers here
1818
- * Secondary canvas: Has `target="id"` prop, shares primary's renderer via CanvasTarget
1513
+ * Secondary canvas: Has `renderer={{ primaryCanvas: 'id' }}`, shares primary's renderer via CanvasTarget
1819
1514
  */
1820
1515
 
1821
1516
  interface PrimaryCanvasEntry {
@@ -1883,12 +1578,23 @@ type EnvironmentLoaderProps = {
1883
1578
  * const texture = useEnvironment({ preset: 'sunset' })
1884
1579
  * ```
1885
1580
  */
1886
- declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown> | CubeTexture;
1581
+ declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown, THREE$1.TextureEventMap> | CubeTexture<unknown>;
1887
1582
  declare namespace useEnvironment {
1888
1583
  var preload: (preloadOptions?: EnvironmentLoaderPreloadOptions) => void;
1889
1584
  var clear: (clearOptions?: EnvironmentLoaderClearOptions) => void;
1890
1585
  }
1891
- type EnvironmentLoaderPreloadOptions = Omit<EnvironmentLoaderProps, 'encoding'>;
1586
+ /**
1587
+ * Options accepted by `useEnvironment.preload`.
1588
+ *
1589
+ * `colorSpace` is deliberately omitted: preload only warms the loader cache, and colorSpace is
1590
+ * applied to the texture by `useEnvironment()` at use time, per consumer. Accepting it here would
1591
+ * advertise an option this function silently ignores.
1592
+ *
1593
+ * This previously read `Omit<…, 'encoding'>` — omitting a key that does not exist on
1594
+ * `EnvironmentLoaderProps`, a leftover from three's pre-`colorSpace` `encoding` API. That made the
1595
+ * type equivalent to the full props, so `colorSpace` was accepted and then dropped on the floor.
1596
+ */
1597
+ type EnvironmentLoaderPreloadOptions = Omit<EnvironmentLoaderProps, 'colorSpace'>;
1892
1598
  type EnvironmentLoaderClearOptions = Pick<EnvironmentLoaderProps, 'files' | 'preset'>;
1893
1599
 
1894
1600
  /**
@@ -2138,383 +1844,21 @@ declare function getLoader<L extends LoaderLike | ConstructorRepresentation<Load
2138
1844
  * Note: this hook's caller must be wrapped with `React.Suspense`
2139
1845
  * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useloader
2140
1846
  */
2141
- 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>;
1847
+ 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>;
2142
1848
  declare namespace useLoader {
2143
- var preload: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void) => void;
2144
- var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I) => void;
1849
+ 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;
1850
+ var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, cacheKey?: InputLike) => void;
2145
1851
  var loader: typeof getLoader;
2146
1852
  }
2147
1853
 
2148
- /**
2149
- * Global Singleton Scheduler - manages the frame loop and job execution for ALL R3F roots.
2150
- *
2151
- * Features:
2152
- * - Single RAF loop for entire application
2153
- * - Root registration (multiple Canvas support)
2154
- * - Global phases for addEffect/addAfterEffect (deprecated)
2155
- * - Per-root job management with phases, priorities, FPS throttling
2156
- * - onIdle callbacks for addTail (deprecated)
2157
- * - Demand mode support via invalidate()
2158
- */
2159
- declare class Scheduler {
2160
- private static readonly INSTANCE_KEY;
2161
- private static get instance();
2162
- private static set instance(value);
2163
- /**
2164
- * Get the global scheduler instance (creates if doesn't exist).
2165
- * Uses HMR data to preserve instance across hot reloads.
2166
- * @returns {Scheduler} The singleton scheduler instance
2167
- */
2168
- static get(): Scheduler;
2169
- /**
2170
- * Reset the singleton instance. Stops the loop and clears all state.
2171
- * Primarily used for testing to ensure clean state between tests.
2172
- * @returns {void}
2173
- */
2174
- static reset(): void;
2175
- private roots;
2176
- private phaseGraph;
2177
- private loopState;
2178
- private stoppedTime;
2179
- private nextRootIndex;
2180
- private globalBeforeJobs;
2181
- private globalAfterJobs;
2182
- private nextGlobalIndex;
2183
- private idleCallbacks;
2184
- private nextJobIndex;
2185
- private jobStateListeners;
2186
- private pendingFrames;
2187
- private _frameloop;
2188
- private _independent;
2189
- private errorHandler;
2190
- private rootReadyCallbacks;
2191
- get phases(): string[];
2192
- get frameloop(): Frameloop;
2193
- set frameloop(mode: Frameloop);
2194
- get isRunning(): boolean;
2195
- get isReady(): boolean;
2196
- get independent(): boolean;
2197
- set independent(value: boolean);
2198
- constructor();
2199
- /**
2200
- * Register a root (Canvas) with the scheduler.
2201
- * The first root to register starts the RAF loop (if frameloop='always').
2202
- * @param {string} id - Unique identifier for this root
2203
- * @param {RootOptions} [options] - Optional configuration with getState and onError callbacks
2204
- * @returns {() => void} Unsubscribe function to remove this root
2205
- */
2206
- registerRoot(id: string, options?: RootOptions): () => void;
2207
- /**
2208
- * Unregister a root from the scheduler.
2209
- * Cleans up all job state listeners for this root's jobs.
2210
- * The last root to unregister stops the RAF loop.
2211
- * @param {string} id - The root ID to unregister
2212
- * @returns {void}
2213
- */
2214
- unregisterRoot(id: string): void;
2215
- /**
2216
- * Subscribe to be notified when a root becomes available.
2217
- * Fires immediately if a root already exists.
2218
- * @param {() => void} callback - Function called when first root registers
2219
- * @returns {() => void} Unsubscribe function
2220
- */
2221
- onRootReady(callback: () => void): () => void;
2222
- /**
2223
- * Notify all registered root-ready callbacks.
2224
- * Called when the first root registers.
2225
- * @returns {void}
2226
- * @private
2227
- */
2228
- private notifyRootReady;
2229
- /**
2230
- * Ensure a default root exists for independent mode.
2231
- * Creates a minimal root with no state provider.
2232
- * @returns {void}
2233
- * @private
2234
- */
2235
- private ensureDefaultRoot;
2236
- /**
2237
- * Trigger error handling for job errors.
2238
- * Uses the bound error handler if available, otherwise logs to console.
2239
- * @param {Error} error - The error to handle
2240
- * @returns {void}
2241
- */
2242
- triggerError(error: Error): void;
2243
- /**
2244
- * Add a named phase to the scheduler's execution order.
2245
- * Marks all roots for rebuild to incorporate the new phase.
2246
- * @param {string} name - The phase name (e.g., 'physics', 'postprocess')
2247
- * @param {AddPhaseOptions} [options] - Positioning options (before/after other phases)
2248
- * @returns {void}
2249
- * @example
2250
- * scheduler.addPhase('physics', { before: 'update' });
2251
- * scheduler.addPhase('postprocess', { after: 'render' });
2252
- */
2253
- addPhase(name: string, options?: AddPhaseOptions): void;
2254
- /**
2255
- * Check if a phase exists in the scheduler.
2256
- * @param {string} name - The phase name to check
2257
- * @returns {boolean} True if the phase exists
2258
- */
2259
- hasPhase(name: string): boolean;
2260
- /**
2261
- * Register a global job that runs once per frame (not per-root).
2262
- * Used internally by deprecated addEffect/addAfterEffect APIs.
2263
- * @param {'before' | 'after'} phase - When to run: 'before' all roots or 'after' all roots
2264
- * @param {string} id - Unique identifier for this global job
2265
- * @param {(timestamp: number) => void} callback - Function called each frame with RAF timestamp
2266
- * @returns {() => void} Unsubscribe function to remove this global job
2267
- * @deprecated Use useFrame with phases instead
2268
- */
2269
- registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void;
2270
- /**
2271
- * Register an idle callback that fires when the loop stops.
2272
- * Used internally by deprecated addTail API.
2273
- * @param {(timestamp: number) => void} callback - Function called when loop becomes idle
2274
- * @returns {() => void} Unsubscribe function to remove this idle callback
2275
- * @deprecated Use demand mode with invalidate() instead
2276
- */
2277
- onIdle(callback: (timestamp: number) => void): () => void;
2278
- /**
2279
- * Notify all registered idle callbacks.
2280
- * Called when the loop stops in demand mode.
2281
- * @param {number} timestamp - The RAF timestamp when idle occurred
2282
- * @returns {void}
2283
- * @private
2284
- */
2285
- private notifyIdle;
2286
- /**
2287
- * Register a job (frame callback) with a specific root.
2288
- * This is the core registration method used by useFrame internally.
2289
- * @param {FrameNextCallback} callback - The function to call each frame
2290
- * @param {JobOptions & { rootId?: string; system?: boolean }} [options] - Job configuration
2291
- * @param {string} [options.rootId] - Target root ID (defaults to first registered root)
2292
- * @param {string} [options.id] - Unique job ID (auto-generated if not provided)
2293
- * @param {string} [options.phase] - Execution phase (defaults to 'update')
2294
- * @param {number} [options.priority] - Priority within phase (higher = earlier, default 0)
2295
- * @param {number} [options.fps] - FPS throttle limit
2296
- * @param {boolean} [options.drop] - Drop frames when behind (default true)
2297
- * @param {boolean} [options.enabled] - Whether job is active (default true)
2298
- * @param {boolean} [options.system] - Internal flag for system jobs (not user-facing)
2299
- * @returns {() => void} Unsubscribe function to remove this job
2300
- */
2301
- register(callback: FrameNextCallback, options?: JobOptions & {
2302
- rootId?: string;
2303
- system?: boolean;
2304
- }): () => void;
2305
- /**
2306
- * Unregister a job by its ID.
2307
- * Searches all roots if rootId is not provided.
2308
- * @param {string} id - The job ID to unregister
2309
- * @param {string} [rootId] - Optional root ID to search (searches all if not provided)
2310
- * @returns {void}
2311
- */
2312
- unregister(id: string, rootId?: string): void;
2313
- /**
2314
- * Update a job's options dynamically.
2315
- * Searches all roots to find the job by ID.
2316
- * Phase/constraint changes trigger a rebuild of the sorted job list.
2317
- * @param {string} id - The job ID to update
2318
- * @param {Partial<JobOptions>} options - The options to update
2319
- * @returns {void}
2320
- */
2321
- updateJob(id: string, options: Partial<JobOptions>): void;
2322
- /**
2323
- * Check if a job is currently paused (disabled).
2324
- * @param {string} id - The job ID to check
2325
- * @returns {boolean} True if the job exists and is paused
2326
- */
2327
- isJobPaused(id: string): boolean;
2328
- /**
2329
- * Subscribe to state changes for a specific job.
2330
- * Listener is called when job is paused or resumed.
2331
- * @param {string} id - The job ID to subscribe to
2332
- * @param {() => void} listener - Callback invoked on state changes
2333
- * @returns {() => void} Unsubscribe function
2334
- */
2335
- subscribeJobState(id: string, listener: () => void): () => void;
2336
- /**
2337
- * Notify all listeners that a job's state has changed.
2338
- * @param {string} id - The job ID that changed
2339
- * @returns {void}
2340
- * @private
2341
- */
2342
- private notifyJobStateChange;
2343
- /**
2344
- * Pause a job by ID (sets enabled=false).
2345
- * Notifies any subscribed state listeners.
2346
- * @param {string} id - The job ID to pause
2347
- * @returns {void}
2348
- */
2349
- pauseJob(id: string): void;
2350
- /**
2351
- * Resume a paused job by ID (sets enabled=true).
2352
- * Resets job timing to prevent frame accumulation.
2353
- * Notifies any subscribed state listeners.
2354
- * @param {string} id - The job ID to resume
2355
- * @returns {void}
2356
- */
2357
- resumeJob(id: string): void;
2358
- /**
2359
- * Start the requestAnimationFrame loop.
2360
- * Resets timing state (elapsedTime, frameCount) on start.
2361
- * No-op if already running.
2362
- * @returns {void}
2363
- */
2364
- start(): void;
2365
- /**
2366
- * Stop the requestAnimationFrame loop.
2367
- * Cancels any pending RAF callback.
2368
- * No-op if not running.
2369
- * @returns {void}
2370
- */
2371
- stop(): void;
2372
- /**
2373
- * Request frames to be rendered in demand mode.
2374
- * Accumulates pending frames (capped at 60) and starts the loop if not running.
2375
- * No-op if frameloop is not 'demand'.
2376
- * @param {number} [frames=1] - Number of frames to request
2377
- * @param {boolean} [stackFrames=false] - Whether to add frames to existing pending count
2378
- * - `false` (default): Sets pending frames to the specified value (replaces existing count)
2379
- * - `true`: Adds frames to existing pending count (useful for accumulating invalidations)
2380
- * @returns {void}
2381
- * @example
2382
- * // Request a single frame render
2383
- * scheduler.invalidate();
2384
- *
2385
- * @example
2386
- * // Request 5 frames (e.g., for animations)
2387
- * scheduler.invalidate(5);
2388
- *
2389
- * @example
2390
- * // Set pending frames to exactly 3 (don't stack with existing)
2391
- * scheduler.invalidate(3, false);
2392
- *
2393
- * @example
2394
- * // Add 2 more frames to existing pending count
2395
- * scheduler.invalidate(2, true);
2396
- */
2397
- invalidate(frames?: number, stackFrames?: boolean): void;
2398
- /**
2399
- * Reset timing state for deterministic testing.
2400
- * Preserves jobs and roots but resets lastTime, frameCount, elapsedTime, etc.
2401
- * @returns {void}
2402
- */
2403
- resetTiming(): void;
2404
- /**
2405
- * Manually execute a single frame for all roots.
2406
- * Useful for frameloop='never' mode or testing scenarios.
2407
- * @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
2408
- * @returns {void}
2409
- * @example
2410
- * // Manual control mode
2411
- * scheduler.frameloop = 'never';
2412
- * scheduler.step(); // Execute one frame
2413
- */
2414
- step(timestamp?: number): void;
2415
- /**
2416
- * Manually execute a single job by its ID.
2417
- * Useful for testing individual job callbacks in isolation.
2418
- * @param {string} id - The job ID to step
2419
- * @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
2420
- * @returns {void}
2421
- */
2422
- stepJob(id: string, timestamp?: number): void;
2423
- /**
2424
- * Main RAF loop callback.
2425
- * Executes frame, handles demand mode, and schedules next frame.
2426
- * @param {number} timestamp - RAF timestamp in milliseconds
2427
- * @returns {void}
2428
- * @private
2429
- */
2430
- private loop;
2431
- /**
2432
- * Execute a single frame across all roots.
2433
- * Order: globalBefore → each root's jobs → globalAfter
2434
- * @param {number} timestamp - RAF timestamp in milliseconds
2435
- * @returns {void}
2436
- * @private
2437
- */
2438
- private executeFrame;
2439
- /**
2440
- * Run all global jobs from a job map.
2441
- * Catches and logs errors without stopping execution.
2442
- * @param {Map<string, GlobalJob>} jobs - The global jobs map to execute
2443
- * @param {number} timestamp - RAF timestamp in milliseconds
2444
- * @returns {void}
2445
- * @private
2446
- */
2447
- private runGlobalJobs;
2448
- /**
2449
- * Execute all jobs for a single root in sorted order.
2450
- * Rebuilds sorted job list if needed, then dispatches each job.
2451
- * Errors are caught and propagated via triggerError.
2452
- * @param {RootEntry} root - The root entry to tick
2453
- * @param {number} timestamp - RAF timestamp in milliseconds
2454
- * @param {number} delta - Time since last frame in seconds
2455
- * @returns {void}
2456
- * @private
2457
- */
2458
- private tickRoot;
2459
- /**
2460
- * Get the total number of registered jobs across all roots.
2461
- * Includes both per-root jobs and global before/after jobs.
2462
- * @returns {number} Total job count
2463
- */
2464
- getJobCount(): number;
2465
- /**
2466
- * Get all registered job IDs across all roots.
2467
- * Includes both per-root jobs and global before/after jobs.
2468
- * @returns {string[]} Array of all job IDs
2469
- */
2470
- getJobIds(): string[];
2471
- /**
2472
- * Get the number of registered roots (Canvas instances).
2473
- * @returns {number} Number of registered roots
2474
- */
2475
- getRootCount(): number;
2476
- /**
2477
- * Check if any user (non-system) jobs are registered in a specific phase.
2478
- * Used by the default render job to know if a user has taken over rendering.
2479
- *
2480
- * @param phase The phase to check
2481
- * @param rootId Optional root ID to check (checks all roots if not provided)
2482
- * @returns true if any user jobs exist in the phase
2483
- */
2484
- hasUserJobsInPhase(phase: string, rootId?: string): boolean;
2485
- /**
2486
- * Generate a unique root ID for automatic root registration.
2487
- * @returns {string} A unique root ID in the format 'root_N'
2488
- */
2489
- generateRootId(): string;
2490
- /**
2491
- * Generate a unique job ID.
2492
- * @returns {string} A unique job ID in the format 'job_N'
2493
- * @private
2494
- */
2495
- private generateJobId;
2496
- /**
2497
- * Normalize before/after constraints to a Set.
2498
- * Handles undefined, single string, or array inputs.
2499
- * @param {string | string[] | undefined} value - The constraint value(s)
2500
- * @returns {Set<string>} Normalized Set of constraint strings
2501
- * @private
2502
- */
2503
- private normalizeConstraints;
2504
- }
2505
- /**
2506
- * Get the global scheduler instance.
2507
- * Creates one if it doesn't exist.
2508
- */
2509
- declare const getScheduler: () => Scheduler;
2510
-
2511
1854
  /**
2512
1855
  * Frame hook with phase-based ordering, priority, and FPS throttling.
2513
1856
  *
2514
- * Works both inside and outside Canvas context:
2515
- * - Inside Canvas: Full RootState (gl, scene, camera, etc.)
2516
- * - Outside Canvas (waiting mode): Waits for Canvas to mount, then gets full state
2517
- * - Outside Canvas (independent mode): Fires immediately with timing-only state
1857
+ * Always delivers full RootState — works both inside and outside Canvas context:
1858
+ * - Inside Canvas: Full RootState (renderer, scene, camera, etc.)
1859
+ * - Outside Canvas: The job registers immediately but the callback is held until a
1860
+ * Canvas adopts it, then runs with full RootState. For hostless / standalone
1861
+ * frame loops with no Canvas, use `@pmndrs/scheduler` directly.
2518
1862
  *
2519
1863
  * Returns a controls object for manual stepping, pausing, and resuming.
2520
1864
  *
@@ -2531,16 +1875,16 @@ declare const getScheduler: () => Scheduler;
2531
1875
  * useFrame((state, delta) => { ... }, { phase: 'physics' })
2532
1876
  *
2533
1877
  * @example
2534
- * // Outside Canvas - waits for Canvas to mount
1878
+ * // Outside Canvas - callback waits for a Canvas, then always has full state
2535
1879
  * function UI() {
2536
1880
  * useFrame((state, delta) => { syncUI(state.camera) });
2537
1881
  * return <button>...</button>;
2538
1882
  * }
2539
1883
  *
2540
1884
  * @example
2541
- * // Independent mode - no Canvas needed
2542
- * getScheduler().independent = true;
2543
- * useFrame((state, delta) => { updateGame(delta) });
1885
+ * // Hostless / standalone loop (no Canvas) - use @pmndrs/scheduler directly
1886
+ * import { getScheduler } from '@pmndrs/scheduler'
1887
+ * getScheduler().register((state, delta) => { updateGame(delta) })
2544
1888
  *
2545
1889
  * @example
2546
1890
  * // Scheduler-only access (no callback)
@@ -2563,11 +1907,16 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
2563
1907
  /** Callback when texture(s) finish loading */
2564
1908
  onLoad?: (texture: MappedTextureType<Url>) => void;
2565
1909
  /**
2566
- * Cache the texture in R3F's global state for access via useTextures().
2567
- * When true:
1910
+ * Register the texture(s) in R3F's global texture registry for access via useTextures().
1911
+ * When true (the default):
2568
1912
  * - Textures persist until explicitly disposed
2569
- * - Returns existing cached textures if available (preserving modifications like colorSpace)
2570
- * @default false
1913
+ * - On mount, returns existing registered textures if available (preserving modifications like colorSpace)
1914
+ *
1915
+ * Reads are taken once at mount — a mounted `useTexture` does not re-render when the registry
1916
+ * changes. To react to registry swaps, use `useTextures(s => s.get(key))` instead.
1917
+ *
1918
+ * Pass `false` to opt out of registry enrollment entirely.
1919
+ * @default true
2571
1920
  */
2572
1921
  cache?: boolean;
2573
1922
  };
@@ -2591,15 +1940,18 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
2591
1940
  * normal: '/normal.png'
2592
1941
  * })
2593
1942
  *
2594
- * // With caching - returns same texture object across components
2595
- * // Modifications (colorSpace, wrapS, etc.) are preserved
2596
- * const diffuse = useTexture('/diffuse.png', { cache: true })
1943
+ * // Textures are registered in the global registry by default — the same texture
1944
+ * // object is shared across components and modifications (colorSpace, wrapS, etc.) are preserved
1945
+ * const diffuse = useTexture('/diffuse.png')
2597
1946
  * diffuse.colorSpace = THREE.SRGBColorSpace
2598
1947
  *
2599
1948
  * // Another component gets the SAME texture with colorSpace already set
2600
- * const sameDiffuse = useTexture('/diffuse.png', { cache: true })
1949
+ * const sameDiffuse = useTexture('/diffuse.png')
1950
+ *
1951
+ * // Opt out of registry enrollment for a one-off texture
1952
+ * const scratch = useTexture('/scratch.png', { cache: false })
2601
1953
  *
2602
- * // Access cache directly
1954
+ * // Access the registry directly
2603
1955
  * const { get } = useTextures()
2604
1956
  * const cached = get('/diffuse.png')
2605
1957
  * ```
@@ -2616,63 +1968,80 @@ declare const Texture: ({ children, input, onLoad, cache, }: {
2616
1968
  cache?: boolean;
2617
1969
  }) => react_jsx_runtime.JSX.Element;
2618
1970
 
2619
- type TextureEntry = Texture$1 | {
2620
- value: Texture$1;
2621
- [key: string]: any;
1971
+ /** Accepted shapes for a registry read: a single key, a list of keys, or a name→key map. */
1972
+ type TextureInput = string | string[] | Record<string, string>;
1973
+ /** Result of a `get()` read, mirroring the input shape. */
1974
+ type TextureResult<Input extends TextureInput> = Input extends string ? Texture$1 | undefined : Input extends string[] ? (Texture$1 | undefined)[] : {
1975
+ [K in keyof Input]: Texture$1 | undefined;
2622
1976
  };
1977
+ /** Options for `dispose()`. */
1978
+ interface DisposeOptions {
1979
+ /** Dispose even if the texture still has active references (default false). */
1980
+ force?: boolean;
1981
+ }
2623
1982
  interface UseTexturesReturn {
2624
- /** Map of all textures currently in cache */
2625
- textures: Map<string, TextureEntry>;
2626
- /** Get a specific texture by key (usually URL) */
2627
- get: (key: string) => TextureEntry | undefined;
2628
- /** Check if a texture exists in cache */
2629
- has: (key: string) => boolean;
2630
- /** Add a texture to the cache */
2631
- add: (key: string, value: TextureEntry) => void;
2632
- /** Add multiple textures to the cache */
2633
- addMultiple: (items: Map<string, TextureEntry> | Record<string, TextureEntry>) => void;
2634
- /** Remove a texture from cache (does NOT dispose GPU resources) */
2635
- remove: (key: string) => void;
2636
- /** Remove multiple textures from cache */
2637
- removeMultiple: (keys: string[]) => void;
2638
- /** Dispose a texture's GPU resources and remove from cache */
2639
- dispose: (key: string) => void;
2640
- /** Dispose multiple textures */
2641
- disposeMultiple: (keys: string[]) => void;
2642
- /** Dispose ALL cached textures - use with caution */
2643
- disposeAll: () => void;
1983
+ /** The live registry Map (key → Texture). Treat as read-only. */
1984
+ readonly all: Map<string, Texture$1>;
1985
+ /** Read one texture, an array of textures, or a name→texture record (mirrors the input shape). */
1986
+ get<Input extends TextureInput>(input: Input): TextureResult<Input>;
1987
+ /** Check whether a key exists in the registry. */
1988
+ has(key: string): boolean;
1989
+ /**
1990
+ * Register a texture (or a record of textures) that has no URL — e.g. a render
1991
+ * target or procedural texture. URL-loaded textures are registered automatically
1992
+ * by `useTexture` (registry enrollment is on by default).
1993
+ */
1994
+ add(key: string, texture: Texture$1): void;
1995
+ add(record: Record<string, Texture$1>): void;
1996
+ /**
1997
+ * Dispose a texture's GPU resources and remove it from the registry.
1998
+ * Refcount-aware: if the key is still in use by a mounted `useTexture` consumer it is
1999
+ * skipped (with a warning) unless `{ force: true }` is passed.
2000
+ * @returns true if disposed, false if skipped.
2001
+ */
2002
+ dispose(key: string, options?: DisposeOptions): boolean;
2003
+ /** Dispose every texture in the registry and clear it. Use on scene teardown. */
2004
+ disposeAll(): void;
2644
2005
  }
2645
2006
  /**
2646
- * Hook for managing the global texture cache in R3F state.
2007
+ * Reactive Texture registry — load once with `useTexture`, reach the textures from anywhere.
2008
+ *
2009
+ * This is a registry of plain `Texture` objects (not TSL nodes), so the same texture can feed
2010
+ * a material map, a heightmap sampler, or anything else. It does **not** load — pair it with
2011
+ * `useTexture` for loading (registry enrollment is on by default); `useTextures` is for access and lifecycle.
2647
2012
  *
2648
- * Textures are stored in a Map with URL/path keys for efficient lookup.
2649
- * Useful for sharing texture references across materials and components.
2013
+ * The returned handle is **reactive**: the calling component re-renders when the registry
2014
+ * changes. Pass a selector to scope the subscription to a single read.
2650
2015
  *
2651
2016
  * @example
2652
2017
  * ```tsx
2653
- * const { textures, add, get, remove, has, dispose } = useTextures()
2018
+ * // Load + register once (anywhere in the tree) — registered by default
2019
+ * useTexture({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
2654
2020
  *
2655
- * // Check if texture is already cached
2656
- * if (!has('/textures/diffuse.png')) {
2657
- * // Load with useTexture and cache: true, or manually add
2658
- * const tex = useTexture('/textures/diffuse.png', { cache: true })
2659
- * }
2660
- *
2661
- * // Access cached texture from anywhere
2662
- * const diffuse = get('/textures/diffuse.png')
2663
- * if (diffuse) material.map = diffuse
2021
+ * // Reach them from another component — record form lands straight into a material
2022
+ * const { map, normalMap } = useTextures().get({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
2023
+ * return <meshStandardMaterial map={map} normalMap={normalMap} />
2664
2024
  *
2665
- * // Remove from cache only (texture still in GPU memory)
2666
- * remove('/textures/old.png')
2025
+ * // A set of heightmaps at once
2026
+ * const [a, b, c] = useTextures().get(['/h0.png', '/h1.png', '/h2.png'])
2667
2027
  *
2668
- * // Fully dispose (frees GPU memory + removes from cache)
2669
- * dispose('/textures/unused.png')
2028
+ * // Register a non-URL texture (render target / procedural)
2029
+ * useTextures().add('rt-main', renderTarget.texture)
2670
2030
  *
2671
- * // Nuclear option - dispose everything
2672
- * disposeAll()
2031
+ * // Deliberate GPU cleanup (refcount-aware; force to override)
2032
+ * useTextures().dispose('/diffuse.jpg')
2033
+ * useTextures().disposeAll() // scene teardown
2673
2034
  * ```
2035
+ *
2036
+ * @remarks
2037
+ * **Future expansion:** an imperative async loader (e.g. `await useTextures().load('/x.jpg')`) is
2038
+ * intentionally not included yet. It would let non-React code (loading screens, dynamic streaming)
2039
+ * populate the registry without Suspense, at the cost of putting loading back into this hook. It
2040
+ * will be added only if a concrete consumer needs imperative loading; for now, loading lives in
2041
+ * `useTexture`.
2674
2042
  */
2675
2043
  declare function useTextures(): UseTexturesReturn;
2044
+ declare function useTextures<T>(selector: (registry: UseTexturesReturn) => T): T;
2676
2045
 
2677
2046
  /**
2678
2047
  * Creates a render target compatible with the current renderer.
@@ -4452,9 +3821,12 @@ declare function useUniforms<T extends UniformInputRecord>(uniforms: T): Uniform
4452
3821
  declare function useUniforms<T extends UniformInputRecord>(uniforms: T, scope: string): UniformsWithUtils<UniformRecord<UniformNode>>;
4453
3822
  /**
4454
3823
  * Global rebuildUniforms function for HMR integration.
4455
- * Clears cached uniforms and increments _hmrVersion to trigger re-creation.
3824
+ * Invalidates cached uniforms and increments _hmrVersion to trigger re-creation.
4456
3825
  * Call this when HMR is detected to refresh all uniform creators.
4457
3826
  *
3827
+ * Resolves to the primary store so shared TSL resources rebuild on the
3828
+ * authoritative store.
3829
+ *
4458
3830
  * @param store - The R3F store (from useStore or context)
4459
3831
  * @param scope - Optional scope to rebuild ('root' for root only, string for specific scope, undefined for all)
4460
3832
  */
@@ -4538,9 +3910,12 @@ declare function useNodes<T extends Record<string, TSLNodeLike>>(creator: NodeCr
4538
3910
  declare function useNodes<T extends Record<string, TSLNodeLike>>(creator: NodeCreator<T>, scope: string): NodesWithUtils<T>;
4539
3911
  /**
4540
3912
  * Global rebuildNodes function for HMR integration.
4541
- * Clears cached nodes and increments _hmrVersion to trigger re-creation.
3913
+ * Invalidates cached nodes and increments _hmrVersion to trigger re-creation.
4542
3914
  * Call this when HMR is detected to refresh all node creators.
4543
3915
  *
3916
+ * Resolves to the primary store so shared TSL resources rebuild on the
3917
+ * authoritative store.
3918
+ *
4544
3919
  * @param store - The R3F store (from useStore or context)
4545
3920
  * @param scope - Optional scope to rebuild ('root' for root only, string for specific scope, undefined for all)
4546
3921
  */
@@ -4617,9 +3992,12 @@ declare function useBuffers<T extends Record<string, BufferLike>>(creator: Buffe
4617
3992
  declare function useBuffers<T extends Record<string, BufferLike>>(creator: BufferCreator<T>, scope: string): BuffersWithUtils<T>;
4618
3993
  /**
4619
3994
  * Global rebuildBuffers function for HMR integration.
4620
- * Clears cached buffers and increments _hmrVersion to trigger re-creation.
3995
+ * Invalidates cached buffers and increments _hmrVersion to trigger re-creation.
4621
3996
  * Call this when HMR is detected to refresh all buffer creators.
4622
3997
  *
3998
+ * Resolves to the primary store so shared TSL resources rebuild on the
3999
+ * authoritative store.
4000
+ *
4623
4001
  * @param store - The R3F store (from useStore or context)
4624
4002
  * @param scope - Optional scope to rebuild ('root' for root only, string for specific scope, undefined for all)
4625
4003
  */
@@ -4651,14 +4029,34 @@ declare function useGPUStorage<T extends Record<string, StorageLike>>(creator: S
4651
4029
  declare function useGPUStorage<T extends Record<string, StorageLike>>(creator: StorageCreator<T>, scope: string): StorageWithUtils<T>;
4652
4030
  /**
4653
4031
  * Global rebuildStorage function for HMR integration.
4654
- * Clears cached storage and increments _hmrVersion to trigger re-creation.
4032
+ * Invalidates cached storage and increments _hmrVersion to trigger re-creation.
4655
4033
  * Call this when HMR is detected to refresh all storage creators.
4656
4034
  *
4035
+ * Resolves to the primary store so shared TSL resources rebuild on the
4036
+ * authoritative store.
4037
+ *
4657
4038
  * @param store - The R3F store (from useStore or context)
4658
4039
  * @param scope - Optional scope to rebuild ('root' for root only, string for specific scope, undefined for all)
4659
4040
  */
4660
4041
  declare function rebuildAllStorage(store: ReturnType<typeof useStore>, scope?: string): void;
4661
4042
 
4043
+ /**
4044
+ * Re-export from core - useTextures is now a core R3F hook (a reactive Texture registry).
4045
+ *
4046
+ * This file maintains backwards compatibility for existing webgpu imports.
4047
+ */
4048
+
4049
+ /**
4050
+ * @deprecated The registry now stores plain `Texture` objects, not TSL nodes. Use `Texture` directly.
4051
+ * Kept as an alias for backwards compatibility.
4052
+ */
4053
+ type TextureEntry = Texture$1;
4054
+ /**
4055
+ * @deprecated The registry now stores plain `Texture` objects, not TSL nodes. Use `Texture` directly.
4056
+ * Kept as an alias for backwards compatibility.
4057
+ */
4058
+ type TextureNode = Texture$1;
4059
+
4662
4060
  interface TextureOperations {
4663
4061
  add: (key: string, value: any) => void;
4664
4062
  addMultiple: (items: Map<string, any> | Record<string, any>) => void;
@@ -4753,5 +4151,5 @@ interface WebGPURootState extends Omit<RootState, 'renderer' | 'gl' | 'internal'
4753
4151
  internal: WebGPUInternalState
4754
4152
  }
4755
4153
 
4756
- 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, rebuildAllBuffers, rebuildAllNodes, rebuildAllStorage, rebuildAllUniforms, reconciler, registerPrimary, removeInteractivity, removeNodes, removeUniforms, resolve, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useBuffers, useEnvironment, useFrame, useGPUStorage, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useLocalNodes, useMutableCallback, useNodes, useRenderPipeline, useRenderTarget, useStore, useTexture, useTextures, useThree, useUniform, useUniforms, waitForPrimary };
4757
- export type { Act, AddPhaseOptions, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferCreator, BufferLike, BufferRecord, BufferStore, BuffersWithUtils, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, ClearBuffersFn, ClearNodesFn, ClearStorageFn, ClearUniformsFn, Color, ComputeFunction, ConstructorRepresentation, CreatorState, DefaultGLProps, DefaultRendererProps, Disposable, DisposeBuffersFn, DisposeStorageFn, 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, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, WebGPUR3FRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, RebuildBuffersFn, RebuildNodesFn, RebuildStorageFn, RebuildUniformsFn, ReconcilerRoot, RemoveBuffersFn, RemoveNodesFn, RemoveStorageFn, RemoveUniformsFn, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootOptions, WebGPURootState as RootState, RootStore, SchedulerApi, ScopedStoreType, SetBlock, Size, StorageCreator, StorageLike, StorageRecord, StorageStore, StorageWithUtils, 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, XRPointerConfig };
4154
+ 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, 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, getUuidPrefix, hasConstructor, hasPrimary, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isFromRef, isObject3D, isOnce, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, once, prepare, presetsObj, rebuildAllBuffers, rebuildAllNodes, rebuildAllStorage, rebuildAllUniforms, reconciler, registerPrimary, removeInteractivity, removeNodes, removeUniforms, resolve, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useBuffers, useEnvironment, useFrame, useGPUStorage, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useLocalNodes, useMutableCallback, useNodes, useRenderPipeline, useRenderTarget, useStore, useTexture, useTextures, useThree, useUniform, useUniforms, waitForPrimary };
4155
+ export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferCreator, BufferLike, BufferRecord, BufferStore, BuffersWithUtils, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, ClearBuffersFn, ClearNodesFn, ClearStorageFn, ClearUniformsFn, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, CreatorState, DefaultGLProps, DefaultRendererProps, Disposable, DisposeBuffersFn, DisposeOptions, DisposeStorageFn, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, 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, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, WebGPUR3FRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, RebuildBuffersFn, RebuildNodesFn, RebuildStorageFn, RebuildUniformsFn, ReconcilerRoot, RemoveBuffersFn, RemoveNodesFn, RemoveStorageFn, RemoveUniformsFn, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, WebGPURootState as RootState, RootStore, ScopedStoreType, SetBlock, Size, StorageCreator, StorageLike, StorageRecord, StorageStore, StorageWithUtils, Subscription, TSLNode, TSLNodeInput, TextureEntry, TextureInput, TextureNode, TextureOperations, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UniformCreator, UniformValue, UniformsWithUtils, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, WebGPUDefaultProps, WebGPUProps, WebGPUShadowConfig, XRManager, XRPointerConfig };