@react-three/fiber 10.0.0-canary.ce4bd5f → 10.0.0-canary.d91831d

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -1,6 +1,6 @@
1
1
  import * as three_examples_jsm_inspector_Inspector_js from 'three/examples/jsm/inspector/Inspector.js';
2
2
  import * as three_webgpu from 'three/webgpu';
3
- import { CubeRenderTarget, RenderTarget, WebGPURenderer, Node, StorageTexture, Data3DTexture, CanvasTarget, ShaderNodeObject, Euler as Euler$2, Color as Color$2, ColorRepresentation as ColorRepresentation$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, Loader as Loader$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Object3D, Frustum, OrthographicCamera } from 'three/webgpu';
3
+ import { CubeRenderTarget, RenderTarget, WebGPURenderer, Node, StorageTexture, Storage3DTexture, StorageArrayTexture, Data3DTexture, CanvasTarget, 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, Object3D, 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, Frustum, OrthographicCamera } from 'three/webgpu';
4
4
  import * as THREE$1 from 'three';
5
5
  import { WebGLCubeRenderTarget, WebGLRenderTarget, WebGLRenderer, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1 } from 'three';
6
6
  import { WebGLRendererParameters } from 'three/src/renderers/WebGLRenderer.js';
@@ -352,6 +352,7 @@ type BufferLike =
352
352
  | Uint16Array
353
353
  | Int16Array
354
354
  | THREE$1.BufferAttribute // Base class for all buffer attributes
355
+ | THREE$1.InterleavedBufferAttribute
355
356
  | Node // TSL buffer nodes (instancedArray, storage)
356
357
 
357
358
  /** Flat record of buffer-like values (no nested scopes) */
@@ -363,6 +364,25 @@ type BufferRecord = Record<string, BufferLike>
363
364
  */
364
365
  type BufferStore = Record<string, BufferLike | BufferRecord>
365
366
 
367
+ //* Node Types (useNodes) ========================================
368
+
369
+ /**
370
+ * Every node representation `useNodes` accepts and `state.nodes` holds: three's real `Node`,
371
+ * the callable proxy `Fn()` returns, and the legacy structural shape (`uuid`/`nodeType`) older
372
+ * code passes through. Creators are constrained to this same type, so the shape a creator returns
373
+ * and the shape the store holds are one type by construction.
374
+ */
375
+ type NodeLike = TSLNodeType | LegacyTSLNodeLike
376
+
377
+ /** Flat record of TSL nodes (no nested scopes) */
378
+ type NodeRecord<T extends NodeLike = NodeLike> = Record<string, T>
379
+
380
+ /**
381
+ * Node store that can contain both root-level nodes and scoped node objects.
382
+ * Structure: { wobble: OperatorNode, fx: { blur: ShaderCallable } }
383
+ */
384
+ type NodeStore = Record<string, NodeLike | NodeRecord>
385
+
366
386
  //* Storage Types (useGPUStorage) ========================================
367
387
 
368
388
  /**
@@ -377,7 +397,9 @@ type BufferStore = Record<string, BufferLike | BufferRecord>
377
397
  * ```
378
398
  */
379
399
  type StorageLike =
380
- | StorageTexture // GPU storage texture
400
+ | StorageTexture // 2D GPU storage texture
401
+ | Storage3DTexture // 3D GPU storage texture (volumes, fluid grids)
402
+ | StorageArrayTexture // 2D-array GPU storage texture
381
403
  | Data3DTexture // 3D texture (can be used as storage)
382
404
  | Node // TSL storage texture nodes (storageTexture)
383
405
 
