@react-three/fiber 10.0.0-canary.2b511a5 → 10.0.0-canary.2c50459

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/legacy.d.ts CHANGED
@@ -3,9 +3,11 @@ import { WebGLRenderTarget, Color as Color$1, ColorRepresentation, Euler as Eule
3
3
  import * as React$1 from 'react';
4
4
  import { ReactNode, Component, RefObject, JSX } from 'react';
5
5
  import * as three_webgpu from 'three/webgpu';
6
- import { WebGPURenderer as WebGPURenderer$1, CanvasTarget, Node, ShaderNodeObject } from 'three/webgpu';
6
+ import { WebGPURenderer as WebGPURenderer$1, Node, StorageTexture, Data3DTexture, CanvasTarget, ShaderNodeObject } from 'three/webgpu';
7
7
  import { StoreApi } from 'zustand';
8
8
  import { UseBoundStoreWithEqualityFn } from 'zustand/traditional';
9
+ import { FrameTimingState, FrameCallback as FrameCallback$1, SchedulerApi, UseFrameNextOptions, FrameNextControls } from '@pmndrs/scheduler';
10
+ export { AddPhaseOptions, FrameControls, FrameNextControls, FrameTimingState, RootOptions, Scheduler, SchedulerApi, UseFrameNextOptions, UseFrameOptions, getScheduler } from '@pmndrs/scheduler';
9
11
  import { Options } from 'react-use-measure';
10
12
  import * as react_jsx_runtime from 'react/jsx-runtime';
11
13
  import { ThreeElement as ThreeElement$1, Euler as Euler$2 } from '@react-three/fiber';
@@ -148,6 +150,8 @@ interface IntersectionEvent<TSourceEvent> extends Intersection {
148
150
  unprojectedPoint: THREE$1.Vector3
149
151
  /** Normalized event coordinates */
150
152
  pointer: THREE$1.Vector2
153
+ /** pointerId of the original event for multiple pointer events */
154
+ pointerId: number
151
155
  /** Delta between first click and this event */
152
156
  delta: number
153
157
  /** The ray that pierced it */
@@ -224,6 +228,18 @@ interface EventHandlers {
224
228
  type FilterFunction = (items: THREE$1.Intersection[], state: RootState) => THREE$1.Intersection[]
225
229
  type ComputeFunction = (event: DomEvent, root: RootState, previous?: RootState) => void
226
230
 
231
+ /** Configuration for XR pointer registration (controllers/hands) */
232
+ interface XRPointerConfig {
233
+ /** Ray origin (updated each frame by XR system) */
234
+ ray: THREE$1.Ray
235
+ /** Optional: custom compute function for this pointer */
236
+ compute?: (state: RootState) => void
237
+ /** Pointer type identifier */
238
+ type: 'controller' | 'hand' | 'gaze'
239
+ /** Which hand (for controller/hand types) */
240
+ handedness?: 'left' | 'right'
241
+ }
242
+
227
243
  interface EventManager<TTarget> {
228
244
  /** Determines if the event layer is active */
229
245
  enabled: boolean
@@ -243,8 +259,21 @@ interface EventManager<TTarget> {
243
259
  disconnect?: () => void
244
260
  /** Triggers a onPointerMove with the last known event. This can be useful to enable raycasting without
245
261
  * explicit user interaction, for instance when the camera moves a hoverable object underneath the cursor.
262
+ * @param pointerId - Optional pointer ID to update specific pointer only
246
263
  */
247
- update?: () => void
264
+ update?: (pointerId?: number) => void
265
+ /** Defer pointer move raycasting to frame start (default: true) */
266
+ frameTimedRaycasts?: boolean
267
+ /** Always fire raycaster immediately on scroll events (default: true) */
268
+ alwaysFireOnScroll?: boolean
269
+ /** Automatically re-raycast every frame to detect hover changes from moving objects/camera (default: false) */
270
+ updateOnFrame?: boolean
271
+ /** Flush deferred pointer raycasts. Called by scheduler at frame start (input phase). */
272
+ flush?: () => void
273
+ /** Register an XR pointer (controller/hand). Returns assigned pointerId */
274
+ registerPointer?: (config: XRPointerConfig) => number
275
+ /** Unregister an XR pointer */
276
+ unregisterPointer?: (pointerId: number) => void
248
277
  }
249
278
 
250
279
  interface PointerCaptureTarget {
@@ -264,227 +293,94 @@ interface VisibilityEntry {
264
293
  }
265
294
 
266
295
  //* Scheduler Types (useFrame) ==============================
296
+ //
297
+ // The generic, framework-agnostic scheduler types now live in @pmndrs/scheduler.
298
+ // This file re-exports them and layers r3f's RootState-aware frame state on top,
299
+ // so existing `#types` imports across the codebase keep resolving unchanged.
267
300
 
268
301
 
269
302
 
270
- // Public Options --------------------------------
303
+ // Frame State (r3f-specific) --------------------------------
271
304
 
272
305
  /**
273
- * Options for useFrame hook
306
+ * State passed to useFrame callbacks (extends RootState with timing).
274
307
  */
275
- interface UseFrameNextOptions {
276
- /** Optional stable id for the job. Auto-generated if not provided */
277
- id?: string
278
- /** Named phase to run in. Default: 'update' */
279
- phase?: string
280
- /** Run before this phase or job id */
281
- before?: string | string[]
282
- /** Run after this phase or job id */
283
- after?: string | string[]
284
- /** Priority within phase. Higher runs first. Default: 0 */
285
- priority?: number
286
- /** Max frames per second for this job */
287
- fps?: number
288
- /** If true, skip frames when behind. If false, try to catch up. Default: true */
289
- drop?: boolean
290
- /** Enable/disable without unregistering. Default: true */
291
- enabled?: boolean
292
- }
293
-
294
- /** Alias for UseFrameNextOptions */
295
- type UseFrameOptions = UseFrameNextOptions
296
-
297
- /**
298
- * Options for addPhase
299
- */
300
- interface AddPhaseOptions {
301
- /** Insert this phase before the specified phase */
302
- before?: string
303
- /** Insert this phase after the specified phase */
304
- after?: string
305
- }
308
+ interface FrameNextState extends RootState, FrameTimingState {}
306
309
 
307
- // Frame State --------------------------------
310
+ /** Alias for FrameNextState */
311
+ type FrameState = FrameNextState
308
312
 
309
- /**
310
- * Timing-only state for independent/outside mode (no RootState)
311
- */
312
- interface FrameTimingState {
313
- /** High-resolution timestamp from RAF (ms) */
314
- time: number
315
- /** Time since last frame in seconds (for legacy compatibility with THREE.Clock) */
316
- delta: number
317
- /** Elapsed time since first frame in seconds (for legacy compatibility with THREE.Clock) */
318
- elapsed: number
319
- /** Incrementing frame counter */
320
- frame: number
321
- }
313
+ // Callback Types (r3f-specific) --------------------------------
322
314
 
323
315
  /**
324
- * State passed to useFrame callbacks (extends RootState with timing)
316
+ * Callback function for useFrame. Receives the full r3f RootState plus timing.
325
317
  */
326
- interface FrameNextState extends RootState, FrameTimingState {}
318
+ type FrameNextCallback = FrameCallback$1<RootState>
327
319
 
328
- /** Alias for FrameNextState */
329
- type FrameState = FrameNextState
320
+ /** Alias for FrameNextCallback */
321
+ type FrameCallback = FrameNextCallback
330
322
 
331
- // Root Options --------------------------------
323
+ //* Buffer Types (useBuffers) ========================================
332
324
 
333
325
  /**
334
- * Options for registerRoot
326
+ * Buffer-like types for GPU compute and storage operations.
327
+ * Includes raw CPU arrays, Three.js buffer attributes, and TSL buffer nodes.
328
+ *
329
+ * @example
330
+ * ```tsx
331
+ * const { positions, velocities } = useBuffers(() => ({
332
+ * positions: instancedArray(count, 'vec3'), // StorageBufferNode
333
+ * velocities: new Float32Array(count * 3), // TypedArray
334
+ * }), 'particles')
335
+ * ```
335
336
  */
336
- interface RootOptions {
337
- /** State provider for callbacks. Optional in independent mode. */
338
- getState?: () => any
339
- /** Error handler for job errors. Falls back to console.error if not provided. */
340
- onError?: (error: Error) => void
341
- }
337
+ type BufferLike =
338
+ | Float32Array
339
+ | Uint32Array
340
+ | Int32Array
341
+ | Float64Array
342
+ | Uint8Array
343
+ | Int8Array
344
+ | Uint16Array
345
+ | Int16Array
346
+ | THREE$1.BufferAttribute // Base class for all buffer attributes
347
+ | Node // TSL buffer nodes (instancedArray, storage)
342
348
 
343
- // Callback Types --------------------------------
349
+ /** Flat record of buffer-like values (no nested scopes) */
350
+ type BufferRecord = Record<string, BufferLike>
344
351
 
345
352
  /**
346
- * Callback function for useFrame
353
+ * Buffer store that can contain both root-level buffers and scoped buffer objects.
354
+ * Structure: { positions: Float32Array, particles: { vel: StorageBufferNode } }
347
355
  */
348
- type FrameNextCallback = (state: FrameNextState, delta: number) => void
356
+ type BufferStore = Record<string, BufferLike | BufferRecord>
349
357
 
350
- /** Alias for FrameNextCallback */
351
- type FrameCallback = FrameNextCallback
352
-
353
- // Controls returned from useFrame --------------------------------
358
+ //* Storage Types (useGPUStorage) ========================================
354
359
 
355
360
  /**
356
- * Controls object returned from useFrame hook
361
+ * GPU storage types for texture-based storage operations.
362
+ * Includes Three.js storage textures and TSL storage texture nodes.
363
+ *
364
+ * @example
365
+ * ```tsx
366
+ * const { heightMap } = useGPUStorage(() => ({
367
+ * heightMap: new StorageTexture(512, 512),
368
+ * }), 'terrain')
369
+ * ```
357
370
  */
358
- interface FrameNextControls {
359
- /** The job's unique ID */
360
- id: string
361
- /** Access to the global scheduler for frame loop control */
362
- scheduler: SchedulerApi
363
- /** Manually step this job only (bypasses FPS limiting) */
364
- step(timestamp?: number): void
365
- /** Manually step ALL jobs in the scheduler */
366
- stepAll(timestamp?: number): void
367
- /** Pause this job (set enabled=false) */
368
- pause(): void
369
- /** Resume this job (set enabled=true) */
370
- resume(): void
371
- /** Reactive paused state - automatically triggers re-render when changed */
372
- isPaused: boolean
373
- }
374
-
375
- /** Alias for FrameNextControls */
376
- type FrameControls = FrameNextControls
371
+ type StorageLike =
372
+ | StorageTexture // GPU storage texture
373
+ | Data3DTexture // 3D texture (can be used as storage)
374
+ | Node // TSL storage texture nodes (storageTexture)
377
375
 
378
- // Scheduler Interface --------------------------------
376
+ /** Flat record of storage-like values (no nested scopes) */
377
+ type StorageRecord = Record<string, StorageLike>
379
378
 
380
379
  /**
381
- * Public interface for the global Scheduler
380
+ * Storage store that can contain both root-level storage and scoped storage objects.
381
+ * Structure: { heightMap: StorageTexture, terrain: { normal: StorageTextureNode } }
382
382
  */
383
- interface SchedulerApi {
384
- //* Phase Management --------------------------------
385
-
386
- /** Add a named phase to the scheduler */
387
- addPhase(name: string, options?: AddPhaseOptions): void
388
- /** Get the ordered list of phase names */
389
- readonly phases: string[]
390
- /** Check if a phase exists */
391
- hasPhase(name: string): boolean
392
-
393
- //* Root Management --------------------------------
394
-
395
- /** Register a root (Canvas) with the scheduler. Returns unsubscribe function. */
396
- registerRoot(id: string, options?: RootOptions): () => void
397
- /** Unregister a root */
398
- unregisterRoot(id: string): void
399
- /** Generate a unique root ID */
400
- generateRootId(): string
401
- /** Get the number of registered roots */
402
- getRootCount(): number
403
- /** Check if any root is registered and ready */
404
- readonly isReady: boolean
405
- /** Subscribe to root-ready event. Fires immediately if already ready. Returns unsubscribe. */
406
- onRootReady(callback: () => void): () => void
407
-
408
- //* Job Registration --------------------------------
409
-
410
- /** Register a job with the scheduler (returns unsubscribe function) */
411
- register(
412
- callback: FrameNextCallback,
413
- options?: {
414
- id?: string
415
- rootId?: string
416
- phase?: string
417
- before?: string | string[]
418
- after?: string | string[]
419
- priority?: number
420
- fps?: number
421
- drop?: boolean
422
- enabled?: boolean
423
- },
424
- ): () => void
425
- /** Update a job's options */
426
- updateJob(
427
- id: string,
428
- options: {
429
- priority?: number
430
- fps?: number
431
- drop?: boolean
432
- enabled?: boolean
433
- phase?: string
434
- before?: string | string[]
435
- after?: string | string[]
436
- },
437
- ): void
438
- /** Unregister a job by ID */
439
- unregister(id: string, rootId?: string): void
440
- /** Get the number of registered jobs */
441
- getJobCount(): number
442
- /** Get all job IDs */
443
- getJobIds(): string[]
444
-
445
- //* Global Jobs (for legacy addEffect/addAfterEffect) --------------------------------
446
-
447
- /** Register a global job (runs once per frame, not per-root). Returns unsubscribe function. */
448
- registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void
449
-
450
- //* Idle Callbacks (for legacy addTail) --------------------------------
451
-
452
- /** Register an idle callback (fires when loop stops). Returns unsubscribe function. */
453
- onIdle(callback: (timestamp: number) => void): () => void
454
-
455
- //* Frame Loop Control --------------------------------
456
-
457
- /** Start the scheduler loop */
458
- start(): void
459
- /** Stop the scheduler loop */
460
- stop(): void
461
- /** Check if the scheduler is running */
462
- readonly isRunning: boolean
463
- /** Get/set the frameloop mode ('always', 'demand', 'never') */
464
- frameloop: Frameloop
465
- /** Independent mode - runs without Canvas, callbacks receive timing-only state */
466
- independent: boolean
467
-
468
- //* Manual Stepping --------------------------------
469
-
470
- /** Manually step all jobs once (for frameloop='never' or testing) */
471
- step(timestamp?: number): void
472
- /** Manually step a single job by ID */
473
- stepJob(id: string, timestamp?: number): void
474
- /** Request frame(s) to be rendered (for frameloop='demand') */
475
- invalidate(frames?: number): void
476
-
477
- //* Per-Job Control --------------------------------
478
-
479
- /** Check if a job is paused */
480
- isJobPaused(id: string): boolean
481
- /** Pause a job */
482
- pauseJob(id: string): void
483
- /** Resume a job */
484
- resumeJob(id: string): void
485
- /** Subscribe to job state changes (for reactive isPaused). Returns unsubscribe function. */
486
- subscribeJobState(id: string, listener: () => void): () => void
487
- }
383
+ type StorageStore = Record<string, StorageLike | StorageRecord>
488
384
 
489
385
  //* Renderer Types ========================================
490
386
 
@@ -499,6 +395,18 @@ type Subscription = {
499
395
  store: RootStore
500
396
  }
501
397
 
398
+ /** Per-pointer state for multi-touch and XR support */
399
+ type PointerState = {
400
+ /** Objects currently hovered by this pointer */
401
+ hovered: Map<string, ThreeEvent<DomEvent>>
402
+ /** Objects capturing this pointer */
403
+ captured: Map<THREE$1.Object3D, PointerCaptureTarget>
404
+ /** Initial click position [x, y] */
405
+ initialClick: [x: number, y: number]
406
+ /** Objects hit on initial click */
407
+ initialHits: THREE$1.Object3D[]
408
+ }
409
+
502
410
  type Dpr = number | [min: number, max: number]
503
411
 
504
412
  interface Size {
@@ -540,12 +448,21 @@ interface Performance {
540
448
 
541
449
  interface InternalState {
542
450
  interaction: THREE$1.Object3D[]
543
- hovered: Map<string, ThreeEvent<DomEvent>>
544
451
  subscribers: Subscription[]
452
+ /** Per-pointer state (hover, capture, click tracking) - replaces hovered, capturedMap, initialClick, initialHits */
453
+ pointerMap: Map<number, PointerState>
454
+ /** Pointers needing raycast this frame (used with frameTimedRaycasts) */
455
+ pointerDirty: Map<number, DomEvent>
456
+ /** Last event received (for events.update() compatibility) */
457
+ lastEvent: React$1.RefObject<DomEvent | null>
458
+ /** @deprecated Use pointerMap.get(pointerId).hovered instead */
459
+ hovered: Map<string, ThreeEvent<DomEvent>>
460
+ /** @deprecated Use pointerMap.get(pointerId).captured instead */
545
461
  capturedMap: Map<number, Map<THREE$1.Object3D, PointerCaptureTarget>>
462
+ /** @deprecated Use pointerMap.get(pointerId).initialClick instead */
546
463
  initialClick: [x: number, y: number]
464
+ /** @deprecated Use pointerMap.get(pointerId).initialHits instead */
547
465
  initialHits: THREE$1.Object3D[]
548
- lastEvent: React$1.RefObject<DomEvent | null>
549
466
  /** Visibility event registry (onFramed, onOccluded, onVisible) */
550
467
  visibilityRegistry: Map<string, VisibilityEntry>
551
468
  /** Whether occlusion queries are enabled (WebGPU only) */
@@ -686,11 +603,17 @@ interface RootState {
686
603
  uniforms: UniformStore
687
604
  /** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
688
605
  nodes: Record<string, any>
689
- /** Global TSL texture nodes - use useTextures() hook for operations */
690
- textures: Map<string, any>
691
- /** WebGPU PostProcessing instance - use usePostProcessing() hook */
692
- postProcessing: any | null // THREE.PostProcessing when available
693
- /** Global TSL pass nodes for post-processing - use usePostProcessing() hook */
606
+ /** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
607
+ buffers: BufferStore
608
+ /** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
609
+ gpuStorage: StorageStore
610
+ /** Global Texture registry (key Texture, usually keyed by URL) - use useTextures() hook for access + lifecycle */
611
+ textures: Map<string, THREE$1.Texture>
612
+ /** Internal: refcount per texture key, driven by mounted useTexture consumers (registry enrollment is on by default) */
613
+ _textureRefs: Map<string, number>
614
+ /** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
615
+ renderPipeline: any | null // THREE.PostProcessing (will be THREE.RenderPipeline in future Three.js release)
616
+ /** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
694
617
  passes: Record<string, any>
695
618
  /** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
696
619
  _hmrVersion: number
@@ -740,6 +663,20 @@ interface Renderer {
740
663
  render: (scene: THREE$1.Scene, camera: THREE$1.Camera) => any
741
664
  }
742
665
 
666
+ //* Color Management Config ==============================
667
+
668
+ /**
669
+ * Color management configuration shared by both WebGL and WebGPU renderers.
670
+ */
671
+ interface ColorManagementConfig {
672
+ /**
673
+ * Color space assigned to 8-bit input textures (color maps).
674
+ * Defaults to sRGB. Most textures are authored in sRGB.
675
+ * @default THREE.SRGBColorSpace
676
+ */
677
+ textureColorSpace?: THREE$1.ColorSpace
678
+ }
679
+
743
680
  //* WebGL Renderer Props ==============================
744
681
 
745
682
  type DefaultGLProps = Omit<THREE$1.WebGLRendererParameters, 'canvas'> & {
@@ -750,7 +687,7 @@ type GLProps =
750
687
  | Renderer
751
688
  | ((defaultProps: DefaultGLProps) => Renderer)
752
689
  | ((defaultProps: DefaultGLProps) => Promise<Renderer>)
753
- | Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters>
690
+ | (Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters> & ColorManagementConfig)
754
691
 
755
692
  //* WebGPU Renderer Props ==============================
756
693
 
@@ -776,9 +713,9 @@ interface CanvasSchedulerConfig {
776
713
  }
777
714
 
778
715
  /**
779
- * Extended renderer configuration for multi-canvas support.
716
+ * Extended renderer configuration for multi-canvas support and color management.
780
717
  */
781
- interface RendererConfigExtended {
718
+ interface RendererConfigExtended extends ColorManagementConfig {
782
719
  /** Share renderer from another canvas (WebGPU only) */
783
720
  primaryCanvas?: string
784
721
  /** Canvas-level scheduler options */
@@ -843,8 +780,6 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
843
780
  * @see https://threejs.org/docs/#api/en/renderers/WebGLRenderer.shadowMap
844
781
  */
845
782
  shadows?: boolean | 'basic' | 'percentage' | 'soft' | 'variance' | Partial<THREE$1.WebGLShadowMap>
846
- /** Color space assigned to 8-bit input textures (color maps). Defaults to sRGB. Most textures are authored in sRGB. */
847
- textureColorSpace?: THREE$1.ColorSpace
848
783
  /** Creates an orthographic camera */
849
784
  orthographic?: boolean
850
785
  /**
@@ -1097,7 +1032,7 @@ interface CanvasProps
1097
1032
  */
1098
1033
  resize?: Options
1099
1034
  /** The target where events are being subscribed to, default: the div that wraps canvas */
1100
- eventSource?: HTMLElement | React$1.RefObject<HTMLElement>
1035
+ eventSource?: HTMLElement | React$1.RefObject<HTMLElement | null>
1101
1036
  /** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
1102
1037
  eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
1103
1038
  /** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
@@ -1311,6 +1246,7 @@ declare global {
1311
1246
  | three_webgpu.Euler
1312
1247
  | three_webgpu.Quaternion
1313
1248
  | { x: number; y?: number; z?: number; w?: number } // Plain objects converted to vectors
1249
+ | { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
1314
1250
  | Node // TSL nodes like color(), vec3(), float() for type casting
1315
1251
  | UniformNode
1316
1252
 
@@ -1356,178 +1292,38 @@ declare module 'three/tsl' {
1356
1292
  }
1357
1293
 
1358
1294
  /**
1359
- * PostProcessing Types for usePostProcessing hook (WebGPU only)
1295
+ * RenderPipeline Types for useRenderPipeline hook (WebGPU only)
1360
1296
  */
1361
1297
 
1362
1298
 
1363
1299
 
1364
1300
  declare global {
1365
- /** Pass record - stores TSL pass nodes for post-processing */
1301
+ /** Pass record - stores TSL pass nodes for render pipeline */
1366
1302
  type PassRecord = Record<string, any>
1367
1303
 
1368
1304
  /** Setup callback - runs first to configure MRT, create additional passes */
1369
- type PostProcessingSetupCallback = (state: RootState) => PassRecord | void
1305
+ type RenderPipelineSetupCallback = (state: RootState) => PassRecord | void
1370
1306
 
1371
1307
  /** Main callback - runs second to configure outputNode, create effect passes */
1372
- type PostProcessingMainCallback = (state: RootState) => PassRecord | void
1308
+ type RenderPipelineMainCallback = (state: RootState) => PassRecord | void
1373
1309
 
1374
- /** Return type for usePostProcessing hook */
1375
- interface UsePostProcessingReturn {
1310
+ /** Return type for useRenderPipeline hook */
1311
+ interface UseRenderPipelineReturn {
1376
1312
  /** Current passes from state */
1377
1313
  passes: PassRecord
1378
- /** PostProcessing instance (null if not initialized) */
1379
- postProcessing: any | null // THREE.PostProcessing
1314
+ /** RenderPipeline instance (null if not initialized) */
1315
+ renderPipeline: any | null // THREE.PostProcessing (will be THREE.RenderPipeline in future Three.js release)
1380
1316
  /** Clear all passes from state */
1381
1317
  clearPasses: () => void
1382
- /** Reset PostProcessing entirely (clears PP + passes) */
1318
+ /** Reset RenderPipeline entirely (clears PP + passes) */
1383
1319
  reset: () => void
1384
1320
  /** Re-run setup/main callbacks with current closure values */
1385
1321
  rebuild: () => void
1386
- /** True when PostProcessing is configured and ready */
1322
+ /** True when RenderPipeline is configured and ready */
1387
1323
  isReady: boolean
1388
1324
  }
1389
1325
  }
1390
1326
 
1391
- //* useFrameNext Types ==============================
1392
-
1393
-
1394
-
1395
- //* Global Type Declarations ==============================
1396
-
1397
- declare global {
1398
- // Job --------------------------------
1399
-
1400
- /**
1401
- * Internal job representation in the scheduler
1402
- */
1403
- interface Job {
1404
- /** Unique identifier */
1405
- id: string
1406
- /** The callback to execute */
1407
- callback: FrameNextCallback
1408
- /** Phase this job belongs to */
1409
- phase: string
1410
- /** Run before these phases/job ids */
1411
- before: Set<string>
1412
- /** Run after these phases/job ids */
1413
- after: Set<string>
1414
- /** Priority within phase (higher first) */
1415
- priority: number
1416
- /** Insertion order for deterministic tie-breaking */
1417
- index: number
1418
- /** Max FPS for this job (undefined = no limit) */
1419
- fps?: number
1420
- /** Drop frames when behind (true) or catch up (false) */
1421
- drop: boolean
1422
- /** Last run timestamp (ms) */
1423
- lastRun?: number
1424
- /** Whether job is enabled */
1425
- enabled: boolean
1426
- /** Internal flag: system jobs (like default render) don't block user render takeover */
1427
- system?: boolean
1428
- }
1429
-
1430
- // Phase Graph --------------------------------
1431
-
1432
- /**
1433
- * A node in the phase graph
1434
- */
1435
- interface PhaseNode {
1436
- /** Phase name */
1437
- name: string
1438
- /** Whether this was auto-generated from a before/after constraint */
1439
- isAutoGenerated: boolean
1440
- }
1441
-
1442
- /**
1443
- * Options for creating a job from hook options
1444
- */
1445
- interface JobOptions {
1446
- id?: string
1447
- phase?: string
1448
- before?: string | string[]
1449
- after?: string | string[]
1450
- priority?: number
1451
- fps?: number
1452
- drop?: boolean
1453
- enabled?: boolean
1454
- }
1455
-
1456
- // Frame Loop State --------------------------------
1457
-
1458
- /**
1459
- * Internal frame loop state
1460
- */
1461
- interface FrameLoopState {
1462
- /** Whether the loop is running */
1463
- running: boolean
1464
- /** Current RAF handle */
1465
- rafHandle: number | null
1466
- /** Last frame timestamp in ms (null = uninitialized) */
1467
- lastTime: number | null
1468
- /** Frame counter */
1469
- frameCount: number
1470
- /** Elapsed time since first frame in ms */
1471
- elapsedTime: number
1472
- /** createdAt timestamp in ms */
1473
- createdAt: number
1474
- }
1475
-
1476
- // Root Entry --------------------------------
1477
-
1478
- /**
1479
- * Internal representation of a registered root (Canvas).
1480
- * Tracks jobs and manages rebuild state for this root.
1481
- * @internal
1482
- */
1483
- interface RootEntry {
1484
- /** Unique identifier for this root */
1485
- id: string
1486
- /** Function to get the root's current state. Returns any to support independent mode. */
1487
- getState: () => any
1488
- /** Map of job IDs to Job objects */
1489
- jobs: Map<string, Job>
1490
- /** Cached sorted job list for execution order */
1491
- sortedJobs: Job[]
1492
- /** Whether sortedJobs needs rebuilding */
1493
- needsRebuild: boolean
1494
- }
1495
-
1496
- /**
1497
- * Internal representation of a global job (deprecated API).
1498
- * Global jobs run once per frame, not per-root.
1499
- * Used by legacy addEffect/addAfterEffect APIs.
1500
- * @internal
1501
- * @deprecated Use useFrame with phases instead
1502
- */
1503
- interface GlobalJob {
1504
- /** Unique identifier for this global job */
1505
- id: string
1506
- /** Callback invoked with RAF timestamp in ms */
1507
- callback: (timestamp: number) => void
1508
- }
1509
-
1510
- // HMR Support --------------------------------
1511
-
1512
- /**
1513
- * Hot Module Replacement data structure for preserving scheduler state
1514
- * @internal
1515
- */
1516
- interface HMRData {
1517
- /** Shared data object for storing values across reloads */
1518
- data: Record<string, any>
1519
- /** Optional function to accept HMR updates */
1520
- accept?: () => void
1521
- }
1522
-
1523
- // Default Phases --------------------------------
1524
-
1525
- /**
1526
- * Default phase names for the scheduler
1527
- */
1528
- type DefaultPhase = 'start' | 'input' | 'physics' | 'update' | 'render' | 'finish'
1529
- }
1530
-
1531
1327
  type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
1532
1328
 
1533
1329
  interface MathRepresentation {
@@ -2003,6 +1799,8 @@ declare function Environment(props: EnvironmentProps): react_jsx_runtime.JSX.Ele
2003
1799
  declare function removeInteractivity(store: RootStore, object: Object3D): void;
2004
1800
  declare function createEvents(store: RootStore): {
2005
1801
  handlePointer: (name: string) => (event: DomEvent) => void;
1802
+ flushDeferredPointers: () => void;
1803
+ processDeferredPointer: (event: DomEvent, pointerId: number) => void;
2006
1804
  };
2007
1805
  /** Default R3F event manager for web */
2008
1806
  declare function createPointerEvents(store: RootStore): EventManager<HTMLElement>;
@@ -2025,376 +1823,14 @@ declare namespace useLoader {
2025
1823
  var loader: typeof getLoader;
2026
1824
  }
2027
1825
 
2028
- /**
2029
- * Global Singleton Scheduler - manages the frame loop and job execution for ALL R3F roots.
2030
- *
2031
- * Features:
2032
- * - Single RAF loop for entire application
2033
- * - Root registration (multiple Canvas support)
2034
- * - Global phases for addEffect/addAfterEffect (deprecated)
2035
- * - Per-root job management with phases, priorities, FPS throttling
2036
- * - onIdle callbacks for addTail (deprecated)
2037
- * - Demand mode support via invalidate()
2038
- */
2039
- declare class Scheduler {
2040
- private static readonly INSTANCE_KEY;
2041
- private static get instance();
2042
- private static set instance(value);
2043
- /**
2044
- * Get the global scheduler instance (creates if doesn't exist).
2045
- * Uses HMR data to preserve instance across hot reloads.
2046
- * @returns {Scheduler} The singleton scheduler instance
2047
- */
2048
- static get(): Scheduler;
2049
- /**
2050
- * Reset the singleton instance. Stops the loop and clears all state.
2051
- * Primarily used for testing to ensure clean state between tests.
2052
- * @returns {void}
2053
- */
2054
- static reset(): void;
2055
- private roots;
2056
- private phaseGraph;
2057
- private loopState;
2058
- private stoppedTime;
2059
- private nextRootIndex;
2060
- private globalBeforeJobs;
2061
- private globalAfterJobs;
2062
- private nextGlobalIndex;
2063
- private idleCallbacks;
2064
- private nextJobIndex;
2065
- private jobStateListeners;
2066
- private pendingFrames;
2067
- private _frameloop;
2068
- private _independent;
2069
- private errorHandler;
2070
- private rootReadyCallbacks;
2071
- get phases(): string[];
2072
- get frameloop(): Frameloop;
2073
- set frameloop(mode: Frameloop);
2074
- get isRunning(): boolean;
2075
- get isReady(): boolean;
2076
- get independent(): boolean;
2077
- set independent(value: boolean);
2078
- constructor();
2079
- /**
2080
- * Register a root (Canvas) with the scheduler.
2081
- * The first root to register starts the RAF loop (if frameloop='always').
2082
- * @param {string} id - Unique identifier for this root
2083
- * @param {RootOptions} [options] - Optional configuration with getState and onError callbacks
2084
- * @returns {() => void} Unsubscribe function to remove this root
2085
- */
2086
- registerRoot(id: string, options?: RootOptions): () => void;
2087
- /**
2088
- * Unregister a root from the scheduler.
2089
- * Cleans up all job state listeners for this root's jobs.
2090
- * The last root to unregister stops the RAF loop.
2091
- * @param {string} id - The root ID to unregister
2092
- * @returns {void}
2093
- */
2094
- unregisterRoot(id: string): void;
2095
- /**
2096
- * Subscribe to be notified when a root becomes available.
2097
- * Fires immediately if a root already exists.
2098
- * @param {() => void} callback - Function called when first root registers
2099
- * @returns {() => void} Unsubscribe function
2100
- */
2101
- onRootReady(callback: () => void): () => void;
2102
- /**
2103
- * Notify all registered root-ready callbacks.
2104
- * Called when the first root registers.
2105
- * @returns {void}
2106
- * @private
2107
- */
2108
- private notifyRootReady;
2109
- /**
2110
- * Ensure a default root exists for independent mode.
2111
- * Creates a minimal root with no state provider.
2112
- * @returns {void}
2113
- * @private
2114
- */
2115
- private ensureDefaultRoot;
2116
- /**
2117
- * Trigger error handling for job errors.
2118
- * Uses the bound error handler if available, otherwise logs to console.
2119
- * @param {Error} error - The error to handle
2120
- * @returns {void}
2121
- */
2122
- triggerError(error: Error): void;
2123
- /**
2124
- * Add a named phase to the scheduler's execution order.
2125
- * Marks all roots for rebuild to incorporate the new phase.
2126
- * @param {string} name - The phase name (e.g., 'physics', 'postprocess')
2127
- * @param {AddPhaseOptions} [options] - Positioning options (before/after other phases)
2128
- * @returns {void}
2129
- * @example
2130
- * scheduler.addPhase('physics', { before: 'update' });
2131
- * scheduler.addPhase('postprocess', { after: 'render' });
2132
- */
2133
- addPhase(name: string, options?: AddPhaseOptions): void;
2134
- /**
2135
- * Check if a phase exists in the scheduler.
2136
- * @param {string} name - The phase name to check
2137
- * @returns {boolean} True if the phase exists
2138
- */
2139
- hasPhase(name: string): boolean;
2140
- /**
2141
- * Register a global job that runs once per frame (not per-root).
2142
- * Used internally by deprecated addEffect/addAfterEffect APIs.
2143
- * @param {'before' | 'after'} phase - When to run: 'before' all roots or 'after' all roots
2144
- * @param {string} id - Unique identifier for this global job
2145
- * @param {(timestamp: number) => void} callback - Function called each frame with RAF timestamp
2146
- * @returns {() => void} Unsubscribe function to remove this global job
2147
- * @deprecated Use useFrame with phases instead
2148
- */
2149
- registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void;
2150
- /**
2151
- * Register an idle callback that fires when the loop stops.
2152
- * Used internally by deprecated addTail API.
2153
- * @param {(timestamp: number) => void} callback - Function called when loop becomes idle
2154
- * @returns {() => void} Unsubscribe function to remove this idle callback
2155
- * @deprecated Use demand mode with invalidate() instead
2156
- */
2157
- onIdle(callback: (timestamp: number) => void): () => void;
2158
- /**
2159
- * Notify all registered idle callbacks.
2160
- * Called when the loop stops in demand mode.
2161
- * @param {number} timestamp - The RAF timestamp when idle occurred
2162
- * @returns {void}
2163
- * @private
2164
- */
2165
- private notifyIdle;
2166
- /**
2167
- * Register a job (frame callback) with a specific root.
2168
- * This is the core registration method used by useFrame internally.
2169
- * @param {FrameNextCallback} callback - The function to call each frame
2170
- * @param {JobOptions & { rootId?: string; system?: boolean }} [options] - Job configuration
2171
- * @param {string} [options.rootId] - Target root ID (defaults to first registered root)
2172
- * @param {string} [options.id] - Unique job ID (auto-generated if not provided)
2173
- * @param {string} [options.phase] - Execution phase (defaults to 'update')
2174
- * @param {number} [options.priority] - Priority within phase (higher = earlier, default 0)
2175
- * @param {number} [options.fps] - FPS throttle limit
2176
- * @param {boolean} [options.drop] - Drop frames when behind (default true)
2177
- * @param {boolean} [options.enabled] - Whether job is active (default true)
2178
- * @param {boolean} [options.system] - Internal flag for system jobs (not user-facing)
2179
- * @returns {() => void} Unsubscribe function to remove this job
2180
- */
2181
- register(callback: FrameNextCallback, options?: JobOptions & {
2182
- rootId?: string;
2183
- system?: boolean;
2184
- }): () => void;
2185
- /**
2186
- * Unregister a job by its ID.
2187
- * Searches all roots if rootId is not provided.
2188
- * @param {string} id - The job ID to unregister
2189
- * @param {string} [rootId] - Optional root ID to search (searches all if not provided)
2190
- * @returns {void}
2191
- */
2192
- unregister(id: string, rootId?: string): void;
2193
- /**
2194
- * Update a job's options dynamically.
2195
- * Searches all roots to find the job by ID.
2196
- * Phase/constraint changes trigger a rebuild of the sorted job list.
2197
- * @param {string} id - The job ID to update
2198
- * @param {Partial<JobOptions>} options - The options to update
2199
- * @returns {void}
2200
- */
2201
- updateJob(id: string, options: Partial<JobOptions>): void;
2202
- /**
2203
- * Check if a job is currently paused (disabled).
2204
- * @param {string} id - The job ID to check
2205
- * @returns {boolean} True if the job exists and is paused
2206
- */
2207
- isJobPaused(id: string): boolean;
2208
- /**
2209
- * Subscribe to state changes for a specific job.
2210
- * Listener is called when job is paused or resumed.
2211
- * @param {string} id - The job ID to subscribe to
2212
- * @param {() => void} listener - Callback invoked on state changes
2213
- * @returns {() => void} Unsubscribe function
2214
- */
2215
- subscribeJobState(id: string, listener: () => void): () => void;
2216
- /**
2217
- * Notify all listeners that a job's state has changed.
2218
- * @param {string} id - The job ID that changed
2219
- * @returns {void}
2220
- * @private
2221
- */
2222
- private notifyJobStateChange;
2223
- /**
2224
- * Pause a job by ID (sets enabled=false).
2225
- * Notifies any subscribed state listeners.
2226
- * @param {string} id - The job ID to pause
2227
- * @returns {void}
2228
- */
2229
- pauseJob(id: string): void;
2230
- /**
2231
- * Resume a paused job by ID (sets enabled=true).
2232
- * Resets job timing to prevent frame accumulation.
2233
- * Notifies any subscribed state listeners.
2234
- * @param {string} id - The job ID to resume
2235
- * @returns {void}
2236
- */
2237
- resumeJob(id: string): void;
2238
- /**
2239
- * Start the requestAnimationFrame loop.
2240
- * Resets timing state (elapsedTime, frameCount) on start.
2241
- * No-op if already running.
2242
- * @returns {void}
2243
- */
2244
- start(): void;
2245
- /**
2246
- * Stop the requestAnimationFrame loop.
2247
- * Cancels any pending RAF callback.
2248
- * No-op if not running.
2249
- * @returns {void}
2250
- */
2251
- stop(): void;
2252
- /**
2253
- * Request frames to be rendered in demand mode.
2254
- * Accumulates pending frames (capped at 60) and starts the loop if not running.
2255
- * No-op if frameloop is not 'demand'.
2256
- * @param {number} [frames=1] - Number of frames to request
2257
- * @param {boolean} [stackFrames=false] - Whether to add frames to existing pending count
2258
- * - `false` (default): Sets pending frames to the specified value (replaces existing count)
2259
- * - `true`: Adds frames to existing pending count (useful for accumulating invalidations)
2260
- * @returns {void}
2261
- * @example
2262
- * // Request a single frame render
2263
- * scheduler.invalidate();
2264
- *
2265
- * @example
2266
- * // Request 5 frames (e.g., for animations)
2267
- * scheduler.invalidate(5);
2268
- *
2269
- * @example
2270
- * // Set pending frames to exactly 3 (don't stack with existing)
2271
- * scheduler.invalidate(3, false);
2272
- *
2273
- * @example
2274
- * // Add 2 more frames to existing pending count
2275
- * scheduler.invalidate(2, true);
2276
- */
2277
- invalidate(frames?: number, stackFrames?: boolean): void;
2278
- /**
2279
- * Reset timing state for deterministic testing.
2280
- * Preserves jobs and roots but resets lastTime, frameCount, elapsedTime, etc.
2281
- * @returns {void}
2282
- */
2283
- resetTiming(): void;
2284
- /**
2285
- * Manually execute a single frame for all roots.
2286
- * Useful for frameloop='never' mode or testing scenarios.
2287
- * @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
2288
- * @returns {void}
2289
- * @example
2290
- * // Manual control mode
2291
- * scheduler.frameloop = 'never';
2292
- * scheduler.step(); // Execute one frame
2293
- */
2294
- step(timestamp?: number): void;
2295
- /**
2296
- * Manually execute a single job by its ID.
2297
- * Useful for testing individual job callbacks in isolation.
2298
- * @param {string} id - The job ID to step
2299
- * @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
2300
- * @returns {void}
2301
- */
2302
- stepJob(id: string, timestamp?: number): void;
2303
- /**
2304
- * Main RAF loop callback.
2305
- * Executes frame, handles demand mode, and schedules next frame.
2306
- * @param {number} timestamp - RAF timestamp in milliseconds
2307
- * @returns {void}
2308
- * @private
2309
- */
2310
- private loop;
2311
- /**
2312
- * Execute a single frame across all roots.
2313
- * Order: globalBefore → each root's jobs → globalAfter
2314
- * @param {number} timestamp - RAF timestamp in milliseconds
2315
- * @returns {void}
2316
- * @private
2317
- */
2318
- private executeFrame;
2319
- /**
2320
- * Run all global jobs from a job map.
2321
- * Catches and logs errors without stopping execution.
2322
- * @param {Map<string, GlobalJob>} jobs - The global jobs map to execute
2323
- * @param {number} timestamp - RAF timestamp in milliseconds
2324
- * @returns {void}
2325
- * @private
2326
- */
2327
- private runGlobalJobs;
2328
- /**
2329
- * Execute all jobs for a single root in sorted order.
2330
- * Rebuilds sorted job list if needed, then dispatches each job.
2331
- * Errors are caught and propagated via triggerError.
2332
- * @param {RootEntry} root - The root entry to tick
2333
- * @param {number} timestamp - RAF timestamp in milliseconds
2334
- * @param {number} delta - Time since last frame in seconds
2335
- * @returns {void}
2336
- * @private
2337
- */
2338
- private tickRoot;
2339
- /**
2340
- * Get the total number of registered jobs across all roots.
2341
- * Includes both per-root jobs and global before/after jobs.
2342
- * @returns {number} Total job count
2343
- */
2344
- getJobCount(): number;
2345
- /**
2346
- * Get all registered job IDs across all roots.
2347
- * Includes both per-root jobs and global before/after jobs.
2348
- * @returns {string[]} Array of all job IDs
2349
- */
2350
- getJobIds(): string[];
2351
- /**
2352
- * Get the number of registered roots (Canvas instances).
2353
- * @returns {number} Number of registered roots
2354
- */
2355
- getRootCount(): number;
2356
- /**
2357
- * Check if any user (non-system) jobs are registered in a specific phase.
2358
- * Used by the default render job to know if a user has taken over rendering.
2359
- *
2360
- * @param phase The phase to check
2361
- * @param rootId Optional root ID to check (checks all roots if not provided)
2362
- * @returns true if any user jobs exist in the phase
2363
- */
2364
- hasUserJobsInPhase(phase: string, rootId?: string): boolean;
2365
- /**
2366
- * Generate a unique root ID for automatic root registration.
2367
- * @returns {string} A unique root ID in the format 'root_N'
2368
- */
2369
- generateRootId(): string;
2370
- /**
2371
- * Generate a unique job ID.
2372
- * @returns {string} A unique job ID in the format 'job_N'
2373
- * @private
2374
- */
2375
- private generateJobId;
2376
- /**
2377
- * Normalize before/after constraints to a Set.
2378
- * Handles undefined, single string, or array inputs.
2379
- * @param {string | string[] | undefined} value - The constraint value(s)
2380
- * @returns {Set<string>} Normalized Set of constraint strings
2381
- * @private
2382
- */
2383
- private normalizeConstraints;
2384
- }
2385
- /**
2386
- * Get the global scheduler instance.
2387
- * Creates one if it doesn't exist.
2388
- */
2389
- declare const getScheduler: () => Scheduler;
2390
-
2391
1826
  /**
2392
1827
  * Frame hook with phase-based ordering, priority, and FPS throttling.
2393
1828
  *
2394
- * Works both inside and outside Canvas context:
2395
- * - Inside Canvas: Full RootState (gl, scene, camera, etc.)
2396
- * - Outside Canvas (waiting mode): Waits for Canvas to mount, then gets full state
2397
- * - Outside Canvas (independent mode): Fires immediately with timing-only state
1829
+ * Always delivers full RootState — works both inside and outside Canvas context:
1830
+ * - Inside Canvas: Full RootState (renderer, scene, camera, etc.)
1831
+ * - Outside Canvas: The job registers immediately but the callback is held until a
1832
+ * Canvas adopts it, then runs with full RootState. For hostless / standalone
1833
+ * frame loops with no Canvas, use `@pmndrs/scheduler` directly.
2398
1834
  *
2399
1835
  * Returns a controls object for manual stepping, pausing, and resuming.
2400
1836
  *
@@ -2411,16 +1847,16 @@ declare const getScheduler: () => Scheduler;
2411
1847
  * useFrame((state, delta) => { ... }, { phase: 'physics' })
2412
1848
  *
2413
1849
  * @example
2414
- * // Outside Canvas - waits for Canvas to mount
1850
+ * // Outside Canvas - callback waits for a Canvas, then always has full state
2415
1851
  * function UI() {
2416
1852
  * useFrame((state, delta) => { syncUI(state.camera) });
2417
1853
  * return <button>...</button>;
2418
1854
  * }
2419
1855
  *
2420
1856
  * @example
2421
- * // Independent mode - no Canvas needed
2422
- * getScheduler().independent = true;
2423
- * useFrame((state, delta) => { updateGame(delta) });
1857
+ * // Hostless / standalone loop (no Canvas) - use @pmndrs/scheduler directly
1858
+ * import { getScheduler } from '@pmndrs/scheduler'
1859
+ * getScheduler().register((state, delta) => { updateGame(delta) })
2424
1860
  *
2425
1861
  * @example
2426
1862
  * // Scheduler-only access (no callback)
@@ -2443,11 +1879,16 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
2443
1879
  /** Callback when texture(s) finish loading */
2444
1880
  onLoad?: (texture: MappedTextureType<Url>) => void;
2445
1881
  /**
2446
- * Cache the texture in R3F's global state for access via useTextures().
2447
- * When true:
1882
+ * Register the texture(s) in R3F's global texture registry for access via useTextures().
1883
+ * When true (the default):
2448
1884
  * - Textures persist until explicitly disposed
2449
- * - Returns existing cached textures if available (preserving modifications like colorSpace)
2450
- * @default false
1885
+ * - On mount, returns existing registered textures if available (preserving modifications like colorSpace)
1886
+ *
1887
+ * Reads are taken once at mount — a mounted `useTexture` does not re-render when the registry
1888
+ * changes. To react to registry swaps, use `useTextures(s => s.get(key))` instead.
1889
+ *
1890
+ * Pass `false` to opt out of registry enrollment entirely.
1891
+ * @default true
2451
1892
  */
2452
1893
  cache?: boolean;
2453
1894
  };
@@ -2471,15 +1912,18 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
2471
1912
  * normal: '/normal.png'
2472
1913
  * })
2473
1914
  *
2474
- * // With caching - returns same texture object across components
2475
- * // Modifications (colorSpace, wrapS, etc.) are preserved
2476
- * const diffuse = useTexture('/diffuse.png', { cache: true })
1915
+ * // Textures are registered in the global registry by default — the same texture
1916
+ * // object is shared across components and modifications (colorSpace, wrapS, etc.) are preserved
1917
+ * const diffuse = useTexture('/diffuse.png')
2477
1918
  * diffuse.colorSpace = THREE.SRGBColorSpace
2478
1919
  *
2479
1920
  * // Another component gets the SAME texture with colorSpace already set
2480
- * const sameDiffuse = useTexture('/diffuse.png', { cache: true })
1921
+ * const sameDiffuse = useTexture('/diffuse.png')
2481
1922
  *
2482
- * // Access cache directly
1923
+ * // Opt out of registry enrollment for a one-off texture
1924
+ * const scratch = useTexture('/scratch.png', { cache: false })
1925
+ *
1926
+ * // Access the registry directly
2483
1927
  * const { get } = useTextures()
2484
1928
  * const cached = get('/diffuse.png')
2485
1929
  * ```
@@ -2496,63 +1940,80 @@ declare const Texture: ({ children, input, onLoad, cache, }: {
2496
1940
  cache?: boolean;
2497
1941
  }) => react_jsx_runtime.JSX.Element;
2498
1942
 
2499
- type TextureEntry = Texture$1 | {
2500
- value: Texture$1;
2501
- [key: string]: any;
1943
+ /** Accepted shapes for a registry read: a single key, a list of keys, or a name→key map. */
1944
+ type TextureInput = string | string[] | Record<string, string>;
1945
+ /** Result of a `get()` read, mirroring the input shape. */
1946
+ type TextureResult<Input extends TextureInput> = Input extends string ? Texture$1 | undefined : Input extends string[] ? (Texture$1 | undefined)[] : {
1947
+ [K in keyof Input]: Texture$1 | undefined;
2502
1948
  };
1949
+ /** Options for `dispose()`. */
1950
+ interface DisposeOptions {
1951
+ /** Dispose even if the texture still has active references (default false). */
1952
+ force?: boolean;
1953
+ }
2503
1954
  interface UseTexturesReturn {
2504
- /** Map of all textures currently in cache */
2505
- textures: Map<string, TextureEntry>;
2506
- /** Get a specific texture by key (usually URL) */
2507
- get: (key: string) => TextureEntry | undefined;
2508
- /** Check if a texture exists in cache */
2509
- has: (key: string) => boolean;
2510
- /** Add a texture to the cache */
2511
- add: (key: string, value: TextureEntry) => void;
2512
- /** Add multiple textures to the cache */
2513
- addMultiple: (items: Map<string, TextureEntry> | Record<string, TextureEntry>) => void;
2514
- /** Remove a texture from cache (does NOT dispose GPU resources) */
2515
- remove: (key: string) => void;
2516
- /** Remove multiple textures from cache */
2517
- removeMultiple: (keys: string[]) => void;
2518
- /** Dispose a texture's GPU resources and remove from cache */
2519
- dispose: (key: string) => void;
2520
- /** Dispose multiple textures */
2521
- disposeMultiple: (keys: string[]) => void;
2522
- /** Dispose ALL cached textures - use with caution */
2523
- disposeAll: () => void;
1955
+ /** The live registry Map (key Texture). Treat as read-only. */
1956
+ readonly all: Map<string, Texture$1>;
1957
+ /** Read one texture, an array of textures, or a name→texture record (mirrors the input shape). */
1958
+ get<Input extends TextureInput>(input: Input): TextureResult<Input>;
1959
+ /** Check whether a key exists in the registry. */
1960
+ has(key: string): boolean;
1961
+ /**
1962
+ * Register a texture (or a record of textures) that has no URL — e.g. a render
1963
+ * target or procedural texture. URL-loaded textures are registered automatically
1964
+ * by `useTexture` (registry enrollment is on by default).
1965
+ */
1966
+ add(key: string, texture: Texture$1): void;
1967
+ add(record: Record<string, Texture$1>): void;
1968
+ /**
1969
+ * Dispose a texture's GPU resources and remove it from the registry.
1970
+ * Refcount-aware: if the key is still in use by a mounted `useTexture` consumer it is
1971
+ * skipped (with a warning) unless `{ force: true }` is passed.
1972
+ * @returns true if disposed, false if skipped.
1973
+ */
1974
+ dispose(key: string, options?: DisposeOptions): boolean;
1975
+ /** Dispose every texture in the registry and clear it. Use on scene teardown. */
1976
+ disposeAll(): void;
2524
1977
  }
2525
1978
  /**
2526
- * Hook for managing the global texture cache in R3F state.
1979
+ * Reactive Texture registry load once with `useTexture`, reach the textures from anywhere.
1980
+ *
1981
+ * This is a registry of plain `Texture` objects (not TSL nodes), so the same texture can feed
1982
+ * a material map, a heightmap sampler, or anything else. It does **not** load — pair it with
1983
+ * `useTexture` for loading (registry enrollment is on by default); `useTextures` is for access and lifecycle.
2527
1984
  *
2528
- * Textures are stored in a Map with URL/path keys for efficient lookup.
2529
- * Useful for sharing texture references across materials and components.
1985
+ * The returned handle is **reactive**: the calling component re-renders when the registry
1986
+ * changes. Pass a selector to scope the subscription to a single read.
2530
1987
  *
2531
1988
  * @example
2532
1989
  * ```tsx
2533
- * const { textures, add, get, remove, has, dispose } = useTextures()
2534
- *
2535
- * // Check if texture is already cached
2536
- * if (!has('/textures/diffuse.png')) {
2537
- * // Load with useTexture and cache: true, or manually add
2538
- * const tex = useTexture('/textures/diffuse.png', { cache: true })
2539
- * }
1990
+ * // Load + register once (anywhere in the tree) registered by default
1991
+ * useTexture({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
2540
1992
  *
2541
- * // Access cached texture from anywhere
2542
- * const diffuse = get('/textures/diffuse.png')
2543
- * if (diffuse) material.map = diffuse
1993
+ * // Reach them from another component — record form lands straight into a material
1994
+ * const { map, normalMap } = useTextures().get({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
1995
+ * return <meshStandardMaterial map={map} normalMap={normalMap} />
2544
1996
  *
2545
- * // Remove from cache only (texture still in GPU memory)
2546
- * remove('/textures/old.png')
1997
+ * // A set of heightmaps at once
1998
+ * const [a, b, c] = useTextures().get(['/h0.png', '/h1.png', '/h2.png'])
2547
1999
  *
2548
- * // Fully dispose (frees GPU memory + removes from cache)
2549
- * dispose('/textures/unused.png')
2000
+ * // Register a non-URL texture (render target / procedural)
2001
+ * useTextures().add('rt-main', renderTarget.texture)
2550
2002
  *
2551
- * // Nuclear option - dispose everything
2552
- * disposeAll()
2003
+ * // Deliberate GPU cleanup (refcount-aware; force to override)
2004
+ * useTextures().dispose('/diffuse.jpg')
2005
+ * useTextures().disposeAll() // scene teardown
2553
2006
  * ```
2007
+ *
2008
+ * @remarks
2009
+ * **Future expansion:** an imperative async loader (e.g. `await useTextures().load('/x.jpg')`) is
2010
+ * intentionally not included yet. It would let non-React code (loading screens, dynamic streaming)
2011
+ * populate the registry without Suspense, at the cost of putting loading back into this hook. It
2012
+ * will be added only if a concrete consumer needs imperative loading; for now, loading lives in
2013
+ * `useTexture`.
2554
2014
  */
2555
2015
  declare function useTextures(): UseTexturesReturn;
2016
+ declare function useTextures<T>(selector: (registry: UseTexturesReturn) => T): T;
2556
2017
 
2557
2018
  /**
2558
2019
  * Creates a render target compatible with the current renderer.
@@ -2582,9 +2043,9 @@ declare function useTextures(): UseTexturesReturn;
2582
2043
  * const fbo = useRenderTarget(512, 256, { samples: 4 })
2583
2044
  * ```
2584
2045
  */
2585
- declare function useRenderTarget(options?: RenderTargetOptions): RenderTarget | WebGLRenderTarget;
2586
- declare function useRenderTarget(size: number, options?: RenderTargetOptions): RenderTarget | WebGLRenderTarget;
2587
- declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): RenderTarget | WebGLRenderTarget;
2046
+ declare function useRenderTarget(options?: RenderTargetOptions): WebGLRenderTarget;
2047
+ declare function useRenderTarget(size: number, options?: RenderTargetOptions): WebGLRenderTarget;
2048
+ declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): WebGLRenderTarget;
2588
2049
 
2589
2050
  /**
2590
2051
  * Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
@@ -4248,5 +3709,5 @@ declare function isOnce(value: unknown): value is {
4248
3709
  */
4249
3710
  declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
4250
3711
 
4251
- export { Block, Canvas, Environment, EnvironmentCube, EnvironmentMap, EnvironmentPortal, ErrorBoundary, FROM_REF, IsObject, ONCE, Portal, R3F_BUILD_LEGACY, R3F_BUILD_WEBGPU, REACT_INTERNAL_PROPS, RESERVED_PROPS, three_d as ReactThreeFiber, Scheduler, Texture, _roots, act, addAfterEffect, addEffect, addTail, advance, applyProps, attach, buildGraph, calculateDpr, context, createEvents, createPointerEvents, createPortal, createRoot, createStore, detach, diffProps, dispose, createPointerEvents as events, extend, findInitialRoot, flushSync, fromRef, getInstanceProps, getPrimary, getPrimaryIds, getRootState, getScheduler, getUuidPrefix, hasConstructor, hasPrimary, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isFromRef, isObject3D, isOnce, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, once, prepare, presetsObj, reconciler, registerPrimary, removeInteractivity, resolve, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useMutableCallback, useRenderTarget, useStore, useTexture, useTextures, useThree, waitForPrimary };
4252
- export type { Act, AddPhaseOptions, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameControls, FrameNextCallback, FrameNextControls, FrameNextState, FrameState, FrameTimingState, Frameloop, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, LegacyInternalState as InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeProps, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, LegacyRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootOptions, LegacyRootState as RootState, RootStore, SchedulerApi, SetBlock, Size, Subscription, TSLNodeInput, TextureEntry, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseFrameNextOptions, UseFrameOptions, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager };
3712
+ 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, context, createEvents, createPointerEvents, createPortal, createRoot, createStore, detach, diffProps, dispose, createPointerEvents as events, extend, findInitialRoot, flushSync, fromRef, getInstanceProps, getPrimary, getPrimaryIds, getRootState, getUuidPrefix, hasConstructor, hasPrimary, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isFromRef, isObject3D, isOnce, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, once, prepare, presetsObj, reconciler, registerPrimary, removeInteractivity, resolve, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useMutableCallback, useRenderTarget, useStore, useTexture, useTextures, useThree, waitForPrimary };
3713
+ export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferLike, BufferRecord, BufferStore, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DisposeOptions, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, LegacyInternalState as InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeProps, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, LegacyRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, LegacyRootState as RootState, RootStore, SetBlock, Size, StorageLike, StorageRecord, StorageStore, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };