@react-three/fiber 10.0.0-canary.4bc4a97 → 10.0.0-canary.4bf885a

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/legacy.d.ts CHANGED
@@ -1,9 +1,9 @@
1
1
  import * as THREE$1 from 'three';
2
- import { WebGLCubeRenderTarget, WebGLRenderTarget, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Node as Node$1, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Object3D, Frustum, OrthographicCamera } from 'three';
2
+ import { WebGLCubeRenderTarget, WebGLRenderTarget, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Object3D, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Frustum, OrthographicCamera } from 'three';
3
3
  import * as React$1 from 'react';
4
4
  import { ReactNode, Component, RefObject, JSX } from 'react';
5
5
  import * as three_webgpu from 'three/webgpu';
6
- import { WebGPURenderer as WebGPURenderer$1, Node, StorageTexture, Data3DTexture, CanvasTarget, ShaderNodeObject } from 'three/webgpu';
6
+ import { WebGPURenderer as WebGPURenderer$1, Node, StorageTexture, Storage3DTexture, StorageArrayTexture, Data3DTexture, CanvasTarget } from 'three/webgpu';
7
7
  import { StoreApi } from 'zustand';
8
8
  import { UseBoundStoreWithEqualityFn } from 'zustand/traditional';
9
9
  import { FrameTimingState, FrameCallback as FrameCallback$1, SchedulerApi, UseFrameNextOptions, FrameNextControls } from '@pmndrs/scheduler';
@@ -12,20 +12,6 @@ import { Options } from 'react-use-measure';
12
12
  import * as react_jsx_runtime from 'react/jsx-runtime';
13
13
  import { GroundedSkybox } from 'three/examples/jsm/objects/GroundedSkybox.js';
14
14
 
15
- function _mergeNamespaces(n, m) {
16
- m.forEach(function (e) {
17
- e && typeof e !== 'string' && !Array.isArray(e) && Object.keys(e).forEach(function (k) {
18
- if (k !== 'default' && !(k in n)) {
19
- var d = Object.getOwnPropertyDescriptor(e, k);
20
- Object.defineProperty(n, k, d.get ? d : {
21
- enumerable: true,
22
- get: function () { return e[k]; }
23
- });
24
- }
25
- });
26
- });
27
- return Object.freeze(n);
28
- }
29
15
 
30
16
  /**
31
17
  * @fileoverview Internal Three.js re-exports - LEGACY ENTRY
@@ -38,28 +24,17 @@ function _mergeNamespaces(n, m) {
38
24
  declare const R3F_BUILD_LEGACY = true;
39
25
  declare const R3F_BUILD_WEBGPU = false;
40
26
 
41
- declare const Inspector: {
42
- new (): {};
43
- };
44
- declare const WebGPURenderer: {
45
- new (): {};
46
- };
27
+ type Inspector = never;
28
+ /** Not available on the legacy (WebGL-only) entry. */
29
+ declare function loadInspector(): Promise<never>;
30
+ declare class WebGPURenderer {
31
+ constructor();
32
+ }
47
33
 
48
34
  declare const RenderTarget: any;
49
35
 
50
36
  declare const CubeRenderTarget: any;
51
37
 
52
- var THREE = /*#__PURE__*/_mergeNamespaces({
53
- __proto__: null,
54
- CubeRenderTarget: CubeRenderTarget,
55
- CubeRenderTargetCompat: WebGLCubeRenderTarget,
56
- Inspector: Inspector,
57
- R3F_BUILD_LEGACY: R3F_BUILD_LEGACY,
58
- R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
59
- RenderTarget: RenderTarget,
60
- RenderTargetCompat: WebGLRenderTarget,
61
- WebGPURenderer: WebGPURenderer
62
- }, [THREE$1]);
63
38
 
64
39
  //* Utility Types ==============================
65
40
 
@@ -347,6 +322,7 @@ type BufferLike =
347
322
  | Uint16Array
348
323
  | Int16Array
349
324
  | THREE$1.BufferAttribute // Base class for all buffer attributes
325
+ | THREE$1.InterleavedBufferAttribute
350
326
  | Node // TSL buffer nodes (instancedArray, storage)
351
327
 
352
328
  /** Flat record of buffer-like values (no nested scopes) */
@@ -358,6 +334,25 @@ type BufferRecord = Record<string, BufferLike>
358
334
  */
359
335
  type BufferStore = Record<string, BufferLike | BufferRecord>
360
336
 
337
+ //* Node Types (useNodes) ========================================
338
+
339
+ /**
340
+ * Every node representation `useNodes` accepts and `state.nodes` holds: three's real `Node`,
341
+ * the callable proxy `Fn()` returns, and the legacy structural shape (`uuid`/`nodeType`) older
342
+ * code passes through. Creators are constrained to this same type, so the shape a creator returns
343
+ * and the shape the store holds are one type by construction.
344
+ */
345
+ type NodeLike = TSLNodeType | LegacyTSLNodeLike
346
+
347
+ /** Flat record of TSL nodes (no nested scopes) */
348
+ type NodeRecord<T extends NodeLike = NodeLike> = Record<string, T>
349
+
350
+ /**
351
+ * Node store that can contain both root-level nodes and scoped node objects.
352
+ * Structure: { wobble: OperatorNode, fx: { blur: ShaderCallable } }
353
+ */
354
+ type NodeStore = Record<string, NodeLike | NodeRecord>
355
+
361
356
  //* Storage Types (useGPUStorage) ========================================
362
357
 
363
358
  /**
@@ -372,7 +367,9 @@ type BufferStore = Record<string, BufferLike | BufferRecord>
372
367
  * ```
373
368
  */
374
369
  type StorageLike =
375
- | StorageTexture // GPU storage texture
370
+ | StorageTexture // 2D GPU storage texture
371
+ | Storage3DTexture // 3D GPU storage texture (volumes, fluid grids)
372
+ | StorageArrayTexture // 2D-array GPU storage texture
376
373
  | Data3DTexture // 3D texture (can be used as storage)
377
374
  | Node // TSL storage texture nodes (storageTexture)
378
375
 
@@ -484,6 +481,12 @@ interface InternalState {
484
481
  actualRenderer: R3FRenderer
485
482
  /** Global scheduler reference (for useFrame hook) */
486
483
  scheduler: SchedulerApi | null
484
+ /**
485
+ * Replaces `renderer.render(scene, camera)` in the default render job when set. Set it with
486
+ * `setRenderOverride(store, fn)`; the job keeps its fps throttle, error handling and user
487
+ * render-phase takeover. Used by `useRenderPipeline`.
488
+ */
489
+ renderOverride?: (() => void) | null
487
490
  /** This root's unique ID in the global scheduler */
488
491
  rootId?: string
489
492
  /** Function to unregister this root from the global scheduler */
@@ -491,11 +494,28 @@ interface InternalState {
491
494
  /** Container for child attachment (scene for root, original container for portals) */
492
495
  container?: THREE$1.Object3D
493
496
  /**
494
- * CanvasTarget for multi-canvas WebGPU rendering.
495
- * Created for all WebGPU canvases to support renderer sharing.
497
+ * The CanvasTarget this root sizes and renders through.
498
+ *
499
+ * A primary (`<Canvas id>`) owns the renderer's default target -- the one three itself built
500
+ * around the canvas element -- so sizing it is sizing the renderer. A secondary owns a target
501
+ * R3F created for its own element. Either way there is exactly one target per canvas element,
502
+ * and the canvas-target job makes it the renderer's active one before this root renders.
503
+ * Absent on WebGL and on an id-less WebGPU canvas, where the renderer is sized directly.
496
504
  * @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
497
505
  */
498
506
  canvasTarget?: CanvasTarget
507
+ /**
508
+ * Set when this root's canvas target has been resized and the backend's cached render pass
509
+ * descriptor (which holds a depth-stencil view built once per canvas) is therefore stale.
510
+ *
511
+ * Flushed by the canvas-target job in the `start` phase, which is the only place this root's
512
+ * target is guaranteed to be the renderer's active one — `backend.updateSize()` operates on
513
+ * whatever `getCanvasTarget()` returns, so calling it from the resize subscription would
514
+ * invalidate some other canvas's descriptor instead.
515
+ *
516
+ * @see https://github.com/pmndrs/react-three-fiber/issues/3847
517
+ */
518
+ canvasTargetSizeDirty?: boolean
499
519
  /**
500
520
  * Whether multi-canvas rendering is active.
501
521
  * True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
@@ -605,7 +625,7 @@ interface RootState {
605
625
  /** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
606
626
  uniforms: UniformStore
607
627
  /** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
608
- nodes: Record<string, any>
628
+ nodes: NodeStore
609
629
  /** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
610
630
  buffers: BufferStore
611
631
  /** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
@@ -617,7 +637,7 @@ interface RootState {
617
637
  /** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
618
638
  renderPipeline: ThreeRenderPipeline | null
619
639
  /** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
620
- passes: Record<string, any>
640
+ passes: PassRecord
621
641
  /** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
622
642
  _hmrVersion: number
623
643
  /** Internal: whether setSize() has taken ownership of canvas dimensions */
@@ -705,12 +725,19 @@ type DefaultRendererProps = {
705
725
  */
706
726
  interface CanvasSchedulerConfig {
707
727
  /**
708
- * Render this canvas after another canvas completes.
709
- * Pass the `id` of another canvas.
728
+ * Run this Canvas root before the referenced Canvas root id(s).
729
+ */
730
+ before?: string | string[]
731
+ /**
732
+ * Run this Canvas root after the referenced Canvas root id(s).
710
733
  */
711
- after?: string
734
+ after?: string | string[]
712
735
  /**
713
- * Limit this canvas's render rate (frames per second).
736
+ * Numeric root order. Lower values run first.
737
+ */
738
+ order?: number
739
+ /**
740
+ * Limit this Canvas's default render job (frames per second).
714
741
  */
715
742
  fps?: number
716
743
  }
@@ -797,14 +824,17 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
797
824
  performance?: Partial<Omit<Performance, 'regress'>>
798
825
  /** Target pixel ratio. Can clamp between a range: `[min, max]` */
799
826
  dpr?: Dpr
800
- /** Props that go into the default raycaster */
801
- raycaster?: Partial<THREE$1.Raycaster>
827
+ /**
828
+ * Props that go into the default raycaster. `params` is merged into the raycaster's defaults,
829
+ * so a single threshold can be set: `raycaster={{ params: { Points: { threshold: 0.2 } } }}`.
830
+ */
831
+ raycaster?: Partial<Omit<THREE$1.Raycaster, 'params'>> & { params?: Partial<THREE$1.RaycasterParameters> }
802
832
  /** A `THREE.Scene` instance or props that go into the default scene */
803
833
  scene?: THREE$1.Scene | Partial<THREE$1.Scene>
804
834
  /** A `THREE.Camera` instance or props that go into the default camera */
805
835
  camera?: CameraProps
806
836
  /** An R3F event manager to manage elements' pointer events */
807
- events?: (store: RootStore) => EventManager<HTMLElement>
837
+ events?: (store: RootStore) => EventManager<Element>
808
838
  /** Callback after the canvas has rendered (but not yet committed) */
809
839
  onCreated?: (state: RootState) => void
810
840
  /** Response for pointer clicks that have missed any target */
@@ -893,7 +923,6 @@ type InstanceProps<T = any, P = any> = ArgsProp<P> & {
893
923
  object?: T
894
924
  dispose?: null
895
925
  attach?: AttachType<T>
896
- onUpdate?: (self: T) => void
897
926
  }
898
927
 
899
928
  interface Instance<O = any> {
@@ -1033,7 +1062,7 @@ interface CanvasProps
1033
1062
  */
1034
1063
  resize?: Options
1035
1064
  /** The target where events are being subscribed to, default: the div that wraps canvas */
1036
- eventSource?: HTMLElement | React$1.RefObject<HTMLElement | null>
1065
+ eventSource?: Element | React$1.RefObject<Element | null>
1037
1066
  /** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
1038
1067
  eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
1039
1068
  /** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
@@ -1141,81 +1170,86 @@ interface LegacyRootState extends Omit<RootState, 'renderer' | 'internal'> {
1141
1170
 
1142
1171
  type RenderTargetOptions = RenderTargetOptions$1
1143
1172
 
1144
- //* Global Types ==============================
1173
+ //* Global TSL Types ==============================
1145
1174
 
1146
1175
  declare global {
1147
1176
  /**
1148
- * Uniform node type.
1149
- *
1150
- * This is three's own `UniformNode`, not a re-declaration of it. It previously was a
1151
- * hand-rolled `interface UniformNode<T> extends Node { value: T }`, which shadowed the real
1152
- * exported type globally — so R3F's ~58 references resolved to an approximation that was
1153
- * missing members three actually ships (`setName` among them) and had drifted to the wrong
1154
- * arity when three made `UniformNode` two-parameter.
1155
- *
1156
- * three's signature is `UniformNode<TNodeType, TValue>`. R3F only ever varies the value type,
1157
- * so the node type is fixed to `unknown` and the single parameter is kept for call-site
1158
- * ergonomics. The result is three's structural type, so members stay in sync with the
1159
- * installed three instead of needing to be mirrored by hand.
1177
+ * Broad callable-node fallback for dynamic store readers.
1178
+ * Creator hooks preserve the exact function signatures inferred from Three's `Fn`.
1160
1179
  */
1161
- type UniformNode<T = unknown> = three_webgpu.UniformNode<unknown, T>
1180
+ type CallableTSLNode = ((...params: never[]) => unknown) & {
1181
+ readonly shaderNode: unknown
1182
+ readonly id: number
1183
+ }
1162
1184
 
1163
- /**
1164
- * ShaderCallable - the return type of Fn()
1165
- * A callable shader function node that can be invoked with parameters.
1166
- * The function returns a ShaderNodeObject when called.
1167
- *
1168
- * @example
1169
- * ```tsx
1170
- * // Define a shader function
1171
- * const blendColorFn = Fn(([color1, color2, factor]) => {
1172
- * return mix(color1, color2, factor)
1173
- * })
1174
- *
1175
- * // Type when retrieving from nodes store
1176
- * const { blendColorFn } = nodes as { blendColorFn: ShaderCallable }
1177
- *
1178
- * // Or with specific return type
1179
- * const { myFn } = nodes as { myFn: ShaderCallable<THREE.Node> }
1180
- * ```
1181
- */
1182
- type ShaderCallable<R extends Node = Node> = ((...params: unknown[]) => ShaderNodeObject<R>) & Node
1185
+ /** Legacy structural node accepted when at least one historical marker exists. */
1186
+ type LegacyTSLNodeLike = {
1187
+ label?: ((label: string) => unknown) | string
1188
+ setName?: (name: string) => unknown
1189
+ } & ({ uuid: string | undefined; nodeType?: string | null } | { uuid?: string; nodeType: string | null | undefined })
1183
1190
 
1184
- /**
1185
- * ShaderNodeRef - a ShaderNodeObject wrapper around a Node
1186
- * This is the common return type for TSL operations (add, mul, sin, etc.)
1187
- *
1188
- * @example
1189
- * ```tsx
1190
- * const { wobble } = nodes as { wobble: ShaderNodeRef }
1191
- * ```
1192
- */
1193
- type ShaderNodeRef<T extends Node = Node> = ShaderNodeObject<T>
1191
+ /** Node type accepted by broad dynamic node-store readers. */
1192
+ type TSLNodeType = three_webgpu.Node | CallableTSLNode
1194
1193
 
1195
1194
  /**
1196
- * TSLNodeType - Union of all common TSL node types
1197
- * Used by ScopedStore to properly type node access from the store.
1198
- *
1199
- * Includes:
1200
- * - Node: base Three.js node type
1201
- * - ShaderCallable: function nodes created with Fn()
1202
- * - ShaderNodeObject: wrapped nodes from TSL operations (sin, mul, mix, etc.)
1203
- *
1204
- * @example
1205
- * ```tsx
1206
- * // In useLocalNodes, nodes are typed as TSLNodeType
1207
- * const { positionNode, blendColorFn } = useLocalNodes(({ nodes }) => ({
1208
- * positionNode: nodes.myPosition, // Works - Node is in union
1209
- * blendColorFn: nodes.myFn, // Works - ShaderCallable is in union
1210
- * }))
1211
- *
1212
- * // Can narrow with type guard or assertion when needed
1213
- * if (typeof blendColorFn === 'function') {
1214
- * blendColorFn(someColor, 0.5)
1215
- * }
1216
- * ```
1195
+ * Derive Three's shader node type from an existing node or a supported raw input.
1196
+ * Existing InputNode generics take precedence over structural value normalization.
1197
+ * Both generics must be inferred because Three's UniformNode intersects an unknown-typed
1198
+ * InputNode base with its concrete InputNode specialization.
1217
1199
  */
1218
- type TSLNodeType = Node | ShaderCallable<Node> | ShaderNodeObject<Node>
1200
+ type UniformNodeType<T> = T extends three_webgpu.UniformNode<infer TNodeType, infer _TValue>
1201
+ ? TNodeType
1202
+ : T extends three_webgpu.InputNode<infer TNodeType, infer _TValue>
1203
+ ? TNodeType
1204
+ : T extends number
1205
+ ? 'float'
1206
+ : T extends boolean
1207
+ ? 'bool'
1208
+ : T extends string | three_webgpu.Color | { r: number; g: number; b: number }
1209
+ ? 'color'
1210
+ : T extends three_webgpu.Vector4 | { x: number; y: number; z: number; w: number }
1211
+ ? 'vec4'
1212
+ : T extends three_webgpu.Vector3 | { x: number; y: number; z: number }
1213
+ ? 'vec3'
1214
+ : T extends three_webgpu.Vector2 | { x: number; y: number }
1215
+ ? 'vec2'
1216
+ : T extends three_webgpu.Matrix4
1217
+ ? 'mat4'
1218
+ : T extends three_webgpu.Matrix3
1219
+ ? 'mat3'
1220
+ : T extends three_webgpu.Matrix2
1221
+ ? 'mat2'
1222
+ : unknown
1223
+
1224
+ /** Derive the normalized JavaScript value stored by a uniform node. */
1225
+ type UniformNodeValue<T> = T extends three_webgpu.UniformNode<infer _TNodeType, infer TValue>
1226
+ ? TValue
1227
+ : T extends three_webgpu.InputNode<infer _TNodeType, infer TValue>
1228
+ ? TValue
1229
+ : T extends string | { r: number; g: number; b: number }
1230
+ ? three_webgpu.Color
1231
+ : T extends { x: number; y: number; z: number; w: number }
1232
+ ? three_webgpu.Vector4
1233
+ : T extends { x: number; y: number; z: number }
1234
+ ? three_webgpu.Vector3
1235
+ : T extends { x: number; y: number }
1236
+ ? three_webgpu.Vector2
1237
+ : T extends number
1238
+ ? number
1239
+ : T extends boolean
1240
+ ? boolean
1241
+ : T
1242
+
1243
+ /** Three's exact UniformNode with shader and value generics derived from an input. */
1244
+ type UniformNodeFor<T> = three_webgpu.UniformNode<UniformNodeType<T>, UniformNodeValue<T>>
1245
+
1246
+ /** Preserve every input key while mapping values to exact Three uniform nodes. */
1247
+ type UniformNodesFor<T extends UniformInputRecord> = {
1248
+ [K in keyof T]: UniformNodeFor<T[K]>
1249
+ }
1250
+
1251
+ /** Backward-compatible single-parameter uniform alias. */
1252
+ type UniformNode<T = unknown> = UniformNodeFor<T>
1219
1253
 
1220
1254
  /** Flat record of uniform nodes (no nested scopes) */
1221
1255
  type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
@@ -1240,7 +1274,7 @@ declare global {
1240
1274
  * Acceptable input values for useUniforms - raw values that get converted to UniformNodes
1241
1275
  * Supports:
1242
1276
  * - Primitives: number, string (color), boolean
1243
- * - Three.js types: Color, Vector2/3/4, Matrix3/4, Euler, Quaternion
1277
+ * - Three.js types: Color, Vector2/3/4, Matrix2/3/4
1244
1278
  * - Plain objects: { x, y, z, w } converted to vectors
1245
1279
  * - TSL nodes: color(), vec3(), float() for type casting
1246
1280
  * - UniformNode: existing uniforms (reused as-is)
@@ -1253,88 +1287,124 @@ declare global {
1253
1287
  | three_webgpu.Vector2
1254
1288
  | three_webgpu.Vector3
1255
1289
  | three_webgpu.Vector4
1290
+ | three_webgpu.Matrix2
1256
1291
  | three_webgpu.Matrix3
1257
1292
  | three_webgpu.Matrix4
1258
- | three_webgpu.Euler
1259
- | three_webgpu.Quaternion
1260
- | { x: number; y?: number; z?: number; w?: number } // Plain objects converted to vectors
1293
+ | { x: number; y: number }
1294
+ | { x: number; y: number; z: number }
1295
+ | { x: number; y: number; z: number; w: number }
1261
1296
  | { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
1262
- | Node // TSL nodes like color(), vec3(), float() for type casting
1297
+ | three_webgpu.Node // TSL nodes like color(), vec3(), float() for type casting
1263
1298
  | UniformNode
1264
1299
 
1265
1300
  /** Input record for useUniforms - accepts raw values or UniformNodes */
1266
1301
  type UniformInputRecord = Record<string, UniformValue>
1267
1302
  }
1268
1303
 
1269
- //* Module Augmentation ==============================
1270
-
1271
- declare module 'three/tsl' {
1304
+ declare global {
1272
1305
  /**
1273
- * Fn with array parameter destructuring
1274
- * @example Fn(([uv, skew]) => { ... })
1306
+ * three's own render pipeline type. Named here so the rest of R3F refers to three's shape
1307
+ * rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
1308
+ * is r185, so the new name is the only one.
1275
1309
  */
1276
- export function Fn<R extends Node = Node>(
1277
- jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
1278
- ): ShaderCallable<R>
1310
+ type ThreeRenderPipeline = three_webgpu.RenderPipeline
1279
1311
 
1280
1312
  /**
1281
- * Fn with object parameter destructuring
1282
- * @example Fn(({ color, intensity }) => { ... })
1313
+ * The pass `useRenderPipeline` creates for you: three's own `PassNode`, as returned by
1314
+ * `pass(scene, camera)` from `three/tsl`. Referenced from three so members like
1315
+ * `getTextureNode`, `setMRT` and `dispose` track the installed version.
1283
1316
  */
1284
- export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
1285
- jsFunc: (inputs: T) => ShaderNodeObject<R>,
1286
- ): ShaderCallable<R>
1317
+ type ScenePassNode = three_webgpu.PassNode
1287
1318
 
1288
1319
  /**
1289
- * Fn with array params + layout
1290
- * @example Fn(([a, b]) => { ... }, { layout: [...] })
1320
+ * Pass record - stores TSL pass nodes for render pipeline.
1321
+ *
1322
+ * `scenePass` is the only key the library owns. It is optional here because this is also the
1323
+ * shape of `state.passes`, which is `{}` before the pipeline exists and again after `reset()`
1324
+ * or `clearPasses()`. Inside the callbacks it is always present; see
1325
+ * {@link RenderPipelineCallbackState}.
1326
+ *
1327
+ * Every other key is user-registered, via a callback's return value. Those are TSL nodes of
1328
+ * any kind, not only passes: texture reads of an MRT attachment, effect nodes, extra
1329
+ * `pass()` instances. `Node` is the common base, so that is the bound. Narrow at the call
1330
+ * site when you need a member, e.g. `passes.velocity as TextureNode`.
1331
+ *
1332
+ * The index signature admits `undefined` because a key may simply not be registered, and
1333
+ * because the optional `scenePass` must be assignable to it: under `skipLibCheck: false` an
1334
+ * optional property whose type excludes `undefined` from the index signature is an error
1335
+ * (TS2411) for every consumer compiling these declarations.
1291
1336
  */
1292
- export function Fn<R extends Node = Node>(
1293
- jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
1294
- layout: { layout?: unknown },
1295
- ): ShaderCallable<R>
1337
+ interface PassRecord {
1338
+ scenePass?: ScenePassNode
1339
+ [key: string]: three_webgpu.Node | undefined
1340
+ }
1296
1341
 
1297
1342
  /**
1298
- * Fn with object params + layout
1343
+ * State passed to pipeline callbacks after the active pipeline has been created.
1344
+ *
1345
+ * `passes.scenePass` is required here: the hook installs the default scene pass before either
1346
+ * callback runs, so callbacks can use it without a guard or a cast.
1347
+ *
1348
+ * `renderer` is narrowed to `WebGPURenderer` and `isLegacy` to `false`: the hook throws under
1349
+ * the legacy renderer before either callback can run, so a callback never sees WebGL.
1299
1350
  */
1300
- export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
1301
- jsFunc: (inputs: T) => ShaderNodeObject<R>,
1302
- layout: { layout?: unknown },
1303
- ): ShaderCallable<R>
1304
- }
1351
+ type RenderPipelineCallbackState = RootState & {
1352
+ renderPipeline: ThreeRenderPipeline
1353
+ passes: PassRecord & { scenePass: ScenePassNode }
1354
+ renderer: three_webgpu.WebGPURenderer
1355
+ isLegacy: false
1356
+ }
1305
1357
 
1306
- declare global {
1307
1358
  /**
1308
- * three's own render pipeline type. Named here so the rest of R3F refers to three's shape
1309
- * rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
1310
- * is r185, so the new name is the only one.
1359
+ * What a callback may return to register entries into `state.passes`.
1360
+ *
1361
+ * `scenePass` is reserved. The hook owns that entry and its lifecycle: it caches the pass it
1362
+ * created, and `rebuild()` / `reset()` dispose that cached pass. A callback overwriting the
1363
+ * store entry would leave the store pointing at a node the hook never disposes, and the hook
1364
+ * disposing a pass nothing references. So returning it is a type error.
1311
1365
  */
1312
- type ThreeRenderPipeline = three_webgpu.RenderPipeline
1313
-
1314
- /** Pass record - stores TSL pass nodes for render pipeline */
1315
- type PassRecord = Record<string, any>
1366
+ type RegisteredPasses = Record<string, three_webgpu.Node> & { scenePass?: never }
1316
1367
 
1317
1368
  /** Setup callback - runs first to configure MRT, create additional passes */
1318
- type RenderPipelineSetupCallback = (state: RootState) => PassRecord | void
1369
+ type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
1319
1370
 
1320
1371
  /** Main callback - runs second to configure outputNode, create effect passes */
1321
- type RenderPipelineMainCallback = (state: RootState) => PassRecord | void
1372
+ type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
1322
1373
 
1323
- /** Return type for useRenderPipeline hook */
1324
- interface UseRenderPipelineReturn {
1374
+ /** The imperative half of useRenderPipeline's return value, present in every state */
1375
+ interface UseRenderPipelineActions {
1325
1376
  /** Current passes from state */
1326
1377
  passes: PassRecord
1327
- /** RenderPipeline instance (null if not initialized) */
1328
- renderPipeline: ThreeRenderPipeline | null
1329
1378
  /** Clear all passes from state */
1330
1379
  clearPasses: () => void
1331
1380
  /** Reset RenderPipeline entirely (clears PP + passes) */
1332
1381
  reset: () => void
1333
1382
  /** Re-run setup/main callbacks with current closure values */
1334
1383
  rebuild: () => void
1335
- /** True when RenderPipeline is configured and ready */
1336
- isReady: boolean
1337
1384
  }
1385
+
1386
+ /**
1387
+ * Return type for useRenderPipeline hook, discriminated on `isReady`.
1388
+ *
1389
+ * `if (isReady)` narrows `renderPipeline` to non-null, which is what the docs already tell
1390
+ * callers to check. `passes.scenePass` deliberately stays optional in the ready branch:
1391
+ * `clearPasses()` empties the record while leaving the pipeline in place.
1392
+ */
1393
+ type UseRenderPipelineReturn = UseRenderPipelineActions &
1394
+ (
1395
+ | {
1396
+ /** True when RenderPipeline is configured and ready */
1397
+ isReady: true
1398
+ /** RenderPipeline instance */
1399
+ renderPipeline: ThreeRenderPipeline
1400
+ }
1401
+ | {
1402
+ /** False until the pipeline has been created */
1403
+ isReady: false
1404
+ /** Not initialized yet, or torn down by reset() */
1405
+ renderPipeline: null
1406
+ }
1407
+ )
1338
1408
  }
1339
1409
 
1340
1410
  type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
@@ -1413,10 +1483,11 @@ type TSLNodeInput = { nodeType?: string | null; uuid?: string } | null
1413
1483
 
1414
1484
  /**
1415
1485
  * For node material properties (colorNode, positionNode, etc.), accept broader types
1416
- * since @types/three has broken inheritance for TSL node subclasses.
1486
+ * since @types/three has broken inheritance for TSL node subclasses. NodeClass requires
1487
+ * `nodeType`, so this structural key test remains neutral to the selected Three entry.
1417
1488
  */
1418
1489
  type NodeProps<P> = {
1419
- [K in keyof P as P[K] extends Node$1 | null ? K : never]?: TSLNodeInput
1490
+ [K in keyof P as NonNullable<P[K]> extends { nodeType: string | null } ? K : never]?: TSLNodeInput
1420
1491
  }
1421
1492
 
1422
1493
  interface ReactProps<P> {
@@ -1437,11 +1508,29 @@ type ThreeToJSXElements<T extends Record<string, any>> = {
1437
1508
  [K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
1438
1509
  }
1439
1510
 
1511
+ /** Method names of Object3D, excluded from the `primitive` element's typed props. */
1512
+ type Object3DMethod = NonNullable<
1513
+ {
1514
+ [K in keyof Object3D]-?: Object3D[K] extends (...args: any[]) => any ? K : never
1515
+ }[keyof Object3D]
1516
+ >
1517
+
1440
1518
  type ThreeExports = typeof import('three')
1441
1519
  type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
1442
1520
 
1443
1521
  interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
1444
- primitive: Omit<ThreeElement<any>, 'args'> & { object: object }
1522
+ /**
1523
+ * `primitive` wraps a pre-existing object, so its props cannot be derived from one class.
1524
+ * Events are typed from `EventHandlers` (`onClick={(e) => ...}` infers `e`), the ref is
1525
+ * untyped, and any other prop is accepted and applied to the object by name. Object3D's own
1526
+ * methods are left out of the typed surface: they return `this`, so a subclass element's
1527
+ * props (`ThreeElements['group']`) could not be spread onto a primitive otherwise.
1528
+ */
1529
+ primitive: Omit<ThreeElement<typeof Object3D>, 'args' | 'object' | 'ref' | Object3DMethod> & {
1530
+ object: object
1531
+ ref?: React.Ref<any>
1532
+ [prop: string]: unknown
1533
+ }
1445
1534
  // Conflicts with DOM types can be accessed through a three* prefix
1446
1535
  threeAudio: ThreeElementsImpl['audio']
1447
1536
  threeSource: ThreeElementsImpl['source']
@@ -1482,6 +1571,7 @@ type three_d_Matrix3 = Matrix3;
1482
1571
  type three_d_Matrix4 = Matrix4;
1483
1572
  type three_d_MutableOrReadonlyParameters<T extends (...args: any) => any> = MutableOrReadonlyParameters<T>;
1484
1573
  type three_d_NodeProps<P> = NodeProps<P>;
1574
+ type three_d_Object3DMethod = Object3DMethod;
1485
1575
  type three_d_Quaternion = Quaternion;
1486
1576
  type three_d_RaycastableRepresentation = RaycastableRepresentation;
1487
1577
  type three_d_ReactProps<P> = ReactProps<P>;
@@ -1496,7 +1586,7 @@ type three_d_Vector3 = Vector3;
1496
1586
  type three_d_Vector4 = Vector4;
1497
1587
  type three_d_VectorRepresentation = VectorRepresentation;
1498
1588
  declare namespace three_d {
1499
- export type { three_d_Color as Color, three_d_ElementProps as ElementProps, three_d_Euler as Euler, three_d_EventProps as EventProps, three_d_GeometryProps as GeometryProps, three_d_GeometryTransformProps as GeometryTransformProps, three_d_Layers as Layers, three_d_MathProps as MathProps, three_d_MathRepresentation as MathRepresentation, three_d_MathType as MathType, three_d_MathTypes as MathTypes, three_d_Matrix3 as Matrix3, three_d_Matrix4 as Matrix4, three_d_MutableOrReadonlyParameters as MutableOrReadonlyParameters, three_d_NodeProps as NodeProps, three_d_Quaternion as Quaternion, three_d_RaycastableRepresentation as RaycastableRepresentation, three_d_ReactProps as ReactProps, three_d_TSLNodeInput as TSLNodeInput, three_d_ThreeElement as ThreeElement, three_d_ThreeElements as ThreeElements, three_d_ThreeElementsImpl as ThreeElementsImpl, three_d_ThreeExports as ThreeExports, three_d_ThreeToJSXElements as ThreeToJSXElements, three_d_Vector2 as Vector2, three_d_Vector3 as Vector3, three_d_Vector4 as Vector4, three_d_VectorRepresentation as VectorRepresentation };
1589
+ export type { three_d_Color as Color, three_d_ElementProps as ElementProps, three_d_Euler as Euler, three_d_EventProps as EventProps, three_d_GeometryProps as GeometryProps, three_d_GeometryTransformProps as GeometryTransformProps, three_d_Layers as Layers, three_d_MathProps as MathProps, three_d_MathRepresentation as MathRepresentation, three_d_MathType as MathType, three_d_MathTypes as MathTypes, three_d_Matrix3 as Matrix3, three_d_Matrix4 as Matrix4, three_d_MutableOrReadonlyParameters as MutableOrReadonlyParameters, three_d_NodeProps as NodeProps, three_d_Object3DMethod as Object3DMethod, three_d_Quaternion as Quaternion, three_d_RaycastableRepresentation as RaycastableRepresentation, three_d_ReactProps as ReactProps, three_d_TSLNodeInput as TSLNodeInput, three_d_ThreeElement as ThreeElement, three_d_ThreeElements as ThreeElements, three_d_ThreeElementsImpl as ThreeElementsImpl, three_d_ThreeExports as ThreeExports, three_d_ThreeToJSXElements as ThreeToJSXElements, three_d_Vector2 as Vector2, three_d_Vector3 as Vector3, three_d_Vector4 as Vector4, three_d_VectorRepresentation as VectorRepresentation };
1500
1590
  }
1501
1591
 
1502
1592
  /**
@@ -1845,7 +1935,43 @@ declare function createEvents(store: RootStore): {
1845
1935
  processDeferredPointer: (event: DomEvent, pointerId: number) => void;
1846
1936
  };
1847
1937
  /** Default R3F event manager for web */
1848
- declare function createPointerEvents(store: RootStore): EventManager<HTMLElement>;
1938
+ declare function createPointerEvents(store: RootStore): EventManager<Element>;
1939
+
1940
+ interface RootExtension {
1941
+ /** Unique name. Registering the same name again replaces the entry (HMR-safe); roots it already
1942
+ * set up are not set up a second time, but get the new entry's dispose and hmr. */
1943
+ name: string;
1944
+ /**
1945
+ * Called once per root, after its renderer exists and before `onCreated` and the first frame.
1946
+ * `isLegacy` and `primaryStore` are known by then, so an extension can skip WebGL roots or defer
1947
+ * to the primary canvas. Return fields to merge into the root's state, or nothing.
1948
+ */
1949
+ setup?(store: RootStore): Partial<RootState> | void;
1950
+ /** Called when a root this extension set up unmounts. */
1951
+ dispose?(store: RootStore): void;
1952
+ /** Called when `<Canvas>` detects hot module replacement (skipped with `hmr={false}`). */
1953
+ hmr?(store: RootStore): void;
1954
+ }
1955
+ /**
1956
+ * Register an extension. It is set up on every live root immediately, and on every root created
1957
+ * afterwards. Returns a function that unregisters it: new roots are no longer set up, while roots
1958
+ * it already set up keep its state and still get its dispose when they unmount.
1959
+ */
1960
+ declare function registerRootExtension(extension: RootExtension): () => void;
1961
+ /**
1962
+ * Point a root's default render job at a different render function, or back at
1963
+ * `renderer.render(scene, camera)` with `null`.
1964
+ *
1965
+ * The default job keeps everything else: the Canvas `fps` throttle, error propagation to the error
1966
+ * boundary, and backing off when a user `useFrame(..., { phase: 'render' })` job takes over.
1967
+ */
1968
+ declare function setRenderOverride(store: RootStore, render: (() => void) | null): void;
1969
+
1970
+ /**
1971
+ * Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
1972
+ * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
1973
+ */
1974
+ declare function useStore(): RootStore;
1849
1975
 
1850
1976
  /**
1851
1977
  * Gets or creates a memoized loader instance from a loader constructor or returns the loader if it's already an instance.
@@ -1865,50 +1991,6 @@ declare namespace useLoader {
1865
1991
  var loader: typeof getLoader;
1866
1992
  }
1867
1993
 
1868
- /**
1869
- * Frame hook with phase-based ordering, priority, and FPS throttling.
1870
- *
1871
- * Always delivers full RootState — works both inside and outside Canvas context:
1872
- * - Inside Canvas: Full RootState (renderer, scene, camera, etc.)
1873
- * - Outside Canvas: The job registers immediately but the callback is held until a
1874
- * Canvas adopts it, then runs with full RootState. For hostless / standalone
1875
- * frame loops with no Canvas, use `@pmndrs/scheduler` directly.
1876
- *
1877
- * Returns a controls object for manual stepping, pausing, and resuming.
1878
- *
1879
- * @param callback - Function called each frame with (state, delta). Optional if you only need scheduler access.
1880
- * @param priorityOrOptions - Either a priority number (backwards compat) or options object
1881
- * @returns Controls object with step(), stepAll(), pause(), resume(), isPaused, id, scheduler
1882
- *
1883
- * @example
1884
- * // Simple priority (backwards compat)
1885
- * useFrame((state, delta) => { ... }, 5)
1886
- *
1887
- * @example
1888
- * // With phase-based ordering
1889
- * useFrame((state, delta) => { ... }, { phase: 'physics' })
1890
- *
1891
- * @example
1892
- * // Outside Canvas - callback waits for a Canvas, then always has full state
1893
- * function UI() {
1894
- * useFrame((state, delta) => { syncUI(state.camera) });
1895
- * return <button>...</button>;
1896
- * }
1897
- *
1898
- * @example
1899
- * // Hostless / standalone loop (no Canvas) - use @pmndrs/scheduler directly
1900
- * import { getScheduler } from '@pmndrs/scheduler'
1901
- * getScheduler().register((state, delta) => { updateGame(delta) })
1902
- *
1903
- * @example
1904
- * // Scheduler-only access (no callback)
1905
- * const { scheduler } = useFrame()
1906
- * scheduler.pauseJob('some-job-id')
1907
- *
1908
- * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useframe
1909
- */
1910
- declare function useFrame(callback?: FrameNextCallback, priorityOrOptions?: number | UseFrameNextOptions): FrameNextControls;
1911
-
1912
1994
  declare const IsObject: (url: unknown) => url is Record<string, string>;
1913
1995
  type TextureArray<T> = T extends string[] ? Texture$1[] : never;
1914
1996
  type TextureRecord<T> = T extends Record<string, string> ? {
@@ -2089,16 +2171,6 @@ declare function useRenderTarget(options?: RenderTargetOptions): WebGLRenderTarg
2089
2171
  declare function useRenderTarget(size: number, options?: RenderTargetOptions): WebGLRenderTarget;
2090
2172
  declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): WebGLRenderTarget;
2091
2173
 
2092
- /**
2093
- * Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
2094
- * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
2095
- */
2096
- declare function useStore(): RootStore;
2097
- /**
2098
- * Accesses R3F's internal state, containing renderer, canvas, scene, etc.
2099
- * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usethree
2100
- */
2101
- declare function useThree<T = RootState>(selector?: (state: RootState) => T, equalityFn?: <T>(state: T, newState: T) => boolean): T;
2102
2174
  /**
2103
2175
  * Exposes an object's {@link Instance}.
2104
2176
  * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#useInstanceHandle
@@ -2174,7 +2246,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
2174
2246
  * Invalidates the view, requesting a frame to be rendered.
2175
2247
  * In demand mode, this triggers the scheduler to run frames.
2176
2248
  *
2177
- * @param state - Optional root state (ignored in new scheduler, kept for backwards compat)
2249
+ * With a state argument, only that root's jobs run on the requested frames; other
2250
+ * roots on 'demand' stay idle. Without one, every registered root is invalidated.
2251
+ *
2252
+ * @param state - Optional root state; targets the invalidation at that root
2178
2253
  * @param frames - Number of frames to request (default: 1)
2179
2254
  * @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
2180
2255
  *
@@ -2185,14 +2260,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
2185
2260
  * Advances the frameloop and runs render effects.
2186
2261
  * Useful for when manually rendering via `frameloop="never"`.
2187
2262
  *
2263
+ * With a state argument, only that root is stepped. Without one, every
2264
+ * registered root is stepped for backwards compatibility.
2265
+ *
2188
2266
  * @param timestamp - The timestamp to use for this frame
2189
2267
  * @param runGlobalEffects - Ignored (kept for backwards compat, global effects always run)
2190
- * @param state - Ignored (kept for backwards compat)
2191
- * @param frame - Ignored (kept for backwards compat)
2268
+ * @param state - Optional root state; targets the manual step at that root
2192
2269
  *
2193
2270
  * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
2194
2271
  */
2195
- declare function advance(timestamp: number): void;
2272
+ declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
2196
2273
 
2197
2274
  /* eslint-disable @definitelytyped/no-unnecessary-generics */
2198
2275
  declare function ReactReconciler<
@@ -3237,6 +3314,7 @@ declare namespace ReactReconciler {
3237
3314
 
3238
3315
  declare function extend<T extends ConstructorRepresentation>(objects: T): React$1.ExoticComponent<ThreeElement<T>>;
3239
3316
  declare function extend<T extends Catalogue>(objects: T): void;
3317
+ declare function extend(objects: Record<string, unknown>): void;
3240
3318
  declare const reconciler: ReactReconciler.Reconciler<RootStore, Instance<any>, void, Instance<any>, never, any>;
3241
3319
 
3242
3320
  declare const isRenderer: (def: any) => boolean;
@@ -3261,6 +3339,7 @@ declare function Portal({ children, container, state }: PortalProps): JSX.Elemen
3261
3339
  declare function flushSync<R>(fn: () => R): R;
3262
3340
 
3263
3341
  declare const context: React$1.Context<RootStore>;
3342
+
3264
3343
  declare const createStore: (invalidate: (state?: RootState, frames?: number, stackFrames?: boolean) => void, advance: (timestamp: number, runGlobalEffects?: boolean, state?: RootState, frame?: XRFrame) => void) => RootStore;
3265
3344
 
3266
3345
  /**
@@ -3514,7 +3593,7 @@ declare function getInstanceProps<T = any>(pendingProps: Record<string, unknown>
3514
3593
  declare function prepare<T = any>(target: T, root: RootStore, type: string, props: Instance<T>['props']): Instance<T>;
3515
3594
  /**
3516
3595
  * Triggers an update for an instance.
3517
- * Calls onUpdate callback and invalidates the frame if necessary.
3596
+ * Invalidates the frame if the root is in demand mode.
3518
3597
  *
3519
3598
  * @param instance - Instance to invalidate
3520
3599
  */
@@ -3680,29 +3759,44 @@ declare const hasConstructor: (object: unknown) => object is {
3680
3759
  * Used to identify values that should be resolved from refs after mount.
3681
3760
  */
3682
3761
  declare const FROM_REF: unique symbol;
3762
+ /** The marker `fromRef()` returns; resolved by the reconciler in `commitMount`. */
3763
+ interface FromRefMarker<T = unknown, R = T> {
3764
+ [FROM_REF]: React$1.RefObject<T | null>;
3765
+ /** Optional transform applied to the resolved ref before assignment. */
3766
+ transform?: (value: T) => R;
3767
+ }
3683
3768
  /**
3684
3769
  * Defers prop application until the referenced object is available.
3685
3770
  * Useful for props like `target` that need sibling refs to be populated.
3686
3771
  *
3772
+ * Only top-level props on a three element are resolved: a marker nested inside another value
3773
+ * (an array, an options object) is never seen. When the prop needs the sibling *wrapped* rather
3774
+ * than assigned as-is, pass a `transform`; it runs once the ref is populated and its result is
3775
+ * what gets assigned.
3776
+ *
3687
3777
  * @param ref - React ref object to resolve at mount time
3688
- * @returns A marker value that applyProps will resolve after mount
3778
+ * @param transform - Optional mapping from the resolved object to the value the prop expects
3779
+ * @returns A marker value that the reconciler resolves after mount
3689
3780
  *
3690
3781
  * @example
3691
3782
  * const targetRef = useRef<THREE.Object3D>(null)
3692
3783
  *
3693
3784
  * <group ref={targetRef} position={[-3, -2, -15]} />
3694
3785
  * <spotLight target={fromRef(targetRef)} intensity={100} />
3786
+ *
3787
+ * @example
3788
+ * // Wrap the sibling: a node material's lightsNode needs a LightsNode, not the light itself
3789
+ * <meshPhongNodeMaterial lightsNode={fromRef(lightRef, (light) => lights([light]))} />
3695
3790
  */
3696
3791
  declare function fromRef<T>(ref: React$1.RefObject<T | null>): T;
3792
+ declare function fromRef<T, R>(ref: React$1.RefObject<T | null>, transform: (value: T) => R): R;
3697
3793
  /**
3698
3794
  * Type guard to check if a value is a fromRef marker.
3699
3795
  *
3700
3796
  * @param value - Value to check
3701
3797
  * @returns True if value is a fromRef marker
3702
3798
  */
3703
- declare function isFromRef(value: unknown): value is {
3704
- [FROM_REF]: React$1.RefObject<any>;
3705
- };
3799
+ declare function isFromRef(value: unknown): value is FromRefMarker<any, unknown>;
3706
3800
 
3707
3801
  /**
3708
3802
  * Symbol marker for mount-only method calls.
@@ -3729,7 +3823,15 @@ declare const ONCE: unique symbol;
3729
3823
  * // No arguments
3730
3824
  * <geometry center={once()} />
3731
3825
  */
3732
- declare function once<T>(...args: T[]): T;
3826
+ declare function once<A extends unknown[]>(...args: A): OnceValue<A>;
3827
+ /**
3828
+ * What `once(...args)` is typed as, so the marker is assignable to the prop it targets:
3829
+ * the single argument itself (`rotateX={once(angle)}`), the argument tuple for multi-argument
3830
+ * methods (`translate={once(x, y, z)}`), or `true` for a bare call (`center={once()}`).
3831
+ *
3832
+ * The runtime value is always the marker object; only the declared type follows the prop.
3833
+ */
3834
+ type OnceValue<A extends unknown[]> = A extends [] ? true : A extends [infer Single] ? Single : A;
3733
3835
  /**
3734
3836
  * Type guard to check if a value is a once marker.
3735
3837
  *
@@ -3741,10 +3843,31 @@ declare function isOnce(value: unknown): value is {
3741
3843
  };
3742
3844
 
3743
3845
  /**
3744
- * A DOM canvas which accepts threejs elements as children.
3745
- * @see https://docs.pmnd.rs/react-three-fiber/api/canvas
3846
+ * @fileoverview Legacy entry point - WebGL only
3847
+ *
3848
+ * This entry point is for apps that want to use the legacy WebGLRenderer.
3849
+ * No WebGPU features are available from this import path.
3850
+ * Auto-extends THREE with WebGL-only constructors (no node materials).
3851
+ *
3852
+ * Usage:
3853
+ * import { Canvas, useFrame } from '@react-three/fiber/legacy'
3746
3854
  */
3747
- declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
3748
3855
 
3749
- export { Block, Canvas, Environment, EnvironmentCube, EnvironmentMap, EnvironmentPortal, ErrorBoundary, FROM_REF, IsObject, ONCE, Portal, R3F_BUILD_LEGACY, R3F_BUILD_WEBGPU, REACT_INTERNAL_PROPS, RESERVED_PROPS, three_d as ReactThreeFiber, Texture, _roots, addAfterEffect, addEffect, addTail, advance, applyProps, attach, buildGraph, calculateDpr, context, createEvents, createPointerEvents, createPortal, createRoot, createStore, detach, diffProps, dispose, createPointerEvents as events, extend, findInitialRoot, flushSync, fromRef, getInstanceProps, getPrimary, getPrimaryIds, getRootState, getUuidPrefix, hasConstructor, hasPrimary, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isFromRef, isObject3D, isOnce, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, once, prepare, presetsObj, reconciler, registerPrimary, removeInteractivity, resolve, swapInteractivity, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useMutableCallback, useRenderTarget, useStore, useTexture, useTextures, useThree, waitForPrimary };
3750
- export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferLike, BufferRecord, BufferStore, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DisposeOptions, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, LegacyInternalState as InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeProps, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, LegacyRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, LegacyRootState as RootState, RootStore, SetBlock, Size, StorageLike, StorageRecord, StorageStore, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };
3856
+ /** `useThree` narrowed to legacy state — `state.renderer` is a `WebGLRenderer`. */
3857
+ type UseThreeLegacy = <T = LegacyRootState>(selector?: (state: LegacyRootState) => T, equalityFn?: <U>(state: U, newState: U) => boolean) => T;
3858
+ /** `useFrame` narrowed to legacy state — the callback's `state.renderer` is a `WebGLRenderer`. */
3859
+ type UseFrameLegacy = (callback?: FrameCallback$1<LegacyRootState>, priorityOrOptions?: number | UseFrameNextOptions) => FrameNextControls;
3860
+ declare const useThree: UseThreeLegacy;
3861
+ declare const useFrame: UseFrameLegacy;
3862
+
3863
+ /** Canvas props on the legacy entry: `onCreated` receives `LegacyRootState`. */
3864
+ type LegacyCanvasProps = Omit<CanvasProps, 'onCreated'> & {
3865
+ /** Callback after the canvas has rendered (but not yet committed); `state.renderer` is a `WebGLRenderer` */
3866
+ onCreated?: (state: LegacyRootState) => void;
3867
+ };
3868
+
3869
+ /** `Canvas` narrowed to legacy state — the same component, `onCreated` typed against `LegacyRootState`. */
3870
+ declare const Canvas: (props: LegacyCanvasProps) => JSX.Element;
3871
+
3872
+ export { Block, Canvas, Environment, EnvironmentCube, EnvironmentMap, EnvironmentPortal, ErrorBoundary, FROM_REF, IsObject, ONCE, Portal, R3F_BUILD_LEGACY, R3F_BUILD_WEBGPU, REACT_INTERNAL_PROPS, RESERVED_PROPS, three_d as ReactThreeFiber, Texture, _roots, addAfterEffect, addEffect, addTail, advance, applyProps, attach, buildGraph, calculateDpr, context, createEvents, createPointerEvents, createPortal, createRoot, createStore, detach, diffProps, dispose, createPointerEvents as events, extend, findInitialRoot, flushSync, fromRef, getInstanceProps, getPrimary, getPrimaryIds, getRootState, getUuidPrefix, hasConstructor, hasPrimary, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isFromRef, isObject3D, isOnce, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, once, prepare, presetsObj, reconciler, registerPrimary, registerRootExtension, removeInteractivity, resolve, setRenderOverride, swapInteractivity, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useMutableCallback, useRenderTarget, useStore, useTexture, useTextures, useThree, waitForPrimary };
3873
+ export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferLike, BufferRecord, BufferStore, Camera, CameraProps, LegacyCanvasProps as CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DisposeOptions, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, FromRefMarker, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, LegacyInternalState as InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyCanvasProps, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeLike, NodeProps, NodeRecord, NodeStore, NonFunctionKeys, Object3DMethod, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, OnceValue, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, LegacyRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootExtension, LegacyRootState as RootState, RootStore, SetBlock, Size, StorageLike, StorageRecord, StorageStore, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseFrameLegacy, UseTextureOptions, UseTexturesReturn, UseThreeLegacy, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };