@react-three/fiber 10.0.0-canary.164c7be → 10.0.0-canary.1be335a
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 +344 -145
- package/dist/index.d.cts +49 -25
- package/dist/index.d.mts +49 -25
- package/dist/index.d.ts +49 -25
- package/dist/index.mjs +347 -148
- package/dist/legacy.cjs +299 -100
- package/dist/legacy.d.cts +49 -24
- package/dist/legacy.d.mts +49 -24
- package/dist/legacy.d.ts +49 -24
- package/dist/legacy.mjs +301 -102
- package/dist/webgpu/index.cjs +631 -673
- package/dist/webgpu/index.d.cts +83 -29
- package/dist/webgpu/index.d.mts +83 -29
- package/dist/webgpu/index.d.ts +83 -29
- package/dist/webgpu/index.mjs +634 -676
- package/package.json +3 -3
- package/readme.md +2 -3
package/dist/legacy.d.cts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as THREE$1 from 'three';
|
|
2
|
-
import { WebGLRenderTarget, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Node as Node$1, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Object3D, Frustum, OrthographicCamera } from 'three';
|
|
2
|
+
import { WebGLCubeRenderTarget, WebGLRenderTarget, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Node as Node$1, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Object3D, Frustum, OrthographicCamera } from 'three';
|
|
3
3
|
import * as React$1 from 'react';
|
|
4
4
|
import { ReactNode, Component, RefObject, JSX } from 'react';
|
|
5
5
|
import * as three_webgpu from 'three/webgpu';
|
|
@@ -48,8 +48,12 @@ declare const WebGPURenderer: {
|
|
|
48
48
|
|
|
49
49
|
declare const RenderTarget: any;
|
|
50
50
|
|
|
51
|
+
declare const CubeRenderTarget: any;
|
|
52
|
+
|
|
51
53
|
var THREE = /*#__PURE__*/_mergeNamespaces({
|
|
52
54
|
__proto__: null,
|
|
55
|
+
CubeRenderTarget: CubeRenderTarget,
|
|
56
|
+
CubeRenderTargetCompat: WebGLCubeRenderTarget,
|
|
53
57
|
Inspector: Inspector,
|
|
54
58
|
R3F_BUILD_LEGACY: R3F_BUILD_LEGACY,
|
|
55
59
|
R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
|
|
@@ -495,7 +499,7 @@ interface InternalState {
|
|
|
495
499
|
canvasTarget?: CanvasTarget
|
|
496
500
|
/**
|
|
497
501
|
* Whether multi-canvas rendering is active.
|
|
498
|
-
* True when any canvas uses `
|
|
502
|
+
* True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
|
|
499
503
|
* When true, setCanvasTarget is called before each render.
|
|
500
504
|
*/
|
|
501
505
|
isMultiCanvas?: boolean
|
|
@@ -593,8 +597,8 @@ interface RootState {
|
|
|
593
597
|
setSize: (width?: number, height?: number, top?: number, left?: number) => void
|
|
594
598
|
/** Shortcut to manual setting the pixel ratio */
|
|
595
599
|
setDpr: (dpr: Dpr) => void
|
|
596
|
-
/** Shortcut to setting frameloop flags */
|
|
597
|
-
setFrameloop: (frameloop
|
|
600
|
+
/** Shortcut to setting frameloop flags. No args resets to 'always'. */
|
|
601
|
+
setFrameloop: (frameloop?: Frameloop) => void
|
|
598
602
|
/** Set error state to propagate to error boundary */
|
|
599
603
|
setError: (error: Error | null) => void
|
|
600
604
|
/** Current error state (null when no error) */
|
|
@@ -612,7 +616,7 @@ interface RootState {
|
|
|
612
616
|
/** Internal: refcount per texture key, driven by mounted useTexture consumers (registry enrollment is on by default) */
|
|
613
617
|
_textureRefs: Map<string, number>
|
|
614
618
|
/** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
|
|
615
|
-
renderPipeline:
|
|
619
|
+
renderPipeline: ThreeRenderPipeline | null
|
|
616
620
|
/** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
|
|
617
621
|
passes: Record<string, any>
|
|
618
622
|
/** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
|
|
@@ -905,8 +909,6 @@ interface Instance<O = any> {
|
|
|
905
909
|
attach?: AttachType<O>
|
|
906
910
|
previousAttach?: any
|
|
907
911
|
isHidden: boolean
|
|
908
|
-
/** Deferred ref props to apply in commitMount */
|
|
909
|
-
deferredRefs?: Array<{ prop: string; ref: React$1.RefObject<any> }>
|
|
910
912
|
/** Set of props that have been applied via once() */
|
|
911
913
|
appliedOnce?: Set<string>
|
|
912
914
|
}
|
|
@@ -1143,10 +1145,21 @@ type RenderTargetOptions = RenderTargetOptions$1
|
|
|
1143
1145
|
//* Global Types ==============================
|
|
1144
1146
|
|
|
1145
1147
|
declare global {
|
|
1146
|
-
/**
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
|
|
1148
|
+
/**
|
|
1149
|
+
* Uniform node type.
|
|
1150
|
+
*
|
|
1151
|
+
* This is three's own `UniformNode`, not a re-declaration of it. It previously was a
|
|
1152
|
+
* hand-rolled `interface UniformNode<T> extends Node { value: T }`, which shadowed the real
|
|
1153
|
+
* exported type globally — so R3F's ~58 references resolved to an approximation that was
|
|
1154
|
+
* missing members three actually ships (`setName` among them) and had drifted to the wrong
|
|
1155
|
+
* arity when three made `UniformNode` two-parameter.
|
|
1156
|
+
*
|
|
1157
|
+
* three's signature is `UniformNode<TNodeType, TValue>`. R3F only ever varies the value type,
|
|
1158
|
+
* so the node type is fixed to `unknown` and the single parameter is kept for call-site
|
|
1159
|
+
* ergonomics. The result is three's structural type, so members stay in sync with the
|
|
1160
|
+
* installed three instead of needing to be mirrored by hand.
|
|
1161
|
+
*/
|
|
1162
|
+
type UniformNode<T = unknown> = three_webgpu.UniformNode<unknown, T>
|
|
1150
1163
|
|
|
1151
1164
|
/**
|
|
1152
1165
|
* ShaderCallable - the return type of Fn()
|
|
@@ -1291,13 +1304,14 @@ declare module 'three/tsl' {
|
|
|
1291
1304
|
): ShaderCallable<R>
|
|
1292
1305
|
}
|
|
1293
1306
|
|
|
1294
|
-
/**
|
|
1295
|
-
* RenderPipeline Types for useRenderPipeline hook (WebGPU only)
|
|
1296
|
-
*/
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
1307
|
declare global {
|
|
1308
|
+
/**
|
|
1309
|
+
* three's own render pipeline type. Named here so the rest of R3F refers to three's shape
|
|
1310
|
+
* rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
|
|
1311
|
+
* is r185, so the new name is the only one.
|
|
1312
|
+
*/
|
|
1313
|
+
type ThreeRenderPipeline = three_webgpu.RenderPipeline
|
|
1314
|
+
|
|
1301
1315
|
/** Pass record - stores TSL pass nodes for render pipeline */
|
|
1302
1316
|
type PassRecord = Record<string, any>
|
|
1303
1317
|
|
|
@@ -1312,7 +1326,7 @@ declare global {
|
|
|
1312
1326
|
/** Current passes from state */
|
|
1313
1327
|
passes: PassRecord
|
|
1314
1328
|
/** RenderPipeline instance (null if not initialized) */
|
|
1315
|
-
renderPipeline:
|
|
1329
|
+
renderPipeline: ThreeRenderPipeline | null
|
|
1316
1330
|
/** Clear all passes from state */
|
|
1317
1331
|
clearPasses: () => void
|
|
1318
1332
|
/** Reset RenderPipeline entirely (clears PP + passes) */
|
|
@@ -1493,7 +1507,7 @@ declare namespace three_d {
|
|
|
1493
1507
|
* a single WebGPURenderer using Three.js CanvasTarget API.
|
|
1494
1508
|
*
|
|
1495
1509
|
* Primary canvas: Has `id` prop, creates its own renderer, registers here
|
|
1496
|
-
* Secondary canvas: Has `
|
|
1510
|
+
* Secondary canvas: Has `renderer={{ primaryCanvas: 'id' }}`, shares primary's renderer via CanvasTarget
|
|
1497
1511
|
*/
|
|
1498
1512
|
|
|
1499
1513
|
interface PrimaryCanvasEntry {
|
|
@@ -1561,12 +1575,23 @@ type EnvironmentLoaderProps = {
|
|
|
1561
1575
|
* const texture = useEnvironment({ preset: 'sunset' })
|
|
1562
1576
|
* ```
|
|
1563
1577
|
*/
|
|
1564
|
-
declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown> | CubeTexture
|
|
1578
|
+
declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown, THREE$1.TextureEventMap> | CubeTexture<unknown>;
|
|
1565
1579
|
declare namespace useEnvironment {
|
|
1566
1580
|
var preload: (preloadOptions?: EnvironmentLoaderPreloadOptions) => void;
|
|
1567
1581
|
var clear: (clearOptions?: EnvironmentLoaderClearOptions) => void;
|
|
1568
1582
|
}
|
|
1569
|
-
|
|
1583
|
+
/**
|
|
1584
|
+
* Options accepted by `useEnvironment.preload`.
|
|
1585
|
+
*
|
|
1586
|
+
* `colorSpace` is deliberately omitted: preload only warms the loader cache, and colorSpace is
|
|
1587
|
+
* applied to the texture by `useEnvironment()` at use time, per consumer. Accepting it here would
|
|
1588
|
+
* advertise an option this function silently ignores.
|
|
1589
|
+
*
|
|
1590
|
+
* This previously read `Omit<…, 'encoding'>` — omitting a key that does not exist on
|
|
1591
|
+
* `EnvironmentLoaderProps`, a leftover from three's pre-`colorSpace` `encoding` API. That made the
|
|
1592
|
+
* type equivalent to the full props, so `colorSpace` was accepted and then dropped on the floor.
|
|
1593
|
+
*/
|
|
1594
|
+
type EnvironmentLoaderPreloadOptions = Omit<EnvironmentLoaderProps, 'colorSpace'>;
|
|
1570
1595
|
type EnvironmentLoaderClearOptions = Pick<EnvironmentLoaderProps, 'files' | 'preset'>;
|
|
1571
1596
|
|
|
1572
1597
|
/**
|
|
@@ -1816,10 +1841,10 @@ declare function getLoader<L extends LoaderLike | ConstructorRepresentation<Load
|
|
|
1816
1841
|
* Note: this hook's caller must be wrapped with `React.Suspense`
|
|
1817
1842
|
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useloader
|
|
1818
1843
|
*/
|
|
1819
|
-
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>;
|
|
1844
|
+
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>;
|
|
1820
1845
|
declare namespace useLoader {
|
|
1821
|
-
var preload: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void) => void;
|
|
1822
|
-
var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I) => void;
|
|
1846
|
+
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;
|
|
1847
|
+
var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, cacheKey?: InputLike) => void;
|
|
1823
1848
|
var loader: typeof getLoader;
|
|
1824
1849
|
}
|
|
1825
1850
|
|
package/dist/legacy.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as THREE$1 from 'three';
|
|
2
|
-
import { WebGLRenderTarget, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Node as Node$1, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Object3D, Frustum, OrthographicCamera } from 'three';
|
|
2
|
+
import { WebGLCubeRenderTarget, WebGLRenderTarget, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Node as Node$1, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Object3D, Frustum, OrthographicCamera } from 'three';
|
|
3
3
|
import * as React$1 from 'react';
|
|
4
4
|
import { ReactNode, Component, RefObject, JSX } from 'react';
|
|
5
5
|
import * as three_webgpu from 'three/webgpu';
|
|
@@ -48,8 +48,12 @@ declare const WebGPURenderer: {
|
|
|
48
48
|
|
|
49
49
|
declare const RenderTarget: any;
|
|
50
50
|
|
|
51
|
+
declare const CubeRenderTarget: any;
|
|
52
|
+
|
|
51
53
|
var THREE = /*#__PURE__*/_mergeNamespaces({
|
|
52
54
|
__proto__: null,
|
|
55
|
+
CubeRenderTarget: CubeRenderTarget,
|
|
56
|
+
CubeRenderTargetCompat: WebGLCubeRenderTarget,
|
|
53
57
|
Inspector: Inspector,
|
|
54
58
|
R3F_BUILD_LEGACY: R3F_BUILD_LEGACY,
|
|
55
59
|
R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
|
|
@@ -495,7 +499,7 @@ interface InternalState {
|
|
|
495
499
|
canvasTarget?: CanvasTarget
|
|
496
500
|
/**
|
|
497
501
|
* Whether multi-canvas rendering is active.
|
|
498
|
-
* True when any canvas uses `
|
|
502
|
+
* True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
|
|
499
503
|
* When true, setCanvasTarget is called before each render.
|
|
500
504
|
*/
|
|
501
505
|
isMultiCanvas?: boolean
|
|
@@ -593,8 +597,8 @@ interface RootState {
|
|
|
593
597
|
setSize: (width?: number, height?: number, top?: number, left?: number) => void
|
|
594
598
|
/** Shortcut to manual setting the pixel ratio */
|
|
595
599
|
setDpr: (dpr: Dpr) => void
|
|
596
|
-
/** Shortcut to setting frameloop flags */
|
|
597
|
-
setFrameloop: (frameloop
|
|
600
|
+
/** Shortcut to setting frameloop flags. No args resets to 'always'. */
|
|
601
|
+
setFrameloop: (frameloop?: Frameloop) => void
|
|
598
602
|
/** Set error state to propagate to error boundary */
|
|
599
603
|
setError: (error: Error | null) => void
|
|
600
604
|
/** Current error state (null when no error) */
|
|
@@ -612,7 +616,7 @@ interface RootState {
|
|
|
612
616
|
/** Internal: refcount per texture key, driven by mounted useTexture consumers (registry enrollment is on by default) */
|
|
613
617
|
_textureRefs: Map<string, number>
|
|
614
618
|
/** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
|
|
615
|
-
renderPipeline:
|
|
619
|
+
renderPipeline: ThreeRenderPipeline | null
|
|
616
620
|
/** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
|
|
617
621
|
passes: Record<string, any>
|
|
618
622
|
/** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
|
|
@@ -905,8 +909,6 @@ interface Instance<O = any> {
|
|
|
905
909
|
attach?: AttachType<O>
|
|
906
910
|
previousAttach?: any
|
|
907
911
|
isHidden: boolean
|
|
908
|
-
/** Deferred ref props to apply in commitMount */
|
|
909
|
-
deferredRefs?: Array<{ prop: string; ref: React$1.RefObject<any> }>
|
|
910
912
|
/** Set of props that have been applied via once() */
|
|
911
913
|
appliedOnce?: Set<string>
|
|
912
914
|
}
|
|
@@ -1143,10 +1145,21 @@ type RenderTargetOptions = RenderTargetOptions$1
|
|
|
1143
1145
|
//* Global Types ==============================
|
|
1144
1146
|
|
|
1145
1147
|
declare global {
|
|
1146
|
-
/**
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
|
|
1148
|
+
/**
|
|
1149
|
+
* Uniform node type.
|
|
1150
|
+
*
|
|
1151
|
+
* This is three's own `UniformNode`, not a re-declaration of it. It previously was a
|
|
1152
|
+
* hand-rolled `interface UniformNode<T> extends Node { value: T }`, which shadowed the real
|
|
1153
|
+
* exported type globally — so R3F's ~58 references resolved to an approximation that was
|
|
1154
|
+
* missing members three actually ships (`setName` among them) and had drifted to the wrong
|
|
1155
|
+
* arity when three made `UniformNode` two-parameter.
|
|
1156
|
+
*
|
|
1157
|
+
* three's signature is `UniformNode<TNodeType, TValue>`. R3F only ever varies the value type,
|
|
1158
|
+
* so the node type is fixed to `unknown` and the single parameter is kept for call-site
|
|
1159
|
+
* ergonomics. The result is three's structural type, so members stay in sync with the
|
|
1160
|
+
* installed three instead of needing to be mirrored by hand.
|
|
1161
|
+
*/
|
|
1162
|
+
type UniformNode<T = unknown> = three_webgpu.UniformNode<unknown, T>
|
|
1150
1163
|
|
|
1151
1164
|
/**
|
|
1152
1165
|
* ShaderCallable - the return type of Fn()
|
|
@@ -1291,13 +1304,14 @@ declare module 'three/tsl' {
|
|
|
1291
1304
|
): ShaderCallable<R>
|
|
1292
1305
|
}
|
|
1293
1306
|
|
|
1294
|
-
/**
|
|
1295
|
-
* RenderPipeline Types for useRenderPipeline hook (WebGPU only)
|
|
1296
|
-
*/
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
1307
|
declare global {
|
|
1308
|
+
/**
|
|
1309
|
+
* three's own render pipeline type. Named here so the rest of R3F refers to three's shape
|
|
1310
|
+
* rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
|
|
1311
|
+
* is r185, so the new name is the only one.
|
|
1312
|
+
*/
|
|
1313
|
+
type ThreeRenderPipeline = three_webgpu.RenderPipeline
|
|
1314
|
+
|
|
1301
1315
|
/** Pass record - stores TSL pass nodes for render pipeline */
|
|
1302
1316
|
type PassRecord = Record<string, any>
|
|
1303
1317
|
|
|
@@ -1312,7 +1326,7 @@ declare global {
|
|
|
1312
1326
|
/** Current passes from state */
|
|
1313
1327
|
passes: PassRecord
|
|
1314
1328
|
/** RenderPipeline instance (null if not initialized) */
|
|
1315
|
-
renderPipeline:
|
|
1329
|
+
renderPipeline: ThreeRenderPipeline | null
|
|
1316
1330
|
/** Clear all passes from state */
|
|
1317
1331
|
clearPasses: () => void
|
|
1318
1332
|
/** Reset RenderPipeline entirely (clears PP + passes) */
|
|
@@ -1493,7 +1507,7 @@ declare namespace three_d {
|
|
|
1493
1507
|
* a single WebGPURenderer using Three.js CanvasTarget API.
|
|
1494
1508
|
*
|
|
1495
1509
|
* Primary canvas: Has `id` prop, creates its own renderer, registers here
|
|
1496
|
-
* Secondary canvas: Has `
|
|
1510
|
+
* Secondary canvas: Has `renderer={{ primaryCanvas: 'id' }}`, shares primary's renderer via CanvasTarget
|
|
1497
1511
|
*/
|
|
1498
1512
|
|
|
1499
1513
|
interface PrimaryCanvasEntry {
|
|
@@ -1561,12 +1575,23 @@ type EnvironmentLoaderProps = {
|
|
|
1561
1575
|
* const texture = useEnvironment({ preset: 'sunset' })
|
|
1562
1576
|
* ```
|
|
1563
1577
|
*/
|
|
1564
|
-
declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown> | CubeTexture
|
|
1578
|
+
declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown, THREE$1.TextureEventMap> | CubeTexture<unknown>;
|
|
1565
1579
|
declare namespace useEnvironment {
|
|
1566
1580
|
var preload: (preloadOptions?: EnvironmentLoaderPreloadOptions) => void;
|
|
1567
1581
|
var clear: (clearOptions?: EnvironmentLoaderClearOptions) => void;
|
|
1568
1582
|
}
|
|
1569
|
-
|
|
1583
|
+
/**
|
|
1584
|
+
* Options accepted by `useEnvironment.preload`.
|
|
1585
|
+
*
|
|
1586
|
+
* `colorSpace` is deliberately omitted: preload only warms the loader cache, and colorSpace is
|
|
1587
|
+
* applied to the texture by `useEnvironment()` at use time, per consumer. Accepting it here would
|
|
1588
|
+
* advertise an option this function silently ignores.
|
|
1589
|
+
*
|
|
1590
|
+
* This previously read `Omit<…, 'encoding'>` — omitting a key that does not exist on
|
|
1591
|
+
* `EnvironmentLoaderProps`, a leftover from three's pre-`colorSpace` `encoding` API. That made the
|
|
1592
|
+
* type equivalent to the full props, so `colorSpace` was accepted and then dropped on the floor.
|
|
1593
|
+
*/
|
|
1594
|
+
type EnvironmentLoaderPreloadOptions = Omit<EnvironmentLoaderProps, 'colorSpace'>;
|
|
1570
1595
|
type EnvironmentLoaderClearOptions = Pick<EnvironmentLoaderProps, 'files' | 'preset'>;
|
|
1571
1596
|
|
|
1572
1597
|
/**
|
|
@@ -1816,10 +1841,10 @@ declare function getLoader<L extends LoaderLike | ConstructorRepresentation<Load
|
|
|
1816
1841
|
* Note: this hook's caller must be wrapped with `React.Suspense`
|
|
1817
1842
|
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useloader
|
|
1818
1843
|
*/
|
|
1819
|
-
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>;
|
|
1844
|
+
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>;
|
|
1820
1845
|
declare namespace useLoader {
|
|
1821
|
-
var preload: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void) => void;
|
|
1822
|
-
var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I) => void;
|
|
1846
|
+
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;
|
|
1847
|
+
var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, cacheKey?: InputLike) => void;
|
|
1823
1848
|
var loader: typeof getLoader;
|
|
1824
1849
|
}
|
|
1825
1850
|
|
package/dist/legacy.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as THREE$1 from 'three';
|
|
2
|
-
import { WebGLRenderTarget, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Node as Node$1, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Object3D, Frustum, OrthographicCamera } from 'three';
|
|
2
|
+
import { WebGLCubeRenderTarget, WebGLRenderTarget, Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Node as Node$1, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Object3D, Frustum, OrthographicCamera } from 'three';
|
|
3
3
|
import * as React$1 from 'react';
|
|
4
4
|
import { ReactNode, Component, RefObject, JSX } from 'react';
|
|
5
5
|
import * as three_webgpu from 'three/webgpu';
|
|
@@ -48,8 +48,12 @@ declare const WebGPURenderer: {
|
|
|
48
48
|
|
|
49
49
|
declare const RenderTarget: any;
|
|
50
50
|
|
|
51
|
+
declare const CubeRenderTarget: any;
|
|
52
|
+
|
|
51
53
|
var THREE = /*#__PURE__*/_mergeNamespaces({
|
|
52
54
|
__proto__: null,
|
|
55
|
+
CubeRenderTarget: CubeRenderTarget,
|
|
56
|
+
CubeRenderTargetCompat: WebGLCubeRenderTarget,
|
|
53
57
|
Inspector: Inspector,
|
|
54
58
|
R3F_BUILD_LEGACY: R3F_BUILD_LEGACY,
|
|
55
59
|
R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
|
|
@@ -495,7 +499,7 @@ interface InternalState {
|
|
|
495
499
|
canvasTarget?: CanvasTarget
|
|
496
500
|
/**
|
|
497
501
|
* Whether multi-canvas rendering is active.
|
|
498
|
-
* True when any canvas uses `
|
|
502
|
+
* True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
|
|
499
503
|
* When true, setCanvasTarget is called before each render.
|
|
500
504
|
*/
|
|
501
505
|
isMultiCanvas?: boolean
|
|
@@ -593,8 +597,8 @@ interface RootState {
|
|
|
593
597
|
setSize: (width?: number, height?: number, top?: number, left?: number) => void
|
|
594
598
|
/** Shortcut to manual setting the pixel ratio */
|
|
595
599
|
setDpr: (dpr: Dpr) => void
|
|
596
|
-
/** Shortcut to setting frameloop flags */
|
|
597
|
-
setFrameloop: (frameloop
|
|
600
|
+
/** Shortcut to setting frameloop flags. No args resets to 'always'. */
|
|
601
|
+
setFrameloop: (frameloop?: Frameloop) => void
|
|
598
602
|
/** Set error state to propagate to error boundary */
|
|
599
603
|
setError: (error: Error | null) => void
|
|
600
604
|
/** Current error state (null when no error) */
|
|
@@ -612,7 +616,7 @@ interface RootState {
|
|
|
612
616
|
/** Internal: refcount per texture key, driven by mounted useTexture consumers (registry enrollment is on by default) */
|
|
613
617
|
_textureRefs: Map<string, number>
|
|
614
618
|
/** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
|
|
615
|
-
renderPipeline:
|
|
619
|
+
renderPipeline: ThreeRenderPipeline | null
|
|
616
620
|
/** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
|
|
617
621
|
passes: Record<string, any>
|
|
618
622
|
/** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
|
|
@@ -905,8 +909,6 @@ interface Instance<O = any> {
|
|
|
905
909
|
attach?: AttachType<O>
|
|
906
910
|
previousAttach?: any
|
|
907
911
|
isHidden: boolean
|
|
908
|
-
/** Deferred ref props to apply in commitMount */
|
|
909
|
-
deferredRefs?: Array<{ prop: string; ref: React$1.RefObject<any> }>
|
|
910
912
|
/** Set of props that have been applied via once() */
|
|
911
913
|
appliedOnce?: Set<string>
|
|
912
914
|
}
|
|
@@ -1143,10 +1145,21 @@ type RenderTargetOptions = RenderTargetOptions$1
|
|
|
1143
1145
|
//* Global Types ==============================
|
|
1144
1146
|
|
|
1145
1147
|
declare global {
|
|
1146
|
-
/**
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
|
|
1148
|
+
/**
|
|
1149
|
+
* Uniform node type.
|
|
1150
|
+
*
|
|
1151
|
+
* This is three's own `UniformNode`, not a re-declaration of it. It previously was a
|
|
1152
|
+
* hand-rolled `interface UniformNode<T> extends Node { value: T }`, which shadowed the real
|
|
1153
|
+
* exported type globally — so R3F's ~58 references resolved to an approximation that was
|
|
1154
|
+
* missing members three actually ships (`setName` among them) and had drifted to the wrong
|
|
1155
|
+
* arity when three made `UniformNode` two-parameter.
|
|
1156
|
+
*
|
|
1157
|
+
* three's signature is `UniformNode<TNodeType, TValue>`. R3F only ever varies the value type,
|
|
1158
|
+
* so the node type is fixed to `unknown` and the single parameter is kept for call-site
|
|
1159
|
+
* ergonomics. The result is three's structural type, so members stay in sync with the
|
|
1160
|
+
* installed three instead of needing to be mirrored by hand.
|
|
1161
|
+
*/
|
|
1162
|
+
type UniformNode<T = unknown> = three_webgpu.UniformNode<unknown, T>
|
|
1150
1163
|
|
|
1151
1164
|
/**
|
|
1152
1165
|
* ShaderCallable - the return type of Fn()
|
|
@@ -1291,13 +1304,14 @@ declare module 'three/tsl' {
|
|
|
1291
1304
|
): ShaderCallable<R>
|
|
1292
1305
|
}
|
|
1293
1306
|
|
|
1294
|
-
/**
|
|
1295
|
-
* RenderPipeline Types for useRenderPipeline hook (WebGPU only)
|
|
1296
|
-
*/
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
1307
|
declare global {
|
|
1308
|
+
/**
|
|
1309
|
+
* three's own render pipeline type. Named here so the rest of R3F refers to three's shape
|
|
1310
|
+
* rather than `any`. three r183 renamed `PostProcessing` to `RenderPipeline`; our peer floor
|
|
1311
|
+
* is r185, so the new name is the only one.
|
|
1312
|
+
*/
|
|
1313
|
+
type ThreeRenderPipeline = three_webgpu.RenderPipeline
|
|
1314
|
+
|
|
1301
1315
|
/** Pass record - stores TSL pass nodes for render pipeline */
|
|
1302
1316
|
type PassRecord = Record<string, any>
|
|
1303
1317
|
|
|
@@ -1312,7 +1326,7 @@ declare global {
|
|
|
1312
1326
|
/** Current passes from state */
|
|
1313
1327
|
passes: PassRecord
|
|
1314
1328
|
/** RenderPipeline instance (null if not initialized) */
|
|
1315
|
-
renderPipeline:
|
|
1329
|
+
renderPipeline: ThreeRenderPipeline | null
|
|
1316
1330
|
/** Clear all passes from state */
|
|
1317
1331
|
clearPasses: () => void
|
|
1318
1332
|
/** Reset RenderPipeline entirely (clears PP + passes) */
|
|
@@ -1493,7 +1507,7 @@ declare namespace three_d {
|
|
|
1493
1507
|
* a single WebGPURenderer using Three.js CanvasTarget API.
|
|
1494
1508
|
*
|
|
1495
1509
|
* Primary canvas: Has `id` prop, creates its own renderer, registers here
|
|
1496
|
-
* Secondary canvas: Has `
|
|
1510
|
+
* Secondary canvas: Has `renderer={{ primaryCanvas: 'id' }}`, shares primary's renderer via CanvasTarget
|
|
1497
1511
|
*/
|
|
1498
1512
|
|
|
1499
1513
|
interface PrimaryCanvasEntry {
|
|
@@ -1561,12 +1575,23 @@ type EnvironmentLoaderProps = {
|
|
|
1561
1575
|
* const texture = useEnvironment({ preset: 'sunset' })
|
|
1562
1576
|
* ```
|
|
1563
1577
|
*/
|
|
1564
|
-
declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown> | CubeTexture
|
|
1578
|
+
declare function useEnvironment({ files, path, preset, colorSpace, extensions, }?: Partial<EnvironmentLoaderProps>): Texture$1<unknown, THREE$1.TextureEventMap> | CubeTexture<unknown>;
|
|
1565
1579
|
declare namespace useEnvironment {
|
|
1566
1580
|
var preload: (preloadOptions?: EnvironmentLoaderPreloadOptions) => void;
|
|
1567
1581
|
var clear: (clearOptions?: EnvironmentLoaderClearOptions) => void;
|
|
1568
1582
|
}
|
|
1569
|
-
|
|
1583
|
+
/**
|
|
1584
|
+
* Options accepted by `useEnvironment.preload`.
|
|
1585
|
+
*
|
|
1586
|
+
* `colorSpace` is deliberately omitted: preload only warms the loader cache, and colorSpace is
|
|
1587
|
+
* applied to the texture by `useEnvironment()` at use time, per consumer. Accepting it here would
|
|
1588
|
+
* advertise an option this function silently ignores.
|
|
1589
|
+
*
|
|
1590
|
+
* This previously read `Omit<…, 'encoding'>` — omitting a key that does not exist on
|
|
1591
|
+
* `EnvironmentLoaderProps`, a leftover from three's pre-`colorSpace` `encoding` API. That made the
|
|
1592
|
+
* type equivalent to the full props, so `colorSpace` was accepted and then dropped on the floor.
|
|
1593
|
+
*/
|
|
1594
|
+
type EnvironmentLoaderPreloadOptions = Omit<EnvironmentLoaderProps, 'colorSpace'>;
|
|
1570
1595
|
type EnvironmentLoaderClearOptions = Pick<EnvironmentLoaderProps, 'files' | 'preset'>;
|
|
1571
1596
|
|
|
1572
1597
|
/**
|
|
@@ -1816,10 +1841,10 @@ declare function getLoader<L extends LoaderLike | ConstructorRepresentation<Load
|
|
|
1816
1841
|
* Note: this hook's caller must be wrapped with `React.Suspense`
|
|
1817
1842
|
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useloader
|
|
1818
1843
|
*/
|
|
1819
|
-
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>;
|
|
1844
|
+
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>;
|
|
1820
1845
|
declare namespace useLoader {
|
|
1821
|
-
var preload: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void) => void;
|
|
1822
|
-
var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I) => void;
|
|
1846
|
+
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;
|
|
1847
|
+
var clear: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, cacheKey?: InputLike) => void;
|
|
1823
1848
|
var loader: typeof getLoader;
|
|
1824
1849
|
}
|
|
1825
1850
|
|