@react-three/fiber 10.0.0-canary.2c50459 → 10.0.0-canary.39882dd
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 +2642 -2345
- package/dist/index.d.cts +117 -47
- package/dist/index.d.mts +117 -47
- package/dist/index.d.ts +117 -47
- package/dist/index.mjs +2645 -2348
- package/dist/legacy.cjs +2527 -2235
- package/dist/legacy.d.cts +116 -49
- package/dist/legacy.d.mts +116 -49
- package/dist/legacy.d.ts +116 -49
- package/dist/legacy.mjs +2529 -2237
- package/dist/webgpu/index.cjs +3089 -3008
- package/dist/webgpu/index.d.cts +171 -99
- package/dist/webgpu/index.d.mts +171 -99
- package/dist/webgpu/index.d.ts +171 -99
- package/dist/webgpu/index.mjs +2821 -2740
- package/package.json +6 -6
- package/readme.md +1 -2
- package/react-reconciler/constants.d.ts +0 -7
- package/react-reconciler/constants.js +0 -1
- package/react-reconciler/index.d.ts +0 -1044
- package/react-reconciler/index.js +0 -208
package/dist/webgpu/index.d.mts
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 { RenderTarget, WebGPURenderer, Node, StorageTexture, Data3DTexture, CanvasTarget, ShaderNodeObject, 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, 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, Object3D, Frustum, OrthographicCamera, WebGPURendererParameters } from 'three/webgpu';
|
|
3
|
+
import { CubeRenderTarget, RenderTarget, WebGPURenderer, Node, StorageTexture, Data3DTexture, CanvasTarget, ShaderNodeObject, 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, 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, Object3D, Frustum, OrthographicCamera, 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';
|
|
@@ -11,7 +12,6 @@ import { FrameTimingState, FrameCallback as FrameCallback$1, SchedulerApi, UseFr
|
|
|
11
12
|
export { AddPhaseOptions, FrameControls, FrameNextControls, FrameTimingState, RootOptions, Scheduler, SchedulerApi, UseFrameNextOptions, UseFrameOptions, getScheduler } from '@pmndrs/scheduler';
|
|
12
13
|
import { Options } from 'react-use-measure';
|
|
13
14
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
14
|
-
import { ThreeElement as ThreeElement$1, Euler as Euler$3 } from '@react-three/fiber';
|
|
15
15
|
import { GroundedSkybox } from 'three/examples/jsm/objects/GroundedSkybox.js';
|
|
16
16
|
|
|
17
17
|
function _mergeNamespaces(n, m) {
|
|
@@ -41,6 +41,8 @@ function _mergeNamespaces(n, m) {
|
|
|
41
41
|
declare const R3F_BUILD_LEGACY = false;
|
|
42
42
|
declare const R3F_BUILD_WEBGPU = true;
|
|
43
43
|
|
|
44
|
+
/** Lazily load the three Inspector. Keeps it out of the eager module graph — see note above. */
|
|
45
|
+
declare function loadInspector(): Promise<typeof three_examples_jsm_inspector_Inspector_js.Inspector>;
|
|
44
46
|
declare const WebGLRenderer: {
|
|
45
47
|
new (): {};
|
|
46
48
|
};
|
|
@@ -49,16 +51,21 @@ type WebGLShadowMap = never;
|
|
|
49
51
|
|
|
50
52
|
declare const WebGLRenderTarget: any;
|
|
51
53
|
|
|
54
|
+
declare const WebGLCubeRenderTarget: any;
|
|
55
|
+
|
|
52
56
|
var THREE = /*#__PURE__*/_mergeNamespaces({
|
|
53
57
|
__proto__: null,
|
|
58
|
+
CubeRenderTargetCompat: CubeRenderTarget,
|
|
54
59
|
Inspector: Inspector,
|
|
55
60
|
R3F_BUILD_LEGACY: R3F_BUILD_LEGACY,
|
|
56
61
|
R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
|
|
57
62
|
RenderTargetCompat: RenderTarget,
|
|
63
|
+
WebGLCubeRenderTarget: WebGLCubeRenderTarget,
|
|
58
64
|
WebGLRenderTarget: WebGLRenderTarget,
|
|
59
65
|
WebGLRenderer: WebGLRenderer,
|
|
60
66
|
WebGLRendererParameters: WebGLRendererParameters,
|
|
61
|
-
WebGLShadowMap: WebGLShadowMap
|
|
67
|
+
WebGLShadowMap: WebGLShadowMap,
|
|
68
|
+
loadInspector: loadInspector
|
|
62
69
|
}, [three_webgpu]);
|
|
63
70
|
|
|
64
71
|
//* Utility Types ==============================
|
|
@@ -496,9 +503,21 @@ interface InternalState {
|
|
|
496
503
|
* @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
|
|
497
504
|
*/
|
|
498
505
|
canvasTarget?: CanvasTarget
|
|
506
|
+
/**
|
|
507
|
+
* Set when this root's canvas target has been resized and the backend's cached render pass
|
|
508
|
+
* descriptor (which holds a depth-stencil view built once per canvas) is therefore stale.
|
|
509
|
+
*
|
|
510
|
+
* Flushed by the canvas-target job in the `start` phase, which is the only place this root's
|
|
511
|
+
* target is guaranteed to be the renderer's active one — `backend.updateSize()` operates on
|
|
512
|
+
* whatever `getCanvasTarget()` returns, so calling it from the resize subscription would
|
|
513
|
+
* invalidate some other canvas's descriptor instead.
|
|
514
|
+
*
|
|
515
|
+
* @see https://github.com/pmndrs/react-three-fiber/issues/3847
|
|
516
|
+
*/
|
|
517
|
+
canvasTargetSizeDirty?: boolean
|
|
499
518
|
/**
|
|
500
519
|
* Whether multi-canvas rendering is active.
|
|
501
|
-
* True when any canvas uses `
|
|
520
|
+
* True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
|
|
502
521
|
* When true, setCanvasTarget is called before each render.
|
|
503
522
|
*/
|
|
504
523
|
isMultiCanvas?: boolean
|
|
@@ -596,8 +615,8 @@ interface RootState {
|
|
|
596
615
|
setSize: (width?: number, height?: number, top?: number, left?: number) => void
|
|
597
616
|
/** Shortcut to manual setting the pixel ratio */
|
|
598
617
|
setDpr: (dpr: Dpr) => void
|
|
599
|
-
/** Shortcut to setting frameloop flags */
|
|
600
|
-
setFrameloop: (frameloop
|
|
618
|
+
/** Shortcut to setting frameloop flags. No args resets to 'always'. */
|
|
619
|
+
setFrameloop: (frameloop?: Frameloop) => void
|
|
601
620
|
/** Set error state to propagate to error boundary */
|
|
602
621
|
setError: (error: Error | null) => void
|
|
603
622
|
/** Current error state (null when no error) */
|
|
@@ -615,7 +634,7 @@ interface RootState {
|
|
|
615
634
|
/** Internal: refcount per texture key, driven by mounted useTexture consumers (registry enrollment is on by default) */
|
|
616
635
|
_textureRefs: Map<string, number>
|
|
617
636
|
/** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
|
|
618
|
-
renderPipeline:
|
|
637
|
+
renderPipeline: ThreeRenderPipeline | null
|
|
619
638
|
/** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
|
|
620
639
|
passes: Record<string, any>
|
|
621
640
|
/** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
|
|
@@ -705,12 +724,19 @@ type DefaultRendererProps = {
|
|
|
705
724
|
*/
|
|
706
725
|
interface CanvasSchedulerConfig {
|
|
707
726
|
/**
|
|
708
|
-
*
|
|
709
|
-
* Pass the `id` of another canvas.
|
|
727
|
+
* Run this Canvas root before the referenced Canvas root id(s).
|
|
710
728
|
*/
|
|
711
|
-
|
|
729
|
+
before?: string | string[]
|
|
712
730
|
/**
|
|
713
|
-
*
|
|
731
|
+
* Run this Canvas root after the referenced Canvas root id(s).
|
|
732
|
+
*/
|
|
733
|
+
after?: string | string[]
|
|
734
|
+
/**
|
|
735
|
+
* Numeric root order. Lower values run first.
|
|
736
|
+
*/
|
|
737
|
+
order?: number
|
|
738
|
+
/**
|
|
739
|
+
* Limit this Canvas's default render job (frames per second).
|
|
714
740
|
*/
|
|
715
741
|
fps?: number
|
|
716
742
|
}
|
|
@@ -908,8 +934,6 @@ interface Instance<O = any> {
|
|
|
908
934
|
attach?: AttachType<O>
|
|
909
935
|
previousAttach?: any
|
|
910
936
|
isHidden: boolean
|
|
911
|
-
/** Deferred ref props to apply in commitMount */
|
|
912
|
-
deferredRefs?: Array<{ prop: string; ref: React$1.RefObject<any> }>
|
|
913
937
|
/** Set of props that have been applied via once() */
|
|
914
938
|
appliedOnce?: Set<string>
|
|
915
939
|
}
|
|
@@ -1146,10 +1170,21 @@ type RenderTargetOptions = RenderTargetOptions$1
|
|
|
1146
1170
|
//* Global Types ==============================
|
|
1147
1171
|
|
|
1148
1172
|
declare global {
|
|
1149
|
-
/**
|
|
1150
|
-
|
|
1151
|
-
|
|
1152
|
-
|
|
1173
|
+
/**
|
|
1174
|
+
* Uniform node type.
|
|
1175
|
+
*
|
|
1176
|
+
* This is three's own `UniformNode`, not a re-declaration of it. It previously was a
|
|
1177
|
+
* hand-rolled `interface UniformNode<T> extends Node { value: T }`, which shadowed the real
|
|
1178
|
+
* exported type globally — so R3F's ~58 references resolved to an approximation that was
|
|
1179
|
+
* missing members three actually ships (`setName` among them) and had drifted to the wrong
|
|
1180
|
+
* arity when three made `UniformNode` two-parameter.
|
|
1181
|
+
*
|
|
1182
|
+
* three's signature is `UniformNode<TNodeType, TValue>`. R3F only ever varies the value type,
|
|
1183
|
+
* so the node type is fixed to `unknown` and the single parameter is kept for call-site
|
|
1184
|
+
* ergonomics. The result is three's structural type, so members stay in sync with the
|
|
1185
|
+
* installed three instead of needing to be mirrored by hand.
|
|
1186
|
+
*/
|
|
1187
|
+
type UniformNode<T = unknown> = three_webgpu.UniformNode<unknown, T>
|
|
1153
1188
|
|
|
1154
1189
|
/**
|
|
1155
1190
|
* ShaderCallable - the return type of Fn()
|
|
@@ -1294,28 +1329,34 @@ declare module 'three/tsl' {
|
|
|
1294
1329
|
): ShaderCallable<R>
|
|
1295
1330
|
}
|
|
1296
1331
|
|
|
1297
|
-
/**
|
|
1298
|
-
* RenderPipeline Types for useRenderPipeline hook (WebGPU only)
|
|
1299
|
-
*/
|
|
1300
|
-
|
|
1301
|
-
|
|
1302
|
-
|
|
1303
1332
|
declare global {
|
|
1333
|
+
/**
|
|
1334
|
+
* three's own render pipeline type. Named here so the rest of R3F refers to three's shape
|
|
1335
|
+
* rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
|
|
1336
|
+
* is r185, so the new name is the only one.
|
|
1337
|
+
*/
|
|
1338
|
+
type ThreeRenderPipeline = three_webgpu.RenderPipeline
|
|
1339
|
+
|
|
1304
1340
|
/** Pass record - stores TSL pass nodes for render pipeline */
|
|
1305
1341
|
type PassRecord = Record<string, any>
|
|
1306
1342
|
|
|
1343
|
+
/** State passed to pipeline callbacks after the active pipeline has been created */
|
|
1344
|
+
type RenderPipelineCallbackState = RootState & {
|
|
1345
|
+
renderPipeline: ThreeRenderPipeline
|
|
1346
|
+
}
|
|
1347
|
+
|
|
1307
1348
|
/** Setup callback - runs first to configure MRT, create additional passes */
|
|
1308
|
-
type RenderPipelineSetupCallback = (state:
|
|
1349
|
+
type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => PassRecord | void
|
|
1309
1350
|
|
|
1310
1351
|
/** Main callback - runs second to configure outputNode, create effect passes */
|
|
1311
|
-
type RenderPipelineMainCallback = (state:
|
|
1352
|
+
type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => PassRecord | void
|
|
1312
1353
|
|
|
1313
1354
|
/** Return type for useRenderPipeline hook */
|
|
1314
1355
|
interface UseRenderPipelineReturn {
|
|
1315
1356
|
/** Current passes from state */
|
|
1316
1357
|
passes: PassRecord
|
|
1317
1358
|
/** RenderPipeline instance (null if not initialized) */
|
|
1318
|
-
renderPipeline:
|
|
1359
|
+
renderPipeline: ThreeRenderPipeline | null
|
|
1319
1360
|
/** Clear all passes from state */
|
|
1320
1361
|
clearPasses: () => void
|
|
1321
1362
|
/** Reset RenderPipeline entirely (clears PP + passes) */
|
|
@@ -1496,7 +1537,7 @@ declare namespace three_d {
|
|
|
1496
1537
|
* a single WebGPURenderer using Three.js CanvasTarget API.
|
|
1497
1538
|
*
|
|
1498
1539
|
* Primary canvas: Has `id` prop, creates its own renderer, registers here
|
|
1499
|
-
* Secondary canvas: Has `
|
|
1540
|
+
* Secondary canvas: Has `renderer={{ primaryCanvas: 'id' }}`, shares primary's renderer via CanvasTarget
|
|
1500
1541
|
*/
|
|
1501
1542
|
|
|
1502
1543
|
interface PrimaryCanvasEntry {
|
|
@@ -1564,12 +1605,23 @@ type EnvironmentLoaderProps = {
|
|
|
1564
1605
|
* const texture = useEnvironment({ preset: 'sunset' })
|
|
1565
1606
|
* ```
|
|
1566
1607
|
*/
|
|
1567
|
-
declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown> | CubeTexture
|
|
1608
|
+
declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown, THREE$1.TextureEventMap> | CubeTexture<unknown>;
|
|
1568
1609
|
declare namespace useEnvironment {
|
|
1569
1610
|
var preload: (preloadOptions?: EnvironmentLoaderPreloadOptions) => void;
|
|
1570
1611
|
var clear: (clearOptions?: EnvironmentLoaderClearOptions) => void;
|
|
1571
1612
|
}
|
|
1572
|
-
|
|
1613
|
+
/**
|
|
1614
|
+
* Options accepted by `useEnvironment.preload`.
|
|
1615
|
+
*
|
|
1616
|
+
* `colorSpace` is deliberately omitted: preload only warms the loader cache, and colorSpace is
|
|
1617
|
+
* applied to the texture by `useEnvironment()` at use time, per consumer. Accepting it here would
|
|
1618
|
+
* advertise an option this function silently ignores.
|
|
1619
|
+
*
|
|
1620
|
+
* This previously read `Omit<…, 'encoding'>` — omitting a key that does not exist on
|
|
1621
|
+
* `EnvironmentLoaderProps`, a leftover from three's pre-`colorSpace` `encoding` API. That made the
|
|
1622
|
+
* type equivalent to the full props, so `colorSpace` was accepted and then dropped on the floor.
|
|
1623
|
+
*/
|
|
1624
|
+
type EnvironmentLoaderPreloadOptions = Omit<EnvironmentLoaderProps, 'colorSpace'>;
|
|
1573
1625
|
type EnvironmentLoaderClearOptions = Pick<EnvironmentLoaderProps, 'files' | 'preset'>;
|
|
1574
1626
|
|
|
1575
1627
|
/**
|
|
@@ -1613,9 +1665,9 @@ type EnvironmentProps = {
|
|
|
1613
1665
|
blur?: number;
|
|
1614
1666
|
backgroundBlurriness?: number;
|
|
1615
1667
|
backgroundIntensity?: number;
|
|
1616
|
-
backgroundRotation?: Euler
|
|
1668
|
+
backgroundRotation?: Euler;
|
|
1617
1669
|
environmentIntensity?: number;
|
|
1618
|
-
environmentRotation?: Euler
|
|
1670
|
+
environmentRotation?: Euler;
|
|
1619
1671
|
map?: Texture$1;
|
|
1620
1672
|
preset?: PresetsType;
|
|
1621
1673
|
scene?: Scene | React$1.RefObject<Scene>;
|
|
@@ -1699,7 +1751,7 @@ declare function EnvironmentCube({ background, scene, blur, backgroundBlurriness
|
|
|
1699
1751
|
declare function EnvironmentPortal({ children, near, far, resolution, frames, map, background, blur, backgroundBlurriness, backgroundIntensity, backgroundRotation, environmentIntensity, environmentRotation, scene, files, path, preset, extensions, }: EnvironmentProps): react_jsx_runtime.JSX.Element;
|
|
1700
1752
|
declare module '@react-three/fiber' {
|
|
1701
1753
|
interface ThreeElements {
|
|
1702
|
-
groundProjectedEnvImpl: ThreeElement
|
|
1754
|
+
groundProjectedEnvImpl: ThreeElement<typeof GroundedSkybox>;
|
|
1703
1755
|
}
|
|
1704
1756
|
}
|
|
1705
1757
|
/**
|
|
@@ -1799,6 +1851,24 @@ declare module '@react-three/fiber' {
|
|
|
1799
1851
|
*/
|
|
1800
1852
|
declare function Environment(props: EnvironmentProps): react_jsx_runtime.JSX.Element;
|
|
1801
1853
|
|
|
1854
|
+
/**
|
|
1855
|
+
* Moves every trace of interactivity from one object to its replacement, for reconstruction.
|
|
1856
|
+
*
|
|
1857
|
+
* When `args` or a `primitive`'s `object` changes, R3F builds a new three object and keeps the same
|
|
1858
|
+
* instance. Removing the old object from the interaction state and registering the new one from
|
|
1859
|
+
* scratch makes events *work* again (#3778), but it forgets what was in flight: a pointer resting on
|
|
1860
|
+
* the object fires a second `onPointerEnter` without ever having left, and an active pointer capture
|
|
1861
|
+
* is dropped mid-drag. Rewriting the references instead keeps the interaction continuous across a
|
|
1862
|
+
* swap the user never asked to see (#3744).
|
|
1863
|
+
*
|
|
1864
|
+
* Captures are re-keyed rather than released, so the DOM-level capture on `captureData.target` is
|
|
1865
|
+
* left alone — releasing and re-acquiring it is precisely the glitch being avoided.
|
|
1866
|
+
*
|
|
1867
|
+
* Visibility handlers are deliberately not transferred: that registry is keyed by `object.uuid`, so
|
|
1868
|
+
* the replacement re-registers itself through `applyProps`. The old entry is dropped here so it
|
|
1869
|
+
* cannot outlive the object it described.
|
|
1870
|
+
*/
|
|
1871
|
+
declare function swapInteractivity(store: RootStore, object: Object3D, newObject: Object3D): void;
|
|
1802
1872
|
declare function removeInteractivity(store: RootStore, object: Object3D): void;
|
|
1803
1873
|
declare function createEvents(store: RootStore): {
|
|
1804
1874
|
handlePointer: (name: string) => (event: DomEvent) => void;
|
|
@@ -1819,57 +1889,13 @@ declare function getLoader<L extends LoaderLike | ConstructorRepresentation<Load
|
|
|
1819
1889
|
* Note: this hook's caller must be wrapped with `React.Suspense`
|
|
1820
1890
|
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useloader
|
|
1821
1891
|
*/
|
|
1822
|
-
declare function useLoader<I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void): I extends any[] ? LoaderResult<L>[] : LoaderResult<L>;
|
|
1892
|
+
declare function useLoader<I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void, cacheKey?: InputLike): I extends any[] ? LoaderResult<L>[] : LoaderResult<L>;
|
|
1823
1893
|
declare namespace useLoader {
|
|
1824
|
-
var preload: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void) => void;
|
|
1825
|
-
var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I) => void;
|
|
1894
|
+
var preload: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void, cacheKey?: InputLike) => void;
|
|
1895
|
+
var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, cacheKey?: InputLike) => void;
|
|
1826
1896
|
var loader: typeof getLoader;
|
|
1827
1897
|
}
|
|
1828
1898
|
|
|
1829
|
-
/**
|
|
1830
|
-
* Frame hook with phase-based ordering, priority, and FPS throttling.
|
|
1831
|
-
*
|
|
1832
|
-
* Always delivers full RootState — works both inside and outside Canvas context:
|
|
1833
|
-
* - Inside Canvas: Full RootState (renderer, scene, camera, etc.)
|
|
1834
|
-
* - Outside Canvas: The job registers immediately but the callback is held until a
|
|
1835
|
-
* Canvas adopts it, then runs with full RootState. For hostless / standalone
|
|
1836
|
-
* frame loops with no Canvas, use `@pmndrs/scheduler` directly.
|
|
1837
|
-
*
|
|
1838
|
-
* Returns a controls object for manual stepping, pausing, and resuming.
|
|
1839
|
-
*
|
|
1840
|
-
* @param callback - Function called each frame with (state, delta). Optional if you only need scheduler access.
|
|
1841
|
-
* @param priorityOrOptions - Either a priority number (backwards compat) or options object
|
|
1842
|
-
* @returns Controls object with step(), stepAll(), pause(), resume(), isPaused, id, scheduler
|
|
1843
|
-
*
|
|
1844
|
-
* @example
|
|
1845
|
-
* // Simple priority (backwards compat)
|
|
1846
|
-
* useFrame((state, delta) => { ... }, 5)
|
|
1847
|
-
*
|
|
1848
|
-
* @example
|
|
1849
|
-
* // With phase-based ordering
|
|
1850
|
-
* useFrame((state, delta) => { ... }, { phase: 'physics' })
|
|
1851
|
-
*
|
|
1852
|
-
* @example
|
|
1853
|
-
* // Outside Canvas - callback waits for a Canvas, then always has full state
|
|
1854
|
-
* function UI() {
|
|
1855
|
-
* useFrame((state, delta) => { syncUI(state.camera) });
|
|
1856
|
-
* return <button>...</button>;
|
|
1857
|
-
* }
|
|
1858
|
-
*
|
|
1859
|
-
* @example
|
|
1860
|
-
* // Hostless / standalone loop (no Canvas) - use @pmndrs/scheduler directly
|
|
1861
|
-
* import { getScheduler } from '@pmndrs/scheduler'
|
|
1862
|
-
* getScheduler().register((state, delta) => { updateGame(delta) })
|
|
1863
|
-
*
|
|
1864
|
-
* @example
|
|
1865
|
-
* // Scheduler-only access (no callback)
|
|
1866
|
-
* const { scheduler } = useFrame()
|
|
1867
|
-
* scheduler.pauseJob('some-job-id')
|
|
1868
|
-
*
|
|
1869
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useframe
|
|
1870
|
-
*/
|
|
1871
|
-
declare function useFrame(callback?: FrameNextCallback, priorityOrOptions?: number | UseFrameNextOptions): FrameNextControls;
|
|
1872
|
-
|
|
1873
1899
|
declare const IsObject: (url: unknown) => url is Record<string, string>;
|
|
1874
1900
|
type TextureArray<T> = T extends string[] ? Texture$1[] : never;
|
|
1875
1901
|
type TextureRecord<T> = T extends Record<string, string> ? {
|
|
@@ -2055,11 +2081,6 @@ declare function useRenderTarget(width: number, height: number, options?: Render
|
|
|
2055
2081
|
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
|
|
2056
2082
|
*/
|
|
2057
2083
|
declare function useStore(): RootStore;
|
|
2058
|
-
/**
|
|
2059
|
-
* Accesses R3F's internal state, containing renderer, canvas, scene, etc.
|
|
2060
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usethree
|
|
2061
|
-
*/
|
|
2062
|
-
declare function useThree<T = RootState>(selector?: (state: RootState) => T, equalityFn?: <T>(state: T, newState: T) => boolean): T;
|
|
2063
2084
|
/**
|
|
2064
2085
|
* Exposes an object's {@link Instance}.
|
|
2065
2086
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#useInstanceHandle
|
|
@@ -2135,7 +2156,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
|
|
|
2135
2156
|
* Invalidates the view, requesting a frame to be rendered.
|
|
2136
2157
|
* In demand mode, this triggers the scheduler to run frames.
|
|
2137
2158
|
*
|
|
2138
|
-
*
|
|
2159
|
+
* With a state argument, only that root's jobs run on the requested frames; other
|
|
2160
|
+
* roots on 'demand' stay idle. Without one, every registered root is invalidated.
|
|
2161
|
+
*
|
|
2162
|
+
* @param state - Optional root state; targets the invalidation at that root
|
|
2139
2163
|
* @param frames - Number of frames to request (default: 1)
|
|
2140
2164
|
* @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
|
|
2141
2165
|
*
|
|
@@ -2146,14 +2170,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
|
|
|
2146
2170
|
* Advances the frameloop and runs render effects.
|
|
2147
2171
|
* Useful for when manually rendering via `frameloop="never"`.
|
|
2148
2172
|
*
|
|
2173
|
+
* With a state argument, only that root is stepped. Without one, every
|
|
2174
|
+
* registered root is stepped for backwards compatibility.
|
|
2175
|
+
*
|
|
2149
2176
|
* @param timestamp - The timestamp to use for this frame
|
|
2150
2177
|
* @param runGlobalEffects - Ignored (kept for backwards compat, global effects always run)
|
|
2151
|
-
* @param state -
|
|
2152
|
-
* @param frame - Ignored (kept for backwards compat)
|
|
2178
|
+
* @param state - Optional root state; targets the manual step at that root
|
|
2153
2179
|
*
|
|
2154
2180
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
|
|
2155
2181
|
*/
|
|
2156
|
-
declare function advance(timestamp: number): void;
|
|
2182
|
+
declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
|
|
2157
2183
|
|
|
2158
2184
|
/* eslint-disable @definitelytyped/no-unnecessary-generics */
|
|
2159
2185
|
declare function ReactReconciler<
|
|
@@ -3224,11 +3250,6 @@ declare function flushSync<R>(fn: () => R): R;
|
|
|
3224
3250
|
declare const context: React$1.Context<RootStore>;
|
|
3225
3251
|
declare const createStore: (invalidate: (state?: RootState, frames?: number, stackFrames?: boolean) => void, advance: (timestamp: number, runGlobalEffects?: boolean, state?: RootState, frame?: XRFrame) => void) => RootStore;
|
|
3226
3252
|
|
|
3227
|
-
/**
|
|
3228
|
-
* Safely flush async effects when testing, simulating a legacy root.
|
|
3229
|
-
* @deprecated Import from React instead. import { act } from 'react'
|
|
3230
|
-
*/
|
|
3231
|
-
declare const act: typeof React$1.act;
|
|
3232
3253
|
/**
|
|
3233
3254
|
* An SSR-friendly useLayoutEffect.
|
|
3234
3255
|
*
|
|
@@ -3796,9 +3817,12 @@ declare function useUniforms<T extends UniformInputRecord>(uniforms: T): Uniform
|
|
|
3796
3817
|
declare function useUniforms<T extends UniformInputRecord>(uniforms: T, scope: string): UniformsWithUtils<UniformRecord<UniformNode>>;
|
|
3797
3818
|
/**
|
|
3798
3819
|
* Global rebuildUniforms function for HMR integration.
|
|
3799
|
-
*
|
|
3820
|
+
* Invalidates cached uniforms and increments _hmrVersion to trigger re-creation.
|
|
3800
3821
|
* Call this when HMR is detected to refresh all uniform creators.
|
|
3801
3822
|
*
|
|
3823
|
+
* Resolves to the primary store so shared TSL resources rebuild on the
|
|
3824
|
+
* authoritative store.
|
|
3825
|
+
*
|
|
3802
3826
|
* @param store - The R3F store (from useStore or context)
|
|
3803
3827
|
* @param scope - Optional scope to rebuild ('root' for root only, string for specific scope, undefined for all)
|
|
3804
3828
|
*/
|
|
@@ -3882,9 +3906,12 @@ declare function useNodes<T extends Record<string, TSLNodeLike>>(creator: NodeCr
|
|
|
3882
3906
|
declare function useNodes<T extends Record<string, TSLNodeLike>>(creator: NodeCreator<T>, scope: string): NodesWithUtils<T>;
|
|
3883
3907
|
/**
|
|
3884
3908
|
* Global rebuildNodes function for HMR integration.
|
|
3885
|
-
*
|
|
3909
|
+
* Invalidates cached nodes and increments _hmrVersion to trigger re-creation.
|
|
3886
3910
|
* Call this when HMR is detected to refresh all node creators.
|
|
3887
3911
|
*
|
|
3912
|
+
* Resolves to the primary store so shared TSL resources rebuild on the
|
|
3913
|
+
* authoritative store.
|
|
3914
|
+
*
|
|
3888
3915
|
* @param store - The R3F store (from useStore or context)
|
|
3889
3916
|
* @param scope - Optional scope to rebuild ('root' for root only, string for specific scope, undefined for all)
|
|
3890
3917
|
*/
|
|
@@ -3961,9 +3988,12 @@ declare function useBuffers<T extends Record<string, BufferLike>>(creator: Buffe
|
|
|
3961
3988
|
declare function useBuffers<T extends Record<string, BufferLike>>(creator: BufferCreator<T>, scope: string): BuffersWithUtils<T>;
|
|
3962
3989
|
/**
|
|
3963
3990
|
* Global rebuildBuffers function for HMR integration.
|
|
3964
|
-
*
|
|
3991
|
+
* Invalidates cached buffers and increments _hmrVersion to trigger re-creation.
|
|
3965
3992
|
* Call this when HMR is detected to refresh all buffer creators.
|
|
3966
3993
|
*
|
|
3994
|
+
* Resolves to the primary store so shared TSL resources rebuild on the
|
|
3995
|
+
* authoritative store.
|
|
3996
|
+
*
|
|
3967
3997
|
* @param store - The R3F store (from useStore or context)
|
|
3968
3998
|
* @param scope - Optional scope to rebuild ('root' for root only, string for specific scope, undefined for all)
|
|
3969
3999
|
*/
|
|
@@ -3995,14 +4025,34 @@ declare function useGPUStorage<T extends Record<string, StorageLike>>(creator: S
|
|
|
3995
4025
|
declare function useGPUStorage<T extends Record<string, StorageLike>>(creator: StorageCreator<T>, scope: string): StorageWithUtils<T>;
|
|
3996
4026
|
/**
|
|
3997
4027
|
* Global rebuildStorage function for HMR integration.
|
|
3998
|
-
*
|
|
4028
|
+
* Invalidates cached storage and increments _hmrVersion to trigger re-creation.
|
|
3999
4029
|
* Call this when HMR is detected to refresh all storage creators.
|
|
4000
4030
|
*
|
|
4031
|
+
* Resolves to the primary store so shared TSL resources rebuild on the
|
|
4032
|
+
* authoritative store.
|
|
4033
|
+
*
|
|
4001
4034
|
* @param store - The R3F store (from useStore or context)
|
|
4002
4035
|
* @param scope - Optional scope to rebuild ('root' for root only, string for specific scope, undefined for all)
|
|
4003
4036
|
*/
|
|
4004
4037
|
declare function rebuildAllStorage(store: ReturnType<typeof useStore>, scope?: string): void;
|
|
4005
4038
|
|
|
4039
|
+
/**
|
|
4040
|
+
* Re-export from core - useTextures is now a core R3F hook (a reactive Texture registry).
|
|
4041
|
+
*
|
|
4042
|
+
* This file maintains backwards compatibility for existing webgpu imports.
|
|
4043
|
+
*/
|
|
4044
|
+
|
|
4045
|
+
/**
|
|
4046
|
+
* @deprecated The registry now stores plain `Texture` objects, not TSL nodes. Use `Texture` directly.
|
|
4047
|
+
* Kept as an alias for backwards compatibility.
|
|
4048
|
+
*/
|
|
4049
|
+
type TextureEntry = Texture$1;
|
|
4050
|
+
/**
|
|
4051
|
+
* @deprecated The registry now stores plain `Texture` objects, not TSL nodes. Use `Texture` directly.
|
|
4052
|
+
* Kept as an alias for backwards compatibility.
|
|
4053
|
+
*/
|
|
4054
|
+
type TextureNode = Texture$1;
|
|
4055
|
+
|
|
4006
4056
|
interface TextureOperations {
|
|
4007
4057
|
add: (key: string, value: any) => void;
|
|
4008
4058
|
addMultiple: (items: Map<string, any> | Record<string, any>) => void;
|
|
@@ -4020,6 +4070,10 @@ declare function createTextureOperations(set: StoreApi<RootState>['setState']):
|
|
|
4020
4070
|
* - Callbacks receive full RootState for flexibility
|
|
4021
4071
|
* - No auto-cleanup on unmount - use reset() for explicit cleanup
|
|
4022
4072
|
* - Scene/camera changes trigger scenePass recreation
|
|
4073
|
+
* - A replaced scenePass is disposed once the new graph is installed, so rebuild() does not
|
|
4074
|
+
* strand its render target (and MRT attachments) on the GPU
|
|
4075
|
+
* - Any run that changes the output node sets RenderPipeline.needsUpdate, so rebuild() actually
|
|
4076
|
+
* recompiles instead of silently keeping the first compiled graph
|
|
4023
4077
|
*
|
|
4024
4078
|
* @param mainCB - Main callback to configure outputNode and create effect passes
|
|
4025
4079
|
* @param setupCB - Optional setup callback to configure MRT on scenePass
|
|
@@ -4097,5 +4151,23 @@ interface WebGPURootState extends Omit<RootState, 'renderer' | 'gl' | 'internal'
|
|
|
4097
4151
|
internal: WebGPUInternalState
|
|
4098
4152
|
}
|
|
4099
4153
|
|
|
4100
|
-
|
|
4101
|
-
|
|
4154
|
+
/**
|
|
4155
|
+
* @fileoverview WebGPU entry point - WebGPU only, no legacy WebGL
|
|
4156
|
+
*
|
|
4157
|
+
* This entry point is for apps that want to use ONLY WebGPURenderer.
|
|
4158
|
+
* Includes WebGPU-specific hooks (useUniforms, useNodes, useTextures).
|
|
4159
|
+
* Auto-extends THREE with WebGPU node materials (MeshBasicNodeMaterial, etc.)
|
|
4160
|
+
*
|
|
4161
|
+
* Usage:
|
|
4162
|
+
* import { Canvas, useFrame, useUniforms } from '@react-three/fiber/webgpu'
|
|
4163
|
+
*/
|
|
4164
|
+
|
|
4165
|
+
/** `useThree` narrowed to WebGPU state — `state.renderer` is a `WebGPURenderer`. */
|
|
4166
|
+
type UseThreeWebGPU = <T = WebGPURootState>(selector?: (state: WebGPURootState) => T, equalityFn?: <U>(state: U, newState: U) => boolean) => T;
|
|
4167
|
+
/** `useFrame` narrowed to WebGPU state — the callback's `state.renderer` is a `WebGPURenderer`. */
|
|
4168
|
+
type UseFrameWebGPU = (callback?: FrameCallback$1<WebGPURootState>, priorityOrOptions?: number | UseFrameNextOptions) => FrameNextControls;
|
|
4169
|
+
declare const useThree: UseThreeWebGPU;
|
|
4170
|
+
declare const useFrame: UseFrameWebGPU;
|
|
4171
|
+
|
|
4172
|
+
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 };
|
|
4173
|
+
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, UseFrameWebGPU, UseTextureOptions, UseTexturesReturn, UseThreeWebGPU, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, WebGPUDefaultProps, WebGPUProps, WebGPUShadowConfig, XRManager, XRPointerConfig };
|