@react-three/fiber 10.0.0-alpha.2 → 10.0.0-canary.0f8db17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -1,15 +1,18 @@
1
1
  import * as three_webgpu from 'three/webgpu';
2
- import { RenderTarget, Node, ShaderNodeObject, Euler as Euler$1, Color as Color$2, ColorRepresentation as ColorRepresentation$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Quaternion as Quaternion$1, Matrix3 as Matrix3$1, Matrix4 as Matrix4$1, Object3D, Texture as Texture$1, Frustum, OrthographicCamera } 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 } from 'three/webgpu';
3
3
  import * as THREE$1 from 'three';
4
- import { WebGLRenderTarget, WebGLRenderer, Color as Color$1, ColorRepresentation, RenderTargetOptions as RenderTargetOptions$1 } from 'three';
4
+ import { WebGLCubeRenderTarget, WebGLRenderTarget, WebGLRenderer, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1 } from 'three';
5
5
  import { WebGLRendererParameters } from 'three/src/renderers/WebGLRenderer.js';
6
6
  import { Inspector } from 'three/addons/inspector/Inspector.js';
7
7
  import * as React$1 from 'react';
8
8
  import { ReactNode, Component, RefObject, JSX } from 'react';
9
9
  import { StoreApi } from 'zustand';
10
10
  import { UseBoundStoreWithEqualityFn } from 'zustand/traditional';
11
+ import { FrameTimingState, FrameCallback as FrameCallback$1, SchedulerApi, UseFrameNextOptions, FrameNextControls } from '@pmndrs/scheduler';
12
+ export { AddPhaseOptions, FrameControls, FrameNextControls, FrameTimingState, RootOptions, Scheduler, SchedulerApi, UseFrameNextOptions, UseFrameOptions, getScheduler } from '@pmndrs/scheduler';
11
13
  import { Options } from 'react-use-measure';
12
14
  import * as react_jsx_runtime from 'react/jsx-runtime';
15
+ import { GroundedSkybox } from 'three/examples/jsm/objects/GroundedSkybox.js';
13
16
 
14
17
  function _mergeNamespaces(n, m) {
15
18
  m.forEach(function (e) {
@@ -46,1291 +49,1430 @@ declare const R3F_BUILD_WEBGPU = true;
46
49
 
47
50
  var THREE = /*#__PURE__*/_mergeNamespaces({
48
51
  __proto__: null,
52
+ CubeRenderTarget: CubeRenderTarget,
53
+ CubeRenderTargetCompat: CubeRenderTarget,
49
54
  Inspector: Inspector,
50
55
  R3F_BUILD_LEGACY: R3F_BUILD_LEGACY,
51
56
  R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
52
57
  RenderTargetCompat: RenderTarget,
58
+ WebGLCubeRenderTarget: WebGLCubeRenderTarget,
53
59
  WebGLRenderTarget: WebGLRenderTarget,
54
60
  WebGLRenderer: WebGLRenderer,
55
61
  WebGLRendererParameters: WebGLRendererParameters
56
62
  }, [three_webgpu]);
57
63
 
58
- //* Utility Types ==============================
59
-
60
- type NonFunctionKeys<P> = { [K in keyof P]-?: P[K] extends Function ? never : K }[keyof P]
61
- type Overwrite<P, O> = Omit<P, NonFunctionKeys<O>> & O
62
- type Properties<T> = Pick<T, NonFunctionKeys<T>>
63
- type Mutable<P> = { [K in keyof P]: P[K] | Readonly<P[K]> }
64
- type IsOptional<T> = undefined extends T ? true : false
65
- type IsAllOptional<T extends any[]> = T extends [infer First, ...infer Rest]
66
- ? IsOptional<First> extends true
67
- ? IsAllOptional<Rest>
68
- : false
69
- : true
70
-
71
- //* Camera Types ==============================
72
-
73
- type ThreeCamera = (THREE$1.OrthographicCamera | THREE$1.PerspectiveCamera) & { manual?: boolean }
74
-
75
- //* Act Type ==============================
76
-
77
- type Act = <T = any>(cb: () => Promise<T>) => Promise<T>
78
-
79
- //* Bridge & Block Types ==============================
80
-
81
- type Bridge = React$1.FC<{ children?: React$1.ReactNode }>
82
-
83
- type SetBlock = false | Promise<null> | null
84
- type UnblockProps = { set: React$1.Dispatch<React$1.SetStateAction<SetBlock>>; children: React$1.ReactNode }
85
-
86
- //* Object Map Type ==============================
87
-
88
- interface ObjectMap {
89
- nodes: { [name: string]: THREE$1.Object3D }
90
- materials: { [name: string]: THREE$1.Material }
91
- meshes: { [name: string]: THREE$1.Mesh }
92
- }
93
-
94
- //* Equality Config ==============================
95
-
96
- interface EquConfig {
97
- /** Compare arrays by reference equality a === b (default), or by shallow equality */
98
- arrays?: 'reference' | 'shallow'
99
- /** Compare objects by reference equality a === b (default), or by shallow equality */
100
- objects?: 'reference' | 'shallow'
101
- /** If true the keys in both a and b must match 1:1 (default), if false a's keys must intersect b's */
102
- strict?: boolean
103
- }
104
-
105
- //* Disposable Type ==============================
106
-
107
- interface Disposable {
108
- type?: string
109
- dispose?: () => void
110
- }
111
-
112
- //* Event-related Types =====================================
113
-
114
- interface Intersection extends THREE$1.Intersection {
115
- /** The event source (the object which registered the handler) */
116
- eventObject: THREE$1.Object3D
117
- }
118
-
119
- type Camera = THREE$1.OrthographicCamera | THREE$1.PerspectiveCamera
120
-
121
- interface IntersectionEvent<TSourceEvent> extends Intersection {
122
- /** The event source (the object which registered the handler) */
123
- eventObject: THREE$1.Object3D
124
- /** An array of intersections */
125
- intersections: Intersection[]
126
- /** vec3.set(pointer.x, pointer.y, 0).unproject(camera) */
127
- unprojectedPoint: THREE$1.Vector3
128
- /** Normalized event coordinates */
129
- pointer: THREE$1.Vector2
130
- /** Delta between first click and this event */
131
- delta: number
132
- /** The ray that pierced it */
133
- ray: THREE$1.Ray
134
- /** The camera that was used by the raycaster */
135
- camera: Camera
136
- /** stopPropagation will stop underlying handlers from firing */
137
- stopPropagation: () => void
138
- /** The original host event */
139
- nativeEvent: TSourceEvent
140
- /** If the event was stopped by calling stopPropagation */
141
- stopped: boolean
142
- }
143
-
144
- type ThreeEvent<TEvent> = IntersectionEvent<TEvent> & Properties<TEvent>
145
- type DomEvent = PointerEvent | MouseEvent | WheelEvent
146
-
147
- /** DOM event handlers registered on the canvas element */
148
- interface Events {
149
- onClick: EventListener
150
- onContextMenu: EventListener
151
- onDoubleClick: EventListener
152
- onWheel: EventListener
153
- onPointerDown: EventListener
154
- onPointerUp: EventListener
155
- onPointerLeave: EventListener
156
- onPointerMove: EventListener
157
- onPointerCancel: EventListener
158
- onLostPointerCapture: EventListener
159
- onDragEnter: EventListener
160
- onDragLeave: EventListener
161
- onDragOver: EventListener
162
- onDrop: EventListener
163
- }
164
-
165
- /** Event handlers that can be attached to R3F objects (meshes, groups, etc.) */
166
- interface EventHandlers {
167
- onClick?: (event: ThreeEvent<MouseEvent>) => void
168
- onContextMenu?: (event: ThreeEvent<MouseEvent>) => void
169
- onDoubleClick?: (event: ThreeEvent<MouseEvent>) => void
170
- /** Fires continuously while dragging over the object */
171
- onDragOver?: (event: ThreeEvent<DragEvent>) => void
172
- /** Fires once when drag enters the object */
173
- onDragOverEnter?: (event: ThreeEvent<DragEvent>) => void
174
- /** Fires once when drag leaves the object */
175
- onDragOverLeave?: (event: ThreeEvent<DragEvent>) => void
176
- /** Fires when drag misses this object (for objects that have drag handlers) */
177
- onDragOverMissed?: (event: DragEvent) => void
178
- /** Fires when a drop occurs on this object */
179
- onDrop?: (event: ThreeEvent<DragEvent>) => void
180
- /** Fires when a drop misses this object (for objects that have drop handlers) */
181
- onDropMissed?: (event: DragEvent) => void
182
- onPointerUp?: (event: ThreeEvent<PointerEvent>) => void
183
- onPointerDown?: (event: ThreeEvent<PointerEvent>) => void
184
- onPointerOver?: (event: ThreeEvent<PointerEvent>) => void
185
- onPointerOut?: (event: ThreeEvent<PointerEvent>) => void
186
- onPointerEnter?: (event: ThreeEvent<PointerEvent>) => void
187
- onPointerLeave?: (event: ThreeEvent<PointerEvent>) => void
188
- onPointerMove?: (event: ThreeEvent<PointerEvent>) => void
189
- onPointerMissed?: (event: MouseEvent) => void
190
- onPointerCancel?: (event: ThreeEvent<PointerEvent>) => void
191
- onWheel?: (event: ThreeEvent<WheelEvent>) => void
192
- onLostPointerCapture?: (event: ThreeEvent<PointerEvent>) => void
193
-
194
- //* Visibility Events --------------------------------
195
- /** Fires when object enters/exits camera frustum. Receives true when in view, false when out. */
196
- onFramed?: (inView: boolean) => void
197
- /** Fires when object occlusion state changes (WebGPU only, requires occlusionTest=true on object) */
198
- onOccluded?: (occluded: boolean) => void
199
- /** Fires when combined visibility changes (frustum + occlusion + visible prop) */
200
- onVisible?: (visible: boolean) => void
201
- }
202
-
203
- type FilterFunction = (items: THREE$1.Intersection[], state: RootState) => THREE$1.Intersection[]
204
- type ComputeFunction = (event: DomEvent, root: RootState, previous?: RootState) => void
205
-
206
- interface EventManager<TTarget> {
207
- /** Determines if the event layer is active */
208
- enabled: boolean
209
- /** Event layer priority, higher prioritized layers come first and may stop(-propagate) lower layer */
210
- priority: number
211
- /** The compute function needs to set up the raycaster and an xy- pointer */
212
- compute?: ComputeFunction
213
- /** The filter can re-order or re-structure the intersections */
214
- filter?: FilterFunction
215
- /** The target node the event layer is tied to */
216
- connected?: TTarget
217
- /** All the pointer event handlers through which the host forwards native events */
218
- handlers?: Events
219
- /** Allows re-connecting to another target */
220
- connect?: (target: TTarget) => void
221
- /** Removes all existing events handlers from the target */
222
- disconnect?: () => void
223
- /** Triggers a onPointerMove with the last known event. This can be useful to enable raycasting without
224
- * explicit user interaction, for instance when the camera moves a hoverable object underneath the cursor.
225
- */
226
- update?: () => void
227
- }
228
-
229
- interface PointerCaptureTarget {
230
- intersection: Intersection
231
- target: Element
232
- }
233
-
234
- //* Visibility System Types =====================================
235
-
236
- /** Entry in the visibility registry for tracking object visibility state */
237
- interface VisibilityEntry {
238
- object: THREE$1.Object3D
239
- handlers: Pick<EventHandlers, 'onFramed' | 'onOccluded' | 'onVisible'>
240
- lastFramedState: boolean | null
241
- lastOccludedState: boolean | null
242
- lastVisibleState: boolean | null
243
- }
244
-
245
- //* Scheduler Types (useFrame) ==============================
246
-
247
-
248
-
249
- // Public Options --------------------------------
250
-
251
- /**
252
- * Options for useFrame hook
253
- */
254
- interface UseFrameNextOptions {
255
- /** Optional stable id for the job. Auto-generated if not provided */
256
- id?: string
257
- /** Named phase to run in. Default: 'update' */
258
- phase?: string
259
- /** Run before this phase or job id */
260
- before?: string | string[]
261
- /** Run after this phase or job id */
262
- after?: string | string[]
263
- /** Priority within phase. Higher runs first. Default: 0 */
264
- priority?: number
265
- /** Max frames per second for this job */
266
- fps?: number
267
- /** If true, skip frames when behind. If false, try to catch up. Default: true */
268
- drop?: boolean
269
- /** Enable/disable without unregistering. Default: true */
270
- enabled?: boolean
271
- }
272
-
273
- /** Alias for UseFrameNextOptions */
274
- type UseFrameOptions = UseFrameNextOptions
275
-
276
- /**
277
- * Options for addPhase
278
- */
279
- interface AddPhaseOptions {
280
- /** Insert this phase before the specified phase */
281
- before?: string
282
- /** Insert this phase after the specified phase */
283
- after?: string
284
- }
285
-
286
- // Frame State --------------------------------
287
-
288
- /**
289
- * Timing-only state for independent/outside mode (no RootState)
290
- */
291
- interface FrameTimingState {
292
- /** High-resolution timestamp from RAF (ms) */
293
- time: number
294
- /** Time since last frame in seconds (for legacy compatibility with THREE.Clock) */
295
- delta: number
296
- /** Elapsed time since first frame in seconds (for legacy compatibility with THREE.Clock) */
297
- elapsed: number
298
- /** Incrementing frame counter */
299
- frame: number
300
- }
301
-
302
- /**
303
- * State passed to useFrame callbacks (extends RootState with timing)
304
- */
305
- interface FrameNextState extends RootState, FrameTimingState {}
306
-
307
- /** Alias for FrameNextState */
308
- type FrameState = FrameNextState
309
-
310
- // Root Options --------------------------------
311
-
312
- /**
313
- * Options for registerRoot
314
- */
315
- interface RootOptions {
316
- /** State provider for callbacks. Optional in independent mode. */
317
- getState?: () => any
318
- /** Error handler for job errors. Falls back to console.error if not provided. */
319
- onError?: (error: Error) => void
320
- }
321
-
322
- // Callback Types --------------------------------
323
-
324
- /**
325
- * Callback function for useFrame
326
- */
327
- type FrameNextCallback = (state: FrameNextState, delta: number) => void
328
-
329
- /** Alias for FrameNextCallback */
330
- type FrameCallback = FrameNextCallback
331
-
332
- // Controls returned from useFrame --------------------------------
333
-
334
- /**
335
- * Controls object returned from useFrame hook
336
- */
337
- interface FrameNextControls {
338
- /** The job's unique ID */
339
- id: string
340
- /** Access to the global scheduler for frame loop control */
341
- scheduler: SchedulerApi
342
- /** Manually step this job only (bypasses FPS limiting) */
343
- step(timestamp?: number): void
344
- /** Manually step ALL jobs in the scheduler */
345
- stepAll(timestamp?: number): void
346
- /** Pause this job (set enabled=false) */
347
- pause(): void
348
- /** Resume this job (set enabled=true) */
349
- resume(): void
350
- /** Reactive paused state - automatically triggers re-render when changed */
351
- isPaused: boolean
352
- }
353
-
354
- /** Alias for FrameNextControls */
355
- type FrameControls = FrameNextControls
356
-
357
- // Scheduler Interface --------------------------------
358
-
359
- /**
360
- * Public interface for the global Scheduler
361
- */
362
- interface SchedulerApi {
363
- //* Phase Management --------------------------------
364
-
365
- /** Add a named phase to the scheduler */
366
- addPhase(name: string, options?: AddPhaseOptions): void
367
- /** Get the ordered list of phase names */
368
- readonly phases: string[]
369
- /** Check if a phase exists */
370
- hasPhase(name: string): boolean
371
-
372
- //* Root Management --------------------------------
373
-
374
- /** Register a root (Canvas) with the scheduler. Returns unsubscribe function. */
375
- registerRoot(id: string, options?: RootOptions): () => void
376
- /** Unregister a root */
377
- unregisterRoot(id: string): void
378
- /** Generate a unique root ID */
379
- generateRootId(): string
380
- /** Get the number of registered roots */
381
- getRootCount(): number
382
- /** Check if any root is registered and ready */
383
- readonly isReady: boolean
384
- /** Subscribe to root-ready event. Fires immediately if already ready. Returns unsubscribe. */
385
- onRootReady(callback: () => void): () => void
386
-
387
- //* Job Registration --------------------------------
388
-
389
- /** Register a job with the scheduler (returns unsubscribe function) */
390
- register(
391
- callback: FrameNextCallback,
392
- options?: {
393
- id?: string
394
- rootId?: string
395
- phase?: string
396
- before?: string | string[]
397
- after?: string | string[]
398
- priority?: number
399
- fps?: number
400
- drop?: boolean
401
- enabled?: boolean
402
- },
403
- ): () => void
404
- /** Update a job's options */
405
- updateJob(
406
- id: string,
407
- options: {
408
- priority?: number
409
- fps?: number
410
- drop?: boolean
411
- enabled?: boolean
412
- phase?: string
413
- before?: string | string[]
414
- after?: string | string[]
415
- },
416
- ): void
417
- /** Unregister a job by ID */
418
- unregister(id: string, rootId?: string): void
419
- /** Get the number of registered jobs */
420
- getJobCount(): number
421
- /** Get all job IDs */
422
- getJobIds(): string[]
423
-
424
- //* Global Jobs (for legacy addEffect/addAfterEffect) --------------------------------
425
-
426
- /** Register a global job (runs once per frame, not per-root). Returns unsubscribe function. */
427
- registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void
428
-
429
- //* Idle Callbacks (for legacy addTail) --------------------------------
430
-
431
- /** Register an idle callback (fires when loop stops). Returns unsubscribe function. */
432
- onIdle(callback: (timestamp: number) => void): () => void
433
-
434
- //* Frame Loop Control --------------------------------
435
-
436
- /** Start the scheduler loop */
437
- start(): void
438
- /** Stop the scheduler loop */
439
- stop(): void
440
- /** Check if the scheduler is running */
441
- readonly isRunning: boolean
442
- /** Get/set the frameloop mode ('always', 'demand', 'never') */
443
- frameloop: Frameloop
444
- /** Independent mode - runs without Canvas, callbacks receive timing-only state */
445
- independent: boolean
446
-
447
- //* Manual Stepping --------------------------------
448
-
449
- /** Manually step all jobs once (for frameloop='never' or testing) */
450
- step(timestamp?: number): void
451
- /** Manually step a single job by ID */
452
- stepJob(id: string, timestamp?: number): void
453
- /** Request frame(s) to be rendered (for frameloop='demand') */
454
- invalidate(frames?: number): void
455
-
456
- //* Per-Job Control --------------------------------
457
-
458
- /** Check if a job is paused */
459
- isJobPaused(id: string): boolean
460
- /** Pause a job */
461
- pauseJob(id: string): void
462
- /** Resume a job */
463
- resumeJob(id: string): void
464
- /** Subscribe to job state changes (for reactive isPaused). Returns unsubscribe function. */
465
- subscribeJobState(id: string, listener: () => void): () => void
466
- }
467
-
468
- //* Core Store Types ========================================
469
-
470
- type Subscription = {
471
- ref: React$1.RefObject<RenderCallback>
472
- priority: number
473
- store: RootStore
474
- }
475
-
476
- type Dpr = number | [min: number, max: number]
477
-
478
- interface Size {
479
- width: number
480
- height: number
481
- top: number
482
- left: number
483
- }
484
-
485
- type Frameloop = 'always' | 'demand' | 'never'
486
-
487
- interface Viewport extends Size {
488
- /** The initial pixel ratio */
489
- initialDpr: number
490
- /** Current pixel ratio */
491
- dpr: number
492
- /** size.width / viewport.width */
493
- factor: number
494
- /** Camera distance */
495
- distance: number
496
- /** Camera aspect ratio: width / height */
497
- aspect: number
498
- }
499
-
500
- type RenderCallback = (state: RootState, delta: number, frame?: XRFrame) => void
501
-
502
- interface Performance {
503
- /** Current performance normal, between min and max */
504
- current: number
505
- /** How low the performance can go, between 0 and max */
506
- min: number
507
- /** How high the performance can go, between min and max */
508
- max: number
509
- /** Time until current returns to max in ms */
510
- debounce: number
511
- /** Sets current to min, puts the system in regression */
512
- regress: () => void
513
- }
514
-
515
- interface InternalState {
516
- interaction: THREE$1.Object3D[]
517
- hovered: Map<string, ThreeEvent<DomEvent>>
518
- subscribers: Subscription[]
519
- capturedMap: Map<number, Map<THREE$1.Object3D, PointerCaptureTarget>>
520
- initialClick: [x: number, y: number]
521
- initialHits: THREE$1.Object3D[]
522
- lastEvent: React$1.RefObject<DomEvent | null>
523
- /** Visibility event registry (onFramed, onOccluded, onVisible) */
524
- visibilityRegistry: Map<string, VisibilityEntry>
525
- /** Whether occlusion queries are enabled (WebGPU only) */
526
- occlusionEnabled: boolean
527
- /** Reference to the invisible occlusion observer mesh */
528
- occlusionObserver: THREE$1.Mesh | null
529
- /** Cached occlusion results from render pass - keyed by Object3D */
530
- occlusionCache: Map<THREE$1.Object3D, boolean | null>
531
- /** Internal helper group for R3F system objects (occlusion observer, etc.) */
532
- helperGroup: THREE$1.Group | null
533
- active: boolean
534
- priority: number
535
- frames: number
536
- subscribe: (callback: React$1.RefObject<RenderCallback>, priority: number, store: RootStore) => () => void
537
- /** Internal renderer storage - use state.renderer or state.gl to access */
538
- actualRenderer: THREE$1.WebGLRenderer | any // WebGPURenderer when available
539
- /** Global scheduler reference (for useFrame hook) */
540
- scheduler: SchedulerApi | null
541
- /** This root's unique ID in the global scheduler */
542
- rootId?: string
543
- /** Function to unregister this root from the global scheduler */
544
- unregisterRoot?: () => void
545
- /** Container for child attachment (scene for root, original container for portals) */
546
- container?: THREE$1.Object3D
547
- }
548
-
549
- interface XRManager {
550
- connect: () => void
551
- disconnect: () => void
552
- }
553
-
554
- //* Root State Interface ====================================
555
-
556
- interface RootState {
557
- /** Set current state */
558
- set: StoreApi<RootState>['setState']
559
- /** Get current state */
560
- get: StoreApi<RootState>['getState']
561
- /** (deprecated) The instance of the WebGLrenderer */
562
- gl: THREE$1.WebGLRenderer
563
- /** The instance of the WebGPU renderer, the fallback, OR the default renderer as a mask of gl */
564
- renderer: THREE$1.WebGLRenderer | any // WebGPURenderer when available
565
- /** Inspector of the webGPU Renderer. Init in the canvas */
566
- inspector: any // Inspector type from three/webgpu
567
-
568
- /** Default camera */
569
- camera: ThreeCamera
570
- /** Camera frustum for visibility checks - auto-updated each frame when autoUpdateFrustum is true */
571
- frustum: THREE$1.Frustum
572
- /** Whether to automatically update the frustum each frame (default: true) */
573
- autoUpdateFrustum: boolean
574
- /** Default scene (may be overridden in portals to point to the portal container) */
575
- scene: THREE$1.Scene
576
- /** The actual root THREE.Scene - always points to the true scene, even inside portals */
577
- rootScene: THREE$1.Scene
578
- /** Default raycaster */
579
- raycaster: THREE$1.Raycaster
580
- /** Event layer interface, contains the event handler and the node they're connected to */
581
- events: EventManager<any>
582
- /** XR interface */
583
- xr: XRManager
584
- /** Currently used controls */
585
- controls: THREE$1.EventDispatcher | null
586
- /** Normalized event coordinates */
587
- pointer: THREE$1.Vector2
588
- /** @deprecated Normalized event coordinates, use "pointer" instead! */
589
- mouse: THREE$1.Vector2
590
- /* Whether to enable r139's THREE.ColorManagement */
591
- legacy: boolean
592
- /** Shortcut to gl.outputColorSpace = THREE.LinearSRGBColorSpace */
593
- linear: boolean
594
- /** Shortcut to gl.toneMapping = NoTonemapping */
595
- flat: boolean
596
- /** Color space assigned to 8-bit input textures (color maps). Most textures are authored in sRGB. */
597
- textureColorSpace: THREE$1.ColorSpace
598
- /** Render loop flags */
599
- frameloop: Frameloop
600
- performance: Performance
601
- /** Reactive pixel-size of the canvas */
602
- size: Size
603
- /** Reactive size of the viewport in threejs units */
604
- viewport: Viewport & {
605
- getCurrentViewport: (
606
- camera?: ThreeCamera,
607
- target?: THREE$1.Vector3 | Parameters<THREE$1.Vector3['set']>,
608
- size?: Size,
609
- ) => Omit<Viewport, 'dpr' | 'initialDpr'>
610
- }
611
- /** Flags the canvas for render, but doesn't render in itself */
612
- invalidate: (frames?: number, stackFrames?: boolean) => void
613
- /** Advance (render) one step */
614
- advance: (timestamp: number, runGlobalEffects?: boolean) => void
615
- /** Shortcut to setting the event layer */
616
- setEvents: (events: Partial<EventManager<any>>) => void
617
- /** Shortcut to manual sizing. No args resets to props/container. Single arg creates square. */
618
- setSize: (width?: number, height?: number, top?: number, left?: number) => void
619
- /** Shortcut to manual setting the pixel ratio */
620
- setDpr: (dpr: Dpr) => void
621
- /** Shortcut to setting frameloop flags */
622
- setFrameloop: (frameloop: Frameloop) => void
623
- /** Set error state to propagate to error boundary */
624
- setError: (error: Error | null) => void
625
- /** Current error state (null when no error) */
626
- error: Error | null
627
- /** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
628
- uniforms: UniformStore
629
- /** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
630
- nodes: Record<string, any>
631
- /** Global TSL texture nodes - use useTextures() hook for operations */
632
- textures: Map<string, any>
633
- /** WebGPU PostProcessing instance - use usePostProcessing() hook */
634
- postProcessing: any | null // THREE.PostProcessing when available
635
- /** Global TSL pass nodes for post-processing - use usePostProcessing() hook */
636
- passes: Record<string, any>
637
- /** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
638
- _hmrVersion: number
639
- /** Internal: whether setSize() has taken ownership of canvas dimensions */
640
- _sizeImperative: boolean
641
- /** Internal: stored size props from Canvas for reset functionality */
642
- _sizeProps: { width?: number; height?: number } | null
643
- /** When the canvas was clicked but nothing was hit */
644
- onPointerMissed?: (event: MouseEvent) => void
645
- /** When a dragover event has missed any target */
646
- onDragOverMissed?: (event: DragEvent) => void
647
- /** When a drop event has missed any target */
648
- onDropMissed?: (event: DragEvent) => void
649
- /** If this state model is layered (via createPortal) then this contains the previous layer */
650
- previousRoot?: RootStore
651
- /** Internals */
652
- internal: InternalState
653
- // flags for triggers
654
- // if we are using the webGl renderer, this will be true
655
- isLegacy: boolean
656
- // regardless of renderer, if the system supports webGpu, this will be true
657
- webGPUSupported: boolean
658
- //if we are on native
659
- isNative: boolean
660
- }
661
-
64
+ //* Utility Types ==============================
65
+
66
+ type NonFunctionKeys<P> = { [K in keyof P]-?: P[K] extends Function ? never : K }[keyof P]
67
+ type Overwrite<P, O> = Omit<P, NonFunctionKeys<O>> & O
68
+ type Properties<T> = Pick<T, NonFunctionKeys<T>>
69
+ type Mutable<P> = { -readonly [K in keyof P]: P[K] }
70
+ type IsOptional<T> = undefined extends T ? true : false
71
+ type IsAllOptional<T extends any[]> = T extends [infer First, ...infer Rest]
72
+ ? IsOptional<First> extends true
73
+ ? IsAllOptional<Rest>
74
+ : false
75
+ : true
76
+
77
+ //* Camera Types ==============================
78
+
79
+ type ThreeCamera = (THREE$1.OrthographicCamera | THREE$1.PerspectiveCamera) & { manual?: boolean }
80
+
81
+ //* Act Type ==============================
82
+
83
+ type Act = <T = any>(cb: () => Promise<T>) => Promise<T>
84
+
85
+ //* Bridge & Block Types ==============================
86
+
87
+ type Bridge = React$1.FC<{ children?: React$1.ReactNode }>
88
+
89
+ type SetBlock = false | Promise<null> | null
90
+ type UnblockProps = { set: React$1.Dispatch<React$1.SetStateAction<SetBlock>>; children: React$1.ReactNode }
91
+
92
+ //* Object Map Type ==============================
93
+
94
+ /* Original version
95
+ export interface ObjectMap {
96
+ nodes: { [name: string]: THREE.Object3D }
97
+ materials: { [name: string]: THREE.Material }
98
+ meshes: { [name: string]: THREE.Mesh }
99
+ }
100
+ */
101
+ /* This version is an expansion found in a PR by itsdouges that seems abandoned but looks useful.
102
+ It allows expansion but falls back to the original shape. (deleted due to stale, but If it doesnt conflict
103
+ I will keep the use here)
104
+ https://github.com/pmndrs/react-three-fiber/commits/generic-object-map/
105
+ His description is:
106
+ The object map type is now generic and can optionally declare the available properties for nodes, materials, and meshes.
107
+ */
108
+ interface ObjectMap<
109
+ T extends { nodes?: string; materials?: string; meshes?: string } = {
110
+ nodes: string
111
+ materials: string
112
+ meshes: string
113
+ },
114
+ > {
115
+ nodes: Record<T['nodes'] extends string ? T['nodes'] : string, THREE$1.Object3D>
116
+ materials: Record<T['materials'] extends string ? T['materials'] : string, THREE$1.Material>
117
+ meshes: Record<T['meshes'] extends string ? T['meshes'] : string, THREE$1.Mesh>
118
+ }
119
+
120
+ //* Equality Config ==============================
121
+
122
+ interface EquConfig {
123
+ /** Compare arrays by reference equality a === b (default), or by shallow equality */
124
+ arrays?: 'reference' | 'shallow'
125
+ /** Compare objects by reference equality a === b (default), or by shallow equality */
126
+ objects?: 'reference' | 'shallow'
127
+ /** If true the keys in both a and b must match 1:1 (default), if false a's keys must intersect b's */
128
+ strict?: boolean
129
+ }
130
+
131
+ //* Disposable Type ==============================
132
+
133
+ interface Disposable {
134
+ type?: string
135
+ dispose?: () => void
136
+ }
137
+
138
+ //* Event-related Types =====================================
139
+
140
+ interface Intersection extends THREE$1.Intersection {
141
+ /** The event source (the object which registered the handler) */
142
+ eventObject: THREE$1.Object3D
143
+ }
144
+
145
+ type Camera = THREE$1.OrthographicCamera | THREE$1.PerspectiveCamera
146
+
147
+ interface IntersectionEvent<TSourceEvent> extends Intersection {
148
+ /** The event source (the object which registered the handler) */
149
+ eventObject: THREE$1.Object3D
150
+ /** An array of intersections */
151
+ intersections: Intersection[]
152
+ /** vec3.set(pointer.x, pointer.y, 0).unproject(camera) */
153
+ unprojectedPoint: THREE$1.Vector3
154
+ /** Normalized event coordinates */
155
+ pointer: THREE$1.Vector2
156
+ /** pointerId of the original event for multiple pointer events */
157
+ pointerId: number
158
+ /** Delta between first click and this event */
159
+ delta: number
160
+ /** The ray that pierced it */
161
+ ray: THREE$1.Ray
162
+ /** The camera that was used by the raycaster */
163
+ camera: Camera
164
+ /** stopPropagation will stop underlying handlers from firing */
165
+ stopPropagation: () => void
166
+ /** The original host event */
167
+ nativeEvent: TSourceEvent
168
+ /** If the event was stopped by calling stopPropagation */
169
+ stopped: boolean
170
+ }
171
+
172
+ type ThreeEvent<TEvent> = IntersectionEvent<TEvent> & Properties<TEvent>
173
+ type DomEvent = PointerEvent | MouseEvent | WheelEvent
174
+
175
+ /** DOM event handlers registered on the canvas element */
176
+ interface Events {
177
+ onClick: EventListener
178
+ onContextMenu: EventListener
179
+ onDoubleClick: EventListener
180
+ onWheel: EventListener
181
+ onPointerDown: EventListener
182
+ onPointerUp: EventListener
183
+ onPointerLeave: EventListener
184
+ onPointerMove: EventListener
185
+ onPointerCancel: EventListener
186
+ onLostPointerCapture: EventListener
187
+ onDragEnter: EventListener
188
+ onDragLeave: EventListener
189
+ onDragOver: EventListener
190
+ onDrop: EventListener
191
+ }
192
+
193
+ /** Event handlers that can be attached to R3F objects (meshes, groups, etc.) */
194
+ interface EventHandlers {
195
+ onClick?: (event: ThreeEvent<MouseEvent>) => void
196
+ onContextMenu?: (event: ThreeEvent<MouseEvent>) => void
197
+ onDoubleClick?: (event: ThreeEvent<MouseEvent>) => void
198
+ /** Fires continuously while dragging over the object */
199
+ onDragOver?: (event: ThreeEvent<DragEvent>) => void
200
+ /** Fires once when drag enters the object */
201
+ onDragOverEnter?: (event: ThreeEvent<DragEvent>) => void
202
+ /** Fires once when drag leaves the object */
203
+ onDragOverLeave?: (event: ThreeEvent<DragEvent>) => void
204
+ /** Fires when drag misses this object (for objects that have drag handlers) */
205
+ onDragOverMissed?: (event: DragEvent) => void
206
+ /** Fires when a drop occurs on this object */
207
+ onDrop?: (event: ThreeEvent<DragEvent>) => void
208
+ /** Fires when a drop misses this object (for objects that have drop handlers) */
209
+ onDropMissed?: (event: DragEvent) => void
210
+ onPointerUp?: (event: ThreeEvent<PointerEvent>) => void
211
+ onPointerDown?: (event: ThreeEvent<PointerEvent>) => void
212
+ onPointerOver?: (event: ThreeEvent<PointerEvent>) => void
213
+ onPointerOut?: (event: ThreeEvent<PointerEvent>) => void
214
+ onPointerEnter?: (event: ThreeEvent<PointerEvent>) => void
215
+ onPointerLeave?: (event: ThreeEvent<PointerEvent>) => void
216
+ onPointerMove?: (event: ThreeEvent<PointerEvent>) => void
217
+ onPointerMissed?: (event: MouseEvent) => void
218
+ onPointerCancel?: (event: ThreeEvent<PointerEvent>) => void
219
+ onWheel?: (event: ThreeEvent<WheelEvent>) => void
220
+ onLostPointerCapture?: (event: ThreeEvent<PointerEvent>) => void
221
+
222
+ //* Visibility Events --------------------------------
223
+ /** Fires when object enters/exits camera frustum. Receives true when in view, false when out. */
224
+ onFramed?: (inView: boolean) => void
225
+ /** Fires when object occlusion state changes (WebGPU only, requires occlusionTest=true on object) */
226
+ onOccluded?: (occluded: boolean) => void
227
+ /** Fires when combined visibility changes (frustum + occlusion + visible prop) */
228
+ onVisible?: (visible: boolean) => void
229
+ }
230
+
231
+ type FilterFunction = (items: THREE$1.Intersection[], state: RootState) => THREE$1.Intersection[]
232
+ type ComputeFunction = (event: DomEvent, root: RootState, previous?: RootState) => void
233
+
234
+ /** Configuration for XR pointer registration (controllers/hands) */
235
+ interface XRPointerConfig {
236
+ /** Ray origin (updated each frame by XR system) */
237
+ ray: THREE$1.Ray
238
+ /** Optional: custom compute function for this pointer */
239
+ compute?: (state: RootState) => void
240
+ /** Pointer type identifier */
241
+ type: 'controller' | 'hand' | 'gaze'
242
+ /** Which hand (for controller/hand types) */
243
+ handedness?: 'left' | 'right'
244
+ }
245
+
246
+ interface EventManager<TTarget> {
247
+ /** Determines if the event layer is active */
248
+ enabled: boolean
249
+ /** Event layer priority, higher prioritized layers come first and may stop(-propagate) lower layer */
250
+ priority: number
251
+ /** The compute function needs to set up the raycaster and an xy- pointer */
252
+ compute?: ComputeFunction
253
+ /** The filter can re-order or re-structure the intersections */
254
+ filter?: FilterFunction
255
+ /** The target node the event layer is tied to */
256
+ connected?: TTarget
257
+ /** All the pointer event handlers through which the host forwards native events */
258
+ handlers?: Events
259
+ /** Allows re-connecting to another target */
260
+ connect?: (target: TTarget) => void
261
+ /** Removes all existing events handlers from the target */
262
+ disconnect?: () => void
263
+ /** Triggers a onPointerMove with the last known event. This can be useful to enable raycasting without
264
+ * explicit user interaction, for instance when the camera moves a hoverable object underneath the cursor.
265
+ * @param pointerId - Optional pointer ID to update specific pointer only
266
+ */
267
+ update?: (pointerId?: number) => void
268
+ /** Defer pointer move raycasting to frame start (default: true) */
269
+ frameTimedRaycasts?: boolean
270
+ /** Always fire raycaster immediately on scroll events (default: true) */
271
+ alwaysFireOnScroll?: boolean
272
+ /** Automatically re-raycast every frame to detect hover changes from moving objects/camera (default: false) */
273
+ updateOnFrame?: boolean
274
+ /** Flush deferred pointer raycasts. Called by scheduler at frame start (input phase). */
275
+ flush?: () => void
276
+ /** Register an XR pointer (controller/hand). Returns assigned pointerId */
277
+ registerPointer?: (config: XRPointerConfig) => number
278
+ /** Unregister an XR pointer */
279
+ unregisterPointer?: (pointerId: number) => void
280
+ }
281
+
282
+ interface PointerCaptureTarget {
283
+ intersection: Intersection
284
+ target: Element
285
+ }
286
+
287
+ //* Visibility System Types =====================================
288
+
289
+ /** Entry in the visibility registry for tracking object visibility state */
290
+ interface VisibilityEntry {
291
+ object: THREE$1.Object3D
292
+ handlers: Pick<EventHandlers, 'onFramed' | 'onOccluded' | 'onVisible'>
293
+ lastFramedState: boolean | null
294
+ lastOccludedState: boolean | null
295
+ lastVisibleState: boolean | null
296
+ }
297
+
298
+ //* Scheduler Types (useFrame) ==============================
299
+ //
300
+ // The generic, framework-agnostic scheduler types now live in @pmndrs/scheduler.
301
+ // This file re-exports them and layers r3f's RootState-aware frame state on top,
302
+ // so existing `#types` imports across the codebase keep resolving unchanged.
303
+
304
+
305
+
306
+ // Frame State (r3f-specific) --------------------------------
307
+
308
+ /**
309
+ * State passed to useFrame callbacks (extends RootState with timing).
310
+ */
311
+ interface FrameNextState extends RootState, FrameTimingState {}
312
+
313
+ /** Alias for FrameNextState */
314
+ type FrameState = FrameNextState
315
+
316
+ // Callback Types (r3f-specific) --------------------------------
317
+
318
+ /**
319
+ * Callback function for useFrame. Receives the full r3f RootState plus timing.
320
+ */
321
+ type FrameNextCallback = FrameCallback$1<RootState>
322
+
323
+ /** Alias for FrameNextCallback */
324
+ type FrameCallback = FrameNextCallback
325
+
326
+ //* Buffer Types (useBuffers) ========================================
327
+
328
+ /**
329
+ * Buffer-like types for GPU compute and storage operations.
330
+ * Includes raw CPU arrays, Three.js buffer attributes, and TSL buffer nodes.
331
+ *
332
+ * @example
333
+ * ```tsx
334
+ * const { positions, velocities } = useBuffers(() => ({
335
+ * positions: instancedArray(count, 'vec3'), // StorageBufferNode
336
+ * velocities: new Float32Array(count * 3), // TypedArray
337
+ * }), 'particles')
338
+ * ```
339
+ */
340
+ type BufferLike =
341
+ | Float32Array
342
+ | Uint32Array
343
+ | Int32Array
344
+ | Float64Array
345
+ | Uint8Array
346
+ | Int8Array
347
+ | Uint16Array
348
+ | Int16Array
349
+ | THREE$1.BufferAttribute // Base class for all buffer attributes
350
+ | Node // TSL buffer nodes (instancedArray, storage)
351
+
352
+ /** Flat record of buffer-like values (no nested scopes) */
353
+ type BufferRecord = Record<string, BufferLike>
354
+
355
+ /**
356
+ * Buffer store that can contain both root-level buffers and scoped buffer objects.
357
+ * Structure: { positions: Float32Array, particles: { vel: StorageBufferNode } }
358
+ */
359
+ type BufferStore = Record<string, BufferLike | BufferRecord>
360
+
361
+ //* Storage Types (useGPUStorage) ========================================
362
+
363
+ /**
364
+ * GPU storage types for texture-based storage operations.
365
+ * Includes Three.js storage textures and TSL storage texture nodes.
366
+ *
367
+ * @example
368
+ * ```tsx
369
+ * const { heightMap } = useGPUStorage(() => ({
370
+ * heightMap: new StorageTexture(512, 512),
371
+ * }), 'terrain')
372
+ * ```
373
+ */
374
+ type StorageLike =
375
+ | StorageTexture // GPU storage texture
376
+ | Data3DTexture // 3D texture (can be used as storage)
377
+ | Node // TSL storage texture nodes (storageTexture)
378
+
379
+ /** Flat record of storage-like values (no nested scopes) */
380
+ type StorageRecord = Record<string, StorageLike>
381
+
382
+ /**
383
+ * Storage store that can contain both root-level storage and scoped storage objects.
384
+ * Structure: { heightMap: StorageTexture, terrain: { normal: StorageTextureNode } }
385
+ */
386
+ type StorageStore = Record<string, StorageLike | StorageRecord>
387
+
388
+ //* Renderer Types ========================================
389
+
390
+ /** Default renderer type - union of WebGL and WebGPU renderers */
391
+ type R3FRenderer = THREE$1.WebGLRenderer | WebGPURenderer
392
+
393
+ //* Core Store Types ========================================
394
+
395
+ type Subscription = {
396
+ ref: React$1.RefObject<RenderCallback>
397
+ priority: number
398
+ store: RootStore
399
+ }
400
+
401
+ /** Per-pointer state for multi-touch and XR support */
402
+ type PointerState = {
403
+ /** Objects currently hovered by this pointer */
404
+ hovered: Map<string, ThreeEvent<DomEvent>>
405
+ /** Objects capturing this pointer */
406
+ captured: Map<THREE$1.Object3D, PointerCaptureTarget>
407
+ /** Initial click position [x, y] */
408
+ initialClick: [x: number, y: number]
409
+ /** Objects hit on initial click */
410
+ initialHits: THREE$1.Object3D[]
411
+ }
412
+
413
+ type Dpr = number | [min: number, max: number]
414
+
415
+ interface Size {
416
+ width: number
417
+ height: number
418
+ top: number
419
+ left: number
420
+ }
421
+
422
+ type Frameloop = 'always' | 'demand' | 'never'
423
+
424
+ interface Viewport extends Size {
425
+ /** The initial pixel ratio */
426
+ initialDpr: number
427
+ /** Current pixel ratio */
428
+ dpr: number
429
+ /** size.width / viewport.width */
430
+ factor: number
431
+ /** Camera distance */
432
+ distance: number
433
+ /** Camera aspect ratio: width / height */
434
+ aspect: number
435
+ }
436
+
437
+ type RenderCallback = (state: RootState, delta: number, frame?: XRFrame) => void
438
+
439
+ interface Performance {
440
+ /** Current performance normal, between min and max */
441
+ current: number
442
+ /** How low the performance can go, between 0 and max */
443
+ min: number
444
+ /** How high the performance can go, between min and max */
445
+ max: number
446
+ /** Time until current returns to max in ms */
447
+ debounce: number
448
+ /** Sets current to min, puts the system in regression */
449
+ regress: () => void
450
+ }
451
+
452
+ interface InternalState {
453
+ interaction: THREE$1.Object3D[]
454
+ subscribers: Subscription[]
455
+ /** Per-pointer state (hover, capture, click tracking) - replaces hovered, capturedMap, initialClick, initialHits */
456
+ pointerMap: Map<number, PointerState>
457
+ /** Pointers needing raycast this frame (used with frameTimedRaycasts) */
458
+ pointerDirty: Map<number, DomEvent>
459
+ /** Last event received (for events.update() compatibility) */
460
+ lastEvent: React$1.RefObject<DomEvent | null>
461
+ /** @deprecated Use pointerMap.get(pointerId).hovered instead */
462
+ hovered: Map<string, ThreeEvent<DomEvent>>
463
+ /** @deprecated Use pointerMap.get(pointerId).captured instead */
464
+ capturedMap: Map<number, Map<THREE$1.Object3D, PointerCaptureTarget>>
465
+ /** @deprecated Use pointerMap.get(pointerId).initialClick instead */
466
+ initialClick: [x: number, y: number]
467
+ /** @deprecated Use pointerMap.get(pointerId).initialHits instead */
468
+ initialHits: THREE$1.Object3D[]
469
+ /** Visibility event registry (onFramed, onOccluded, onVisible) */
470
+ visibilityRegistry: Map<string, VisibilityEntry>
471
+ /** Whether occlusion queries are enabled (WebGPU only) */
472
+ occlusionEnabled: boolean
473
+ /** Reference to the invisible occlusion observer mesh */
474
+ occlusionObserver: THREE$1.Mesh | null
475
+ /** Cached occlusion results from render pass - keyed by Object3D */
476
+ occlusionCache: Map<THREE$1.Object3D, boolean | null>
477
+ /** Internal helper group for R3F system objects (occlusion observer, etc.) */
478
+ helperGroup: THREE$1.Group | null
479
+ active: boolean
480
+ priority: number
481
+ frames: number
482
+ subscribe: (callback: React$1.RefObject<RenderCallback>, priority: number, store: RootStore) => () => void
483
+ /** Internal renderer storage - use state.renderer or state.gl to access */
484
+ actualRenderer: R3FRenderer
485
+ /** Global scheduler reference (for useFrame hook) */
486
+ scheduler: SchedulerApi | null
487
+ /** This root's unique ID in the global scheduler */
488
+ rootId?: string
489
+ /** Function to unregister this root from the global scheduler */
490
+ unregisterRoot?: () => void
491
+ /** Container for child attachment (scene for root, original container for portals) */
492
+ container?: THREE$1.Object3D
493
+ /**
494
+ * CanvasTarget for multi-canvas WebGPU rendering.
495
+ * Created for all WebGPU canvases to support renderer sharing.
496
+ * @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
497
+ */
498
+ canvasTarget?: CanvasTarget
499
+ /**
500
+ * Whether multi-canvas rendering is active.
501
+ * True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
502
+ * When true, setCanvasTarget is called before each render.
503
+ */
504
+ isMultiCanvas?: boolean
505
+ /**
506
+ * Whether this canvas is a secondary canvas sharing another's renderer.
507
+ * True when `target` prop is used.
508
+ */
509
+ isSecondary?: boolean
510
+ /**
511
+ * The id of the primary canvas this secondary canvas targets.
512
+ * Only set when isSecondary is true.
513
+ */
514
+ targetId?: string
515
+ /**
516
+ * Function to unregister this primary canvas from the registry.
517
+ * Only set when this canvas has an `id` prop.
518
+ */
519
+ unregisterPrimary?: () => void
520
+ /** Whether canvas dimensions are forced to even numbers */
521
+ forceEven?: boolean
522
+ }
523
+
524
+ interface XRManager {
525
+ connect: () => void
526
+ disconnect: () => void
527
+ }
528
+
529
+ //* Root State Interface ====================================
530
+
531
+ interface RootState {
532
+ /** Set current state */
533
+ set: StoreApi<RootState>['setState']
534
+ /** Get current state */
535
+ get: StoreApi<RootState>['getState']
536
+ /**
537
+ * Reference to the authoritative store for shared TSL resources (uniforms, nodes, etc).
538
+ * - For primary/independent canvases: points to its own store (self-reference)
539
+ * - For secondary canvases: points to the primary canvas's store
540
+ *
541
+ * Hooks like useNodes/useUniforms should read from primaryStore to ensure
542
+ * consistent shared state across all canvases sharing a renderer.
543
+ */
544
+ primaryStore: RootStore
545
+ /** @deprecated Use `renderer` instead. The instance of the renderer (typed as WebGLRenderer for backwards compat) */
546
+ gl: THREE$1.WebGLRenderer
547
+ /** The renderer instance - type depends on entry point (WebGPU, Legacy, or union for default) */
548
+ renderer: R3FRenderer
549
+ /** Inspector of the webGPU Renderer. Init in the canvas */
550
+ inspector: any // Inspector type from three/webgpu
551
+
552
+ /** Default camera */
553
+ camera: ThreeCamera
554
+ /** Camera frustum for visibility checks - auto-updated each frame when autoUpdateFrustum is true */
555
+ frustum: THREE$1.Frustum
556
+ /** Whether to automatically update the frustum each frame (default: true) */
557
+ autoUpdateFrustum: boolean
558
+ /** Default scene (may be overridden in portals to point to the portal container) */
559
+ scene: THREE$1.Scene
560
+ /** The actual root THREE.Scene - always points to the true scene, even inside portals */
561
+ rootScene: THREE$1.Scene
562
+ /** Default raycaster */
563
+ raycaster: THREE$1.Raycaster
564
+ /** Event layer interface, contains the event handler and the node they're connected to */
565
+ events: EventManager<any>
566
+ /** XR interface */
567
+ xr: XRManager
568
+ /** Currently used controls */
569
+ controls: THREE$1.EventDispatcher | null
570
+ /** Normalized event coordinates */
571
+ pointer: THREE$1.Vector2
572
+ /** @deprecated Normalized event coordinates, use "pointer" instead! */
573
+ mouse: THREE$1.Vector2
574
+ /** Color space assigned to 8-bit input textures (color maps). Most textures are authored in sRGB. */
575
+ textureColorSpace: THREE$1.ColorSpace
576
+ /** Render loop flags */
577
+ frameloop: Frameloop
578
+ performance: Performance
579
+ /** Reactive pixel-size of the canvas */
580
+ size: Size
581
+ /** Reactive size of the viewport in threejs units */
582
+ viewport: Viewport & {
583
+ getCurrentViewport: (
584
+ camera?: ThreeCamera,
585
+ target?: THREE$1.Vector3 | Parameters<THREE$1.Vector3['set']>,
586
+ size?: Size,
587
+ ) => Omit<Viewport, 'dpr' | 'initialDpr'>
588
+ }
589
+ /** Flags the canvas for render, but doesn't render in itself */
590
+ invalidate: (frames?: number, stackFrames?: boolean) => void
591
+ /** Advance (render) one step */
592
+ advance: (timestamp: number, runGlobalEffects?: boolean) => void
593
+ /** Shortcut to setting the event layer */
594
+ setEvents: (events: Partial<EventManager<any>>) => void
595
+ /** Shortcut to manual sizing. No args resets to props/container. Single arg creates square. */
596
+ setSize: (width?: number, height?: number, top?: number, left?: number) => void
597
+ /** Shortcut to manual setting the pixel ratio */
598
+ setDpr: (dpr: Dpr) => void
599
+ /** Shortcut to setting frameloop flags. No args resets to 'always'. */
600
+ setFrameloop: (frameloop?: Frameloop) => void
601
+ /** Set error state to propagate to error boundary */
602
+ setError: (error: Error | null) => void
603
+ /** Current error state (null when no error) */
604
+ error: Error | null
605
+ /** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
606
+ uniforms: UniformStore
607
+ /** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
608
+ nodes: Record<string, any>
609
+ /** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
610
+ buffers: BufferStore
611
+ /** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
612
+ gpuStorage: StorageStore
613
+ /** Global Texture registry (key → Texture, usually keyed by URL) - use useTextures() hook for access + lifecycle */
614
+ textures: Map<string, THREE$1.Texture>
615
+ /** Internal: refcount per texture key, driven by mounted useTexture consumers (registry enrollment is on by default) */
616
+ _textureRefs: Map<string, number>
617
+ /** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
618
+ renderPipeline: ThreeRenderPipeline | null
619
+ /** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
620
+ passes: Record<string, any>
621
+ /** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
622
+ _hmrVersion: number
623
+ /** Internal: whether setSize() has taken ownership of canvas dimensions */
624
+ _sizeImperative: boolean
625
+ /** Internal: stored size props from Canvas for reset functionality */
626
+ _sizeProps: { width?: number; height?: number } | null
627
+ /** When the canvas was clicked but nothing was hit */
628
+ onPointerMissed?: (event: MouseEvent) => void
629
+ /** When a dragover event has missed any target */
630
+ onDragOverMissed?: (event: DragEvent) => void
631
+ /** When a drop event has missed any target */
632
+ onDropMissed?: (event: DragEvent) => void
633
+ /** If this state model is layered (via createPortal) then this contains the previous layer */
634
+ previousRoot?: RootStore
635
+ /** Internals */
636
+ internal: InternalState
637
+ // flags for triggers
638
+ // if we are using the webGl renderer, this will be true
639
+ isLegacy: boolean
640
+ // regardless of renderer, if the system supports webGpu, this will be true
641
+ webGPUSupported: boolean
642
+ //if we are on native
643
+ isNative: boolean
644
+ }
645
+
662
646
  type RootStore = UseBoundStoreWithEqualityFn<StoreApi<RootState>>
663
647
 
664
- //* Base Renderer Types =====================================
665
-
666
- // Shim for OffscreenCanvas since it was removed from DOM types
667
- interface OffscreenCanvas$1 extends EventTarget {}
668
-
669
- interface BaseRendererProps {
670
- canvas: HTMLCanvasElement | OffscreenCanvas$1
671
- powerPreference?: 'high-performance' | 'low-power' | 'default'
672
- antialias?: boolean
673
- alpha?: boolean
674
- }
675
-
676
- type RendererFactory<TRenderer, TParams> =
677
- | TRenderer
678
- | ((defaultProps: TParams) => TRenderer)
679
- | ((defaultProps: TParams) => Promise<TRenderer>)
680
-
681
- interface Renderer {
682
- render: (scene: THREE$1.Scene, camera: THREE$1.Camera) => any
683
- }
684
-
685
- //* WebGL Renderer Props ==============================
686
-
687
- type DefaultGLProps = Omit<THREE$1.WebGLRendererParameters, 'canvas'> & {
688
- canvas: HTMLCanvasElement | OffscreenCanvas$1
689
- }
690
-
691
- type GLProps =
692
- | Renderer
693
- | ((defaultProps: DefaultGLProps) => Renderer)
694
- | ((defaultProps: DefaultGLProps) => Promise<Renderer>)
695
- | Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters>
696
-
697
- //* WebGPU Renderer Props ==============================
698
-
699
- type DefaultRendererProps = {
700
- canvas: HTMLCanvasElement | OffscreenCanvas$1
701
- [key: string]: any
702
- }
703
-
704
- type RendererProps =
705
- | any // WebGPURenderer
706
- | ((defaultProps: DefaultRendererProps) => any)
707
- | ((defaultProps: DefaultRendererProps) => Promise<any>)
708
- | Partial<Properties<any> | Record<string, any>>
709
-
710
- //* Camera Props ==============================
711
-
712
- type CameraProps = (
713
- | THREE$1.Camera
714
- | Partial<
715
- ThreeElement<typeof THREE$1.Camera> &
716
- ThreeElement<typeof THREE$1.PerspectiveCamera> &
717
- ThreeElement<typeof THREE$1.OrthographicCamera>
718
- >
719
- ) & {
720
- /** Flags the camera as manual, putting projection into your own hands */
721
- manual?: boolean
722
- }
723
-
724
- //* Render Props ==============================
725
-
726
- interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
727
- /** A threejs renderer instance or props that go into the default renderer */
728
- gl?: GLProps
729
- /** A WebGPU renderer instance or props that go into the default renderer */
730
- renderer?: RendererProps
731
- /** Dimensions to fit the renderer to. Will measure canvas dimensions if omitted */
732
- size?: Size
733
- /**
734
- * Enables shadows (by default PCFsoft). Can accept `gl.shadowMap` options for fine-tuning,
735
- * but also strings: 'basic' | 'percentage' | 'soft' | 'variance'.
736
- * @see https://threejs.org/docs/#api/en/renderers/WebGLRenderer.shadowMap
737
- */
738
- shadows?: boolean | 'basic' | 'percentage' | 'soft' | 'variance' | Partial<THREE$1.WebGLShadowMap>
739
- /**
740
- * Disables three r139 color management.
741
- * @see https://threejs.org/docs/#manual/en/introduction/Color-management
742
- */
743
- legacy?: boolean
744
- /** Switch off automatic sRGB encoding and gamma correction */
745
- linear?: boolean
746
- /** Use `THREE.NoToneMapping` instead of `THREE.ACESFilmicToneMapping` */
747
- flat?: boolean
748
- /** Working color space for automatic texture colorspace assignment. Defaults to THREE.SRGBColorSpace */
749
- /** Color space assigned to 8-bit input textures (color maps). Defaults to sRGB. Most textures are authored in sRGB. */
750
- textureColorSpace?: THREE$1.ColorSpace
751
- /** Creates an orthographic camera */
752
- orthographic?: boolean
753
- /**
754
- * R3F's render mode. Set to `demand` to only render on state change or `never` to take control.
755
- * @see https://docs.pmnd.rs/react-three-fiber/advanced/scaling-performance#on-demand-rendering
756
- */
757
- frameloop?: Frameloop
758
- /**
759
- * R3F performance options for adaptive performance.
760
- * @see https://docs.pmnd.rs/react-three-fiber/advanced/scaling-performance#movement-regression
761
- */
762
- performance?: Partial<Omit<Performance, 'regress'>>
763
- /** Target pixel ratio. Can clamp between a range: `[min, max]` */
764
- dpr?: Dpr
765
- /** Props that go into the default raycaster */
766
- raycaster?: Partial<THREE$1.Raycaster>
767
- /** A `THREE.Scene` instance or props that go into the default scene */
768
- scene?: THREE$1.Scene | Partial<THREE$1.Scene>
769
- /** A `THREE.Camera` instance or props that go into the default camera */
770
- camera?: CameraProps
771
- /** An R3F event manager to manage elements' pointer events */
772
- events?: (store: RootStore) => EventManager<HTMLElement>
773
- /** Callback after the canvas has rendered (but not yet committed) */
774
- onCreated?: (state: RootState) => void
775
- /** Response for pointer clicks that have missed any target */
776
- onPointerMissed?: (event: MouseEvent) => void
777
- /** Response for dragover events that have missed any target */
778
- onDragOverMissed?: (event: DragEvent) => void
779
- /** Response for drop events that have missed any target */
780
- onDropMissed?: (event: DragEvent) => void
781
- /** Whether to automatically update the frustum each frame (default: true) */
782
- autoUpdateFrustum?: boolean
783
- /**
784
- * Enable WebGPU occlusion queries for onOccluded/onVisible events.
785
- * Auto-enabled when any object uses onOccluded or onVisible handlers.
786
- * Only works with WebGPU renderer - WebGL will log a warning.
787
- */
788
- occlusion?: boolean
789
- /** Internal: stored size props from Canvas for reset functionality */
790
- _sizeProps?: { width?: number; height?: number } | null
791
- }
792
-
793
- //* Reconciler Root ==============================
794
-
795
- interface ReconcilerRoot<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
796
- configure: (config?: RenderProps<TCanvas>) => Promise<ReconcilerRoot<TCanvas>>
797
- render: (element: ReactNode) => RootStore
798
- unmount: () => void
799
- }
800
-
801
- //* Inject State ==============================
802
-
803
- type InjectState = Partial<
804
- Omit<RootState, 'events'> & {
805
- events?: {
806
- enabled?: boolean
807
- priority?: number
808
- compute?: ComputeFunction
809
- connected?: any
810
- }
811
- /**
812
- * When true (default), injects a THREE.Scene between container and children if container isn't already a Scene.
813
- * This ensures state.scene is always a real THREE.Scene with proper properties (background, environment, fog).
814
- * Set to false to use the container directly as scene (anti-pattern, but supported for edge cases).
815
- */
816
- injectScene?: boolean
817
- }
648
+ //* Base Renderer Types =====================================
649
+
650
+ // Shim for OffscreenCanvas since it was removed from DOM types
651
+ interface OffscreenCanvas$1 extends EventTarget {}
652
+
653
+ interface BaseRendererProps {
654
+ canvas: HTMLCanvasElement | OffscreenCanvas$1
655
+ powerPreference?: 'high-performance' | 'low-power' | 'default'
656
+ antialias?: boolean
657
+ alpha?: boolean
658
+ }
659
+
660
+ type RendererFactory<TRenderer, TParams> =
661
+ | TRenderer
662
+ | ((defaultProps: TParams) => TRenderer)
663
+ | ((defaultProps: TParams) => Promise<TRenderer>)
664
+
665
+ interface Renderer {
666
+ render: (scene: THREE$1.Scene, camera: THREE$1.Camera) => any
667
+ }
668
+
669
+ //* Color Management Config ==============================
670
+
671
+ /**
672
+ * Color management configuration shared by both WebGL and WebGPU renderers.
673
+ */
674
+ interface ColorManagementConfig {
675
+ /**
676
+ * Color space assigned to 8-bit input textures (color maps).
677
+ * Defaults to sRGB. Most textures are authored in sRGB.
678
+ * @default THREE.SRGBColorSpace
679
+ */
680
+ textureColorSpace?: THREE$1.ColorSpace
681
+ }
682
+
683
+ //* WebGL Renderer Props ==============================
684
+
685
+ type DefaultGLProps = Omit<THREE$1.WebGLRendererParameters, 'canvas'> & {
686
+ canvas: HTMLCanvasElement | OffscreenCanvas$1
687
+ }
688
+
689
+ type GLProps =
690
+ | Renderer
691
+ | ((defaultProps: DefaultGLProps) => Renderer)
692
+ | ((defaultProps: DefaultGLProps) => Promise<Renderer>)
693
+ | (Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters> & ColorManagementConfig)
694
+
695
+ //* WebGPU Renderer Props ==============================
696
+
697
+ type DefaultRendererProps = {
698
+ canvas: HTMLCanvasElement | OffscreenCanvas$1
699
+ [key: string]: any
700
+ }
701
+
702
+ /**
703
+ * Canvas-level scheduler configuration.
704
+ * Controls render timing relative to other canvases.
705
+ */
706
+ interface CanvasSchedulerConfig {
707
+ /**
708
+ * Render this canvas after another canvas completes.
709
+ * Pass the `id` of another canvas.
710
+ */
711
+ after?: string
712
+ /**
713
+ * Limit this canvas's render rate (frames per second).
714
+ */
715
+ fps?: number
716
+ }
717
+
718
+ /**
719
+ * Extended renderer configuration for multi-canvas support and color management.
720
+ */
721
+ interface RendererConfigExtended extends ColorManagementConfig {
722
+ /** Share renderer from another canvas (WebGPU only) */
723
+ primaryCanvas?: string
724
+ /** Canvas-level scheduler options */
725
+ scheduler?: CanvasSchedulerConfig
726
+ }
727
+
728
+ type RendererProps =
729
+ | any // WebGPURenderer
730
+ | ((defaultProps: DefaultRendererProps) => any)
731
+ | ((defaultProps: DefaultRendererProps) => Promise<any>)
732
+ | (Partial<Properties<any> | Record<string, any>> & RendererConfigExtended)
733
+
734
+ //* Camera Props ==============================
735
+
736
+ type CameraProps = (
737
+ | THREE$1.Camera
738
+ | Partial<
739
+ ThreeElement<typeof THREE$1.Camera> &
740
+ ThreeElement<typeof THREE$1.PerspectiveCamera> &
741
+ ThreeElement<typeof THREE$1.OrthographicCamera>
742
+ >
743
+ ) & {
744
+ /** Flags the camera as manual, putting projection into your own hands */
745
+ manual?: boolean
746
+ }
747
+
748
+ //* Render Props ==============================
749
+
750
+ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
751
+ /**
752
+ * Unique identifier for multi-canvas renderer sharing.
753
+ * Makes this canvas targetable by other canvases using the `primaryCanvas` prop.
754
+ * Also sets the HTML `id` attribute on the canvas element.
755
+ * @example <Canvas id="main-viewer">...</Canvas>
756
+ */
757
+ id?: string
758
+ /**
759
+ * Share the renderer from another canvas instead of creating a new one.
760
+ * Pass the `id` of the primary canvas to share its WebGPURenderer.
761
+ * Only available with WebGPU (not legacy WebGL).
762
+ *
763
+ * Note: This is extracted from `renderer={{ primaryCanvas: "id" }}` by Canvas.
764
+ * @internal
765
+ */
766
+ primaryCanvas?: string
767
+ /**
768
+ * Canvas-level scheduler options. Controls render timing relative to other canvases.
769
+ *
770
+ * Note: This is extracted from `renderer={{ scheduler: {...} }}` by Canvas.
771
+ * @internal
772
+ */
773
+ scheduler?: CanvasSchedulerConfig
774
+ /** A threejs renderer instance or props that go into the default renderer */
775
+ gl?: GLProps
776
+ /** A WebGPU renderer instance or props that go into the default renderer */
777
+ renderer?: RendererProps
778
+ /** Dimensions to fit the renderer to. Will measure canvas dimensions if omitted */
779
+ size?: Size
780
+ /**
781
+ * Enables shadows (by default PCFsoft). Can accept `gl.shadowMap` options for fine-tuning,
782
+ * but also strings: 'basic' | 'percentage' | 'soft' | 'variance'.
783
+ * @see https://threejs.org/docs/#api/en/renderers/WebGLRenderer.shadowMap
784
+ */
785
+ shadows?: boolean | 'basic' | 'percentage' | 'soft' | 'variance' | Partial<THREE$1.WebGLShadowMap>
786
+ /** Creates an orthographic camera */
787
+ orthographic?: boolean
788
+ /**
789
+ * R3F's render mode. Set to `demand` to only render on state change or `never` to take control.
790
+ * @see https://docs.pmnd.rs/react-three-fiber/advanced/scaling-performance#on-demand-rendering
791
+ */
792
+ frameloop?: Frameloop
793
+ /**
794
+ * R3F performance options for adaptive performance.
795
+ * @see https://docs.pmnd.rs/react-three-fiber/advanced/scaling-performance#movement-regression
796
+ */
797
+ performance?: Partial<Omit<Performance, 'regress'>>
798
+ /** Target pixel ratio. Can clamp between a range: `[min, max]` */
799
+ dpr?: Dpr
800
+ /** Props that go into the default raycaster */
801
+ raycaster?: Partial<THREE$1.Raycaster>
802
+ /** A `THREE.Scene` instance or props that go into the default scene */
803
+ scene?: THREE$1.Scene | Partial<THREE$1.Scene>
804
+ /** A `THREE.Camera` instance or props that go into the default camera */
805
+ camera?: CameraProps
806
+ /** An R3F event manager to manage elements' pointer events */
807
+ events?: (store: RootStore) => EventManager<HTMLElement>
808
+ /** Callback after the canvas has rendered (but not yet committed) */
809
+ onCreated?: (state: RootState) => void
810
+ /** Response for pointer clicks that have missed any target */
811
+ onPointerMissed?: (event: MouseEvent) => void
812
+ /** Response for dragover events that have missed any target */
813
+ onDragOverMissed?: (event: DragEvent) => void
814
+ /** Response for drop events that have missed any target */
815
+ onDropMissed?: (event: DragEvent) => void
816
+ /** Whether to automatically update the frustum each frame (default: true) */
817
+ autoUpdateFrustum?: boolean
818
+ /**
819
+ * Enable WebGPU occlusion queries for onOccluded/onVisible events.
820
+ * Auto-enabled when any object uses onOccluded or onVisible handlers.
821
+ * Only works with WebGPU renderer - WebGL will log a warning.
822
+ */
823
+ occlusion?: boolean
824
+ /** Internal: stored size props from Canvas for reset functionality */
825
+ _sizeProps?: { width?: number; height?: number } | null
826
+ /** Force canvas dimensions to even numbers (fixes Safari rendering issues with odd/fractional sizes) */
827
+ forceEven?: boolean
828
+ }
829
+
830
+ //* Reconciler Root ==============================
831
+
832
+ interface ReconcilerRoot<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
833
+ configure: (config?: RenderProps<TCanvas>) => Promise<ReconcilerRoot<TCanvas>>
834
+ render: (element: ReactNode) => RootStore
835
+ unmount: () => void
836
+ }
837
+
838
+ //* Inject State ==============================
839
+
840
+ type InjectState = Partial<
841
+ Omit<RootState, 'events'> & {
842
+ events?: {
843
+ enabled?: boolean
844
+ priority?: number
845
+ compute?: ComputeFunction
846
+ connected?: any
847
+ }
848
+ /**
849
+ * When true (default), injects a THREE.Scene between container and children if container isn't already a Scene.
850
+ * This ensures state.scene is always a real THREE.Scene with proper properties (background, environment, fog).
851
+ * Set to false to use the container directly as scene (anti-pattern, but supported for edge cases).
852
+ */
853
+ injectScene?: boolean
854
+ }
818
855
  >
