@react-three/fiber 10.0.0-alpha.4 → 10.0.0-alpha.5
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.cjs +47 -48
- package/dist/index.d.cts +249 -138
- package/dist/index.d.mts +249 -138
- package/dist/index.d.ts +249 -166
- package/dist/index.mjs +47 -48
- package/dist/legacy.cjs +46 -46
- package/dist/legacy.d.cts +253 -142
- package/dist/legacy.d.mts +253 -142
- package/dist/legacy.d.ts +253 -168
- package/dist/legacy.mjs +46 -46
- package/dist/webgpu/index.cjs +117 -118
- package/dist/webgpu/index.d.cts +309 -201
- package/dist/webgpu/index.d.mts +309 -201
- package/dist/webgpu/index.d.ts +309 -229
- package/dist/webgpu/index.mjs +117 -118
- package/package.json +1 -1
package/dist/webgpu/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,
|
|
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, Matrix2, WebGPURendererParameters } from 'three/webgpu';
|
|
4
4
|
import { Inspector } from 'three/addons/inspector/Inspector.js';
|
|
5
5
|
import * as THREE$1 from 'three';
|
|
6
6
|
import { Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1 } from 'three';
|
|
@@ -354,6 +354,7 @@ type BufferLike =
|
|
|
354
354
|
| Uint16Array
|
|
355
355
|
| Int16Array
|
|
356
356
|
| THREE$1.BufferAttribute // Base class for all buffer attributes
|
|
357
|
+
| THREE$1.InterleavedBufferAttribute
|
|
357
358
|
| Node // TSL buffer nodes (instancedArray, storage)
|
|
358
359
|
|
|
359
360
|
/** Flat record of buffer-like values (no nested scopes) */
|
|
@@ -365,6 +366,25 @@ type BufferRecord = Record<string, BufferLike>
|
|
|
365
366
|
*/
|
|
366
367
|
type BufferStore = Record<string, BufferLike | BufferRecord>
|
|
367
368
|
|
|
369
|
+
//* Node Types (useNodes) ========================================
|
|
370
|
+
|
|
371
|
+
/**
|
|
372
|
+
* Every node representation `useNodes` accepts and `state.nodes` holds: three's real `Node`,
|
|
373
|
+
* the callable proxy `Fn()` returns, and the legacy structural shape (`uuid`/`nodeType`) older
|
|
374
|
+
* code passes through. Creators are constrained to this same type, so the shape a creator returns
|
|
375
|
+
* and the shape the store holds are one type by construction.
|
|
376
|
+
*/
|
|
377
|
+
type NodeLike = TSLNodeType | LegacyTSLNodeLike
|
|
378
|
+
|
|
379
|
+
/** Flat record of TSL nodes (no nested scopes) */
|
|
380
|
+
type NodeRecord<T extends NodeLike = NodeLike> = Record<string, T>
|
|
381
|
+
|
|
382
|
+
/**
|
|
383
|
+
* Node store that can contain both root-level nodes and scoped node objects.
|
|
384
|
+
* Structure: { wobble: OperatorNode, fx: { blur: ShaderCallable } }
|
|
385
|
+
*/
|
|
386
|
+
type NodeStore = Record<string, NodeLike | NodeRecord>
|
|
387
|
+
|
|
368
388
|
//* Storage Types (useGPUStorage) ========================================
|
|
369
389
|
|
|
370
390
|
/**
|
|
@@ -379,7 +399,9 @@ type BufferStore = Record<string, BufferLike | BufferRecord>
|
|
|
379
399
|
* ```
|
|
380
400
|
*/
|
|
381
401
|
type StorageLike =
|
|
382
|
-
| StorageTexture // GPU storage texture
|
|
402
|
+
| StorageTexture // 2D GPU storage texture
|
|
403
|
+
| Storage3DTexture // 3D GPU storage texture (volumes, fluid grids)
|
|
404
|
+
| StorageArrayTexture // 2D-array GPU storage texture
|
|
383
405
|
| Data3DTexture // 3D texture (can be used as storage)
|
|
384
406
|
| Node // TSL storage texture nodes (storageTexture)
|
|
385
407
|
|
|
@@ -498,8 +520,13 @@ interface InternalState {
|
|
|
498
520
|
/** Container for child attachment (scene for root, original container for portals) */
|
|
499
521
|
container?: THREE$1.Object3D
|
|
500
522
|
/**
|
|
501
|
-
* CanvasTarget
|
|
502
|
-
*
|
|
523
|
+
* The CanvasTarget this root sizes and renders through.
|
|
524
|
+
*
|
|
525
|
+
* A primary (`<Canvas id>`) owns the renderer's default target -- the one three itself built
|
|
526
|
+
* around the canvas element -- so sizing it is sizing the renderer. A secondary owns a target
|
|
527
|
+
* R3F created for its own element. Either way there is exactly one target per canvas element,
|
|
528
|
+
* and the canvas-target job makes it the renderer's active one before this root renders.
|
|
529
|
+
* Absent on WebGL and on an id-less WebGPU canvas, where the renderer is sized directly.
|
|
503
530
|
* @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
|
|
504
531
|
*/
|
|
505
532
|
canvasTarget?: CanvasTarget
|
|
@@ -624,7 +651,7 @@ interface RootState {
|
|
|
624
651
|
/** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
|
|
625
652
|
uniforms: UniformStore
|
|
626
653
|
/** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
|
|
627
|
-
nodes:
|
|
654
|
+
nodes: NodeStore
|
|
628
655
|
/** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
|
|
629
656
|
buffers: BufferStore
|
|
630
657
|
/** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
|
|
@@ -636,7 +663,7 @@ interface RootState {
|
|
|
636
663
|
/** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
|
|
637
664
|
renderPipeline: ThreeRenderPipeline | null
|
|
638
665
|
/** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
|
|
639
|
-
passes:
|
|
666
|
+
passes: PassRecord
|
|
640
667
|
/** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
|
|
641
668
|
_hmrVersion: number
|
|
642
669
|
/** Internal: whether setSize() has taken ownership of canvas dimensions */
|
|
@@ -823,14 +850,17 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
|
|
|
823
850
|
performance?: Partial<Omit<Performance, 'regress'>>
|
|
824
851
|
/** Target pixel ratio. Can clamp between a range: `[min, max]` */
|
|
825
852
|
dpr?: Dpr
|
|
826
|
-
/**
|
|
827
|
-
|
|
853
|
+
/**
|
|
854
|
+
* Props that go into the default raycaster. `params` is merged into the raycaster's defaults,
|
|
855
|
+
* so a single threshold can be set: `raycaster={{ params: { Points: { threshold: 0.2 } } }}`.
|
|
856
|
+
*/
|
|
857
|
+
raycaster?: Partial<Omit<THREE$1.Raycaster, 'params'>> & { params?: Partial<THREE$1.RaycasterParameters> }
|
|
828
858
|
/** A `THREE.Scene` instance or props that go into the default scene */
|
|
829
859
|
scene?: THREE$1.Scene | Partial<THREE$1.Scene>
|
|
830
860
|
/** A `THREE.Camera` instance or props that go into the default camera */
|
|
831
861
|
camera?: CameraProps
|
|
832
862
|
/** An R3F event manager to manage elements' pointer events */
|
|
833
|
-
events?: (store: RootStore) => EventManager<
|
|
863
|
+
events?: (store: RootStore) => EventManager<Element>
|
|
834
864
|
/** Callback after the canvas has rendered (but not yet committed) */
|
|
835
865
|
onCreated?: (state: RootState) => void
|
|
836
866
|
/** Response for pointer clicks that have missed any target */
|
|
@@ -1059,7 +1089,7 @@ interface CanvasProps
|
|
|
1059
1089
|
*/
|
|
1060
1090
|
resize?: Options
|
|
1061
1091
|
/** The target where events are being subscribed to, default: the div that wraps canvas */
|
|
1062
|
-
eventSource?:
|
|
1092
|
+
eventSource?: Element | React$1.RefObject<Element | null>
|
|
1063
1093
|
/** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
|
|
1064
1094
|
eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
|
|
1065
1095
|
/** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
|
|
@@ -1167,81 +1197,86 @@ interface LegacyRootState extends Omit<RootState, 'renderer' | 'internal'> {
|
|
|
1167
1197
|
|
|
1168
1198
|
type RenderTargetOptions = RenderTargetOptions$1
|
|
1169
1199
|
|
|
1170
|
-
//* Global Types ==============================
|
|
1200
|
+
//* Global TSL Types ==============================
|
|
1171
1201
|
|
|
1172
1202
|
declare global {
|
|
1173
1203
|
/**
|
|
1174
|
-
*
|
|
1175
|
-
*
|
|
1176
|
-
* This is three's own `UniformNode`, not a re-declaration of it. It previously was a
|
|
1177
|
-
* hand-rolled `interface UniformNode<T> extends Node { value: T }`, which shadowed the real
|
|
1178
|
-
* exported type globally — so R3F's ~58 references resolved to an approximation that was
|
|
1179
|
-
* missing members three actually ships (`setName` among them) and had drifted to the wrong
|
|
1180
|
-
* arity when three made `UniformNode` two-parameter.
|
|
1181
|
-
*
|
|
1182
|
-
* three's signature is `UniformNode<TNodeType, TValue>`. R3F only ever varies the value type,
|
|
1183
|
-
* so the node type is fixed to `unknown` and the single parameter is kept for call-site
|
|
1184
|
-
* ergonomics. The result is three's structural type, so members stay in sync with the
|
|
1185
|
-
* installed three instead of needing to be mirrored by hand.
|
|
1204
|
+
* Broad callable-node fallback for dynamic store readers.
|
|
1205
|
+
* Creator hooks preserve the exact function signatures inferred from Three's `Fn`.
|
|
1186
1206
|
*/
|
|
1187
|
-
type
|
|
1207
|
+
type CallableTSLNode = ((...params: never[]) => unknown) & {
|
|
1208
|
+
readonly shaderNode: unknown
|
|
1209
|
+
readonly id: number
|
|
1210
|
+
}
|
|
1188
1211
|
|
|
1189
|
-
/**
|
|
1190
|
-
|
|
1191
|
-
|
|
1192
|
-
|
|
1193
|
-
|
|
1194
|
-
* @example
|
|
1195
|
-
* ```tsx
|
|
1196
|
-
* // Define a shader function
|
|
1197
|
-
* const blendColorFn = Fn(([color1, color2, factor]) => {
|
|
1198
|
-
* return mix(color1, color2, factor)
|
|
1199
|
-
* })
|
|
1200
|
-
*
|
|
1201
|
-
* // Type when retrieving from nodes store
|
|
1202
|
-
* const { blendColorFn } = nodes as { blendColorFn: ShaderCallable }
|
|
1203
|
-
*
|
|
1204
|
-
* // Or with specific return type
|
|
1205
|
-
* const { myFn } = nodes as { myFn: ShaderCallable<THREE.Node> }
|
|
1206
|
-
* ```
|
|
1207
|
-
*/
|
|
1208
|
-
type ShaderCallable<R extends Node = Node> = ((...params: unknown[]) => ShaderNodeObject<R>) & Node
|
|
1212
|
+
/** Legacy structural node accepted when at least one historical marker exists. */
|
|
1213
|
+
type LegacyTSLNodeLike = {
|
|
1214
|
+
label?: ((label: string) => unknown) | string
|
|
1215
|
+
setName?: (name: string) => unknown
|
|
1216
|
+
} & ({ uuid: string | undefined; nodeType?: string | null } | { uuid?: string; nodeType: string | null | undefined })
|
|
1209
1217
|
|
|
1210
|
-
/**
|
|
1211
|
-
|
|
1212
|
-
* This is the common return type for TSL operations (add, mul, sin, etc.)
|
|
1213
|
-
*
|
|
1214
|
-
* @example
|
|
1215
|
-
* ```tsx
|
|
1216
|
-
* const { wobble } = nodes as { wobble: ShaderNodeRef }
|
|
1217
|
-
* ```
|
|
1218
|
-
*/
|
|
1219
|
-
type ShaderNodeRef<T extends Node = Node> = ShaderNodeObject<T>
|
|
1218
|
+
/** Node type accepted by broad dynamic node-store readers. */
|
|
1219
|
+
type TSLNodeType = three_webgpu.Node | CallableTSLNode
|
|
1220
1220
|
|
|
1221
1221
|
/**
|
|
1222
|
-
*
|
|
1223
|
-
*
|
|
1224
|
-
*
|
|
1225
|
-
*
|
|
1226
|
-
* - Node: base Three.js node type
|
|
1227
|
-
* - ShaderCallable: function nodes created with Fn()
|
|
1228
|
-
* - ShaderNodeObject: wrapped nodes from TSL operations (sin, mul, mix, etc.)
|
|
1229
|
-
*
|
|
1230
|
-
* @example
|
|
1231
|
-
* ```tsx
|
|
1232
|
-
* // In useLocalNodes, nodes are typed as TSLNodeType
|
|
1233
|
-
* const { positionNode, blendColorFn } = useLocalNodes(({ nodes }) => ({
|
|
1234
|
-
* positionNode: nodes.myPosition, // Works - Node is in union
|
|
1235
|
-
* blendColorFn: nodes.myFn, // Works - ShaderCallable is in union
|
|
1236
|
-
* }))
|
|
1237
|
-
*
|
|
1238
|
-
* // Can narrow with type guard or assertion when needed
|
|
1239
|
-
* if (typeof blendColorFn === 'function') {
|
|
1240
|
-
* blendColorFn(someColor, 0.5)
|
|
1241
|
-
* }
|
|
1242
|
-
* ```
|
|
1222
|
+
* Derive Three's shader node type from an existing node or a supported raw input.
|
|
1223
|
+
* Existing InputNode generics take precedence over structural value normalization.
|
|
1224
|
+
* Both generics must be inferred because Three's UniformNode intersects an unknown-typed
|
|
1225
|
+
* InputNode base with its concrete InputNode specialization.
|
|
1243
1226
|
*/
|
|
1244
|
-
type
|
|
1227
|
+
type UniformNodeType<T> = T extends three_webgpu.UniformNode<infer TNodeType, infer _TValue>
|
|
1228
|
+
? TNodeType
|
|
1229
|
+
: T extends three_webgpu.InputNode<infer TNodeType, infer _TValue>
|
|
1230
|
+
? TNodeType
|
|
1231
|
+
: T extends number
|
|
1232
|
+
? 'float'
|
|
1233
|
+
: T extends boolean
|
|
1234
|
+
? 'bool'
|
|
1235
|
+
: T extends string | three_webgpu.Color | { r: number; g: number; b: number }
|
|
1236
|
+
? 'color'
|
|
1237
|
+
: T extends three_webgpu.Vector4 | { x: number; y: number; z: number; w: number }
|
|
1238
|
+
? 'vec4'
|
|
1239
|
+
: T extends three_webgpu.Vector3 | { x: number; y: number; z: number }
|
|
1240
|
+
? 'vec3'
|
|
1241
|
+
: T extends three_webgpu.Vector2 | { x: number; y: number }
|
|
1242
|
+
? 'vec2'
|
|
1243
|
+
: T extends three_webgpu.Matrix4
|
|
1244
|
+
? 'mat4'
|
|
1245
|
+
: T extends three_webgpu.Matrix3
|
|
1246
|
+
? 'mat3'
|
|
1247
|
+
: T extends three_webgpu.Matrix2
|
|
1248
|
+
? 'mat2'
|
|
1249
|
+
: unknown
|
|
1250
|
+
|
|
1251
|
+
/** Derive the normalized JavaScript value stored by a uniform node. */
|
|
1252
|
+
type UniformNodeValue<T> = T extends three_webgpu.UniformNode<infer _TNodeType, infer TValue>
|
|
1253
|
+
? TValue
|
|
1254
|
+
: T extends three_webgpu.InputNode<infer _TNodeType, infer TValue>
|
|
1255
|
+
? TValue
|
|
1256
|
+
: T extends string | { r: number; g: number; b: number }
|
|
1257
|
+
? three_webgpu.Color
|
|
1258
|
+
: T extends { x: number; y: number; z: number; w: number }
|
|
1259
|
+
? three_webgpu.Vector4
|
|
1260
|
+
: T extends { x: number; y: number; z: number }
|
|
1261
|
+
? three_webgpu.Vector3
|
|
1262
|
+
: T extends { x: number; y: number }
|
|
1263
|
+
? three_webgpu.Vector2
|
|
1264
|
+
: T extends number
|
|
1265
|
+
? number
|
|
1266
|
+
: T extends boolean
|
|
1267
|
+
? boolean
|
|
1268
|
+
: T
|
|
1269
|
+
|
|
1270
|
+
/** Three's exact UniformNode with shader and value generics derived from an input. */
|
|
1271
|
+
type UniformNodeFor<T> = three_webgpu.UniformNode<UniformNodeType<T>, UniformNodeValue<T>>
|
|
1272
|
+
|
|
1273
|
+
/** Preserve every input key while mapping values to exact Three uniform nodes. */
|
|
1274
|
+
type UniformNodesFor<T extends UniformInputRecord> = {
|
|
1275
|
+
[K in keyof T]: UniformNodeFor<T[K]>
|
|
1276
|
+
}
|
|
1277
|
+
|
|
1278
|
+
/** Backward-compatible single-parameter uniform alias. */
|
|
1279
|
+
type UniformNode<T = unknown> = UniformNodeFor<T>
|
|
1245
1280
|
|
|
1246
1281
|
/** Flat record of uniform nodes (no nested scopes) */
|
|
1247
1282
|
type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
|
|
@@ -1266,7 +1301,7 @@ declare global {
|
|
|
1266
1301
|
* Acceptable input values for useUniforms - raw values that get converted to UniformNodes
|
|
1267
1302
|
* Supports:
|
|
1268
1303
|
* - Primitives: number, string (color), boolean
|
|
1269
|
-
* - Three.js types: Color, Vector2/3/4,
|
|
1304
|
+
* - Three.js types: Color, Vector2/3/4, Matrix2/3/4
|
|
1270
1305
|
* - Plain objects: { x, y, z, w } converted to vectors
|
|
1271
1306
|
* - TSL nodes: color(), vec3(), float() for type casting
|
|
1272
1307
|
* - UniformNode: existing uniforms (reused as-is)
|
|
@@ -1279,93 +1314,124 @@ declare global {
|
|
|
1279
1314
|
| three_webgpu.Vector2
|
|
1280
1315
|
| three_webgpu.Vector3
|
|
1281
1316
|
| three_webgpu.Vector4
|
|
1317
|
+
| three_webgpu.Matrix2
|
|
1282
1318
|
| three_webgpu.Matrix3
|
|
1283
1319
|
| three_webgpu.Matrix4
|
|
1284
|
-
|
|
|
1285
|
-
|
|
|
1286
|
-
| { x: number; y
|
|
1320
|
+
| { x: number; y: number }
|
|
1321
|
+
| { x: number; y: number; z: number }
|
|
1322
|
+
| { x: number; y: number; z: number; w: number }
|
|
1287
1323
|
| { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
|
|
1288
|
-
| Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1324
|
+
| three_webgpu.Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1289
1325
|
| UniformNode
|
|
1290
1326
|
|
|
1291
1327
|
/** Input record for useUniforms - accepts raw values or UniformNodes */
|
|
1292
1328
|
type UniformInputRecord = Record<string, UniformValue>
|
|
1293
1329
|
}
|
|
1294
1330
|
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
declare module 'three/tsl' {
|
|
1298
|
-
/**
|
|
1299
|
-
* Fn with array parameter destructuring
|
|
1300
|
-
* @example Fn(([uv, skew]) => { ... })
|
|
1301
|
-
*/
|
|
1302
|
-
export function Fn<R extends Node = Node>(
|
|
1303
|
-
jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
|
|
1304
|
-
): ShaderCallable<R>
|
|
1305
|
-
|
|
1331
|
+
declare global {
|
|
1306
1332
|
/**
|
|
1307
|
-
*
|
|
1308
|
-
*
|
|
1333
|
+
* three's own render pipeline type. Named here so the rest of R3F refers to three's shape
|
|
1334
|
+
* rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
|
|
1335
|
+
* is r185, so the new name is the only one.
|
|
1309
1336
|
*/
|
|
1310
|
-
|
|
1311
|
-
jsFunc: (inputs: T) => ShaderNodeObject<R>,
|
|
1312
|
-
): ShaderCallable<R>
|
|
1337
|
+
type ThreeRenderPipeline = three_webgpu.RenderPipeline
|
|
1313
1338
|
|
|
1314
1339
|
/**
|
|
1315
|
-
*
|
|
1316
|
-
*
|
|
1340
|
+
* The pass `useRenderPipeline` creates for you: three's own `PassNode`, as returned by
|
|
1341
|
+
* `pass(scene, camera)` from `three/tsl`. Referenced from three so members like
|
|
1342
|
+
* `getTextureNode`, `setMRT` and `dispose` track the installed version.
|
|
1317
1343
|
*/
|
|
1318
|
-
|
|
1319
|
-
jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
|
|
1320
|
-
layout: { layout?: unknown },
|
|
1321
|
-
): ShaderCallable<R>
|
|
1344
|
+
type ScenePassNode = three_webgpu.PassNode
|
|
1322
1345
|
|
|
1323
1346
|
/**
|
|
1324
|
-
*
|
|
1347
|
+
* Pass record - stores TSL pass nodes for render pipeline.
|
|
1348
|
+
*
|
|
1349
|
+
* `scenePass` is the only key the library owns. It is optional here because this is also the
|
|
1350
|
+
* shape of `state.passes`, which is `{}` before the pipeline exists and again after `reset()`
|
|
1351
|
+
* or `clearPasses()`. Inside the callbacks it is always present; see
|
|
1352
|
+
* {@link RenderPipelineCallbackState}.
|
|
1353
|
+
*
|
|
1354
|
+
* Every other key is user-registered, via a callback's return value. Those are TSL nodes of
|
|
1355
|
+
* any kind, not only passes: texture reads of an MRT attachment, effect nodes, extra
|
|
1356
|
+
* `pass()` instances. `Node` is the common base, so that is the bound. Narrow at the call
|
|
1357
|
+
* site when you need a member, e.g. `passes.velocity as TextureNode`.
|
|
1358
|
+
*
|
|
1359
|
+
* The index signature admits `undefined` because a key may simply not be registered, and
|
|
1360
|
+
* because the optional `scenePass` must be assignable to it: under `skipLibCheck: false` an
|
|
1361
|
+
* optional property whose type excludes `undefined` from the index signature is an error
|
|
1362
|
+
* (TS2411) for every consumer compiling these declarations.
|
|
1325
1363
|
*/
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
|
|
1329
|
-
|
|
1330
|
-
}
|
|
1364
|
+
interface PassRecord {
|
|
1365
|
+
scenePass?: ScenePassNode
|
|
1366
|
+
[key: string]: three_webgpu.Node | undefined
|
|
1367
|
+
}
|
|
1331
1368
|
|
|
1332
|
-
declare global {
|
|
1333
1369
|
/**
|
|
1334
|
-
*
|
|
1335
|
-
*
|
|
1336
|
-
* is
|
|
1370
|
+
* State passed to pipeline callbacks after the active pipeline has been created.
|
|
1371
|
+
*
|
|
1372
|
+
* `passes.scenePass` is required here: the hook installs the default scene pass before either
|
|
1373
|
+
* callback runs, so callbacks can use it without a guard or a cast.
|
|
1374
|
+
*
|
|
1375
|
+
* `renderer` is narrowed to `WebGPURenderer` and `isLegacy` to `false`: the hook throws under
|
|
1376
|
+
* the legacy renderer before either callback can run, so a callback never sees WebGL.
|
|
1337
1377
|
*/
|
|
1338
|
-
type ThreeRenderPipeline = three_webgpu.RenderPipeline
|
|
1339
|
-
|
|
1340
|
-
/** Pass record - stores TSL pass nodes for render pipeline */
|
|
1341
|
-
type PassRecord = Record<string, any>
|
|
1342
|
-
|
|
1343
|
-
/** State passed to pipeline callbacks after the active pipeline has been created */
|
|
1344
1378
|
type RenderPipelineCallbackState = RootState & {
|
|
1345
1379
|
renderPipeline: ThreeRenderPipeline
|
|
1380
|
+
passes: PassRecord & { scenePass: ScenePassNode }
|
|
1381
|
+
renderer: three_webgpu.WebGPURenderer
|
|
1382
|
+
isLegacy: false
|
|
1346
1383
|
}
|
|
1347
1384
|
|
|
1385
|
+
/**
|
|
1386
|
+
* What a callback may return to register entries into `state.passes`.
|
|
1387
|
+
*
|
|
1388
|
+
* `scenePass` is reserved. The hook owns that entry and its lifecycle: it caches the pass it
|
|
1389
|
+
* created, and `rebuild()` / `reset()` dispose that cached pass. A callback overwriting the
|
|
1390
|
+
* store entry would leave the store pointing at a node the hook never disposes, and the hook
|
|
1391
|
+
* disposing a pass nothing references. So returning it is a type error.
|
|
1392
|
+
*/
|
|
1393
|
+
type RegisteredPasses = Record<string, three_webgpu.Node> & { scenePass?: never }
|
|
1394
|
+
|
|
1348
1395
|
/** Setup callback - runs first to configure MRT, create additional passes */
|
|
1349
|
-
type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) =>
|
|
1396
|
+
type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1350
1397
|
|
|
1351
1398
|
/** Main callback - runs second to configure outputNode, create effect passes */
|
|
1352
|
-
type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) =>
|
|
1399
|
+
type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1353
1400
|
|
|
1354
|
-
/**
|
|
1355
|
-
interface
|
|
1401
|
+
/** The imperative half of useRenderPipeline's return value, present in every state */
|
|
1402
|
+
interface UseRenderPipelineActions {
|
|
1356
1403
|
/** Current passes from state */
|
|
1357
1404
|
passes: PassRecord
|
|
1358
|
-
/** RenderPipeline instance (null if not initialized) */
|
|
1359
|
-
renderPipeline: ThreeRenderPipeline | null
|
|
1360
1405
|
/** Clear all passes from state */
|
|
1361
1406
|
clearPasses: () => void
|
|
1362
1407
|
/** Reset RenderPipeline entirely (clears PP + passes) */
|
|
1363
1408
|
reset: () => void
|
|
1364
1409
|
/** Re-run setup/main callbacks with current closure values */
|
|
1365
1410
|
rebuild: () => void
|
|
1366
|
-
/** True when RenderPipeline is configured and ready */
|
|
1367
|
-
isReady: boolean
|
|
1368
1411
|
}
|
|
1412
|
+
|
|
1413
|
+
/**
|
|
1414
|
+
* Return type for useRenderPipeline hook, discriminated on `isReady`.
|
|
1415
|
+
*
|
|
1416
|
+
* `if (isReady)` narrows `renderPipeline` to non-null, which is what the docs already tell
|
|
1417
|
+
* callers to check. `passes.scenePass` deliberately stays optional in the ready branch:
|
|
1418
|
+
* `clearPasses()` empties the record while leaving the pipeline in place.
|
|
1419
|
+
*/
|
|
1420
|
+
type UseRenderPipelineReturn = UseRenderPipelineActions &
|
|
1421
|
+
(
|
|
1422
|
+
| {
|
|
1423
|
+
/** True when RenderPipeline is configured and ready */
|
|
1424
|
+
isReady: true
|
|
1425
|
+
/** RenderPipeline instance */
|
|
1426
|
+
renderPipeline: ThreeRenderPipeline
|
|
1427
|
+
}
|
|
1428
|
+
| {
|
|
1429
|
+
/** False until the pipeline has been created */
|
|
1430
|
+
isReady: false
|
|
1431
|
+
/** Not initialized yet, or torn down by reset() */
|
|
1432
|
+
renderPipeline: null
|
|
1433
|
+
}
|
|
1434
|
+
)
|
|
1369
1435
|
}
|
|
1370
1436
|
|
|
1371
1437
|
type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
|
|
@@ -1444,10 +1510,11 @@ type TSLNodeInput = { nodeType?: string | null; uuid?: string } | null
|
|
|
1444
1510
|
|
|
1445
1511
|
/**
|
|
1446
1512
|
* For node material properties (colorNode, positionNode, etc.), accept broader types
|
|
1447
|
-
* since @types/three has broken inheritance for TSL node subclasses.
|
|
1513
|
+
* since @types/three has broken inheritance for TSL node subclasses. NodeClass requires
|
|
1514
|
+
* `nodeType`, so this structural key test remains neutral to the selected Three entry.
|
|
1448
1515
|
*/
|
|
1449
1516
|
type NodeProps<P> = {
|
|
1450
|
-
[K in keyof P as P[K] extends
|
|
1517
|
+
[K in keyof P as NonNullable<P[K]> extends { nodeType: string | null } ? K : never]?: TSLNodeInput
|
|
1451
1518
|
}
|
|
1452
1519
|
|
|
1453
1520
|
interface ReactProps<P> {
|
|
@@ -1468,11 +1535,30 @@ type ThreeToJSXElements<T extends Record<string, any>> = {
|
|
|
1468
1535
|
[K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
|
|
1469
1536
|
}
|
|
1470
1537
|
|
|
1538
|
+
/** Method names of Object3D, excluded from the `primitive` element's typed props. */
|
|
1539
|
+
type Object3DMethod = NonNullable<
|
|
1540
|
+
{
|
|
1541
|
+
[K in keyof Object3D]-?: Object3D[K] extends (...args: any[]) => any ? K : never
|
|
1542
|
+
}[keyof Object3D]
|
|
1543
|
+
>
|
|
1544
|
+
|
|
1471
1545
|
type ThreeExports = typeof THREE
|
|
1472
1546
|
type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
|
|
1473
1547
|
|
|
1474
1548
|
interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
|
|
1475
|
-
|
|
1549
|
+
/**
|
|
1550
|
+
* `primitive` wraps a pre-existing object, so its props cannot be derived from one class.
|
|
1551
|
+
* Events are typed from `EventHandlers` (`onClick={(e) => ...}` infers `e`), the ref is
|
|
1552
|
+
* untyped, and any other prop is accepted and applied to the object by name. Object3D's own
|
|
1553
|
+
* methods are left out of the typed surface: they return `this`, so a subclass element's
|
|
1554
|
+
* props (`ThreeElements['group']`) could not be spread onto a primitive otherwise.
|
|
1555
|
+
*/
|
|
1556
|
+
primitive: Omit<ThreeElement<typeof Object3D>, 'args' | 'object' | 'ref' | 'onUpdate' | Object3DMethod> & {
|
|
1557
|
+
object: object
|
|
1558
|
+
ref?: React.Ref<any>
|
|
1559
|
+
onUpdate?: (self: any) => void
|
|
1560
|
+
[prop: string]: unknown
|
|
1561
|
+
}
|
|
1476
1562
|
// Conflicts with DOM types can be accessed through a three* prefix
|
|
1477
1563
|
threeAudio: ThreeElementsImpl['audio']
|
|
1478
1564
|
threeSource: ThreeElementsImpl['source']
|
|
@@ -1513,6 +1599,7 @@ type three_d_Matrix3 = Matrix3;
|
|
|
1513
1599
|
type three_d_Matrix4 = Matrix4;
|
|
1514
1600
|
type three_d_MutableOrReadonlyParameters<T extends (...args: any) => any> = MutableOrReadonlyParameters<T>;
|
|
1515
1601
|
type three_d_NodeProps<P> = NodeProps<P>;
|
|
1602
|
+
type three_d_Object3DMethod = Object3DMethod;
|
|
1516
1603
|
type three_d_Quaternion = Quaternion;
|
|
1517
1604
|
type three_d_RaycastableRepresentation = RaycastableRepresentation;
|
|
1518
1605
|
type three_d_ReactProps<P> = ReactProps<P>;
|
|
@@ -1527,7 +1614,7 @@ type three_d_Vector3 = Vector3;
|
|
|
1527
1614
|
type three_d_Vector4 = Vector4;
|
|
1528
1615
|
type three_d_VectorRepresentation = VectorRepresentation;
|
|
1529
1616
|
declare namespace three_d {
|
|
1530
|
-
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 };
|
|
1617
|
+
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 };
|
|
1531
1618
|
}
|
|
1532
1619
|
|
|
1533
1620
|
/**
|
|
@@ -1876,7 +1963,7 @@ declare function createEvents(store: RootStore): {
|
|
|
1876
1963
|
processDeferredPointer: (event: DomEvent, pointerId: number) => void;
|
|
1877
1964
|
};
|
|
1878
1965
|
/** Default R3F event manager for web */
|
|
1879
|
-
declare function createPointerEvents(store: RootStore): EventManager<
|
|
1966
|
+
declare function createPointerEvents(store: RootStore): EventManager<Element>;
|
|
1880
1967
|
|
|
1881
1968
|
/**
|
|
1882
1969
|
* Gets or creates a memoized loader instance from a loader constructor or returns the loader if it's already an instance.
|
|
@@ -3224,6 +3311,7 @@ declare namespace ReactReconciler {
|
|
|
3224
3311
|
|
|
3225
3312
|
declare function extend<T extends ConstructorRepresentation>(objects: T): React$1.ExoticComponent<ThreeElement<T>>;
|
|
3226
3313
|
declare function extend<T extends Catalogue>(objects: T): void;
|
|
3314
|
+
declare function extend(objects: Record<string, unknown>): void;
|
|
3227
3315
|
declare const reconciler: ReactReconciler.Reconciler<RootStore, Instance<any>, void, Instance<any>, never, any>;
|
|
3228
3316
|
|
|
3229
3317
|
declare const isRenderer: (def: any) => boolean;
|
|
@@ -3667,29 +3755,44 @@ declare const hasConstructor: (object: unknown) => object is {
|
|
|
3667
3755
|
* Used to identify values that should be resolved from refs after mount.
|
|
3668
3756
|
*/
|
|
3669
3757
|
declare const FROM_REF: unique symbol;
|
|
3758
|
+
/** The marker `fromRef()` returns; resolved by the reconciler in `commitMount`. */
|
|
3759
|
+
interface FromRefMarker<T = unknown, R = T> {
|
|
3760
|
+
[FROM_REF]: React$1.RefObject<T | null>;
|
|
3761
|
+
/** Optional transform applied to the resolved ref before assignment. */
|
|
3762
|
+
transform?: (value: T) => R;
|
|
3763
|
+
}
|
|
3670
3764
|
/**
|
|
3671
3765
|
* Defers prop application until the referenced object is available.
|
|
3672
3766
|
* Useful for props like `target` that need sibling refs to be populated.
|
|
3673
3767
|
*
|
|
3768
|
+
* Only top-level props on a three element are resolved: a marker nested inside another value
|
|
3769
|
+
* (an array, an options object) is never seen. When the prop needs the sibling *wrapped* rather
|
|
3770
|
+
* than assigned as-is, pass a `transform`; it runs once the ref is populated and its result is
|
|
3771
|
+
* what gets assigned.
|
|
3772
|
+
*
|
|
3674
3773
|
* @param ref - React ref object to resolve at mount time
|
|
3675
|
-
* @
|
|
3774
|
+
* @param transform - Optional mapping from the resolved object to the value the prop expects
|
|
3775
|
+
* @returns A marker value that the reconciler resolves after mount
|
|
3676
3776
|
*
|
|
3677
3777
|
* @example
|
|
3678
3778
|
* const targetRef = useRef<THREE.Object3D>(null)
|
|
3679
3779
|
*
|
|
3680
3780
|
* <group ref={targetRef} position={[-3, -2, -15]} />
|
|
3681
3781
|
* <spotLight target={fromRef(targetRef)} intensity={100} />
|
|
3782
|
+
*
|
|
3783
|
+
* @example
|
|
3784
|
+
* // Wrap the sibling: a node material's lightsNode needs a LightsNode, not the light itself
|
|
3785
|
+
* <meshPhongNodeMaterial lightsNode={fromRef(lightRef, (light) => lights([light]))} />
|
|
3682
3786
|
*/
|
|
3683
3787
|
declare function fromRef<T>(ref: React$1.RefObject<T | null>): T;
|
|
3788
|
+
declare function fromRef<T, R>(ref: React$1.RefObject<T | null>, transform: (value: T) => R): R;
|
|
3684
3789
|
/**
|
|
3685
3790
|
* Type guard to check if a value is a fromRef marker.
|
|
3686
3791
|
*
|
|
3687
3792
|
* @param value - Value to check
|
|
3688
3793
|
* @returns True if value is a fromRef marker
|
|
3689
3794
|
*/
|
|
3690
|
-
declare function isFromRef(value: unknown): value is
|
|
3691
|
-
[FROM_REF]: React$1.RefObject<any>;
|
|
3692
|
-
};
|
|
3795
|
+
declare function isFromRef(value: unknown): value is FromRefMarker<any, unknown>;
|
|
3693
3796
|
|
|
3694
3797
|
/**
|
|
3695
3798
|
* Symbol marker for mount-only method calls.
|
|
@@ -3716,7 +3819,15 @@ declare const ONCE: unique symbol;
|
|
|
3716
3819
|
* // No arguments
|
|
3717
3820
|
* <geometry center={once()} />
|
|
3718
3821
|
*/
|
|
3719
|
-
declare function once<
|
|
3822
|
+
declare function once<A extends unknown[]>(...args: A): OnceValue<A>;
|
|
3823
|
+
/**
|
|
3824
|
+
* What `once(...args)` is typed as, so the marker is assignable to the prop it targets:
|
|
3825
|
+
* the single argument itself (`rotateX={once(angle)}`), the argument tuple for multi-argument
|
|
3826
|
+
* methods (`translate={once(x, y, z)}`), or `true` for a bare call (`center={once()}`).
|
|
3827
|
+
*
|
|
3828
|
+
* The runtime value is always the marker object; only the declared type follows the prop.
|
|
3829
|
+
*/
|
|
3830
|
+
type OnceValue<A extends unknown[]> = A extends [] ? true : A extends [infer Single] ? Single : A;
|
|
3720
3831
|
/**
|
|
3721
3832
|
* Type guard to check if a value is a once marker.
|
|
3722
3833
|
*
|
|
@@ -3727,11 +3838,8 @@ declare function isOnce(value: unknown): value is {
|
|
|
3727
3838
|
[ONCE]: any[] | true;
|
|
3728
3839
|
};
|
|
3729
3840
|
|
|
3730
|
-
/**
|
|
3731
|
-
|
|
3732
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/canvas
|
|
3733
|
-
*/
|
|
3734
|
-
declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
|
|
3841
|
+
/** Distinguishes a resource leaf from a nested resource scope. */
|
|
3842
|
+
type ResourceLeafGuard<T> = (value: unknown) => value is T;
|
|
3735
3843
|
|
|
3736
3844
|
/**
|
|
3737
3845
|
* ScopedStore - Type-safe wrapper for nested stores (uniforms, nodes)
|
|
@@ -3753,33 +3861,30 @@ declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
|
|
|
3753
3861
|
* ```
|
|
3754
3862
|
*/
|
|
3755
3863
|
|
|
3756
|
-
/** Keys reserved for methods (excluded from index signature) */
|
|
3757
|
-
type MethodKeys = 'scope' | 'has' | 'keys';
|
|
3758
3864
|
/**
|
|
3759
3865
|
* Type-safe wrapper interface for accessing nested store data.
|
|
3760
3866
|
* Property access returns `T` (assumes leaf node).
|
|
3761
3867
|
* Use `.scope(key)` for nested object access.
|
|
3762
3868
|
*
|
|
3763
|
-
* Uses mapped type with key filtering to exclude method names from index signature,
|
|
3764
|
-
* allowing methods to have their correct return types.
|
|
3765
3869
|
*/
|
|
3766
|
-
type
|
|
3767
|
-
/** Direct property access returns the leaf type T (method keys excluded) */
|
|
3768
|
-
readonly [K in string as K extends MethodKeys ? never : K]: T;
|
|
3769
|
-
} & {
|
|
3870
|
+
type ScopedStoreMethods<TLeaf> = {
|
|
3770
3871
|
/** Access a nested scope by key. Returns empty wrapper if scope doesn't exist. */
|
|
3771
|
-
scope(key: string): ScopedStoreType<
|
|
3872
|
+
scope<TScope extends Record<string, TLeaf> = Record<string, TLeaf>>(key: string): ScopedStoreType<TLeaf, TScope>;
|
|
3772
3873
|
/** Check if a key exists in the store */
|
|
3773
3874
|
has(key: string): boolean;
|
|
3774
3875
|
/** Get all keys in the store */
|
|
3775
3876
|
keys(): string[];
|
|
3776
3877
|
};
|
|
3878
|
+
type ScopedStoreType<TLeaf, TEntries extends Record<string, TLeaf> = Record<string, TLeaf>> = Readonly<TEntries> & ScopedStoreMethods<TLeaf>;
|
|
3879
|
+
interface ScopedStoreData<TLeaf> {
|
|
3880
|
+
[key: string]: TLeaf | ScopedStoreData<TLeaf>;
|
|
3881
|
+
}
|
|
3777
3882
|
/**
|
|
3778
3883
|
* Create a type-safe ScopedStore wrapper around store data.
|
|
3779
3884
|
* @param data - The raw store data (uniforms or nodes from RootState)
|
|
3780
3885
|
* @returns A ScopedStoreType wrapper with type-safe access
|
|
3781
3886
|
*/
|
|
3782
|
-
declare function createScopedStore<
|
|
3887
|
+
declare function createScopedStore<TLeaf>(data: ScopedStoreData<TLeaf>, isLeaf: ResourceLeafGuard<TLeaf>): ScopedStoreType<TLeaf>;
|
|
3783
3888
|
/**
|
|
3784
3889
|
* State type passed to creator functions with ScopedStore wrappers.
|
|
3785
3890
|
* Provides type-safe access to uniforms, nodes, buffers, and gpuStorage without manual casting.
|
|
@@ -3787,8 +3892,8 @@ declare function createScopedStore<T>(data: Record<string, any>): ScopedStoreTyp
|
|
|
3787
3892
|
type CreatorState = Omit<RootState, 'uniforms' | 'nodes' | 'buffers' | 'gpuStorage'> & {
|
|
3788
3893
|
/** Type-safe uniform access - property access returns UniformNode */
|
|
3789
3894
|
uniforms: ScopedStoreType<UniformNode>;
|
|
3790
|
-
/** Type-safe node access
|
|
3791
|
-
nodes: ScopedStoreType<
|
|
3895
|
+
/** Type-safe node access for real, callable, and legacy structural nodes */
|
|
3896
|
+
nodes: ScopedStoreType<NodeLike>;
|
|
3792
3897
|
/** Type-safe buffer access - property access returns BufferLike (TypedArrays, BufferAttributes, TSL nodes) */
|
|
3793
3898
|
buffers: ScopedStoreType<BufferLike>;
|
|
3794
3899
|
/** Type-safe GPU storage access - property access returns StorageLike (StorageTexture, TSL nodes) */
|
|
@@ -3804,17 +3909,18 @@ type ClearUniformsFn = (scope?: string) => void;
|
|
|
3804
3909
|
/** Function signature for rebuildUniforms util */
|
|
3805
3910
|
type RebuildUniformsFn = (scope?: string) => void;
|
|
3806
3911
|
/** Return type with utils included */
|
|
3807
|
-
type UniformsWithUtils<T extends UniformRecord = UniformRecord> = T & {
|
|
3912
|
+
type UniformsWithUtils<T extends UniformRecord | UniformStore = UniformRecord> = T & {
|
|
3808
3913
|
removeUniforms: RemoveUniformsFn;
|
|
3809
3914
|
clearUniforms: ClearUniformsFn;
|
|
3810
3915
|
rebuildUniforms: RebuildUniformsFn;
|
|
3811
3916
|
};
|
|
3812
|
-
declare function useUniforms(): UniformsWithUtils<
|
|
3917
|
+
declare function useUniforms<T extends UniformInputRecord>(creator: UniformCreator<T>): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3918
|
+
declare function useUniforms<T extends UniformInputRecord>(creator: UniformCreator<T>, scope: string): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3919
|
+
declare function useUniforms<T extends UniformInputRecord>(uniforms: T): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3920
|
+
declare function useUniforms<T extends UniformInputRecord>(uniforms: T, scope: string): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3921
|
+
declare function useUniforms(): UniformsWithUtils<UniformStore>;
|
|
3813
3922
|
declare function useUniforms(scope: string): UniformsWithUtils;
|
|
3814
|
-
declare function useUniforms<T extends UniformInputRecord>(
|
|
3815
|
-
declare function useUniforms<T extends UniformInputRecord>(creator: UniformCreator<T>, scope: string): UniformsWithUtils<UniformRecord<UniformNode>>;
|
|
3816
|
-
declare function useUniforms<T extends UniformInputRecord>(uniforms: T): UniformsWithUtils<UniformRecord<UniformNode>>;
|
|
3817
|
-
declare function useUniforms<T extends UniformInputRecord>(uniforms: T, scope: string): UniformsWithUtils<UniformRecord<UniformNode>>;
|
|
3923
|
+
declare function useUniforms<T extends UniformInputRecord>(scope?: string): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3818
3924
|
/**
|
|
3819
3925
|
* Global rebuildUniforms function for HMR integration.
|
|
3820
3926
|
* Invalidates cached uniforms and increments _hmrVersion to trigger re-creation.
|
|
@@ -3845,47 +3951,28 @@ declare function clearRootUniforms(set: ReturnType<typeof useStore>['setState'])
|
|
|
3845
3951
|
|
|
3846
3952
|
/**
|
|
3847
3953
|
* Supported uniform value types:
|
|
3848
|
-
* - Raw values: number, boolean, Vector2, Vector3, Vector4, Color, Matrix3, Matrix4
|
|
3954
|
+
* - Raw values: number, boolean, Vector2, Vector3, Vector4, Color, Matrix2, Matrix3, Matrix4
|
|
3849
3955
|
* - String colors: '#ff0000', 'red', 'rgb(255,0,0)' (auto-converted to Color)
|
|
3850
3956
|
* - TSL nodes: color(), vec3(), float(), etc. (for type casting)
|
|
3851
3957
|
* - UniformNode: existing uniforms (reused as-is)
|
|
3852
3958
|
*/
|
|
3853
|
-
type UniformValue = number | boolean | string | Vector2$1 | Vector3$1 | Vector4$1 | Color$2 | Matrix3$1 | Matrix4$1 | Node | UniformNode;
|
|
3854
|
-
|
|
3855
|
-
|
|
3856
|
-
* - 0 → number
|
|
3857
|
-
* - true → boolean
|
|
3858
|
-
* - '#ff0000' → Color (string colors are converted to Color objects)
|
|
3859
|
-
* - Node → Node (TSL nodes passed through for uniform type casting)
|
|
3860
|
-
*/
|
|
3861
|
-
type Widen<T> = T extends number ? number : T extends boolean ? boolean : T extends string ? Color$2 : T;
|
|
3862
|
-
declare function useUniform<T extends UniformValue>(name: string): UniformNode<T>;
|
|
3863
|
-
declare function useUniform<T extends UniformValue>(name: string, value: T): UniformNode<Widen<T>>;
|
|
3959
|
+
type UniformValue = number | boolean | string | Vector2$1 | Vector3$1 | Vector4$1 | Color$2 | Matrix2 | Matrix3$1 | Matrix4$1 | Node | UniformNode;
|
|
3960
|
+
declare function useUniform<T extends UniformValue = UniformValue>(name: string): UniformNodeFor<T>;
|
|
3961
|
+
declare function useUniform<T extends UniformValue>(name: string, value: T): UniformNodeFor<T>;
|
|
3864
3962
|
|
|
3865
3963
|
/**
|
|
3866
|
-
*
|
|
3867
|
-
*
|
|
3868
|
-
*
|
|
3869
|
-
*
|
|
3964
|
+
* Every node representation a creator may return. The definition lives with the store types as
|
|
3965
|
+
* `NodeLike`, so the shape creators return and the shape `state.nodes` holds are one type by
|
|
3966
|
+
* construction: three's real `Node`, the callable proxy `Fn()` returns, or the legacy structural
|
|
3967
|
+
* `{ uuid, nodeType }` shape.
|
|
3870
3968
|
*/
|
|
3871
|
-
|
|
3872
|
-
|
|
3873
|
-
|
|
3874
|
-
/** label method for chaining - sets the node's label and returns self */
|
|
3875
|
-
label?: ((label: string) => TSLNodeLike) | string;
|
|
3876
|
-
setName?: (name: string) => this;
|
|
3877
|
-
}
|
|
3878
|
-
/** TSL node type - alias for compatibility */
|
|
3969
|
+
type TSLNodeLike = NodeLike;
|
|
3970
|
+
|
|
3971
|
+
/** Backward-compatible alias covering every accepted node representation. */
|
|
3879
3972
|
type TSLNode = TSLNodeLike;
|
|
3880
|
-
/**
|
|
3881
|
-
* A record of TSL nodes - allows mixed node types (OperatorNode, ConstNode, etc.)
|
|
3882
|
-
* Uses TSLNodeLike for broader compatibility with Three.js's TSL type definitions.
|
|
3883
|
-
*/
|
|
3884
|
-
type NodeRecord<T extends TSLNodeLike = TSLNodeLike> = Record<string, T>;
|
|
3885
3973
|
/**
|
|
3886
3974
|
* Creator function that returns a record of nodes.
|
|
3887
|
-
*
|
|
3888
|
-
* (e.g., { n: OperatorNode; color: ConstNode<Color> }) to pass type checking.
|
|
3975
|
+
* Exact creator return inference is preserved within the compatible node constraint.
|
|
3889
3976
|
*/
|
|
3890
3977
|
type NodeCreator<T extends Record<string, TSLNodeLike>> = (state: CreatorState) => T;
|
|
3891
3978
|
/** Function signature for removeNodes util */
|
|
@@ -3895,15 +3982,17 @@ type ClearNodesFn = (scope?: string) => void;
|
|
|
3895
3982
|
/** Function signature for rebuildNodes util */
|
|
3896
3983
|
type RebuildNodesFn = (scope?: string) => void;
|
|
3897
3984
|
/** Return type with utils included */
|
|
3898
|
-
type NodesWithUtils<T extends Record<string,
|
|
3985
|
+
type NodesWithUtils<T extends Record<string, unknown> = NodeRecord> = T & {
|
|
3899
3986
|
removeNodes: RemoveNodesFn;
|
|
3900
3987
|
clearNodes: ClearNodesFn;
|
|
3901
3988
|
rebuildNodes: RebuildNodesFn;
|
|
3902
3989
|
};
|
|
3903
|
-
declare function useNodes(): NodesWithUtils<
|
|
3904
|
-
declare function useNodes(scope: string): NodesWithUtils<
|
|
3905
|
-
declare function useNodes<T extends
|
|
3906
|
-
declare function useNodes<T extends
|
|
3990
|
+
declare function useNodes(): NodesWithUtils<NodeStore>;
|
|
3991
|
+
declare function useNodes(scope: string): NodesWithUtils<NodeRecord>;
|
|
3992
|
+
declare function useNodes<T extends NodeRecord>(scope?: string): NodesWithUtils<T>;
|
|
3993
|
+
declare function useNodes<T extends NodeRecord>(creator: NodeCreator<T>): NodesWithUtils<T>;
|
|
3994
|
+
declare function useNodes<T extends NodeRecord>(creator: NodeCreator<T>, scope: string): NodesWithUtils<T>;
|
|
3995
|
+
declare function useNodes(creatorOrScope?: NodeCreator<NodeRecord> | string, scope?: string): NodesWithUtils<Record<string, unknown>>;
|
|
3907
3996
|
/**
|
|
3908
3997
|
* Global rebuildNodes function for HMR integration.
|
|
3909
3998
|
* Invalidates cached nodes and increments _hmrVersion to trigger re-creation.
|
|
@@ -3962,6 +4051,10 @@ type LocalNodeCreator<T extends Record<string, unknown>> = (state: CreatorState)
|
|
|
3962
4051
|
*/
|
|
3963
4052
|
declare function useLocalNodes<T extends Record<string, unknown>>(creator: LocalNodeCreator<T>): T;
|
|
3964
4053
|
|
|
4054
|
+
/**
|
|
4055
|
+
* A record of buffer-like values - allows mixed types (TypedArrays, BufferAttributes, TSL nodes)
|
|
4056
|
+
*/
|
|
4057
|
+
type BufferRecordType<T extends BufferLike = BufferLike> = Record<string, T>;
|
|
3965
4058
|
/**
|
|
3966
4059
|
* Creator function that returns a record of buffers.
|
|
3967
4060
|
* Receives CreatorState with access to existing buffers, gpuStorage, uniforms, nodes, etc.
|
|
@@ -3976,14 +4069,15 @@ type RebuildBuffersFn = (scope?: string) => void;
|
|
|
3976
4069
|
/** Function signature for disposeBuffers util - releases GPU resources */
|
|
3977
4070
|
type DisposeBuffersFn = (names: string | string[], scope?: string) => void;
|
|
3978
4071
|
/** Return type with utils included */
|
|
3979
|
-
type BuffersWithUtils<T extends
|
|
4072
|
+
type BuffersWithUtils<T extends BufferRecordType | BufferStore = BufferRecordType> = T & {
|
|
3980
4073
|
removeBuffers: RemoveBuffersFn;
|
|
3981
4074
|
clearBuffers: ClearBuffersFn;
|
|
3982
4075
|
rebuildBuffers: RebuildBuffersFn;
|
|
3983
4076
|
disposeBuffers: DisposeBuffersFn;
|
|
3984
4077
|
};
|
|
3985
|
-
declare function useBuffers(): BuffersWithUtils<
|
|
4078
|
+
declare function useBuffers(): BuffersWithUtils<BufferStore>;
|
|
3986
4079
|
declare function useBuffers(scope: string): BuffersWithUtils<Record<string, BufferLike>>;
|
|
4080
|
+
declare function useBuffers<T extends Record<string, BufferLike>>(scope?: string): BuffersWithUtils<T>;
|
|
3987
4081
|
declare function useBuffers<T extends Record<string, BufferLike>>(creator: BufferCreator<T>): BuffersWithUtils<T>;
|
|
3988
4082
|
declare function useBuffers<T extends Record<string, BufferLike>>(creator: BufferCreator<T>, scope: string): BuffersWithUtils<T>;
|
|
3989
4083
|
/**
|
|
@@ -3999,6 +4093,10 @@ declare function useBuffers<T extends Record<string, BufferLike>>(creator: Buffe
|
|
|
3999
4093
|
*/
|
|
4000
4094
|
declare function rebuildAllBuffers(store: ReturnType<typeof useStore>, scope?: string): void;
|
|
4001
4095
|
|
|
4096
|
+
/**
|
|
4097
|
+
* A record of storage-like values - allows mixed types (StorageTexture, Storage3DTexture, TSL nodes)
|
|
4098
|
+
*/
|
|
4099
|
+
type StorageRecordType<T extends StorageLike = StorageLike> = Record<string, T>;
|
|
4002
4100
|
/**
|
|
4003
4101
|
* Creator function that returns a record of GPU storage objects.
|
|
4004
4102
|
* Receives CreatorState with access to existing buffers, gpuStorage, uniforms, nodes, etc.
|
|
@@ -4013,14 +4111,15 @@ type RebuildStorageFn = (scope?: string) => void;
|
|
|
4013
4111
|
/** Function signature for disposeStorage util - releases GPU resources */
|
|
4014
4112
|
type DisposeStorageFn = (names: string | string[], scope?: string) => void;
|
|
4015
4113
|
/** Return type with utils included */
|
|
4016
|
-
type StorageWithUtils<T extends
|
|
4114
|
+
type StorageWithUtils<T extends StorageRecordType | StorageStore = StorageRecordType> = T & {
|
|
4017
4115
|
removeStorage: RemoveStorageFn;
|
|
4018
4116
|
clearStorage: ClearStorageFn;
|
|
4019
4117
|
rebuildStorage: RebuildStorageFn;
|
|
4020
4118
|
disposeStorage: DisposeStorageFn;
|
|
4021
4119
|
};
|
|
4022
|
-
declare function useGPUStorage(): StorageWithUtils<
|
|
4120
|
+
declare function useGPUStorage(): StorageWithUtils<StorageStore>;
|
|
4023
4121
|
declare function useGPUStorage(scope: string): StorageWithUtils<Record<string, StorageLike>>;
|
|
4122
|
+
declare function useGPUStorage<T extends Record<string, StorageLike>>(scope?: string): StorageWithUtils<T>;
|
|
4024
4123
|
declare function useGPUStorage<T extends Record<string, StorageLike>>(creator: StorageCreator<T>): StorageWithUtils<T>;
|
|
4025
4124
|
declare function useGPUStorage<T extends Record<string, StorageLike>>(creator: StorageCreator<T>, scope: string): StorageWithUtils<T>;
|
|
4026
4125
|
/**
|
|
@@ -4169,5 +4268,14 @@ type UseFrameWebGPU = (callback?: FrameCallback$1<WebGPURootState>, priorityOrOp
|
|
|
4169
4268
|
declare const useThree: UseThreeWebGPU;
|
|
4170
4269
|
declare const useFrame: UseFrameWebGPU;
|
|
4171
4270
|
|
|
4271
|
+
/** Canvas props on the WebGPU entry: `onCreated` receives `WebGPURootState`. */
|
|
4272
|
+
type WebGPUCanvasProps = Omit<CanvasProps, 'onCreated'> & {
|
|
4273
|
+
/** Callback after the canvas has rendered (but not yet committed); `state.renderer` is a `WebGPURenderer` */
|
|
4274
|
+
onCreated?: (state: WebGPURootState) => void;
|
|
4275
|
+
};
|
|
4276
|
+
|
|
4277
|
+
/** `Canvas` narrowed to WebGPU state — the same component, `onCreated` typed against `WebGPURootState`. */
|
|
4278
|
+
declare const Canvas: (props: WebGPUCanvasProps) => JSX.Element;
|
|
4279
|
+
|
|
4172
4280
|
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, clearNodeScope, clearRootNodes, clearRootUniforms, clearScope, context, createEvents, createPointerEvents, createPortal, createRoot, createScopedStore, createStore, createTextureOperations, detach, diffProps, dispose, createPointerEvents as events, extend, findInitialRoot, flushSync, fromRef, getInstanceProps, getPrimary, getPrimaryIds, getRootState, getUuidPrefix, hasConstructor, hasPrimary, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isFromRef, isObject3D, isOnce, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, once, prepare, presetsObj, rebuildAllBuffers, rebuildAllNodes, rebuildAllStorage, rebuildAllUniforms, reconciler, registerPrimary, removeInteractivity, removeNodes, removeUniforms, resolve, swapInteractivity, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useBuffers, useEnvironment, useFrame, useGPUStorage, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useLocalNodes, useMutableCallback, useNodes, useRenderPipeline, useRenderTarget, useStore, useTexture, useTextures, useThree, useUniform, useUniforms, waitForPrimary };
|
|
4173
|
-
export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferCreator, BufferLike, BufferRecord, BufferStore, BuffersWithUtils, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, ClearBuffersFn, ClearNodesFn, ClearStorageFn, ClearUniformsFn, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, CreatorState, DefaultGLProps, DefaultRendererProps, Disposable, DisposeBuffersFn, DisposeOptions, DisposeStorageFn, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, WebGPUInternalState as InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, LocalNodeCreator, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeCreator, NodeProps, NodeRecord, NodesWithUtils, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, WebGPUR3FRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, RebuildBuffersFn, RebuildNodesFn, RebuildStorageFn, RebuildUniformsFn, ReconcilerRoot, RemoveBuffersFn, RemoveNodesFn, RemoveStorageFn, RemoveUniformsFn, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, WebGPURootState as RootState, RootStore, ScopedStoreType, SetBlock, Size, StorageCreator, StorageLike, StorageRecord, StorageStore, StorageWithUtils, Subscription, TSLNode, TSLNodeInput, TextureEntry, TextureInput, TextureNode, TextureOperations, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UniformCreator, UniformValue, UniformsWithUtils, UseFrameWebGPU, UseTextureOptions, UseTexturesReturn, UseThreeWebGPU, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, WebGPUDefaultProps, WebGPUProps, WebGPUShadowConfig, XRManager, XRPointerConfig };
|
|
4281
|
+
export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferCreator, BufferLike, BufferRecord, BufferStore, BuffersWithUtils, Camera, CameraProps, WebGPUCanvasProps as CanvasProps, CanvasSchedulerConfig, Catalogue, ClearBuffersFn, ClearNodesFn, ClearStorageFn, ClearUniformsFn, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, CreatorState, DefaultGLProps, DefaultRendererProps, Disposable, DisposeBuffersFn, DisposeOptions, DisposeStorageFn, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, FromRefMarker, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, WebGPUInternalState as InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, LocalNodeCreator, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeCreator, NodeLike, NodeProps, NodeRecord, NodeStore, NodesWithUtils, NonFunctionKeys, Object3DMethod, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, OnceValue, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, WebGPUR3FRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, RebuildBuffersFn, RebuildNodesFn, RebuildStorageFn, RebuildUniformsFn, ReconcilerRoot, RemoveBuffersFn, RemoveNodesFn, RemoveStorageFn, RemoveUniformsFn, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, WebGPURootState as RootState, RootStore, ScopedStoreType, SetBlock, Size, StorageCreator, StorageLike, StorageRecord, StorageStore, StorageWithUtils, Subscription, TSLNode, TSLNodeInput, TSLNodeLike, TextureEntry, TextureInput, TextureNode, TextureOperations, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UniformCreator, UniformValue, UniformsWithUtils, UseFrameWebGPU, UseTextureOptions, UseTexturesReturn, UseThreeWebGPU, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, WebGPUCanvasProps, WebGPUDefaultProps, WebGPUProps, WebGPUShadowConfig, XRManager, XRPointerConfig };
|