@react-three/fiber 10.0.0-canary.4f316e6 → 10.0.0-canary.4f9f64c
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 +35 -40
- package/dist/index.d.cts +155 -164
- package/dist/index.d.mts +155 -164
- package/dist/index.d.ts +155 -192
- package/dist/index.mjs +35 -40
- package/dist/legacy.cjs +37 -42
- package/dist/legacy.d.cts +159 -168
- package/dist/legacy.d.mts +159 -168
- package/dist/legacy.d.ts +159 -194
- package/dist/legacy.mjs +37 -42
- package/dist/webgpu/index.cjs +91 -97
- package/dist/webgpu/index.d.cts +214 -214
- package/dist/webgpu/index.d.mts +214 -214
- package/dist/webgpu/index.d.ts +214 -242
- package/dist/webgpu/index.mjs +91 -97
- package/package.json +1 -1
package/dist/legacy.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import * as THREE$1 from 'three';
|
|
2
|
-
import { WebGLCubeRenderTarget, WebGLRenderTarget, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1,
|
|
2
|
+
import { WebGLCubeRenderTarget, WebGLRenderTarget, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Object3D, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Frustum, OrthographicCamera } from 'three';
|
|
3
3
|
import * as React$1 from 'react';
|
|
4
4
|
import { ReactNode, Component, RefObject, JSX } from 'react';
|
|
5
5
|
import * as three_webgpu from 'three/webgpu';
|
|
6
|
-
import { WebGPURenderer as WebGPURenderer$1, Node, StorageTexture, Data3DTexture, CanvasTarget
|
|
6
|
+
import { WebGPURenderer as WebGPURenderer$1, Node, StorageTexture, Storage3DTexture, StorageArrayTexture, Data3DTexture, CanvasTarget } from 'three/webgpu';
|
|
7
7
|
import { StoreApi } from 'zustand';
|
|
8
8
|
import { UseBoundStoreWithEqualityFn } from 'zustand/traditional';
|
|
9
9
|
import { FrameTimingState, FrameCallback as FrameCallback$1, SchedulerApi, UseFrameNextOptions, FrameNextControls } from '@pmndrs/scheduler';
|
|
@@ -12,20 +12,6 @@ import { Options } from 'react-use-measure';
|
|
|
12
12
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
13
13
|
import { GroundedSkybox } from 'three/examples/jsm/objects/GroundedSkybox.js';
|
|
14
14
|
|
|
15
|
-
function _mergeNamespaces(n, m) {
|
|
16
|
-
m.forEach(function (e) {
|
|
17
|
-
e && typeof e !== 'string' && !Array.isArray(e) && Object.keys(e).forEach(function (k) {
|
|
18
|
-
if (k !== 'default' && !(k in n)) {
|
|
19
|
-
var d = Object.getOwnPropertyDescriptor(e, k);
|
|
20
|
-
Object.defineProperty(n, k, d.get ? d : {
|
|
21
|
-
enumerable: true,
|
|
22
|
-
get: function () { return e[k]; }
|
|
23
|
-
});
|
|
24
|
-
}
|
|
25
|
-
});
|
|
26
|
-
});
|
|
27
|
-
return Object.freeze(n);
|
|
28
|
-
}
|
|
29
15
|
|
|
30
16
|
/**
|
|
31
17
|
* @fileoverview Internal Three.js re-exports - LEGACY ENTRY
|
|
@@ -41,26 +27,14 @@ declare const R3F_BUILD_WEBGPU = false;
|
|
|
41
27
|
type Inspector = never;
|
|
42
28
|
/** Not available on the legacy (WebGL-only) entry. */
|
|
43
29
|
declare function loadInspector(): Promise<never>;
|
|
44
|
-
declare
|
|
45
|
-
|
|
46
|
-
}
|
|
30
|
+
declare class WebGPURenderer {
|
|
31
|
+
constructor();
|
|
32
|
+
}
|
|
47
33
|
|
|
48
34
|
declare const RenderTarget: any;
|
|
49
35
|
|
|
50
36
|
declare const CubeRenderTarget: any;
|
|
51
37
|
|
|
52
|
-
var THREE = /*#__PURE__*/_mergeNamespaces({
|
|
53
|
-
__proto__: null,
|
|
54
|
-
CubeRenderTarget: CubeRenderTarget,
|
|
55
|
-
CubeRenderTargetCompat: WebGLCubeRenderTarget,
|
|
56
|
-
Inspector: Inspector,
|
|
57
|
-
R3F_BUILD_LEGACY: R3F_BUILD_LEGACY,
|
|
58
|
-
R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
|
|
59
|
-
RenderTarget: RenderTarget,
|
|
60
|
-
RenderTargetCompat: WebGLRenderTarget,
|
|
61
|
-
WebGPURenderer: WebGPURenderer,
|
|
62
|
-
loadInspector: loadInspector
|
|
63
|
-
}, [THREE$1]);
|
|
64
38
|
|
|
65
39
|
//* Utility Types ==============================
|
|
66
40
|
|
|
@@ -348,6 +322,7 @@ type BufferLike =
|
|
|
348
322
|
| Uint16Array
|
|
349
323
|
| Int16Array
|
|
350
324
|
| THREE$1.BufferAttribute // Base class for all buffer attributes
|
|
325
|
+
| THREE$1.InterleavedBufferAttribute
|
|
351
326
|
| Node // TSL buffer nodes (instancedArray, storage)
|
|
352
327
|
|
|
353
328
|
/** Flat record of buffer-like values (no nested scopes) */
|
|
@@ -362,23 +337,15 @@ type BufferStore = Record<string, BufferLike | BufferRecord>
|
|
|
362
337
|
//* Node Types (useNodes) ========================================
|
|
363
338
|
|
|
364
339
|
/**
|
|
365
|
-
*
|
|
366
|
-
*
|
|
367
|
-
*
|
|
368
|
-
*
|
|
369
|
-
* would reject values `useNodes` creators legitimately return. This is the same shape
|
|
370
|
-
* `useNodes` already constrains creators to (`TSLNodeLike`).
|
|
340
|
+
* Every node representation `useNodes` accepts and `state.nodes` holds: three's real `Node`,
|
|
341
|
+
* the callable proxy `Fn()` returns, and the legacy structural shape (`uuid`/`nodeType`) older
|
|
342
|
+
* code passes through. Creators are constrained to this same type, so the shape a creator returns
|
|
343
|
+
* and the shape the store holds are one type by construction.
|
|
371
344
|
*/
|
|
372
|
-
|
|
373
|
-
uuid?: string
|
|
374
|
-
nodeType?: string | null
|
|
375
|
-
/** label method for chaining - sets the node's label and returns self */
|
|
376
|
-
label?: ((label: string) => NodeLike) | string
|
|
377
|
-
setName?: (name: string) => this
|
|
378
|
-
}
|
|
345
|
+
type NodeLike = TSLNodeType | LegacyTSLNodeLike
|
|
379
346
|
|
|
380
347
|
/** Flat record of TSL nodes (no nested scopes) */
|
|
381
|
-
type NodeRecord = Record<string,
|
|
348
|
+
type NodeRecord<T extends NodeLike = NodeLike> = Record<string, T>
|
|
382
349
|
|
|
383
350
|
/**
|
|
384
351
|
* Node store that can contain both root-level nodes and scoped node objects.
|
|
@@ -400,7 +367,9 @@ type NodeStore = Record<string, NodeLike | NodeRecord>
|
|
|
400
367
|
* ```
|
|
401
368
|
*/
|
|
402
369
|
type StorageLike =
|
|
403
|
-
| StorageTexture // GPU storage texture
|
|
370
|
+
| StorageTexture // 2D GPU storage texture
|
|
371
|
+
| Storage3DTexture // 3D GPU storage texture (volumes, fluid grids)
|
|
372
|
+
| StorageArrayTexture // 2D-array GPU storage texture
|
|
404
373
|
| Data3DTexture // 3D texture (can be used as storage)
|
|
405
374
|
| Node // TSL storage texture nodes (storageTexture)
|
|
406
375
|
|
|
@@ -849,14 +818,17 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
|
|
|
849
818
|
performance?: Partial<Omit<Performance, 'regress'>>
|
|
850
819
|
/** Target pixel ratio. Can clamp between a range: `[min, max]` */
|
|
851
820
|
dpr?: Dpr
|
|
852
|
-
/**
|
|
853
|
-
|
|
821
|
+
/**
|
|
822
|
+
* Props that go into the default raycaster. `params` is merged into the raycaster's defaults,
|
|
823
|
+
* so a single threshold can be set: `raycaster={{ params: { Points: { threshold: 0.2 } } }}`.
|
|
824
|
+
*/
|
|
825
|
+
raycaster?: Partial<Omit<THREE$1.Raycaster, 'params'>> & { params?: Partial<THREE$1.RaycasterParameters> }
|
|
854
826
|
/** A `THREE.Scene` instance or props that go into the default scene */
|
|
855
827
|
scene?: THREE$1.Scene | Partial<THREE$1.Scene>
|
|
856
828
|
/** A `THREE.Camera` instance or props that go into the default camera */
|
|
857
829
|
camera?: CameraProps
|
|
858
830
|
/** An R3F event manager to manage elements' pointer events */
|
|
859
|
-
events?: (store: RootStore) => EventManager<
|
|
831
|
+
events?: (store: RootStore) => EventManager<Element>
|
|
860
832
|
/** Callback after the canvas has rendered (but not yet committed) */
|
|
861
833
|
onCreated?: (state: RootState) => void
|
|
862
834
|
/** Response for pointer clicks that have missed any target */
|
|
@@ -1085,7 +1057,7 @@ interface CanvasProps
|
|
|
1085
1057
|
*/
|
|
1086
1058
|
resize?: Options
|
|
1087
1059
|
/** The target where events are being subscribed to, default: the div that wraps canvas */
|
|
1088
|
-
eventSource?:
|
|
1060
|
+
eventSource?: Element | React$1.RefObject<Element | null>
|
|
1089
1061
|
/** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
|
|
1090
1062
|
eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
|
|
1091
1063
|
/** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
|
|
@@ -1193,107 +1165,86 @@ interface LegacyRootState extends Omit<RootState, 'renderer' | 'internal'> {
|
|
|
1193
1165
|
|
|
1194
1166
|
type RenderTargetOptions = RenderTargetOptions$1
|
|
1195
1167
|
|
|
1196
|
-
//* Global Types ==============================
|
|
1168
|
+
//* Global TSL Types ==============================
|
|
1197
1169
|
|
|
1198
1170
|
declare global {
|
|
1199
1171
|
/**
|
|
1200
|
-
*
|
|
1201
|
-
*
|
|
1202
|
-
* This is three's own `UniformNode`, not a re-declaration of it. It previously was a
|
|
1203
|
-
* hand-rolled `interface UniformNode<T> extends Node { value: T }`, which shadowed the real
|
|
1204
|
-
* exported type globally — so R3F's ~58 references resolved to an approximation that was
|
|
1205
|
-
* missing members three actually ships (`setName` among them) and had drifted to the wrong
|
|
1206
|
-
* arity when three made `UniformNode` two-parameter.
|
|
1207
|
-
*
|
|
1208
|
-
* three's signature is `UniformNode<TNodeType, TValue>`. R3F only ever varies the value type,
|
|
1209
|
-
* so the node type is fixed to `unknown` and the single parameter is kept for call-site
|
|
1210
|
-
* ergonomics. The result is three's structural type, so members stay in sync with the
|
|
1211
|
-
* installed three instead of needing to be mirrored by hand.
|
|
1172
|
+
* Broad callable-node fallback for dynamic store readers.
|
|
1173
|
+
* Creator hooks preserve the exact function signatures inferred from Three's `Fn`.
|
|
1212
1174
|
*/
|
|
1213
|
-
type
|
|
1175
|
+
type CallableTSLNode = ((...params: never[]) => unknown) & {
|
|
1176
|
+
readonly shaderNode: unknown
|
|
1177
|
+
readonly id: number
|
|
1178
|
+
}
|
|
1179
|
+
|
|
1180
|
+
/** Legacy structural node accepted when at least one historical marker exists. */
|
|
1181
|
+
type LegacyTSLNodeLike = {
|
|
1182
|
+
label?: ((label: string) => unknown) | string
|
|
1183
|
+
setName?: (name: string) => unknown
|
|
1184
|
+
} & ({ uuid: string | undefined; nodeType?: string | null } | { uuid?: string; nodeType: string | null | undefined })
|
|
1185
|
+
|
|
1186
|
+
/** Node type accepted by broad dynamic node-store readers. */
|
|
1187
|
+
type TSLNodeType = three_webgpu.Node | CallableTSLNode
|
|
1214
1188
|
|
|
1215
1189
|
/**
|
|
1216
|
-
*
|
|
1217
|
-
*
|
|
1218
|
-
*
|
|
1219
|
-
*
|
|
1190
|
+
* Derive Three's shader node type from an existing node or a supported raw input.
|
|
1191
|
+
* Existing InputNode generics take precedence over structural value normalization.
|
|
1192
|
+
* Both generics must be inferred because Three's UniformNode intersects an unknown-typed
|
|
1193
|
+
* InputNode base with its concrete InputNode specialization.
|
|
1220
1194
|
*/
|
|
1221
|
-
type
|
|
1222
|
-
?
|
|
1223
|
-
: T extends
|
|
1224
|
-
?
|
|
1225
|
-
: T extends
|
|
1226
|
-
? '
|
|
1227
|
-
: T extends
|
|
1228
|
-
? '
|
|
1229
|
-
: T extends three_webgpu.
|
|
1230
|
-
? '
|
|
1231
|
-
: T extends three_webgpu.Vector4
|
|
1195
|
+
type UniformNodeType<T> = T extends three_webgpu.UniformNode<infer TNodeType, infer _TValue>
|
|
1196
|
+
? TNodeType
|
|
1197
|
+
: T extends three_webgpu.InputNode<infer TNodeType, infer _TValue>
|
|
1198
|
+
? TNodeType
|
|
1199
|
+
: T extends number
|
|
1200
|
+
? 'float'
|
|
1201
|
+
: T extends boolean
|
|
1202
|
+
? 'bool'
|
|
1203
|
+
: T extends string | three_webgpu.Color | { r: number; g: number; b: number }
|
|
1204
|
+
? 'color'
|
|
1205
|
+
: T extends three_webgpu.Vector4 | { x: number; y: number; z: number; w: number }
|
|
1232
1206
|
? 'vec4'
|
|
1233
|
-
: T extends three_webgpu.
|
|
1234
|
-
? '
|
|
1235
|
-
: T extends three_webgpu.
|
|
1236
|
-
? '
|
|
1207
|
+
: T extends three_webgpu.Vector3 | { x: number; y: number; z: number }
|
|
1208
|
+
? 'vec3'
|
|
1209
|
+
: T extends three_webgpu.Vector2 | { x: number; y: number }
|
|
1210
|
+
? 'vec2'
|
|
1237
1211
|
: T extends three_webgpu.Matrix4
|
|
1238
1212
|
? 'mat4'
|
|
1239
|
-
:
|
|
1240
|
-
|
|
1241
|
-
|
|
1242
|
-
|
|
1243
|
-
|
|
1244
|
-
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
|
-
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
|
|
1267
|
-
|
|
1268
|
-
|
|
1269
|
-
|
|
1270
|
-
|
|
1271
|
-
type ShaderNodeRef<T extends Node = Node> = ShaderNodeObject<T>
|
|
1213
|
+
: T extends three_webgpu.Matrix3
|
|
1214
|
+
? 'mat3'
|
|
1215
|
+
: T extends three_webgpu.Matrix2
|
|
1216
|
+
? 'mat2'
|
|
1217
|
+
: unknown
|
|
1218
|
+
|
|
1219
|
+
/** Derive the normalized JavaScript value stored by a uniform node. */
|
|
1220
|
+
type UniformNodeValue<T> = T extends three_webgpu.UniformNode<infer _TNodeType, infer TValue>
|
|
1221
|
+
? TValue
|
|
1222
|
+
: T extends three_webgpu.InputNode<infer _TNodeType, infer TValue>
|
|
1223
|
+
? TValue
|
|
1224
|
+
: T extends string | { r: number; g: number; b: number }
|
|
1225
|
+
? three_webgpu.Color
|
|
1226
|
+
: T extends { x: number; y: number; z: number; w: number }
|
|
1227
|
+
? three_webgpu.Vector4
|
|
1228
|
+
: T extends { x: number; y: number; z: number }
|
|
1229
|
+
? three_webgpu.Vector3
|
|
1230
|
+
: T extends { x: number; y: number }
|
|
1231
|
+
? three_webgpu.Vector2
|
|
1232
|
+
: T extends number
|
|
1233
|
+
? number
|
|
1234
|
+
: T extends boolean
|
|
1235
|
+
? boolean
|
|
1236
|
+
: T
|
|
1237
|
+
|
|
1238
|
+
/** Three's exact UniformNode with shader and value generics derived from an input. */
|
|
1239
|
+
type UniformNodeFor<T> = three_webgpu.UniformNode<UniformNodeType<T>, UniformNodeValue<T>>
|
|
1240
|
+
|
|
1241
|
+
/** Preserve every input key while mapping values to exact Three uniform nodes. */
|
|
1242
|
+
type UniformNodesFor<T extends UniformInputRecord> = {
|
|
1243
|
+
[K in keyof T]: UniformNodeFor<T[K]>
|
|
1244
|
+
}
|
|
1272
1245
|
|
|
1273
|
-
/**
|
|
1274
|
-
|
|
1275
|
-
* Used by ScopedStore to properly type node access from the store.
|
|
1276
|
-
*
|
|
1277
|
-
* Includes:
|
|
1278
|
-
* - Node: base Three.js node type
|
|
1279
|
-
* - ShaderCallable: function nodes created with Fn()
|
|
1280
|
-
* - ShaderNodeObject: wrapped nodes from TSL operations (sin, mul, mix, etc.)
|
|
1281
|
-
*
|
|
1282
|
-
* @example
|
|
1283
|
-
* ```tsx
|
|
1284
|
-
* // In useLocalNodes, nodes are typed as TSLNodeType
|
|
1285
|
-
* const { positionNode, blendColorFn } = useLocalNodes(({ nodes }) => ({
|
|
1286
|
-
* positionNode: nodes.myPosition, // Works - Node is in union
|
|
1287
|
-
* blendColorFn: nodes.myFn, // Works - ShaderCallable is in union
|
|
1288
|
-
* }))
|
|
1289
|
-
*
|
|
1290
|
-
* // Can narrow with type guard or assertion when needed
|
|
1291
|
-
* if (typeof blendColorFn === 'function') {
|
|
1292
|
-
* blendColorFn(someColor, 0.5)
|
|
1293
|
-
* }
|
|
1294
|
-
* ```
|
|
1295
|
-
*/
|
|
1296
|
-
type TSLNodeType = Node | ShaderCallable<Node> | ShaderNodeObject<Node>
|
|
1246
|
+
/** Backward-compatible single-parameter uniform alias. */
|
|
1247
|
+
type UniformNode<T = unknown> = UniformNodeFor<T>
|
|
1297
1248
|
|
|
1298
1249
|
/** Flat record of uniform nodes (no nested scopes) */
|
|
1299
1250
|
type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
|
|
@@ -1318,7 +1269,7 @@ declare global {
|
|
|
1318
1269
|
* Acceptable input values for useUniforms - raw values that get converted to UniformNodes
|
|
1319
1270
|
* Supports:
|
|
1320
1271
|
* - Primitives: number, string (color), boolean
|
|
1321
|
-
* - Three.js types: Color, Vector2/3/4,
|
|
1272
|
+
* - Three.js types: Color, Vector2/3/4, Matrix2/3/4
|
|
1322
1273
|
* - Plain objects: { x, y, z, w } converted to vectors
|
|
1323
1274
|
* - TSL nodes: color(), vec3(), float() for type casting
|
|
1324
1275
|
* - UniformNode: existing uniforms (reused as-is)
|
|
@@ -1331,56 +1282,20 @@ declare global {
|
|
|
1331
1282
|
| three_webgpu.Vector2
|
|
1332
1283
|
| three_webgpu.Vector3
|
|
1333
1284
|
| three_webgpu.Vector4
|
|
1285
|
+
| three_webgpu.Matrix2
|
|
1334
1286
|
| three_webgpu.Matrix3
|
|
1335
1287
|
| three_webgpu.Matrix4
|
|
1336
|
-
|
|
|
1337
|
-
|
|
|
1338
|
-
| { x: number; y
|
|
1288
|
+
| { x: number; y: number }
|
|
1289
|
+
| { x: number; y: number; z: number }
|
|
1290
|
+
| { x: number; y: number; z: number; w: number }
|
|
1339
1291
|
| { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
|
|
1340
|
-
| Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1292
|
+
| three_webgpu.Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1341
1293
|
| UniformNode
|
|
1342
1294
|
|
|
1343
1295
|
/** Input record for useUniforms - accepts raw values or UniformNodes */
|
|
1344
1296
|
type UniformInputRecord = Record<string, UniformValue>
|
|
1345
1297
|
}
|
|
1346
1298
|
|
|
1347
|
-
//* Module Augmentation ==============================
|
|
1348
|
-
|
|
1349
|
-
declare module 'three/tsl' {
|
|
1350
|
-
/**
|
|
1351
|
-
* Fn with array parameter destructuring
|
|
1352
|
-
* @example Fn(([uv, skew]) => { ... })
|
|
1353
|
-
*/
|
|
1354
|
-
export function Fn<R extends Node = Node>(
|
|
1355
|
-
jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
|
|
1356
|
-
): ShaderCallable<R>
|
|
1357
|
-
|
|
1358
|
-
/**
|
|
1359
|
-
* Fn with object parameter destructuring
|
|
1360
|
-
* @example Fn(({ color, intensity }) => { ... })
|
|
1361
|
-
*/
|
|
1362
|
-
export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
|
|
1363
|
-
jsFunc: (inputs: T) => ShaderNodeObject<R>,
|
|
1364
|
-
): ShaderCallable<R>
|
|
1365
|
-
|
|
1366
|
-
/**
|
|
1367
|
-
* Fn with array params + layout
|
|
1368
|
-
* @example Fn(([a, b]) => { ... }, { layout: [...] })
|
|
1369
|
-
*/
|
|
1370
|
-
export function Fn<R extends Node = Node>(
|
|
1371
|
-
jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
|
|
1372
|
-
layout: { layout?: unknown },
|
|
1373
|
-
): ShaderCallable<R>
|
|
1374
|
-
|
|
1375
|
-
/**
|
|
1376
|
-
* Fn with object params + layout
|
|
1377
|
-
*/
|
|
1378
|
-
export function Fn<T extends Record<string, unknown>, R extends Node = Node>(
|
|
1379
|
-
jsFunc: (inputs: T) => ShaderNodeObject<R>,
|
|
1380
|
-
layout: { layout?: unknown },
|
|
1381
|
-
): ShaderCallable<R>
|
|
1382
|
-
}
|
|
1383
|
-
|
|
1384
1299
|
declare global {
|
|
1385
1300
|
/**
|
|
1386
1301
|
* three's own render pipeline type. Named here so the rest of R3F refers to three's shape
|
|
@@ -1408,10 +1323,15 @@ declare global {
|
|
|
1408
1323
|
* any kind, not only passes: texture reads of an MRT attachment, effect nodes, extra
|
|
1409
1324
|
* `pass()` instances. `Node` is the common base, so that is the bound. Narrow at the call
|
|
1410
1325
|
* site when you need a member, e.g. `passes.velocity as TextureNode`.
|
|
1326
|
+
*
|
|
1327
|
+
* The index signature admits `undefined` because a key may simply not be registered, and
|
|
1328
|
+
* because the optional `scenePass` must be assignable to it: under `skipLibCheck: false` an
|
|
1329
|
+
* optional property whose type excludes `undefined` from the index signature is an error
|
|
1330
|
+
* (TS2411) for every consumer compiling these declarations.
|
|
1411
1331
|
*/
|
|
1412
1332
|
interface PassRecord {
|
|
1413
1333
|
scenePass?: ScenePassNode
|
|
1414
|
-
[key: string]: three_webgpu.Node
|
|
1334
|
+
[key: string]: three_webgpu.Node | undefined
|
|
1415
1335
|
}
|
|
1416
1336
|
|
|
1417
1337
|
/**
|
|
@@ -1558,10 +1478,11 @@ type TSLNodeInput = { nodeType?: string | null; uuid?: string } | null
|
|
|
1558
1478
|
|
|
1559
1479
|
/**
|
|
1560
1480
|
* For node material properties (colorNode, positionNode, etc.), accept broader types
|
|
1561
|
-
* since @types/three has broken inheritance for TSL node subclasses.
|
|
1481
|
+
* since @types/three has broken inheritance for TSL node subclasses. NodeClass requires
|
|
1482
|
+
* `nodeType`, so this structural key test remains neutral to the selected Three entry.
|
|
1562
1483
|
*/
|
|
1563
1484
|
type NodeProps<P> = {
|
|
1564
|
-
[K in keyof P as P[K] extends
|
|
1485
|
+
[K in keyof P as NonNullable<P[K]> extends { nodeType: string | null } ? K : never]?: TSLNodeInput
|
|
1565
1486
|
}
|
|
1566
1487
|
|
|
1567
1488
|
interface ReactProps<P> {
|
|
@@ -1582,11 +1503,30 @@ type ThreeToJSXElements<T extends Record<string, any>> = {
|
|
|
1582
1503
|
[K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
|
|
1583
1504
|
}
|
|
1584
1505
|
|
|
1506
|
+
/** Method names of Object3D, excluded from the `primitive` element's typed props. */
|
|
1507
|
+
type Object3DMethod = NonNullable<
|
|
1508
|
+
{
|
|
1509
|
+
[K in keyof Object3D]-?: Object3D[K] extends (...args: any[]) => any ? K : never
|
|
1510
|
+
}[keyof Object3D]
|
|
1511
|
+
>
|
|
1512
|
+
|
|
1585
1513
|
type ThreeExports = typeof import('three')
|
|
1586
1514
|
type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
|
|
1587
1515
|
|
|
1588
1516
|
interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
|
|
1589
|
-
|
|
1517
|
+
/**
|
|
1518
|
+
* `primitive` wraps a pre-existing object, so its props cannot be derived from one class.
|
|
1519
|
+
* Events are typed from `EventHandlers` (`onClick={(e) => ...}` infers `e`), the ref is
|
|
1520
|
+
* untyped, and any other prop is accepted and applied to the object by name. Object3D's own
|
|
1521
|
+
* methods are left out of the typed surface: they return `this`, so a subclass element's
|
|
1522
|
+
* props (`ThreeElements['group']`) could not be spread onto a primitive otherwise.
|
|
1523
|
+
*/
|
|
1524
|
+
primitive: Omit<ThreeElement<typeof Object3D>, 'args' | 'object' | 'ref' | 'onUpdate' | Object3DMethod> & {
|
|
1525
|
+
object: object
|
|
1526
|
+
ref?: React.Ref<any>
|
|
1527
|
+
onUpdate?: (self: any) => void
|
|
1528
|
+
[prop: string]: unknown
|
|
1529
|
+
}
|
|
1590
1530
|
// Conflicts with DOM types can be accessed through a three* prefix
|
|
1591
1531
|
threeAudio: ThreeElementsImpl['audio']
|
|
1592
1532
|
threeSource: ThreeElementsImpl['source']
|
|
@@ -1627,6 +1567,7 @@ type three_d_Matrix3 = Matrix3;
|
|
|
1627
1567
|
type three_d_Matrix4 = Matrix4;
|
|
1628
1568
|
type three_d_MutableOrReadonlyParameters<T extends (...args: any) => any> = MutableOrReadonlyParameters<T>;
|
|
1629
1569
|
type three_d_NodeProps<P> = NodeProps<P>;
|
|
1570
|
+
type three_d_Object3DMethod = Object3DMethod;
|
|
1630
1571
|
type three_d_Quaternion = Quaternion;
|
|
1631
1572
|
type three_d_RaycastableRepresentation = RaycastableRepresentation;
|
|
1632
1573
|
type three_d_ReactProps<P> = ReactProps<P>;
|
|
@@ -1641,7 +1582,7 @@ type three_d_Vector3 = Vector3;
|
|
|
1641
1582
|
type three_d_Vector4 = Vector4;
|
|
1642
1583
|
type three_d_VectorRepresentation = VectorRepresentation;
|
|
1643
1584
|
declare namespace three_d {
|
|
1644
|
-
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 };
|
|
1585
|
+
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 };
|
|
1645
1586
|
}
|
|
1646
1587
|
|
|
1647
1588
|
/**
|
|
@@ -1990,7 +1931,7 @@ declare function createEvents(store: RootStore): {
|
|
|
1990
1931
|
processDeferredPointer: (event: DomEvent, pointerId: number) => void;
|
|
1991
1932
|
};
|
|
1992
1933
|
/** Default R3F event manager for web */
|
|
1993
|
-
declare function createPointerEvents(store: RootStore): EventManager<
|
|
1934
|
+
declare function createPointerEvents(store: RootStore): EventManager<Element>;
|
|
1994
1935
|
|
|
1995
1936
|
/**
|
|
1996
1937
|
* Gets or creates a memoized loader instance from a loader constructor or returns the loader if it's already an instance.
|
|
@@ -3387,6 +3328,7 @@ declare namespace ReactReconciler {
|
|
|
3387
3328
|
|
|
3388
3329
|
declare function extend<T extends ConstructorRepresentation>(objects: T): React$1.ExoticComponent<ThreeElement<T>>;
|
|
3389
3330
|
declare function extend<T extends Catalogue>(objects: T): void;
|
|
3331
|
+
declare function extend(objects: Record<string, unknown>): void;
|
|
3390
3332
|
declare const reconciler: ReactReconciler.Reconciler<RootStore, Instance<any>, void, Instance<any>, never, any>;
|
|
3391
3333
|
|
|
3392
3334
|
declare const isRenderer: (def: any) => boolean;
|
|
@@ -3830,29 +3772,44 @@ declare const hasConstructor: (object: unknown) => object is {
|
|
|
3830
3772
|
* Used to identify values that should be resolved from refs after mount.
|
|
3831
3773
|
*/
|
|
3832
3774
|
declare const FROM_REF: unique symbol;
|
|
3775
|
+
/** The marker `fromRef()` returns; resolved by the reconciler in `commitMount`. */
|
|
3776
|
+
interface FromRefMarker<T = unknown, R = T> {
|
|
3777
|
+
[FROM_REF]: React$1.RefObject<T | null>;
|
|
3778
|
+
/** Optional transform applied to the resolved ref before assignment. */
|
|
3779
|
+
transform?: (value: T) => R;
|
|
3780
|
+
}
|
|
3833
3781
|
/**
|
|
3834
3782
|
* Defers prop application until the referenced object is available.
|
|
3835
3783
|
* Useful for props like `target` that need sibling refs to be populated.
|
|
3836
3784
|
*
|
|
3785
|
+
* Only top-level props on a three element are resolved: a marker nested inside another value
|
|
3786
|
+
* (an array, an options object) is never seen. When the prop needs the sibling *wrapped* rather
|
|
3787
|
+
* than assigned as-is, pass a `transform`; it runs once the ref is populated and its result is
|
|
3788
|
+
* what gets assigned.
|
|
3789
|
+
*
|
|
3837
3790
|
* @param ref - React ref object to resolve at mount time
|
|
3838
|
-
* @
|
|
3791
|
+
* @param transform - Optional mapping from the resolved object to the value the prop expects
|
|
3792
|
+
* @returns A marker value that the reconciler resolves after mount
|
|
3839
3793
|
*
|
|
3840
3794
|
* @example
|
|
3841
3795
|
* const targetRef = useRef<THREE.Object3D>(null)
|
|
3842
3796
|
*
|
|
3843
3797
|
* <group ref={targetRef} position={[-3, -2, -15]} />
|
|
3844
3798
|
* <spotLight target={fromRef(targetRef)} intensity={100} />
|
|
3799
|
+
*
|
|
3800
|
+
* @example
|
|
3801
|
+
* // Wrap the sibling: a node material's lightsNode needs a LightsNode, not the light itself
|
|
3802
|
+
* <meshPhongNodeMaterial lightsNode={fromRef(lightRef, (light) => lights([light]))} />
|
|
3845
3803
|
*/
|
|
3846
3804
|
declare function fromRef<T>(ref: React$1.RefObject<T | null>): T;
|
|
3805
|
+
declare function fromRef<T, R>(ref: React$1.RefObject<T | null>, transform: (value: T) => R): R;
|
|
3847
3806
|
/**
|
|
3848
3807
|
* Type guard to check if a value is a fromRef marker.
|
|
3849
3808
|
*
|
|
3850
3809
|
* @param value - Value to check
|
|
3851
3810
|
* @returns True if value is a fromRef marker
|
|
3852
3811
|
*/
|
|
3853
|
-
declare function isFromRef(value: unknown): value is
|
|
3854
|
-
[FROM_REF]: React$1.RefObject<any>;
|
|
3855
|
-
};
|
|
3812
|
+
declare function isFromRef(value: unknown): value is FromRefMarker<any, unknown>;
|
|
3856
3813
|
|
|
3857
3814
|
/**
|
|
3858
3815
|
* Symbol marker for mount-only method calls.
|
|
@@ -3879,7 +3836,15 @@ declare const ONCE: unique symbol;
|
|
|
3879
3836
|
* // No arguments
|
|
3880
3837
|
* <geometry center={once()} />
|
|
3881
3838
|
*/
|
|
3882
|
-
declare function once<
|
|
3839
|
+
declare function once<A extends unknown[]>(...args: A): OnceValue<A>;
|
|
3840
|
+
/**
|
|
3841
|
+
* What `once(...args)` is typed as, so the marker is assignable to the prop it targets:
|
|
3842
|
+
* the single argument itself (`rotateX={once(angle)}`), the argument tuple for multi-argument
|
|
3843
|
+
* methods (`translate={once(x, y, z)}`), or `true` for a bare call (`center={once()}`).
|
|
3844
|
+
*
|
|
3845
|
+
* The runtime value is always the marker object; only the declared type follows the prop.
|
|
3846
|
+
*/
|
|
3847
|
+
type OnceValue<A extends unknown[]> = A extends [] ? true : A extends [infer Single] ? Single : A;
|
|
3883
3848
|
/**
|
|
3884
3849
|
* Type guard to check if a value is a once marker.
|
|
3885
3850
|
*
|
|
@@ -3897,4 +3862,4 @@ declare function isOnce(value: unknown): value is {
|
|
|
3897
3862
|
declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
|
|
3898
3863
|
|
|
3899
3864
|
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 };
|
|
3900
|
-
export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferLike, BufferRecord, BufferStore, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DisposeOptions, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, LegacyInternalState as InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeLike, NodeProps, NodeRecord, NodeStore, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, LegacyRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, LegacyRootState as RootState, RootStore, SetBlock, Size, StorageLike, StorageRecord, StorageStore, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };
|
|
3865
|
+
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, LegacyInternalState as 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, LegacyRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, LegacyRootState as RootState, RootStore, SetBlock, Size, StorageLike, StorageRecord, StorageStore, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };
|