819
856
 
820
- //* Reconciler Types ==============================
821
-
822
- // FiberRoot is an opaque internal React type - we define it locally
823
- // to avoid bundling @types/react-reconciler which causes absolute path issues
824
- type FiberRoot = any
825
-
826
- interface Root {
827
- fiber: FiberRoot
828
- store: RootStore
829
- }
830
-
831
- type AttachFnType<O = any> = (parent: any, self: O) => () => void
832
- type AttachType<O = any> = string | AttachFnType<O>
833
-
834
- type ConstructorRepresentation<T = any> = new (...args: any[]) => T
835
-
836
- interface Catalogue {
837
- [name: string]: ConstructorRepresentation
838
- }
839
-
840
- // TODO: handle constructor overloads
841
- // https://github.com/pmndrs/react-three-fiber/pull/2931
842
- // https://github.com/microsoft/TypeScript/issues/37079
843
- type Args<T> = T extends ConstructorRepresentation
844
- ? T extends typeof Color$1
845
- ? [r: number, g: number, b: number] | [color: ColorRepresentation]
846
- : ConstructorParameters<T>
847
- : any[]
848
-
849
- type ArgsProp<P> = P extends ConstructorRepresentation
850
- ? IsAllOptional<ConstructorParameters<P>> extends true
851
- ? { args?: Args<P> }
852
- : { args: Args<P> }
853
- : { args: unknown[] }
854
-
855
- type InstanceProps<T = any, P = any> = ArgsProp<P> & {
856
- object?: T
857
- dispose?: null
858
- attach?: AttachType<T>
859
- onUpdate?: (self: T) => void
860
- }
861
-
862
- interface Instance<O = any> {
863
- root: RootStore
864
- type: string
865
- parent: Instance | null
866
- children: Instance[]
867
- props: InstanceProps<O> & Record<string, unknown>
868
- object: O & { __r3f?: Instance<O> }
869
- eventCount: number
870
- handlers: Partial<EventHandlers>
871
- attach?: AttachType<O>
872
- previousAttach?: any
873
- isHidden: boolean
874
- }
875
-
876
- interface HostConfig {
877
- type: string
878
- props: Instance['props']
879
- container: RootStore
880
- instance: Instance
881
- textInstance: void
882
- suspenseInstance: Instance
883
- hydratableInstance: never
884
- formInstance: never
885
- publicInstance: Instance['object']
886
- hostContext: {}
887
- childSet: never
888
- timeoutHandle: number | undefined
889
- noTimeout: -1
890
- TransitionStatus: null
891
- }
892
- declare global {
893
- var IS_REACT_ACT_ENVIRONMENT: boolean | undefined
894
- }
895
-
896
- //* Loop Types ==============================
897
-
898
- type GlobalRenderCallback = (timestamp: number) => void
899
-
857
+ //* Reconciler Types ==============================
858
+
859
+ // FiberRoot is an opaque internal React type - we define it locally
860
+ // to avoid bundling @types/react-reconciler which causes absolute path issues
861
+ type FiberRoot = any
862
+
863
+ interface Root {
864
+ fiber: FiberRoot
865
+ store: RootStore
866
+ }
867
+
868
+ type AttachFnType<O = any> = (parent: any, self: O) => () => void
869
+ type AttachType<O = any> = string | AttachFnType<O>
870
+
871
+ type ConstructorRepresentation<T = any> = new (...args: any[]) => T
872
+
873
+ interface Catalogue {
874
+ [name: string]: ConstructorRepresentation
875
+ }
876
+
877
+ // TODO: handle constructor overloads
878
+ // https://github.com/pmndrs/react-three-fiber/pull/2931
879
+ // https://github.com/microsoft/TypeScript/issues/37079
880
+ type Args<T> = T extends ConstructorRepresentation
881
+ ? T extends typeof Color$1
882
+ ? [r: number, g: number, b: number] | [color: ColorRepresentation]
883
+ : ConstructorParameters<T>
884
+ : any[]
885
+
886
+ type ArgsProp<P> = P extends ConstructorRepresentation
887
+ ? IsAllOptional<ConstructorParameters<P>> extends true
888
+ ? { args?: Args<P> }
889
+ : { args: Args<P> }
890
+ : { args: unknown[] }
891
+
892
+ type InstanceProps<T = any, P = any> = ArgsProp<P> & {
893
+ object?: T
894
+ dispose?: null
895
+ attach?: AttachType<T>
896
+ onUpdate?: (self: T) => void
897
+ }
898
+
899
+ interface Instance<O = any> {
900
+ root: RootStore
901
+ type: string
902
+ parent: Instance | null
903
+ children: Instance[]
904
+ props: InstanceProps<O> & Record<string, unknown>
905
+ object: O & { __r3f?: Instance<O> }
906
+ eventCount: number
907
+ handlers: Partial<EventHandlers>
908
+ attach?: AttachType<O>
909
+ previousAttach?: any
910
+ isHidden: boolean
911
+ /** Set of props that have been applied via once() */
912
+ appliedOnce?: Set<string>
913
+ }
914
+
915
+ interface HostConfig {
916
+ type: string
917
+ props: Instance['props']
918
+ container: RootStore
919
+ instance: Instance
920
+ textInstance: void
921
+ suspenseInstance: Instance
922
+ hydratableInstance: never
923
+ formInstance: never
924
+ publicInstance: Instance['object']
925
+ hostContext: {}
926
+ childSet: never
927
+ timeoutHandle: number | undefined
928
+ noTimeout: -1
929
+ TransitionStatus: null
930
+ }
931
+ declare global {
932
+ var IS_REACT_ACT_ENVIRONMENT: boolean | undefined
933
+ }
934
+
935
+ //* Loop Types ==============================
936
+
937
+ type GlobalRenderCallback = (timestamp: number) => void
938
+
900
939
  type GlobalEffectType = 'before' | 'after' | 'tail'