@@ -496,8 +518,13 @@ interface InternalState {
496
518
  /** Container for child attachment (scene for root, original container for portals) */
497
519
  container?: THREE$1.Object3D
498
520
  /**
499
- * CanvasTarget for multi-canvas WebGPU rendering.
500
- * Created for all WebGPU canvases to support renderer sharing.
521
+ * The CanvasTarget this root sizes and renders through.
522
+ *
523
+ * A primary (`<Canvas id>`) owns the renderer's default target -- the one three itself built
524
+ * around the canvas element -- so sizing it is sizing the renderer. A secondary owns a target
525
+ * R3F created for its own element. Either way there is exactly one target per canvas element,
526
+ * and the canvas-target job makes it the renderer's active one before this root renders.
527
+ * Absent on WebGL and on an id-less WebGPU canvas, where the renderer is sized directly.
501
528
  * @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
502
529
  */
503
530
  canvasTarget?: CanvasTarget
@@ -622,7 +649,7 @@ interface RootState {
622
649
  /** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
623
650
  uniforms: UniformStore
624
651
  /** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
625
- nodes: Record<string, any>
652
+ nodes: NodeStore
626
653
  /** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
627
654
  buffers: BufferStore
628
655
  /** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
@@ -634,7 +661,7 @@ interface RootState {
634
661
  /** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
635
662
  renderPipeline: ThreeRenderPipeline | null
636
663
  /** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
637
- passes: Record<string, any>
664
+ passes: PassRecord
638
665
  /** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
639
666
  _hmrVersion: number
640
667
  /** Internal: whether setSize() has taken ownership of canvas dimensions */
@@ -821,14 +848,17 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
821
848
  performance?: Partial<Omit<Performance, 'regress'>>
822
849
  /** Target pixel ratio. Can clamp between a range: `[min, max]` */
823
850
  dpr?: Dpr
824
- /** Props that go into the default raycaster */
825
- raycaster?: Partial<THREE$1.Raycaster>
851
+ /**
852
+ * Props that go into the default raycaster. `params` is merged into the raycaster's defaults,
853
+ * so a single threshold can be set: `raycaster={{ params: { Points: { threshold: 0.2 } } }}`.
854
+ */
855
+ raycaster?: Partial<Omit<THREE$1.Raycaster, 'params'>> & { params?: Partial<THREE$1.RaycasterParameters> }
826
856
  /** A `THREE.Scene` instance or props that go into the default scene */
827
857
  scene?: THREE$1.Scene | Partial<THREE$1.Scene>
828
858
  /** A `THREE.Camera` instance or props that go into the default camera */
829
859
  camera?: CameraProps
830
860
  /** An R3F event manager to manage elements' pointer events */
831
- events?: (store: RootStore) => EventManager<HTMLElement>
861
+ events?: (store: RootStore) => EventManager<Element>
832
862
  /** Callback after the canvas has rendered (but not yet committed) */
833
863
  onCreated?: (state: RootState) => void
834
864
  /** Response for pointer clicks that have missed any target */
@@ -1057,7 +1087,7 @@ interface CanvasProps
1057
1087
  */
1058
1088
  resize?: Options
1059
1089
  /** The target where events are being subscribed to, default: the div that wraps canvas */
1060
- eventSource?: HTMLElement | React$1.RefObject<HTMLElement | null>
1090
+ eventSource?: Element | React$1.RefObject<Element | null>
1061
1091
  /** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
1062
1092
  eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
1063
1093
  /** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
@@ -1165,81 +1195,86 @@ interface LegacyRootState extends Omit<RootState, 'renderer' | 'internal'> {
1165
1195
 
1166
1196
  type RenderTargetOptions = RenderTargetOptions$1
1167
1197
 
1168
- //* Global Types ==============================
1198
+ //* Global TSL Types ==============================
1169
1199
 
1170
1200
  declare global {
1171
1201
  /**
1172
- * Uniform node type.
1173
- *
1174
- * This is three's own `UniformNode`, not a re-declaration of it. It previously was a
1175
- * hand-rolled `interface UniformNode<T> extends Node { value: T }`, which shadowed the real
1176
- * exported type globally — so R3F's ~58 references resolved to an approximation that was
1177
- * missing members three actually ships (`setName` among them) and had drifted to the wrong
1178
- * arity when three made `UniformNode` two-parameter.
1179
- *
1180
- * three's signature is `UniformNode<TNodeType, TValue>`. R3F only ever varies the value type,
1181
- * so the node type is fixed to `unknown` and the single parameter is kept for call-site
1182
- * ergonomics. The result is three's structural type, so members stay in sync with the
1183
- * installed three instead of needing to be mirrored by hand.
1202
+ * Broad callable-node fallback for dynamic store readers.
1203
+ * Creator hooks preserve the exact function signatures inferred from Three's `Fn`.
1184
1204
  */
1185
- type UniformNode<T = unknown> = three_webgpu.UniformNode<unknown, T>
1205
+ type CallableTSLNode = ((...params: never[]) => unknown) & {
1206
+ readonly shaderNode: unknown
1207
+ readonly id: number
1208
+ }
1186
1209
 
1187
- /**
1188
- * ShaderCallable - the return type of Fn()
1189
- * A callable shader function node that can be invoked with parameters.
1190
- * The function returns a ShaderNodeObject when called.
1191
- *
1192
- * @example
1193
- * ```tsx
1194
- * // Define a shader function
1195
- * const blendColorFn = Fn(([color1, color2, factor]) => {
1196
- * return mix(color1, color2, factor)
1197
- * })
1198
- *
1199
- * // Type when retrieving from nodes store
1200
- * const { blendColorFn } = nodes as { blendColorFn: ShaderCallable }
1201
- *
1202
- * // Or with specific return type
1203
- * const { myFn } = nodes as { myFn: ShaderCallable<THREE.Node> }
1204
- * ```
1205
- */
1206
- type ShaderCallable<R extends Node = Node> = ((...params: unknown[]) => ShaderNodeObject<R>) & Node
1210
+ /** Legacy structural node accepted when at least one historical marker exists. */
1211
+ type LegacyTSLNodeLike = {
1212
+ label?: ((label: string) => unknown) | string
1213
+ setName?: (name: string) => unknown
1214
+ } & ({ uuid: string | undefined; nodeType?: string | null } | { uuid?: string; nodeType: string | null | undefined })
1207
1215
 
1208
- /**
1209
- * ShaderNodeRef - a ShaderNodeObject wrapper around a Node
1210
- * This is the common return type for TSL operations (add, mul, sin, etc.)
1211
- *
1212
- * @example
1213
- * ```tsx
1214
- * const { wobble } = nodes as { wobble: ShaderNodeRef }
1215
- * ```
1216
- */
1217
- type ShaderNodeRef<T extends Node = Node> = ShaderNodeObject<T>
1216
+ /** Node type accepted by broad dynamic node-store readers. */
1217
+ type TSLNodeType = three_webgpu.Node | CallableTSLNode
1218
1218
 
1219
1219
  /**
1220
- * TSLNodeType - Union of all common TSL node types
1221
- * Used by ScopedStore to properly type node access from the store.
1222
- *
1223
- * Includes:
1224
- * - Node: base Three.js node type
1225
- * - ShaderCallable: function nodes created with Fn()
1226
- * - ShaderNodeObject: wrapped nodes from TSL operations (sin, mul, mix, etc.)
1227
- *
1228
- * @example
1229
- * ```tsx
1230
- * // In useLocalNodes, nodes are typed as TSLNodeType
1231
- * const { positionNode, blendColorFn } = useLocalNodes(({ nodes }) => ({
1232
- * positionNode: nodes.myPosition, // Works - Node is in union
1233
- * blendColorFn: nodes.myFn, // Works - ShaderCallable is in union
1234
- * }))
1235
- *
1236
- * // Can narrow with type guard or assertion when needed
1237
- * if (typeof blendColorFn === 'function') {
1238
- * blendColorFn(someColor, 0.5)
1239
- * }
1240
- * ```
1220
+ * Derive Three's shader node type from an existing node or a supported raw input.
1221
+ * Existing InputNode generics take precedence over structural value normalization.
1222
+ * Both generics must be inferred because Three's UniformNode intersects an unknown-typed
1223
+ * InputNode base with its concrete InputNode specialization.
1241
1224
  */
1242
- type TSLNodeType = Node | ShaderCallable<Node> | ShaderNodeObject<Node>
1225
+ type UniformNodeType<T> = T extends three_webgpu.UniformNode<infer TNodeType, infer _TValue>
1226
+ ? TNodeType
1227
+ : T extends three_webgpu.InputNode<infer TNodeType, infer _TValue>
1228
+ ? TNodeType
1229
+ : T extends number
1230
+ ? 'float'
1231
+ : T extends boolean
1232
+ ? 'bool'
1233
+ : T extends string | three_webgpu.Color | { r: number; g: number; b: number }
1234
+ ? 'color'
1235
+ : T extends three_webgpu.Vector4 | { x: number; y: number; z: number; w: number }
1236
+ ? 'vec4'
1237
+ : T extends three_webgpu.Vector3 | { x: number; y: number; z: number }
1238
+ ? 'vec3'
1239
+ : T extends three_webgpu.Vector2 | { x: number; y: number }
1240
+ ? 'vec2'
1241
+ : T extends three_webgpu.Matrix4
1242
+ ? 'mat4'
1243
+ : T extends three_webgpu.Matrix3
1244
+ ? 'mat3'
1245
+ : T extends three_webgpu.Matrix2
1246
+ ? 'mat2'
1247
+ : unknown
1248
+
1249
+ /** Derive the normalized JavaScript value stored by a uniform node. */
1250
+ type UniformNodeValue<T> = T extends three_webgpu.UniformNode<infer _TNodeType, infer TValue>
1251
+ ? TValue
1252
+ : T extends three_webgpu.InputNode<infer _TNodeType, infer TValue>
1253
+ ? TValue
1254
+ : T extends string | { r: number; g: number; b: number }
1255
+ ? three_webgpu.Color
1256
+ : T extends { x: number; y: number; z: number; w: number }
1257
+ ? three_webgpu.Vector4
1258
+ : T extends { x: number; y: number; z: number }
1259
+ ? three_webgpu.Vector3
1260
+ : T extends { x: number; y: number }
1261
+ ? three_webgpu.Vector2
1262
+ : T extends number
1263
+ ? number
1264
+ : T extends boolean
1265
+ ? boolean
1266
+ : T
1267
+
1268
+ /** Three's exact UniformNode with shader and value generics derived from an input. */
1269
+ type UniformNodeFor<T> = three_webgpu.UniformNode<UniformNodeType<T>, UniformNodeValue<T>>
1270
+
1271
+ /** Preserve every input key while mapping values to exact Three uniform nodes. */
1272
+ type UniformNodesFor<T extends UniformInputRecord> = {
1273
+ [K in keyof T]: UniformNodeFor<T[K]>
1274
+ }
1275
+
1276
+ /** Backward-compatible single-parameter uniform alias. */
1277
+ type UniformNode<T = unknown> = UniformNodeFor<T>
1243
1278
 
1244
1279
  /** Flat record of uniform nodes (no nested scopes) */
1245
1280
  type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
@@ -1264,7 +1299,7 @@ declare global {
1264
1299
  * Acceptable input values for useUniforms - raw values that get converted to UniformNodes
1265
1300
  * Supports:
1266
1301
  * - Primitives: number, string (color), boolean
1267
- * - Three.js types: Color, Vector2/3/4, Matrix3/4, Euler, Quaternion
1302
+ * - Three.js types: Color, Vector2/3/4, Matrix2/3/4
1268
1303
  * - Plain objects: { x, y, z, w } converted to vectors
1269
1304
  * - TSL nodes: color(), vec3(), float() for type casting
1270
1305
  * - UniformNode: existing uniforms (reused as-is)
@@ -1277,93 +1312,124 @@ declare global {
1277
1312
  | three_webgpu.Vector2
1278
1313
  | three_webgpu.Vector3
1279
1314
  | three_webgpu.Vector4
1315
+ | three_webgpu.Matrix2
1280
1316
  | three_webgpu.Matrix3
1281
1317
  | three_webgpu.Matrix4
1282
- | three_webgpu.Euler
1283
- | three_webgpu.Quaternion
1284
- | { x: number; y?: number; z?: number; w?: number } // Plain objects converted to vectors
1318
+ | { x: number; y: number }
1319
+ | { x: number; y: number; z: number }
1320
+ | { x: number; y: number; z: number; w: number }
1285
1321
  | { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
1286
- | Node // TSL nodes like color(), vec3(), float() for type casting
1322
+ | three_webgpu.Node // TSL nodes like color(), vec3(), float() for type casting
1287
1323
  | UniformNode
1288
1324
 
1289
1325
  /** Input record for useUniforms - accepts raw values or UniformNodes */
1290
1326
  type UniformInputRecord = Record<string, UniformValue>
1291
1327
  }
1292
1328
 
1293
- //* Module Augmentation ==============================
1294
-
1295
- declare module 'three/tsl' {
1296
- /**
1297
- * Fn with array parameter destructuring
1298
- * @example Fn(([uv, skew]) => { ... })
1299
- */
1300
- export function Fn<R extends Node = Node>(
1301
- jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
1302
- ): ShaderCallable<R>
1303
-
1329
+ declare global {
1304
1330
  /**
1305
- * Fn with object parameter destructuring
1306
- * @example Fn(({ color, intensity }) => { ... })
1331
+ * three's own render pipeline type. Named here so the rest of R3F refers to three's shape
1332
+ * rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
1333
+ * is r185, so the new name is the only one.
1307
1334
  */
1308
- export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
1309
- jsFunc: (inputs: T) => ShaderNodeObject<R>,
1310
- ): ShaderCallable<R>
1335
+ type ThreeRenderPipeline = three_webgpu.RenderPipeline
1311
1336
 
1312
1337
  /**
1313
- * Fn with array params + layout
1314
- * @example Fn(([a, b]) => { ... }, { layout: [...] })
1338
+ * The pass `useRenderPipeline` creates for you: three's own `PassNode`, as returned by
1339
+ * `pass(scene, camera)` from `three/tsl`. Referenced from three so members like
1340
+ * `getTextureNode`, `setMRT` and `dispose` track the installed version.
1315
1341
  */
1316
- export function Fn<R extends Node = Node>(
1317
- jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
1318
- layout: { layout?: unknown },
1319
- ): ShaderCallable<R>
1342
+ type ScenePassNode = three_webgpu.PassNode
1320
1343
 
1321
1344
  /**
1322
- * Fn with object params + layout
1345
+ * Pass record - stores TSL pass nodes for render pipeline.
1346
+ *
1347
+ * `scenePass` is the only key the library owns. It is optional here because this is also the
1348
+ * shape of `state.passes`, which is `{}` before the pipeline exists and again after `reset()`
1349
+ * or `clearPasses()`. Inside the callbacks it is always present; see
1350
+ * {@link RenderPipelineCallbackState}.
1351
+ *
1352
+ * Every other key is user-registered, via a callback's return value. Those are TSL nodes of
1353
+ * any kind, not only passes: texture reads of an MRT attachment, effect nodes, extra
1354
+ * `pass()` instances. `Node` is the common base, so that is the bound. Narrow at the call
1355
+ * site when you need a member, e.g. `passes.velocity as TextureNode`.
1356
+ *
1357
+ * The index signature admits `undefined` because a key may simply not be registered, and
1358
+ * because the optional `scenePass` must be assignable to it: under `skipLibCheck: false` an
1359
+ * optional property whose type excludes `undefined` from the index signature is an error
1360
+ * (TS2411) for every consumer compiling these declarations.
1323
1361
  */
1324
- export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
1325
- jsFunc: (inputs: T) => ShaderNodeObject<R>,
1326
- layout: { layout?: unknown },
1327
- ): ShaderCallable<R>
1328
- }
1362
+ interface PassRecord {
1363
+ scenePass?: ScenePassNode
1364
+ [key: string]: three_webgpu.Node | undefined
1365
+ }
1329
1366
 
1330
- declare global {
1331
1367
  /**
1332
- * three's own render pipeline type. Named here so the rest of R3F refers to three's shape
1333
- * rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
1334
- * is r185, so the new name is the only one.
1368
+ * State passed to pipeline callbacks after the active pipeline has been created.
1369
+ *
1370
+ * `passes.scenePass` is required here: the hook installs the default scene pass before either
1371
+ * callback runs, so callbacks can use it without a guard or a cast.
1372
+ *
1373
+ * `renderer` is narrowed to `WebGPURenderer` and `isLegacy` to `false`: the hook throws under
1374
+ * the legacy renderer before either callback can run, so a callback never sees WebGL.
1335
1375
  */
1336
- type ThreeRenderPipeline = three_webgpu.RenderPipeline
1337
-
1338
- /** Pass record - stores TSL pass nodes for render pipeline */
1339
- type PassRecord = Record<string, any>
1340
-
1341
- /** State passed to pipeline callbacks after the active pipeline has been created */
1342
1376
  type RenderPipelineCallbackState = RootState & {
1343
1377
  renderPipeline: ThreeRenderPipeline
1378
+ passes: PassRecord & { scenePass: ScenePassNode }
1379
+ renderer: three_webgpu.WebGPURenderer
1380
+ isLegacy: false
1344
1381
  }
1345
1382
 
1383
+ /**
1384
+ * What a callback may return to register entries into `state.passes`.
1385
+ *
1386
+ * `scenePass` is reserved. The hook owns that entry and its lifecycle: it caches the pass it
1387
+ * created, and `rebuild()` / `reset()` dispose that cached pass. A callback overwriting the
1388
+ * store entry would leave the store pointing at a node the hook never disposes, and the hook
1389
+ * disposing a pass nothing references. So returning it is a type error.
1390
+ */
1391
+ type RegisteredPasses = Record<string, three_webgpu.Node> & { scenePass?: never }
1392
+
1346
1393
  /** Setup callback - runs first to configure MRT, create additional passes */
1347
- type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => PassRecord | void
1394
+ type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
1348
1395
 
1349
1396
  /** Main callback - runs second to configure outputNode, create effect passes */
1350
- type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => PassRecord | void
1397
+ type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
1351
1398
 
1352
- /** Return type for useRenderPipeline hook */
1353
- interface UseRenderPipelineReturn {
1399
+ /** The imperative half of useRenderPipeline's return value, present in every state */
1400
+ interface UseRenderPipelineActions {
1354
1401
  /** Current passes from state */
1355
1402
  passes: PassRecord
1356
- /** RenderPipeline instance (null if not initialized) */
1357
- renderPipeline: ThreeRenderPipeline | null
1358
1403
  /** Clear all passes from state */
1359
1404
  clearPasses: () => void
1360
1405
  /** Reset RenderPipeline entirely (clears PP + passes) */
1361
1406
  reset: () => void
1362
1407
  /** Re-run setup/main callbacks with current closure values */
1363
1408
  rebuild: () => void
1364
- /** True when RenderPipeline is configured and ready */
1365
- isReady: boolean
1366
1409
  }
1410
+
1411
+ /**
1412
+ * Return type for useRenderPipeline hook, discriminated on `isReady`.
1413
+ *
1414
+ * `if (isReady)` narrows `renderPipeline` to non-null, which is what the docs already tell
1415
+ * callers to check. `passes.scenePass` deliberately stays optional in the ready branch:
1416
+ * `clearPasses()` empties the record while leaving the pipeline in place.
1417
+ */
1418
+ type UseRenderPipelineReturn = UseRenderPipelineActions &
1419
+ (
1420
+ | {
1421
+ /** True when RenderPipeline is configured and ready */
1422
+ isReady: true
1423
+ /** RenderPipeline instance */
1424
+ renderPipeline: ThreeRenderPipeline
1425
+ }
1426
+ | {
1427
+ /** False until the pipeline has been created */
1428
+ isReady: false
1429
+ /** Not initialized yet, or torn down by reset() */
1430
+ renderPipeline: null
1431
+ }
1432
+ )
1367
1433
  }
1368
1434
 
1369
1435
  type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
@@ -1442,10 +1508,11 @@ type TSLNodeInput = { nodeType?: string | null; uuid?: string } | null
1442
1508
 
1443
1509
  /**
1444
1510
  * For node material properties (colorNode, positionNode, etc.), accept broader types
1445
- * since @types/three has broken inheritance for TSL node subclasses.
1511
+ * since @types/three has broken inheritance for TSL node subclasses. NodeClass requires
1512
+ * `nodeType`, so this structural key test remains neutral to the selected Three entry.
1446
1513
  */
1447
1514
  type NodeProps<P> = {
1448
- [K in keyof P as P[K] extends Node | null ? K : never]?: TSLNodeInput
1515
+ [K in keyof P as NonNullable<P[K]> extends { nodeType: string | null } ? K : never]?: TSLNodeInput
1449
1516
  }
1450
1517
 
1451
1518
  interface ReactProps<P> {
@@ -1466,11 +1533,30 @@ type ThreeToJSXElements<T extends Record<string, any>> = {
1466
1533
  [K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
1467
1534
  }
1468
1535
 
1536
+ /** Method names of Object3D, excluded from the `primitive` element's typed props. */
1537
+ type Object3DMethod = NonNullable<
1538
+ {
1539
+ [K in keyof Object3D]-?: Object3D[K] extends (...args: any[]) => any ? K : never
1540
+ }[keyof Object3D]
1541
+ >
1542
+
1469
1543
  type ThreeExports = typeof THREE
1470
1544
  type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
1471
1545
 
1472
1546
  interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
1473
- primitive: Omit<ThreeElement<any>, 'args'> & { object: object }
1547
+ /**
1548
+ * `primitive` wraps a pre-existing object, so its props cannot be derived from one class.
1549
+ * Events are typed from `EventHandlers` (`onClick={(e) => ...}` infers `e`), the ref is
1550
+ * untyped, and any other prop is accepted and applied to the object by name. Object3D's own
1551
+ * methods are left out of the typed surface: they return `this`, so a subclass element's
1552
+ * props (`ThreeElements['group']`) could not be spread onto a primitive otherwise.
1553
+ */
1554
+ primitive: Omit<ThreeElement<typeof Object3D>, 'args' | 'object' | 'ref' | 'onUpdate' | Object3DMethod> & {
1555
+ object: object
1556
+ ref?: React.Ref<any>
1557
+ onUpdate?: (self: any) => void
1558
+ [prop: string]: unknown
1559
+ }
1474
1560
  // Conflicts with DOM types can be accessed through a three* prefix
1475
1561
  threeAudio: ThreeElementsImpl['audio']
1476
1562
  threeSource: ThreeElementsImpl['source']
@@ -1511,6 +1597,7 @@ type three_d_Matrix3 = Matrix3;
1511
1597
  type three_d_Matrix4 = Matrix4;
1512
1598
  type three_d_MutableOrReadonlyParameters<T extends (...args: any) => any> = MutableOrReadonlyParameters<T>;
1513
1599
  type three_d_NodeProps<P> = NodeProps<P>;
1600
+ type three_d_Object3DMethod = Object3DMethod;
1514
1601
  type three_d_Quaternion = Quaternion;
1515
1602
  type three_d_RaycastableRepresentation = RaycastableRepresentation;
1516
1603
  type three_d_ReactProps<P> = ReactProps<P>;
@@ -1525,7 +1612,7 @@ type three_d_Vector3 = Vector3;
1525
1612
  type three_d_Vector4 = Vector4;
1526
1613
  type three_d_VectorRepresentation = VectorRepresentation;
1527
1614
  declare namespace three_d {
1528
- 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 };
1615
+ 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 };
1529
1616
  }
1530
1617
 
1531
1618
  /**
@@ -1874,7 +1961,7 @@ declare function createEvents(store: RootStore): {
1874
1961
  processDeferredPointer: (event: DomEvent, pointerId: number) => void;
1875
1962
  };
1876
1963
  /** Default R3F event manager for web */
1877
- declare function createPointerEvents(store: RootStore): EventManager<HTMLElement>;
1964
+ declare function createPointerEvents(store: RootStore): EventManager<Element>;
1878
1965
 
1879
1966
  /**
1880
1967
  * Gets or creates a memoized loader instance from a loader constructor or returns the loader if it's already an instance.
@@ -3271,6 +3358,7 @@ declare namespace ReactReconciler {
3271
3358
 
3272
3359
  declare function extend<T extends ConstructorRepresentation>(objects: T): React$1.ExoticComponent<ThreeElement<T>>;
3273
3360
  declare function extend<T extends Catalogue>(objects: T): void;
3361
+ declare function extend(objects: Record<string, unknown>): void;
3274
3362
  declare const reconciler: ReactReconciler.Reconciler<RootStore, Instance<any>, void, Instance<any>, never, any>;
3275
3363
 
3276
3364
  declare const isRenderer: (def: any) => boolean;
@@ -3714,29 +3802,44 @@ declare const hasConstructor: (object: unknown) => object is {
3714
3802
  * Used to identify values that should be resolved from refs after mount.
3715
3803
  */
3716
3804
  declare const FROM_REF: unique symbol;
3805
+ /** The marker `fromRef()` returns; resolved by the reconciler in `commitMount`. */
3806
+ interface FromRefMarker<T = unknown, R = T> {
3807
+ [FROM_REF]: React$1.RefObject<T | null>;
3808
+ /** Optional transform applied to the resolved ref before assignment. */
3809
+ transform?: (value: T) => R;
3810
+ }
3717
3811
  /**
3718
3812
  * Defers prop application until the referenced object is available.
3719
3813
  * Useful for props like `target` that need sibling refs to be populated.
3720
3814
  *
3815
+ * Only top-level props on a three element are resolved: a marker nested inside another value
3816
+ * (an array, an options object) is never seen. When the prop needs the sibling *wrapped* rather
3817
+ * than assigned as-is, pass a `transform`; it runs once the ref is populated and its result is
3818
+ * what gets assigned.
3819
+ *
3721
3820
  * @param ref - React ref object to resolve at mount time
3722
- * @returns A marker value that applyProps will resolve after mount
3821
+ * @param transform - Optional mapping from the resolved object to the value the prop expects
3822
+ * @returns A marker value that the reconciler resolves after mount
3723
3823
  *
3724
3824
  * @example
3725
3825
  * const targetRef = useRef<THREE.Object3D>(null)
3726
3826
  *
3727
3827
  * <group ref={targetRef} position={[-3, -2, -15]} />
3728
3828
  * <spotLight target={fromRef(targetRef)} intensity={100} />
3829
+ *
3830
+ * @example
3831
+ * // Wrap the sibling: a node material's lightsNode needs a LightsNode, not the light itself
3832
+ * <meshPhongNodeMaterial lightsNode={fromRef(lightRef, (light) => lights([light]))} />
3729
3833
  */
3730
3834
  declare function fromRef<T>(ref: React$1.RefObject<T | null>): T;
3835
+ declare function fromRef<T, R>(ref: React$1.RefObject<T | null>, transform: (value: T) => R): R;
3731
3836
  /**
3732
3837
  * Type guard to check if a value is a fromRef marker.
3733
3838
  *
3734
3839
  * @param value - Value to check
3735
3840
  * @returns True if value is a fromRef marker
3736
3841
  */
3737
- declare function isFromRef(value: unknown): value is {
3738
- [FROM_REF]: React$1.RefObject<any>;
3739
- };
3842
+ declare function isFromRef(value: unknown): value is FromRefMarker<any, unknown>;
3740
3843
 
3741
3844
  /**
3742
3845
  * Symbol marker for mount-only method calls.
@@ -3763,7 +3866,15 @@ declare const ONCE: unique symbol;
3763
3866
  * // No arguments
3764
3867
  * <geometry center={once()} />
3765
3868
  */
3766
- declare function once<T>(...args: T[]): T;
3869
+ declare function once<A extends unknown[]>(...args: A): OnceValue<A>;
3870
+ /**
3871
+ * What `once(...args)` is typed as, so the marker is assignable to the prop it targets:
3872
+ * the single argument itself (`rotateX={once(angle)}`), the argument tuple for multi-argument
3873
+ * methods (`translate={once(x, y, z)}`), or `true` for a bare call (`center={once()}`).
3874
+ *
3875
+ * The runtime value is always the marker object; only the declared type follows the prop.
3876
+ */
3877
+ type OnceValue<A extends unknown[]> = A extends [] ? true : A extends [infer Single] ? Single : A;
3767
3878
  /**
3768
3879
  * Type guard to check if a value is a once marker.
3769
3880
  *
@@ -3781,4 +3892,4 @@ declare function isOnce(value: unknown): value is {
3781
3892
  declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
3782
3893
 
3783
3894
  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 };
3784
- export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferLike, BufferRecord, BufferStore, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DisposeOptions, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeProps, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootState, RootStore, SetBlock, Size, StorageLike, StorageRecord, StorageStore, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };
3895
+ 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, FromRefMarker, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeLike, NodeProps, NodeRecord, NodeStore, NonFunctionKeys, Object3DMethod, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, OnceValue, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootState, RootStore, SetBlock, Size, StorageLike, StorageRecord, StorageStore, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };