@react-three/fiber 10.0.0-canary.07c4f9d → 10.0.0-canary.0ea97c0
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 +19 -15
- package/dist/index.d.cts +137 -17
- package/dist/index.d.mts +137 -17
- package/dist/index.d.ts +137 -17
- package/dist/index.mjs +19 -15
- package/dist/legacy.cjs +16 -11
- package/dist/legacy.d.cts +137 -17
- package/dist/legacy.d.mts +137 -17
- package/dist/legacy.d.ts +137 -17
- package/dist/legacy.mjs +16 -11
- package/dist/webgpu/index.cjs +33 -28
- package/dist/webgpu/index.d.cts +141 -33
- package/dist/webgpu/index.d.mts +141 -33
- package/dist/webgpu/index.d.ts +141 -33
- package/dist/webgpu/index.mjs +33 -28
- package/package.json +1 -1
package/dist/legacy.d.mts
CHANGED
|
@@ -359,6 +359,33 @@ type BufferRecord = Record<string, BufferLike>
|
|
|
359
359
|
*/
|
|
360
360
|
type BufferStore = Record<string, BufferLike | BufferRecord>
|
|
361
361
|
|
|
362
|
+
//* Node Types (useNodes) ========================================
|
|
363
|
+
|
|
364
|
+
/**
|
|
365
|
+
* Structural shape of a TSL node as stored on `state.nodes`.
|
|
366
|
+
*
|
|
367
|
+
* Deliberately minimal rather than three's nominal `Node`: in @types/three several node classes
|
|
368
|
+
* TSL hands back (OperatorNode, ConstNode, ...) do not extend `Node` cleanly, so a `Node` bound
|
|
369
|
+
* would reject values `useNodes` creators legitimately return. This is the same shape
|
|
370
|
+
* `useNodes` already constrains creators to (`TSLNodeLike`).
|
|
371
|
+
*/
|
|
372
|
+
interface NodeLike {
|
|
373
|
+
uuid?: string
|
|
374
|
+
nodeType?: string | null
|
|
375
|
+
/** label method for chaining - sets the node's label and returns self */
|
|
376
|
+
label?: ((label: string) => NodeLike) | string
|
|
377
|
+
setName?: (name: string) => this
|
|
378
|
+
}
|
|
379
|
+
|
|
380
|
+
/** Flat record of TSL nodes (no nested scopes) */
|
|
381
|
+
type NodeRecord = Record<string, NodeLike>
|
|
382
|
+
|
|
383
|
+
/**
|
|
384
|
+
* Node store that can contain both root-level nodes and scoped node objects.
|
|
385
|
+
* Structure: { wobble: OperatorNode, fx: { blur: ShaderCallable } }
|
|
386
|
+
*/
|
|
387
|
+
type NodeStore = Record<string, NodeLike | NodeRecord>
|
|
388
|
+
|
|
362
389
|
//* Storage Types (useGPUStorage) ========================================
|
|
363
390
|
|
|
364
391
|
/**
|
|
@@ -492,8 +519,13 @@ interface InternalState {
|
|
|
492
519
|
/** Container for child attachment (scene for root, original container for portals) */
|
|
493
520
|
container?: THREE$1.Object3D
|
|
494
521
|
/**
|
|
495
|
-
* CanvasTarget
|
|
496
|
-
*
|
|
522
|
+
* The CanvasTarget this root sizes and renders through.
|
|
523
|
+
*
|
|
524
|
+
* A primary (`<Canvas id>`) owns the renderer's default target -- the one three itself built
|
|
525
|
+
* around the canvas element -- so sizing it is sizing the renderer. A secondary owns a target
|
|
526
|
+
* R3F created for its own element. Either way there is exactly one target per canvas element,
|
|
527
|
+
* and the canvas-target job makes it the renderer's active one before this root renders.
|
|
528
|
+
* Absent on WebGL and on an id-less WebGPU canvas, where the renderer is sized directly.
|
|
497
529
|
* @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
|
|
498
530
|
*/
|
|
499
531
|
canvasTarget?: CanvasTarget
|
|
@@ -618,7 +650,7 @@ interface RootState {
|
|
|
618
650
|
/** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
|
|
619
651
|
uniforms: UniformStore
|
|
620
652
|
/** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
|
|
621
|
-
nodes:
|
|
653
|
+
nodes: NodeStore
|
|
622
654
|
/** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
|
|
623
655
|
buffers: BufferStore
|
|
624
656
|
/** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
|
|
@@ -630,7 +662,7 @@ interface RootState {
|
|
|
630
662
|
/** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
|
|
631
663
|
renderPipeline: ThreeRenderPipeline | null
|
|
632
664
|
/** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
|
|
633
|
-
passes:
|
|
665
|
+
passes: PassRecord
|
|
634
666
|
/** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
|
|
635
667
|
_hmrVersion: number
|
|
636
668
|
/** Internal: whether setSize() has taken ownership of canvas dimensions */
|
|
@@ -1178,7 +1210,33 @@ declare global {
|
|
|
1178
1210
|
* ergonomics. The result is three's structural type, so members stay in sync with the
|
|
1179
1211
|
* installed three instead of needing to be mirrored by hand.
|
|
1180
1212
|
*/
|
|
1181
|
-
type UniformNode<T = unknown> = three_webgpu.UniformNode<
|
|
1213
|
+
type UniformNode<T = unknown> = three_webgpu.UniformNode<UniformNodeTypeFor<T>, T>
|
|
1214
|
+
|
|
1215
|
+
/**
|
|
1216
|
+
* three's node type name for a uniform value type, mirroring the `uniform()` overloads.
|
|
1217
|
+
* A `UniformNode<number>` is a `Node<'float'>`, so TSL math (`.mul`, `.add`, ...) accepts it.
|
|
1218
|
+
* Unknown or unlisted value types resolve to `unknown`, which TSL math rejects: narrow with
|
|
1219
|
+
* `as UniformNode<number>` (or the matching value type) at the call site.
|
|
1220
|
+
*/
|
|
1221
|
+
type UniformNodeTypeFor<T> = T extends number
|
|
1222
|
+
? 'float'
|
|
1223
|
+
: T extends boolean
|
|
1224
|
+
? 'bool'
|
|
1225
|
+
: T extends three_webgpu.Color
|
|
1226
|
+
? 'color'
|
|
1227
|
+
: T extends three_webgpu.Vector2
|
|
1228
|
+
? 'vec2'
|
|
1229
|
+
: T extends three_webgpu.Vector3
|
|
1230
|
+
? 'vec3'
|
|
1231
|
+
: T extends three_webgpu.Vector4
|
|
1232
|
+
? 'vec4'
|
|
1233
|
+
: T extends three_webgpu.Matrix2
|
|
1234
|
+
? 'mat2'
|
|
1235
|
+
: T extends three_webgpu.Matrix3
|
|
1236
|
+
? 'mat3'
|
|
1237
|
+
: T extends three_webgpu.Matrix4
|
|
1238
|
+
? 'mat4'
|
|
1239
|
+
: unknown
|
|
1182
1240
|
|
|
1183
1241
|
/**
|
|
1184
1242
|
* ShaderCallable - the return type of Fn()
|
|
@@ -1331,35 +1389,97 @@ declare global {
|
|
|
1331
1389
|
*/
|
|
1332
1390
|
type ThreeRenderPipeline = three_webgpu.RenderPipeline
|
|
1333
1391
|
|
|
1334
|
-
/**
|
|
1335
|
-
|
|
1392
|
+
/**
|
|
1393
|
+
* The pass `useRenderPipeline` creates for you: three's own `PassNode`, as returned by
|
|
1394
|
+
* `pass(scene, camera)` from `three/tsl`. Referenced from three so members like
|
|
1395
|
+
* `getTextureNode`, `setMRT` and `dispose` track the installed version.
|
|
1396
|
+
*/
|
|
1397
|
+
type ScenePassNode = three_webgpu.PassNode
|
|
1398
|
+
|
|
1399
|
+
/**
|
|
1400
|
+
* Pass record - stores TSL pass nodes for render pipeline.
|
|
1401
|
+
*
|
|
1402
|
+
* `scenePass` is the only key the library owns. It is optional here because this is also the
|
|
1403
|
+
* shape of `state.passes`, which is `{}` before the pipeline exists and again after `reset()`
|
|
1404
|
+
* or `clearPasses()`. Inside the callbacks it is always present; see
|
|
1405
|
+
* {@link RenderPipelineCallbackState}.
|
|
1406
|
+
*
|
|
1407
|
+
* Every other key is user-registered, via a callback's return value. Those are TSL nodes of
|
|
1408
|
+
* any kind, not only passes: texture reads of an MRT attachment, effect nodes, extra
|
|
1409
|
+
* `pass()` instances. `Node` is the common base, so that is the bound. Narrow at the call
|
|
1410
|
+
* site when you need a member, e.g. `passes.velocity as TextureNode`.
|
|
1411
|
+
*/
|
|
1412
|
+
interface PassRecord {
|
|
1413
|
+
scenePass?: ScenePassNode
|
|
1414
|
+
[key: string]: three_webgpu.Node
|
|
1415
|
+
}
|
|
1336
1416
|
|
|
1337
|
-
/**
|
|
1417
|
+
/**
|
|
1418
|
+
* State passed to pipeline callbacks after the active pipeline has been created.
|
|
1419
|
+
*
|
|
1420
|
+
* `passes.scenePass` is required here: the hook installs the default scene pass before either
|
|
1421
|
+
* callback runs, so callbacks can use it without a guard or a cast.
|
|
1422
|
+
*
|
|
1423
|
+
* `renderer` is narrowed to `WebGPURenderer` and `isLegacy` to `false`: the hook throws under
|
|
1424
|
+
* the legacy renderer before either callback can run, so a callback never sees WebGL.
|
|
1425
|
+
*/
|
|
1338
1426
|
type RenderPipelineCallbackState = RootState & {
|
|
1339
1427
|
renderPipeline: ThreeRenderPipeline
|
|
1428
|
+
passes: PassRecord & { scenePass: ScenePassNode }
|
|
1429
|
+
renderer: three_webgpu.WebGPURenderer
|
|
1430
|
+
isLegacy: false
|
|
1340
1431
|
}
|
|
1341
1432
|
|
|
1433
|
+
/**
|
|
1434
|
+
* What a callback may return to register entries into `state.passes`.
|
|
1435
|
+
*
|
|
1436
|
+
* `scenePass` is reserved. The hook owns that entry and its lifecycle: it caches the pass it
|
|
1437
|
+
* created, and `rebuild()` / `reset()` dispose that cached pass. A callback overwriting the
|
|
1438
|
+
* store entry would leave the store pointing at a node the hook never disposes, and the hook
|
|
1439
|
+
* disposing a pass nothing references. So returning it is a type error.
|
|
1440
|
+
*/
|
|
1441
|
+
type RegisteredPasses = Record<string, three_webgpu.Node> & { scenePass?: never }
|
|
1442
|
+
|
|
1342
1443
|
/** Setup callback - runs first to configure MRT, create additional passes */
|
|
1343
|
-
type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) =>
|
|
1444
|
+
type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1344
1445
|
|
|
1345
1446
|
/** Main callback - runs second to configure outputNode, create effect passes */
|
|
1346
|
-
type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) =>
|
|
1447
|
+
type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1347
1448
|
|
|
1348
|
-
/**
|
|
1349
|
-
interface
|
|
1449
|
+
/** The imperative half of useRenderPipeline's return value, present in every state */
|
|
1450
|
+
interface UseRenderPipelineActions {
|
|
1350
1451
|
/** Current passes from state */
|
|
1351
1452
|
passes: PassRecord
|
|
1352
|
-
/** RenderPipeline instance (null if not initialized) */
|
|
1353
|
-
renderPipeline: ThreeRenderPipeline | null
|
|
1354
1453
|
/** Clear all passes from state */
|
|
1355
1454
|
clearPasses: () => void
|
|
1356
1455
|
/** Reset RenderPipeline entirely (clears PP + passes) */
|
|
1357
1456
|
reset: () => void
|
|
1358
1457
|
/** Re-run setup/main callbacks with current closure values */
|
|
1359
1458
|
rebuild: () => void
|
|
1360
|
-
/** True when RenderPipeline is configured and ready */
|
|
1361
|
-
isReady: boolean
|
|
1362
1459
|
}
|
|
1460
|
+
|
|
1461
|
+
/**
|
|
1462
|
+
* Return type for useRenderPipeline hook, discriminated on `isReady`.
|
|
1463
|
+
*
|
|
1464
|
+
* `if (isReady)` narrows `renderPipeline` to non-null, which is what the docs already tell
|
|
1465
|
+
* callers to check. `passes.scenePass` deliberately stays optional in the ready branch:
|
|
1466
|
+
* `clearPasses()` empties the record while leaving the pipeline in place.
|
|
1467
|
+
*/
|
|
1468
|
+
type UseRenderPipelineReturn = UseRenderPipelineActions &
|
|
1469
|
+
(
|
|
1470
|
+
| {
|
|
1471
|
+
/** True when RenderPipeline is configured and ready */
|
|
1472
|
+
isReady: true
|
|
1473
|
+
/** RenderPipeline instance */
|
|
1474
|
+
renderPipeline: ThreeRenderPipeline
|
|
1475
|
+
}
|
|
1476
|
+
| {
|
|
1477
|
+
/** False until the pipeline has been created */
|
|
1478
|
+
isReady: false
|
|
1479
|
+
/** Not initialized yet, or torn down by reset() */
|
|
1480
|
+
renderPipeline: null
|
|
1481
|
+
}
|
|
1482
|
+
)
|
|
1363
1483
|
}
|
|
1364
1484
|
|
|
1365
1485
|
type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
|
|
@@ -3777,4 +3897,4 @@ declare function isOnce(value: unknown): value is {
|
|
|
3777
3897
|
declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
|
|
3778
3898
|
|
|
3779
3899
|
export { Block, Canvas, Environment, EnvironmentCube, EnvironmentMap, EnvironmentPortal, ErrorBoundary, FROM_REF, IsObject, ONCE, Portal, R3F_BUILD_LEGACY, R3F_BUILD_WEBGPU, REACT_INTERNAL_PROPS, RESERVED_PROPS, three_d as ReactThreeFiber, Texture, _roots, addAfterEffect, addEffect, addTail, advance, applyProps, attach, buildGraph, calculateDpr, context, createEvents, createPointerEvents, createPortal, createRoot, createStore, detach, diffProps, dispose, createPointerEvents as events, extend, findInitialRoot, flushSync, fromRef, getInstanceProps, getPrimary, getPrimaryIds, getRootState, getUuidPrefix, hasConstructor, hasPrimary, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isFromRef, isObject3D, isOnce, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, once, prepare, presetsObj, reconciler, registerPrimary, removeInteractivity, resolve, swapInteractivity, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useMutableCallback, useRenderTarget, useStore, useTexture, useTextures, useThree, waitForPrimary };
|
|
3780
|
-
export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferLike, BufferRecord, BufferStore, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DisposeOptions, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, LegacyInternalState as InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeProps, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, LegacyRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, LegacyRootState as RootState, RootStore, SetBlock, Size, StorageLike, StorageRecord, StorageStore, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };
|
|
3900
|
+
export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferLike, BufferRecord, BufferStore, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DisposeOptions, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, LegacyInternalState as InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeLike, NodeProps, NodeRecord, NodeStore, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, LegacyRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, LegacyRootState as RootState, RootStore, SetBlock, Size, StorageLike, StorageRecord, StorageStore, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };
|
package/dist/legacy.d.ts
CHANGED
|
@@ -359,6 +359,33 @@ type BufferRecord = Record<string, BufferLike>
|
|
|
359
359
|
*/
|
|
360
360
|
type BufferStore = Record<string, BufferLike | BufferRecord>
|
|
361
361
|
|
|
362
|
+
//* Node Types (useNodes) ========================================
|
|
363
|
+
|
|
364
|
+
/**
|
|
365
|
+
* Structural shape of a TSL node as stored on `state.nodes`.
|
|
366
|
+
*
|
|
367
|
+
* Deliberately minimal rather than three's nominal `Node`: in @types/three several node classes
|
|
368
|
+
* TSL hands back (OperatorNode, ConstNode, ...) do not extend `Node` cleanly, so a `Node` bound
|
|
369
|
+
* would reject values `useNodes` creators legitimately return. This is the same shape
|
|
370
|
+
* `useNodes` already constrains creators to (`TSLNodeLike`).
|
|
371
|
+
*/
|
|
372
|
+
interface NodeLike {
|
|
373
|
+
uuid?: string
|
|
374
|
+
nodeType?: string | null
|
|
375
|
+
/** label method for chaining - sets the node's label and returns self */
|
|
376
|
+
label?: ((label: string) => NodeLike) | string
|
|
377
|
+
setName?: (name: string) => this
|
|
378
|
+
}
|
|
379
|
+
|
|
380
|
+
/** Flat record of TSL nodes (no nested scopes) */
|
|
381
|
+
type NodeRecord = Record<string, NodeLike>
|
|
382
|
+
|
|
383
|
+
/**
|
|
384
|
+
* Node store that can contain both root-level nodes and scoped node objects.
|
|
385
|
+
* Structure: { wobble: OperatorNode, fx: { blur: ShaderCallable } }
|
|
386
|
+
*/
|
|
387
|
+
type NodeStore = Record<string, NodeLike | NodeRecord>
|
|
388
|
+
|
|
362
389
|
//* Storage Types (useGPUStorage) ========================================
|
|
363
390
|
|
|
364
391
|
/**
|
|
@@ -492,8 +519,13 @@ interface InternalState {
|
|
|
492
519
|
/** Container for child attachment (scene for root, original container for portals) */
|
|
493
520
|
container?: THREE$1.Object3D
|
|
494
521
|
/**
|
|
495
|
-
* CanvasTarget
|
|
496
|
-
*
|
|
522
|
+
* The CanvasTarget this root sizes and renders through.
|
|
523
|
+
*
|
|
524
|
+
* A primary (`<Canvas id>`) owns the renderer's default target -- the one three itself built
|
|
525
|
+
* around the canvas element -- so sizing it is sizing the renderer. A secondary owns a target
|
|
526
|
+
* R3F created for its own element. Either way there is exactly one target per canvas element,
|
|
527
|
+
* and the canvas-target job makes it the renderer's active one before this root renders.
|
|
528
|
+
* Absent on WebGL and on an id-less WebGPU canvas, where the renderer is sized directly.
|
|
497
529
|
* @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
|
|
498
530
|
*/
|
|
499
531
|
canvasTarget?: CanvasTarget
|
|
@@ -618,7 +650,7 @@ interface RootState {
|
|
|
618
650
|
/** Global TSL uniform nodes - root-level uniforms + scoped sub-objects. Use useUniforms() hook */
|
|
619
651
|
uniforms: UniformStore
|
|
620
652
|
/** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
|
|
621
|
-
nodes:
|
|
653
|
+
nodes: NodeStore
|
|
622
654
|
/** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
|
|
623
655
|
buffers: BufferStore
|
|
624
656
|
/** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
|
|
@@ -630,7 +662,7 @@ interface RootState {
|
|
|
630
662
|
/** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
|
|
631
663
|
renderPipeline: ThreeRenderPipeline | null
|
|
632
664
|
/** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
|
|
633
|
-
passes:
|
|
665
|
+
passes: PassRecord
|
|
634
666
|
/** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
|
|
635
667
|
_hmrVersion: number
|
|
636
668
|
/** Internal: whether setSize() has taken ownership of canvas dimensions */
|
|
@@ -1178,7 +1210,33 @@ declare global {
|
|
|
1178
1210
|
* ergonomics. The result is three's structural type, so members stay in sync with the
|
|
1179
1211
|
* installed three instead of needing to be mirrored by hand.
|
|
1180
1212
|
*/
|
|
1181
|
-
type UniformNode<T = unknown> = three_webgpu.UniformNode<
|
|
1213
|
+
type UniformNode<T = unknown> = three_webgpu.UniformNode<UniformNodeTypeFor<T>, T>
|
|
1214
|
+
|
|
1215
|
+
/**
|
|
1216
|
+
* three's node type name for a uniform value type, mirroring the `uniform()` overloads.
|
|
1217
|
+
* A `UniformNode<number>` is a `Node<'float'>`, so TSL math (`.mul`, `.add`, ...) accepts it.
|
|
1218
|
+
* Unknown or unlisted value types resolve to `unknown`, which TSL math rejects: narrow with
|
|
1219
|
+
* `as UniformNode<number>` (or the matching value type) at the call site.
|
|
1220
|
+
*/
|
|
1221
|
+
type UniformNodeTypeFor<T> = T extends number
|
|
1222
|
+
? 'float'
|
|
1223
|
+
: T extends boolean
|
|
1224
|
+
? 'bool'
|
|
1225
|
+
: T extends three_webgpu.Color
|
|
1226
|
+
? 'color'
|
|
1227
|
+
: T extends three_webgpu.Vector2
|
|
1228
|
+
? 'vec2'
|
|
1229
|
+
: T extends three_webgpu.Vector3
|
|
1230
|
+
? 'vec3'
|
|
1231
|
+
: T extends three_webgpu.Vector4
|
|
1232
|
+
? 'vec4'
|
|
1233
|
+
: T extends three_webgpu.Matrix2
|
|
1234
|
+
? 'mat2'
|
|
1235
|
+
: T extends three_webgpu.Matrix3
|
|
1236
|
+
? 'mat3'
|
|
1237
|
+
: T extends three_webgpu.Matrix4
|
|
1238
|
+
? 'mat4'
|
|
1239
|
+
: unknown
|
|
1182
1240
|
|
|
1183
1241
|
/**
|
|
1184
1242
|
* ShaderCallable - the return type of Fn()
|
|
@@ -1331,35 +1389,97 @@ declare global {
|
|
|
1331
1389
|
*/
|
|
1332
1390
|
type ThreeRenderPipeline = three_webgpu.RenderPipeline
|
|
1333
1391
|
|
|
1334
|
-
/**
|
|
1335
|
-
|
|
1392
|
+
/**
|
|
1393
|
+
* The pass `useRenderPipeline` creates for you: three's own `PassNode`, as returned by
|
|
1394
|
+
* `pass(scene, camera)` from `three/tsl`. Referenced from three so members like
|
|
1395
|
+
* `getTextureNode`, `setMRT` and `dispose` track the installed version.
|
|
1396
|
+
*/
|
|
1397
|
+
type ScenePassNode = three_webgpu.PassNode
|
|
1398
|
+
|
|
1399
|
+
/**
|
|
1400
|
+
* Pass record - stores TSL pass nodes for render pipeline.
|
|
1401
|
+
*
|
|
1402
|
+
* `scenePass` is the only key the library owns. It is optional here because this is also the
|
|
1403
|
+
* shape of `state.passes`, which is `{}` before the pipeline exists and again after `reset()`
|
|
1404
|
+
* or `clearPasses()`. Inside the callbacks it is always present; see
|
|
1405
|
+
* {@link RenderPipelineCallbackState}.
|
|
1406
|
+
*
|
|
1407
|
+
* Every other key is user-registered, via a callback's return value. Those are TSL nodes of
|
|
1408
|
+
* any kind, not only passes: texture reads of an MRT attachment, effect nodes, extra
|
|
1409
|
+
* `pass()` instances. `Node` is the common base, so that is the bound. Narrow at the call
|
|
1410
|
+
* site when you need a member, e.g. `passes.velocity as TextureNode`.
|
|
1411
|
+
*/
|
|
1412
|
+
interface PassRecord {
|
|
1413
|
+
scenePass?: ScenePassNode
|
|
1414
|
+
[key: string]: three_webgpu.Node
|
|
1415
|
+
}
|
|
1336
1416
|
|
|
1337
|
-
/**
|
|
1417
|
+
/**
|
|
1418
|
+
* State passed to pipeline callbacks after the active pipeline has been created.
|
|
1419
|
+
*
|
|
1420
|
+
* `passes.scenePass` is required here: the hook installs the default scene pass before either
|
|
1421
|
+
* callback runs, so callbacks can use it without a guard or a cast.
|
|
1422
|
+
*
|
|
1423
|
+
* `renderer` is narrowed to `WebGPURenderer` and `isLegacy` to `false`: the hook throws under
|
|
1424
|
+
* the legacy renderer before either callback can run, so a callback never sees WebGL.
|
|
1425
|
+
*/
|
|
1338
1426
|
type RenderPipelineCallbackState = RootState & {
|
|
1339
1427
|
renderPipeline: ThreeRenderPipeline
|
|
1428
|
+
passes: PassRecord & { scenePass: ScenePassNode }
|
|
1429
|
+
renderer: three_webgpu.WebGPURenderer
|
|
1430
|
+
isLegacy: false
|
|
1340
1431
|
}
|
|
1341
1432
|
|
|
1433
|
+
/**
|
|
1434
|
+
* What a callback may return to register entries into `state.passes`.
|
|
1435
|
+
*
|
|
1436
|
+
* `scenePass` is reserved. The hook owns that entry and its lifecycle: it caches the pass it
|
|
1437
|
+
* created, and `rebuild()` / `reset()` dispose that cached pass. A callback overwriting the
|
|
1438
|
+
* store entry would leave the store pointing at a node the hook never disposes, and the hook
|
|
1439
|
+
* disposing a pass nothing references. So returning it is a type error.
|
|
1440
|
+
*/
|
|
1441
|
+
type RegisteredPasses = Record<string, three_webgpu.Node> & { scenePass?: never }
|
|
1442
|
+
|
|
1342
1443
|
/** Setup callback - runs first to configure MRT, create additional passes */
|
|
1343
|
-
type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) =>
|
|
1444
|
+
type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1344
1445
|
|
|
1345
1446
|
/** Main callback - runs second to configure outputNode, create effect passes */
|
|
1346
|
-
type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) =>
|
|
1447
|
+
type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => RegisteredPasses | void
|
|
1347
1448
|
|
|
1348
|
-
/**
|
|
1349
|
-
interface
|
|
1449
|
+
/** The imperative half of useRenderPipeline's return value, present in every state */
|
|
1450
|
+
interface UseRenderPipelineActions {
|
|
1350
1451
|
/** Current passes from state */
|
|
1351
1452
|
passes: PassRecord
|
|
1352
|
-
/** RenderPipeline instance (null if not initialized) */
|
|
1353
|
-
renderPipeline: ThreeRenderPipeline | null
|
|
1354
1453
|
/** Clear all passes from state */
|
|
1355
1454
|
clearPasses: () => void
|
|
1356
1455
|
/** Reset RenderPipeline entirely (clears PP + passes) */
|
|
1357
1456
|
reset: () => void
|
|
1358
1457
|
/** Re-run setup/main callbacks with current closure values */
|
|
1359
1458
|
rebuild: () => void
|
|
1360
|
-
/** True when RenderPipeline is configured and ready */
|
|
1361
|
-
isReady: boolean
|
|
1362
1459
|
}
|
|
1460
|
+
|
|
1461
|
+
/**
|
|
1462
|
+
* Return type for useRenderPipeline hook, discriminated on `isReady`.
|
|
1463
|
+
*
|
|
1464
|
+
* `if (isReady)` narrows `renderPipeline` to non-null, which is what the docs already tell
|
|
1465
|
+
* callers to check. `passes.scenePass` deliberately stays optional in the ready branch:
|
|
1466
|
+
* `clearPasses()` empties the record while leaving the pipeline in place.
|
|
1467
|
+
*/
|
|
1468
|
+
type UseRenderPipelineReturn = UseRenderPipelineActions &
|
|
1469
|
+
(
|
|
1470
|
+
| {
|
|
1471
|
+
/** True when RenderPipeline is configured and ready */
|
|
1472
|
+
isReady: true
|
|
1473
|
+
/** RenderPipeline instance */
|
|
1474
|
+
renderPipeline: ThreeRenderPipeline
|
|
1475
|
+
}
|
|
1476
|
+
| {
|
|
1477
|
+
/** False until the pipeline has been created */
|
|
1478
|
+
isReady: false
|
|
1479
|
+
/** Not initialized yet, or torn down by reset() */
|
|
1480
|
+
renderPipeline: null
|
|
1481
|
+
}
|
|
1482
|
+
)
|
|
1363
1483
|
}
|
|
1364
1484
|
|
|
1365
1485
|
type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
|
|
@@ -3777,4 +3897,4 @@ declare function isOnce(value: unknown): value is {
|
|
|
3777
3897
|
declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
|
|
3778
3898
|
|
|
3779
3899
|
export { Block, Canvas, Environment, EnvironmentCube, EnvironmentMap, EnvironmentPortal, ErrorBoundary, FROM_REF, IsObject, ONCE, Portal, R3F_BUILD_LEGACY, R3F_BUILD_WEBGPU, REACT_INTERNAL_PROPS, RESERVED_PROPS, three_d as ReactThreeFiber, Texture, _roots, addAfterEffect, addEffect, addTail, advance, applyProps, attach, buildGraph, calculateDpr, context, createEvents, createPointerEvents, createPortal, createRoot, createStore, detach, diffProps, dispose, createPointerEvents as events, extend, findInitialRoot, flushSync, fromRef, getInstanceProps, getPrimary, getPrimaryIds, getRootState, getUuidPrefix, hasConstructor, hasPrimary, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isFromRef, isObject3D, isOnce, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, once, prepare, presetsObj, reconciler, registerPrimary, removeInteractivity, resolve, swapInteractivity, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useMutableCallback, useRenderTarget, useStore, useTexture, useTextures, useThree, waitForPrimary };
|
|
3780
|
-
export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferLike, BufferRecord, BufferStore, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DisposeOptions, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, LegacyInternalState as InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeProps, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, LegacyRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, LegacyRootState as RootState, RootStore, SetBlock, Size, StorageLike, StorageRecord, StorageStore, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };
|
|
3900
|
+
export type { Act, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferLike, BufferRecord, BufferStore, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ColorManagementConfig, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DisposeOptions, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameNextCallback, FrameNextState, FrameState, Frameloop, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, LegacyInternalState as InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeLike, NodeProps, NodeRecord, NodeStore, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, LegacyRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, LegacyRootState as RootState, RootStore, SetBlock, Size, StorageLike, StorageRecord, StorageStore, Subscription, TSLNodeInput, TextureInput, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };
|
package/dist/legacy.mjs
CHANGED
|
@@ -606,7 +606,12 @@ function diffProps(instance, newProps) {
|
|
|
606
606
|
const changedProps = {};
|
|
607
607
|
for (const prop in newProps) {
|
|
608
608
|
if (RESERVED_PROPS.includes(prop)) continue;
|
|
609
|
-
if (is.equ(newProps[prop], instance.props[prop]))
|
|
609
|
+
if (is.equ(newProps[prop], instance.props[prop])) {
|
|
610
|
+
const value = newProps[prop];
|
|
611
|
+
if (!isCopyable(value)) continue;
|
|
612
|
+
const { target } = resolve(instance.object, prop);
|
|
613
|
+
if (!isCopyable(target) || target.constructor !== value.constructor) continue;
|
|
614
|
+
}
|
|
610
615
|
changedProps[prop] = newProps[prop];
|
|
611
616
|
for (const other in newProps) {
|
|
612
617
|
if (other.startsWith(`${prop}-`)) changedProps[other] = newProps[other];
|
|
@@ -1052,7 +1057,8 @@ const createStore = (invalidate, advance) => {
|
|
|
1052
1057
|
const resizeTarget = canvasTarget ?? actualRenderer;
|
|
1053
1058
|
if (viewport.dpr > 0) resizeTarget.setPixelRatio(viewport.dpr);
|
|
1054
1059
|
resizeTarget.setSize(size.width, size.height, false);
|
|
1055
|
-
|
|
1060
|
+
const activeTarget = actualRenderer.getCanvasTarget?.();
|
|
1061
|
+
if (!canvasTarget || activeTarget !== canvasTarget) internal.canvasTargetSizeDirty = true;
|
|
1056
1062
|
}
|
|
1057
1063
|
if (camera !== oldCamera) {
|
|
1058
1064
|
oldCamera = camera;
|
|
@@ -14409,9 +14415,10 @@ function createRoot(canvas) {
|
|
|
14409
14415
|
const unregisterCanvasTarget = scheduler.register(
|
|
14410
14416
|
() => {
|
|
14411
14417
|
const state2 = store.getState();
|
|
14412
|
-
|
|
14418
|
+
const canvasTarget = state2.internal.canvasTarget;
|
|
14419
|
+
if (canvasTarget) {
|
|
14413
14420
|
const renderer2 = state2.internal.actualRenderer;
|
|
14414
|
-
renderer2.setCanvasTarget(
|
|
14421
|
+
if (renderer2.getCanvasTarget() !== canvasTarget) renderer2.setCanvasTarget(canvasTarget);
|
|
14415
14422
|
if (state2.internal.canvasTargetSizeDirty) {
|
|
14416
14423
|
state2.internal.canvasTargetSizeDirty = false;
|
|
14417
14424
|
renderer2.backend?.updateSize?.();
|
|
@@ -14575,7 +14582,7 @@ function unmountComponentAtNode(canvas, callback) {
|
|
|
14575
14582
|
const unregisterPrimary = state.internal.unregisterPrimary;
|
|
14576
14583
|
if (unregisterPrimary) unregisterPrimary();
|
|
14577
14584
|
const canvasTarget = state.internal.canvasTarget;
|
|
14578
|
-
if (canvasTarget?.dispose) canvasTarget.dispose();
|
|
14585
|
+
if (state.internal.isSecondary && canvasTarget?.dispose) canvasTarget.dispose();
|
|
14579
14586
|
state.events.disconnect?.();
|
|
14580
14587
|
cleanupHelperGroup(root.store);
|
|
14581
14588
|
if (state.isLegacy && renderer) {
|
|
@@ -15019,9 +15026,9 @@ function CanvasImpl({
|
|
|
15019
15026
|
React.useMemo(() => extend(THREE), []);
|
|
15020
15027
|
const Bridge = useBridge();
|
|
15021
15028
|
const backgroundProps = React.useMemo(() => parseBackground(background), [background]);
|
|
15022
|
-
const
|
|
15029
|
+
const [hasInitialSize, setHasInitialSize] = React.useState(false);
|
|
15023
15030
|
const measureConfig = React.useMemo(() => {
|
|
15024
|
-
if (!
|
|
15031
|
+
if (!hasInitialSize) {
|
|
15025
15032
|
return {
|
|
15026
15033
|
...resize,
|
|
15027
15034
|
scroll: resize?.scroll ?? true,
|
|
@@ -15033,7 +15040,7 @@ function CanvasImpl({
|
|
|
15033
15040
|
debounce: { scroll: 50, resize: 0 },
|
|
15034
15041
|
...resize
|
|
15035
15042
|
};
|
|
15036
|
-
}, [
|
|
15043
|
+
}, [hasInitialSize, resize]);
|
|
15037
15044
|
const [containerRef, containerRect] = useMeasure(measureConfig);
|
|
15038
15045
|
const effectiveSize = React.useMemo(() => {
|
|
15039
15046
|
let w = width ?? containerRect.width;
|
|
@@ -15049,9 +15056,7 @@ function CanvasImpl({
|
|
|
15049
15056
|
left: containerRect.left
|
|
15050
15057
|
};
|
|
15051
15058
|
}, [width, height, containerRect, forceEven]);
|
|
15052
|
-
if (!
|
|
15053
|
-
hasInitialSizeRef.current = true;
|
|
15054
|
-
}
|
|
15059
|
+
if (!hasInitialSize && effectiveSize.width > 0 && effectiveSize.height > 0) setHasInitialSize(true);
|
|
15055
15060
|
const canvasRef = React.useRef(null);
|
|
15056
15061
|
const divRef = React.useRef(null);
|
|
15057
15062
|
React.useImperativeHandle(ref, () => canvasRef.current);
|