901
940
 
902
- //* Canvas Types ==============================
903
-
904
- interface CanvasProps
905
- extends Omit<RenderProps<HTMLCanvasElement>, 'size'>, React$1.HTMLAttributes<HTMLDivElement> {
906
- children?: React$1.ReactNode
907
- ref?: React$1.Ref<HTMLCanvasElement>
908
- /** Canvas fallback content, similar to img's alt prop */
909
- fallback?: React$1.ReactNode
910
- /**
911
- * Options to pass to useMeasure.
912
- * @see https://github.com/pmndrs/react-use-measure#api
913
- */
914
- resize?: Options
915
- /** The target where events are being subscribed to, default: the div that wraps canvas */
916
- eventSource?: HTMLElement | React$1.RefObject<HTMLElement>
917
- /** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
918
- eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
919
- /** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
920
- hmr?: boolean
921
- /** Canvas resolution width in pixels. If omitted, uses container width. */
922
- width?: number
923
- /** Canvas resolution height in pixels. If omitted, uses container height. */
924
- height?: number
925
- }
926
-
927
- //* Loader Types ==============================
928
-
929
- type InputLike = string | string[] | string[][] | Readonly<string | string[] | string[][]>
930
-
931
- // Define a loader-like interface that matches THREE.Loader's load signature
932
- // This works for both generic and non-generic THREE.Loader instances
933
- interface LoaderLike {
934
- load(
935
- url: InputLike,
936
- onLoad?: (result: any) => void,
937
- onProgress?: (event: ProgressEvent<EventTarget>) => void,
938
- onError?: (error: unknown) => void,
939
- ): any
940
- }
941
-
942
- type GLTFLike = { scene: THREE$1.Object3D }
943
-
944
- type LoaderInstance<T extends LoaderLike | ConstructorRepresentation<LoaderLike>> =
945
- T extends ConstructorRepresentation<LoaderLike> ? InstanceType<T> : T
946
-
947
- // Infer result type from the load method's callback parameter
948
- type InferLoadResult<T> = T extends {
949
- load(url: any, onLoad?: (result: infer R) => void, ...args: any[]): any
950
- }
951
- ? R
952
- : T extends ConstructorRepresentation<any>
953
- ? InstanceType<T> extends {
954
- load(url: any, onLoad?: (result: infer R) => void, ...args: any[]): any
955
- }
956
- ? R
957
- : any
958
- : any
959
-
960
- type LoaderResult<T extends LoaderLike | ConstructorRepresentation<LoaderLike>> =
961
- InferLoadResult<LoaderInstance<T>> extends infer R ? (R extends GLTFLike ? R & ObjectMap : R) : never
962
-
963
- type Extensions<T extends LoaderLike | ConstructorRepresentation<LoaderLike>> = (
964
- loader: LoaderInstance<T>,
941
+ declare const presetsObj: {
942
+ apartment: string;
943
+ city: string;
944
+ dawn: string;
945
+ forest: string;
946
+ lobby: string;
947
+ night: string;
948
+ park: string;
949
+ studio: string;
950
+ sunset: string;
951
+ warehouse: string;
952
+ };
953
+ type PresetsType = keyof typeof presetsObj;
954
+
955
+ //* Background Types ==============================
956
+
957
+ /**
958
+ * Expanded object form for background configuration.
959
+ * Allows separate textures for background (visual backdrop) and environment (PBR lighting).
960
+ */
961
+ interface BackgroundConfig {
962
+ /** HDRI preset name: 'apartment', 'city', 'dawn', 'forest', 'lobby', 'night', 'park', 'studio', 'sunset', 'warehouse' */
963
+ preset?: PresetsType
964
+ /** Files for cube texture (6 faces) or single HDR/EXR */
965
+ files?: string | string[]
966
+ /** Separate files for scene.background (visual backdrop) */
967
+ backgroundMap?: string | string[]
968
+ backgroundRotation?: Euler$1 | [number, number, number]
969
+ backgroundBlurriness?: number
970
+ backgroundIntensity?: number
971
+ /** Separate files for scene.environment (PBR lighting/reflections) */
972
+ envMap?: string | string[]
973
+ environmentRotation?: Euler$1 | [number, number, number]
974
+ environmentIntensity?: number
975
+ path?: string
976
+ extensions?: (loader: Loader) => void
977
+ }
978
+
979
+ /**
980
+ * Background prop type for Canvas.
981
+ *
982
+ * String detection priority:
983
+ * 1. Preset - exact match against known presets (apartment, city, dawn, forest, lobby, night, park, studio, sunset, warehouse)
984
+ * 2. URL - starts with /, ./, ../, http://, https://, OR has image extension
985
+ * 3. Color - default fallback (CSS color names, hex values, rgb(), etc.)
986
+ *
987
+ * @example Color
988
+ * ```tsx
989
+ * <Canvas background="red" />
990
+ * <Canvas background="#ff0000" />
991
+ * <Canvas background={0xff0000} />
992
+ * ```
993
+ *
994
+ * @example Preset
995
+ * ```tsx
996
+ * <Canvas background="city" />
997
+ * ```
998
+ *
999
+ * @example URL
1000
+ * ```tsx
1001
+ * <Canvas background="/path/to/env.hdr" />
1002
+ * <Canvas background="./sky.jpg" />
1003
+ * ```
1004
+ *
1005
+ * @example Object form
1006
+ * ```tsx
1007
+ * <Canvas background={{
1008
+ * files: ['px.png', 'nx.png', 'py.png', 'ny.png', 'pz.png', 'nz.png'],
1009
+ * backgroundMap: 'path/to/sky.jpg',
1010
+ * envMap: 'path/to/lighting.hdr',
1011
+ * backgroundBlurriness: 0.5,
1012
+ * }} />
1013
+ * ```
1014
+ */
1015
+ type BackgroundProp =
1016
+ | ColorRepresentation // "red", "#ff0000", 0xff0000
1017
+ | string // URL or preset
1018
+ | BackgroundConfig // Expanded object form
1019
+
1020
+ //* Canvas Types ==============================
1021
+
1022
+ interface CanvasProps
1023
+ extends
1024
+ Omit<RenderProps<HTMLCanvasElement>, 'size' | 'primaryCanvas' | 'scheduler'>,
1025
+ React$1.HTMLAttributes<HTMLDivElement> {
1026
+ children?: React$1.ReactNode
1027
+ ref?: React$1.Ref<HTMLCanvasElement>
1028
+ /** Canvas fallback content, similar to img's alt prop */
1029
+ fallback?: React$1.ReactNode
1030
+ /**
1031
+ * Options to pass to useMeasure.
1032
+ * @see https://github.com/pmndrs/react-use-measure#api
1033
+ */
1034
+ resize?: Options
1035
+ /** The target where events are being subscribed to, default: the div that wraps canvas */
1036
+ eventSource?: HTMLElement | React$1.RefObject<HTMLElement | null>
1037
+ /** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
1038
+ eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
1039
+ /** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
1040
+ hmr?: boolean
1041
+ /** Canvas resolution width in pixels. If omitted, uses container width. */
1042
+ width?: number
1043
+ /** Canvas resolution height in pixels. If omitted, uses container height. */
1044
+ height?: number
1045
+ /** Force canvas dimensions to even numbers (fixes Safari rendering issues with odd/fractional sizes) */
1046
+ forceEven?: boolean
1047
+ /**
1048
+ * Scene background configuration.
1049
+ * Accepts colors, URLs, presets, or an expanded object for separate background/environment.
1050
+ * @see BackgroundProp for full documentation and examples
1051
+ */
1052
+ background?: BackgroundProp
1053
+ }
1054
+
1055
+ //* Loader Types ==============================
1056
+
1057
+ type InputLike = string | string[] | string[][] | Readonly<string | string[] | string[][]>
1058
+
1059
+ // Define a loader-like interface that matches THREE.Loader's load signature
1060
+ // This works for both generic and non-generic THREE.Loader instances
1061
+ interface LoaderLike {
1062
+ load(
1063
+ url: InputLike,
1064
+ onLoad?: (result: any) => void,
1065
+ onProgress?: (event: ProgressEvent<EventTarget>) => void,
1066
+ onError?: (error: unknown) => void,
1067
+ ): any
1068
+ }
1069
+
1070
+ type GLTFLike = { scene: THREE$1.Object3D }
1071
+
1072
+ type LoaderInstance<T extends LoaderLike | ConstructorRepresentation<LoaderLike>> =
1073
+ T extends ConstructorRepresentation<LoaderLike> ? InstanceType<T> : T
1074
+
1075
+ // Infer result type from the load method's callback parameter
1076
+ type InferLoadResult<T> = T extends {
1077
+ load(url: any, onLoad?: (result: infer R) => void, ...args: any[]): any
1078
+ }
1079
+ ? R
1080
+ : T extends ConstructorRepresentation<any>
1081
+ ? InstanceType<T> extends {
1082
+ load(url: any, onLoad?: (result: infer R) => void, ...args: any[]): any
1083
+ }
1084
+ ? R
1085
+ : any
1086
+ : any
1087
+
1088
+ type LoaderResult<T extends LoaderLike | ConstructorRepresentation<LoaderLike>> =
1089
+ InferLoadResult<LoaderInstance<T>> extends infer R ? (R extends GLTFLike ? R & ObjectMap : R) : never
1090
+
1091
+ type Extensions<T extends LoaderLike | ConstructorRepresentation<LoaderLike>> = (
1092
+ loader: LoaderInstance<T>,
965
1093
  ) => void
966
1094
 
967
- type WebGLDefaultProps = Omit<THREE$1.WebGLRendererParameters, 'canvas'> & BaseRendererProps
968
-
969
- type WebGLProps =
970
- | RendererFactory<THREE$1.WebGLRenderer, WebGLDefaultProps>
971
- | Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters>
972
-
973
- interface WebGLShadowConfig {
974
- shadows?: boolean | 'basic' | 'percentage' | 'soft' | 'variance' | Partial<THREE$1.WebGLShadowMap>
1095
+ //* Renderer Props ========================================
1096
+
1097
+ type WebGLDefaultProps = Omit<THREE$1.WebGLRendererParameters, 'canvas'> & BaseRendererProps
1098
+
1099
+ type WebGLProps =
1100
+ | RendererFactory<THREE$1.WebGLRenderer, WebGLDefaultProps>
1101
+ | Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters>
1102
+
1103
+ interface WebGLShadowConfig {
1104
+ shadows?: boolean | 'basic' | 'percentage' | 'soft' | 'variance' | Partial<THREE$1.WebGLShadowMap>
1105
+ }
1106
+
1107
+ //* Legacy-specific Types ========================================
1108
+
1109
+ /** Legacy (WebGL) renderer type - re-exported as R3FRenderer from @react-three/fiber/legacy */
1110
+ type LegacyRenderer = THREE$1.WebGLRenderer
1111
+
1112
+ /** Legacy internal state with narrowed renderer type */
1113
+ interface LegacyInternalState extends Omit<InternalState, 'actualRenderer'> {
1114
+ actualRenderer: THREE$1.WebGLRenderer
1115
+ }
1116
+
1117
+ /**
1118
+ * Legacy-specific RootState with narrowed renderer type.
1119
+ * Automatically used when importing from `@react-three/fiber/legacy`.
1120
+ *
1121
+ * @example
1122
+ * ```tsx
1123
+ * import { useThree } from '@react-three/fiber/legacy'
1124
+ *
1125
+ * function MyComponent() {
1126
+ * const { renderer } = useThree()
1127
+ * // renderer is typed as THREE.WebGLRenderer
1128
+ * renderer.shadowMap.enabled = true
1129
+ * }
1130
+ * ```
1131
+ */
1132
+ interface LegacyRootState extends Omit<RootState, 'renderer' | 'internal'> {
1133
+ /** The WebGL renderer instance */
1134
+ renderer: THREE$1.WebGLRenderer
1135
+ /** Internals with WebGL renderer */
1136
+ internal: LegacyInternalState
975
1137
  }
976
1138
 
977
- //* RenderTarget Types ==============================
978
-
979
-
1139
+ //* RenderTarget Types ==============================
1140
+
1141
+
980
1142
  type RenderTargetOptions = RenderTargetOptions$1
981
1143
 
982
- //* Global Types ==============================
983
-
984
- declare global {
985
- /** Uniform node type - a Node with a value property (matches Three.js UniformNode) */
986
- interface UniformNode<T = unknown> extends Node {
987
- value: T
988
- }
989
-
990
- /** Flat record of uniform nodes (no nested scopes) */
991
- type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
992
-
993
- /**
994
- * Uniform store that can contain both root-level uniforms and scoped uniform objects
995
- * Used by state.uniforms which has structure like:
996
- * { uTime: UniformNode, player: { uHealth: UniformNode }, enemy: { uHealth: UniformNode } }
997
- */
998
- type UniformStore = Record<string, UniformNode | UniformRecord>
999
-
1000
- /**
1001
- * Helper to safely access a uniform node from the store.
1002
- * Use this when accessing state.uniforms to get proper typing.
1003
- * @example
1004
- * const uTime = uniforms.uTime as UniformNode<number>
1005
- * const uColor = uniforms.uColor as UniformNode<import('three/webgpu').Color>
1006
- */
1007
- type GetUniform<T = unknown> = UniformNode<T>
1008
-
1009
- /**
1010
- * Acceptable input values for useUniforms - raw values that get converted to UniformNodes
1011
- * Supports: primitives, Three.js types, plain objects (converted to vectors), and UniformNodes
1012
- */
1013
- type UniformValue =
1014
- | number
1015
- | string
1016
- | boolean
1017
- | three_webgpu.Color
1018
- | three_webgpu.Vector2
1019
- | three_webgpu.Vector3
1020
- | three_webgpu.Vector4
1021
- | three_webgpu.Matrix3
1022
- | three_webgpu.Matrix4
1023
- | three_webgpu.Euler
1024
- | three_webgpu.Quaternion
1025
- | { x: number; y?: number; z?: number; w?: number } // Plain objects converted to vectors
1026
- | UniformNode
1027
-
1028
- /** Input record for useUniforms - accepts raw values or UniformNodes */
1029
- type UniformInputRecord = Record<string, UniformValue>
1030
- }
1031
-
1032
- //* Fn Return Type ==============================
1033
-
1034
- /** The return type of Fn() - a callable shader function node */
1035
- type ShaderCallable<R extends Node = Node> = ((...params: unknown[]) => ShaderNodeObject<R>) & Node
1036
-
1037
- //* Module Augmentation ==============================
1038
-
1039
- declare module 'three/tsl' {
1040
- /**
1041
- * Fn with array parameter destructuring
1042
- * @example Fn(([uv, skew]) => { ... })
1043
- */
1044
- export function Fn<R extends Node = Node>(
1045
- jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
1046
- ): ShaderCallable<R>
1047
-
1048
- /**
1049
- * Fn with object parameter destructuring
1050
- * @example Fn(({ color, intensity }) => { ... })
1051
- */
1052
- export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
1053
- jsFunc: (inputs: T) => ShaderNodeObject<R>,
1054
- ): ShaderCallable<R>
1055
-
1056
- /**
1057
- * Fn with array params + layout
1058
- * @example Fn(([a, b]) => { ... }, { layout: [...] })
1059
- */
1060
- export function Fn<R extends Node = Node>(
1061
- jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
1062
- layout: { layout?: unknown },
1063
- ): ShaderCallable<R>
1064
-
1065
- /**
1066
- * Fn with object params + layout
1067
- */
1068
- export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
1069
- jsFunc: (inputs: T) => ShaderNodeObject<R>,
1070
- layout: { layout?: unknown },
1071
- ): ShaderCallable<R>
1072
- }
1073
-
1074
- /**
1075
- * PostProcessing Types for usePostProcessing hook (WebGPU only)
1076
- */
1077
-
1078
-
1079
-
1080
- declare global {
1081
- /** Pass record - stores TSL pass nodes for post-processing */
1082
- type PassRecord = Record<string, any>
1083
-
1084
- /** Setup callback - runs first to configure MRT, create additional passes */
1085
- type PostProcessingSetupCallback = (state: RootState) => PassRecord | void
1086
-
1087
- /** Main callback - runs second to configure outputNode, create effect passes */
1088
- type PostProcessingMainCallback = (state: RootState) => PassRecord | void
1089
-
1090
- /** Return type for usePostProcessing hook */
1091
- interface UsePostProcessingReturn {
1092
- /** Current passes from state */
1093
- passes: PassRecord
1094
- /** PostProcessing instance (null if not initialized) */
1095
- postProcessing: any | null // THREE.PostProcessing
1096
- /** Clear all passes from state */
1097
- clearPasses: () => void
1098
- /** Reset PostProcessing entirely (clears PP + passes) */
1099
- reset: () => void
1100
- /** Re-run setup/main callbacks with current closure values */
1101
- rebuild: () => void
1102
- /** True when PostProcessing is configured and ready */
1103
- isReady: boolean
1104
- }
1105
- }
1106
-
1107
- //* useFrameNext Types ==============================
1108
-
1109
-
1110
-
1111
- //* Global Type Declarations ==============================
1112
-
1113
- declare global {
1114
- // Job --------------------------------
1115
-
1116
- /**
1117
- * Internal job representation in the scheduler
1118
- */
1119
- interface Job {
1120
- /** Unique identifier */
1121
- id: string
1122
- /** The callback to execute */
1123
- callback: FrameNextCallback
1124
- /** Phase this job belongs to */
1125
- phase: string
1126
- /** Run before these phases/job ids */
1127
- before: Set<string>
1128
- /** Run after these phases/job ids */
1129
- after: Set<string>
1130
- /** Priority within phase (higher first) */
1131
- priority: number
1132
- /** Insertion order for deterministic tie-breaking */
1133
- index: number
1134
- /** Max FPS for this job (undefined = no limit) */
1135
- fps?: number
1136
- /** Drop frames when behind (true) or catch up (false) */
1137
- drop: boolean
1138
- /** Last run timestamp (ms) */
1139
- lastRun?: number
1140
- /** Whether job is enabled */
1141
- enabled: boolean
1142
- /** Internal flag: system jobs (like default render) don't block user render takeover */
1143
- system?: boolean
1144
- }
1145
-
1146
- // Phase Graph --------------------------------
1147
-
1148
- /**
1149
- * A node in the phase graph
1150
- */
1151
- interface PhaseNode {
1152
- /** Phase name */
1153
- name: string
1154
- /** Whether this was auto-generated from a before/after constraint */
1155
- isAutoGenerated: boolean
1156
- }
1157
-
1158
- /**
1159
- * Options for creating a job from hook options
1160
- */
1161
- interface JobOptions {
1162
- id?: string
1163
- phase?: string
1164
- before?: string | string[]
1165
- after?: string | string[]
1166
- priority?: number
1167
- fps?: number
1168
- drop?: boolean
1169
- enabled?: boolean
1170
- }
1171
-
1172
- // Frame Loop State --------------------------------
1173
-
1174
- /**
1175
- * Internal frame loop state
1176
- */
1177
- interface FrameLoopState {
1178
- /** Whether the loop is running */
1179
- running: boolean
1180
- /** Current RAF handle */
1181
- rafHandle: number | null
1182
- /** Last frame timestamp in ms (null = uninitialized) */
1183
- lastTime: number | null
1184
- /** Frame counter */
1185
- frameCount: number
1186
- /** Elapsed time since first frame in ms */
1187
- elapsedTime: number
1188
- /** createdAt timestamp in ms */
1189
- createdAt: number
1190
- }
1191
-
1192
- // Root Entry --------------------------------
1193
-
1194
- /**
1195
- * Internal representation of a registered root (Canvas).
1196
- * Tracks jobs and manages rebuild state for this root.
1197
- * @internal
1198
- */
1199
- interface RootEntry {
1200
- /** Unique identifier for this root */
1201
- id: string
1202
- /** Function to get the root's current state. Returns any to support independent mode. */
1203
- getState: () => any
1204
- /** Map of job IDs to Job objects */
1205
- jobs: Map<string, Job>
1206
- /** Cached sorted job list for execution order */
1207
- sortedJobs: Job[]
1208
- /** Whether sortedJobs needs rebuilding */
1209
- needsRebuild: boolean
1210
- }
1211
-
1212
- /**
1213
- * Internal representation of a global job (deprecated API).
1214
- * Global jobs run once per frame, not per-root.
1215
- * Used by legacy addEffect/addAfterEffect APIs.
1216
- * @internal
1217
- * @deprecated Use useFrame with phases instead
1218
- */
1219
- interface GlobalJob {
1220
- /** Unique identifier for this global job */
1221
- id: string
1222
- /** Callback invoked with RAF timestamp in ms */
1223
- callback: (timestamp: number) => void
1224
- }
1225
-
1226
- // HMR Support --------------------------------
1227
-
1228
- /**
1229
- * Hot Module Replacement data structure for preserving scheduler state
1230
- * @internal
1231
- */
1232
- interface HMRData {
1233
- /** Shared data object for storing values across reloads */
1234
- data: Record<string, any>
1235
- /** Optional function to accept HMR updates */
1236
- accept?: () => void
1237
- }
1238
-
1239
- // Default Phases --------------------------------
1240
-
1241
- /**
1242
- * Default phase names for the scheduler
1243
- */
1244
- type DefaultPhase = 'start' | 'input' | 'physics' | 'update' | 'render' | 'finish'
1245
- }
1246
-
1247
- type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
1248
-
1249
- interface MathRepresentation {
1250
- set(...args: number[]): any
1251
- }
1252
- interface VectorRepresentation extends MathRepresentation {
1253
- setScalar(value: number): any
1254
- }
1255
- type MathTypes = MathRepresentation | Euler$1 | Color$2
1256
-
1257
- type MathType<T extends MathTypes> = T extends Color$2
1258
- ? Args<typeof Color$2> | ColorRepresentation$1
1259
- : T extends VectorRepresentation | Layers$1 | Euler$1
1260
- ? T | MutableOrReadonlyParameters<T['set']> | number
1261
- : T | MutableOrReadonlyParameters<T['set']>
1262
-
1263
- type MathProps<P> = {
1264
- [K in keyof P as P[K] extends MathTypes ? K : never]: P[K] extends MathTypes ? MathType<P[K]> : never
1265
- }
1266
-
1267
- type Vector2 = MathType<Vector2$1>
1268
- type Vector3 = MathType<Vector3$1>
1269
- type Vector4 = MathType<Vector4$1>
1270
- type Color = MathType<Color$2>
1271
- type Layers = MathType<Layers$1>
1272
- type Quaternion = MathType<Quaternion$1>
1273
- type Euler = MathType<Euler$1>
1274
- type Matrix3 = MathType<Matrix3$1>
1275
- type Matrix4 = MathType<Matrix4$1>
1276
-
1277
- interface RaycastableRepresentation {
1278
- raycast(raycaster: Raycaster, intersects: Intersection$1[]): void
1279
- }
1280
- type EventProps<P> = P extends RaycastableRepresentation ? Partial<EventHandlers> : {}
1281
-
1282
- interface ReactProps<P> {
1283
- children?: React.ReactNode
1284
- ref?: React.Ref<P>
1285
- key?: React.Key
1286
- }
1287
-
1288
- type ElementProps<T extends ConstructorRepresentation, P = InstanceType<T>> = Partial<
1289
- Overwrite<P, MathProps<P> & ReactProps<P> & EventProps<P>>
1290
- >
1291
-
1292
- type ThreeElement<T extends ConstructorRepresentation> = Mutable<
1293
- Overwrite<ElementProps<T>, Omit<InstanceProps<InstanceType<T>, T>, 'object'>>
1294
- >
1295
-
1296
- type ThreeToJSXElements<T extends Record<string, any>> = {
1297
- [K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
1298
- }
1299
-
1300
- type ThreeExports = typeof THREE
1301
- type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
1302
-
1303
- interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
1304
- primitive: Omit<ThreeElement<any>, 'args'> & { object: object }
1305
- // Conflicts with DOM types can be accessed through a three* prefix
1306
- threeAudio: ThreeElementsImpl['audio']
1307
- threeSource: ThreeElementsImpl['source']
1308
- threeLine: ThreeElementsImpl['line']
1309
- threePath: ThreeElementsImpl['path']
1310
- }
1311
-
1312
- declare module 'react' {
1313
- namespace JSX {
1314
- interface IntrinsicElements extends ThreeElements {}
1315
- }
1316
- }
1317
-
1318
- declare module 'react/jsx-runtime' {
1319
- namespace JSX {
1320
- interface IntrinsicElements extends ThreeElements {}
1321
- }
1322
- }
1323
-
1324
- declare module 'react/jsx-dev-runtime' {
1325
- namespace JSX {
1326
- interface IntrinsicElements extends ThreeElements {}
1327
- }
1144
+ //* Global Types ==============================
1145
+
1146
+ declare global {
1147
+ /**
1148
+ * Uniform node type.
1149
+ *
1150
+ * This is three's own `UniformNode`, not a re-declaration of it. It previously was a
1151
+ * hand-rolled `interface UniformNode<T> extends Node { value: T }`, which shadowed the real
1152
+ * exported type globally — so R3F's ~58 references resolved to an approximation that was
1153
+ * missing members three actually ships (`setName` among them) and had drifted to the wrong
1154
+ * arity when three made `UniformNode` two-parameter.
1155
+ *
1156
+ * three's signature is `UniformNode<TNodeType, TValue>`. R3F only ever varies the value type,
1157
+ * so the node type is fixed to `unknown` and the single parameter is kept for call-site
1158
+ * ergonomics. The result is three's structural type, so members stay in sync with the
1159
+ * installed three instead of needing to be mirrored by hand.
1160
+ */
1161
+ type UniformNode<T = unknown> = three_webgpu.UniformNode<unknown, T>
1162
+
1163
+ /**
1164
+ * ShaderCallable - the return type of Fn()
1165
+ * A callable shader function node that can be invoked with parameters.
1166
+ * The function returns a ShaderNodeObject when called.
1167
+ *
1168
+ * @example
1169
+ * ```tsx
1170
+ * // Define a shader function
1171
+ * const blendColorFn = Fn(([color1, color2, factor]) => {
1172
+ * return mix(color1, color2, factor)
1173
+ * })
1174
+ *
1175
+ * // Type when retrieving from nodes store
1176
+ * const { blendColorFn } = nodes as { blendColorFn: ShaderCallable }
1177
+ *
1178
+ * // Or with specific return type
1179
+ * const { myFn } = nodes as { myFn: ShaderCallable<THREE.Node> }
1180
+ * ```
1181
+ */
1182
+ type ShaderCallable<R extends Node = Node> = ((...params: unknown[]) => ShaderNodeObject<R>) & Node
1183
+
1184
+ /**
1185
+ * ShaderNodeRef - a ShaderNodeObject wrapper around a Node
1186
+ * This is the common return type for TSL operations (add, mul, sin, etc.)
1187
+ *
1188
+ * @example
1189
+ * ```tsx
1190
+ * const { wobble } = nodes as { wobble: ShaderNodeRef }
1191
+ * ```
1192
+ */
1193
+ type ShaderNodeRef<T extends Node = Node> = ShaderNodeObject<T>
1194
+
1195
+ /**
1196
+ * TSLNodeType - Union of all common TSL node types
1197
+ * Used by ScopedStore to properly type node access from the store.
1198
+ *
1199
+ * Includes:
1200
+ * - Node: base Three.js node type
1201
+ * - ShaderCallable: function nodes created with Fn()
1202
+ * - ShaderNodeObject: wrapped nodes from TSL operations (sin, mul, mix, etc.)
1203
+ *
1204
+ * @example
1205
+ * ```tsx
1206
+ * // In useLocalNodes, nodes are typed as TSLNodeType
1207
+ * const { positionNode, blendColorFn } = useLocalNodes(({ nodes }) => ({
1208
+ * positionNode: nodes.myPosition, // Works - Node is in union
1209
+ * blendColorFn: nodes.myFn, // Works - ShaderCallable is in union
1210
+ * }))
1211
+ *
1212
+ * // Can narrow with type guard or assertion when needed
1213
+ * if (typeof blendColorFn === 'function') {
1214
+ * blendColorFn(someColor, 0.5)
1215
+ * }
1216
+ * ```
1217
+ */
1218
+ type TSLNodeType = Node | ShaderCallable<Node> | ShaderNodeObject<Node>
1219
+
1220
+ /** Flat record of uniform nodes (no nested scopes) */
1221
+ type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
1222
+
1223
+ /**
1224
+ * Uniform store that can contain both root-level uniforms and scoped uniform objects
1225
+ * Used by state.uniforms which has structure like:
1226
+ * { uTime: UniformNode, player: { uHealth: UniformNode }, enemy: { uHealth: UniformNode } }
1227
+ */
1228
+ type UniformStore = Record<string, UniformNode | UniformRecord>
1229
+
1230
+ /**
1231
+ * Helper to safely access a uniform node from the store.
1232
+ * Use this when accessing state.uniforms to get proper typing.
1233
+ * @example
1234
+ * const uTime = uniforms.uTime as UniformNode<number>
1235
+ * const uColor = uniforms.uColor as UniformNode<import('three/webgpu').Color>
1236
+ */
1237
+ type GetUniform<T = unknown> = UniformNode<T>
1238
+
1239
+ /**
1240
+ * Acceptable input values for useUniforms - raw values that get converted to UniformNodes
1241
+ * Supports:
1242
+ * - Primitives: number, string (color), boolean
1243
+ * - Three.js types: Color, Vector2/3/4, Matrix3/4, Euler, Quaternion
1244
+ * - Plain objects: { x, y, z, w } converted to vectors
1245
+ * - TSL nodes: color(), vec3(), float() for type casting
1246
+ * - UniformNode: existing uniforms (reused as-is)
1247
+ */
1248
+ type UniformValue =
1249
+ | number
1250
+ | string
1251
+ | boolean
1252
+ | three_webgpu.Color
1253
+ | three_webgpu.Vector2
1254
+ | three_webgpu.Vector3
1255
+ | three_webgpu.Vector4
1256
+ | three_webgpu.Matrix3
1257
+ | three_webgpu.Matrix4
1258
+ | three_webgpu.Euler
1259
+ | three_webgpu.Quaternion
1260
+ | { x: number; y?: number; z?: number; w?: number } // Plain objects converted to vectors
1261
+ | { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
1262
+ | Node // TSL nodes like color(), vec3(), float() for type casting
1263
+ | UniformNode
1264
+
1265
+ /** Input record for useUniforms - accepts raw values or UniformNodes */
1266
+ type UniformInputRecord = Record<string, UniformValue>
1267
+ }
1268
+
1269
+ //* Module Augmentation ==============================
1270
+
1271
+ declare module 'three/tsl' {
1272
+ /**
1273
+ * Fn with array parameter destructuring
1274
+ * @example Fn(([uv, skew]) => { ... })
1275
+ */
1276
+ export function Fn<R extends Node = Node>(
1277
+ jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
1278
+ ): ShaderCallable<R>
1279
+
1280
+ /**
1281
+ * Fn with object parameter destructuring
1282
+ * @example Fn(({ color, intensity }) => { ... })
1283
+ */
1284
+ export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
1285
+ jsFunc: (inputs: T) => ShaderNodeObject<R>,
1286
+ ): ShaderCallable<R>
1287
+
1288
+ /**
1289
+ * Fn with array params + layout
1290
+ * @example Fn(([a, b]) => { ... }, { layout: [...] })
1291
+ */
1292
+ export function Fn<R extends Node = Node>(
1293
+ jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
1294
+ layout: { layout?: unknown },
1295
+ ): ShaderCallable<R>
1296
+
1297
+ /**
1298
+ * Fn with object params + layout
1299
+ */
1300
+ export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
1301
+ jsFunc: (inputs: T) => ShaderNodeObject<R>,
1302
+ layout: { layout?: unknown },
1303
+ ): ShaderCallable<R>
1304
+ }
1305
+
1306
+ declare global {
1307
+ /**
1308
+ * three's own render pipeline type. Named here so the rest of R3F refers to three's shape
1309
+ * rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
1310
+ * is r185, so the new name is the only one.
1311
+ */
1312
+ type ThreeRenderPipeline = three_webgpu.RenderPipeline
1313
+
1314
+ /** Pass record - stores TSL pass nodes for render pipeline */
1315
+ type PassRecord = Record<string, any>
1316
+
1317
+ /** Setup callback - runs first to configure MRT, create additional passes */
1318
+ type RenderPipelineSetupCallback = (state: RootState) => PassRecord | void
1319
+
1320
+ /** Main callback - runs second to configure outputNode, create effect passes */
1321
+ type RenderPipelineMainCallback = (state: RootState) => PassRecord | void
1322
+
1323
+ /** Return type for useRenderPipeline hook */
1324
+ interface UseRenderPipelineReturn {
1325
+ /** Current passes from state */
1326
+ passes: PassRecord
1327
+ /** RenderPipeline instance (null if not initialized) */
1328
+ renderPipeline: ThreeRenderPipeline | null
1329
+ /** Clear all passes from state */
1330
+ clearPasses: () => void
1331
+ /** Reset RenderPipeline entirely (clears PP + passes) */
1332
+ reset: () => void
1333
+ /** Re-run setup/main callbacks with current closure values */
1334
+ rebuild: () => void
1335
+ /** True when RenderPipeline is configured and ready */
1336
+ isReady: boolean
1337
+ }
1338
+ }
1339
+
1340
+ type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
1341
+
1342
+ interface MathRepresentation {
1343
+ set(...args: number[]): any
1344
+ }
1345
+ interface VectorRepresentation extends MathRepresentation {
1346
+ setScalar(value: number): any
1347
+ }
1348
+ type MathTypes = MathRepresentation | Euler$2 | Color$2
1349
+
1350
+ type MathType<T extends MathTypes> = T extends Color$2
1351
+ ? Args<typeof Color$2> | ColorRepresentation$1
1352
+ : T extends VectorRepresentation | Layers$1 | Euler$2
1353
+ ? T | MutableOrReadonlyParameters<T['set']> | number
1354
+ : T | MutableOrReadonlyParameters<T['set']>
1355
+
1356
+ type MathProps<P> = {
1357
+ [K in keyof P as P[K] extends MathTypes ? K : never]: P[K] extends MathTypes ? MathType<P[K]> : never
1358
+ }
1359
+
1360
+ type Vector2 = MathType<Vector2$1>
1361
+ type Vector3 = MathType<Vector3$1>
1362
+ type Vector4 = MathType<Vector4$1>
1363
+ type Color = MathType<Color$2>
1364
+ type Layers = MathType<Layers$1>
1365
+ type Quaternion = MathType<Quaternion$1>
1366
+ type Euler = MathType<Euler$2>
1367
+ type Matrix3 = MathType<Matrix3$1>
1368
+ type Matrix4 = MathType<Matrix4$1>
1369
+
1370
+ interface RaycastableRepresentation {
1371
+ raycast(raycaster: Raycaster, intersects: Intersection$1[]): void
1372
+ }
1373
+ type EventProps<P> = P extends RaycastableRepresentation ? Partial<EventHandlers> : {}
1374
+
1375
+ /**
1376
+ * Props for geometry transform methods that can be called with `once()`.
1377
+ * These methods modify the geometry in-place and only make sense to call once on mount.
1378
+ *
1379
+ * @example
1380
+ * import { once } from '@react-three/fiber'
1381
+ *
1382
+ * <boxGeometry args={[1, 1, 1]} rotateX={once(Math.PI / 2)} />
1383
+ * <planeGeometry args={[10, 10]} translate={once(0, 0, 5)} />
1384
+ * <bufferGeometry applyMatrix4={once(matrix)} center={once()} />
1385
+ */
1386
+ interface GeometryTransformProps {
1387
+ /** Rotate the geometry about the X axis (radians). Use with once(). */
1388
+ rotateX?: number
1389
+ /** Rotate the geometry about the Y axis (radians). Use with once(). */
1390
+ rotateY?: number
1391
+ /** Rotate the geometry about the Z axis (radians). Use with once(). */
1392
+ rotateZ?: number
1393
+ /** Translate the geometry (x, y, z). Use with once(). */
1394
+ translate?: [x: number, y: number, z: number]
1395
+ /** Scale the geometry (x, y, z). Use with once(). */
1396
+ scale?: [x: number, y: number, z: number]
1397
+ /** Center the geometry based on bounding box. Use with once(). */
1398
+ center?: true
1399
+ /** Apply a Matrix4 transformation. Use with once(). */
1400
+ applyMatrix4?: Matrix4$1
1401
+ /** Apply a Quaternion rotation. Use with once(). */
1402
+ applyQuaternion?: Quaternion$1
1403
+ }
1404
+
1405
+ type GeometryProps<P> = P extends BufferGeometry ? GeometryTransformProps : {}
1406
+
1407
+ /**
1408
+ * Workaround for @types/three TSL node type issues.
1409
+ * The Node base class has properties that subclasses (OperatorNode, ConstNode, etc.) don't inherit.
1410
+ * This transforms `Node | null` properties to accept any object with node-like shape.
1411
+ */
1412
+ type TSLNodeInput = { nodeType?: string | null; uuid?: string } | null
1413
+
1414
+ /**
1415
+ * For node material properties (colorNode, positionNode, etc.), accept broader types
1416
+ * since @types/three has broken inheritance for TSL node subclasses.
1417
+ */
1418
+ type NodeProps<P> = {
1419
+ [K in keyof P as P[K] extends Node | null ? K : never]?: TSLNodeInput
1420
+ }
1421
+
1422
+ interface ReactProps<P> {
1423
+ children?: React.ReactNode
1424
+ ref?: React.Ref<P>
1425
+ key?: React.Key
1426
+ }
1427
+
1428
+ type ElementProps<T extends ConstructorRepresentation, P = InstanceType<T>> = Partial<
1429
+ Overwrite<P, MathProps<P> & ReactProps<P> & EventProps<P> & GeometryProps<P> & NodeProps<P>>
1430
+ >
1431
+
1432
+ type ThreeElement<T extends ConstructorRepresentation> = Mutable<
1433
+ Overwrite<ElementProps<T>, Omit<InstanceProps<InstanceType<T>, T>, 'object'>>
1434
+ >
1435
+
1436
+ type ThreeToJSXElements<T extends Record<string, any>> = {
1437
+ [K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
1438
+ }
1439
+
1440
+ type ThreeExports = typeof THREE
1441
+ type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
1442
+
1443
+ interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
1444
+ primitive: Omit<ThreeElement<any>, 'args'> & { object: object }
1445
+ // Conflicts with DOM types can be accessed through a three* prefix
1446
+ threeAudio: ThreeElementsImpl['audio']
1447
+ threeSource: ThreeElementsImpl['source']
1448
+ threeLine: ThreeElementsImpl['line']
1449
+ threePath: ThreeElementsImpl['path']
1450
+ }
1451
+
1452
+ declare module 'react' {
1453
+ namespace JSX {
1454
+ interface IntrinsicElements extends ThreeElements {}
1455
+ }
1456
+ }
1457
+
1458
+ declare module 'react/jsx-runtime' {
1459
+ namespace JSX {
1460
+ interface IntrinsicElements extends ThreeElements {}
1461
+ }
1462
+ }
1463
+
1464
+ declare module 'react/jsx-dev-runtime' {
1465
+ namespace JSX {
1466
+ interface IntrinsicElements extends ThreeElements {}
1467
+ }
1328
1468
  }
1329
1469
 
1330
1470
  type three_d_Color = Color;
1331
1471
  type three_d_ElementProps<T extends ConstructorRepresentation, P = InstanceType<T>> = ElementProps<T, P>;
1332
1472
  type three_d_Euler = Euler;
1333
1473
  type three_d_EventProps<P> = EventProps<P>;
1474
+ type three_d_GeometryProps<P> = GeometryProps<P>;
1475
+ type three_d_GeometryTransformProps = GeometryTransformProps;
1334
1476
  type three_d_Layers = Layers;
1335
1477
  type three_d_MathProps<P> = MathProps<P>;
1336
1478
  type three_d_MathRepresentation = MathRepresentation;
@@ -1339,9 +1481,11 @@ type three_d_MathTypes = MathTypes;
1339
1481
  type three_d_Matrix3 = Matrix3;
1340
1482
  type three_d_Matrix4 = Matrix4;
1341
1483
  type three_d_MutableOrReadonlyParameters<T extends (...args: any) => any> = MutableOrReadonlyParameters<T>;
1484
+ type three_d_NodeProps<P> = NodeProps<P>;
1342
1485
  type three_d_Quaternion = Quaternion;
1343
1486
  type three_d_RaycastableRepresentation = RaycastableRepresentation;
1344
1487
  type three_d_ReactProps<P> = ReactProps<P>;
1488
+ type three_d_TSLNodeInput = TSLNodeInput;
1345
1489
  type three_d_ThreeElement<T extends ConstructorRepresentation> = ThreeElement<T>;
1346
1490
  type three_d_ThreeElements = ThreeElements;
1347
1491
  type three_d_ThreeElementsImpl = ThreeElementsImpl;
@@ -1352,12 +1496,353 @@ type three_d_Vector3 = Vector3;
1352
1496
  type three_d_Vector4 = Vector4;
1353
1497
  type three_d_VectorRepresentation = VectorRepresentation;
1354
1498
  declare namespace three_d {
1355
- export type { three_d_Color as Color, three_d_ElementProps as ElementProps, three_d_Euler as Euler, three_d_EventProps as EventProps, three_d_Layers as Layers, three_d_MathProps as MathProps, three_d_MathRepresentation as MathRepresentation, three_d_MathType as MathType, three_d_MathTypes as MathTypes, three_d_Matrix3 as Matrix3, three_d_Matrix4 as Matrix4, three_d_MutableOrReadonlyParameters as MutableOrReadonlyParameters, three_d_Quaternion as Quaternion, three_d_RaycastableRepresentation as RaycastableRepresentation, three_d_ReactProps as ReactProps, three_d_ThreeElement as ThreeElement, three_d_ThreeElements as ThreeElements, three_d_ThreeElementsImpl as ThreeElementsImpl, three_d_ThreeExports as ThreeExports, three_d_ThreeToJSXElements as ThreeToJSXElements, three_d_Vector2 as Vector2, three_d_Vector3 as Vector3, three_d_Vector4 as Vector4, three_d_VectorRepresentation as VectorRepresentation };
1499
+ export type { three_d_Color as Color, three_d_ElementProps as ElementProps, three_d_Euler as Euler, three_d_EventProps as EventProps, three_d_GeometryProps as GeometryProps, three_d_GeometryTransformProps as GeometryTransformProps, three_d_Layers as Layers, three_d_MathProps as MathProps, three_d_MathRepresentation as MathRepresentation, three_d_MathType as MathType, three_d_MathTypes as MathTypes, three_d_Matrix3 as Matrix3, three_d_Matrix4 as Matrix4, three_d_MutableOrReadonlyParameters as MutableOrReadonlyParameters, three_d_NodeProps as NodeProps, three_d_Quaternion as Quaternion, three_d_RaycastableRepresentation as RaycastableRepresentation, three_d_ReactProps as ReactProps, three_d_TSLNodeInput as TSLNodeInput, three_d_ThreeElement as ThreeElement, three_d_ThreeElements as ThreeElements, three_d_ThreeElementsImpl as ThreeElementsImpl, three_d_ThreeExports as ThreeExports, three_d_ThreeToJSXElements as ThreeToJSXElements, three_d_Vector2 as Vector2, three_d_Vector3 as Vector3, three_d_Vector4 as Vector4, three_d_VectorRepresentation as VectorRepresentation };
1500
+ }
1501
+
1502
+ /**
1503
+ * @fileoverview Registry for primary canvases that can be targeted by secondary canvases
1504
+ *
1505
+ * Enables multi-canvas WebGPU rendering where multiple Canvas components share
1506
+ * a single WebGPURenderer using Three.js CanvasTarget API.
1507
+ *
1508
+ * Primary canvas: Has `id` prop, creates its own renderer, registers here
1509
+ * Secondary canvas: Has `renderer={{ primaryCanvas: 'id' }}`, shares primary's renderer via CanvasTarget
1510
+ */
1511
+
1512
+ interface PrimaryCanvasEntry {
1513
+ /** The WebGPURenderer instance owned by this primary canvas */
1514
+ renderer: WebGPURenderer;
1515
+ /** The zustand store for this canvas */
1516
+ store: RootStore;
1517
+ }
1518
+ /**
1519
+ * Register a primary canvas that can be targeted by secondary canvases.
1520
+ *
1521
+ * @param id - Unique identifier for this primary canvas
1522
+ * @param renderer - The WebGPURenderer owned by this canvas
1523
+ * @param store - The zustand store for this canvas
1524
+ * @returns Cleanup function to unregister on unmount
1525
+ */
1526
+ declare function registerPrimary(id: string, renderer: WebGPURenderer, store: RootStore): () => void;
1527
+ /**
1528
+ * Get a registered primary canvas by id.
1529
+ *
1530
+ * @param id - The id of the primary canvas to look up
1531
+ * @returns The primary canvas entry or undefined if not found
1532
+ */
1533
+ declare function getPrimary(id: string): PrimaryCanvasEntry | undefined;
1534
+ /**
1535
+ * Wait for a primary canvas to be registered.
1536
+ * Returns immediately if already registered, otherwise waits.
1537
+ *
1538
+ * @param id - The id of the primary canvas to wait for
1539
+ * @param timeout - Optional timeout in ms (default: 5000)
1540
+ * @returns Promise that resolves with the primary canvas entry
1541
+ */
1542
+ declare function waitForPrimary(id: string, timeout?: number): Promise<PrimaryCanvasEntry>;
1543
+ /**
1544
+ * Check if a primary canvas with the given id exists.
1545
+ *
1546
+ * @param id - The id to check
1547
+ * @returns True if a primary canvas with this id is registered
1548
+ */
1549
+ declare function hasPrimary(id: string): boolean;
1550
+ /**
1551
+ * Unregister a primary canvas. Called on unmount.
1552
+ *
1553
+ * @param id - The id of the primary canvas to unregister
1554
+ */
1555
+ declare function unregisterPrimary(id: string): void;
1556
+ /**
1557
+ * Get all registered primary canvas ids. Useful for debugging.
1558
+ */
1559
+ declare function getPrimaryIds(): string[];
1560
+
1561
+ type EnvironmentLoaderProps = {
1562
+ files?: string | string[];
1563
+ path?: string;
1564
+ preset?: PresetsType;
1565
+ extensions?: (loader: Loader$1) => void;
1566
+ colorSpace?: ColorSpace;
1567
+ };
1568
+ /**
1569
+ * Loads environment textures for reflections and lighting.
1570
+ * Supports HDR files, presets, and cubemaps.
1571
+ *
1572
+ * @example Basic usage
1573
+ * ```jsx
1574
+ * const texture = useEnvironment({ preset: 'sunset' })
1575
+ * ```
1576
+ */
1577
+ declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown, THREE$1.TextureEventMap> | CubeTexture<unknown>;
1578
+ declare namespace useEnvironment {
1579
+ var preload: (preloadOptions?: EnvironmentLoaderPreloadOptions) => void;
1580
+ var clear: (clearOptions?: EnvironmentLoaderClearOptions) => void;
1356
1581
  }
1582
+ /**
1583
+ * Options accepted by `useEnvironment.preload`.
1584
+ *
1585
+ * `colorSpace` is deliberately omitted: preload only warms the loader cache, and colorSpace is
1586
+ * applied to the texture by `useEnvironment()` at use time, per consumer. Accepting it here would
1587
+ * advertise an option this function silently ignores.
1588
+ *
1589
+ * This previously read `Omit<…, 'encoding'>` — omitting a key that does not exist on
1590
+ * `EnvironmentLoaderProps`, a leftover from three's pre-`colorSpace` `encoding` API. That made the
1591
+ * type equivalent to the full props, so `colorSpace` was accepted and then dropped on the floor.
1592
+ */
1593
+ type EnvironmentLoaderPreloadOptions = Omit<EnvironmentLoaderProps, 'colorSpace'>;
1594
+ type EnvironmentLoaderClearOptions = Pick<EnvironmentLoaderProps, 'files' | 'preset'>;
1357
1595
 
