@react-three/fiber 10.0.0-alpha.3 → 10.0.0-alpha.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +143 -90
- package/dist/index.d.cts +288 -143
- package/dist/index.d.mts +288 -143
- package/dist/index.d.ts +286 -169
- package/dist/index.mjs +143 -90
- package/dist/legacy.cjs +141 -92
- package/dist/legacy.d.cts +291 -150
- package/dist/legacy.d.mts +291 -150
- package/dist/legacy.d.ts +289 -174
- package/dist/legacy.mjs +141 -92
- package/dist/webgpu/index.cjs +260 -182
- package/dist/webgpu/index.d.cts +368 -254
- package/dist/webgpu/index.d.mts +368 -254
- package/dist/webgpu/index.d.ts +366 -280
- package/dist/webgpu/index.mjs +260 -182
- package/package.json +2 -2
package/dist/webgpu/index.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
|
+
import * as three_examples_jsm_inspector_Inspector_js from 'three/examples/jsm/inspector/Inspector.js';
|
|
1
2
|
import * as three_webgpu from 'three/webgpu';
|
|
2
|
-
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';
|
|
3
4
|
import { Inspector } from 'three/addons/inspector/Inspector.js';
|
|
4
5
|
import * as THREE$1 from 'three';
|
|
5
6
|
import { Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1 } from 'three';
|
|
@@ -13,20 +14,6 @@ import { Options } from 'react-use-measure';
|
|
|
13
14
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
14
15
|
import { GroundedSkybox } from 'three/examples/jsm/objects/GroundedSkybox.js';
|
|
15
16
|
|
|
16
|
-
function _mergeNamespaces(n, m) {
|
|
17
|
-
m.forEach(function (e) {
|
|
18
|
-
e && typeof e !== 'string' && !Array.isArray(e) && Object.keys(e).forEach(function (k) {
|
|
19
|
-
if (k !== 'default' && !(k in n)) {
|
|
20
|
-
var d = Object.getOwnPropertyDescriptor(e, k);
|
|
21
|
-
Object.defineProperty(n, k, d.get ? d : {
|
|
22
|
-
enumerable: true,
|
|
23
|
-
get: function () { return e[k]; }
|
|
24
|
-
});
|
|
25
|
-
}
|
|
26
|
-
});
|
|
27
|
-
});
|
|
28
|
-
return Object.freeze(n);
|
|
29
|
-
}
|
|
30
17
|
|
|
31
18
|
/**
|
|
32
19
|
* @fileoverview Internal Three.js re-exports - WEBGPU ONLY ENTRY
|
|
@@ -40,6 +27,8 @@ function _mergeNamespaces(n, m) {
|
|
|
40
27
|
declare const R3F_BUILD_LEGACY = false;
|
|
41
28
|
declare const R3F_BUILD_WEBGPU = true;
|
|
42
29
|
|
|
30
|
+
/** Lazily load the three Inspector. Keeps it out of the eager module graph — see note above. */
|
|
31
|
+
declare function loadInspector(): Promise<typeof three_examples_jsm_inspector_Inspector_js.Inspector>;
|
|
43
32
|
declare const WebGLRenderer: {
|
|
44
33
|
new (): {};
|
|
45
34
|
};
|
|
@@ -50,19 +39,6 @@ declare const WebGLRenderTarget: any;
|
|
|
50
39
|
|
|
51
40
|
declare const WebGLCubeRenderTarget: any;
|
|
52
41
|
|
|
53
|
-
var THREE = /*#__PURE__*/_mergeNamespaces({
|
|
54
|
-
__proto__: null,
|
|
55
|
-
CubeRenderTargetCompat: CubeRenderTarget,
|
|
56
|
-
Inspector: Inspector,
|
|
57
|
-
R3F_BUILD_LEGACY: R3F_BUILD_LEGACY,
|
|
58
|
-
R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
|
|
59
|
-
RenderTargetCompat: RenderTarget,
|
|
60
|
-
WebGLCubeRenderTarget: WebGLCubeRenderTarget,
|
|
61
|
-
WebGLRenderTarget: WebGLRenderTarget,
|
|
62
|
-
WebGLRenderer: WebGLRenderer,
|
|
63
|
-
WebGLRendererParameters: WebGLRendererParameters,
|
|
64
|
-
WebGLShadowMap: WebGLShadowMap
|
|
65
|
-
}, [three_webgpu]);
|
|
66
42
|
|
|
67
43
|
//* Utility Types ==============================
|
|
68
44
|
|
|
@@ -350,6 +326,7 @@ type BufferLike =
|
|
|
350
326
|
| Uint16Array
|
|
351
327
|
| Int16Array
|
|
352
328
|
| THREE$1.BufferAttribute // Base class for all buffer attributes
|
|
329
|
+
| THREE$1.InterleavedBufferAttribute
|
|
353
330
|
| Node // TSL buffer nodes (instancedArray, storage)
|
|
354
331
|
|
|
355
332
|
/** Flat record of buffer-like values (no nested scopes) */
|
|
@@ -361,6 +338,25 @@ type BufferRecord = Record<string, BufferLike>
|
|
|
361
338
|
*/
|
|
362
339
|
type BufferStore = Record<string, BufferLike | BufferRecord>
|
|
363
340
|
|
|
341
|
+
//* Node Types (useNodes) ========================================
|
|
342
|
+
|
|
343
|
+
/**
|
|
344
|
+
* Every node representation `useNodes` accepts and `state.nodes` holds: three's real `Node`,
|
|
345
|
+
* the callable proxy `Fn()` returns, and the legacy structural shape (`uuid`/`nodeType`) older
|
|
346
|
+
* code passes through. Creators are constrained to this same type, so the shape a creator returns
|
|
347
|
+
* and the shape the store holds are one type by construction.
|
|
348
|
+
*/
|
|
349
|
+
type NodeLike = TSLNodeType | LegacyTSLNodeLike
|
|
350
|
+
|
|
351
|
+
/** Flat record of TSL nodes (no nested scopes) */
|
|
352
|
+
type NodeRecord<T extends NodeLike = NodeLike> = Record<string, T>
|
|
353
|
+
|
|
354
|
+
/**
|
|
355
|
+
* Node store that can contain both root-level nodes and scoped node objects.
|
|
356
|
+
* Structure: { wobble: OperatorNode, fx: { blur: ShaderCallable } }
|
|
357
|
+
*/
|
|
358
|
+
type NodeStore = Record<string, NodeLike | NodeRecord>
|
|
359
|
+
|
|
364
360
|
//* Storage Types (useGPUStorage) ========================================
|
|
365
361
|
|
|
366
362
|
/**
|
|
@@ -375,7 +371,9 @@ type BufferStore = Record<string, BufferLike | BufferRecord>
|
|
|
375
371
|
* ```
|
|
376
372
|
*/
|
|
377
373
|
type StorageLike =
|
|
378
|
-
| StorageTexture // GPU storage texture
|
|
374
|
+
| StorageTexture // 2D GPU storage texture
|
|
375
|
+
| Storage3DTexture // 3D GPU storage texture (volumes, fluid grids)
|
|
376
|
+
| StorageArrayTexture // 2D-array GPU storage texture
|
|
379
377
|
| Data3DTexture // 3D texture (can be used as storage)
|
|
380
378
|
| Node // TSL storage texture nodes (storageTexture)
|
|
381
379
|
|
|
@@ -494,11 +492,28 @@ interface InternalState {
|
|
|
494
492
|
/** Container for child attachment (scene for root, original container for portals) */
|
|
495
493
|
container?: THREE$1.Object3D
|
|
496
494
|
/**
|
|
497
|
-
* CanvasTarget
|
|
498
|
-
*
|
|
495
|
+
* The CanvasTarget this root sizes and renders through.
|
|
496
|
+
*
|
|
497
|
+
* A primary (`<Canvas id>`) owns the renderer's default target -- the one three itself built
|
|
498
|
+
* around the canvas element -- so sizing it is sizing the renderer. A secondary owns a target
|
|
499
|
+
* R3F created for its own element. Either way there is exactly one target per canvas element,
|
|
500
|
+
* and the canvas-target job makes it the renderer's active one before this root renders.
|
|
501
|
+
* Absent on WebGL and on an id-less WebGPU canvas, where the renderer is sized directly.
|
|
499
502
|
* @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
|
|
500
503
|
*/
|
|
501
504
|
canvasTarget?: CanvasTarget
|
|
505
|
+
/**
|
|
506
|
+
* Set when this root's canvas target has been resized and the backend's cached render pass
|
|
507
|
+
* descriptor (which holds a depth-stencil view built once per canvas) is therefore stale.
|
|
508
|
+
*
|
|
509
|
+
* Flushed by the canvas-target job in the `start` phase, which is the only place this root's
|
|
510
|
+
* target is guaranteed to be the renderer's active one — `backend.updateSize()` operates on
|
|
511
|
+
* whatever `getCanvasTarget()` returns, so calling it from the resize subscription would
|
|
512
|
+
* invalidate some other canvas's descriptor instead.
|
|
513
|
+
*
|
|
514
|
+
* @see https://github.com/pmndrs/react-three-fiber/issues/3847
|
|
515
|
+
*/
|
|
516
|
+
canvasTargetSizeDirty?: boolean
|
|
502
517
|
/**
|
|
503
518
|
* Whether multi-canvas rendering is active.
|
|
504
519
|
* True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
|
|
@@ -608,7 +623,7 @@ interface RootState {
|
|
|
608
623
|
/** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
|
|
609
624
|
uniforms: UniformStore
|
|
610
625
|
/** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
|
|
611
|
-
nodes:
|
|
626
|
+
nodes: NodeStore
|
|
612
627
|
/** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
|
|
613
628
|
buffers: BufferStore
|
|
614
629
|
/** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
|
|
@@ -620,7 +635,7 @@ interface RootState {
|
|
|
620
635
|
/** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
|
|
621
636
|
renderPipeline: ThreeRenderPipeline | null
|
|
622
637
|
/** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
|
|
623
|
-
passes:
|
|
638
|
+
passes: PassRecord
|
|
624
639
|
/** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
|
|
625
640
|
_hmrVersion: number
|
|
626
641
|
/** Internal: whether setSize() has taken ownership of canvas dimensions */
|
|
@@ -708,12 +723,19 @@ type DefaultRendererProps = {
|
|
|
708
723
|
*/
|
|
709
724
|
interface CanvasSchedulerConfig {
|
|
710
725
|
/**
|
|
711
|
-
*
|
|
712
|
-
* Pass the `id` of another canvas.
|
|
726
|
+
* Run this Canvas root before the referenced Canvas root id(s).
|
|
713
727
|
*/
|
|
714
|
-
|
|
728
|
+
before?: string | string[]
|
|
715
729
|
/**
|
|
716
|
-
*
|
|
730
|
+
* Run this Canvas root after the referenced Canvas root id(s).
|
|
731
|
+
*/
|
|
732
|
+
after?: string | string[]
|
|
733
|
+
/**
|
|
734
|
+
* Numeric root order. Lower values run first.
|
|
735
|
+
*/
|
|
736
|
+
order?: number
|
|
737
|
+
/**
|
|
738
|
+
* Limit this Canvas's default render job (frames per second).
|
|
717
739
|
*/
|
|
718
740
|
fps?: number
|
|
719
741
|
}
|
|
@@ -800,14 +822,17 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
|
|
|
800
822
|
performance?: Partial<Omit<Performance, 'regress'>>
|
|
801
823
|
/** Target pixel ratio. Can clamp between a range: `[min, max]` */
|
|
802
824
|
dpr?: Dpr
|
|
803
|
-
/**
|
|
804
|
-
|
|
825
|
+
/**
|
|
826
|
+
* Props that go into the default raycaster. `params` is merged into the raycaster's defaults,
|
|
827
|
+
* so a single threshold can be set: `raycaster={{ params: { Points: { threshold: 0.2 } } }}`.
|
|
828
|
+
*/
|
|
829
|
+
raycaster?: Partial<Omit<THREE$1.Raycaster, 'params'>> & { params?: Partial<THREE$1.RaycasterParameters> }
|
|
805
830
|
/** A `THREE.Scene` instance or props that go into the default scene */
|
|
806
831
|
scene?: THREE$1.Scene | Partial<THREE$1.Scene>
|
|
807
832
|
/** A `THREE.Camera` instance or props that go into the default camera */
|
|
808
833
|
camera?: CameraProps
|
|
809
834
|
/** An R3F event manager to manage elements' pointer events */
|
|
810
|
-
events?: (store: RootStore) => EventManager<
|
|
835
|
+
events?: (store: RootStore) => EventManager<Element>
|
|
811
836
|
/** Callback after the canvas has rendered (but not yet committed) */
|
|
812
837
|
onCreated?: (state: RootState) => void
|
|
813
838
|
/** Response for pointer clicks that have missed any target */
|
|
@@ -1036,7 +1061,7 @@ interface CanvasProps
|
|
|
1036
1061
|
*/
|
|
1037
1062
|
resize?: Options
|
|
1038
1063
|
/** The target where events are being subscribed to, default: the div that wraps canvas */
|
|
1039
|
-
eventSource?:
|
|
1064
|
+
eventSource?: Element | React$1.RefObject<Element | null>
|
|
1040
1065
|
/** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
|
|
1041
1066
|
eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
|
|
1042
1067
|
/** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
|
|
@@ -1144,81 +1169,86 @@ interface LegacyRootState extends Omit<RootState, 'renderer' | 'internal'> {
|
|
|
1144
1169
|
|
|
1145
1170
|
type RenderTargetOptions = RenderTargetOptions$1
|
|
1146
1171
|
|
|
1147
|
-
//* Global Types ==============================
|
|
1172
|
+
//* Global TSL Types ==============================
|
|
1148
1173
|
|
|
1149
1174
|
declare global {
|
|
1150
1175
|
/**
|
|
1151
|
-
*
|
|
1152
|
-
*
|
|
1153
|
-
* This is three's own `UniformNode`, not a re-declaration of it. It previously was a
|
|
1154
|
-
* hand-rolled `interface UniformNode<T> extends Node { value: T }`, which shadowed the real
|
|
1155
|
-
* exported type globally — so R3F's ~58 references resolved to an approximation that was
|
|
1156
|
-
* missing members three actually ships (`setName` among them) and had drifted to the wrong
|
|
1157
|
-
* arity when three made `UniformNode` two-parameter.
|
|
1158
|
-
*
|
|
1159
|
-
* three's signature is `UniformNode<TNodeType, TValue>`. R3F only ever varies the value type,
|
|
1160
|
-
* so the node type is fixed to `unknown` and the single parameter is kept for call-site
|
|
1161
|
-
* ergonomics. The result is three's structural type, so members stay in sync with the
|
|
1162
|
-
* installed three instead of needing to be mirrored by hand.
|
|
1176
|
+
* Broad callable-node fallback for dynamic store readers.
|
|
1177
|
+
* Creator hooks preserve the exact function signatures inferred from Three's `Fn`.
|
|
1163
1178
|
*/
|
|
1164
|
-
type
|
|
1179
|
+
type CallableTSLNode = ((...params: never[]) => unknown) & {
|
|
1180
|
+
readonly shaderNode: unknown
|
|
1181
|
+
readonly id: number
|
|
1182
|
+
}
|
|
1165
1183
|
|
|
1166
|
-
/**
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
* @example
|
|
1172
|
-
* ```tsx
|
|
1173
|
-
* // Define a shader function
|
|
1174
|
-
* const blendColorFn = Fn(([color1, color2, factor]) => {
|
|
1175
|
-
* return mix(color1, color2, factor)
|
|
1176
|
-
* })
|
|
1177
|
-
*
|
|
1178
|
-
* // Type when retrieving from nodes store
|
|
1179
|
-
* const { blendColorFn } = nodes as { blendColorFn: ShaderCallable }
|
|
1180
|
-
*
|
|
1181
|
-
* // Or with specific return type
|
|
1182
|
-
* const { myFn } = nodes as { myFn: ShaderCallable<THREE.Node> }
|
|
1183
|
-
* ```
|
|
1184
|
-
*/
|
|
1185
|
-
type ShaderCallable<R extends Node = Node> = ((...params: unknown[]) => ShaderNodeObject<R>) & Node
|
|
1184
|
+
/** Legacy structural node accepted when at least one historical marker exists. */
|
|
1185
|
+
type LegacyTSLNodeLike = {
|
|
1186
|
+
label?: ((label: string) => unknown) | string
|
|
1187
|
+
setName?: (name: string) => unknown
|
|
1188
|
+
} & ({ uuid: string | undefined; nodeType?: string | null } | { uuid?: string; nodeType: string | null | undefined })
|
|
1186
1189
|
|
|
1187
|
-
/**
|
|
1188
|
-
|
|
1189
|
-
* This is the common return type for TSL operations (add, mul, sin, etc.)
|
|
1190
|
-
*
|
|
1191
|
-
* @example
|
|
1192
|
-
* ```tsx
|
|
1193
|
-
* const { wobble } = nodes as { wobble: ShaderNodeRef }
|
|
1194
|
-
* ```
|
|
1195
|
-
*/
|
|
1196
|
-
type ShaderNodeRef<T extends Node = Node> = ShaderNodeObject<T>
|
|
1190
|
+
/** Node type accepted by broad dynamic node-store readers. */
|
|
1191
|
+
type TSLNodeType = three_webgpu.Node | CallableTSLNode
|
|
1197
1192
|
|
|
1198
1193
|
/**
|
|
1199
|
-
*
|
|
1200
|
-
*
|
|
1201
|
-
*
|
|
1202
|
-
*
|
|
1203
|
-
* - Node: base Three.js node type
|
|
1204
|
-
* - ShaderCallable: function nodes created with Fn()
|
|
1205
|
-
* - ShaderNodeObject: wrapped nodes from TSL operations (sin, mul, mix, etc.)
|
|
1206
|
-
*
|
|
1207
|
-
* @example
|
|
1208
|
-
* ```tsx
|
|
1209
|
-
* // In useLocalNodes, nodes are typed as TSLNodeType
|
|
1210
|
-
* const { positionNode, blendColorFn } = useLocalNodes(({ nodes }) => ({
|
|
1211
|
-
* positionNode: nodes.myPosition, // Works - Node is in union
|
|
1212
|
-
* blendColorFn: nodes.myFn, // Works - ShaderCallable is in union
|
|
1213
|
-
* }))
|
|
1214
|
-
*
|
|
1215
|
-
* // Can narrow with type guard or assertion when needed
|
|
1216
|
-
* if (typeof blendColorFn === 'function') {
|
|
1217
|
-
* blendColorFn(someColor, 0.5)
|
|
1218
|
-
* }
|
|
1219
|
-
* ```
|
|
1194
|
+
* Derive Three's shader node type from an existing node or a supported raw input.
|
|
1195
|
+
* Existing InputNode generics take precedence over structural value normalization.
|
|
1196
|
+
* Both generics must be inferred because Three's UniformNode intersects an unknown-typed
|
|
1197
|
+
* InputNode base with its concrete InputNode specialization.
|
|
1220
1198
|
*/
|
|
1221
|
-
type
|
|
1199
|
+
type UniformNodeType<T> = T extends three_webgpu.UniformNode<infer TNodeType, infer _TValue>
|
|
1200
|
+
? TNodeType
|
|
1201
|
+
: T extends three_webgpu.InputNode<infer TNodeType, infer _TValue>
|
|
1202
|
+
? TNodeType
|
|
1203
|
+
: T extends number
|
|
1204
|
+
? 'float'
|
|
1205
|
+
: T extends boolean
|
|
1206
|
+
? 'bool'
|
|
1207
|
+
: T extends string | three_webgpu.Color | { r: number; g: number; b: number }
|
|
1208
|
+
? 'color'
|
|
1209
|
+
: T extends three_webgpu.Vector4 | { x: number; y: number; z: number; w: number }
|
|
1210
|
+
? 'vec4'
|
|
1211
|
+
: T extends three_webgpu.Vector3 | { x: number; y: number; z: number }
|
|
1212
|
+
? 'vec3'
|
|
1213
|
+
: T extends three_webgpu.Vector2 | { x: number; y: number }
|
|
1214
|
+
? 'vec2'
|
|
1215
|
+
: T extends three_webgpu.Matrix4
|
|
1216
|
+
? 'mat4'
|
|
1217
|
+
: T extends three_webgpu.Matrix3
|
|
1218
|
+
? 'mat3'
|
|
1219
|
+
: T extends three_webgpu.Matrix2
|
|
1220
|
+
? 'mat2'
|
|
1221
|
+
: unknown
|
|
1222
|
+
|
|
1223
|
+
/** Derive the normalized JavaScript value stored by a uniform node. */
|
|
1224
|
+
type UniformNodeValue<T> = T extends three_webgpu.UniformNode<infer _TNodeType, infer TValue>
|
|
1225
|
+
? TValue
|
|
1226
|
+
: T extends three_webgpu.InputNode<infer _TNodeType, infer TValue>
|
|
1227
|
+
? TValue
|
|
1228
|
+
: T extends string | { r: number; g: number; b: number }
|
|
1229
|
+
? three_webgpu.Color
|
|
1230
|
+
: T extends { x: number; y: number; z: number; w: number }
|
|
1231
|
+
? three_webgpu.Vector4
|
|
1232
|
+
: T extends { x: number; y: number; z: number }
|
|
1233
|
+
? three_webgpu.Vector3
|
|
1234
|
+
: T extends { x: number; y: number }
|
|
1235
|
+
? three_webgpu.Vector2
|
|
1236
|
+
: T extends number
|
|
1237
|
+
? number
|
|
1238
|
+
: T extends boolean
|
|
1239
|
+
? boolean
|
|
1240
|
+
: T
|
|
1241
|
+
|
|
1242
|
+
/** Three's exact UniformNode with shader and value generics derived from an input. */
|
|
1243
|
+
type UniformNodeFor<T> = three_webgpu.UniformNode<UniformNodeType<T>, UniformNodeValue<T>>
|
|
1244
|
+
|
|
1245
|
+
/** Preserve every input key while mapping values to exact Three uniform nodes. */
|
|
1246
|
+
type UniformNodesFor<T extends UniformInputRecord> = {
|
|
1247
|
+
[K in keyof T]: UniformNodeFor<T[K]>
|
|
1248
|
+
}
|
|
1249
|
+
|
|
1250
|
+
/** Backward-compatible single-parameter uniform alias. */
|
|
1251
|
+
type UniformNode<T = unknown> = UniformNodeFor<T>
|
|
1222
1252
|
|
|
1223
1253
|
/** Flat record of uniform nodes (no nested scopes) */
|
|
1224
1254
|
type UniformRecord<T extends UniformNode = UniformNode> = Record<string, T>
|
|
@@ -1243,7 +1273,7 @@ declare global {
|
|
|
1243
1273
|
* Acceptable input values for useUniforms - raw values that get converted to UniformNodes
|
|
1244
1274
|
* Supports:
|
|
1245
1275
|
* - Primitives: number, string (color), boolean
|
|
1246
|
-
* - Three.js types: Color, Vector2/3/4,
|
|
1276
|
+
* - Three.js types: Color, Vector2/3/4, Matrix2/3/4
|
|
1247
1277
|
* - Plain objects: { x, y, z, w } converted to vectors
|
|
1248
1278
|
* - TSL nodes: color(), vec3(), float() for type casting
|
|
1249
1279
|
* - UniformNode: existing uniforms (reused as-is)
|
|
@@ -1256,88 +1286,124 @@ declare global {
|
|
|
1256
1286
|
| three_webgpu.Vector2
|
|
1257
1287
|
| three_webgpu.Vector3
|
|
1258
1288
|
| three_webgpu.Vector4
|
|
1289
|
+
| three_webgpu.Matrix2
|
|
1259
1290
|
| three_webgpu.Matrix3
|
|
1260
1291
|
| three_webgpu.Matrix4
|
|
1261
|
-
|
|
|
1262
|
-
|
|
|
1263
|
-
| { x: number; y
|
|
1292
|
+
| { x: number; y: number }
|
|
1293
|
+
| { x: number; y: number; z: number }
|
|
1294
|
+
| { x: number; y: number; z: number; w: number }
|
|
1264
1295
|
| { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
|
|
1265
|
-
| Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1296
|
+
| three_webgpu.Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1266
1297
|
| UniformNode
|
|
1267
1298
|
|
|
1268
1299
|
/** Input record for useUniforms - accepts raw values or UniformNodes */
|
|
1269
1300
|
type UniformInputRecord = Record<string, UniformValue>
|
|
1270
1301
|
}
|
|
1271
1302
|
|
|
1272
|
-
|
|
1273
|
-
|
|
1274
|
-
declare module 'three/tsl' {
|
|
1303
|
+
declare global {
|
|
1275
1304
|
/**
|
|
1276
|
-
*
|
|
1277
|
-
*
|
|
1305
|
+
* three's own render pipeline type. Named here so the rest of R3F refers to three's shape
|
|
1306
|
+
* rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
|
|
1307
|
+
* is r185, so the new name is the only one.
|
|
1278
1308
|
*/
|
|
1279
|
-
|
|
1280
|
-
jsFunc: (inputs: ShaderNodeObject<Node>[]) => ShaderNodeObject<R>,
|
|
1281
|
-
): ShaderCallable<R>
|
|
1309
|
+
type ThreeRenderPipeline = three_webgpu.RenderPipeline
|
|
1282
1310
|
|
|
1283
1311
|
/**
|
|
1284
|
-
*
|
|
1285
|
-
*
|
|
1312
|
+
* The pass `useRenderPipeline` creates for you: three's own `PassNode`, as returned by
|
|
1313
|
+
* `pass(scene, camera)` from `three/tsl`. Referenced from three so members like
|
|
1314
|
+
* `getTextureNode`, `setMRT` and `dispose` track the installed version.
|
|
1286
1315
|
*/
|
|
1287
|
-
|
|
1288
|
-
jsFunc: (inputs: T) => ShaderNodeObject<R>,
|
|
1289
|
-
): ShaderCallable<R>
|
|
1316
|
+
type ScenePassNode = three_webgpu.PassNode
|
|
1290
1317
|
|
|
1291
1318
|
/**
|
|
1292
|
-
*
|
|
1293
|
-
*
|
|
1319
|
+
* Pass record - stores TSL pass nodes for render pipeline.
|
|
1320
|
+
*
|
|
1321
|
+
* `scenePass` is the only key the library owns. It is optional here because this is also the
|
|
1322
|
+
* shape of `state.passes`, which is `{}` before the pipeline exists and again after `reset()`
|
|
1323
|
+
* or `clearPasses()`. Inside the callbacks it is always present; see
|
|
1324
|
+
* {@link RenderPipelineCallbackState}.
|
|
1325
|
+
*
|
|
1326
|
+
* Every other key is user-registered, via a callback's return value. Those are TSL nodes of
|
|
1327
|
+
* any kind, not only passes: texture reads of an MRT attachment, effect nodes, extra
|
|
1328
|
+
* `pass()` instances. `Node` is the common base, so that is the bound. Narrow at the call
|
|
1329
|
+
* site when you need a member, e.g. `passes.velocity as TextureNode`.
|
|
1330
|
+
*
|
|
1331
|
+
* The index signature admits `undefined` because a key may simply not be registered, and
|
|
1332
|
+
* because the optional `scenePass` must be assignable to it: under `skipLibCheck: false` an
|
|
1333
|
+
* optional property whose type excludes `undefined` from the index signature is an error
|
|
1334
|
+
* (TS2411) for every consumer compiling these declarations.
|
|
1294
1335
|
*/
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
1336
|
+
interface PassRecord {
|
|
1337
|
+
scenePass?: ScenePassNode
|
|
1338
|
+
[key: string]: three_webgpu.Node | undefined
|
|
1339
|
+
}
|
|
1299
1340
|
|
|
1300
1341
|
/**
|
|
1301
|
-
*
|
|
1342
|
+
* State passed to pipeline callbacks after the active pipeline has been created.
|
|
1343
|
+
*
|
|
1344
|
+
* `passes.scenePass` is required here: the hook installs the default scene pass before either
|
|
1345
|
+
* callback runs, so callbacks can use it without a guard or a cast.
|
|
1346
|
+
*
|
|
1347
|
+
* `renderer` is narrowed to `WebGPURenderer` and `isLegacy` to `false`: the hook throws under
|
|
1348
|
+
* the legacy renderer before either callback can run, so a callback never sees WebGL.
|
|
1302
1349
|
*/
|
|
1303
|
-
|
|
1304
|
-
|
|
1305
|
-
|
|
1306
|
-
|
|
1307
|
-
|
|
1350
|
+
type RenderPipelineCallbackState = RootState & {
|
|
1351
|
+
renderPipeline: ThreeRenderPipeline
|
|
1352
|
+
passes: PassRecord & { scenePass: ScenePassNode }
|
|
1353
|
+
renderer: three_webgpu.WebGPURenderer
|
|
1354
|
+
isLegacy: false
|
|
1355
|
+
}
|
|
1308
1356
|
|
|
1309
|
-
declare global {
|
|
1310
1357
|
/**
|
|
1311
|
-
*
|
|
1312
|
-
*
|
|
1313
|
-
* is
|
|
1358
|
+
* What a callback may return to register entries into `state.passes`.
|
|
1359
|
+
*
|
|
1360
|
+
* `scenePass` is reserved. The hook owns that entry and its lifecycle: it caches the pass it
|
|
1361
|
+
* created, and `rebuild()` / `reset()` dispose that cached pass. A callback overwriting the
|
|
1362
|
+
* store entry would leave the store pointing at a node the hook never disposes, and the hook
|
|
1363
|
+
* disposing a pass nothing references. So returning it is a type error.
|
|
1314
1364
|
*/
|
|
1315
|
-
type
|
|
1316
|
-
|
|
1317
|
-
/** Pass record - stores TSL pass nodes for render pipeline */
|
|
1318
|
-
type PassRecord = Record<string, any>
|
|
1365
|
+
type RegisteredPasses = Record<string, three_webgpu.Node> & { scenePass?: never }
|
|
1319
1366
|
|
|
1320
1367
|
/** Setup callback - runs first to configure MRT, create additional passes */
|
|
1321
|
-
type RenderPipelineSetupCallback = (state:
|
|
1368
|
+
type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1322
1369
|
|
|
1323
1370
|
/** Main callback - runs second to configure outputNode, create effect passes */
|
|
1324
|
-
type RenderPipelineMainCallback = (state:
|
|
1371
|
+
type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1325
1372
|
|
|
1326
|
-
/**
|
|
1327
|
-
interface
|
|
1373
|
+
/** The imperative half of useRenderPipeline's return value, present in every state */
|
|
1374
|
+
interface UseRenderPipelineActions {
|
|
1328
1375
|
/** Current passes from state */
|
|
1329
1376
|
passes: PassRecord
|
|
1330
|
-
/** RenderPipeline instance (null if not initialized) */
|
|
1331
|
-
renderPipeline: ThreeRenderPipeline | null
|
|
1332
1377
|
/** Clear all passes from state */
|
|
1333
1378
|
clearPasses: () => void
|
|
1334
1379
|
/** Reset RenderPipeline entirely (clears PP + passes) */
|
|
1335
1380
|
reset: () => void
|
|
1336
1381
|
/** Re-run setup/main callbacks with current closure values */
|
|
1337
1382
|
rebuild: () => void
|
|
1338
|
-
/** True when RenderPipeline is configured and ready */
|
|
1339
|
-
isReady: boolean
|
|
1340
1383
|
}
|
|
1384
|
+
|
|
1385
|
+
/**
|
|
1386
|
+
* Return type for useRenderPipeline hook, discriminated on `isReady`.
|
|
1387
|
+
*
|
|
1388
|
+
* `if (isReady)` narrows `renderPipeline` to non-null, which is what the docs already tell
|
|
1389
|
+
* callers to check. `passes.scenePass` deliberately stays optional in the ready branch:
|
|
1390
|
+
* `clearPasses()` empties the record while leaving the pipeline in place.
|
|
1391
|
+
*/
|
|
1392
|
+
type UseRenderPipelineReturn = UseRenderPipelineActions &
|
|
1393
|
+
(
|
|
1394
|
+
| {
|
|
1395
|
+
/** True when RenderPipeline is configured and ready */
|
|
1396
|
+
isReady: true
|
|
1397
|
+
/** RenderPipeline instance */
|
|
1398
|
+
renderPipeline: ThreeRenderPipeline
|
|
1399
|
+
}
|
|
1400
|
+
| {
|
|
1401
|
+
/** False until the pipeline has been created */
|
|
1402
|
+
isReady: false
|
|
1403
|
+
/** Not initialized yet, or torn down by reset() */
|
|
1404
|
+
renderPipeline: null
|
|
1405
|
+
}
|
|
1406
|
+
)
|
|
1341
1407
|
}
|
|
1342
1408
|
|
|
1343
1409
|
type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
|
|
@@ -1416,10 +1482,11 @@ type TSLNodeInput = { nodeType?: string | null; uuid?: string } | null
|
|
|
1416
1482
|
|
|
1417
1483
|
/**
|
|
1418
1484
|
* For node material properties (colorNode, positionNode, etc.), accept broader types
|
|
1419
|
-
* since @types/three has broken inheritance for TSL node subclasses.
|
|
1485
|
+
* since @types/three has broken inheritance for TSL node subclasses. NodeClass requires
|
|
1486
|
+
* `nodeType`, so this structural key test remains neutral to the selected Three entry.
|
|
1420
1487
|
*/
|
|
1421
1488
|
type NodeProps<P> = {
|
|
1422
|
-
[K in keyof P as P[K] extends
|
|
1489
|
+
[K in keyof P as NonNullable<P[K]> extends { nodeType: string | null } ? K : never]?: TSLNodeInput
|
|
1423
1490
|
}
|
|
1424
1491
|
|
|
1425
1492
|
interface ReactProps<P> {
|
|
@@ -1440,11 +1507,30 @@ type ThreeToJSXElements<T extends Record<string, any>> = {
|
|
|
1440
1507
|
[K in keyof T & string as Uncapitalize<K>]: T[K] extends ConstructorRepresentation ? ThreeElement<T[K]> : never
|
|
1441
1508
|
}
|
|
1442
1509
|
|
|
1510
|
+
/** Method names of Object3D, excluded from the `primitive` element's typed props. */
|
|
1511
|
+
type Object3DMethod = NonNullable<
|
|
1512
|
+
{
|
|
1513
|
+
[K in keyof Object3D]-?: Object3D[K] extends (...args: any[]) => any ? K : never
|
|
1514
|
+
}[keyof Object3D]
|
|
1515
|
+
>
|
|
1516
|
+
|
|
1443
1517
|
type ThreeExports = typeof import('three/webgpu')
|
|
1444
1518
|
type ThreeElementsImpl = ThreeToJSXElements<ThreeExports>
|
|
1445
1519
|
|
|
1446
1520
|
interface ThreeElements extends Omit<ThreeElementsImpl, 'audio' | 'source' | 'line' | 'path'> {
|
|
1447
|
-
|
|
1521
|
+
/**
|
|
1522
|
+
* `primitive` wraps a pre-existing object, so its props cannot be derived from one class.
|
|
1523
|
+
* Events are typed from `EventHandlers` (`onClick={(e) => ...}` infers `e`), the ref is
|
|
1524
|
+
* untyped, and any other prop is accepted and applied to the object by name. Object3D's own
|
|
1525
|
+
* methods are left out of the typed surface: they return `this`, so a subclass element's
|
|
1526
|
+
* props (`ThreeElements['group']`) could not be spread onto a primitive otherwise.
|
|
1527
|
+
*/
|
|
1528
|
+
primitive: Omit<ThreeElement<typeof Object3D>, 'args' | 'object' | 'ref' | 'onUpdate' | Object3DMethod> & {
|
|
1529
|
+
object: object
|
|
1530
|
+
ref?: React.Ref<any>
|
|
1531
|
+
onUpdate?: (self: any) => void
|
|
1532
|
+
[prop: string]: unknown
|
|
1533
|
+
}
|
|
1448
1534
|
// Conflicts with DOM types can be accessed through a three* prefix
|
|
1449
1535
|
threeAudio: ThreeElementsImpl['audio']
|
|
1450
1536
|
threeSource: ThreeElementsImpl['source']
|
|
@@ -1485,6 +1571,7 @@ type three_d_Matrix3 = Matrix3;
|
|
|
1485
1571
|
type three_d_Matrix4 = Matrix4;
|
|
1486
1572
|
type three_d_MutableOrReadonlyParameters<T extends (...args: any) => any> = MutableOrReadonlyParameters<T>;
|
|
1487
1573
|
type three_d_NodeProps<P> = NodeProps<P>;
|
|
1574
|
+
type three_d_Object3DMethod = Object3DMethod;
|
|
1488
1575
|
type three_d_Quaternion = Quaternion;
|
|
1489
1576
|
type three_d_RaycastableRepresentation = RaycastableRepresentation;
|
|
1490
1577
|
type three_d_ReactProps<P> = ReactProps<P>;
|
|
@@ -1499,7 +1586,7 @@ type three_d_Vector3 = Vector3;
|
|
|
1499
1586
|
type three_d_Vector4 = Vector4;
|
|
1500
1587
|
type three_d_VectorRepresentation = VectorRepresentation;
|
|
1501
1588
|
declare namespace three_d {
|
|
1502
|
-
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 };
|
|
1589
|
+
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 };
|
|
1503
1590
|
}
|
|
1504
1591
|
|
|
1505
1592
|
/**
|
|
@@ -1848,7 +1935,7 @@ declare function createEvents(store: RootStore): {
|
|
|
1848
1935
|
processDeferredPointer: (event: DomEvent, pointerId: number) => void;
|
|
1849
1936
|
};
|
|
1850
1937
|
/** Default R3F event manager for web */
|
|
1851
|
-
declare function createPointerEvents(store: RootStore): EventManager<
|
|
1938
|
+
declare function createPointerEvents(store: RootStore): EventManager<Element>;
|
|
1852
1939
|
|
|
1853
1940
|
/**
|
|
1854
1941
|
* Gets or creates a memoized loader instance from a loader constructor or returns the loader if it's already an instance.
|
|
@@ -1868,50 +1955,6 @@ declare namespace useLoader {
|
|
|
1868
1955
|
var loader: typeof getLoader;
|
|
1869
1956
|
}
|
|
1870
1957
|
|
|
1871
|
-
/**
|
|
1872
|
-
* Frame hook with phase-based ordering, priority, and FPS throttling.
|
|
1873
|
-
*
|
|
1874
|
-
* Always delivers full RootState — works both inside and outside Canvas context:
|
|
1875
|
-
* - Inside Canvas: Full RootState (renderer, scene, camera, etc.)
|
|
1876
|
-
* - Outside Canvas: The job registers immediately but the callback is held until a
|
|
1877
|
-
* Canvas adopts it, then runs with full RootState. For hostless / standalone
|
|
1878
|
-
* frame loops with no Canvas, use `@pmndrs/scheduler` directly.
|
|
1879
|
-
*
|
|
1880
|
-
* Returns a controls object for manual stepping, pausing, and resuming.
|
|
1881
|
-
*
|
|
1882
|
-
* @param callback - Function called each frame with (state, delta). Optional if you only need scheduler access.
|
|
1883
|
-
* @param priorityOrOptions - Either a priority number (backwards compat) or options object
|
|
1884
|
-
* @returns Controls object with step(), stepAll(), pause(), resume(), isPaused, id, scheduler
|
|
1885
|
-
*
|
|
1886
|
-
* @example
|
|
1887
|
-
* // Simple priority (backwards compat)
|
|
1888
|
-
* useFrame((state, delta) => { ... }, 5)
|
|
1889
|
-
*
|
|
1890
|
-
* @example
|
|
1891
|
-
* // With phase-based ordering
|
|
1892
|
-
* useFrame((state, delta) => { ... }, { phase: 'physics' })
|
|
1893
|
-
*
|
|
1894
|
-
* @example
|
|
1895
|
-
* // Outside Canvas - callback waits for a Canvas, then always has full state
|
|
1896
|
-
* function UI() {
|
|
1897
|
-
* useFrame((state, delta) => { syncUI(state.camera) });
|
|
1898
|
-
* return <button>...</button>;
|
|
1899
|
-
* }
|
|
1900
|
-
*
|
|
1901
|
-
* @example
|
|
1902
|
-
* // Hostless / standalone loop (no Canvas) - use @pmndrs/scheduler directly
|
|
1903
|
-
* import { getScheduler } from '@pmndrs/scheduler'
|
|
1904
|
-
* getScheduler().register((state, delta) => { updateGame(delta) })
|
|
1905
|
-
*
|
|
1906
|
-
* @example
|
|
1907
|
-
* // Scheduler-only access (no callback)
|
|
1908
|
-
* const { scheduler } = useFrame()
|
|
1909
|
-
* scheduler.pauseJob('some-job-id')
|
|
1910
|
-
*
|
|
1911
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useframe
|
|
1912
|
-
*/
|
|
1913
|
-
declare function useFrame(callback?: FrameNextCallback, priorityOrOptions?: number | UseFrameNextOptions): FrameNextControls;
|
|
1914
|
-
|
|
1915
1958
|
declare const IsObject: (url: unknown) => url is Record<string, string>;
|
|
1916
1959
|
type TextureArray<T> = T extends string[] ? Texture$1[] : never;
|
|
1917
1960
|
type TextureRecord<T> = T extends Record<string, string> ? {
|
|
@@ -2097,11 +2140,6 @@ declare function useRenderTarget(width: number, height: number, options?: Render
|
|
|
2097
2140
|
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
|
|
2098
2141
|
*/
|
|
2099
2142
|
declare function useStore(): RootStore;
|
|
2100
|
-
/**
|
|
2101
|
-
* Accesses R3F's internal state, containing renderer, canvas, scene, etc.
|
|
2102
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usethree
|
|
2103
|
-
*/
|
|
2104
|
-
declare function useThree<T = RootState>(selector?: (state: RootState) => T, equalityFn?: <T>(state: T, newState: T) => boolean): T;
|
|
2105
2143
|
/**
|
|
2106
2144
|
* Exposes an object's {@link Instance}.
|
|
2107
2145
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#useInstanceHandle
|
|
@@ -2177,7 +2215,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
|
|
|
2177
2215
|
* Invalidates the view, requesting a frame to be rendered.
|
|
2178
2216
|
* In demand mode, this triggers the scheduler to run frames.
|
|
2179
2217
|
*
|
|
2180
|
-
*
|
|
2218
|
+
* With a state argument, only that root's jobs run on the requested frames; other
|
|
2219
|
+
* roots on 'demand' stay idle. Without one, every registered root is invalidated.
|
|
2220
|
+
*
|
|
2221
|
+
* @param state - Optional root state; targets the invalidation at that root
|
|
2181
2222
|
* @param frames - Number of frames to request (default: 1)
|
|
2182
2223
|
* @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
|
|
2183
2224
|
*
|
|
@@ -2188,14 +2229,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
|
|
|
2188
2229
|
* Advances the frameloop and runs render effects.
|
|
2189
2230
|
* Useful for when manually rendering via `frameloop="never"`.
|
|
2190
2231
|
*
|
|
2232
|
+
* With a state argument, only that root is stepped. Without one, every
|
|
2233
|
+
* registered root is stepped for backwards compatibility.
|
|
2234
|
+
*
|
|
2191
2235
|
* @param timestamp - The timestamp to use for this frame
|
|
2192
2236
|
* @param runGlobalEffects - Ignored (kept for backwards compat, global effects always run)
|
|
2193
|
-
* @param state -
|
|
2194
|
-
* @param frame - Ignored (kept for backwards compat)
|
|
2237
|
+
* @param state - Optional root state; targets the manual step at that root
|
|
2195
2238
|
*
|
|
2196
2239
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
|
|
2197
2240
|
*/
|
|
2198
|
-
declare function advance(timestamp: number): void;
|
|
2241
|
+
declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
|
|
2199
2242
|
|
|
2200
2243
|
/* eslint-disable @definitelytyped/no-unnecessary-generics */
|
|
2201
2244
|
declare function ReactReconciler<
|
|
@@ -3240,6 +3283,7 @@ declare namespace ReactReconciler {
|
|
|
3240
3283
|
|
|
3241
3284
|
declare function extend<T extends ConstructorRepresentation>(objects: T): React$1.ExoticComponent<ThreeElement<T>>;
|
|
3242
3285
|
declare function extend<T extends Catalogue>(objects: T): void;
|
|
3286
|
+
declare function extend(objects: Record<string, unknown>): void;
|
|
3243
3287
|
declare const reconciler: ReactReconciler.Reconciler<RootStore, Instance<any>, void, Instance<any>, never, any>;
|
|
3244
3288
|
|
|
3245
3289
|
declare const isRenderer: (def: any) => boolean;
|
|
@@ -3683,29 +3727,44 @@ declare const hasConstructor: (object: unknown) => object is {
|
|
|
3683
3727
|
* Used to identify values that should be resolved from refs after mount.
|
|
3684
3728
|
*/
|
|
3685
3729
|
declare const FROM_REF: unique symbol;
|
|
3730
|
+
/** The marker `fromRef()` returns; resolved by the reconciler in `commitMount`. */
|
|
3731
|
+
interface FromRefMarker<T = unknown, R = T> {
|
|
3732
|
+
[FROM_REF]: React$1.RefObject<T | null>;
|
|
3733
|
+
/** Optional transform applied to the resolved ref before assignment. */
|
|
3734
|
+
transform?: (value: T) => R;
|
|
3735
|
+
}
|
|
3686
3736
|
/**
|
|
3687
3737
|
* Defers prop application until the referenced object is available.
|
|
3688
3738
|
* Useful for props like `target` that need sibling refs to be populated.
|
|
3689
3739
|
*
|
|
3740
|
+
* Only top-level props on a three element are resolved: a marker nested inside another value
|
|
3741
|
+
* (an array, an options object) is never seen. When the prop needs the sibling *wrapped* rather
|
|
3742
|
+
* than assigned as-is, pass a `transform`; it runs once the ref is populated and its result is
|
|
3743
|
+
* what gets assigned.
|
|
3744
|
+
*
|
|
3690
3745
|
* @param ref - React ref object to resolve at mount time
|
|
3691
|
-
* @
|
|
3746
|
+
* @param transform - Optional mapping from the resolved object to the value the prop expects
|
|
3747
|
+
* @returns A marker value that the reconciler resolves after mount
|
|
3692
3748
|
*
|
|
3693
3749
|
* @example
|
|
3694
3750
|
* const targetRef = useRef<THREE.Object3D>(null)
|
|
3695
3751
|
*
|
|
3696
3752
|
* <group ref={targetRef} position={[-3, -2, -15]} />
|
|
3697
3753
|
* <spotLight target={fromRef(targetRef)} intensity={100} />
|
|
3754
|
+
*
|
|
3755
|
+
* @example
|
|
3756
|
+
* // Wrap the sibling: a node material's lightsNode needs a LightsNode, not the light itself
|
|
3757
|
+
* <meshPhongNodeMaterial lightsNode={fromRef(lightRef, (light) => lights([light]))} />
|
|
3698
3758
|
*/
|
|
3699
3759
|
declare function fromRef<T>(ref: React$1.RefObject<T | null>): T;
|
|
3760
|
+
declare function fromRef<T, R>(ref: React$1.RefObject<T | null>, transform: (value: T) => R): R;
|
|
3700
3761
|
/**
|
|
3701
3762
|
* Type guard to check if a value is a fromRef marker.
|
|
3702
3763
|
*
|
|
3703
3764
|
* @param value - Value to check
|
|
3704
3765
|
* @returns True if value is a fromRef marker
|
|
3705
3766
|
*/
|
|
3706
|
-
declare function isFromRef(value: unknown): value is
|
|
3707
|
-
[FROM_REF]: React$1.RefObject<any>;
|
|
3708
|
-
};
|
|
3767
|
+
declare function isFromRef(value: unknown): value is FromRefMarker<any, unknown>;
|
|
3709
3768
|
|
|
3710
3769
|
/**
|
|
3711
3770
|
* Symbol marker for mount-only method calls.
|
|
@@ -3732,7 +3791,15 @@ declare const ONCE: unique symbol;
|
|
|
3732
3791
|
* // No arguments
|
|
3733
3792
|
* <geometry center={once()} />
|
|
3734
3793
|
*/
|
|
3735
|
-
declare function once<
|
|
3794
|
+
declare function once<A extends unknown[]>(...args: A): OnceValue<A>;
|
|
3795
|
+
/**
|
|
3796
|
+
* What `once(...args)` is typed as, so the marker is assignable to the prop it targets:
|
|
3797
|
+
* the single argument itself (`rotateX={once(angle)}`), the argument tuple for multi-argument
|
|
3798
|
+
* methods (`translate={once(x, y, z)}`), or `true` for a bare call (`center={once()}`).
|
|
3799
|
+
*
|
|
3800
|
+
* The runtime value is always the marker object; only the declared type follows the prop.
|
|
3801
|
+
*/
|
|
3802
|
+
type OnceValue<A extends unknown[]> = A extends [] ? true : A extends [infer Single] ? Single : A;
|
|
3736
3803
|
/**
|
|
3737
3804
|
* Type guard to check if a value is a once marker.
|
|
3738
3805
|
*
|
|
@@ -3743,11 +3810,8 @@ declare function isOnce(value: unknown): value is {
|
|
|
3743
3810
|
[ONCE]: any[] | true;
|
|
3744
3811
|
};
|
|
3745
3812
|
|
|
3746
|
-
/**
|
|
3747
|
-
|
|
3748
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/canvas
|
|
3749
|
-
*/
|
|
3750
|
-
declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
|
|
3813
|
+
/** Distinguishes a resource leaf from a nested resource scope. */
|
|
3814
|
+
type ResourceLeafGuard<T> = (value: unknown) => value is T;
|
|
3751
3815
|
|
|
3752
3816
|
/**
|
|
3753
3817
|
* ScopedStore - Type-safe wrapper for nested stores (uniforms, nodes)
|
|
@@ -3769,33 +3833,30 @@ declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
|
|
|
3769
3833
|
* ```
|
|
3770
3834
|
*/
|
|
3771
3835
|
|
|
3772
|
-
/** Keys reserved for methods (excluded from index signature) */
|
|
3773
|
-
type MethodKeys = 'scope' | 'has' | 'keys';
|
|
3774
3836
|
/**
|
|
3775
3837
|
* Type-safe wrapper interface for accessing nested store data.
|
|
3776
3838
|
* Property access returns `T` (assumes leaf node).
|
|
3777
3839
|
* Use `.scope(key)` for nested object access.
|
|
3778
3840
|
*
|
|
3779
|
-
* Uses mapped type with key filtering to exclude method names from index signature,
|
|
3780
|
-
* allowing methods to have their correct return types.
|
|
3781
3841
|
*/
|
|
3782
|
-
type
|
|
3783
|
-
/** Direct property access returns the leaf type T (method keys excluded) */
|
|
3784
|
-
readonly [K in string as K extends MethodKeys ? never : K]: T;
|
|
3785
|
-
} & {
|
|
3842
|
+
type ScopedStoreMethods<TLeaf> = {
|
|
3786
3843
|
/** Access a nested scope by key. Returns empty wrapper if scope doesn't exist. */
|
|
3787
|
-
scope(key: string): ScopedStoreType<
|
|
3844
|
+
scope<TScope extends Record<string, TLeaf> = Record<string, TLeaf>>(key: string): ScopedStoreType<TLeaf, TScope>;
|
|
3788
3845
|
/** Check if a key exists in the store */
|
|
3789
3846
|
has(key: string): boolean;
|
|
3790
3847
|
/** Get all keys in the store */
|
|
3791
3848
|
keys(): string[];
|
|
3792
3849
|
};
|
|
3850
|
+
type ScopedStoreType<TLeaf, TEntries extends Record<string, TLeaf> = Record<string, TLeaf>> = Readonly<TEntries> & ScopedStoreMethods<TLeaf>;
|
|
3851
|
+
interface ScopedStoreData<TLeaf> {
|
|
3852
|
+
[key: string]: TLeaf | ScopedStoreData<TLeaf>;
|
|
3853
|
+
}
|
|
3793
3854
|
/**
|
|
3794
3855
|
* Create a type-safe ScopedStore wrapper around store data.
|
|
3795
3856
|
* @param data - The raw store data (uniforms or nodes from RootState)
|
|
3796
3857
|
* @returns A ScopedStoreType wrapper with type-safe access
|
|
3797
3858
|
*/
|
|
3798
|
-
declare function createScopedStore<
|
|
3859
|
+
declare function createScopedStore<TLeaf>(data: ScopedStoreData<TLeaf>, isLeaf: ResourceLeafGuard<TLeaf>): ScopedStoreType<TLeaf>;
|
|
3799
3860
|
/**
|
|
3800
3861
|
* State type passed to creator functions with ScopedStore wrappers.
|
|
3801
3862
|
* Provides type-safe access to uniforms, nodes, buffers, and gpuStorage without manual casting.
|
|
@@ -3803,8 +3864,8 @@ declare function createScopedStore<T>(data: Record<string, any>): ScopedStoreTyp
|
|
|
3803
3864
|
type CreatorState = Omit<RootState, 'uniforms' | 'nodes' | 'buffers' | 'gpuStorage'> & {
|
|
3804
3865
|
/** Type-safe uniform access - property access returns UniformNode */
|
|
3805
3866
|
uniforms: ScopedStoreType<UniformNode>;
|
|
3806
|
-
/** Type-safe node access
|
|
3807
|
-
nodes: ScopedStoreType<
|
|
3867
|
+
/** Type-safe node access for real, callable, and legacy structural nodes */
|
|
3868
|
+
nodes: ScopedStoreType<NodeLike>;
|
|
3808
3869
|
/** Type-safe buffer access - property access returns BufferLike (TypedArrays, BufferAttributes, TSL nodes) */
|
|
3809
3870
|
buffers: ScopedStoreType<BufferLike>;
|
|
3810
3871
|
/** Type-safe GPU storage access - property access returns StorageLike (StorageTexture, TSL nodes) */
|
|
@@ -3820,17 +3881,18 @@ type ClearUniformsFn = (scope?: string) => void;
|
|
|
3820
3881
|
/** Function signature for rebuildUniforms util */
|
|
3821
3882
|
type RebuildUniformsFn = (scope?: string) => void;
|
|
3822
3883
|
/** Return type with utils included */
|
|
3823
|
-
type UniformsWithUtils<T extends UniformRecord = UniformRecord> = T & {
|
|
3884
|
+
type UniformsWithUtils<T extends UniformRecord | UniformStore = UniformRecord> = T & {
|
|
3824
3885
|
removeUniforms: RemoveUniformsFn;
|
|
3825
3886
|
clearUniforms: ClearUniformsFn;
|
|
3826
3887
|
rebuildUniforms: RebuildUniformsFn;
|
|
3827
3888
|
};
|
|
3828
|
-
declare function useUniforms(): UniformsWithUtils<
|
|
3889
|
+
declare function useUniforms<T extends UniformInputRecord>(creator: UniformCreator<T>): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3890
|
+
declare function useUniforms<T extends UniformInputRecord>(creator: UniformCreator<T>, scope: string): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3891
|
+
declare function useUniforms<T extends UniformInputRecord>(uniforms: T): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3892
|
+
declare function useUniforms<T extends UniformInputRecord>(uniforms: T, scope: string): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3893
|
+
declare function useUniforms(): UniformsWithUtils<UniformStore>;
|
|
3829
3894
|
declare function useUniforms(scope: string): UniformsWithUtils;
|
|
3830
|
-
declare function useUniforms<T extends UniformInputRecord>(
|
|
3831
|
-
declare function useUniforms<T extends UniformInputRecord>(creator: UniformCreator<T>, scope: string): UniformsWithUtils<UniformRecord<UniformNode>>;
|
|
3832
|
-
declare function useUniforms<T extends UniformInputRecord>(uniforms: T): UniformsWithUtils<UniformRecord<UniformNode>>;
|
|
3833
|
-
declare function useUniforms<T extends UniformInputRecord>(uniforms: T, scope: string): UniformsWithUtils<UniformRecord<UniformNode>>;
|
|
3895
|
+
declare function useUniforms<T extends UniformInputRecord>(scope?: string): UniformsWithUtils<UniformNodesFor<T>>;
|
|
3834
3896
|
/**
|
|
3835
3897
|
* Global rebuildUniforms function for HMR integration.
|
|
3836
3898
|
* Invalidates cached uniforms and increments _hmrVersion to trigger re-creation.
|
|
@@ -3861,47 +3923,28 @@ declare function clearRootUniforms(set: ReturnType<typeof useStore>['setState'])
|
|
|
3861
3923
|
|
|
3862
3924
|
/**
|
|
3863
3925
|
* Supported uniform value types:
|
|
3864
|
-
* - Raw values: number, boolean, Vector2, Vector3, Vector4, Color, Matrix3, Matrix4
|
|
3926
|
+
* - Raw values: number, boolean, Vector2, Vector3, Vector4, Color, Matrix2, Matrix3, Matrix4
|
|
3865
3927
|
* - String colors: '#ff0000', 'red', 'rgb(255,0,0)' (auto-converted to Color)
|
|
3866
3928
|
* - TSL nodes: color(), vec3(), float(), etc. (for type casting)
|
|
3867
3929
|
* - UniformNode: existing uniforms (reused as-is)
|
|
3868
3930
|
*/
|
|
3869
|
-
type UniformValue = number | boolean | string | Vector2$1 | Vector3$1 | Vector4$1 | Color$2 | Matrix3$1 | Matrix4$1 | Node | UniformNode;
|
|
3870
|
-
|
|
3871
|
-
|
|
3872
|
-
* - 0 → number
|
|
3873
|
-
* - true → boolean
|
|
3874
|
-
* - '#ff0000' → Color (string colors are converted to Color objects)
|
|
3875
|
-
* - Node → Node (TSL nodes passed through for uniform type casting)
|
|
3876
|
-
*/
|
|
3877
|
-
type Widen<T> = T extends number ? number : T extends boolean ? boolean : T extends string ? Color$2 : T;
|
|
3878
|
-
declare function useUniform<T extends UniformValue>(name: string): UniformNode<T>;
|
|
3879
|
-
declare function useUniform<T extends UniformValue>(name: string, value: T): UniformNode<Widen<T>>;
|
|
3931
|
+
type UniformValue = number | boolean | string | Vector2$1 | Vector3$1 | Vector4$1 | Color$2 | Matrix2 | Matrix3$1 | Matrix4$1 | Node | UniformNode;
|
|
3932
|
+
declare function useUniform<T extends UniformValue = UniformValue>(name: string): UniformNodeFor<T>;
|
|
3933
|
+
declare function useUniform<T extends UniformValue>(name: string, value: T): UniformNodeFor<T>;
|
|
3880
3934
|
|
|
3881
3935
|
/**
|
|
3882
|
-
*
|
|
3883
|
-
*
|
|
3884
|
-
*
|
|
3885
|
-
*
|
|
3936
|
+
* Every node representation a creator may return. The definition lives with the store types as
|
|
3937
|
+
* `NodeLike`, so the shape creators return and the shape `state.nodes` holds are one type by
|
|
3938
|
+
* construction: three's real `Node`, the callable proxy `Fn()` returns, or the legacy structural
|
|
3939
|
+
* `{ uuid, nodeType }` shape.
|
|
3886
3940
|
*/
|
|
3887
|
-
|
|
3888
|
-
|
|
3889
|
-
|
|
3890
|
-
/** label method for chaining - sets the node's label and returns self */
|
|
3891
|
-
label?: ((label: string) => TSLNodeLike) | string;
|
|
3892
|
-
setName?: (name: string) => this;
|
|
3893
|
-
}
|
|
3894
|
-
/** TSL node type - alias for compatibility */
|
|
3941
|
+
type TSLNodeLike = NodeLike;
|
|
3942
|
+
|
|
3943
|
+
/** Backward-compatible alias covering every accepted node representation. */
|
|
3895
3944
|
type TSLNode = TSLNodeLike;
|
|
3896
|
-
/**
|
|
3897
|
-
* A record of TSL nodes - allows mixed node types (OperatorNode, ConstNode, etc.)
|
|
3898
|
-
* Uses TSLNodeLike for broader compatibility with Three.js's TSL type definitions.
|
|
3899
|
-
*/
|
|
3900
|
-
type NodeRecord<T extends TSLNodeLike = TSLNodeLike> = Record<string, T>;
|
|
3901
3945
|
/**
|
|
3902
3946
|
* Creator function that returns a record of nodes.
|
|
3903
|
-
*
|
|
3904
|
-
* (e.g., { n: OperatorNode; color: ConstNode<Color> }) to pass type checking.
|
|
3947
|
+
* Exact creator return inference is preserved within the compatible node constraint.
|
|
3905
3948
|
*/
|
|
3906
3949
|
type NodeCreator<T extends Record<string, TSLNodeLike>> = (state: CreatorState) => T;
|
|
3907
3950
|
/** Function signature for removeNodes util */
|
|
@@ -3911,15 +3954,17 @@ type ClearNodesFn = (scope?: string) => void;
|
|
|
3911
3954
|
/** Function signature for rebuildNodes util */
|
|
3912
3955
|
type RebuildNodesFn = (scope?: string) => void;
|
|
3913
3956
|
/** Return type with utils included */
|
|
3914
|
-
type NodesWithUtils<T extends Record<string,
|
|
3957
|
+
type NodesWithUtils<T extends Record<string, unknown> = NodeRecord> = T & {
|
|
3915
3958
|
removeNodes: RemoveNodesFn;
|
|
3916
3959
|
clearNodes: ClearNodesFn;
|
|
3917
3960
|
rebuildNodes: RebuildNodesFn;
|
|
3918
3961
|
};
|
|
3919
|
-
declare function useNodes(): NodesWithUtils<
|
|
3920
|
-
declare function useNodes(scope: string): NodesWithUtils<
|
|
3921
|
-
declare function useNodes<T extends
|
|
3922
|
-
declare function useNodes<T extends
|
|
3962
|
+
declare function useNodes(): NodesWithUtils<NodeStore>;
|
|
3963
|
+
declare function useNodes(scope: string): NodesWithUtils<NodeRecord>;
|
|
3964
|
+
declare function useNodes<T extends NodeRecord>(scope?: string): NodesWithUtils<T>;
|
|
3965
|
+
declare function useNodes<T extends NodeRecord>(creator: NodeCreator<T>): NodesWithUtils<T>;
|
|
3966
|
+
declare function useNodes<T extends NodeRecord>(creator: NodeCreator<T>, scope: string): NodesWithUtils<T>;
|
|
3967
|
+
declare function useNodes(creatorOrScope?: NodeCreator<NodeRecord> | string, scope?: string): NodesWithUtils<Record<string, unknown>>;
|
|
3923
3968
|
/**
|
|
3924
3969
|
* Global rebuildNodes function for HMR integration.
|
|
3925
3970
|
* Invalidates cached nodes and increments _hmrVersion to trigger re-creation.
|
|
@@ -3978,6 +4023,10 @@ type LocalNodeCreator<T extends Record<string, unknown>> = (state: CreatorState)
|
|
|
3978
4023
|
*/
|
|
3979
4024
|
declare function useLocalNodes<T extends Record<string, unknown>>(creator: LocalNodeCreator<T>): T;
|
|
3980
4025
|
|
|
4026
|
+
/**
|
|
4027
|
+
* A record of buffer-like values - allows mixed types (TypedArrays, BufferAttributes, TSL nodes)
|
|
4028
|
+
*/
|
|
4029
|
+
type BufferRecordType<T extends BufferLike = BufferLike> = Record<string, T>;
|
|
3981
4030
|
/**
|
|
3982
4031
|
* Creator function that returns a record of buffers.
|
|
3983
4032
|
* Receives CreatorState with access to existing buffers, gpuStorage, uniforms, nodes, etc.
|
|
@@ -3992,14 +4041,15 @@ type RebuildBuffersFn = (scope?: string) => void;
|
|
|
3992
4041
|
/** Function signature for disposeBuffers util - releases GPU resources */
|
|
3993
4042
|
type DisposeBuffersFn = (names: string | string[], scope?: string) => void;
|
|
3994
4043
|
/** Return type with utils included */
|
|
3995
|
-
type BuffersWithUtils<T extends
|
|
4044
|
+
type BuffersWithUtils<T extends BufferRecordType | BufferStore = BufferRecordType> = T & {
|
|
3996
4045
|
removeBuffers: RemoveBuffersFn;
|
|
3997
4046
|
clearBuffers: ClearBuffersFn;
|
|
3998
4047
|
rebuildBuffers: RebuildBuffersFn;
|
|
3999
4048
|
disposeBuffers: DisposeBuffersFn;
|
|
4000
4049
|
};
|
|
4001
|
-
declare function useBuffers(): BuffersWithUtils<
|
|
4050
|
+
declare function useBuffers(): BuffersWithUtils<BufferStore>;
|
|
4002
4051
|
declare function useBuffers(scope: string): BuffersWithUtils<Record<string, BufferLike>>;
|
|
4052
|
+
declare function useBuffers<T extends Record<string, BufferLike>>(scope?: string): BuffersWithUtils<T>;
|
|
4003
4053
|
declare function useBuffers<T extends Record<string, BufferLike>>(creator: BufferCreator<T>): BuffersWithUtils<T>;
|
|
4004
4054
|
declare function useBuffers<T extends Record<string, BufferLike>>(creator: BufferCreator<T>, scope: string): BuffersWithUtils<T>;
|
|
4005
4055
|
/**
|
|
@@ -4015,6 +4065,10 @@ declare function useBuffers<T extends Record<string, BufferLike>>(creator: Buffe
|
|
|
4015
4065
|
*/
|
|
4016
4066
|
declare function rebuildAllBuffers(store: ReturnType<typeof useStore>, scope?: string): void;
|
|
4017
4067
|
|
|
4068
|
+
/**
|
|
4069
|
+
* A record of storage-like values - allows mixed types (StorageTexture, Storage3DTexture, TSL nodes)
|
|
4070
|
+
*/
|
|
4071
|
+
type StorageRecordType<T extends StorageLike = StorageLike> = Record<string, T>;
|
|
4018
4072
|
/**
|
|
4019
4073
|
* Creator function that returns a record of GPU storage objects.
|
|
4020
4074
|
* Receives CreatorState with access to existing buffers, gpuStorage, uniforms, nodes, etc.
|
|
@@ -4029,14 +4083,15 @@ type RebuildStorageFn = (scope?: string) => void;
|
|
|
4029
4083
|
/** Function signature for disposeStorage util - releases GPU resources */
|
|
4030
4084
|
type DisposeStorageFn = (names: string | string[], scope?: string) => void;
|
|
4031
4085
|
/** Return type with utils included */
|
|
4032
|
-
type StorageWithUtils<T extends
|
|
4086
|
+
type StorageWithUtils<T extends StorageRecordType | StorageStore = StorageRecordType> = T & {
|
|
4033
4087
|
removeStorage: RemoveStorageFn;
|
|
4034
4088
|
clearStorage: ClearStorageFn;
|
|
4035
4089
|
rebuildStorage: RebuildStorageFn;
|
|
4036
4090
|
disposeStorage: DisposeStorageFn;
|
|
4037
4091
|
};
|
|
4038
|
-
declare function useGPUStorage(): StorageWithUtils<
|
|
4092
|
+
declare function useGPUStorage(): StorageWithUtils<StorageStore>;
|
|
4039
4093
|
declare function useGPUStorage(scope: string): StorageWithUtils<Record<string, StorageLike>>;
|
|
4094
|
+
declare function useGPUStorage<T extends Record<string, StorageLike>>(scope?: string): StorageWithUtils<T>;
|
|
4040
4095
|
declare function useGPUStorage<T extends Record<string, StorageLike>>(creator: StorageCreator<T>): StorageWithUtils<T>;
|
|
4041
4096
|
declare function useGPUStorage<T extends Record<string, StorageLike>>(creator: StorageCreator<T>, scope: string): StorageWithUtils<T>;
|
|
4042
4097
|
/**
|
|
@@ -4086,6 +4141,10 @@ declare function createTextureOperations(set: StoreApi<RootState>['setState']):
|
|
|
4086
4141
|
* - Callbacks receive full RootState for flexibility
|
|
4087
4142
|
* - No auto-cleanup on unmount - use reset() for explicit cleanup
|
|
4088
4143
|
* - Scene/camera changes trigger scenePass recreation
|
|
4144
|
+
* - A replaced scenePass is disposed once the new graph is installed, so rebuild() does not
|
|
4145
|
+
* strand its render target (and MRT attachments) on the GPU
|
|
4146
|
+
* - Any run that changes the output node sets RenderPipeline.needsUpdate, so rebuild() actually
|
|
4147
|
+
* recompiles instead of silently keeping the first compiled graph
|
|
4089
4148
|
*
|
|
4090
4149
|
* @param mainCB - Main callback to configure outputNode and create effect passes
|
|
4091
4150
|
* @param setupCB - Optional setup callback to configure MRT on scenePass
|
|
@@ -4163,5 +4222,32 @@ interface WebGPURootState extends Omit<RootState, 'renderer' | 'gl' | 'internal'
|
|
|
4163
4222
|
internal: WebGPUInternalState
|
|
4164
4223
|
}
|
|
4165
4224
|
|
|
4225
|
+
/**
|
|
4226
|
+
* @fileoverview WebGPU entry point - WebGPU only, no legacy WebGL
|
|
4227
|
+
*
|
|
4228
|
+
* This entry point is for apps that want to use ONLY WebGPURenderer.
|
|
4229
|
+
* Includes WebGPU-specific hooks (useUniforms, useNodes, useTextures).
|
|
4230
|
+
* Auto-extends THREE with WebGPU node materials (MeshBasicNodeMaterial, etc.)
|
|
4231
|
+
*
|
|
4232
|
+
* Usage:
|
|
4233
|
+
* import { Canvas, useFrame, useUniforms } from '@react-three/fiber/webgpu'
|
|
4234
|
+
*/
|
|
4235
|
+
|
|
4236
|
+
/** `useThree` narrowed to WebGPU state — `state.renderer` is a `WebGPURenderer`. */
|
|
4237
|
+
type UseThreeWebGPU = <T = WebGPURootState>(selector?: (state: WebGPURootState) => T, equalityFn?: <U>(state: U, newState: U) => boolean) => T;
|
|
4238
|
+
/** `useFrame` narrowed to WebGPU state — the callback's `state.renderer` is a `WebGPURenderer`. */
|
|
4239
|
+
type UseFrameWebGPU = (callback?: FrameCallback$1<WebGPURootState>, priorityOrOptions?: number | UseFrameNextOptions) => FrameNextControls;
|
|
4240
|
+
declare const useThree: UseThreeWebGPU;
|
|
4241
|
+
declare const useFrame: UseFrameWebGPU;
|
|
4242
|
+
|
|
4243
|
+
/** Canvas props on the WebGPU entry: `onCreated` receives `WebGPURootState`. */
|
|
4244
|
+
type WebGPUCanvasProps = Omit<CanvasProps, 'onCreated'> & {
|
|
4245
|
+
/** Callback after the canvas has rendered (but not yet committed); `state.renderer` is a `WebGPURenderer` */
|
|
4246
|
+
onCreated?: (state: WebGPURootState) => void;
|
|
4247
|
+
};
|
|
4248
|
+
|
|
4249
|
+
/** `Canvas` narrowed to WebGPU state — the same component, `onCreated` typed against `WebGPURootState`. */
|
|
4250
|
+
declare const Canvas: (props: WebGPUCanvasProps) => JSX.Element;
|
|
4251
|
+
|
|
4166
4252
|
export { Block, Canvas, Environment, EnvironmentCube, EnvironmentMap, EnvironmentPortal, ErrorBoundary, FROM_REF, IsObject, ONCE, Portal, R3F_BUILD_LEGACY, R3F_BUILD_WEBGPU, REACT_INTERNAL_PROPS, RESERVED_PROPS, three_d as ReactThreeFiber, Texture, _roots, addAfterEffect, addEffect, addTail, advance, applyProps, attach, buildGraph, calculateDpr, clearNodeScope, clearRootNodes, clearRootUniforms, clearScope, context, createEvents, createPointerEvents, createPortal, createRoot, createScopedStore, createStore, createTextureOperations, detach, diffProps, dispose, createPointerEvents as events, extend, findInitialRoot, flushSync, fromRef, getInstanceProps, getPrimary, getPrimaryIds, getRootState, getUuidPrefix, hasConstructor, hasPrimary, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isFromRef, isObject3D, isOnce, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, once, prepare, presetsObj, rebuildAllBuffers, rebuildAllNodes, rebuildAllStorage, rebuildAllUniforms, reconciler, registerPrimary, removeInteractivity, removeNodes, removeUniforms, resolve, swapInteractivity, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useBuffers, useEnvironment, useFrame, useGPUStorage, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useLocalNodes, useMutableCallback, useNodes, useRenderPipeline, useRenderTarget, useStore, useTexture, useTextures, useThree, useUniform, useUniforms, waitForPrimary };
|
|
4167
|
-
export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferCreator, BufferLike, BufferRecord, BufferStore, BuffersWithUtils, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, ClearBuffersFn, ClearNodesFn, ClearStorageFn, ClearUniformsFn, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, CreatorState, DefaultGLProps, DefaultRendererProps, Disposable, DisposeBuffersFn, DisposeOptions, DisposeStorageFn, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, WebGPUInternalState as InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, LocalNodeCreator, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeCreator, NodeProps, NodeRecord, NodesWithUtils, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, WebGPUR3FRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, RebuildBuffersFn, RebuildNodesFn, RebuildStorageFn, RebuildUniformsFn, ReconcilerRoot, RemoveBuffersFn, RemoveNodesFn, RemoveStorageFn, RemoveUniformsFn, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, WebGPURootState as RootState, RootStore, ScopedStoreType, SetBlock, Size, StorageCreator, StorageLike, StorageRecord, StorageStore, StorageWithUtils, Subscription, TSLNode, TSLNodeInput, TextureEntry, TextureInput, TextureNode, TextureOperations, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UniformCreator, UniformValue, UniformsWithUtils, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, WebGPUDefaultProps, WebGPUProps, WebGPUShadowConfig, XRManager, XRPointerConfig };
|
|
4253
|
+
export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferCreator, BufferLike, BufferRecord, BufferStore, BuffersWithUtils, Camera, CameraProps, WebGPUCanvasProps as CanvasProps, CanvasSchedulerConfig, Catalogue, ClearBuffersFn, ClearNodesFn, ClearStorageFn, ClearUniformsFn, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, CreatorState, DefaultGLProps, DefaultRendererProps, Disposable, DisposeBuffersFn, DisposeOptions, DisposeStorageFn, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, FromRefMarker, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, WebGPUInternalState as InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, LocalNodeCreator, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeCreator, NodeLike, NodeProps, NodeRecord, NodeStore, NodesWithUtils, NonFunctionKeys, Object3DMethod, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, OnceValue, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, WebGPUR3FRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, RebuildBuffersFn, RebuildNodesFn, RebuildStorageFn, RebuildUniformsFn, ReconcilerRoot, RemoveBuffersFn, RemoveNodesFn, RemoveStorageFn, RemoveUniformsFn, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, WebGPURootState as RootState, RootStore, ScopedStoreType, SetBlock, Size, StorageCreator, StorageLike, StorageRecord, StorageStore, StorageWithUtils, Subscription, TSLNode, TSLNodeInput, TSLNodeLike, TextureEntry, TextureInput, TextureNode, TextureOperations, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UniformCreator, UniformValue, UniformsWithUtils, UseFrameWebGPU, UseTextureOptions, UseTexturesReturn, UseThreeWebGPU, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, WebGPUCanvasProps, WebGPUDefaultProps, WebGPUProps, WebGPUShadowConfig, XRManager, XRPointerConfig };
|