@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/legacy.d.cts
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';
|
|
@@ -41,9 +41,9 @@ declare const R3F_BUILD_WEBGPU = false;
|
|
|
41
41
|
type Inspector = never;
|
|
42
42
|
/** Not available on the legacy (WebGL-only) entry. */
|
|
43
43
|
declare function loadInspector(): Promise<never>;
|
|
44
|
-
declare
|
|
45
|
-
|
|
46
|
-
}
|
|
44
|
+
declare class WebGPURenderer {
|
|
45
|
+
constructor();
|
|
46
|
+
}
|
|
47
47
|
|
|
48
48
|
declare const RenderTarget: any;
|
|
49
49
|
|
|
@@ -348,6 +348,7 @@ type BufferLike =
|
|
|
348
348
|
| Uint16Array
|
|
349
349
|
| Int16Array
|
|
350
350
|
| THREE$1.BufferAttribute // Base class for all buffer attributes
|
|
351
|
+
| THREE$1.InterleavedBufferAttribute
|
|
351
352
|
| Node // TSL buffer nodes (instancedArray, storage)
|
|
352
353
|
|
|
353
354
|
/** Flat record of buffer-like values (no nested scopes) */
|
|
@@ -359,6 +360,25 @@ type BufferRecord = Record<string, BufferLike>
|
|
|
359
360
|
*/
|
|
360
361
|
type BufferStore = Record<string, BufferLike | BufferRecord>
|
|
361
362
|
|
|
363
|
+
//* Node Types (useNodes) ========================================
|
|
364
|
+
|
|
365
|
+
/**
|
|
366
|
+
* Every node representation `useNodes` accepts and `state.nodes` holds: three's real `Node`,
|
|
367
|
+
* the callable proxy `Fn()` returns, and the legacy structural shape (`uuid`/`nodeType`) older
|
|
368
|
+
* code passes through. Creators are constrained to this same type, so the shape a creator returns
|
|
369
|
+
* and the shape the store holds are one type by construction.
|
|
370
|
+
*/
|
|
371
|
+
type NodeLike = TSLNodeType | LegacyTSLNodeLike
|
|
372
|
+
|
|
373
|
+
/** Flat record of TSL nodes (no nested scopes) */
|
|
374
|
+
type NodeRecord<T extends NodeLike = NodeLike> = Record<string, T>
|
|
375
|
+
|
|
376
|
+
/**
|
|
377
|
+
* Node store that can contain both root-level nodes and scoped node objects.
|
|
378
|
+
* Structure: { wobble: OperatorNode, fx: { blur: ShaderCallable } }
|
|
379
|
+
*/
|
|
380
|
+
type NodeStore = Record<string, NodeLike | NodeRecord>
|
|
381
|
+
|
|
362
382
|
//* Storage Types (useGPUStorage) ========================================
|
|
363
383
|
|
|
364
384
|
/**
|
|
@@ -373,7 +393,9 @@ type BufferStore = Record<string, BufferLike | BufferRecord>
|
|
|
373
393
|
* ```
|
|
374
394
|
*/
|
|
375
395
|
type StorageLike =
|
|
376
|
-
| StorageTexture // GPU storage texture
|
|
396
|
+
| StorageTexture // 2D GPU storage texture
|
|
397
|
+
| Storage3DTexture // 3D GPU storage texture (volumes, fluid grids)
|
|
398
|
+
| StorageArrayTexture // 2D-array GPU storage texture
|
|
377
399
|
| Data3DTexture // 3D texture (can be used as storage)
|
|
378
400
|
| Node // TSL storage texture nodes (storageTexture)
|
|
379
401
|
|
|
@@ -485,6 +507,12 @@ interface InternalState {
|
|
|
485
507
|
actualRenderer: R3FRenderer
|
|
486
508
|
/** Global scheduler reference (for useFrame hook) */
|
|
487
509
|
scheduler: SchedulerApi | null
|
|
510
|
+
/**
|
|
511
|
+
* Replaces `renderer.render(scene, camera)` in the default render job when set. Set it with
|
|
512
|
+
* `setRenderOverride(store, fn)`; the job keeps its fps throttle, error handling and user
|
|
513
|
+
* render-phase takeover. Used by `useRenderPipeline`.
|
|
514
|
+
*/
|
|
515
|
+
renderOverride?: (() => void) | null
|
|
488
516
|
/** This root's unique ID in the global scheduler */
|
|
489
517
|
rootId?: string
|
|
490
518
|
/** Function to unregister this root from the global scheduler */
|
|
@@ -492,11 +520,28 @@ interface InternalState {
|
|
|
492
520
|
/** Container for child attachment (scene for root, original container for portals) */
|
|
493
521
|
container?: THREE$1.Object3D
|
|
494
522
|
/**
|
|
495
|
-
* CanvasTarget
|
|
496
|
-
*
|
|
523
|
+
* The CanvasTarget this root sizes and renders through.
|
|
524
|
+
*
|
|
525
|
+
* A primary (`<Canvas id>`) owns the renderer's default target -- the one three itself built
|
|
526
|
+
* around the canvas element -- so sizing it is sizing the renderer. A secondary owns a target
|
|
527
|
+
* R3F created for its own element. Either way there is exactly one target per canvas element,
|
|
528
|
+
* and the canvas-target job makes it the renderer's active one before this root renders.
|
|
529
|
+
* Absent on WebGL and on an id-less WebGPU canvas, where the renderer is sized directly.
|
|
497
530
|
* @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
|
|
498
531
|
*/
|
|
499
532
|
canvasTarget?: CanvasTarget
|
|
533
|
+
/**
|
|
534
|
+
* Set when this root's canvas target has been resized and the backend's cached render pass
|
|
535
|
+
* descriptor (which holds a depth-stencil view built once per canvas) is therefore stale.
|
|
536
|
+
*
|
|
537
|
+
* Flushed by the canvas-target job in the `start` phase, which is the only place this root's
|
|
538
|
+
* target is guaranteed to be the renderer's active one — `backend.updateSize()` operates on
|
|
539
|
+
* whatever `getCanvasTarget()` returns, so calling it from the resize subscription would
|
|
540
|
+
* invalidate some other canvas's descriptor instead.
|
|
541
|
+
*
|
|
542
|
+
* @see https://github.com/pmndrs/react-three-fiber/issues/3847
|
|
543
|
+
*/
|
|
544
|
+
canvasTargetSizeDirty?: boolean
|
|
500
545
|
/**
|
|
501
546
|
* Whether multi-canvas rendering is active.
|
|
502
547
|
* True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
|
|
@@ -606,7 +651,7 @@ interface RootState {
|
|
|
606
651
|
/** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
|
|
607
652
|
uniforms: UniformStore
|
|
608
653
|
/** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
|
|
609
|
-
nodes:
|
|
654
|
+
nodes: NodeStore
|
|
610
655
|
/** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
|
|
611
656
|
buffers: BufferStore
|
|
612
657
|
/** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
|
|
@@ -618,7 +663,7 @@ interface RootState {
|
|
|
618
663
|
/** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
|
|
619
664
|
renderPipeline: ThreeRenderPipeline | null
|
|
620
665
|
/** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
|
|
621
|
-
passes:
|
|
666
|
+
passes: PassRecord
|
|
622
667
|
/** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
|
|
623
668
|
_hmrVersion: number
|
|
624
669
|
/** Internal: whether setSize() has taken ownership of canvas dimensions */
|
|
@@ -706,12 +751,19 @@ type DefaultRendererProps = {
|
|
|
706
751
|
*/
|
|
707
752
|
interface CanvasSchedulerConfig {
|
|
708
753
|
/**
|
|
709
|
-
*
|
|
710
|
-
* Pass the `id` of another canvas.
|
|
754
|
+
* Run this Canvas root before the referenced Canvas root id(s).
|
|
711
755
|
*/
|
|
712
|
-
|
|
756
|
+
before?: string | string[]
|
|
713
757
|
/**
|
|
714
|
-
*
|
|
758
|
+
* Run this Canvas root after the referenced Canvas root id(s).
|
|
759
|
+
*/
|
|
760
|
+
after?: string | string[]
|
|
761
|
+
/**
|
|
762
|
+
* Numeric root order. Lower values run first.
|
|
763
|
+
*/
|
|
764
|
+
order?: number
|
|
765
|
+
/**
|
|
766
|
+
* Limit this Canvas's default render job (frames per second).
|
|
715
767
|
*/
|
|
716
768
|
fps?: number
|
|
717
769
|
}
|
|
@@ -798,14 +850,17 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
|
|
|
798
850
|
performance?: Partial<Omit<Performance, 'regress'>>
|
|
799
851
|
/** Target pixel ratio. Can clamp between a range: `[min, max]` */
|
|
800
852
|
dpr?: Dpr
|
|
801
|
-
/**
|
|
802
|
-
|
|
853
|
+
/**
|
|
854
|
+
* Props that go into the default raycaster. `params` is merged into the raycaster's defaults,
|
|
855
|
+
* so a single threshold can be set: `raycaster={{ params: { Points: { threshold: 0.2 } } }}`.
|
|
856
|
+
*/
|
|
857
|
+
raycaster?: Partial<Omit<THREE$1.Raycaster, 'params'>> & { params?: Partial<THREE$1.RaycasterParameters> }
|
|
803
858
|
/** A `THREE.Scene` instance or props that go into the default scene */
|
|
804
859
|
scene?: THREE$1.Scene | Partial<THREE$1.Scene>
|
|
805
860
|
/** A `THREE.Camera` instance or props that go into the default camera */
|
|
806
861
|
camera?: CameraProps
|
|
807
862
|
/** An R3F event manager to manage elements' pointer events */
|
|
808
|
-
events?: (store: RootStore) => EventManager<
|
|
863
|
+
events?: (store: RootStore) => EventManager<Element>
|
|
809
864
|
/** Callback after the canvas has rendered (but not yet committed) */
|
|
810
865
|
onCreated?: (state: RootState) => void
|
|
811
866
|
/** Response for pointer clicks that have missed any target */
|
|
@@ -894,7 +949,6 @@ type InstanceProps<T = any, P = any> = ArgsProp<P> & {
|
|
|
894
949
|
object?: T
|
|
895
950
|
dispose?: null
|
|
896
951
|
attach?: AttachType<T>
|
|
897
|
-
onUpdate?: (self: T) => void
|
|
898
952
|
}
|
|
899
953
|
|
|
900
954
|
interface Instance<O = any> {
|
|
@@ -1034,7 +1088,7 @@ interface CanvasProps
|
|
|
1034
1088
|
*/
|
|
1035
1089
|
resize?: Options
|
|
1036
1090
|
/** The target where events are being subscribed to, default: the div that wraps canvas */
|
|
1037
|
-
eventSource?:
|
|
1091
|
+
eventSource?: Element | React$1.RefObject<Element | null>
|
|
1038
1092
|
/** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
|
|
1039
1093
|
eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
|
|
1040
1094
|
/** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
|
|
@@ -1142,81 +1196,86 @@ interface LegacyRootState extends Omit<RootState, 'renderer' | 'internal'> {
|
|
|
1142
1196
|
|
|
1143
1197
|
type RenderTargetOptions = RenderTargetOptions$1
|
|
1144
1198
|
|
|
1145
|
-
//* Global Types ==============================
|
|
1199
|
+
//* Global TSL Types ==============================
|
|
1146
1200
|
|
|
1147
1201
|
declare global {
|
|
1148
1202
|
/**
|
|
1149
|
-
*
|
|
1150
|
-
*
|
|
1151
|
-
* This is three's own `UniformNode`, not a re-declaration of it. It previously was a
|
|
1152
|
-
* hand-rolled `interface UniformNode<T> extends Node { value: T }`, which shadowed the real
|
|
1153
|
-
* exported type globally — so R3F's ~58 references resolved to an approximation that was
|
|
1154
|
-
* missing members three actually ships (`setName` among them) and had drifted to the wrong
|
|
1155
|
-
* arity when three made `UniformNode` two-parameter.
|
|
1156
|
-
*
|
|
1157
|
-
* three's signature is `UniformNode<TNodeType, TValue>`. R3F only ever varies the value type,
|
|
1158
|
-
* so the node type is fixed to `unknown` and the single parameter is kept for call-site
|
|
1159
|
-
* ergonomics. The result is three's structural type, so members stay in sync with the
|
|
1160
|
-
* installed three instead of needing to be mirrored by hand.
|
|
1203
|
+
* Broad callable-node fallback for dynamic store readers.
|
|
1204
|
+
* Creator hooks preserve the exact function signatures inferred from Three's `Fn`.
|
|
1161
1205
|
*/
|
|
1162
|
-
type
|
|
1206
|
+
type CallableTSLNode = ((...params: never[]) => unknown) & {
|
|
1207
|
+
readonly shaderNode: unknown
|
|
1208
|
+
readonly id: number
|
|
1209
|
+
}
|
|
1163
1210
|
|
|
1164
|
-
/**
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
* @example
|
|
1170
|
-
* ```tsx
|
|
1171
|
-
* // Define a shader function
|
|
1172
|
-
* const blendColorFn = Fn(([color1, color2, factor]) => {
|
|
1173
|
-
* return mix(color1, color2, factor)
|
|
1174
|
-
* })
|
|
1175
|
-
*
|
|
1176
|
-
* // Type when retrieving from nodes store
|
|
1177
|
-
* const { blendColorFn } = nodes as { blendColorFn: ShaderCallable }
|
|
1178
|
-
*
|
|
1179
|
-
* // Or with specific return type
|
|
1180
|
-
* const { myFn } = nodes as { myFn: ShaderCallable<THREE.Node> }
|
|
1181
|
-
* ```
|
|
1182
|
-
*/
|
|
1183
|
-
type ShaderCallable<R extends Node = Node> = ((...params: unknown[]) => ShaderNodeObject<R>) & Node
|
|
1211
|
+
/** Legacy structural node accepted when at least one historical marker exists. */
|
|
1212
|
+
type LegacyTSLNodeLike = {
|
|
1213
|
+
label?: ((label: string) => unknown) | string
|
|
1214
|
+
setName?: (name: string) => unknown
|
|
1215
|
+
} & ({ uuid: string | undefined; nodeType?: string | null } | { uuid?: string; nodeType: string | null | undefined })
|
|
1184
1216
|
|
|
1185
|
-
/**
|
|
1186
|
-
|
|
1187
|
-
* This is the common return type for TSL operations (add, mul, sin, etc.)
|
|
1188
|
-
*
|
|
1189
|
-
* @example
|
|
1190
|
-
* ```tsx
|
|
1191
|
-
* const { wobble } = nodes as { wobble: ShaderNodeRef }
|
|
1192
|
-
* ```
|
|
1193
|
-
*/
|
|
1194
|
-
type ShaderNodeRef<T extends Node = Node> = ShaderNodeObject<T>
|
|
1217
|
+
/** Node type accepted by broad dynamic node-store readers. */
|
|
1218
|
+
type TSLNodeType = three_webgpu.Node | CallableTSLNode
|
|
1195
1219
|
|
|
1196
1220
|
/**
|
|
1197
|
-
*
|
|
1198
|
-
*
|
|
1199
|
-
*
|
|
1200
|
-
*
|
|
1201
|
-
* - Node: base Three.js node type
|
|
1202
|
-
* - ShaderCallable: function nodes created with Fn()
|
|
1203
|
-
* - ShaderNodeObject: wrapped nodes from TSL operations (sin, mul, mix, etc.)
|
|
1204
|
-
*
|
|
1205
|
-
* @example
|
|
1206
|
-
* ```tsx
|
|
1207
|
-
* // In useLocalNodes, nodes are typed as TSLNodeType
|
|
1208
|
-
* const { positionNode, blendColorFn } = useLocalNodes(({ nodes }) => ({
|
|
1209
|
-
* positionNode: nodes.myPosition, // Works - Node is in union
|
|
1210
|
-
* blendColorFn: nodes.myFn, // Works - ShaderCallable is in union
|
|
1211
|
-
* }))
|
|
1212
|
-
*
|
|
1213
|
-
* // Can narrow with type guard or assertion when needed
|
|
1214
|
-
* if (typeof blendColorFn === 'function') {
|
|
1215
|
-
* blendColorFn(someColor, 0.5)
|
|
1216
|
-
* }
|
|
1217
|
-
* ```
|
|
1221
|
+
* Derive Three's shader node type from an existing node or a supported raw input.
|
|
1222
|
+
* Existing InputNode generics take precedence over structural value normalization.
|
|
1223
|
+
* Both generics must be inferred because Three's UniformNode intersects an unknown-typed
|
|
1224
|
+
* InputNode base with its concrete InputNode specialization.
|
|
1218
1225
|
*/
|
|
1219
|
-
type
|
|
1226
|
+
type UniformNodeType<T> = T extends three_webgpu.UniformNode<infer TNodeType, infer _TValue>
|
|
1227
|
+
? TNodeType
|
|
1228
|
+
: T extends three_webgpu.InputNode<infer TNodeType, infer _TValue>
|
|
1229
|
+
? TNodeType
|
|
1230
|
+
: T extends number
|
|
1231
|
+
? 'float'
|
|
1232
|
+
: T extends boolean
|
|
1233
|
+
? 'bool'
|
|
1234
|
+
: T extends string | three_webgpu.Color | { r: number; g: number; b: number }
|
|
1235
|
+
? 'color'
|
|
1236
|
+
: T extends three_webgpu.Vector4 | { x: number; y: number; z: number; w: number }
|
|
1237
|
+
? 'vec4'
|
|
1238
|
+
: T extends three_webgpu.Vector3 | { x: number; y: number; z: number }
|
|
1239
|
+
? 'vec3'
|
|
1240
|
+
: T extends three_webgpu.Vector2 | { x: number; y: number }
|
|
1241
|
+
? 'vec2'
|
|
1242
|
+
: T extends three_webgpu.Matrix4
|
|
1243
|
+
? 'mat4'
|
|
1244
|
+
: T extends three_webgpu.Matrix3
|
|
1245
|
+
? 'mat3'
|
|
1246
|
+
: T extends three_webgpu.Matrix2
|
|
1247
|
+
? 'mat2'
|
|
1248
|
+
: unknown
|
|
1249
|
+
|
|
1250
|
+
/** Derive the normalized JavaScript value stored by a uniform node. */
|
|
1251
|
+
type UniformNodeValue<T> = T extends three_webgpu.UniformNode<infer _TNodeType, infer TValue>
|
|
1252
|
+
? TValue
|
|
1253
|
+
: T extends three_webgpu.InputNode<infer _TNodeType, infer TValue>
|
|
1254
|
+
? TValue
|
|
1255
|
+
: T extends string | { r: number; g: number; b: number }
|
|
1256
|
+
? three_webgpu.Color
|
|
1257
|
+
: T extends { x: number; y: number; z: number; w: number }
|
|
1258
|
+
? three_webgpu.Vector4
|
|
1259
|
+
: T extends { x: number; y: number; z: number }
|
|
1260
|
+
? three_webgpu.Vector3
|
|
1261
|
+
: T extends { x: number; y: number }
|
|
1262
|
+
? three_webgpu.Vector2
|
|
1263
|
+
: T extends number
|
|
1264
|
+
? number
|
|
1265
|
+
: T extends boolean
|
|
1266
|
+
? boolean
|
|
1267
|
+
: T
|
|
1268
|
+
|
|
1269
|
+
/** Three's exact UniformNode with shader and value generics derived from an input. */
|
|
1270
|
+
type UniformNodeFor<T> = three_webgpu.UniformNode<UniformNodeType<T>, UniformNodeValue<T>>
|
|
1271
|
+
|
|
1272
|
+
/** Preserve every input key while mapping values to exact Three uniform nodes. */
|
|
1273
|
+
type UniformNodesFor<T extends UniformInputRecord> = {
|
|
1274
|
+
[K in keyof T]: UniformNodeFor<T[K]>
|
|
1275
|
+
}
|
|
1276
|
+
|
|
1277
|
+
/** Backward-compatible single-parameter uniform alias. */
|
|
1278
|
+
type UniformNode<T = unknown> = UniformNodeFor<T>
|
|
1220
1279
|
|
|
1221
1280
|
/** Flat record of uniform nodes (no nested scopes) */
|
|
1222
1281
|
type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
|
|
@@ -1241,7 +1300,7 @@ declare global {
|
|
|
1241
1300
|
* Acceptable input values for useUniforms - raw values that get converted to UniformNodes
|
|
1242
1301
|
* Supports:
|
|
1243
1302
|
* - Primitives: number, string (color), boolean
|
|
1244
|
-
* - Three.js types: Color, Vector2/3/4,
|
|
1303
|
+
* - Three.js types: Color, Vector2/3/4, Matrix2/3/4
|
|
1245
1304
|
* - Plain objects: { x, y, z, w } converted to vectors
|
|
1246
1305
|
* - TSL nodes: color(), vec3(), float() for type casting
|
|
1247
1306
|
* - UniformNode: existing uniforms (reused as-is)
|
|
@@ -1254,88 +1313,124 @@ declare global {
|
|
|
1254
1313
|
| three_webgpu.Vector2
|
|
1255
1314
|
| three_webgpu.Vector3
|
|
1256
1315
|
| three_webgpu.Vector4
|
|
1316
|
+
| three_webgpu.Matrix2
|
|
1257
1317
|
| three_webgpu.Matrix3
|
|
1258
1318
|
| three_webgpu.Matrix4
|
|
1259
|
-
|
|
|
1260
|
-
|
|
|
1261
|
-
| { x: number; y
|
|
1319
|
+
| { x: number; y: number }
|
|
1320
|
+
| { x: number; y: number; z: number }
|
|
1321
|
+
| { x: number; y: number; z: number; w: number }
|
|
1262
1322
|
| { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
|
|
1263
|
-
| Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1323
|
+
| three_webgpu.Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1264
1324
|
| UniformNode
|
|
1265
1325
|
|
|
1266
1326
|
/** Input record for useUniforms - accepts raw values or UniformNodes */
|
|
1267
1327
|
type UniformInputRecord = Record<string, UniformValue>
|
|
1268
1328
|
}
|
|
1269
1329
|
|
|
1270
|
-
|
|
1271
|
-
|
|
1272
|
-
declare module 'three/tsl' {
|
|
1330
|
+
declare global {
|
|
1273
1331
|
/**
|
|
1274
|
-
*
|
|
1275
|
-
*
|
|
1332
|
+
* three's own render pipeline type. Named here so the rest of R3F refers to three's shape
|
|
1333
|
+
* rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
|
|
1334
|
+
* is r185, so the new name is the only one.
|
|
1276
1335
|
*/
|
|
1277
|
-
|
|
1278
|
-
jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
|
|
1279
|
-
): ShaderCallable<R>
|
|
1336
|
+
type ThreeRenderPipeline = three_webgpu.RenderPipeline
|
|
1280
1337
|
|
|
1281
1338
|
/**
|
|
1282
|
-
*
|
|
1283
|
-
*
|
|
1339
|
+
* The pass `useRenderPipeline` creates for you: three's own `PassNode`, as returned by
|
|
1340
|
+
* `pass(scene, camera)` from `three/tsl`. Referenced from three so members like
|
|
1341
|
+
* `getTextureNode`, `setMRT` and `dispose` track the installed version.
|
|
1284
1342
|
*/
|
|
1285
|
-
|
|
1286
|
-
jsFunc: (inputs: T) => ShaderNodeObject<R>,
|
|
1287
|
-
): ShaderCallable<R>
|
|
1343
|
+
type ScenePassNode = three_webgpu.PassNode
|
|
1288
1344
|
|
|
1289
1345
|
/**
|
|
1290
|
-
*
|
|
1291
|
-
*
|
|
1346
|
+
* Pass record - stores TSL pass nodes for render pipeline.
|
|
1347
|
+
*
|
|
1348
|
+
* `scenePass` is the only key the library owns. It is optional here because this is also the
|
|
1349
|
+
* shape of `state.passes`, which is `{}` before the pipeline exists and again after `reset()`
|
|
1350
|
+
* or `clearPasses()`. Inside the callbacks it is always present; see
|
|
1351
|
+
* {@link RenderPipelineCallbackState}.
|
|
1352
|
+
*
|
|
1353
|
+
* Every other key is user-registered, via a callback's return value. Those are TSL nodes of
|
|
1354
|
+
* any kind, not only passes: texture reads of an MRT attachment, effect nodes, extra
|
|
1355
|
+
* `pass()` instances. `Node` is the common base, so that is the bound. Narrow at the call
|
|
1356
|
+
* site when you need a member, e.g. `passes.velocity as TextureNode`.
|
|
1357
|
+
*
|
|
1358
|
+
* The index signature admits `undefined` because a key may simply not be registered, and
|
|
1359
|
+
* because the optional `scenePass` must be assignable to it: under `skipLibCheck: false` an
|
|
1360
|
+
* optional property whose type excludes `undefined` from the index signature is an error
|
|
1361
|
+
* (TS2411) for every consumer compiling these declarations.
|
|
1292
1362
|
*/
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
|
|
1363
|
+
interface PassRecord {
|
|
1364
|
+
scenePass?: ScenePassNode
|
|
1365
|
+
[key: string]: three_webgpu.Node | undefined
|
|
1366
|
+
}
|
|
1297
1367
|
|
|
1298
1368
|
/**
|
|
1299
|
-
*
|
|
1369
|
+
* State passed to pipeline callbacks after the active pipeline has been created.
|
|
1370
|
+
*
|
|
1371
|
+
* `passes.scenePass` is required here: the hook installs the default scene pass before either
|
|
1372
|
+
* callback runs, so callbacks can use it without a guard or a cast.
|
|
1373
|
+
*
|
|
1374
|
+
* `renderer` is narrowed to `WebGPURenderer` and `isLegacy` to `false`: the hook throws under
|
|
1375
|
+
* the legacy renderer before either callback can run, so a callback never sees WebGL.
|
|
1300
1376
|
*/
|
|
1301
|
-
|
|
1302
|
-
|
|
1303
|
-
|
|
1304
|
-
|
|
1305
|
-
|
|
1377
|
+
type RenderPipelineCallbackState = RootState & {
|
|
1378
|
+
renderPipeline: ThreeRenderPipeline
|
|
1379
|
+
passes: PassRecord & { scenePass: ScenePassNode }
|
|
1380
|
+
renderer: three_webgpu.WebGPURenderer
|
|
1381
|
+
isLegacy: false
|
|
1382
|
+
}
|
|
1306
1383
|
|
|
1307
|
-
declare global {
|
|
1308
1384
|
/**
|
|
1309
|
-
*
|
|
1310
|
-
*
|
|
1311
|
-
* is
|
|
1385
|
+
* What a callback may return to register entries into `state.passes`.
|
|
1386
|
+
*
|
|
1387
|
+
* `scenePass` is reserved. The hook owns that entry and its lifecycle: it caches the pass it
|
|
1388
|
+
* created, and `rebuild()` / `reset()` dispose that cached pass. A callback overwriting the
|
|
1389
|
+
* store entry would leave the store pointing at a node the hook never disposes, and the hook
|
|
1390
|
+
* disposing a pass nothing references. So returning it is a type error.
|
|
1312
1391
|
*/
|
|
1313
|
-
type
|
|
1314
|
-
|
|
1315
|
-
/** Pass record - stores TSL pass nodes for render pipeline */
|
|
1316
|
-
type PassRecord = Record<string, any>
|
|
1392
|
+
type RegisteredPasses = Record<string, three_webgpu.Node> & { scenePass?: never }
|
|
1317
1393
|
|
|
1318
1394
|
/** Setup callback - runs first to configure MRT, create additional passes */
|
|
1319
|
-
type RenderPipelineSetupCallback = (state:
|
|
1395
|
+
type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1320
1396
|
|
|
1321
1397
|
/** Main callback - runs second to configure outputNode, create effect passes */
|
|
1322
|
-
type RenderPipelineMainCallback = (state:
|
|
1398
|
+
type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1323
1399
|
|
|
1324
|
-
/**
|
|
1325
|
-
interface
|
|
1400
|
+
/** The imperative half of useRenderPipeline's return value, present in every state */
|
|
1401
|
+
interface UseRenderPipelineActions {
|
|
1326
1402
|
/** Current passes from state */
|
|
1327
1403
|
passes: PassRecord
|
|
1328
|
-
/** RenderPipeline instance (null if not initialized) */
|
|
1329
|
-
renderPipeline: ThreeRenderPipeline | null
|
|
1330
1404
|
/** Clear all passes from state */
|
|
1331
1405
|
clearPasses: () => void
|
|
1332
1406
|
/** Reset RenderPipeline entirely (clears PP + passes) */
|
|
1333
1407
|
reset: () => void
|
|
1334
1408
|
/** Re-run setup/main callbacks with current closure values */
|
|
1335
1409
|
rebuild: () => void
|
|
1336
|
-
/** True when RenderPipeline is configured and ready */
|
|
1337
|
-
isReady: boolean
|
|
1338
1410
|
}
|
|
1411
|
+
|
|
1412
|
+
/**
|
|
1413
|
+
* Return type for useRenderPipeline hook, discriminated on `isReady`.
|
|
1414
|
+
*
|
|
1415
|
+
* `if (isReady)` narrows `renderPipeline` to non-null, which is what the docs already tell
|
|
1416
|
+
* callers to check. `passes.scenePass` deliberately stays optional in the ready branch:
|
|
1417
|
+
* `clearPasses()` empties the record while leaving the pipeline in place.
|
|
1418
|
+
*/
|
|
1419
|
+
type UseRenderPipelineReturn = UseRenderPipelineActions &
|
|
1420
|
+
(
|
|
1421
|
+
| {
|
|
1422
|
+
/** True when RenderPipeline is configured and ready */
|
|
1423
|
+
isReady: true
|
|
1424
|
+
/** RenderPipeline instance */
|
|
1425
|
+
renderPipeline: ThreeRenderPipeline
|
|
1426
|
+
}
|
|
1427
|
+
| {
|
|
1428
|
+
/** False until the pipeline has been created */
|
|
1429
|
+
isReady: false
|
|
1430
|
+
/** Not initialized yet, or torn down by reset() */
|
|
1431
|
+
renderPipeline: null
|
|
1432
|
+
}
|
|
1433
|
+
)
|
|
1339
1434
|
}
|
|
1340
1435
|
|
|
1341
1436
|
type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
|
|
@@ -1414,10 +1509,11 @@ type TSLNodeInput = { nodeType?: string | null; uuid?: string } | null
|
|
|
1414
1509
|
|
|
1415
1510
|
/**
|
|
1416
1511
|
* For node material properties (colorNode, positionNode, etc.), accept broader types
|
|
1417
|
-
* since @types/three has broken inheritance for TSL node subclasses.
|
|
1512
|
+
* since @types/three has broken inheritance for TSL node subclasses. NodeClass requires
|
|
1513
|
+
* `nodeType`, so this structural key test remains neutral to the selected Three entry.
|
|
1418
1514
|
*/
|
|
1419
1515
|
type NodeProps<P> = {
|
|
1420
|
-
[K in keyof P as P[K] extends
|
|
1516
|
+
[K in keyof P as NonNullable<P[K]> extends { nodeType: string | null } ? K : never]?: TSLNodeInput
|
|
1421
1517
|
}
|
|
1422
1518
|
|
|
1423
1519
|
interface ReactProps<P> {
|
|
@@ -1438,11 +1534,29 @@ type ThreeToJSXElements<T extends Record<string, any>> = {
|
|
|
1438
1534
|
[K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
|
|
1439
1535
|
}
|
|
1440
1536
|
|
|
1537
|
+
/** Method names of Object3D, excluded from the `primitive` element's typed props. */
|
|
1538
|
+
type Object3DMethod = NonNullable<
|
|
1539
|
+
{
|
|
1540
|
+
[K in keyof Object3D]-?: Object3D[K] extends (...args: any[]) => any ? K : never
|
|
1541
|
+
}[keyof Object3D]
|
|
1542
|
+
>
|
|
1543
|
+
|
|
1441
1544
|
type ThreeExports = typeof THREE
|
|
1442
1545
|
type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
|
|
1443
1546
|
|
|
1444
1547
|
interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
|
|
1445
|
-
|
|
1548
|
+
/**
|
|
1549
|
+
* `primitive` wraps a pre-existing object, so its props cannot be derived from one class.
|
|
1550
|
+
* Events are typed from `EventHandlers` (`onClick={(e) => ...}` infers `e`), the ref is
|
|
1551
|
+
* untyped, and any other prop is accepted and applied to the object by name. Object3D's own
|
|
1552
|
+
* methods are left out of the typed surface: they return `this`, so a subclass element's
|
|
1553
|
+
* props (`ThreeElements['group']`) could not be spread onto a primitive otherwise.
|
|
1554
|
+
*/
|
|
1555
|
+
primitive: Omit<ThreeElement<typeof Object3D>, 'args' | 'object' | 'ref' | Object3DMethod> & {
|
|
1556
|
+
object: object
|
|
1557
|
+
ref?: React.Ref<any>
|
|
1558
|
+
[prop: string]: unknown
|
|
1559
|
+
}
|
|
1446
1560
|
// Conflicts with DOM types can be accessed through a three* prefix
|
|
1447
1561
|
threeAudio: ThreeElementsImpl['audio']
|
|
1448
1562
|
threeSource: ThreeElementsImpl['source']
|
|
@@ -1483,6 +1597,7 @@ type three_d_Matrix3 = Matrix3;
|
|
|
1483
1597
|
type three_d_Matrix4 = Matrix4;
|
|
1484
1598
|
type three_d_MutableOrReadonlyParameters<T extends (...args: any) => any> = MutableOrReadonlyParameters<T>;
|
|
1485
1599
|
type three_d_NodeProps<P> = NodeProps<P>;
|
|
1600
|
+
type three_d_Object3DMethod = Object3DMethod;
|
|
1486
1601
|
type three_d_Quaternion = Quaternion;
|
|
1487
1602
|
type three_d_RaycastableRepresentation = RaycastableRepresentation;
|
|
1488
1603
|
type three_d_ReactProps<P> = ReactProps<P>;
|
|
@@ -1497,7 +1612,7 @@ type three_d_Vector3 = Vector3;
|
|
|
1497
1612
|
type three_d_Vector4 = Vector4;
|
|
1498
1613
|
type three_d_VectorRepresentation = VectorRepresentation;
|
|
1499
1614
|
declare namespace three_d {
|
|
1500
|
-
export type { three_d_Color as Color, three_d_ElementProps as ElementProps, three_d_Euler as Euler, three_d_EventProps as EventProps, three_d_GeometryProps as GeometryProps, three_d_GeometryTransformProps as GeometryTransformProps, three_d_Layers as Layers, three_d_MathProps as MathProps, three_d_MathRepresentation as MathRepresentation, three_d_MathType as MathType, three_d_MathTypes as MathTypes, three_d_Matrix3 as Matrix3, three_d_Matrix4 as Matrix4, three_d_MutableOrReadonlyParameters as MutableOrReadonlyParameters, three_d_NodeProps as NodeProps, three_d_Quaternion as Quaternion, three_d_RaycastableRepresentation as RaycastableRepresentation, three_d_ReactProps as ReactProps, three_d_TSLNodeInput as TSLNodeInput, three_d_ThreeElement as ThreeElement, three_d_ThreeElements as ThreeElements, three_d_ThreeElementsImpl as ThreeElementsImpl, three_d_ThreeExports as ThreeExports, three_d_ThreeToJSXElements as ThreeToJSXElements, three_d_Vector2 as Vector2, three_d_Vector3 as Vector3, three_d_Vector4 as Vector4, three_d_VectorRepresentation as VectorRepresentation };
|
|
1615
|
+
export type { three_d_Color as Color, three_d_ElementProps as ElementProps, three_d_Euler as Euler, three_d_EventProps as EventProps, three_d_GeometryProps as GeometryProps, three_d_GeometryTransformProps as GeometryTransformProps, three_d_Layers as Layers, three_d_MathProps as MathProps, three_d_MathRepresentation as MathRepresentation, three_d_MathType as MathType, three_d_MathTypes as MathTypes, three_d_Matrix3 as Matrix3, three_d_Matrix4 as Matrix4, three_d_MutableOrReadonlyParameters as MutableOrReadonlyParameters, three_d_NodeProps as NodeProps, three_d_Object3DMethod as Object3DMethod, three_d_Quaternion as Quaternion, three_d_RaycastableRepresentation as RaycastableRepresentation, three_d_ReactProps as ReactProps, three_d_TSLNodeInput as TSLNodeInput, three_d_ThreeElement as ThreeElement, three_d_ThreeElements as ThreeElements, three_d_ThreeElementsImpl as ThreeElementsImpl, three_d_ThreeExports as ThreeExports, three_d_ThreeToJSXElements as ThreeToJSXElements, three_d_Vector2 as Vector2, three_d_Vector3 as Vector3, three_d_Vector4 as Vector4, three_d_VectorRepresentation as VectorRepresentation };
|
|
1501
1616
|
}
|
|
1502
1617
|
|
|
1503
1618
|
/**
|
|
@@ -1846,7 +1961,43 @@ declare function createEvents(store: RootStore): {
|
|
|
1846
1961
|
processDeferredPointer: (event: DomEvent, pointerId: number) => void;
|
|
1847
1962
|
};
|
|
1848
1963
|
/** Default R3F event manager for web */
|
|
1849
|
-
declare function createPointerEvents(store: RootStore): EventManager<
|
|
1964
|
+
declare function createPointerEvents(store: RootStore): EventManager<Element>;
|
|
1965
|
+
|
|
1966
|
+
interface RootExtension {
|
|
1967
|
+
/** Unique name. Registering the same name again replaces the entry (HMR-safe); roots it already
|
|
1968
|
+
* set up are not set up a second time, but get the new entry's dispose and hmr. */
|
|
1969
|
+
name: string;
|
|
1970
|
+
/**
|
|
1971
|
+
* Called once per root, after its renderer exists and before `onCreated` and the first frame.
|
|
1972
|
+
* `isLegacy` and `primaryStore` are known by then, so an extension can skip WebGL roots or defer
|
|
1973
|
+
* to the primary canvas. Return fields to merge into the root's state, or nothing.
|
|
1974
|
+
*/
|
|
1975
|
+
setup?(store: RootStore): Partial<RootState> | void;
|
|
1976
|
+
/** Called when a root this extension set up unmounts. */
|
|
1977
|
+
dispose?(store: RootStore): void;
|
|
1978
|
+
/** Called when `<Canvas>` detects hot module replacement (skipped with `hmr={false}`). */
|
|
1979
|
+
hmr?(store: RootStore): void;
|
|
1980
|
+
}
|
|
1981
|
+
/**
|
|
1982
|
+
* Register an extension. It is set up on every live root immediately, and on every root created
|
|
1983
|
+
* afterwards. Returns a function that unregisters it: new roots are no longer set up, while roots
|
|
1984
|
+
* it already set up keep its state and still get its dispose when they unmount.
|
|
1985
|
+
*/
|
|
1986
|
+
declare function registerRootExtension(extension: RootExtension): () => void;
|
|
1987
|
+
/**
|
|
1988
|
+
* Point a root's default render job at a different render function, or back at
|
|
1989
|
+
* `renderer.render(scene, camera)` with `null`.
|
|
1990
|
+
*
|
|
1991
|
+
* The default job keeps everything else: the Canvas `fps` throttle, error propagation to the error
|
|
1992
|
+
* boundary, and backing off when a user `useFrame(..., { phase: 'render' })` job takes over.
|
|
1993
|
+
*/
|
|
1994
|
+
declare function setRenderOverride(store: RootStore, render: (() => void) | null): void;
|
|
1995
|
+
|
|
1996
|
+
/**
|
|
1997
|
+
* Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
|
|
1998
|
+
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
|
|
1999
|
+
*/
|
|
2000
|
+
declare function useStore(): RootStore;
|
|
1850
2001
|
|
|
1851
2002
|
/**
|
|
1852
2003
|
* Gets or creates a memoized loader instance from a loader constructor or returns the loader if it's already an instance.
|
|
@@ -1866,50 +2017,6 @@ declare namespace useLoader {
|
|
|
1866
2017
|
var loader: typeof getLoader;
|
|
1867
2018
|
}
|
|
1868
2019
|
|
|
1869
|
-
/**
|
|
1870
|
-
* Frame hook with phase-based ordering, priority, and FPS throttling.
|
|
1871
|
-
*
|
|
1872
|
-
* Always delivers full RootState — works both inside and outside Canvas context:
|
|
1873
|
-
* - Inside Canvas: Full RootState (renderer, scene, camera, etc.)
|
|
1874
|
-
* - Outside Canvas: The job registers immediately but the callback is held until a
|
|
1875
|
-
* Canvas adopts it, then runs with full RootState. For hostless / standalone
|
|
1876
|
-
* frame loops with no Canvas, use `@pmndrs/scheduler` directly.
|
|
1877
|
-
*
|
|
1878
|
-
* Returns a controls object for manual stepping, pausing, and resuming.
|
|
1879
|
-
*
|
|
1880
|
-
* @param callback - Function called each frame with (state, delta). Optional if you only need scheduler access.
|
|
1881
|
-
* @param priorityOrOptions - Either a priority number (backwards compat) or options object
|
|
1882
|
-
* @returns Controls object with step(), stepAll(), pause(), resume(), isPaused, id, scheduler
|
|
1883
|
-
*
|
|
1884
|
-
* @example
|
|
1885
|
-
* // Simple priority (backwards compat)
|
|
1886
|
-
* useFrame((state, delta) => { ... }, 5)
|
|
1887
|
-
*
|
|
1888
|
-
* @example
|
|
1889
|
-
* // With phase-based ordering
|
|
1890
|
-
* useFrame((state, delta) => { ... }, { phase: 'physics' })
|
|
1891
|
-
*
|
|
1892
|
-
* @example
|
|
1893
|
-
* // Outside Canvas - callback waits for a Canvas, then always has full state
|
|
1894
|
-
* function UI() {
|
|
1895
|
-
* useFrame((state, delta) => { syncUI(state.camera) });
|
|
1896
|
-
* return <button>...</button>;
|
|
1897
|
-
* }
|
|
1898
|
-
*
|
|
1899
|
-
* @example
|
|
1900
|
-
* // Hostless / standalone loop (no Canvas) - use @pmndrs/scheduler directly
|
|
1901
|
-
* import { getScheduler } from '@pmndrs/scheduler'
|
|
1902
|
-
* getScheduler().register((state, delta) => { updateGame(delta) })
|
|
1903
|
-
*
|
|
1904
|
-
* @example
|
|
1905
|
-
* // Scheduler-only access (no callback)
|
|
1906
|
-
* const { scheduler } = useFrame()
|
|
1907
|
-
* scheduler.pauseJob('some-job-id')
|
|
1908
|
-
*
|
|
1909
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useframe
|
|
1910
|
-
*/
|
|
1911
|
-
declare function useFrame(callback?: FrameNextCallback, priorityOrOptions?: number | UseFrameNextOptions): FrameNextControls;
|
|
1912
|
-
|
|
1913
2020
|
declare const IsObject: (url: unknown) => url is Record<string, string>;
|
|
1914
2021
|
type TextureArray<T> = T extends string[] ? Texture$1[] : never;
|
|
1915
2022
|
type TextureRecord<T> = T extends Record<string, string> ? {
|
|
@@ -2090,16 +2197,6 @@ declare function useRenderTarget(options?: RenderTargetOptions): WebGLRenderTarg
|
|
|
2090
2197
|
declare function useRenderTarget(size: number, options?: RenderTargetOptions): WebGLRenderTarget;
|
|
2091
2198
|
declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): WebGLRenderTarget;
|
|
2092
2199
|
|
|
2093
|
-
/**
|
|
2094
|
-
* Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
|
|
2095
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
|
|
2096
|
-
*/
|
|
2097
|
-
declare function useStore(): RootStore;
|
|
2098
|
-
/**
|
|
2099
|
-
* Accesses R3F's internal state, containing renderer, canvas, scene, etc.
|
|
2100
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usethree
|
|
2101
|
-
*/
|
|
2102
|
-
declare function useThree<T = RootState>(selector?: (state: RootState) => T, equalityFn?: <T>(state: T, newState: T) => boolean): T;
|
|
2103
2200
|
/**
|
|
2104
2201
|
* Exposes an object's {@link Instance}.
|
|
2105
2202
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#useInstanceHandle
|
|
@@ -2175,7 +2272,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
|
|
|
2175
2272
|
* Invalidates the view, requesting a frame to be rendered.
|
|
2176
2273
|
* In demand mode, this triggers the scheduler to run frames.
|
|
2177
2274
|
*
|
|
2178
|
-
*
|
|
2275
|
+
* With a state argument, only that root's jobs run on the requested frames; other
|
|
2276
|
+
* roots on 'demand' stay idle. Without one, every registered root is invalidated.
|
|
2277
|
+
*
|
|
2278
|
+
* @param state - Optional root state; targets the invalidation at that root
|
|
2179
2279
|
* @param frames - Number of frames to request (default: 1)
|
|
2180
2280
|
* @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
|
|
2181
2281
|
*
|
|
@@ -2186,14 +2286,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
|
|
|
2186
2286
|
* Advances the frameloop and runs render effects.
|
|
2187
2287
|
* Useful for when manually rendering via `frameloop="never"`.
|
|
2188
2288
|
*
|
|
2289
|
+
* With a state argument, only that root is stepped. Without one, every
|
|
2290
|
+
* registered root is stepped for backwards compatibility.
|
|
2291
|
+
*
|
|
2189
2292
|
* @param timestamp - The timestamp to use for this frame
|
|
2190
2293
|
* @param runGlobalEffects - Ignored (kept for backwards compat, global effects always run)
|
|
2191
|
-
* @param state -
|
|
2192
|
-
* @param frame - Ignored (kept for backwards compat)
|
|
2294
|
+
* @param state - Optional root state; targets the manual step at that root
|
|
2193
2295
|
*
|
|
2194
2296
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
|
|
2195
2297
|
*/
|
|
2196
|
-
declare function advance(timestamp: number): void;
|
|
2298
|
+
declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
|
|
2197
2299
|
|
|
2198
2300
|
/* eslint-disable @definitelytyped/no-unnecessary-generics */
|
|
2199
2301
|
declare function ReactReconciler<
|
|
@@ -3238,6 +3340,7 @@ declare namespace ReactReconciler {
|
|
|
3238
3340
|
|
|
3239
3341
|
declare function extend<T extends ConstructorRepresentation>(objects: T): React$1.ExoticComponent<ThreeElement<T>>;
|
|
3240
3342
|
declare function extend<T extends Catalogue>(objects: T): void;
|
|
3343
|
+
declare function extend(objects: Record<string, unknown>): void;
|
|
3241
3344
|
declare const reconciler: ReactReconciler.Reconciler<RootStore, Instance<any>, void, Instance<any>, never, any>;
|
|
3242
3345
|
|
|
3243
3346
|
declare const isRenderer: (def: any) => boolean;
|
|
@@ -3262,6 +3365,7 @@ declare function Portal({ children, container, state }: PortalProps): JSX.Elemen
|
|
|
3262
3365
|
declare function flushSync<R>(fn: () => R): R;
|
|
3263
3366
|
|
|
3264
3367
|
declare const context: React$1.Context<RootStore>;
|
|
3368
|
+
|
|
3265
3369
|
declare const createStore: (invalidate: (state?: RootState, frames?: number, stackFrames?: boolean) => void, advance: (timestamp: number, runGlobalEffects?: boolean, state?: RootState, frame?: XRFrame) => void) => RootStore;
|
|
3266
3370
|
|
|
3267
3371
|
/**
|
|
@@ -3515,7 +3619,7 @@ declare function getInstanceProps<T = any>(pendingProps: Record<string, unknown>
|
|
|
3515
3619
|
declare function prepare<T = any>(target: T, root: RootStore, type: string, props: Instance<T>['props']): Instance<T>;
|
|
3516
3620
|
/**
|
|
3517
3621
|
* Triggers an update for an instance.
|
|
3518
|
-
*
|
|
3622
|
+
* Invalidates the frame if the root is in demand mode.
|
|
3519
3623
|
*
|
|
3520
3624
|
* @param instance - Instance to invalidate
|
|
3521
3625
|
*/
|
|
@@ -3681,29 +3785,44 @@ declare const hasConstructor: (object: unknown) => object is {
|
|
|
3681
3785
|
* Used to identify values that should be resolved from refs after mount.
|
|
3682
3786
|
*/
|
|
3683
3787
|
declare const FROM_REF: unique symbol;
|
|
3788
|
+
/** The marker `fromRef()` returns; resolved by the reconciler in `commitMount`. */
|
|
3789
|
+
interface FromRefMarker<T = unknown, R = T> {
|
|
3790
|
+
[FROM_REF]: React$1.RefObject<T | null>;
|
|
3791
|
+
/** Optional transform applied to the resolved ref before assignment. */
|
|
3792
|
+
transform?: (value: T) => R;
|
|
3793
|
+
}
|
|
3684
3794
|
/**
|
|
3685
3795
|
* Defers prop application until the referenced object is available.
|
|
3686
3796
|
* Useful for props like `target` that need sibling refs to be populated.
|
|
3687
3797
|
*
|
|
3798
|
+
* Only top-level props on a three element are resolved: a marker nested inside another value
|
|
3799
|
+
* (an array, an options object) is never seen. When the prop needs the sibling *wrapped* rather
|
|
3800
|
+
* than assigned as-is, pass a `transform`; it runs once the ref is populated and its result is
|
|
3801
|
+
* what gets assigned.
|
|
3802
|
+
*
|
|
3688
3803
|
* @param ref - React ref object to resolve at mount time
|
|
3689
|
-
* @
|
|
3804
|
+
* @param transform - Optional mapping from the resolved object to the value the prop expects
|
|
3805
|
+
* @returns A marker value that the reconciler resolves after mount
|
|
3690
3806
|
*
|
|
3691
3807
|
* @example
|
|
3692
3808
|
* const targetRef = useRef<THREE.Object3D>(null)
|
|
3693
3809
|
*
|
|
3694
3810
|
* <group ref={targetRef} position={[-3, -2, -15]} />
|
|
3695
3811
|
* <spotLight target={fromRef(targetRef)} intensity={100} />
|
|
3812
|
+
*
|
|
3813
|
+
* @example
|
|
3814
|
+
* // Wrap the sibling: a node material's lightsNode needs a LightsNode, not the light itself
|
|
3815
|
+
* <meshPhongNodeMaterial lightsNode={fromRef(lightRef, (light) => lights([light]))} />
|
|
3696
3816
|
*/
|
|
3697
3817
|
declare function fromRef<T>(ref: React$1.RefObject<T | null>): T;
|
|
3818
|
+
declare function fromRef<T, R>(ref: React$1.RefObject<T | null>, transform: (value: T) => R): R;
|
|
3698
3819
|
/**
|
|
3699
3820
|
* Type guard to check if a value is a fromRef marker.
|
|
3700
3821
|
*
|
|
3701
3822
|
* @param value - Value to check
|
|
3702
3823
|
* @returns True if value is a fromRef marker
|
|
3703
3824
|
*/
|
|
3704
|
-
declare function isFromRef(value: unknown): value is
|
|
3705
|
-
[FROM_REF]: React$1.RefObject<any>;
|
|
3706
|
-
};
|
|
3825
|
+
declare function isFromRef(value: unknown): value is FromRefMarker<any, unknown>;
|
|
3707
3826
|
|
|
3708
3827
|
/**
|
|
3709
3828
|
* Symbol marker for mount-only method calls.
|
|
@@ -3730,7 +3849,15 @@ declare const ONCE: unique symbol;
|
|
|
3730
3849
|
* // No arguments
|
|
3731
3850
|
* <geometry center={once()} />
|
|
3732
3851
|
*/
|
|
3733
|
-
declare function once<
|
|
3852
|
+
declare function once<A extends unknown[]>(...args: A): OnceValue<A>;
|
|
3853
|
+
/**
|
|
3854
|
+
* What `once(...args)` is typed as, so the marker is assignable to the prop it targets:
|
|
3855
|
+
* the single argument itself (`rotateX={once(angle)}`), the argument tuple for multi-argument
|
|
3856
|
+
* methods (`translate={once(x, y, z)}`), or `true` for a bare call (`center={once()}`).
|
|
3857
|
+
*
|
|
3858
|
+
* The runtime value is always the marker object; only the declared type follows the prop.
|
|
3859
|
+
*/
|
|
3860
|
+
type OnceValue<A extends unknown[]> = A extends [] ? true : A extends [infer Single] ? Single : A;
|
|
3734
3861
|
/**
|
|
3735
3862
|
* Type guard to check if a value is a once marker.
|
|
3736
3863
|
*
|
|
@@ -3742,10 +3869,31 @@ declare function isOnce(value: unknown): value is {
|
|
|
3742
3869
|
};
|
|
3743
3870
|
|
|
3744
3871
|
/**
|
|
3745
|
-
*
|
|
3746
|
-
*
|
|
3872
|
+
* @fileoverview Legacy entry point - WebGL only
|
|
3873
|
+
*
|
|
3874
|
+
* This entry point is for apps that want to use the legacy WebGLRenderer.
|
|
3875
|
+
* No WebGPU features are available from this import path.
|
|
3876
|
+
* Auto-extends THREE with WebGL-only constructors (no node materials).
|
|
3877
|
+
*
|
|
3878
|
+
* Usage:
|
|
3879
|
+
* import { Canvas, useFrame } from '@react-three/fiber/legacy'
|
|
3747
3880
|
*/
|
|
3748
|
-
declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
|
|
3749
3881
|
|
|
3750
|
-
|
|
3751
|
-
|
|
3882
|
+
/** `useThree` narrowed to legacy state — `state.renderer` is a `WebGLRenderer`. */
|
|
3883
|
+
type UseThreeLegacy = <T = LegacyRootState>(selector?: (state: LegacyRootState) => T, equalityFn?: <U>(state: U, newState: U) => boolean) => T;
|
|
3884
|
+
/** `useFrame` narrowed to legacy state — the callback's `state.renderer` is a `WebGLRenderer`. */
|
|
3885
|
+
type UseFrameLegacy = (callback?: FrameCallback$1<LegacyRootState>, priorityOrOptions?: number | UseFrameNextOptions) => FrameNextControls;
|
|
3886
|
+
declare const useThree: UseThreeLegacy;
|
|
3887
|
+
declare const useFrame: UseFrameLegacy;
|
|
3888
|
+
|
|
3889
|
+
/** Canvas props on the legacy entry: `onCreated` receives `LegacyRootState`. */
|
|
3890
|
+
type LegacyCanvasProps = Omit<CanvasProps, 'onCreated'> & {
|
|
3891
|
+
/** Callback after the canvas has rendered (but not yet committed); `state.renderer` is a `WebGLRenderer` */
|
|
3892
|
+
onCreated?: (state: LegacyRootState) => void;
|
|
3893
|
+
};
|
|
3894
|
+
|
|
3895
|
+
/** `Canvas` narrowed to legacy state — the same component, `onCreated` typed against `LegacyRootState`. */
|
|
3896
|
+
declare const Canvas: (props: LegacyCanvasProps) => JSX.Element;
|
|
3897
|
+
|
|
3898
|
+
export { Block, Canvas, Environment, EnvironmentCube, EnvironmentMap, EnvironmentPortal, ErrorBoundary, FROM_REF, IsObject, ONCE, Portal, R3F_BUILD_LEGACY, R3F_BUILD_WEBGPU, REACT_INTERNAL_PROPS, RESERVED_PROPS, three_d as ReactThreeFiber, Texture, _roots, addAfterEffect, addEffect, addTail, advance, applyProps, attach, buildGraph, calculateDpr, context, createEvents, createPointerEvents, createPortal, createRoot, createStore, detach, diffProps, dispose, createPointerEvents as events, extend, findInitialRoot, flushSync, fromRef, getInstanceProps, getPrimary, getPrimaryIds, getRootState, getUuidPrefix, hasConstructor, hasPrimary, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isFromRef, isObject3D, isOnce, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, once, prepare, presetsObj, reconciler, registerPrimary, registerRootExtension, removeInteractivity, resolve, setRenderOverride, swapInteractivity, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useMutableCallback, useRenderTarget, useStore, useTexture, useTextures, useThree, waitForPrimary };
|
|
3899
|
+
export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferLike, BufferRecord, BufferStore, Camera, CameraProps, LegacyCanvasProps as CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DisposeOptions, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, FromRefMarker, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, LegacyInternalState as InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyCanvasProps, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeLike, NodeProps, NodeRecord, NodeStore, NonFunctionKeys, Object3DMethod, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, OnceValue, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, LegacyRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootExtension, LegacyRootState as RootState, RootStore, SetBlock, Size, StorageLike, StorageRecord, StorageStore, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseFrameLegacy, UseTextureOptions, UseTexturesReturn, UseThreeLegacy, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };
|