1596
+ /**
1597
+ * Props for Environment component that sets up global cubemap for PBR materials and backgrounds.
1598
+ *
1599
+ * @property children - React children to render into custom environment portal
1600
+ * @property frames - Number of frames to render the environment. Use 1 for static, Infinity for animated (default: 1)
1601
+ * @property near - Near clipping plane for cube camera (default: 0.1)
1602
+ * @property far - Far clipping plane for cube camera (default: 1000)
1603
+ * @property resolution - Resolution of the cube render target (default: 256)
1604
+ * @property background - Whether to set scene.background. Can be true, false, or "only" (which only sets background) (default: false)
1605
+ *
1606
+ * @property blur - @deprecated Use backgroundBlurriness instead
1607
+ * @property backgroundBlurriness - Blur factor between 0 and 1 for background (default: 0, requires three.js 0.146+)
1608
+ * @property backgroundIntensity - Intensity factor for background (default: 1, requires three.js 0.163+)
1609
+ * @property backgroundRotation - Rotation for background as Euler angles (default: [0,0,0], requires three.js 0.163+)
1610
+ * @property environmentIntensity - Intensity factor for environment lighting (default: 1, requires three.js 0.163+)
1611
+ * @property environmentRotation - Rotation for environment as Euler angles (default: [0,0,0], requires three.js 0.163+)
1612
+ *
1613
+ * @property map - Pre-existing texture to use as environment map
1614
+ * @property preset - HDRI Haven preset: 'apartment', 'city', 'dawn', 'forest', 'lobby', 'night', 'park', 'studio', 'sunset', 'warehouse'. Not for production use.
1615
+ * @property scene - Custom THREE.Scene or ref to apply environment to (default: uses default scene)
1616
+ * @property ground - Ground projection settings. Use true for defaults or object with:
1617
+ * - height: Height of camera used to create env map (default: 15)
1618
+ * - radius: Radius of the world (default: 60)
1619
+ * - scale: Scale of backside projected sphere (default: 1000)
1620
+ *
1621
+ * Additional loader props:
1622
+ * @property files - File path(s) for environment. Supports .hdr, .exr, gainmap .jpg/.webp, or array of 6 cube faces
1623
+ * @property path - Base path for file loading
1624
+ * @property extensions - Texture extensions override
1625
+ */
1626
+ type EnvironmentProps = {
1627
+ children?: React$1.ReactNode;
1628
+ frames?: number;
1629
+ near?: number;
1630
+ far?: number;
1631
+ resolution?: number;
1632
+ background?: boolean | 'only';
1633
+ /** deprecated, use backgroundBlurriness */
1634
+ blur?: number;
1635
+ backgroundBlurriness?: number;
1636
+ backgroundIntensity?: number;
1637
+ backgroundRotation?: Euler;
1638
+ environmentIntensity?: number;
1639
+ environmentRotation?: Euler;
1640
+ map?: Texture$1;
1641
+ preset?: PresetsType;
1642
+ scene?: Scene | React$1.RefObject<Scene>;
1643
+ ground?: boolean | {
1644
+ radius?: number;
1645
+ height?: number;
1646
+ scale?: number;
1647
+ };
1648
+ /** Solid color for background (alternative to files/preset) */
1649
+ color?: ColorRepresentation$1;
1650
+ /** Separate files for background (when different from environment files) */
1651
+ backgroundFiles?: string | string[];
1652
+ } & EnvironmentLoaderProps;
1653
+ /**
1654
+ * Internal component that applies a pre-existing texture as environment map.
1655
+ * Sets scene.environment and optionally scene.background.
1656
+ *
1657
+ * @example
1658
+ * ```jsx
1659
+ * <CubeCamera>{(texture) => <EnvironmentMap map={texture} />}</CubeCamera>
1660
+ * ```
1661
+ */
1662
+ declare function EnvironmentMap({ scene, background, map, ...config }: EnvironmentProps): null;
1663
+ /**
1664
+ * Internal component that loads environment textures from files or presets.
1665
+ * Uses HDRLoader for .hdr, EXRLoader for .exr, UltraHDRLoader for .jpg/.jpeg HDR,
1666
+ * GainMapLoader for gainmap .webp, or CubeTextureLoader for arrays of images.
1667
+ *
1668
+ * @example With preset
1669
+ * ```jsx
1670
+ * <EnvironmentCube preset="sunset" />
1671
+ * ```
1672
+ *
1673
+ * @example From HDR file
1674
+ * ```jsx
1675
+ * <EnvironmentCube files="environment.hdr" />
1676
+ * ```
1677
+ *
1678
+ * @example From gainmap (smallest footprint)
1679
+ * ```jsx
1680
+ * <EnvironmentCube files={['file.webp', 'file-gainmap.webp', 'file.json']} />
1681
+ * ```
1682
+ *
1683
+ * @example From cube faces
1684
+ * ```jsx
1685
+ * <EnvironmentCube files={['px.png', 'nx.png', 'py.png', 'ny.png', 'pz.png', 'nz.png']} />
1686
+ * ```
1687
+ */
1688
+ declare function EnvironmentCube({ background, scene, blur, backgroundBlurriness, backgroundIntensity, backgroundRotation, environmentIntensity, environmentRotation, ...rest }: EnvironmentProps): null;
1689
+ /**
1690
+ * Internal component that renders custom environment using a portal and cube camera.
1691
+ * Renders children into an off-buffer and films with a cube camera to create environment map.
1692
+ * Can be static (frames=1) or animated (frames=Infinity).
1693
+ *
1694
+ * @example Custom environment with sphere
1695
+ * ```jsx
1696
+ * <EnvironmentPortal background near={1} far={1000} resolution={256}>
1697
+ * <mesh scale={100}>
1698
+ * <sphereGeometry args={[1, 64, 64]} />
1699
+ * <meshBasicMaterial map={texture} side={THREE.BackSide} />
1700
+ * </mesh>
1701
+ * </EnvironmentPortal>
1702
+ * ```
1703
+ *
1704
+ * @example Animated environment
1705
+ * ```jsx
1706
+ * <EnvironmentPortal frames={Infinity} resolution={256}>
1707
+ * <Float>
1708
+ * <mesh />
1709
+ * </Float>
1710
+ * </EnvironmentPortal>
1711
+ * ```
1712
+ *
1713
+ * @example Mixed with preset
1714
+ * ```jsx
1715
+ * <EnvironmentPortal preset="warehouse">
1716
+ * <mesh />
1717
+ * </EnvironmentPortal>
1718
+ * ```
1719
+ */
1720
+ declare function EnvironmentPortal({ children, near, far, resolution, frames, map, background, blur, backgroundBlurriness, backgroundIntensity, backgroundRotation, environmentIntensity, environmentRotation, scene, files, path, preset, extensions, }: EnvironmentProps): react_jsx_runtime.JSX.Element;
1721
+ declare module '@react-three/fiber' {
1722
+ interface ThreeElements {
1723
+ groundProjectedEnvImpl: ThreeElement<typeof GroundedSkybox>;
1724
+ }
1725
+ }
1726
+ /**
1727
+ * Sets up a global environment map for PBR materials and backgrounds.
1728
+ * Affects scene.environment and optionally scene.background unless a custom scene is passed.
1729
+ *
1730
+ * Supports multiple input methods:
1731
+ * - **Presets**: Selection of HDRI Haven assets (apartment, city, dawn, forest, lobby, night, park, studio, sunset, warehouse)
1732
+ * - **Files**: HDR (.hdr), EXR (.exr), gainmap JPEG (.jpg), gainmap WebP (.webp), or cube faces (array of 6 images)
1733
+ * - **Texture**: Pre-existing cube texture via `map` prop
1734
+ * - **Custom Scene**: Render children into environment using portal and cube camera
1735
+ * - **Ground Projection**: Project environment onto ground plane
1736
+ *
1737
+ * @remarks
1738
+ * - Preset property is NOT meant for production and may fail (relies on CDNs)
1739
+ * - Gainmap format has the smallest file footprint
1740
+ * - Use `frames={Infinity}` for animated environments with low resolution for performance
1741
+ * - Ground projection places models on the "ground" within the environment map
1742
+ * - Supports self-hosting with @pmndrs/assets using dynamic imports
1743
+ *
1744
+ * @example Basic preset usage
1745
+ * ```jsx
1746
+ * <Environment preset="sunset" />
1747
+ * ```
1748
+ *
1749
+ * @example From HDR file
1750
+ * ```jsx
1751
+ * <Environment files="/hdr/environment.hdr" />
1752
+ * ```
1753
+ *
1754
+ * @example From gainmap (smallest footprint)
1755
+ * ```jsx
1756
+ * <Environment files={['file.webp', 'file-gainmap.webp', 'file.json']} />
1757
+ * ```
1758
+ *
1759
+ * @example With self-hosted assets
1760
+ * ```jsx
1761
+ * import { suspend } from 'suspend-react'
1762
+ * const city = import('@pmndrs/assets/hdri/city.exr').then(m => m.default)
1763
+ *
1764
+ * <Environment files={suspend(city)} />
1765
+ * ```
1766
+ *
1767
+ * @example From existing texture
1768
+ * ```jsx
1769
+ * <CubeCamera>{(texture) => <Environment map={texture} />}</CubeCamera>
1770
+ * ```
1771
+ *
1772
+ * @example Custom environment scene
1773
+ * ```jsx
1774
+ * <Environment background near={1} far={1000} resolution={256}>
1775
+ * <mesh scale={100}>
1776
+ * <sphereGeometry args={[1, 64, 64]} />
1777
+ * <meshBasicMaterial map={texture} side={THREE.BackSide} />
1778
+ * </mesh>
1779
+ * </Environment>
1780
+ * ```
1781
+ *
1782
+ * @example Animated environment
1783
+ * ```jsx
1784
+ * <Environment frames={Infinity} resolution={256}>
1785
+ * <Float>
1786
+ * <mesh />
1787
+ * </Float>
1788
+ * </Environment>
1789
+ * ```
1790
+ *
1791
+ * @example Mixed custom scene with preset
1792
+ * ```jsx
1793
+ * <Environment background preset="warehouse">
1794
+ * <mesh />
1795
+ * </Environment>
1796
+ * ```
1797
+ *
1798
+ * @example With ground projection
1799
+ * ```jsx
1800
+ * <Environment ground={{ height: 15, radius: 60 }} preset="city" />
1801
+ * ```
1802
+ *
1803
+ * @example As background only
1804
+ * ```jsx
1805
+ * <Environment background="only" preset="sunset" />
1806
+ * ```
1807
+ *
1808
+ * @example With rotation and intensity
1809
+ * ```jsx
1810
+ * <Environment
1811
+ * background
1812
+ * backgroundBlurriness={0.5}
1813
+ * backgroundIntensity={0.8}
1814
+ * backgroundRotation={[0, Math.PI / 2, 0]}
1815
+ * environmentIntensity={1.2}
1816
+ * environmentRotation={[0, Math.PI / 4, 0]}
1817
+ * preset="studio"
1818
+ * />
1819
+ * ```
1820
+ */
1821
+ declare function Environment(props: EnvironmentProps): react_jsx_runtime.JSX.Element;
1822
+
1823
+ /**
1824
+ * Moves every trace of interactivity from one object to its replacement, for reconstruction.
1825
+ *
1826
+ * When `args` or a `primitive`'s `object` changes, R3F builds a new three object and keeps the same
1827
+ * instance. Removing the old object from the interaction state and registering the new one from
1828
+ * scratch makes events *work* again (#3778), but it forgets what was in flight: a pointer resting on
1829
+ * the object fires a second `onPointerEnter` without ever having left, and an active pointer capture
1830
+ * is dropped mid-drag. Rewriting the references instead keeps the interaction continuous across a
1831
+ * swap the user never asked to see (#3744).
1832
+ *
1833
+ * Captures are re-keyed rather than released, so the DOM-level capture on `captureData.target` is
1834
+ * left alone — releasing and re-acquiring it is precisely the glitch being avoided.
1835
+ *
1836
+ * Visibility handlers are deliberately not transferred: that registry is keyed by `object.uuid`, so
1837
+ * the replacement re-registers itself through `applyProps`. The old entry is dropped here so it
1838
+ * cannot outlive the object it described.
1839
+ */
1840
+ declare function swapInteractivity(store: RootStore, object: Object3D, newObject: Object3D): void;
1358
1841
  declare function removeInteractivity(store: RootStore, object: Object3D): void;
1359
1842
  declare function createEvents(store: RootStore): {
1360
1843
  handlePointer: (name: string) => (event: DomEvent) => void;
1844
+ flushDeferredPointers: () => void;
1845
+ processDeferredPointer: (event: DomEvent, pointerId: number) => void;
1361
1846
  };
1362
1847
  /** Default R3F event manager for web */
1363
1848
  declare function createPointerEvents(store: RootStore): EventManager<HTMLElement>;
@@ -1373,383 +1858,21 @@ declare function getLoader<L extends LoaderLike | ConstructorRepresentation<Load
1373
1858
  * Note: this hook's caller must be wrapped with `React.Suspense`
1374
1859
  * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useloader
1375
1860
  */
1376
- 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>;
1861
+ 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>;
1377
1862
  declare namespace useLoader {
1378
- var preload: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void) => void;
1379
- var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I) => void;
1863
+ 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;
1864
+ var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, cacheKey?: InputLike) => void;
1380
1865
  var loader: typeof getLoader;
1381
1866
  }
1382
1867
 
1383
- /**
1384
- * Global Singleton Scheduler - manages the frame loop and job execution for ALL R3F roots.
1385
- *
1386
- * Features:
1387
- * - Single RAF loop for entire application
1388
- * - Root registration (multiple Canvas support)
1389
- * - Global phases for addEffect/addAfterEffect (deprecated)
1390
- * - Per-root job management with phases, priorities, FPS throttling
1391
- * - onIdle callbacks for addTail (deprecated)
1392
- * - Demand mode support via invalidate()
1393
- */
1394
- declare class Scheduler {
1395
- private static readonly INSTANCE_KEY;
1396
- private static get instance();
1397
- private static set instance(value);
1398
- /**
1399
- * Get the global scheduler instance (creates if doesn't exist).
1400
- * Uses HMR data to preserve instance across hot reloads.
1401
- * @returns {Scheduler} The singleton scheduler instance
1402
- */
1403
- static get(): Scheduler;
1404
- /**
1405
- * Reset the singleton instance. Stops the loop and clears all state.
1406
- * Primarily used for testing to ensure clean state between tests.
1407
- * @returns {void}
1408
- */
1409
- static reset(): void;
1410
- private roots;
1411
- private phaseGraph;
1412
- private loopState;
1413
- private stoppedTime;
1414
- private nextRootIndex;
1415
- private globalBeforeJobs;
1416
- private globalAfterJobs;
1417
- private nextGlobalIndex;
1418
- private idleCallbacks;
1419
- private nextJobIndex;
1420
- private jobStateListeners;
1421
- private pendingFrames;
1422
- private _frameloop;
1423
- private _independent;
1424
- private errorHandler;
1425
- private rootReadyCallbacks;
1426
- get phases(): string[];
1427
- get frameloop(): Frameloop;
1428
- set frameloop(mode: Frameloop);
1429
- get isRunning(): boolean;
1430
- get isReady(): boolean;
1431
- get independent(): boolean;
1432
- set independent(value: boolean);
1433
- constructor();
1434
- /**
1435
- * Register a root (Canvas) with the scheduler.
1436
- * The first root to register starts the RAF loop (if frameloop='always').
1437
- * @param {string} id - Unique identifier for this root
1438
- * @param {RootOptions} [options] - Optional configuration with getState and onError callbacks
1439
- * @returns {() => void} Unsubscribe function to remove this root
1440
- */
1441
- registerRoot(id: string, options?: RootOptions): () => void;
1442
- /**
1443
- * Unregister a root from the scheduler.
1444
- * Cleans up all job state listeners for this root's jobs.
1445
- * The last root to unregister stops the RAF loop.
1446
- * @param {string} id - The root ID to unregister
1447
- * @returns {void}
1448
- */
1449
- unregisterRoot(id: string): void;
1450
- /**
1451
- * Subscribe to be notified when a root becomes available.
1452
- * Fires immediately if a root already exists.
1453
- * @param {() => void} callback - Function called when first root registers
1454
- * @returns {() => void} Unsubscribe function
1455
- */
1456
- onRootReady(callback: () => void): () => void;
1457
- /**
1458
- * Notify all registered root-ready callbacks.
1459
- * Called when the first root registers.
1460
- * @returns {void}
1461
- * @private
1462
- */
1463
- private notifyRootReady;
1464
- /**
1465
- * Ensure a default root exists for independent mode.
1466
- * Creates a minimal root with no state provider.
1467
- * @returns {void}
1468
- * @private
1469
- */
1470
- private ensureDefaultRoot;
1471
- /**
1472
- * Trigger error handling for job errors.
1473
- * Uses the bound error handler if available, otherwise logs to console.
1474
- * @param {Error} error - The error to handle
1475
- * @returns {void}
1476
- */
1477
- triggerError(error: Error): void;
1478
- /**
1479
- * Add a named phase to the scheduler's execution order.
1480
- * Marks all roots for rebuild to incorporate the new phase.
1481
- * @param {string} name - The phase name (e.g., 'physics', 'postprocess')
1482
- * @param {AddPhaseOptions} [options] - Positioning options (before/after other phases)
1483
- * @returns {void}
1484
- * @example
1485
- * scheduler.addPhase('physics', { before: 'update' });
1486
- * scheduler.addPhase('postprocess', { after: 'render' });
1487
- */
1488
- addPhase(name: string, options?: AddPhaseOptions): void;
1489
- /**
1490
- * Check if a phase exists in the scheduler.
1491
- * @param {string} name - The phase name to check
1492
- * @returns {boolean} True if the phase exists
1493
- */
1494
- hasPhase(name: string): boolean;
1495
- /**
1496
- * Register a global job that runs once per frame (not per-root).
1497
- * Used internally by deprecated addEffect/addAfterEffect APIs.
1498
- * @param {'before' | 'after'} phase - When to run: 'before' all roots or 'after' all roots
1499
- * @param {string} id - Unique identifier for this global job
1500
- * @param {(timestamp: number) => void} callback - Function called each frame with RAF timestamp
1501
- * @returns {() => void} Unsubscribe function to remove this global job
1502
- * @deprecated Use useFrame with phases instead
1503
- */
1504
- registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void;
1505
- /**
1506
- * Register an idle callback that fires when the loop stops.
1507
- * Used internally by deprecated addTail API.
1508
- * @param {(timestamp: number) => void} callback - Function called when loop becomes idle
1509
- * @returns {() => void} Unsubscribe function to remove this idle callback
1510
- * @deprecated Use demand mode with invalidate() instead
1511
- */
1512
- onIdle(callback: (timestamp: number) => void): () => void;
1513
- /**
1514
- * Notify all registered idle callbacks.
1515
- * Called when the loop stops in demand mode.
1516
- * @param {number} timestamp - The RAF timestamp when idle occurred
1517
- * @returns {void}
1518
- * @private
1519
- */
1520
- private notifyIdle;
1521
- /**
1522
- * Register a job (frame callback) with a specific root.
1523
- * This is the core registration method used by useFrame internally.
1524
- * @param {FrameNextCallback} callback - The function to call each frame
1525
- * @param {JobOptions & { rootId?: string; system?: boolean }} [options] - Job configuration
1526
- * @param {string} [options.rootId] - Target root ID (defaults to first registered root)
1527
- * @param {string} [options.id] - Unique job ID (auto-generated if not provided)
1528
- * @param {string} [options.phase] - Execution phase (defaults to 'update')
1529
- * @param {number} [options.priority] - Priority within phase (higher = earlier, default 0)
1530
- * @param {number} [options.fps] - FPS throttle limit
1531
- * @param {boolean} [options.drop] - Drop frames when behind (default true)
1532
- * @param {boolean} [options.enabled] - Whether job is active (default true)
1533
- * @param {boolean} [options.system] - Internal flag for system jobs (not user-facing)
1534
- * @returns {() => void} Unsubscribe function to remove this job
1535
- */
1536
- register(callback: FrameNextCallback, options?: JobOptions & {
1537
- rootId?: string;
1538
- system?: boolean;
1539
- }): () => void;
1540
- /**
1541
- * Unregister a job by its ID.
1542
- * Searches all roots if rootId is not provided.
1543
- * @param {string} id - The job ID to unregister
1544
- * @param {string} [rootId] - Optional root ID to search (searches all if not provided)
1545
- * @returns {void}
1546
- */
1547
- unregister(id: string, rootId?: string): void;
1548
- /**
1549
- * Update a job's options dynamically.
1550
- * Searches all roots to find the job by ID.
1551
- * Phase/constraint changes trigger a rebuild of the sorted job list.
1552
- * @param {string} id - The job ID to update
1553
- * @param {Partial<JobOptions>} options - The options to update
1554
- * @returns {void}
1555
- */
1556
- updateJob(id: string, options: Partial<JobOptions>): void;
1557
- /**
1558
- * Check if a job is currently paused (disabled).
1559
- * @param {string} id - The job ID to check
1560
- * @returns {boolean} True if the job exists and is paused
1561
- */
1562
- isJobPaused(id: string): boolean;
1563
- /**
1564
- * Subscribe to state changes for a specific job.
1565
- * Listener is called when job is paused or resumed.
1566
- * @param {string} id - The job ID to subscribe to
1567
- * @param {() => void} listener - Callback invoked on state changes
1568
- * @returns {() => void} Unsubscribe function
1569
- */
1570
- subscribeJobState(id: string, listener: () => void): () => void;
1571
- /**
1572
- * Notify all listeners that a job's state has changed.
1573
- * @param {string} id - The job ID that changed
1574
- * @returns {void}
1575
- * @private
1576
- */
1577
- private notifyJobStateChange;
1578
- /**
1579
- * Pause a job by ID (sets enabled=false).
1580
- * Notifies any subscribed state listeners.
1581
- * @param {string} id - The job ID to pause
1582
- * @returns {void}
1583
- */
1584
- pauseJob(id: string): void;
1585
- /**
1586
- * Resume a paused job by ID (sets enabled=true).
1587
- * Resets job timing to prevent frame accumulation.
1588
- * Notifies any subscribed state listeners.
1589
- * @param {string} id - The job ID to resume
1590
- * @returns {void}
1591
- */
1592
- resumeJob(id: string): void;
1593
- /**
1594
- * Start the requestAnimationFrame loop.
1595
- * Resets timing state (elapsedTime, frameCount) on start.
1596
- * No-op if already running.
1597
- * @returns {void}
1598
- */
1599
- start(): void;
1600
- /**
1601
- * Stop the requestAnimationFrame loop.
1602
- * Cancels any pending RAF callback.
1603
- * No-op if not running.
1604
- * @returns {void}
1605
- */
1606
- stop(): void;
1607
- /**
1608
- * Request frames to be rendered in demand mode.
1609
- * Accumulates pending frames (capped at 60) and starts the loop if not running.
1610
- * No-op if frameloop is not 'demand'.
1611
- * @param {number} [frames=1] - Number of frames to request
1612
- * @param {boolean} [stackFrames=false] - Whether to add frames to existing pending count
1613
- * - `false` (default): Sets pending frames to the specified value (replaces existing count)
1614
- * - `true`: Adds frames to existing pending count (useful for accumulating invalidations)
1615
- * @returns {void}
1616
- * @example
1617
- * // Request a single frame render
1618
- * scheduler.invalidate();
1619
- *
1620
- * @example
1621
- * // Request 5 frames (e.g., for animations)
1622
- * scheduler.invalidate(5);
1623
- *
1624
- * @example
1625
- * // Set pending frames to exactly 3 (don't stack with existing)
1626
- * scheduler.invalidate(3, false);
1627
- *
1628
- * @example
1629
- * // Add 2 more frames to existing pending count
1630
- * scheduler.invalidate(2, true);
1631
- */
1632
- invalidate(frames?: number, stackFrames?: boolean): void;
1633
- /**
1634
- * Reset timing state for deterministic testing.
1635
- * Preserves jobs and roots but resets lastTime, frameCount, elapsedTime, etc.
1636
- * @returns {void}
1637
- */
1638
- resetTiming(): void;
1639
- /**
1640
- * Manually execute a single frame for all roots.
1641
- * Useful for frameloop='never' mode or testing scenarios.
1642
- * @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
1643
- * @returns {void}
1644
- * @example
1645
- * // Manual control mode
1646
- * scheduler.frameloop = 'never';
1647
- * scheduler.step(); // Execute one frame
1648
- */
1649
- step(timestamp?: number): void;
1650
- /**
1651
- * Manually execute a single job by its ID.
1652
- * Useful for testing individual job callbacks in isolation.
1653
- * @param {string} id - The job ID to step
1654
- * @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
1655
- * @returns {void}
1656
- */
1657
- stepJob(id: string, timestamp?: number): void;
1658
- /**
1659
- * Main RAF loop callback.
1660
- * Executes frame, handles demand mode, and schedules next frame.
1661
- * @param {number} timestamp - RAF timestamp in milliseconds
1662
- * @returns {void}
1663
- * @private
1664
- */
1665
- private loop;
1666
- /**
1667
- * Execute a single frame across all roots.
1668
- * Order: globalBefore → each root's jobs → globalAfter
1669
- * @param {number} timestamp - RAF timestamp in milliseconds
1670
- * @returns {void}
1671
- * @private
1672
- */
1673
- private executeFrame;
1674
- /**
1675
- * Run all global jobs from a job map.
1676
- * Catches and logs errors without stopping execution.
1677
- * @param {Map<string, GlobalJob>} jobs - The global jobs map to execute
1678
- * @param {number} timestamp - RAF timestamp in milliseconds
1679
- * @returns {void}
1680
- * @private
1681
- */
1682
- private runGlobalJobs;
1683
- /**
1684
- * Execute all jobs for a single root in sorted order.
1685
- * Rebuilds sorted job list if needed, then dispatches each job.
1686
- * Errors are caught and propagated via triggerError.
1687
- * @param {RootEntry} root - The root entry to tick
1688
- * @param {number} timestamp - RAF timestamp in milliseconds
1689
- * @param {number} delta - Time since last frame in seconds
1690
- * @returns {void}
1691
- * @private
1692
- */
1693
- private tickRoot;
1694
- /**
1695
- * Get the total number of registered jobs across all roots.
1696
- * Includes both per-root jobs and global before/after jobs.
1697
- * @returns {number} Total job count
1698
- */
1699
- getJobCount(): number;
1700
- /**
1701
- * Get all registered job IDs across all roots.
1702
- * Includes both per-root jobs and global before/after jobs.
1703
- * @returns {string[]} Array of all job IDs
1704
- */
1705
- getJobIds(): string[];
1706
- /**
1707
- * Get the number of registered roots (Canvas instances).
1708
- * @returns {number} Number of registered roots
1709
- */
1710
- getRootCount(): number;
1711
- /**
1712
- * Check if any user (non-system) jobs are registered in a specific phase.
1713
- * Used by the default render job to know if a user has taken over rendering.
1714
- *
1715
- * @param phase The phase to check
1716
- * @param rootId Optional root ID to check (checks all roots if not provided)
1717
- * @returns true if any user jobs exist in the phase
1718
- */
1719
- hasUserJobsInPhase(phase: string, rootId?: string): boolean;
1720
- /**
1721
- * Generate a unique root ID for automatic root registration.
1722
- * @returns {string} A unique root ID in the format 'root_N'
1723
- */
1724
- generateRootId(): string;
1725
- /**
1726
- * Generate a unique job ID.
1727
- * @returns {string} A unique job ID in the format 'job_N'
1728
- * @private
1729
- */
1730
- private generateJobId;
1731
- /**
1732
- * Normalize before/after constraints to a Set.
1733
- * Handles undefined, single string, or array inputs.
1734
- * @param {string | string[] | undefined} value - The constraint value(s)
1735
- * @returns {Set<string>} Normalized Set of constraint strings
1736
- * @private
1737
- */
1738
- private normalizeConstraints;
1739
- }
1740
- /**
1741
- * Get the global scheduler instance.
1742
- * Creates one if it doesn't exist.
1743
- */
1744
- declare const getScheduler: () => Scheduler;
1745
-
1746
1868
  /**
1747
1869
  * Frame hook with phase-based ordering, priority, and FPS throttling.
1748
1870
  *
1749
- * Works both inside and outside Canvas context:
1750
- * - Inside Canvas: Full RootState (gl, scene, camera, etc.)
1751
- * - Outside Canvas (waiting mode): Waits for Canvas to mount, then gets full state
1752
- * - Outside Canvas (independent mode): Fires immediately with timing-only state
1871
+ * Always delivers full RootState — works both inside and outside Canvas context:
1872
+ * - Inside Canvas: Full RootState (renderer, scene, camera, etc.)
1873
+ * - Outside Canvas: The job registers immediately but the callback is held until a
1874
+ * Canvas adopts it, then runs with full RootState. For hostless / standalone
1875
+ * frame loops with no Canvas, use `@pmndrs/scheduler` directly.
1753
1876
  *
1754
1877
  * Returns a controls object for manual stepping, pausing, and resuming.
1755
1878
  *
@@ -1766,16 +1889,16 @@ declare const getScheduler: () => Scheduler;
1766
1889
  * useFrame((state, delta) => { ... }, { phase: 'physics' })
1767
1890
  *
1768
1891
  * @example
1769
- * // Outside Canvas - waits for Canvas to mount
1892
+ * // Outside Canvas - callback waits for a Canvas, then always has full state
1770
1893
  * function UI() {
1771
1894
  * useFrame((state, delta) => { syncUI(state.camera) });
1772
1895
  * return <button>...</button>;
1773
1896
  * }
1774
1897
  *
1775
1898
  * @example
1776
- * // Independent mode - no Canvas needed
1777
- * getScheduler().independent = true;
1778
- * useFrame((state, delta) => { updateGame(delta) });
1899
+ * // Hostless / standalone loop (no Canvas) - use @pmndrs/scheduler directly
1900
+ * import { getScheduler } from '@pmndrs/scheduler'
1901
+ * getScheduler().register((state, delta) => { updateGame(delta) })
1779
1902
  *
1780
1903
  * @example
1781
1904
  * // Scheduler-only access (no callback)
@@ -1798,11 +1921,16 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
1798
1921
  /** Callback when texture(s) finish loading */
