@react-three/fiber 10.0.0-alpha.2 → 10.0.0-canary.164c7be

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