@react-three/fiber 10.0.0-canary.da7a768 → 10.0.0-canary.dc0ec15
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/extension.cjs +278 -0
- package/dist/extension.d.cts +1675 -0
- package/dist/extension.d.mts +1675 -0
- package/dist/extension.d.ts +1647 -0
- package/dist/extension.mjs +258 -0
- package/dist/index.cjs +994 -898
- package/dist/index.d.cts +331 -155
- package/dist/index.d.mts +331 -155
- package/dist/index.d.ts +331 -183
- package/dist/index.mjs +995 -901
- package/dist/legacy.cjs +1345 -1245
- package/dist/legacy.d.cts +353 -205
- package/dist/legacy.d.mts +353 -205
- package/dist/legacy.d.ts +353 -231
- package/dist/legacy.mjs +1346 -1248
- package/dist/webgpu/index.cjs +908 -713
- package/dist/webgpu/index.d.cts +389 -212
- package/dist/webgpu/index.d.mts +389 -212
- package/dist/webgpu/index.d.ts +389 -240
- package/dist/webgpu/index.mjs +910 -717
- package/package.json +7 -2
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
|
|
|
@@ -491,6 +513,12 @@ interface InternalState {
|
|
|
491
513
|
actualRenderer: R3FRenderer
|
|
492
514
|
/** Global scheduler reference (for useFrame hook) */
|
|
493
515
|
scheduler: SchedulerApi | null
|
|
516
|
+
/**
|
|
517
|
+
* Replaces `renderer.render(scene, camera)` in the default render job when set. Set it with
|
|
518
|
+
* `setRenderOverride(store, fn)`; the job keeps its fps throttle, error handling and user
|
|
519
|
+
* render-phase takeover. Used by `useRenderPipeline`.
|
|
520
|
+
*/
|
|
521
|
+
renderOverride?: (() => void) | null
|
|
494
522
|
/** This root's unique ID in the global scheduler */
|
|
495
523
|
rootId?: string
|
|
496
524
|
/** Function to unregister this root from the global scheduler */
|
|
@@ -498,11 +526,28 @@ interface InternalState {
|
|
|
498
526
|
/** Container for child attachment (scene for root, original container for portals) */
|
|
499
527
|
container?: THREE$1.Object3D
|
|
500
528
|
/**
|
|
501
|
-
* CanvasTarget
|
|
502
|
-
*
|
|
529
|
+
* The CanvasTarget this root sizes and renders through.
|
|
530
|
+
*
|
|
531
|
+
* A primary (`<Canvas id>`) owns the renderer's default target -- the one three itself built
|
|
532
|
+
* around the canvas element -- so sizing it is sizing the renderer. A secondary owns a target
|
|
533
|
+
* R3F created for its own element. Either way there is exactly one target per canvas element,
|
|
534
|
+
* and the canvas-target job makes it the renderer's active one before this root renders.
|
|
535
|
+
* Absent on WebGL and on an id-less WebGPU canvas, where the renderer is sized directly.
|
|
503
536
|
* @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
|
|
504
537
|
*/
|
|
505
538
|
canvasTarget?: CanvasTarget
|
|
539
|
+
/**
|
|
540
|
+
* Set when this root's canvas target has been resized and the backend's cached render pass
|
|
541
|
+
* descriptor (which holds a depth-stencil view built once per canvas) is therefore stale.
|
|
542
|
+
*
|
|
543
|
+
* Flushed by the canvas-target job in the `start` phase, which is the only place this root's
|
|
544
|
+
* target is guaranteed to be the renderer's active one — `backend.updateSize()` operates on
|
|
545
|
+
* whatever `getCanvasTarget()` returns, so calling it from the resize subscription would
|
|
546
|
+
* invalidate some other canvas's descriptor instead.
|
|
547
|
+
*
|
|
548
|
+
* @see https://github.com/pmndrs/react-three-fiber/issues/3847
|
|
549
|
+
*/
|
|
550
|
+
canvasTargetSizeDirty?: boolean
|
|
506
551
|
/**
|
|
507
552
|
* Whether multi-canvas rendering is active.
|
|
508
553
|
* True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
|
|
@@ -612,7 +657,7 @@ interface RootState {
|
|
|
612
657
|
/** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
|
|
613
658
|
uniforms: UniformStore
|
|
614
659
|
/** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
|
|
615
|
-
nodes:
|
|
660
|
+
nodes: NodeStore
|
|
616
661
|
/** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
|
|
617
662
|
buffers: BufferStore
|
|
618
663
|
/** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
|
|
@@ -624,7 +669,7 @@ interface RootState {
|
|
|
624
669
|
/** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
|
|
625
670
|
renderPipeline: ThreeRenderPipeline | null
|
|
626
671
|
/** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
|
|
627
|
-
passes:
|
|
672
|
+
passes: PassRecord
|
|
628
673
|
/** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
|
|
629
674
|
_hmrVersion: number
|
|
630
675
|
/** Internal: whether setSize() has taken ownership of canvas dimensions */
|
|
@@ -712,12 +757,19 @@ type DefaultRendererProps = {
|
|
|
712
757
|
*/
|
|
713
758
|
interface CanvasSchedulerConfig {
|
|
714
759
|
/**
|
|
715
|
-
*
|
|
716
|
-
* Pass the `id` of another canvas.
|
|
760
|
+
* Run this Canvas root before the referenced Canvas root id(s).
|
|
717
761
|
*/
|
|
718
|
-
|
|
762
|
+
before?: string | string[]
|
|
719
763
|
/**
|
|
720
|
-
*
|
|
764
|
+
* Run this Canvas root after the referenced Canvas root id(s).
|
|
765
|
+
*/
|
|
766
|
+
after?: string | string[]
|
|
767
|
+
/**
|
|
768
|
+
* Numeric root order. Lower values run first.
|
|
769
|
+
*/
|
|
770
|
+
order?: number
|
|
771
|
+
/**
|
|
772
|
+
* Limit this Canvas's default render job (frames per second).
|
|
721
773
|
*/
|
|
722
774
|
fps?: number
|
|
723
775
|
}
|
|
@@ -804,14 +856,17 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
|
|
|
804
856
|
performance?: Partial<Omit<Performance, 'regress'>>
|
|
805
857
|
/** Target pixel ratio. Can clamp between a range: `[min, max]` */
|
|
806
858
|
dpr?: Dpr
|
|
807
|
-
/**
|
|
808
|
-
|
|
859
|
+
/**
|
|
860
|
+
* Props that go into the default raycaster. `params` is merged into the raycaster's defaults,
|
|
861
|
+
* so a single threshold can be set: `raycaster={{ params: { Points: { threshold: 0.2 } } }}`.
|
|
862
|
+
*/
|
|
863
|
+
raycaster?: Partial<Omit<THREE$1.Raycaster, 'params'>> & { params?: Partial<THREE$1.RaycasterParameters> }
|
|
809
864
|
/** A `THREE.Scene` instance or props that go into the default scene */
|
|
810
865
|
scene?: THREE$1.Scene | Partial<THREE$1.Scene>
|
|
811
866
|
/** A `THREE.Camera` instance or props that go into the default camera */
|
|
812
867
|
camera?: CameraProps
|
|
813
868
|
/** An R3F event manager to manage elements' pointer events */
|
|
814
|
-
events?: (store: RootStore) => EventManager<
|
|
869
|
+
events?: (store: RootStore) => EventManager<Element>
|
|
815
870
|
/** Callback after the canvas has rendered (but not yet committed) */
|
|
816
871
|
onCreated?: (state: RootState) => void
|
|
817
872
|
/** Response for pointer clicks that have missed any target */
|
|
@@ -900,7 +955,6 @@ type InstanceProps<T = any, P = any> = ArgsProp<P> & {
|
|
|
900
955
|
object?: T
|
|
901
956
|
dispose?: null
|
|
902
957
|
attach?: AttachType<T>
|
|
903
|
-
onUpdate?: (self: T) => void
|
|
904
958
|
}
|
|
905
959
|
|
|
906
960
|
interface Instance<O = any> {
|
|
@@ -1040,7 +1094,7 @@ interface CanvasProps
|
|
|
1040
1094
|
*/
|
|
1041
1095
|
resize?: Options
|
|
1042
1096
|
/** The target where events are being subscribed to, default: the div that wraps canvas */
|
|
1043
|
-
eventSource?:
|
|
1097
|
+
eventSource?: Element | React$1.RefObject<Element | null>
|
|
1044
1098
|
/** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
|
|
1045
1099
|
eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
|
|
1046
1100
|
/** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
|
|
@@ -1148,81 +1202,86 @@ interface LegacyRootState extends Omit<RootState, 'renderer' | 'internal'> {
|
|
|
1148
1202
|
|
|
1149
1203
|
type RenderTargetOptions = RenderTargetOptions$1
|
|
1150
1204
|
|
|
1151
|
-
//* Global Types ==============================
|
|
1205
|
+
//* Global TSL Types ==============================
|
|
1152
1206
|
|
|
1153
1207
|
declare global {
|
|
1154
1208
|
/**
|
|
1155
|
-
*
|
|
1156
|
-
*
|
|
1157
|
-
* This is three's own `UniformNode`, not a re-declaration of it. It previously was a
|
|
1158
|
-
* hand-rolled `interface UniformNode<T> extends Node { value: T }`, which shadowed the real
|
|
1159
|
-
* exported type globally — so R3F's ~58 references resolved to an approximation that was
|
|
1160
|
-
* missing members three actually ships (`setName` among them) and had drifted to the wrong
|
|
1161
|
-
* arity when three made `UniformNode` two-parameter.
|
|
1162
|
-
*
|
|
1163
|
-
* three's signature is `UniformNode<TNodeType, TValue>`. R3F only ever varies the value type,
|
|
1164
|
-
* so the node type is fixed to `unknown` and the single parameter is kept for call-site
|
|
1165
|
-
* ergonomics. The result is three's structural type, so members stay in sync with the
|
|
1166
|
-
* installed three instead of needing to be mirrored by hand.
|
|
1209
|
+
* Broad callable-node fallback for dynamic store readers.
|
|
1210
|
+
* Creator hooks preserve the exact function signatures inferred from Three's `Fn`.
|
|
1167
1211
|
*/
|
|
1168
|
-
type
|
|
1212
|
+
type CallableTSLNode = ((...params: never[]) => unknown) & {
|
|
1213
|
+
readonly shaderNode: unknown
|
|
1214
|
+
readonly id: number
|
|
1215
|
+
}
|
|
1169
1216
|
|
|
1170
|
-
/**
|
|
1171
|
-
|
|
1172
|
-
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
* @example
|
|
1176
|
-
* ```tsx
|
|
1177
|
-
* // Define a shader function
|
|
1178
|
-
* const blendColorFn = Fn(([color1, color2, factor]) => {
|
|
1179
|
-
* return mix(color1, color2, factor)
|
|
1180
|
-
* })
|
|
1181
|
-
*
|
|
1182
|
-
* // Type when retrieving from nodes store
|
|
1183
|
-
* const { blendColorFn } = nodes as { blendColorFn: ShaderCallable }
|
|
1184
|
-
*
|
|
1185
|
-
* // Or with specific return type
|
|
1186
|
-
* const { myFn } = nodes as { myFn: ShaderCallable<THREE.Node> }
|
|
1187
|
-
* ```
|
|
1188
|
-
*/
|
|
1189
|
-
type ShaderCallable<R extends Node = Node> = ((...params: unknown[]) => ShaderNodeObject<R>) & Node
|
|
1217
|
+
/** Legacy structural node accepted when at least one historical marker exists. */
|
|
1218
|
+
type LegacyTSLNodeLike = {
|
|
1219
|
+
label?: ((label: string) => unknown) | string
|
|
1220
|
+
setName?: (name: string) => unknown
|
|
1221
|
+
} & ({ uuid: string | undefined; nodeType?: string | null } | { uuid?: string; nodeType: string | null | undefined })
|
|
1190
1222
|
|
|
1191
|
-
/**
|
|
1192
|
-
|
|
1193
|
-
* This is the common return type for TSL operations (add, mul, sin, etc.)
|
|
1194
|
-
*
|
|
1195
|
-
* @example
|
|
1196
|
-
* ```tsx
|
|
1197
|
-
* const { wobble } = nodes as { wobble: ShaderNodeRef }
|
|
1198
|
-
* ```
|
|
1199
|
-
*/
|
|
1200
|
-
type ShaderNodeRef<T extends Node = Node> = ShaderNodeObject<T>
|
|
1223
|
+
/** Node type accepted by broad dynamic node-store readers. */
|
|
1224
|
+
type TSLNodeType = three_webgpu.Node | CallableTSLNode
|
|
1201
1225
|
|
|
1202
1226
|
/**
|
|
1203
|
-
*
|
|
1204
|
-
*
|
|
1205
|
-
*
|
|
1206
|
-
*
|
|
1207
|
-
* - Node: base Three.js node type
|
|
1208
|
-
* - ShaderCallable: function nodes created with Fn()
|
|
1209
|
-
* - ShaderNodeObject: wrapped nodes from TSL operations (sin, mul, mix, etc.)
|
|
1210
|
-
*
|
|
1211
|
-
* @example
|
|
1212
|
-
* ```tsx
|
|
1213
|
-
* // In useLocalNodes, nodes are typed as TSLNodeType
|
|
1214
|
-
* const { positionNode, blendColorFn } = useLocalNodes(({ nodes }) => ({
|
|
1215
|
-
* positionNode: nodes.myPosition, // Works - Node is in union
|
|
1216
|
-
* blendColorFn: nodes.myFn, // Works - ShaderCallable is in union
|
|
1217
|
-
* }))
|
|
1218
|
-
*
|
|
1219
|
-
* // Can narrow with type guard or assertion when needed
|
|
1220
|
-
* if (typeof blendColorFn === 'function') {
|
|
1221
|
-
* blendColorFn(someColor, 0.5)
|
|
1222
|
-
* }
|
|
1223
|
-
* ```
|
|
1227
|
+
* Derive Three's shader node type from an existing node or a supported raw input.
|
|
1228
|
+
* Existing InputNode generics take precedence over structural value normalization.
|
|
1229
|
+
* Both generics must be inferred because Three's UniformNode intersects an unknown-typed
|
|
1230
|
+
* InputNode base with its concrete InputNode specialization.
|
|
1224
1231
|
*/
|
|
1225
|
-
type
|
|
1232
|
+
type UniformNodeType<T> = T extends three_webgpu.UniformNode<infer TNodeType, infer _TValue>
|
|
1233
|
+
? TNodeType
|
|
1234
|
+
: T extends three_webgpu.InputNode<infer TNodeType, infer _TValue>
|
|
1235
|
+
? TNodeType
|
|
1236
|
+
: T extends number
|
|
1237
|
+
? 'float'
|
|
1238
|
+
: T extends boolean
|
|
1239
|
+
? 'bool'
|
|
1240
|
+
: T extends string | three_webgpu.Color | { r: number; g: number; b: number }
|
|
1241
|
+
? 'color'
|
|
1242
|
+
: T extends three_webgpu.Vector4 | { x: number; y: number; z: number; w: number }
|
|
1243
|
+
? 'vec4'
|
|
1244
|
+
: T extends three_webgpu.Vector3 | { x: number; y: number; z: number }
|
|
1245
|
+
? 'vec3'
|
|
1246
|
+
: T extends three_webgpu.Vector2 | { x: number; y: number }
|
|
1247
|
+
? 'vec2'
|
|
1248
|
+
: T extends three_webgpu.Matrix4
|
|
1249
|
+
? 'mat4'
|
|
1250
|
+
: T extends three_webgpu.Matrix3
|
|
1251
|
+
? 'mat3'
|
|
1252
|
+
: T extends three_webgpu.Matrix2
|
|
1253
|
+
? 'mat2'
|
|
1254
|
+
: unknown
|
|
1255
|
+
|
|
1256
|
+
/** Derive the normalized JavaScript value stored by a uniform node. */
|
|
1257
|
+
type UniformNodeValue<T> = T extends three_webgpu.UniformNode<infer _TNodeType, infer TValue>
|
|
1258
|
+
? TValue
|
|
1259
|
+
: T extends three_webgpu.InputNode<infer _TNodeType, infer TValue>
|
|
1260
|
+
? TValue
|
|
1261
|
+
: T extends string | { r: number; g: number; b: number }
|
|
1262
|
+
? three_webgpu.Color
|
|
1263
|
+
: T extends { x: number; y: number; z: number; w: number }
|
|
1264
|
+
? three_webgpu.Vector4
|
|
1265
|
+
: T extends { x: number; y: number; z: number }
|
|
1266
|
+
? three_webgpu.Vector3
|
|
1267
|
+
: T extends { x: number; y: number }
|
|
1268
|
+
? three_webgpu.Vector2
|
|
1269
|
+
: T extends number
|
|
1270
|
+
? number
|
|
1271
|
+
: T extends boolean
|
|
1272
|
+
? boolean
|
|
1273
|
+
: T
|
|
1274
|
+
|
|
1275
|
+
/** Three's exact UniformNode with shader and value generics derived from an input. */
|
|
1276
|
+
type UniformNodeFor<T> = three_webgpu.UniformNode<UniformNodeType<T>, UniformNodeValue<T>>
|
|
1277
|
+
|
|
1278
|
+
/** Preserve every input key while mapping values to exact Three uniform nodes. */
|
|
1279
|
+
type UniformNodesFor<T extends UniformInputRecord> = {
|
|
1280
|
+
[K in keyof T]: UniformNodeFor<T[K]>
|
|
1281
|
+
}
|
|
1282
|
+
|
|
1283
|
+
/** Backward-compatible single-parameter uniform alias. */
|
|
1284
|
+
type UniformNode<T = unknown> = UniformNodeFor<T>
|
|
1226
1285
|
|
|
1227
1286
|
/** Flat record of uniform nodes (no nested scopes) */
|
|
1228
1287
|
type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
|
|
@@ -1247,7 +1306,7 @@ declare global {
|
|
|
1247
1306
|
* Acceptable input values for useUniforms - raw values that get converted to UniformNodes
|
|
1248
1307
|
* Supports:
|
|
1249
1308
|
* - Primitives: number, string (color), boolean
|
|
1250
|
-
* - Three.js types: Color, Vector2/3/4,
|
|
1309
|
+
* - Three.js types: Color, Vector2/3/4, Matrix2/3/4
|
|
1251
1310
|
* - Plain objects: { x, y, z, w } converted to vectors
|
|
1252
1311
|
* - TSL nodes: color(), vec3(), float() for type casting
|
|
1253
1312
|
* - UniformNode: existing uniforms (reused as-is)
|
|
@@ -1260,88 +1319,124 @@ declare global {
|
|
|
1260
1319
|
| three_webgpu.Vector2
|
|
1261
1320
|
| three_webgpu.Vector3
|
|
1262
1321
|
| three_webgpu.Vector4
|
|
1322
|
+
| three_webgpu.Matrix2
|
|
1263
1323
|
| three_webgpu.Matrix3
|
|
1264
1324
|
| three_webgpu.Matrix4
|
|
1265
|
-
|
|
|
1266
|
-
|
|
|
1267
|
-
| { x: number; y
|
|
1325
|
+
| { x: number; y: number }
|
|
1326
|
+
| { x: number; y: number; z: number }
|
|
1327
|
+
| { x: number; y: number; z: number; w: number }
|
|
1268
1328
|
| { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
|
|
1269
|
-
| Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1329
|
+
| three_webgpu.Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1270
1330
|
| UniformNode
|
|
1271
1331
|
|
|
1272
1332
|
/** Input record for useUniforms - accepts raw values or UniformNodes */
|
|
1273
1333
|
type UniformInputRecord = Record<string, UniformValue>
|
|
1274
1334
|
}
|
|
1275
1335
|
|
|
1276
|
-
|
|
1277
|
-
|
|
1278
|
-
declare module 'three/tsl' {
|
|
1336
|
+
declare global {
|
|
1279
1337
|
/**
|
|
1280
|
-
*
|
|
1281
|
-
*
|
|
1338
|
+
* three's own render pipeline type. Named here so the rest of R3F refers to three's shape
|
|
1339
|
+
* rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
|
|
1340
|
+
* is r185, so the new name is the only one.
|
|
1282
1341
|
*/
|
|
1283
|
-
|
|
1284
|
-
jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
|
|
1285
|
-
): ShaderCallable<R>
|
|
1342
|
+
type ThreeRenderPipeline = three_webgpu.RenderPipeline
|
|
1286
1343
|
|
|
1287
1344
|
/**
|
|
1288
|
-
*
|
|
1289
|
-
*
|
|
1345
|
+
* The pass `useRenderPipeline` creates for you: three's own `PassNode`, as returned by
|
|
1346
|
+
* `pass(scene, camera)` from `three/tsl`. Referenced from three so members like
|
|
1347
|
+
* `getTextureNode`, `setMRT` and `dispose` track the installed version.
|
|
1290
1348
|
*/
|
|
1291
|
-
|
|
1292
|
-
jsFunc: (inputs: T) => ShaderNodeObject<R>,
|
|
1293
|
-
): ShaderCallable<R>
|
|
1349
|
+
type ScenePassNode = three_webgpu.PassNode
|
|
1294
1350
|
|
|
1295
1351
|
/**
|
|
1296
|
-
*
|
|
1297
|
-
*
|
|
1352
|
+
* Pass record - stores TSL pass nodes for render pipeline.
|
|
1353
|
+
*
|
|
1354
|
+
* `scenePass` is the only key the library owns. It is optional here because this is also the
|
|
1355
|
+
* shape of `state.passes`, which is `{}` before the pipeline exists and again after `reset()`
|
|
1356
|
+
* or `clearPasses()`. Inside the callbacks it is always present; see
|
|
1357
|
+
* {@link RenderPipelineCallbackState}.
|
|
1358
|
+
*
|
|
1359
|
+
* Every other key is user-registered, via a callback's return value. Those are TSL nodes of
|
|
1360
|
+
* any kind, not only passes: texture reads of an MRT attachment, effect nodes, extra
|
|
1361
|
+
* `pass()` instances. `Node` is the common base, so that is the bound. Narrow at the call
|
|
1362
|
+
* site when you need a member, e.g. `passes.velocity as TextureNode`.
|
|
1363
|
+
*
|
|
1364
|
+
* The index signature admits `undefined` because a key may simply not be registered, and
|
|
1365
|
+
* because the optional `scenePass` must be assignable to it: under `skipLibCheck: false` an
|
|
1366
|
+
* optional property whose type excludes `undefined` from the index signature is an error
|
|
1367
|
+
* (TS2411) for every consumer compiling these declarations.
|
|
1298
1368
|
*/
|
|
1299
|
-
|
|
1300
|
-
|
|
1301
|
-
|
|
1302
|
-
|
|
1369
|
+
interface PassRecord {
|
|
1370
|
+
scenePass?: ScenePassNode
|
|
1371
|
+
[key: string]: three_webgpu.Node | undefined
|
|
1372
|
+
}
|
|
1303
1373
|
|
|
1304
1374
|
/**
|
|
1305
|
-
*
|
|
1375
|
+
* State passed to pipeline callbacks after the active pipeline has been created.
|
|
1376
|
+
*
|
|
1377
|
+
* `passes.scenePass` is required here: the hook installs the default scene pass before either
|
|
1378
|
+
* callback runs, so callbacks can use it without a guard or a cast.
|
|
1379
|
+
*
|
|
1380
|
+
* `renderer` is narrowed to `WebGPURenderer` and `isLegacy` to `false`: the hook throws under
|
|
1381
|
+
* the legacy renderer before either callback can run, so a callback never sees WebGL.
|
|
1306
1382
|
*/
|
|
1307
|
-
|
|
1308
|
-
|
|
1309
|
-
|
|
1310
|
-
|
|
1311
|
-
|
|
1383
|
+
type RenderPipelineCallbackState = RootState & {
|
|
1384
|
+
renderPipeline: ThreeRenderPipeline
|
|
1385
|
+
passes: PassRecord & { scenePass: ScenePassNode }
|
|
1386
|
+
renderer: three_webgpu.WebGPURenderer
|
|
1387
|
+
isLegacy: false
|
|
1388
|
+
}
|
|
1312
1389
|
|
|
1313
|
-
declare global {
|
|
1314
1390
|
/**
|
|
1315
|
-
*
|
|
1316
|
-
*
|
|
1317
|
-
* is
|
|
1391
|
+
* What a callback may return to register entries into `state.passes`.
|
|
1392
|
+
*
|
|
1393
|
+
* `scenePass` is reserved. The hook owns that entry and its lifecycle: it caches the pass it
|
|
1394
|
+
* created, and `rebuild()` / `reset()` dispose that cached pass. A callback overwriting the
|
|
1395
|
+
* store entry would leave the store pointing at a node the hook never disposes, and the hook
|
|
1396
|
+
* disposing a pass nothing references. So returning it is a type error.
|
|
1318
1397
|
*/
|
|
1319
|
-
type
|
|
1320
|
-
|
|
1321
|
-
/** Pass record - stores TSL pass nodes for render pipeline */
|
|
1322
|
-
type PassRecord = Record<string, any>
|
|
1398
|
+
type RegisteredPasses = Record<string, three_webgpu.Node> & { scenePass?: never }
|
|
1323
1399
|
|
|
1324
1400
|
/** Setup callback - runs first to configure MRT, create additional passes */
|
|
1325
|
-
type RenderPipelineSetupCallback = (state:
|
|
1401
|
+
type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1326
1402
|
|
|
1327
1403
|
/** Main callback - runs second to configure outputNode, create effect passes */
|
|
1328
|
-
type RenderPipelineMainCallback = (state:
|
|
1404
|
+
type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1329
1405
|
|
|
1330
|
-
/**
|
|
1331
|
-
interface
|
|
1406
|
+
/** The imperative half of useRenderPipeline's return value, present in every state */
|
|
1407
|
+
interface UseRenderPipelineActions {
|
|
1332
1408
|
/** Current passes from state */
|
|
1333
1409
|
passes: PassRecord
|
|
1334
|
-
/** RenderPipeline instance (null if not initialized) */
|
|
1335
|
-
renderPipeline: ThreeRenderPipeline | null
|
|
1336
1410
|
/** Clear all passes from state */
|
|
1337
1411
|
clearPasses: () => void
|
|
1338
1412
|
/** Reset RenderPipeline entirely (clears PP + passes) */
|
|
1339
1413
|
reset: () => void
|
|
1340
1414
|
/** Re-run setup/main callbacks with current closure values */
|
|
1341
1415
|
rebuild: () => void
|
|
1342
|
-
/** True when RenderPipeline is configured and ready */
|
|
1343
|
-
isReady: boolean
|
|
1344
1416
|
}
|
|
1417
|
+
|
|
1418
|
+
/**
|
|
1419
|
+
* Return type for useRenderPipeline hook, discriminated on `isReady`.
|
|
1420
|
+
*
|
|
1421
|
+
* `if (isReady)` narrows `renderPipeline` to non-null, which is what the docs already tell
|
|
1422
|
+
* callers to check. `passes.scenePass` deliberately stays optional in the ready branch:
|
|
1423
|
+
* `clearPasses()` empties the record while leaving the pipeline in place.
|
|
1424
|
+
*/
|
|
1425
|
+
type UseRenderPipelineReturn = UseRenderPipelineActions &
|
|
1426
|
+
(
|
|
1427
|
+
| {
|
|
1428
|
+
/** True when RenderPipeline is configured and ready */
|
|
1429
|
+
isReady: true
|
|
1430
|
+
/** RenderPipeline instance */
|
|
1431
|
+
renderPipeline: ThreeRenderPipeline
|
|
1432
|
+
}
|
|
1433
|
+
| {
|
|
1434
|
+
/** False until the pipeline has been created */
|
|
1435
|
+
isReady: false
|
|
1436
|
+
/** Not initialized yet, or torn down by reset() */
|
|
1437
|
+
renderPipeline: null
|
|
1438
|
+
}
|
|
1439
|
+
)
|
|
1345
1440
|
}
|
|
1346
1441
|
|
|
1347
1442
|
type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
|
|
@@ -1420,10 +1515,11 @@ type TSLNodeInput = { nodeType?: string | null; uuid?: string } | null
|
|
|
1420
1515
|
|
|
1421
1516
|
/**
|
|
1422
1517
|
* For node material properties (colorNode, positionNode, etc.), accept broader types
|
|
1423
|
-
* since @types/three has broken inheritance for TSL node subclasses.
|
|
1518
|
+
* since @types/three has broken inheritance for TSL node subclasses. NodeClass requires
|
|
1519
|
+
* `nodeType`, so this structural key test remains neutral to the selected Three entry.
|
|
1424
1520
|
*/
|
|
1425
1521
|
type NodeProps<P> = {
|
|
1426
|
-
[K in keyof P as P[K] extends
|
|
1522
|
+
[K in keyof P as NonNullable<P[K]> extends { nodeType: string | null } ? K : never]?: TSLNodeInput
|
|
1427
1523
|
}
|
|
1428
1524
|
|
|
1429
1525
|
interface ReactProps<P> {
|
|
@@ -1444,11 +1540,29 @@ type ThreeToJSXElements<T extends Record<string, any>> = {
|
|
|
1444
1540
|
[K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
|
|
1445
1541
|
}
|
|
1446
1542
|
|
|
1543
|
+
/** Method names of Object3D, excluded from the `primitive` element's typed props. */
|
|
1544
|
+
type Object3DMethod = NonNullable<
|
|
1545
|
+
{
|
|
1546
|
+
[K in keyof Object3D]-?: Object3D[K] extends (...args: any[]) => any ? K : never
|
|
1547
|
+
}[keyof Object3D]
|
|
1548
|
+
>
|
|
1549
|
+
|
|
1447
1550
|
type ThreeExports = typeof THREE
|
|
1448
1551
|
type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
|
|
1449
1552
|
|
|
1450
1553
|
interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
|
|
1451
|
-
|
|
1554
|
+
/**
|
|
1555
|
+
* `primitive` wraps a pre-existing object, so its props cannot be derived from one class.
|
|
1556
|
+
* Events are typed from `EventHandlers` (`onClick={(e) => ...}` infers `e`), the ref is
|
|
1557
|
+
* untyped, and any other prop is accepted and applied to the object by name. Object3D's own
|
|
1558
|
+
* methods are left out of the typed surface: they return `this`, so a subclass element's
|
|
1559
|
+
* props (`ThreeElements['group']`) could not be spread onto a primitive otherwise.
|
|
1560
|
+
*/
|
|
1561
|
+
primitive: Omit<ThreeElement<typeof Object3D>, 'args' | 'object' | 'ref' | Object3DMethod> & {
|
|
1562
|
+
object: object
|
|
1563
|
+
ref?: React.Ref<any>
|
|
1564
|
+
[prop: string]: unknown
|
|
1565
|
+
}
|
|
1452
1566
|
// Conflicts with DOM types can be accessed through a three* prefix
|
|
1453
1567
|
threeAudio: ThreeElementsImpl['audio']
|
|
1454
1568
|
threeSource: ThreeElementsImpl['source']
|
|
@@ -1489,6 +1603,7 @@ type three_d_Matrix3 = Matrix3;
|
|
|
1489
1603
|
type three_d_Matrix4 = Matrix4;
|
|
1490
1604
|
type three_d_MutableOrReadonlyParameters<T extends (...args: any) => any> = MutableOrReadonlyParameters<T>;
|
|
1491
1605
|
type three_d_NodeProps<P> = NodeProps<P>;
|
|
1606
|
+
type three_d_Object3DMethod = Object3DMethod;
|
|
1492
1607
|
type three_d_Quaternion = Quaternion;
|
|
1493
1608
|
type three_d_RaycastableRepresentation = RaycastableRepresentation;
|
|
1494
1609
|
type three_d_ReactProps<P> = ReactProps<P>;
|
|
@@ -1503,7 +1618,7 @@ type three_d_Vector3 = Vector3;
|
|
|
1503
1618
|
type three_d_Vector4 = Vector4;
|
|
1504
1619
|
type three_d_VectorRepresentation = VectorRepresentation;
|
|
1505
1620
|
declare namespace three_d {
|
|
1506
|
-
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 };
|
|
1621
|
+
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 };
|
|
1507
1622
|
}
|
|
1508
1623
|
|
|
1509
1624
|
/**
|
|
@@ -1852,7 +1967,43 @@ declare function createEvents(store: RootStore): {
|
|
|
1852
1967
|
processDeferredPointer: (event: DomEvent, pointerId: number) => void;
|
|
1853
1968
|
};
|
|
1854
1969
|
/** Default R3F event manager for web */
|
|
1855
|
-
declare function createPointerEvents(store: RootStore): EventManager<
|
|
1970
|
+
declare function createPointerEvents(store: RootStore): EventManager<Element>;
|
|
1971
|
+
|
|
1972
|
+
interface RootExtension {
|
|
1973
|
+
/** Unique name. Registering the same name again replaces the entry (HMR-safe); roots it already
|
|
1974
|
+
* set up are not set up a second time, but get the new entry's dispose and hmr. */
|
|
1975
|
+
name: string;
|
|
1976
|
+
/**
|
|
1977
|
+
* Called once per root, after its renderer exists and before `onCreated` and the first frame.
|
|
1978
|
+
* `isLegacy` and `primaryStore` are known by then, so an extension can skip WebGL roots or defer
|
|
1979
|
+
* to the primary canvas. Return fields to merge into the root's state, or nothing.
|
|
1980
|
+
*/
|
|
1981
|
+
setup?(store: RootStore): Partial<RootState> | void;
|
|
1982
|
+
/** Called when a root this extension set up unmounts. */
|
|
1983
|
+
dispose?(store: RootStore): void;
|
|
1984
|
+
/** Called when `<Canvas>` detects hot module replacement (skipped with `hmr={false}`). */
|
|
1985
|
+
hmr?(store: RootStore): void;
|
|
1986
|
+
}
|
|
1987
|
+
/**
|
|
1988
|
+
* Register an extension. It is set up on every live root immediately, and on every root created
|
|
1989
|
+
* afterwards. Returns a function that unregisters it: new roots are no longer set up, while roots
|
|
1990
|
+
* it already set up keep its state and still get its dispose when they unmount.
|
|
1991
|
+
*/
|
|
1992
|
+
declare function registerRootExtension(extension: RootExtension): () => void;
|
|
1993
|
+
/**
|
|
1994
|
+
* Point a root's default render job at a different render function, or back at
|
|
1995
|
+
* `renderer.render(scene, camera)` with `null`.
|
|
1996
|
+
*
|
|
1997
|
+
* The default job keeps everything else: the Canvas `fps` throttle, error propagation to the error
|
|
1998
|
+
* boundary, and backing off when a user `useFrame(..., { phase: 'render' })` job takes over.
|
|
1999
|
+
*/
|
|
2000
|
+
declare function setRenderOverride(store: RootStore, render: (() => void) | null): void;
|
|
2001
|
+
|
|
2002
|
+
/**
|
|
2003
|
+
* Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
|
|
2004
|
+
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
|
|
2005
|
+
*/
|
|
2006
|
+
declare function useStore(): RootStore;
|
|
1856
2007
|
|
|
1857
2008
|
/**
|
|
1858
2009
|
* Gets or creates a memoized loader instance from a loader constructor or returns the loader if it's already an instance.
|
|
@@ -2052,11 +2203,6 @@ declare function useRenderTarget(options?: RenderTargetOptions): RenderTarget;
|
|
|
2052
2203
|
declare function useRenderTarget(size: number, options?: RenderTargetOptions): RenderTarget;
|
|
2053
2204
|
declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): RenderTarget;
|
|
2054
2205
|
|
|
2055
|
-
/**
|
|
2056
|
-
* Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
|
|
2057
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
|
|
2058
|
-
*/
|
|
2059
|
-
declare function useStore(): RootStore;
|
|
2060
2206
|
/**
|
|
2061
2207
|
* Exposes an object's {@link Instance}.
|
|
2062
2208
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#useInstanceHandle
|
|
@@ -2132,7 +2278,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
|
|
|
2132
2278
|
* Invalidates the view, requesting a frame to be rendered.
|
|
2133
2279
|
* In demand mode, this triggers the scheduler to run frames.
|
|
2134
2280
|
*
|
|
2135
|
-
*
|
|
2281
|
+
* With a state argument, only that root's jobs run on the requested frames; other
|
|
2282
|
+
* roots on 'demand' stay idle. Without one, every registered root is invalidated.
|
|
2283
|
+
*
|
|
2284
|
+
* @param state - Optional root state; targets the invalidation at that root
|
|
2136
2285
|
* @param frames - Number of frames to request (default: 1)
|
|
2137
2286
|
* @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
|
|
2138
2287
|
*
|
|
@@ -2143,14 +2292,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
|
|
|
2143
2292
|
* Advances the frameloop and runs render effects.
|
|
2144
2293
|
* Useful for when manually rendering via `frameloop="never"`.
|
|
2145
2294
|
*
|
|
2295
|
+
* With a state argument, only that root is stepped. Without one, every
|
|
2296
|
+
* registered root is stepped for backwards compatibility.
|
|
2297
|
+
*
|
|
2146
2298
|
* @param timestamp - The timestamp to use for this frame
|
|
2147
2299
|
* @param runGlobalEffects - Ignored (kept for backwards compat, global effects always run)
|
|
2148
|
-
* @param state -
|
|
2149
|
-
* @param frame - Ignored (kept for backwards compat)
|
|
2300
|
+
* @param state - Optional root state; targets the manual step at that root
|
|
2150
2301
|
*
|
|
2151
2302
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
|
|
2152
2303
|
*/
|
|
2153
|
-
declare function advance(timestamp: number): void;
|
|
2304
|
+
declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
|
|
2154
2305
|
|
|
2155
2306
|
/* eslint-disable @definitelytyped/no-unnecessary-generics */
|
|
2156
2307
|
declare function ReactReconciler<
|
|
@@ -3195,6 +3346,7 @@ declare namespace ReactReconciler {
|
|
|
3195
3346
|
|
|
3196
3347
|
declare function extend<T extends ConstructorRepresentation>(objects: T): React$1.ExoticComponent<ThreeElement<T>>;
|
|
3197
3348
|
declare function extend<T extends Catalogue>(objects: T): void;
|
|
3349
|
+
declare function extend(objects: Record<string, unknown>): void;
|
|
3198
3350
|
declare const reconciler: ReactReconciler.Reconciler<RootStore, Instance<any>, void, Instance<any>, never, any>;
|
|
3199
3351
|
|
|
3200
3352
|
declare const isRenderer: (def: any) => boolean;
|
|
@@ -3219,6 +3371,7 @@ declare function Portal({ children, container, state }: PortalProps): JSX.Elemen
|
|
|
3219
3371
|
declare function flushSync<R>(fn: () => R): R;
|
|
3220
3372
|
|
|
3221
3373
|
declare const context: React$1.Context<RootStore>;
|
|
3374
|
+
|
|
3222
3375
|
declare const createStore: (invalidate: (state?: RootState, frames?: number, stackFrames?: boolean) => void, advance: (timestamp: number, runGlobalEffects?: boolean, state?: RootState, frame?: XRFrame) => void) => RootStore;
|
|
3223
3376
|
|
|
3224
3377
|
/**
|
|
@@ -3472,7 +3625,7 @@ declare function getInstanceProps<T = any>(pendingProps: Record<string, unknown>
|
|
|
3472
3625
|
declare function prepare<T = any>(target: T, root: RootStore, type: string, props: Instance<T>['props']): Instance<T>;
|
|
3473
3626
|
/**
|
|
3474
3627
|
* Triggers an update for an instance.
|
|
3475
|
-
*
|
|
3628
|
+
* Invalidates the frame if the root is in demand mode.
|
|
3476
3629
|
*
|
|
3477
3630
|
* @param instance - Instance to invalidate
|
|
3478
3631
|
*/
|
|
@@ -3638,29 +3791,44 @@ declare const hasConstructor: (object: unknown) => object is {
|
|
|
3638
3791
|
* Used to identify values that should be resolved from refs after mount.
|
|
3639
3792
|
*/
|
|
3640
3793
|
declare const FROM_REF: unique symbol;
|
|
3794
|
+
/** The marker `fromRef()` returns; resolved by the reconciler in `commitMount`. */
|
|
3795
|
+
interface FromRefMarker<T = unknown, R = T> {
|
|
3796
|
+
[FROM_REF]: React$1.RefObject<T | null>;
|
|
3797
|
+
/** Optional transform applied to the resolved ref before assignment. */
|
|
3798
|
+
transform?: (value: T) => R;
|
|
3799
|
+
}
|
|
3641
3800
|
/**
|
|
3642
3801
|
* Defers prop application until the referenced object is available.
|
|
3643
3802
|
* Useful for props like `target` that need sibling refs to be populated.
|
|
3644
3803
|
*
|
|
3804
|
+
* Only top-level props on a three element are resolved: a marker nested inside another value
|
|
3805
|
+
* (an array, an options object) is never seen. When the prop needs the sibling *wrapped* rather
|
|
3806
|
+
* than assigned as-is, pass a `transform`; it runs once the ref is populated and its result is
|
|
3807
|
+
* what gets assigned.
|
|
3808
|
+
*
|
|
3645
3809
|
* @param ref - React ref object to resolve at mount time
|
|
3646
|
-
* @
|
|
3810
|
+
* @param transform - Optional mapping from the resolved object to the value the prop expects
|
|
3811
|
+
* @returns A marker value that the reconciler resolves after mount
|
|
3647
3812
|
*
|
|
3648
3813
|
* @example
|
|
3649
3814
|
* const targetRef = useRef<THREE.Object3D>(null)
|
|
3650
3815
|
*
|
|
3651
3816
|
* <group ref={targetRef} position={[-3, -2, -15]} />
|
|
3652
3817
|
* <spotLight target={fromRef(targetRef)} intensity={100} />
|
|
3818
|
+
*
|
|
3819
|
+
* @example
|
|
3820
|
+
* // Wrap the sibling: a node material's lightsNode needs a LightsNode, not the light itself
|
|
3821
|
+
* <meshPhongNodeMaterial lightsNode={fromRef(lightRef, (light) => lights([light]))} />
|
|
3653
3822
|
*/
|
|
3654
3823
|
declare function fromRef<T>(ref: React$1.RefObject<T | null>): T;
|
|
3824
|
+
declare function fromRef<T, R>(ref: React$1.RefObject<T | null>, transform: (value: T) => R): R;
|
|
3655
3825
|
/**
|
|
3656
3826
|
* Type guard to check if a value is a fromRef marker.
|
|
3657
3827
|
*
|
|
3658
3828
|
* @param value - Value to check
|
|
3659
3829
|
* @returns True if value is a fromRef marker
|
|
3660
3830
|
*/
|
|
3661
|
-
declare function isFromRef(value: unknown): value is
|
|
3662
|
-
[FROM_REF]: React$1.RefObject<any>;
|
|
3663
|
-
};
|
|
3831
|
+
declare function isFromRef(value: unknown): value is FromRefMarker<any, unknown>;
|
|
3664
3832
|
|
|
3665
3833
|
/**
|
|
3666
3834
|
* Symbol marker for mount-only method calls.
|
|
@@ -3687,7 +3855,15 @@ declare const ONCE: unique symbol;
|
|
|
3687
3855
|
* // No arguments
|
|
3688
3856
|
* <geometry center={once()} />
|
|
3689
3857
|
*/
|
|
3690
|
-
declare function once<
|
|
3858
|
+
declare function once<A extends unknown[]>(...args: A): OnceValue<A>;
|
|
3859
|
+
/**
|
|
3860
|
+
* What `once(...args)` is typed as, so the marker is assignable to the prop it targets:
|
|
3861
|
+
* the single argument itself (`rotateX={once(angle)}`), the argument tuple for multi-argument
|
|
3862
|
+
* methods (`translate={once(x, y, z)}`), or `true` for a bare call (`center={once()}`).
|
|
3863
|
+
*
|
|
3864
|
+
* The runtime value is always the marker object; only the declared type follows the prop.
|
|
3865
|
+
*/
|
|
3866
|
+
type OnceValue<A extends unknown[]> = A extends [] ? true : A extends [infer Single] ? Single : A;
|
|
3691
3867
|
/**
|
|
3692
3868
|
* Type guard to check if a value is a once marker.
|
|
3693
3869
|
*
|
|
@@ -3698,11 +3874,8 @@ declare function isOnce(value: unknown): value is {
|
|
|
3698
3874
|
[ONCE]: any[] | true;
|
|
3699
3875
|
};
|
|
3700
3876
|
|
|
3701
|
-
/**
|
|
3702
|
-
|
|
3703
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/canvas
|
|
3704
|
-
*/
|
|
3705
|
-
declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
|
|
3877
|
+
/** Distinguishes a resource leaf from a nested resource scope. */
|
|
3878
|
+
type ResourceLeafGuard<T> = (value: unknown) => value is T;
|
|
3706
3879
|
|
|
3707
3880
|
/**
|
|
3708
3881
|
* ScopedStore - Type-safe wrapper for nested stores (uniforms, nodes)
|
|
@@ -3724,33 +3897,30 @@ declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
|
|
|
3724
3897
|
* ```
|
|
3725
3898
|
*/
|
|
3726
3899
|
|
|
3727
|
-
/** Keys reserved for methods (excluded from index signature) */
|
|
3728
|
-
type MethodKeys = 'scope' | 'has' | 'keys';
|
|
3729
3900
|
/**
|
|
3730
3901
|
* Type-safe wrapper interface for accessing nested store data.
|
|
3731
3902
|
* Property access returns `T` (assumes leaf node).
|
|
3732
3903
|
* Use `.scope(key)` for nested object access.
|
|
3733
3904
|
*
|
|
3734
|
-
* Uses mapped type with key filtering to exclude method names from index signature,
|
|
3735
|
-
* allowing methods to have their correct return types.
|
|
3736
3905
|
*/
|
|
3737
|
-
type
|
|
3738
|
-
/** Direct property access returns the leaf type T (method keys excluded) */
|
|
3739
|
-
readonly [K in string as K extends MethodKeys ? never : K]: T;
|
|
3740
|
-
} & {
|
|
3906
|
+
type ScopedStoreMethods<TLeaf> = {
|
|
3741
3907
|
/** Access a nested scope by key. Returns empty wrapper if scope doesn't exist. */
|
|
3742
|
-
scope(key: string): ScopedStoreType<
|
|
3908
|
+
scope<TScope extends Record<string, TLeaf> = Record<string, TLeaf>>(key: string): ScopedStoreType<TLeaf, TScope>;
|
|
3743
3909
|
/** Check if a key exists in the store */
|
|
3744
3910
|
has(key: string): boolean;
|
|
3745
3911
|
/** Get all keys in the store */
|
|
3746
3912
|
keys(): string[];
|
|
3747
3913
|
};
|
|
3914
|
+
type ScopedStoreType<TLeaf, TEntries extends Record<string, TLeaf> = Record<string, TLeaf>> = Readonly<TEntries> & ScopedStoreMethods<TLeaf>;
|
|
3915
|
+
interface ScopedStoreData<TLeaf> {
|
|
3916
|
+
[key: string]: TLeaf | ScopedStoreData<TLeaf>;
|
|
3917
|
+
}
|
|
3748
3918
|
/**
|
|
3749
3919
|
* Create a type-safe ScopedStore wrapper around store data.
|
|
3750
3920
|
* @param data - The raw store data (uniforms or nodes from RootState)
|
|
3751
3921
|
* @returns A ScopedStoreType wrapper with type-safe access
|
|
3752
3922
|
*/
|
|
3753
|
-
declare function createScopedStore<
|
|
3923
|
+
declare function createScopedStore<TLeaf>(data: ScopedStoreData<TLeaf>, isLeaf: ResourceLeafGuard<TLeaf>): ScopedStoreType<TLeaf>;
|
|
3754
3924
|
/**
|
|
3755
3925
|
* State type passed to creator functions with ScopedStore wrappers.
|
|
3756
3926
|
* Provides type-safe access to uniforms, nodes, buffers, and gpuStorage without manual casting.
|
|
@@ -3758,8 +3928,8 @@ declare function createScopedStore<T>(data: Record<string, any>): ScopedStoreTyp
|
|
|
3758
3928
|
type CreatorState = Omit<RootState, 'uniforms' | 'nodes' | 'buffers' | 'gpuStorage'> & {
|
|
3759
3929
|
/** Type-safe uniform access - property access returns UniformNode */
|
|
3760
3930
|
uniforms: ScopedStoreType<UniformNode>;
|
|
3761
|
-
/** Type-safe node access
|
|
3762
|
-
nodes: ScopedStoreType<
|
|
3931
|
+
/** Type-safe node access for real, callable, and legacy structural nodes */
|
|
3932
|
+
nodes: ScopedStoreType<NodeLike>;
|
|
3763
3933
|
/** Type-safe buffer access - property access returns BufferLike (TypedArrays, BufferAttributes, TSL nodes) */
|
|
3764
3934
|
buffers: ScopedStoreType<BufferLike>;
|
|
3765
3935
|
/** Type-safe GPU storage access - property access returns StorageLike (StorageTexture, TSL nodes) */
|
|
@@ -3775,17 +3945,18 @@ type ClearUniformsFn = (scope?: string) => void;
|
|
|
3775
3945
|
/** Function signature for rebuildUniforms util */
|
|
3776
3946
|
type RebuildUniformsFn = (scope?: string) => void;
|
|
3777
3947
|
/** Return type with utils included */
|
|
3778
|
-
type UniformsWithUtils<T extends UniformRecord = UniformRecord> = T & {
|
|
3948
|
+
type UniformsWithUtils<T extends UniformRecord | UniformStore = UniformRecord> = T & {
|
|
3779
3949
|
removeUniforms: RemoveUniformsFn;
|
|
3780
3950
|
clearUniforms: ClearUniformsFn;
|
|
3781
3951
|
rebuildUniforms: RebuildUniformsFn;
|
|
3782
3952
|
};
|
|
3783
|
-
declare function useUniforms(): UniformsWithUtils<
|
|
3953
|
+
declare function useUniforms<T extends UniformInputRecord>(creator: UniformCreator<T>): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3954
|
+
declare function useUniforms<T extends UniformInputRecord>(creator: UniformCreator<T>, scope: string): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3955
|
+
declare function useUniforms<T extends UniformInputRecord>(uniforms: T): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3956
|
+
declare function useUniforms<T extends UniformInputRecord>(uniforms: T, scope: string): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3957
|
+
declare function useUniforms(): UniformsWithUtils<UniformStore>;
|
|
3784
3958
|
declare function useUniforms(scope: string): UniformsWithUtils;
|
|
3785
|
-
declare function useUniforms<T extends UniformInputRecord>(
|
|
3786
|
-
declare function useUniforms<T extends UniformInputRecord>(creator: UniformCreator<T>, scope: string): UniformsWithUtils<UniformRecord<UniformNode>>;
|
|
3787
|
-
declare function useUniforms<T extends UniformInputRecord>(uniforms: T): UniformsWithUtils<UniformRecord<UniformNode>>;
|
|
3788
|
-
declare function useUniforms<T extends UniformInputRecord>(uniforms: T, scope: string): UniformsWithUtils<UniformRecord<UniformNode>>;
|
|
3959
|
+
declare function useUniforms<T extends UniformInputRecord>(scope?: string): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3789
3960
|
/**
|
|
3790
3961
|
* Global rebuildUniforms function for HMR integration.
|
|
3791
3962
|
* Invalidates cached uniforms and increments _hmrVersion to trigger re-creation.
|
|
@@ -3816,47 +3987,28 @@ declare function clearRootUniforms(set: ReturnType<typeof useStore>['setState'])
|
|
|
3816
3987
|
|
|
3817
3988
|
/**
|
|
3818
3989
|
* Supported uniform value types:
|
|
3819
|
-
* - Raw values: number, boolean, Vector2, Vector3, Vector4, Color, Matrix3, Matrix4
|
|
3990
|
+
* - Raw values: number, boolean, Vector2, Vector3, Vector4, Color, Matrix2, Matrix3, Matrix4
|
|
3820
3991
|
* - String colors: '#ff0000', 'red', 'rgb(255,0,0)' (auto-converted to Color)
|
|
3821
3992
|
* - TSL nodes: color(), vec3(), float(), etc. (for type casting)
|
|
3822
3993
|
* - UniformNode: existing uniforms (reused as-is)
|
|
3823
3994
|
*/
|
|
3824
|
-
type UniformValue = number | boolean | string | Vector2$1 | Vector3$1 | Vector4$1 | Color$2 | Matrix3$1 | Matrix4$1 | Node | UniformNode;
|
|
3825
|
-
|
|
3826
|
-
|
|
3827
|
-
* - 0 → number
|
|
3828
|
-
* - true → boolean
|
|
3829
|
-
* - '#ff0000' → Color (string colors are converted to Color objects)
|
|
3830
|
-
* - Node → Node (TSL nodes passed through for uniform type casting)
|
|
3831
|
-
*/
|
|
3832
|
-
type Widen<T> = T extends number ? number : T extends boolean ? boolean : T extends string ? Color$2 : T;
|
|
3833
|
-
declare function useUniform<T extends UniformValue>(name: string): UniformNode<T>;
|
|
3834
|
-
declare function useUniform<T extends UniformValue>(name: string, value: T): UniformNode<Widen<T>>;
|
|
3995
|
+
type UniformValue = number | boolean | string | Vector2$1 | Vector3$1 | Vector4$1 | Color$2 | Matrix2 | Matrix3$1 | Matrix4$1 | Node | UniformNode;
|
|
3996
|
+
declare function useUniform<T extends UniformValue = UniformValue>(name: string): UniformNodeFor<T>;
|
|
3997
|
+
declare function useUniform<T extends UniformValue>(name: string, value: T): UniformNodeFor<T>;
|
|
3835
3998
|
|
|
3836
3999
|
/**
|
|
3837
|
-
*
|
|
3838
|
-
*
|
|
3839
|
-
*
|
|
3840
|
-
*
|
|
4000
|
+
* Every node representation a creator may return. The definition lives with the store types as
|
|
4001
|
+
* `NodeLike`, so the shape creators return and the shape `state.nodes` holds are one type by
|
|
4002
|
+
* construction: three's real `Node`, the callable proxy `Fn()` returns, or the legacy structural
|
|
4003
|
+
* `{ uuid, nodeType }` shape.
|
|
3841
4004
|
*/
|
|
3842
|
-
|
|
3843
|
-
|
|
3844
|
-
|
|
3845
|
-
/** label method for chaining - sets the node's label and returns self */
|
|
3846
|
-
label?: ((label: string) => TSLNodeLike) | string;
|
|
3847
|
-
setName?: (name: string) => this;
|
|
3848
|
-
}
|
|
3849
|
-
/** TSL node type - alias for compatibility */
|
|
4005
|
+
type TSLNodeLike = NodeLike;
|
|
4006
|
+
|
|
4007
|
+
/** Backward-compatible alias covering every accepted node representation. */
|
|
3850
4008
|
type TSLNode = TSLNodeLike;
|
|
3851
|
-
/**
|
|
3852
|
-
* A record of TSL nodes - allows mixed node types (OperatorNode, ConstNode, etc.)
|
|
3853
|
-
* Uses TSLNodeLike for broader compatibility with Three.js's TSL type definitions.
|
|
3854
|
-
*/
|
|
3855
|
-
type NodeRecord<T extends TSLNodeLike = TSLNodeLike> = Record<string, T>;
|
|
3856
4009
|
/**
|
|
3857
4010
|
* Creator function that returns a record of nodes.
|
|
3858
|
-
*
|
|
3859
|
-
* (e.g., { n: OperatorNode; color: ConstNode<Color> }) to pass type checking.
|
|
4011
|
+
* Exact creator return inference is preserved within the compatible node constraint.
|
|
3860
4012
|
*/
|
|
3861
4013
|
type NodeCreator<T extends Record<string, TSLNodeLike>> = (state: CreatorState) => T;
|
|
3862
4014
|
/** Function signature for removeNodes util */
|
|
@@ -3866,15 +4018,17 @@ type ClearNodesFn = (scope?: string) => void;
|
|
|
3866
4018
|
/** Function signature for rebuildNodes util */
|
|
3867
4019
|
type RebuildNodesFn = (scope?: string) => void;
|
|
3868
4020
|
/** Return type with utils included */
|
|
3869
|
-
type NodesWithUtils<T extends Record<string,
|
|
4021
|
+
type NodesWithUtils<T extends Record<string, unknown> = NodeRecord> = T & {
|
|
3870
4022
|
removeNodes: RemoveNodesFn;
|
|
3871
4023
|
clearNodes: ClearNodesFn;
|
|
3872
4024
|
rebuildNodes: RebuildNodesFn;
|
|
3873
4025
|
};
|
|
3874
|
-
declare function useNodes(): NodesWithUtils<
|
|
3875
|
-
declare function useNodes(scope: string): NodesWithUtils<
|
|
3876
|
-
declare function useNodes<T extends
|
|
3877
|
-
declare function useNodes<T extends
|
|
4026
|
+
declare function useNodes(): NodesWithUtils<NodeStore>;
|
|
4027
|
+
declare function useNodes(scope: string): NodesWithUtils<NodeRecord>;
|
|
4028
|
+
declare function useNodes<T extends NodeRecord>(scope?: string): NodesWithUtils<T>;
|
|
4029
|
+
declare function useNodes<T extends NodeRecord>(creator: NodeCreator<T>): NodesWithUtils<T>;
|
|
4030
|
+
declare function useNodes<T extends NodeRecord>(creator: NodeCreator<T>, scope: string): NodesWithUtils<T>;
|
|
4031
|
+
declare function useNodes(creatorOrScope?: NodeCreator<NodeRecord> | string, scope?: string): NodesWithUtils<Record<string, unknown>>;
|
|
3878
4032
|
/**
|
|
3879
4033
|
* Global rebuildNodes function for HMR integration.
|
|
3880
4034
|
* Invalidates cached nodes and increments _hmrVersion to trigger re-creation.
|
|
@@ -3933,6 +4087,10 @@ type LocalNodeCreator<T extends Record<string, unknown>> = (state: CreatorState)
|
|
|
3933
4087
|
*/
|
|
3934
4088
|
declare function useLocalNodes<T extends Record<string, unknown>>(creator: LocalNodeCreator<T>): T;
|
|
3935
4089
|
|
|
4090
|
+
/**
|
|
4091
|
+
* A record of buffer-like values - allows mixed types (TypedArrays, BufferAttributes, TSL nodes)
|
|
4092
|
+
*/
|
|
4093
|
+
type BufferRecordType<T extends BufferLike = BufferLike> = Record<string, T>;
|
|
3936
4094
|
/**
|
|
3937
4095
|
* Creator function that returns a record of buffers.
|
|
3938
4096
|
* Receives CreatorState with access to existing buffers, gpuStorage, uniforms, nodes, etc.
|
|
@@ -3947,14 +4105,15 @@ type RebuildBuffersFn = (scope?: string) => void;
|
|
|
3947
4105
|
/** Function signature for disposeBuffers util - releases GPU resources */
|
|
3948
4106
|
type DisposeBuffersFn = (names: string | string[], scope?: string) => void;
|
|
3949
4107
|
/** Return type with utils included */
|
|
3950
|
-
type BuffersWithUtils<T extends
|
|
4108
|
+
type BuffersWithUtils<T extends BufferRecordType | BufferStore = BufferRecordType> = T & {
|
|
3951
4109
|
removeBuffers: RemoveBuffersFn;
|
|
3952
4110
|
clearBuffers: ClearBuffersFn;
|
|
3953
4111
|
rebuildBuffers: RebuildBuffersFn;
|
|
3954
4112
|
disposeBuffers: DisposeBuffersFn;
|
|
3955
4113
|
};
|
|
3956
|
-
declare function useBuffers(): BuffersWithUtils<
|
|
4114
|
+
declare function useBuffers(): BuffersWithUtils<BufferStore>;
|
|
3957
4115
|
declare function useBuffers(scope: string): BuffersWithUtils<Record<string, BufferLike>>;
|
|
4116
|
+
declare function useBuffers<T extends Record<string, BufferLike>>(scope?: string): BuffersWithUtils<T>;
|
|
3958
4117
|
declare function useBuffers<T extends Record<string, BufferLike>>(creator: BufferCreator<T>): BuffersWithUtils<T>;
|
|
3959
4118
|
declare function useBuffers<T extends Record<string, BufferLike>>(creator: BufferCreator<T>, scope: string): BuffersWithUtils<T>;
|
|
3960
4119
|
/**
|
|
@@ -3970,6 +4129,10 @@ declare function useBuffers<T extends Record<string, BufferLike>>(creator: Buffe
|
|
|
3970
4129
|
*/
|
|
3971
4130
|
declare function rebuildAllBuffers(store: ReturnType<typeof useStore>, scope?: string): void;
|
|
3972
4131
|
|
|
4132
|
+
/**
|
|
4133
|
+
* A record of storage-like values - allows mixed types (StorageTexture, Storage3DTexture, TSL nodes)
|
|
4134
|
+
*/
|
|
4135
|
+
type StorageRecordType<T extends StorageLike = StorageLike> = Record<string, T>;
|
|
3973
4136
|
/**
|
|
3974
4137
|
* Creator function that returns a record of GPU storage objects.
|
|
3975
4138
|
* Receives CreatorState with access to existing buffers, gpuStorage, uniforms, nodes, etc.
|
|
@@ -3984,14 +4147,15 @@ type RebuildStorageFn = (scope?: string) => void;
|
|
|
3984
4147
|
/** Function signature for disposeStorage util - releases GPU resources */
|
|
3985
4148
|
type DisposeStorageFn = (names: string | string[], scope?: string) => void;
|
|
3986
4149
|
/** Return type with utils included */
|
|
3987
|
-
type StorageWithUtils<T extends
|
|
4150
|
+
type StorageWithUtils<T extends StorageRecordType | StorageStore = StorageRecordType> = T & {
|
|
3988
4151
|
removeStorage: RemoveStorageFn;
|
|
3989
4152
|
clearStorage: ClearStorageFn;
|
|
3990
4153
|
rebuildStorage: RebuildStorageFn;
|
|
3991
4154
|
disposeStorage: DisposeStorageFn;
|
|
3992
4155
|
};
|
|
3993
|
-
declare function useGPUStorage(): StorageWithUtils<
|
|
4156
|
+
declare function useGPUStorage(): StorageWithUtils<StorageStore>;
|
|
3994
4157
|
declare function useGPUStorage(scope: string): StorageWithUtils<Record<string, StorageLike>>;
|
|
4158
|
+
declare function useGPUStorage<T extends Record<string, StorageLike>>(scope?: string): StorageWithUtils<T>;
|
|
3995
4159
|
declare function useGPUStorage<T extends Record<string, StorageLike>>(creator: StorageCreator<T>): StorageWithUtils<T>;
|
|
3996
4160
|
declare function useGPUStorage<T extends Record<string, StorageLike>>(creator: StorageCreator<T>, scope: string): StorageWithUtils<T>;
|
|
3997
4161
|
/**
|
|
@@ -4041,6 +4205,10 @@ declare function createTextureOperations(set: StoreApi<RootState>['setState']):
|
|
|
4041
4205
|
* - Callbacks receive full RootState for flexibility
|
|
4042
4206
|
* - No auto-cleanup on unmount - use reset() for explicit cleanup
|
|
4043
4207
|
* - Scene/camera changes trigger scenePass recreation
|
|
4208
|
+
* - A replaced scenePass is disposed once the new graph is installed, so rebuild() does not
|
|
4209
|
+
* strand its render target (and MRT attachments) on the GPU
|
|
4210
|
+
* - Any run that changes the output node sets RenderPipeline.needsUpdate, so rebuild() actually
|
|
4211
|
+
* recompiles instead of silently keeping the first compiled graph
|
|
4044
4212
|
*
|
|
4045
4213
|
* @param mainCB - Main callback to configure outputNode and create effect passes
|
|
4046
4214
|
* @param setupCB - Optional setup callback to configure MRT on scenePass
|
|
@@ -4136,5 +4304,14 @@ type UseFrameWebGPU = (callback?: FrameCallback$1<WebGPURootState>, priorityOrOp
|
|
|
4136
4304
|
declare const useThree: UseThreeWebGPU;
|
|
4137
4305
|
declare const useFrame: UseFrameWebGPU;
|
|
4138
4306
|
|
|
4139
|
-
|
|
4140
|
-
|
|
4307
|
+
/** Canvas props on the WebGPU entry: `onCreated` receives `WebGPURootState`. */
|
|
4308
|
+
type WebGPUCanvasProps = Omit<CanvasProps, 'onCreated'> & {
|
|
4309
|
+
/** Callback after the canvas has rendered (but not yet committed); `state.renderer` is a `WebGPURenderer` */
|
|
4310
|
+
onCreated?: (state: WebGPURootState) => void;
|
|
4311
|
+
};
|
|
4312
|
+
|
|
4313
|
+
/** `Canvas` narrowed to WebGPU state — the same component, `onCreated` typed against `WebGPURootState`. */
|
|
4314
|
+
declare const Canvas: (props: WebGPUCanvasProps) => JSX.Element;
|
|
4315
|
+
|
|
4316
|
+
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, registerRootExtension, removeInteractivity, removeNodes, removeUniforms, resolve, setRenderOverride, 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 };
|
|
4317
|
+
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, RootExtension, 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 };
|