1799
1922
  onLoad?: (texture: MappedTextureType<Url>) => void;
1800
1923
  /**
1801
- * Cache the texture in R3F's global state for access via useTextures().
1802
- * When true:
1924
+ * Register the texture(s) in R3F's global texture registry for access via useTextures().
1925
+ * When true (the default):
1803
1926
  * - Textures persist until explicitly disposed
1804
- * - Returns existing cached textures if available (preserving modifications like colorSpace)
1805
- * @default false
1927
+ * - On mount, returns existing registered textures if available (preserving modifications like colorSpace)
1928
+ *
1929
+ * Reads are taken once at mount — a mounted `useTexture` does not re-render when the registry
1930
+ * changes. To react to registry swaps, use `useTextures(s => s.get(key))` instead.
1931
+ *
1932
+ * Pass `false` to opt out of registry enrollment entirely.
1933
+ * @default true
1806
1934
  */
1807
1935
  cache?: boolean;
1808
1936
  };
@@ -1826,15 +1954,18 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
1826
1954
  * normal: '/normal.png'
1827
1955
  * })
1828
1956
  *
1829
- * // With caching - returns same texture object across components
1830
- * // Modifications (colorSpace, wrapS, etc.) are preserved
1831
- * const diffuse = useTexture('/diffuse.png', { cache: true })
1957
+ * // Textures are registered in the global registry by default — the same texture
1958
+ * // object is shared across components and modifications (colorSpace, wrapS, etc.) are preserved
1959
+ * const diffuse = useTexture('/diffuse.png')
1832
1960
  * diffuse.colorSpace = THREE.SRGBColorSpace
1833
1961
  *
1834
1962
  * // Another component gets the SAME texture with colorSpace already set
1835
- * const sameDiffuse = useTexture('/diffuse.png', { cache: true })
1963
+ * const sameDiffuse = useTexture('/diffuse.png')
1836
1964
  *
1837
- * // Access cache directly
1965
+ * // Opt out of registry enrollment for a one-off texture
1966
+ * const scratch = useTexture('/scratch.png', { cache: false })
1967
+ *
1968
+ * // Access the registry directly
1838
1969
  * const { get } = useTextures()
1839
1970
  * const cached = get('/diffuse.png')
1840
1971
  * ```
@@ -1851,63 +1982,80 @@ declare const Texture: ({ children, input, onLoad, cache, }: {
1851
1982
  cache?: boolean;
1852
1983
  }) => react_jsx_runtime.JSX.Element;
1853
1984
 
1854
- type TextureEntry = Texture$1 | {
1855
- value: Texture$1;
1856
- [key: string]: any;
1985
+ /** Accepted shapes for a registry read: a single key, a list of keys, or a name→key map. */
1986
+ type TextureInput = string | string[] | Record<string, string>;
1987
+ /** Result of a `get()` read, mirroring the input shape. */
1988
+ type TextureResult<Input extends TextureInput> = Input extends string ? Texture$1 | undefined : Input extends string[] ? (Texture$1 | undefined)[] : {
1989
+ [K in keyof Input]: Texture$1 | undefined;
1857
1990
  };
1991
+ /** Options for `dispose()`. */
1992
+ interface DisposeOptions {
1993
+ /** Dispose even if the texture still has active references (default false). */
1994
+ force?: boolean;
1995
+ }
1858
1996
  interface UseTexturesReturn {
1859
- /** Map of all textures currently in cache */
1860
- textures: Map<string, TextureEntry>;
1861
- /** Get a specific texture by key (usually URL) */
1862
- get: (key: string) => TextureEntry | undefined;
1863
- /** Check if a texture exists in cache */
1864
- has: (key: string) => boolean;
1865
- /** Add a texture to the cache */
1866
- add: (key: string, value: TextureEntry) => void;
1867
- /** Add multiple textures to the cache */
1868
- addMultiple: (items: Map<string, TextureEntry> | Record<string, TextureEntry>) => void;
1869
- /** Remove a texture from cache (does NOT dispose GPU resources) */
1870
- remove: (key: string) => void;
1871
- /** Remove multiple textures from cache */
1872
- removeMultiple: (keys: string[]) => void;
1873
- /** Dispose a texture's GPU resources and remove from cache */
1874
- dispose: (key: string) => void;
1875
- /** Dispose multiple textures */
1876
- disposeMultiple: (keys: string[]) => void;
1877
- /** Dispose ALL cached textures - use with caution */
1878
- disposeAll: () => void;
1879
- }
1880
- /**
1881
- * Hook for managing the global texture cache in R3F state.
1882
- *
1883
- * Textures are stored in a Map with URL/path keys for efficient lookup.
1884
- * Useful for sharing texture references across materials and components.
1997
+ /** The live registry Map (key → Texture). Treat as read-only. */
1998
+ readonly all: Map<string, Texture$1>;
1999
+ /** Read one texture, an array of textures, or a name→texture record (mirrors the input shape). */
2000
+ get<Input extends TextureInput>(input: Input): TextureResult<Input>;
2001
+ /** Check whether a key exists in the registry. */
2002
+ has(key: string): boolean;
2003
+ /**
2004
+ * Register a texture (or a record of textures) that has no URL — e.g. a render
2005
+ * target or procedural texture. URL-loaded textures are registered automatically
2006
+ * by `useTexture` (registry enrollment is on by default).
2007
+ */
2008
+ add(key: string, texture: Texture$1): void;
2009
+ add(record: Record<string, Texture$1>): void;
2010
+ /**
2011
+ * Dispose a texture's GPU resources and remove it from the registry.
2012
+ * Refcount-aware: if the key is still in use by a mounted `useTexture` consumer it is
2013
+ * skipped (with a warning) unless `{ force: true }` is passed.
2014
+ * @returns true if disposed, false if skipped.
2015
+ */
2016
+ dispose(key: string, options?: DisposeOptions): boolean;
2017
+ /** Dispose every texture in the registry and clear it. Use on scene teardown. */
2018
+ disposeAll(): void;
2019
+ }
2020
+ /**
2021
+ * Reactive Texture registry — load once with `useTexture`, reach the textures from anywhere.
2022
+ *
2023
+ * This is a registry of plain `Texture` objects (not TSL nodes), so the same texture can feed
2024
+ * a material map, a heightmap sampler, or anything else. It does **not** load — pair it with
2025
+ * `useTexture` for loading (registry enrollment is on by default); `useTextures` is for access and lifecycle.
2026
+ *
2027
+ * The returned handle is **reactive**: the calling component re-renders when the registry
2028
+ * changes. Pass a selector to scope the subscription to a single read.
1885
2029
  *
1886
2030
  * @example
1887
2031
  * ```tsx
1888
- * const { textures, add, get, remove, has, dispose } = useTextures()
1889
- *
1890
- * // Check if texture is already cached
1891
- * if (!has('/textures/diffuse.png')) {
1892
- * // Load with useTexture and cache: true, or manually add
1893
- * const tex = useTexture('/textures/diffuse.png', { cache: true })
1894
- * }
2032
+ * // Load + register once (anywhere in the tree) — registered by default
2033
+ * useTexture({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
1895
2034
  *
1896
- * // Access cached texture from anywhere
1897
- * const diffuse = get('/textures/diffuse.png')
1898
- * if (diffuse) material.map = diffuse
2035
+ * // Reach them from another component — record form lands straight into a material
2036
+ * const { map, normalMap } = useTextures().get({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
2037
+ * return <meshStandardMaterial map={map} normalMap={normalMap} />
1899
2038
  *
1900
- * // Remove from cache only (texture still in GPU memory)
1901
- * remove('/textures/old.png')
2039
+ * // A set of heightmaps at once
2040
+ * const [a, b, c] = useTextures().get(['/h0.png', '/h1.png', '/h2.png'])
1902
2041
  *
1903
- * // Fully dispose (frees GPU memory + removes from cache)
1904
- * dispose('/textures/unused.png')
2042
+ * // Register a non-URL texture (render target / procedural)
2043
+ * useTextures().add('rt-main', renderTarget.texture)
1905
2044
  *
1906
- * // Nuclear option - dispose everything
1907
- * disposeAll()
2045
+ * // Deliberate GPU cleanup (refcount-aware; force to override)
2046
+ * useTextures().dispose('/diffuse.jpg')
2047
+ * useTextures().disposeAll() // scene teardown
1908
2048
  * ```
2049
+ *
2050
+ * @remarks
2051
+ * **Future expansion:** an imperative async loader (e.g. `await useTextures().load('/x.jpg')`) is
2052
+ * intentionally not included yet. It would let non-React code (loading screens, dynamic streaming)
2053
+ * populate the registry without Suspense, at the cost of putting loading back into this hook. It
2054
+ * will be added only if a concrete consumer needs imperative loading; for now, loading lives in
2055
+ * `useTexture`.
1909
2056
  */
1910
2057
  declare function useTextures(): UseTexturesReturn;
2058
+ declare function useTextures<T>(selector: (registry: UseTexturesReturn) => T): T;
1911
2059
 
1912
2060
  /**
1913
2061
  * Creates a render target compatible with the current renderer.
@@ -1916,31 +2064,30 @@ declare function useTextures(): UseTexturesReturn;
1916
2064
  * - WebGPU build: Returns RenderTarget
1917
2065
  * - Default build: Returns whichever matches the active renderer
1918
2066
  *
1919
- * @param width - Target width (defaults to canvas width)
1920
- * @param height - Target height (defaults to canvas height)
1921
- * @param options - Three.js RenderTarget options
1922
- *
1923
2067
  * @example
1924
2068
  * ```tsx
1925
- * function PortalScene() {
1926
- * const fbo = useRenderTarget(512, 512, { depthBuffer: true })
1927
- *
1928
- * useFrame(({ renderer, scene, camera }) => {
1929
- * renderer.setRenderTarget(fbo)
1930
- * renderer.render(scene, camera)
1931
- * renderer.setRenderTarget(null)
1932
- * })
1933
- *
1934
- * return (
1935
- * <mesh>
1936
- * <planeGeometry />
1937
- * <meshBasicMaterial map={fbo.texture} />
1938
- * </mesh>
1939
- * )
1940
- * }
2069
+ * // Use canvas size
2070
+ * const fbo = useRenderTarget()
2071
+ *
2072
+ * // Use canvas size with options
2073
+ * const fbo = useRenderTarget({ samples: 4 })
2074
+ *
2075
+ * // Square render target
2076
+ * const fbo = useRenderTarget(512)
2077
+ *
2078
+ * // Square render target with options
2079
+ * const fbo = useRenderTarget(512, { depthBuffer: true })
2080
+ *
2081
+ * // Explicit dimensions
2082
+ * const fbo = useRenderTarget(512, 256)
2083
+ *
2084
+ * // Explicit dimensions with options
2085
+ * const fbo = useRenderTarget(512, 256, { samples: 4 })
1941
2086
  * ```
1942
2087
  */
1943
- declare function useRenderTarget(width?: number, height?: number, options?: RenderTargetOptions): RenderTarget<THREE$1.Texture<unknown>>;
2088
+ declare function useRenderTarget(options?: RenderTargetOptions): RenderTarget;
2089
+ declare function useRenderTarget(size: number, options?: RenderTargetOptions): RenderTarget;
2090
+ declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): RenderTarget;
1944
2091
 
1945
2092
  /**
1946
2093
  * Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
@@ -2045,7 +2192,7 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
2045
2192
  *
2046
2193
  * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
2047
2194
  */
2048
- declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState, frame?: XRFrame): void;
2195
+ declare function advance(timestamp: number): void;
2049
2196
 
2050
2197
  /* eslint-disable @definitelytyped/no-unnecessary-generics */
2051
2198
  declare function ReactReconciler<
@@ -3099,6 +3246,12 @@ declare const _roots: Map<HTMLCanvasElement | OffscreenCanvas, Root>;
3099
3246
  declare function createRoot<TCanvas extends HTMLCanvasElement | OffscreenCanvas>(canvas: TCanvas): ReconcilerRoot<TCanvas>;
3100
3247
  declare function unmountComponentAtNode<TCanvas extends HTMLCanvasElement | OffscreenCanvas>(canvas: TCanvas, callback?: (canvas: TCanvas) => void): void;
3101
3248
  declare function createPortal(children: ReactNode, container: Object3D | RefObject<Object3D | null> | RefObject<Object3D>, state?: InjectState): JSX.Element;
3249
+ interface PortalProps {
3250
+ children: ReactNode;
3251
+ state?: InjectState;
3252
+ container: Object3D | RefObject<Object3D | null> | RefObject<Object3D>;
3253
+ }
3254
+ declare function Portal({ children, container, state }: PortalProps): JSX.Element;
3102
3255
  /**
3103
3256
  * Force React to flush any updates inside the provided callback synchronously and immediately.
3104
3257
  * All the same caveats documented for react-dom's `flushSync` apply here (see https://react.dev/reference/react-dom/flushSync).
@@ -3110,11 +3263,6 @@ declare function flushSync<R>(fn: () => R): R;
3110
3263
  declare const context: React$1.Context<RootStore>;
3111
3264
  declare const createStore: (invalidate: (state?: RootState, frames?: number, stackFrames?: boolean) => void, advance: (timestamp: number, runGlobalEffects?: boolean, state?: RootState, frame?: XRFrame) => void) => RootStore;
3112
3265
 
3113
- /**
3114
- * Safely flush async effects when testing, simulating a legacy root.
3115
- * @deprecated Import from React instead. import { act } from 'react'
3116
- */
3117
- declare const act: typeof React$1.act;
3118
3266
  /**
3119
3267
  * An SSR-friendly useLayoutEffect.
3120
3268
  *
@@ -3527,11 +3675,76 @@ declare const hasConstructor: (object: unknown) => object is {
3527
3675
  constructor?: Function;
3528
3676
  };
3529
3677
 
3678
+ /**
3679
+ * Symbol marker for deferred ref resolution.
3680
+ * Used to identify values that should be resolved from refs after mount.
3681
+ */
3682
+ declare const FROM_REF: unique symbol;
3683
+ /**
3684
+ * Defers prop application until the referenced object is available.
3685
+ * Useful for props like `target` that need sibling refs to be populated.
3686
+ *
3687
+ * @param ref - React ref object to resolve at mount time
3688
+ * @returns A marker value that applyProps will resolve after mount
3689
+ *
3690
+ * @example
3691
+ * const targetRef = useRef<THREE.Object3D>(null)
3692
+ *
3693
+ * <group ref={targetRef} position={[-3, -2, -15]} />
3694
+ * <spotLight target={fromRef(targetRef)} intensity={100} />
3695
+ */
3696
+ declare function fromRef<T>(ref: React$1.RefObject<T | null>): T;
3697
+ /**
3698
+ * Type guard to check if a value is a fromRef marker.
3699
+ *
3700
+ * @param value - Value to check
3701
+ * @returns True if value is a fromRef marker
3702
+ */
3703
+ declare function isFromRef(value: unknown): value is {
3704
+ [FROM_REF]: React$1.RefObject<any>;
3705
+ };
3706
+
3707
+ /**
3708
+ * Symbol marker for mount-only method calls.
3709
+ * Used to identify methods that should only be called once on initial mount.
3710
+ */
3711
+ declare const ONCE: unique symbol;
3712
+ /**
3713
+ * Marks a method call to be executed only on initial mount.
3714
+ * Useful for geometry transforms that should not be reapplied on every render.
3715
+ *
3716
+ * When `args` prop changes (triggering reconstruction), the method will be
3717
+ * called again on the new instance since appliedOnce is not carried over.
3718
+ *
3719
+ * @param args - Arguments to pass to the method
3720
+ * @returns A marker value that applyProps will execute once
3721
+ *
3722
+ * @example
3723
+ * // Rotate geometry on mount
3724
+ * <boxGeometry args={[1, 1, 1]} rotateX={once(Math.PI / 2)} />
3725
+ *
3726
+ * // Multiple arguments
3727
+ * <bufferGeometry applyMatrix4={once(matrix)} />
3728
+ *
3729
+ * // No arguments
3730
+ * <geometry center={once()} />
3731
+ */
3732
+ declare function once<T>(...args: T[]): T;
3733
+ /**
3734
+ * Type guard to check if a value is a once marker.
3735
+ *
3736
+ * @param value - Value to check
3737
+ * @returns True if value is a once marker
3738
+ */
3739
+ declare function isOnce(value: unknown): value is {
3740
+ [ONCE]: any[] | true;
3741
+ };
3742
+
3530
3743
  /**
3531
3744
  * A DOM canvas which accepts threejs elements as children.
3532
3745
  * @see https://docs.pmnd.rs/react-three-fiber/api/canvas
3533
3746
  */
3534
3747
  declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
3535
3748
 
3536
- export { Block, Canvas, ErrorBoundary, IsObject, 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, getInstanceProps, getRootState, getScheduler, getUuidPrefix, hasConstructor, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isObject3D, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, prepare, reconciler, removeInteractivity, resolve, unmountComponentAtNode, updateCamera, updateFrustum, useBridge, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useMutableCallback, useRenderTarget, useStore, useTexture, useTextures, useThree };
3537
- export type { Act, AddPhaseOptions, Args, ArgsProp, AttachFnType, AttachType, BaseRendererProps, Bridge, Camera, CameraProps, CanvasProps, Catalogue, Color, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DomEvent, Dpr, ElementProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameControls, FrameNextCallback, FrameNextControls, FrameNextState, FrameState, FrameTimingState, Frameloop, GLProps, GLTFLike, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, Properties, Quaternion, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererFactory, RendererProps, Root, RootOptions, RootState, RootStore, SchedulerApi, SetBlock, Size, Subscription, TextureEntry, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseFrameNextOptions, UseFrameOptions, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager };
3749
+ export { Block, Canvas, Environment, EnvironmentCube, EnvironmentMap, EnvironmentPortal, ErrorBoundary, FROM_REF, IsObject, ONCE, Portal, R3F_BUILD_LEGACY, R3F_BUILD_WEBGPU, REACT_INTERNAL_PROPS, RESERVED_PROPS, three_d as ReactThreeFiber, Texture, _roots, addAfterEffect, addEffect, addTail, advance, applyProps, attach, buildGraph, calculateDpr, context, createEvents, createPointerEvents, createPortal, createRoot, createStore, detach, diffProps, dispose, createPointerEvents as events, extend, findInitialRoot, flushSync, fromRef, getInstanceProps, getPrimary, getPrimaryIds, getRootState, getUuidPrefix, hasConstructor, hasPrimary, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isFromRef, isObject3D, isOnce, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, once, prepare, presetsObj, reconciler, registerPrimary, removeInteractivity, resolve, swapInteractivity, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useMutableCallback, useRenderTarget, useStore, useTexture, useTextures, useThree, waitForPrimary };
3750
+ 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, 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, R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, 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 };