@react-three/fiber 10.0.0-canary.2b511a5 → 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 +2803 -3282
- package/dist/index.d.cts +356 -825
- package/dist/index.d.mts +356 -825
- package/dist/index.d.ts +356 -825
- package/dist/index.mjs +2607 -3085
- package/dist/legacy.cjs +2620 -3110
- package/dist/legacy.d.cts +356 -828
- package/dist/legacy.d.mts +356 -828
- package/dist/legacy.d.ts +356 -828
- package/dist/legacy.mjs +2738 -3227
- package/dist/webgpu/index.cjs +2962 -3275
- package/dist/webgpu/index.d.cts +483 -878
- package/dist/webgpu/index.d.mts +483 -878
- package/dist/webgpu/index.d.ts +483 -878
- package/dist/webgpu/index.mjs +3199 -3515
- package/package.json +6 -5
- package/readme.md +3 -4
- 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.cts
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,
|
|
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';
|
|
@@ -7,9 +8,10 @@ import * as React$1 from 'react';
|
|
|
7
8
|
import { ReactNode, Component, RefObject, JSX } from 'react';
|
|
8
9
|
import { StoreApi } from 'zustand';
|
|
9
10
|
import { UseBoundStoreWithEqualityFn } from 'zustand/traditional';
|
|
11
|
+
import { FrameTimingState, FrameCallback as FrameCallback$1, SchedulerApi, UseFrameNextOptions, FrameNextControls } from '@pmndrs/scheduler';
|
|
12
|
+
export { AddPhaseOptions, FrameControls, FrameNextControls, FrameTimingState, RootOptions, Scheduler, SchedulerApi, UseFrameNextOptions, UseFrameOptions, getScheduler } from '@pmndrs/scheduler';
|
|
10
13
|
import { Options } from 'react-use-measure';
|
|
11
14
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
12
|
-
import { ThreeElement as ThreeElement$1, Euler as Euler$3 } from '@react-three/fiber';
|
|
13
15
|
import { GroundedSkybox } from 'three/examples/jsm/objects/GroundedSkybox.js';
|
|
14
16
|
|
|
15
17
|
function _mergeNamespaces(n, m) {
|
|
@@ -39,6 +41,8 @@ function _mergeNamespaces(n, m) {
|
|
|
39
41
|
declare const R3F_BUILD_LEGACY = false;
|
|
40
42
|
declare const R3F_BUILD_WEBGPU = true;
|
|
41
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>;
|
|
42
46
|
declare const WebGLRenderer: {
|
|
43
47
|
new (): {};
|
|
44
48
|
};
|
|
@@ -47,16 +51,21 @@ type WebGLShadowMap = never;
|
|
|
47
51
|
|
|
48
52
|
declare const WebGLRenderTarget: any;
|
|
49
53
|
|
|
54
|
+
declare const WebGLCubeRenderTarget: any;
|
|
55
|
+
|
|
50
56
|
var THREE = /*#__PURE__*/_mergeNamespaces({
|
|
51
57
|
__proto__: null,
|
|
58
|
+
CubeRenderTargetCompat: CubeRenderTarget,
|
|
52
59
|
Inspector: Inspector,
|
|
53
60
|
R3F_BUILD_LEGACY: R3F_BUILD_LEGACY,
|
|
54
61
|
R3F_BUILD_WEBGPU: R3F_BUILD_WEBGPU,
|
|
55
62
|
RenderTargetCompat: RenderTarget,
|
|
63
|
+
WebGLCubeRenderTarget: WebGLCubeRenderTarget,
|
|
56
64
|
WebGLRenderTarget: WebGLRenderTarget,
|
|
57
65
|
WebGLRenderer: WebGLRenderer,
|
|
58
66
|
WebGLRendererParameters: WebGLRendererParameters,
|
|
59
|
-
WebGLShadowMap: WebGLShadowMap
|
|
67
|
+
WebGLShadowMap: WebGLShadowMap,
|
|
68
|
+
loadInspector: loadInspector
|
|
60
69
|
}, [three_webgpu]);
|
|
61
70
|
|
|
62
71
|
//* Utility Types ==============================
|
|
@@ -151,6 +160,8 @@ interface IntersectionEvent<TSourceEvent> extends Intersection {
|
|
|
151
160
|
unprojectedPoint: THREE$1.Vector3
|
|
152
161
|
/** Normalized event coordinates */
|
|
153
162
|
pointer: THREE$1.Vector2
|
|
163
|
+
/** pointerId of the original event for multiple pointer events */
|
|
164
|
+
pointerId: number
|
|
154
165
|
/** Delta between first click and this event */
|
|
155
166
|
delta: number
|
|
156
167
|
/** The ray that pierced it */
|
|
@@ -227,6 +238,18 @@ interface EventHandlers {
|
|
|
227
238
|
type FilterFunction = (items: THREE$1.Intersection[], state: RootState) => THREE$1.Intersection[]
|
|
228
239
|
type ComputeFunction = (event: DomEvent, root: RootState, previous?: RootState) => void
|
|
229
240
|
|
|
241
|
+
/** Configuration for XR pointer registration (controllers/hands) */
|
|
242
|
+
interface XRPointerConfig {
|
|
243
|
+
/** Ray origin (updated each frame by XR system) */
|
|
244
|
+
ray: THREE$1.Ray
|
|
245
|
+
/** Optional: custom compute function for this pointer */
|
|
246
|
+
compute?: (state: RootState) => void
|
|
247
|
+
/** Pointer type identifier */
|
|
248
|
+
type: 'controller' | 'hand' | 'gaze'
|
|
249
|
+
/** Which hand (for controller/hand types) */
|
|
250
|
+
handedness?: 'left' | 'right'
|
|
251
|
+
}
|
|
252
|
+
|
|
230
253
|
interface EventManager<TTarget> {
|
|
231
254
|
/** Determines if the event layer is active */
|
|
232
255
|
enabled: boolean
|
|
@@ -246,8 +269,21 @@ interface EventManager<TTarget> {
|
|
|
246
269
|
disconnect?: () => void
|
|
247
270
|
/** Triggers a onPointerMove with the last known event. This can be useful to enable raycasting without
|
|
248
271
|
* explicit user interaction, for instance when the camera moves a hoverable object underneath the cursor.
|
|
272
|
+
* @param pointerId - Optional pointer ID to update specific pointer only
|
|
249
273
|
*/
|
|
250
|
-
update?: () => void
|
|
274
|
+
update?: (pointerId?: number) => void
|
|
275
|
+
/** Defer pointer move raycasting to frame start (default: true) */
|
|
276
|
+
frameTimedRaycasts?: boolean
|
|
277
|
+
/** Always fire raycaster immediately on scroll events (default: true) */
|
|
278
|
+
alwaysFireOnScroll?: boolean
|
|
279
|
+
/** Automatically re-raycast every frame to detect hover changes from moving objects/camera (default: false) */
|
|
280
|
+
updateOnFrame?: boolean
|
|
281
|
+
/** Flush deferred pointer raycasts. Called by scheduler at frame start (input phase). */
|
|
282
|
+
flush?: () => void
|
|
283
|
+
/** Register an XR pointer (controller/hand). Returns assigned pointerId */
|
|
284
|
+
registerPointer?: (config: XRPointerConfig) => number
|
|
285
|
+
/** Unregister an XR pointer */
|
|
286
|
+
unregisterPointer?: (pointerId: number) => void
|
|
251
287
|
}
|
|
252
288
|
|
|
253
289
|
interface PointerCaptureTarget {
|
|
@@ -267,227 +303,94 @@ interface VisibilityEntry {
|
|
|
267
303
|
}
|
|
268
304
|
|
|
269
305
|
//* Scheduler Types (useFrame) ==============================
|
|
306
|
+
//
|
|
307
|
+
// The generic, framework-agnostic scheduler types now live in @pmndrs/scheduler.
|
|
308
|
+
// This file re-exports them and layers r3f's RootState-aware frame state on top,
|
|
309
|
+
// so existing `#types` imports across the codebase keep resolving unchanged.
|
|
270
310
|
|
|
271
311
|
|
|
272
312
|
|
|
273
|
-
//
|
|
274
|
-
|
|
275
|
-
/**
|
|
276
|
-
* Options for useFrame hook
|
|
277
|
-
*/
|
|
278
|
-
interface UseFrameNextOptions {
|
|
279
|
-
/** Optional stable id for the job. Auto-generated if not provided */
|
|
280
|
-
id?: string
|
|
281
|
-
/** Named phase to run in. Default: 'update' */
|
|
282
|
-
phase?: string
|
|
283
|
-
/** Run before this phase or job id */
|
|
284
|
-
before?: string | string[]
|
|
285
|
-
/** Run after this phase or job id */
|
|
286
|
-
after?: string | string[]
|
|
287
|
-
/** Priority within phase. Higher runs first. Default: 0 */
|
|
288
|
-
priority?: number
|
|
289
|
-
/** Max frames per second for this job */
|
|
290
|
-
fps?: number
|
|
291
|
-
/** If true, skip frames when behind. If false, try to catch up. Default: true */
|
|
292
|
-
drop?: boolean
|
|
293
|
-
/** Enable/disable without unregistering. Default: true */
|
|
294
|
-
enabled?: boolean
|
|
295
|
-
}
|
|
296
|
-
|
|
297
|
-
/** Alias for UseFrameNextOptions */
|
|
298
|
-
type UseFrameOptions = UseFrameNextOptions
|
|
299
|
-
|
|
300
|
-
/**
|
|
301
|
-
* Options for addPhase
|
|
302
|
-
*/
|
|
303
|
-
interface AddPhaseOptions {
|
|
304
|
-
/** Insert this phase before the specified phase */
|
|
305
|
-
before?: string
|
|
306
|
-
/** Insert this phase after the specified phase */
|
|
307
|
-
after?: string
|
|
308
|
-
}
|
|
309
|
-
|
|
310
|
-
// Frame State --------------------------------
|
|
311
|
-
|
|
312
|
-
/**
|
|
313
|
-
* Timing-only state for independent/outside mode (no RootState)
|
|
314
|
-
*/
|
|
315
|
-
interface FrameTimingState {
|
|
316
|
-
/** High-resolution timestamp from RAF (ms) */
|
|
317
|
-
time: number
|
|
318
|
-
/** Time since last frame in seconds (for legacy compatibility with THREE.Clock) */
|
|
319
|
-
delta: number
|
|
320
|
-
/** Elapsed time since first frame in seconds (for legacy compatibility with THREE.Clock) */
|
|
321
|
-
elapsed: number
|
|
322
|
-
/** Incrementing frame counter */
|
|
323
|
-
frame: number
|
|
324
|
-
}
|
|
313
|
+
// Frame State (r3f-specific) --------------------------------
|
|
325
314
|
|
|
326
315
|
/**
|
|
327
|
-
* State passed to useFrame callbacks (extends RootState with timing)
|
|
316
|
+
* State passed to useFrame callbacks (extends RootState with timing).
|
|
328
317
|
*/
|
|
329
318
|
interface FrameNextState extends RootState, FrameTimingState {}
|
|
330
319
|
|
|
331
320
|
/** Alias for FrameNextState */
|
|
332
321
|
type FrameState = FrameNextState
|
|
333
322
|
|
|
334
|
-
//
|
|
323
|
+
// Callback Types (r3f-specific) --------------------------------
|
|
335
324
|
|
|
336
325
|
/**
|
|
337
|
-
*
|
|
326
|
+
* Callback function for useFrame. Receives the full r3f RootState plus timing.
|
|
338
327
|
*/
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
onError?: (error: Error) => void
|
|
344
|
-
}
|
|
328
|
+
type FrameNextCallback = FrameCallback$1<RootState>
|
|
329
|
+
|
|
330
|
+
/** Alias for FrameNextCallback */
|
|
331
|
+
type FrameCallback = FrameNextCallback
|
|
345
332
|
|
|
346
|
-
|
|
333
|
+
//* Buffer Types (useBuffers) ========================================
|
|
347
334
|
|
|
348
335
|
/**
|
|
349
|
-
*
|
|
336
|
+
* Buffer-like types for GPU compute and storage operations.
|
|
337
|
+
* Includes raw CPU arrays, Three.js buffer attributes, and TSL buffer nodes.
|
|
338
|
+
*
|
|
339
|
+
* @example
|
|
340
|
+
* ```tsx
|
|
341
|
+
* const { positions, velocities } = useBuffers(() => ({
|
|
342
|
+
* positions: instancedArray(count, 'vec3'), // StorageBufferNode
|
|
343
|
+
* velocities: new Float32Array(count * 3), // TypedArray
|
|
344
|
+
* }), 'particles')
|
|
345
|
+
* ```
|
|
350
346
|
*/
|
|
351
|
-
type
|
|
347
|
+
type BufferLike =
|
|
348
|
+
| Float32Array
|
|
349
|
+
| Uint32Array
|
|
350
|
+
| Int32Array
|
|
351
|
+
| Float64Array
|
|
352
|
+
| Uint8Array
|
|
353
|
+
| Int8Array
|
|
354
|
+
| Uint16Array
|
|
355
|
+
| Int16Array
|
|
356
|
+
| THREE$1.BufferAttribute // Base class for all buffer attributes
|
|
357
|
+
| Node // TSL buffer nodes (instancedArray, storage)
|
|
358
|
+
|
|
359
|
+
/** Flat record of buffer-like values (no nested scopes) */
|
|
360
|
+
type BufferRecord = Record<string, BufferLike>
|
|
352
361
|
|
|
353
|
-
/**
|
|
354
|
-
|
|
362
|
+
/**
|
|
363
|
+
* Buffer store that can contain both root-level buffers and scoped buffer objects.
|
|
364
|
+
* Structure: { positions: Float32Array, particles: { vel: StorageBufferNode } }
|
|
365
|
+
*/
|
|
366
|
+
type BufferStore = Record<string, BufferLike | BufferRecord>
|
|
355
367
|
|
|
356
|
-
|
|
368
|
+
//* Storage Types (useGPUStorage) ========================================
|
|
357
369
|
|
|
358
370
|
/**
|
|
359
|
-
*
|
|
371
|
+
* GPU storage types for texture-based storage operations.
|
|
372
|
+
* Includes Three.js storage textures and TSL storage texture nodes.
|
|
373
|
+
*
|
|
374
|
+
* @example
|
|
375
|
+
* ```tsx
|
|
376
|
+
* const { heightMap } = useGPUStorage(() => ({
|
|
377
|
+
* heightMap: new StorageTexture(512, 512),
|
|
378
|
+
* }), 'terrain')
|
|
379
|
+
* ```
|
|
360
380
|
*/
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
scheduler: SchedulerApi
|
|
366
|
-
/** Manually step this job only (bypasses FPS limiting) */
|
|
367
|
-
step(timestamp?: number): void
|
|
368
|
-
/** Manually step ALL jobs in the scheduler */
|
|
369
|
-
stepAll(timestamp?: number): void
|
|
370
|
-
/** Pause this job (set enabled=false) */
|
|
371
|
-
pause(): void
|
|
372
|
-
/** Resume this job (set enabled=true) */
|
|
373
|
-
resume(): void
|
|
374
|
-
/** Reactive paused state - automatically triggers re-render when changed */
|
|
375
|
-
isPaused: boolean
|
|
376
|
-
}
|
|
381
|
+
type StorageLike =
|
|
382
|
+
| StorageTexture // GPU storage texture
|
|
383
|
+
| Data3DTexture // 3D texture (can be used as storage)
|
|
384
|
+
| Node // TSL storage texture nodes (storageTexture)
|
|
377
385
|
|
|
378
|
-
/**
|
|
379
|
-
type
|
|
380
|
-
|
|
381
|
-
// Scheduler Interface --------------------------------
|
|
386
|
+
/** Flat record of storage-like values (no nested scopes) */
|
|
387
|
+
type StorageRecord = Record<string, StorageLike>
|
|
382
388
|
|
|
383
389
|
/**
|
|
384
|
-
*
|
|
390
|
+
* Storage store that can contain both root-level storage and scoped storage objects.
|
|
391
|
+
* Structure: { heightMap: StorageTexture, terrain: { normal: StorageTextureNode } }
|
|
385
392
|
*/
|
|
386
|
-
|
|
387
|
-
//* Phase Management --------------------------------
|
|
388
|
-
|
|
389
|
-
/** Add a named phase to the scheduler */
|
|
390
|
-
addPhase(name: string, options?: AddPhaseOptions): void
|
|
391
|
-
/** Get the ordered list of phase names */
|
|
392
|
-
readonly phases: string[]
|
|
393
|
-
/** Check if a phase exists */
|
|
394
|
-
hasPhase(name: string): boolean
|
|
395
|
-
|
|
396
|
-
//* Root Management --------------------------------
|
|
397
|
-
|
|
398
|
-
/** Register a root (Canvas) with the scheduler. Returns unsubscribe function. */
|
|
399
|
-
registerRoot(id: string, options?: RootOptions): () => void
|
|
400
|
-
/** Unregister a root */
|
|
401
|
-
unregisterRoot(id: string): void
|
|
402
|
-
/** Generate a unique root ID */
|
|
403
|
-
generateRootId(): string
|
|
404
|
-
/** Get the number of registered roots */
|
|
405
|
-
getRootCount(): number
|
|
406
|
-
/** Check if any root is registered and ready */
|
|
407
|
-
readonly isReady: boolean
|
|
408
|
-
/** Subscribe to root-ready event. Fires immediately if already ready. Returns unsubscribe. */
|
|
409
|
-
onRootReady(callback: () => void): () => void
|
|
410
|
-
|
|
411
|
-
//* Job Registration --------------------------------
|
|
412
|
-
|
|
413
|
-
/** Register a job with the scheduler (returns unsubscribe function) */
|
|
414
|
-
register(
|
|
415
|
-
callback: FrameNextCallback,
|
|
416
|
-
options?: {
|
|
417
|
-
id?: string
|
|
418
|
-
rootId?: string
|
|
419
|
-
phase?: string
|
|
420
|
-
before?: string | string[]
|
|
421
|
-
after?: string | string[]
|
|
422
|
-
priority?: number
|
|
423
|
-
fps?: number
|
|
424
|
-
drop?: boolean
|
|
425
|
-
enabled?: boolean
|
|
426
|
-
},
|
|
427
|
-
): () => void
|
|
428
|
-
/** Update a job's options */
|
|
429
|
-
updateJob(
|
|
430
|
-
id: string,
|
|
431
|
-
options: {
|
|
432
|
-
priority?: number
|
|
433
|
-
fps?: number
|
|
434
|
-
drop?: boolean
|
|
435
|
-
enabled?: boolean
|
|
436
|
-
phase?: string
|
|
437
|
-
before?: string | string[]
|
|
438
|
-
after?: string | string[]
|
|
439
|
-
},
|
|
440
|
-
): void
|
|
441
|
-
/** Unregister a job by ID */
|
|
442
|
-
unregister(id: string, rootId?: string): void
|
|
443
|
-
/** Get the number of registered jobs */
|
|
444
|
-
getJobCount(): number
|
|
445
|
-
/** Get all job IDs */
|
|
446
|
-
getJobIds(): string[]
|
|
447
|
-
|
|
448
|
-
//* Global Jobs (for legacy addEffect/addAfterEffect) --------------------------------
|
|
449
|
-
|
|
450
|
-
/** Register a global job (runs once per frame, not per-root). Returns unsubscribe function. */
|
|
451
|
-
registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void
|
|
452
|
-
|
|
453
|
-
//* Idle Callbacks (for legacy addTail) --------------------------------
|
|
454
|
-
|
|
455
|
-
/** Register an idle callback (fires when loop stops). Returns unsubscribe function. */
|
|
456
|
-
onIdle(callback: (timestamp: number) => void): () => void
|
|
457
|
-
|
|
458
|
-
//* Frame Loop Control --------------------------------
|
|
459
|
-
|
|
460
|
-
/** Start the scheduler loop */
|
|
461
|
-
start(): void
|
|
462
|
-
/** Stop the scheduler loop */
|
|
463
|
-
stop(): void
|
|
464
|
-
/** Check if the scheduler is running */
|
|
465
|
-
readonly isRunning: boolean
|
|
466
|
-
/** Get/set the frameloop mode ('always', 'demand', 'never') */
|
|
467
|
-
frameloop: Frameloop
|
|
468
|
-
/** Independent mode - runs without Canvas, callbacks receive timing-only state */
|
|
469
|
-
independent: boolean
|
|
470
|
-
|
|
471
|
-
//* Manual Stepping --------------------------------
|
|
472
|
-
|
|
473
|
-
/** Manually step all jobs once (for frameloop='never' or testing) */
|
|
474
|
-
step(timestamp?: number): void
|
|
475
|
-
/** Manually step a single job by ID */
|
|
476
|
-
stepJob(id: string, timestamp?: number): void
|
|
477
|
-
/** Request frame(s) to be rendered (for frameloop='demand') */
|
|
478
|
-
invalidate(frames?: number): void
|
|
479
|
-
|
|
480
|
-
//* Per-Job Control --------------------------------
|
|
481
|
-
|
|
482
|
-
/** Check if a job is paused */
|
|
483
|
-
isJobPaused(id: string): boolean
|
|
484
|
-
/** Pause a job */
|
|
485
|
-
pauseJob(id: string): void
|
|
486
|
-
/** Resume a job */
|
|
487
|
-
resumeJob(id: string): void
|
|
488
|
-
/** Subscribe to job state changes (for reactive isPaused). Returns unsubscribe function. */
|
|
489
|
-
subscribeJobState(id: string, listener: () => void): () => void
|
|
490
|
-
}
|
|
393
|
+
type StorageStore = Record<string, StorageLike | StorageRecord>
|
|
491
394
|
|
|
492
395
|
//* Renderer Types ========================================
|
|
493
396
|
|
|
@@ -502,6 +405,18 @@ type Subscription = {
|
|
|
502
405
|
store: RootStore
|
|
503
406
|
}
|
|
504
407
|
|
|
408
|
+
/** Per-pointer state for multi-touch and XR support */
|
|
409
|
+
type PointerState = {
|
|
410
|
+
/** Objects currently hovered by this pointer */
|
|
411
|
+
hovered: Map<string, ThreeEvent<DomEvent>>
|
|
412
|
+
/** Objects capturing this pointer */
|
|
413
|
+
captured: Map<THREE$1.Object3D, PointerCaptureTarget>
|
|
414
|
+
/** Initial click position [x, y] */
|
|
415
|
+
initialClick: [x: number, y: number]
|
|
416
|
+
/** Objects hit on initial click */
|
|
417
|
+
initialHits: THREE$1.Object3D[]
|
|
418
|
+
}
|
|
419
|
+
|
|
505
420
|
type Dpr = number | [min: number, max: number]
|
|
506
421
|
|
|
507
422
|
interface Size {
|
|
@@ -543,12 +458,21 @@ interface Performance {
|
|
|
543
458
|
|
|
544
459
|
interface InternalState {
|
|
545
460
|
interaction: THREE$1.Object3D[]
|
|
546
|
-
hovered: Map<string, ThreeEvent<DomEvent>>
|
|
547
461
|
subscribers: Subscription[]
|
|
462
|
+
/** Per-pointer state (hover, capture, click tracking) - replaces hovered, capturedMap, initialClick, initialHits */
|
|
463
|
+
pointerMap: Map<number, PointerState>
|
|
464
|
+
/** Pointers needing raycast this frame (used with frameTimedRaycasts) */
|
|
465
|
+
pointerDirty: Map<number, DomEvent>
|
|
466
|
+
/** Last event received (for events.update() compatibility) */
|
|
467
|
+
lastEvent: React$1.RefObject<DomEvent | null>
|
|
468
|
+
/** @deprecated Use pointerMap.get(pointerId).hovered instead */
|
|
469
|
+
hovered: Map<string, ThreeEvent<DomEvent>>
|
|
470
|
+
/** @deprecated Use pointerMap.get(pointerId).captured instead */
|
|
548
471
|
capturedMap: Map<number, Map<THREE$1.Object3D, PointerCaptureTarget>>
|
|
472
|
+
/** @deprecated Use pointerMap.get(pointerId).initialClick instead */
|
|
549
473
|
initialClick: [x: number, y: number]
|
|
474
|
+
/** @deprecated Use pointerMap.get(pointerId).initialHits instead */
|
|
550
475
|
initialHits: THREE$1.Object3D[]
|
|
551
|
-
lastEvent: React$1.RefObject<DomEvent | null>
|
|
552
476
|
/** Visibility event registry (onFramed, onOccluded, onVisible) */
|
|
553
477
|
visibilityRegistry: Map<string, VisibilityEntry>
|
|
554
478
|
/** Whether occlusion queries are enabled (WebGPU only) */
|
|
@@ -579,9 +503,21 @@ interface InternalState {
|
|
|
579
503
|
* @see https://threejs.org/docs/#api/en/renderers/common/CanvasTarget
|
|
580
504
|
*/
|
|
581
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
|
|
582
518
|
/**
|
|
583
519
|
* Whether multi-canvas rendering is active.
|
|
584
|
-
* True when any canvas uses `
|
|
520
|
+
* True when any canvas uses `renderer={{ primaryCanvas: 'id' }}` to share a renderer.
|
|
585
521
|
* When true, setCanvasTarget is called before each render.
|
|
586
522
|
*/
|
|
587
523
|
isMultiCanvas?: boolean
|
|
@@ -679,8 +615,8 @@ interface RootState {
|
|
|
679
615
|
setSize: (width?: number, height?: number, top?: number, left?: number) => void
|
|
680
616
|
/** Shortcut to manual setting the pixel ratio */
|
|
681
617
|
setDpr: (dpr: Dpr) => void
|
|
682
|
-
/** Shortcut to setting frameloop flags */
|
|
683
|
-
setFrameloop: (frameloop
|
|
618
|
+
/** Shortcut to setting frameloop flags. No args resets to 'always'. */
|
|
619
|
+
setFrameloop: (frameloop?: Frameloop) => void
|
|
684
620
|
/** Set error state to propagate to error boundary */
|
|
685
621
|
setError: (error: Error | null) => void
|
|
686
622
|
/** Current error state (null when no error) */
|
|
@@ -689,11 +625,17 @@ interface RootState {
|
|
|
689
625
|
uniforms: UniformStore
|
|
690
626
|
/** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
|
|
691
627
|
nodes: Record<string, any>
|
|
692
|
-
/** Global TSL
|
|
693
|
-
|
|
694
|
-
/**
|
|
695
|
-
|
|
696
|
-
/** Global
|
|
628
|
+
/** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
|
|
629
|
+
buffers: BufferStore
|
|
630
|
+
/** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
|
|
631
|
+
gpuStorage: StorageStore
|
|
632
|
+
/** Global Texture registry (key → Texture, usually keyed by URL) - use useTextures() hook for access + lifecycle */
|
|
633
|
+
textures: Map<string, THREE$1.Texture>
|
|
634
|
+
/** Internal: refcount per texture key, driven by mounted useTexture consumers (registry enrollment is on by default) */
|
|
635
|
+
_textureRefs: Map<string, number>
|
|
636
|
+
/** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
|
|
637
|
+
renderPipeline: ThreeRenderPipeline | null
|
|
638
|
+
/** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
|
|
697
639
|
passes: Record<string, any>
|
|
698
640
|
/** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
|
|
699
641
|
_hmrVersion: number
|
|
@@ -743,6 +685,20 @@ interface Renderer {
|
|
|
743
685
|
render: (scene: THREE$1.Scene, camera: THREE$1.Camera) => any
|
|
744
686
|
}
|
|
745
687
|
|
|
688
|
+
//* Color Management Config ==============================
|
|
689
|
+
|
|
690
|
+
/**
|
|
691
|
+
* Color management configuration shared by both WebGL and WebGPU renderers.
|
|
692
|
+
*/
|
|
693
|
+
interface ColorManagementConfig {
|
|
694
|
+
/**
|
|
695
|
+
* Color space assigned to 8-bit input textures (color maps).
|
|
696
|
+
* Defaults to sRGB. Most textures are authored in sRGB.
|
|
697
|
+
* @default THREE.SRGBColorSpace
|
|
698
|
+
*/
|
|
699
|
+
textureColorSpace?: THREE$1.ColorSpace
|
|
700
|
+
}
|
|
701
|
+
|
|
746
702
|
//* WebGL Renderer Props ==============================
|
|
747
703
|
|
|
748
704
|
type DefaultGLProps = Omit<THREE$1.WebGLRendererParameters, 'canvas'> & {
|
|
@@ -753,7 +709,7 @@ type GLProps =
|
|
|
753
709
|
| Renderer
|
|
754
710
|
| ((defaultProps: DefaultGLProps) => Renderer)
|
|
755
711
|
| ((defaultProps: DefaultGLProps) => Promise<Renderer>)
|
|
756
|
-
| Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters>
|
|
712
|
+
| (Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters> & ColorManagementConfig)
|
|
757
713
|
|
|
758
714
|
//* WebGPU Renderer Props ==============================
|
|
759
715
|
|
|
@@ -768,20 +724,27 @@ type DefaultRendererProps = {
|
|
|
768
724
|
*/
|
|
769
725
|
interface CanvasSchedulerConfig {
|
|
770
726
|
/**
|
|
771
|
-
*
|
|
772
|
-
* Pass the `id` of another canvas.
|
|
727
|
+
* Run this Canvas root before the referenced Canvas root id(s).
|
|
773
728
|
*/
|
|
774
|
-
|
|
729
|
+
before?: string | string[]
|
|
775
730
|
/**
|
|
776
|
-
*
|
|
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).
|
|
777
740
|
*/
|
|
778
741
|
fps?: number
|
|
779
742
|
}
|
|
780
743
|
|
|
781
744
|
/**
|
|
782
|
-
* Extended renderer configuration for multi-canvas support.
|
|
745
|
+
* Extended renderer configuration for multi-canvas support and color management.
|
|
783
746
|
*/
|
|
784
|
-
interface RendererConfigExtended {
|
|
747
|
+
interface RendererConfigExtended extends ColorManagementConfig {
|
|
785
748
|
/** Share renderer from another canvas (WebGPU only) */
|
|
786
749
|
primaryCanvas?: string
|
|
787
750
|
/** Canvas-level scheduler options */
|
|
@@ -846,8 +809,6 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
|
|
|
846
809
|
* @see https://threejs.org/docs/#api/en/renderers/WebGLRenderer.shadowMap
|
|
847
810
|
*/
|
|
848
811
|
shadows?: boolean | 'basic' | 'percentage' | 'soft' | 'variance' | Partial<THREE$1.WebGLShadowMap>
|
|
849
|
-
/** Color space assigned to 8-bit input textures (color maps). Defaults to sRGB. Most textures are authored in sRGB. */
|
|
850
|
-
textureColorSpace?: THREE$1.ColorSpace
|
|
851
812
|
/** Creates an orthographic camera */
|
|
852
813
|
orthographic?: boolean
|
|
853
814
|
/**
|
|
@@ -973,8 +934,6 @@ interface Instance<O = any> {
|
|
|
973
934
|
attach?: AttachType<O>
|
|
974
935
|
previousAttach?: any
|
|
975
936
|
isHidden: boolean
|
|
976
|
-
/** Deferred ref props to apply in commitMount */
|
|
977
|
-
deferredRefs?: Array<{ prop: string; ref: React$1.RefObject<any> }>
|
|
978
937
|
/** Set of props that have been applied via once() */
|
|
979
938
|
appliedOnce?: Set<string>
|
|
980
939
|
}
|
|
@@ -1100,7 +1059,7 @@ interface CanvasProps
|
|
|
1100
1059
|
*/
|
|
1101
1060
|
resize?: Options
|
|
1102
1061
|
/** The target where events are being subscribed to, default: the div that wraps canvas */
|
|
1103
|
-
eventSource?: HTMLElement | React$1.RefObject<HTMLElement>
|
|
1062
|
+
eventSource?: HTMLElement | React$1.RefObject<HTMLElement | null>
|
|
1104
1063
|
/** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
|
|
1105
1064
|
eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
|
|
1106
1065
|
/** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
|
|
@@ -1211,10 +1170,21 @@ type RenderTargetOptions = RenderTargetOptions$1
|
|
|
1211
1170
|
//* Global Types ==============================
|
|
1212
1171
|
|
|
1213
1172
|
declare global {
|
|
1214
|
-
/**
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
|
|
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>
|
|
1218
1188
|
|
|
1219
1189
|
/**
|
|
1220
1190
|
* ShaderCallable - the return type of Fn()
|
|
@@ -1314,6 +1284,7 @@ declare global {
|
|
|
1314
1284
|
| three_webgpu.Euler
|
|
1315
1285
|
| three_webgpu.Quaternion
|
|
1316
1286
|
| { x: number; y?: number; z?: number; w?: number } // Plain objects converted to vectors
|
|
1287
|
+
| { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
|
|
1317
1288
|
| Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1318
1289
|
| UniformNode
|
|
1319
1290
|
|
|
@@ -1358,179 +1329,45 @@ declare module 'three/tsl' {
|
|
|
1358
1329
|
): ShaderCallable<R>
|
|
1359
1330
|
}
|
|
1360
1331
|
|
|
1361
|
-
/**
|
|
1362
|
-
* PostProcessing Types for usePostProcessing hook (WebGPU only)
|
|
1363
|
-
*/
|
|
1364
|
-
|
|
1365
|
-
|
|
1366
|
-
|
|
1367
1332
|
declare global {
|
|
1368
|
-
/**
|
|
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
|
+
|
|
1340
|
+
/** Pass record - stores TSL pass nodes for render pipeline */
|
|
1369
1341
|
type PassRecord = Record<string, any>
|
|
1370
1342
|
|
|
1343
|
+
/** State passed to pipeline callbacks after the active pipeline has been created */
|
|
1344
|
+
type RenderPipelineCallbackState = RootState & {
|
|
1345
|
+
renderPipeline: ThreeRenderPipeline
|
|
1346
|
+
}
|
|
1347
|
+
|
|
1371
1348
|
/** Setup callback - runs first to configure MRT, create additional passes */
|
|
1372
|
-
type
|
|
1349
|
+
type RenderPipelineSetupCallback = (state: RenderPipelineCallbackState) => PassRecord | void
|
|
1373
1350
|
|
|
1374
1351
|
/** Main callback - runs second to configure outputNode, create effect passes */
|
|
1375
|
-
type
|
|
1352
|
+
type RenderPipelineMainCallback = (state: RenderPipelineCallbackState) => PassRecord | void
|
|
1376
1353
|
|
|
1377
|
-
/** Return type for
|
|
1378
|
-
interface
|
|
1354
|
+
/** Return type for useRenderPipeline hook */
|
|
1355
|
+
interface UseRenderPipelineReturn {
|
|
1379
1356
|
/** Current passes from state */
|
|
1380
1357
|
passes: PassRecord
|
|
1381
|
-
/**
|
|
1382
|
-
|
|
1358
|
+
/** RenderPipeline instance (null if not initialized) */
|
|
1359
|
+
renderPipeline: ThreeRenderPipeline | null
|
|
1383
1360
|
/** Clear all passes from state */
|
|
1384
1361
|
clearPasses: () => void
|
|
1385
|
-
/** Reset
|
|
1362
|
+
/** Reset RenderPipeline entirely (clears PP + passes) */
|
|
1386
1363
|
reset: () => void
|
|
1387
1364
|
/** Re-run setup/main callbacks with current closure values */
|
|
1388
1365
|
rebuild: () => void
|
|
1389
|
-
/** True when
|
|
1366
|
+
/** True when RenderPipeline is configured and ready */
|
|
1390
1367
|
isReady: boolean
|
|
1391
1368
|
}
|
|
1392
1369
|
}
|
|
1393
1370
|
|
|
1394
|
-
//* useFrameNext Types ==============================
|
|
1395
|
-
|
|
1396
|
-
|
|
1397
|
-
|
|
1398
|
-
//* Global Type Declarations ==============================
|
|
1399
|
-
|
|
1400
|
-
declare global {
|
|
1401
|
-
// Job --------------------------------
|
|
1402
|
-
|
|
1403
|
-
/**
|
|
1404
|
-
* Internal job representation in the scheduler
|
|
1405
|
-
*/
|
|
1406
|
-
interface Job {
|
|
1407
|
-
/** Unique identifier */
|
|
1408
|
-
id: string
|
|
1409
|
-
/** The callback to execute */
|
|
1410
|
-
callback: FrameNextCallback
|
|
1411
|
-
/** Phase this job belongs to */
|
|
1412
|
-
phase: string
|
|
1413
|
-
/** Run before these phases/job ids */
|
|
1414
|
-
before: Set<string>
|
|
1415
|
-
/** Run after these phases/job ids */
|
|
1416
|
-
after: Set<string>
|
|
1417
|
-
/** Priority within phase (higher first) */
|
|
1418
|
-
priority: number
|
|
1419
|
-
/** Insertion order for deterministic tie-breaking */
|
|
1420
|
-
index: number
|
|
1421
|
-
/** Max FPS for this job (undefined = no limit) */
|
|
1422
|
-
fps?: number
|
|
1423
|
-
/** Drop frames when behind (true) or catch up (false) */
|
|
1424
|
-
drop: boolean
|
|
1425
|
-
/** Last run timestamp (ms) */
|
|
1426
|
-
lastRun?: number
|
|
1427
|
-
/** Whether job is enabled */
|
|
1428
|
-
enabled: boolean
|
|
1429
|
-
/** Internal flag: system jobs (like default render) don't block user render takeover */
|
|
1430
|
-
system?: boolean
|
|
1431
|
-
}
|
|
1432
|
-
|
|
1433
|
-
// Phase Graph --------------------------------
|
|
1434
|
-
|
|
1435
|
-
/**
|
|
1436
|
-
* A node in the phase graph
|
|
1437
|
-
*/
|
|
1438
|
-
interface PhaseNode {
|
|
1439
|
-
/** Phase name */
|
|
1440
|
-
name: string
|
|
1441
|
-
/** Whether this was auto-generated from a before/after constraint */
|
|
1442
|
-
isAutoGenerated: boolean
|
|
1443
|
-
}
|
|
1444
|
-
|
|
1445
|
-
/**
|
|
1446
|
-
* Options for creating a job from hook options
|
|
1447
|
-
*/
|
|
1448
|
-
interface JobOptions {
|
|
1449
|
-
id?: string
|
|
1450
|
-
phase?: string
|
|
1451
|
-
before?: string | string[]
|
|
1452
|
-
after?: string | string[]
|
|
1453
|
-
priority?: number
|
|
1454
|
-
fps?: number
|
|
1455
|
-
drop?: boolean
|
|
1456
|
-
enabled?: boolean
|
|
1457
|
-
}
|
|
1458
|
-
|
|
1459
|
-
// Frame Loop State --------------------------------
|
|
1460
|
-
|
|
1461
|
-
/**
|
|
1462
|
-
* Internal frame loop state
|
|
1463
|
-
*/
|
|
1464
|
-
interface FrameLoopState {
|
|
1465
|
-
/** Whether the loop is running */
|
|
1466
|
-
running: boolean
|
|
1467
|
-
/** Current RAF handle */
|
|
1468
|
-
rafHandle: number | null
|
|
1469
|
-
/** Last frame timestamp in ms (null = uninitialized) */
|
|
1470
|
-
lastTime: number | null
|
|
1471
|
-
/** Frame counter */
|
|
1472
|
-
frameCount: number
|
|
1473
|
-
/** Elapsed time since first frame in ms */
|
|
1474
|
-
elapsedTime: number
|
|
1475
|
-
/** createdAt timestamp in ms */
|
|
1476
|
-
createdAt: number
|
|
1477
|
-
}
|
|
1478
|
-
|
|
1479
|
-
// Root Entry --------------------------------
|
|
1480
|
-
|
|
1481
|
-
/**
|
|
1482
|
-
* Internal representation of a registered root (Canvas).
|
|
1483
|
-
* Tracks jobs and manages rebuild state for this root.
|
|
1484
|
-
* @internal
|
|
1485
|
-
*/
|
|
1486
|
-
interface RootEntry {
|
|
1487
|
-
/** Unique identifier for this root */
|
|
1488
|
-
id: string
|
|
1489
|
-
/** Function to get the root's current state. Returns any to support independent mode. */
|
|
1490
|
-
getState: () => any
|
|
1491
|
-
/** Map of job IDs to Job objects */
|
|
1492
|
-
jobs: Map<string, Job>
|
|
1493
|
-
/** Cached sorted job list for execution order */
|
|
1494
|
-
sortedJobs: Job[]
|
|
1495
|
-
/** Whether sortedJobs needs rebuilding */
|
|
1496
|
-
needsRebuild: boolean
|
|
1497
|
-
}
|
|
1498
|
-
|
|
1499
|
-
/**
|
|
1500
|
-
* Internal representation of a global job (deprecated API).
|
|
1501
|
-
* Global jobs run once per frame, not per-root.
|
|
1502
|
-
* Used by legacy addEffect/addAfterEffect APIs.
|
|
1503
|
-
* @internal
|
|
1504
|
-
* @deprecated Use useFrame with phases instead
|
|
1505
|
-
*/
|
|
1506
|
-
interface GlobalJob {
|
|
1507
|
-
/** Unique identifier for this global job */
|
|
1508
|
-
id: string
|
|
1509
|
-
/** Callback invoked with RAF timestamp in ms */
|
|
1510
|
-
callback: (timestamp: number) => void
|
|
1511
|
-
}
|
|
1512
|
-
|
|
1513
|
-
// HMR Support --------------------------------
|
|
1514
|
-
|
|
1515
|
-
/**
|
|
1516
|
-
* Hot Module Replacement data structure for preserving scheduler state
|
|
1517
|
-
* @internal
|
|
1518
|
-
*/
|
|
1519
|
-
interface HMRData {
|
|
1520
|
-
/** Shared data object for storing values across reloads */
|
|
1521
|
-
data: Record<string, any>
|
|
1522
|
-
/** Optional function to accept HMR updates */
|
|
1523
|
-
accept?: () => void
|
|
1524
|
-
}
|
|
1525
|
-
|
|
1526
|
-
// Default Phases --------------------------------
|
|
1527
|
-
|
|
1528
|
-
/**
|
|
1529
|
-
* Default phase names for the scheduler
|
|
1530
|
-
*/
|
|
1531
|
-
type DefaultPhase = 'start' | 'input' | 'physics' | 'update' | 'render' | 'finish'
|
|
1532
|
-
}
|
|
1533
|
-
|
|
1534
1371
|
type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
|
|
1535
1372
|
|
|
1536
1373
|
interface MathRepresentation {
|
|
@@ -1700,7 +1537,7 @@ declare namespace three_d {
|
|
|
1700
1537
|
* a single WebGPURenderer using Three.js CanvasTarget API.
|
|
1701
1538
|
*
|
|
1702
1539
|
* Primary canvas: Has `id` prop, creates its own renderer, registers here
|
|
1703
|
-
* Secondary canvas: Has `
|
|
1540
|
+
* Secondary canvas: Has `renderer={{ primaryCanvas: 'id' }}`, shares primary's renderer via CanvasTarget
|
|
1704
1541
|
*/
|
|
1705
1542
|
|
|
1706
1543
|
interface PrimaryCanvasEntry {
|
|
@@ -1768,12 +1605,23 @@ type EnvironmentLoaderProps = {
|
|
|
1768
1605
|
* const texture = useEnvironment({ preset: 'sunset' })
|
|
1769
1606
|
* ```
|
|
1770
1607
|
*/
|
|
1771
|
-
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>;
|
|
1772
1609
|
declare namespace useEnvironment {
|
|
1773
1610
|
var preload: (preloadOptions?: EnvironmentLoaderPreloadOptions) => void;
|
|
1774
1611
|
var clear: (clearOptions?: EnvironmentLoaderClearOptions) => void;
|
|
1775
1612
|
}
|
|
1776
|
-
|
|
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'>;
|
|
1777
1625
|
type EnvironmentLoaderClearOptions = Pick<EnvironmentLoaderProps, 'files' | 'preset'>;
|
|
1778
1626
|
|
|
1779
1627
|
/**
|
|
@@ -1817,9 +1665,9 @@ type EnvironmentProps = {
|
|
|
1817
1665
|
blur?: number;
|
|
1818
1666
|
backgroundBlurriness?: number;
|
|
1819
1667
|
backgroundIntensity?: number;
|
|
1820
|
-
backgroundRotation?: Euler
|
|
1668
|
+
backgroundRotation?: Euler;
|
|
1821
1669
|
environmentIntensity?: number;
|
|
1822
|
-
environmentRotation?: Euler
|
|
1670
|
+
environmentRotation?: Euler;
|
|
1823
1671
|
map?: Texture$1;
|
|
1824
1672
|
preset?: PresetsType;
|
|
1825
1673
|
scene?: Scene | React$1.RefObject<Scene>;
|
|
@@ -1903,7 +1751,7 @@ declare function EnvironmentCube({ background, scene, blur, backgroundBlurriness
|
|
|
1903
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;
|
|
1904
1752
|
declare module '@react-three/fiber' {
|
|
1905
1753
|
interface ThreeElements {
|
|
1906
|
-
groundProjectedEnvImpl: ThreeElement
|
|
1754
|
+
groundProjectedEnvImpl: ThreeElement<typeof GroundedSkybox>;
|
|
1907
1755
|
}
|
|
1908
1756
|
}
|
|
1909
1757
|
/**
|
|
@@ -2003,9 +1851,29 @@ declare module '@react-three/fiber' {
|
|
|
2003
1851
|
*/
|
|
2004
1852
|
declare function Environment(props: EnvironmentProps): react_jsx_runtime.JSX.Element;
|
|
2005
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;
|
|
2006
1872
|
declare function removeInteractivity(store: RootStore, object: Object3D): void;
|
|
2007
1873
|
declare function createEvents(store: RootStore): {
|
|
2008
1874
|
handlePointer: (name: string) => (event: DomEvent) => void;
|
|
1875
|
+
flushDeferredPointers: () => void;
|
|
1876
|
+
processDeferredPointer: (event: DomEvent, pointerId: number) => void;
|
|
2009
1877
|
};
|
|
2010
1878
|
/** Default R3F event manager for web */
|
|
2011
1879
|
declare function createPointerEvents(store: RootStore): EventManager<HTMLElement>;
|
|
@@ -2021,419 +1889,13 @@ declare function getLoader<L extends LoaderLike | ConstructorRepresentation<Load
|
|
|
2021
1889
|
* Note: this hook's caller must be wrapped with `React.Suspense`
|
|
2022
1890
|
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useloader
|
|
2023
1891
|
*/
|
|
2024
|
-
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>;
|
|
2025
1893
|
declare namespace useLoader {
|
|
2026
|
-
var preload: <I extends InputLike, L extends LoaderLike | ConstructorRepresentation<LoaderLike>>(loader: L, input: I, extensions?: Extensions<L>, onProgress?: (event: ProgressEvent<EventTarget>) => void) => void;
|
|
2027
|
-
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;
|
|
2028
1896
|
var loader: typeof getLoader;
|
|
2029
1897
|
}
|
|
2030
1898
|
|
|
2031
|
-
/**
|
|
2032
|
-
* Global Singleton Scheduler - manages the frame loop and job execution for ALL R3F roots.
|
|
2033
|
-
*
|
|
2034
|
-
* Features:
|
|
2035
|
-
* - Single RAF loop for entire application
|
|
2036
|
-
* - Root registration (multiple Canvas support)
|
|
2037
|
-
* - Global phases for addEffect/addAfterEffect (deprecated)
|
|
2038
|
-
* - Per-root job management with phases, priorities, FPS throttling
|
|
2039
|
-
* - onIdle callbacks for addTail (deprecated)
|
|
2040
|
-
* - Demand mode support via invalidate()
|
|
2041
|
-
*/
|
|
2042
|
-
declare class Scheduler {
|
|
2043
|
-
private static readonly INSTANCE_KEY;
|
|
2044
|
-
private static get instance();
|
|
2045
|
-
private static set instance(value);
|
|
2046
|
-
/**
|
|
2047
|
-
* Get the global scheduler instance (creates if doesn't exist).
|
|
2048
|
-
* Uses HMR data to preserve instance across hot reloads.
|
|
2049
|
-
* @returns {Scheduler} The singleton scheduler instance
|
|
2050
|
-
*/
|
|
2051
|
-
static get(): Scheduler;
|
|
2052
|
-
/**
|
|
2053
|
-
* Reset the singleton instance. Stops the loop and clears all state.
|
|
2054
|
-
* Primarily used for testing to ensure clean state between tests.
|
|
2055
|
-
* @returns {void}
|
|
2056
|
-
*/
|
|
2057
|
-
static reset(): void;
|
|
2058
|
-
private roots;
|
|
2059
|
-
private phaseGraph;
|
|
2060
|
-
private loopState;
|
|
2061
|
-
private stoppedTime;
|
|
2062
|
-
private nextRootIndex;
|
|
2063
|
-
private globalBeforeJobs;
|
|
2064
|
-
private globalAfterJobs;
|
|
2065
|
-
private nextGlobalIndex;
|
|
2066
|
-
private idleCallbacks;
|
|
2067
|
-
private nextJobIndex;
|
|
2068
|
-
private jobStateListeners;
|
|
2069
|
-
private pendingFrames;
|
|
2070
|
-
private _frameloop;
|
|
2071
|
-
private _independent;
|
|
2072
|
-
private errorHandler;
|
|
2073
|
-
private rootReadyCallbacks;
|
|
2074
|
-
get phases(): string[];
|
|
2075
|
-
get frameloop(): Frameloop;
|
|
2076
|
-
set frameloop(mode: Frameloop);
|
|
2077
|
-
get isRunning(): boolean;
|
|
2078
|
-
get isReady(): boolean;
|
|
2079
|
-
get independent(): boolean;
|
|
2080
|
-
set independent(value: boolean);
|
|
2081
|
-
constructor();
|
|
2082
|
-
/**
|
|
2083
|
-
* Register a root (Canvas) with the scheduler.
|
|
2084
|
-
* The first root to register starts the RAF loop (if frameloop='always').
|
|
2085
|
-
* @param {string} id - Unique identifier for this root
|
|
2086
|
-
* @param {RootOptions} [options] - Optional configuration with getState and onError callbacks
|
|
2087
|
-
* @returns {() => void} Unsubscribe function to remove this root
|
|
2088
|
-
*/
|
|
2089
|
-
registerRoot(id: string, options?: RootOptions): () => void;
|
|
2090
|
-
/**
|
|
2091
|
-
* Unregister a root from the scheduler.
|
|
2092
|
-
* Cleans up all job state listeners for this root's jobs.
|
|
2093
|
-
* The last root to unregister stops the RAF loop.
|
|
2094
|
-
* @param {string} id - The root ID to unregister
|
|
2095
|
-
* @returns {void}
|
|
2096
|
-
*/
|
|
2097
|
-
unregisterRoot(id: string): void;
|
|
2098
|
-
/**
|
|
2099
|
-
* Subscribe to be notified when a root becomes available.
|
|
2100
|
-
* Fires immediately if a root already exists.
|
|
2101
|
-
* @param {() => void} callback - Function called when first root registers
|
|
2102
|
-
* @returns {() => void} Unsubscribe function
|
|
2103
|
-
*/
|
|
2104
|
-
onRootReady(callback: () => void): () => void;
|
|
2105
|
-
/**
|
|
2106
|
-
* Notify all registered root-ready callbacks.
|
|
2107
|
-
* Called when the first root registers.
|
|
2108
|
-
* @returns {void}
|
|
2109
|
-
* @private
|
|
2110
|
-
*/
|
|
2111
|
-
private notifyRootReady;
|
|
2112
|
-
/**
|
|
2113
|
-
* Ensure a default root exists for independent mode.
|
|
2114
|
-
* Creates a minimal root with no state provider.
|
|
2115
|
-
* @returns {void}
|
|
2116
|
-
* @private
|
|
2117
|
-
*/
|
|
2118
|
-
private ensureDefaultRoot;
|
|
2119
|
-
/**
|
|
2120
|
-
* Trigger error handling for job errors.
|
|
2121
|
-
* Uses the bound error handler if available, otherwise logs to console.
|
|
2122
|
-
* @param {Error} error - The error to handle
|
|
2123
|
-
* @returns {void}
|
|
2124
|
-
*/
|
|
2125
|
-
triggerError(error: Error): void;
|
|
2126
|
-
/**
|
|
2127
|
-
* Add a named phase to the scheduler's execution order.
|
|
2128
|
-
* Marks all roots for rebuild to incorporate the new phase.
|
|
2129
|
-
* @param {string} name - The phase name (e.g., 'physics', 'postprocess')
|
|
2130
|
-
* @param {AddPhaseOptions} [options] - Positioning options (before/after other phases)
|
|
2131
|
-
* @returns {void}
|
|
2132
|
-
* @example
|
|
2133
|
-
* scheduler.addPhase('physics', { before: 'update' });
|
|
2134
|
-
* scheduler.addPhase('postprocess', { after: 'render' });
|
|
2135
|
-
*/
|
|
2136
|
-
addPhase(name: string, options?: AddPhaseOptions): void;
|
|
2137
|
-
/**
|
|
2138
|
-
* Check if a phase exists in the scheduler.
|
|
2139
|
-
* @param {string} name - The phase name to check
|
|
2140
|
-
* @returns {boolean} True if the phase exists
|
|
2141
|
-
*/
|
|
2142
|
-
hasPhase(name: string): boolean;
|
|
2143
|
-
/**
|
|
2144
|
-
* Register a global job that runs once per frame (not per-root).
|
|
2145
|
-
* Used internally by deprecated addEffect/addAfterEffect APIs.
|
|
2146
|
-
* @param {'before' | 'after'} phase - When to run: 'before' all roots or 'after' all roots
|
|
2147
|
-
* @param {string} id - Unique identifier for this global job
|
|
2148
|
-
* @param {(timestamp: number) => void} callback - Function called each frame with RAF timestamp
|
|
2149
|
-
* @returns {() => void} Unsubscribe function to remove this global job
|
|
2150
|
-
* @deprecated Use useFrame with phases instead
|
|
2151
|
-
*/
|
|
2152
|
-
registerGlobal(phase: 'before' | 'after', id: string, callback: (timestamp: number) => void): () => void;
|
|
2153
|
-
/**
|
|
2154
|
-
* Register an idle callback that fires when the loop stops.
|
|
2155
|
-
* Used internally by deprecated addTail API.
|
|
2156
|
-
* @param {(timestamp: number) => void} callback - Function called when loop becomes idle
|
|
2157
|
-
* @returns {() => void} Unsubscribe function to remove this idle callback
|
|
2158
|
-
* @deprecated Use demand mode with invalidate() instead
|
|
2159
|
-
*/
|
|
2160
|
-
onIdle(callback: (timestamp: number) => void): () => void;
|
|
2161
|
-
/**
|
|
2162
|
-
* Notify all registered idle callbacks.
|
|
2163
|
-
* Called when the loop stops in demand mode.
|
|
2164
|
-
* @param {number} timestamp - The RAF timestamp when idle occurred
|
|
2165
|
-
* @returns {void}
|
|
2166
|
-
* @private
|
|
2167
|
-
*/
|
|
2168
|
-
private notifyIdle;
|
|
2169
|
-
/**
|
|
2170
|
-
* Register a job (frame callback) with a specific root.
|
|
2171
|
-
* This is the core registration method used by useFrame internally.
|
|
2172
|
-
* @param {FrameNextCallback} callback - The function to call each frame
|
|
2173
|
-
* @param {JobOptions & { rootId?: string; system?: boolean }} [options] - Job configuration
|
|
2174
|
-
* @param {string} [options.rootId] - Target root ID (defaults to first registered root)
|
|
2175
|
-
* @param {string} [options.id] - Unique job ID (auto-generated if not provided)
|
|
2176
|
-
* @param {string} [options.phase] - Execution phase (defaults to 'update')
|
|
2177
|
-
* @param {number} [options.priority] - Priority within phase (higher = earlier, default 0)
|
|
2178
|
-
* @param {number} [options.fps] - FPS throttle limit
|
|
2179
|
-
* @param {boolean} [options.drop] - Drop frames when behind (default true)
|
|
2180
|
-
* @param {boolean} [options.enabled] - Whether job is active (default true)
|
|
2181
|
-
* @param {boolean} [options.system] - Internal flag for system jobs (not user-facing)
|
|
2182
|
-
* @returns {() => void} Unsubscribe function to remove this job
|
|
2183
|
-
*/
|
|
2184
|
-
register(callback: FrameNextCallback, options?: JobOptions & {
|
|
2185
|
-
rootId?: string;
|
|
2186
|
-
system?: boolean;
|
|
2187
|
-
}): () => void;
|
|
2188
|
-
/**
|
|
2189
|
-
* Unregister a job by its ID.
|
|
2190
|
-
* Searches all roots if rootId is not provided.
|
|
2191
|
-
* @param {string} id - The job ID to unregister
|
|
2192
|
-
* @param {string} [rootId] - Optional root ID to search (searches all if not provided)
|
|
2193
|
-
* @returns {void}
|
|
2194
|
-
*/
|
|
2195
|
-
unregister(id: string, rootId?: string): void;
|
|
2196
|
-
/**
|
|
2197
|
-
* Update a job's options dynamically.
|
|
2198
|
-
* Searches all roots to find the job by ID.
|
|
2199
|
-
* Phase/constraint changes trigger a rebuild of the sorted job list.
|
|
2200
|
-
* @param {string} id - The job ID to update
|
|
2201
|
-
* @param {Partial<JobOptions>} options - The options to update
|
|
2202
|
-
* @returns {void}
|
|
2203
|
-
*/
|
|
2204
|
-
updateJob(id: string, options: Partial<JobOptions>): void;
|
|
2205
|
-
/**
|
|
2206
|
-
* Check if a job is currently paused (disabled).
|
|
2207
|
-
* @param {string} id - The job ID to check
|
|
2208
|
-
* @returns {boolean} True if the job exists and is paused
|
|
2209
|
-
*/
|
|
2210
|
-
isJobPaused(id: string): boolean;
|
|
2211
|
-
/**
|
|
2212
|
-
* Subscribe to state changes for a specific job.
|
|
2213
|
-
* Listener is called when job is paused or resumed.
|
|
2214
|
-
* @param {string} id - The job ID to subscribe to
|
|
2215
|
-
* @param {() => void} listener - Callback invoked on state changes
|
|
2216
|
-
* @returns {() => void} Unsubscribe function
|
|
2217
|
-
*/
|
|
2218
|
-
subscribeJobState(id: string, listener: () => void): () => void;
|
|
2219
|
-
/**
|
|
2220
|
-
* Notify all listeners that a job's state has changed.
|
|
2221
|
-
* @param {string} id - The job ID that changed
|
|
2222
|
-
* @returns {void}
|
|
2223
|
-
* @private
|
|
2224
|
-
*/
|
|
2225
|
-
private notifyJobStateChange;
|
|
2226
|
-
/**
|
|
2227
|
-
* Pause a job by ID (sets enabled=false).
|
|
2228
|
-
* Notifies any subscribed state listeners.
|
|
2229
|
-
* @param {string} id - The job ID to pause
|
|
2230
|
-
* @returns {void}
|
|
2231
|
-
*/
|
|
2232
|
-
pauseJob(id: string): void;
|
|
2233
|
-
/**
|
|
2234
|
-
* Resume a paused job by ID (sets enabled=true).
|
|
2235
|
-
* Resets job timing to prevent frame accumulation.
|
|
2236
|
-
* Notifies any subscribed state listeners.
|
|
2237
|
-
* @param {string} id - The job ID to resume
|
|
2238
|
-
* @returns {void}
|
|
2239
|
-
*/
|
|
2240
|
-
resumeJob(id: string): void;
|
|
2241
|
-
/**
|
|
2242
|
-
* Start the requestAnimationFrame loop.
|
|
2243
|
-
* Resets timing state (elapsedTime, frameCount) on start.
|
|
2244
|
-
* No-op if already running.
|
|
2245
|
-
* @returns {void}
|
|
2246
|
-
*/
|
|
2247
|
-
start(): void;
|
|
2248
|
-
/**
|
|
2249
|
-
* Stop the requestAnimationFrame loop.
|
|
2250
|
-
* Cancels any pending RAF callback.
|
|
2251
|
-
* No-op if not running.
|
|
2252
|
-
* @returns {void}
|
|
2253
|
-
*/
|
|
2254
|
-
stop(): void;
|
|
2255
|
-
/**
|
|
2256
|
-
* Request frames to be rendered in demand mode.
|
|
2257
|
-
* Accumulates pending frames (capped at 60) and starts the loop if not running.
|
|
2258
|
-
* No-op if frameloop is not 'demand'.
|
|
2259
|
-
* @param {number} [frames=1] - Number of frames to request
|
|
2260
|
-
* @param {boolean} [stackFrames=false] - Whether to add frames to existing pending count
|
|
2261
|
-
* - `false` (default): Sets pending frames to the specified value (replaces existing count)
|
|
2262
|
-
* - `true`: Adds frames to existing pending count (useful for accumulating invalidations)
|
|
2263
|
-
* @returns {void}
|
|
2264
|
-
* @example
|
|
2265
|
-
* // Request a single frame render
|
|
2266
|
-
* scheduler.invalidate();
|
|
2267
|
-
*
|
|
2268
|
-
* @example
|
|
2269
|
-
* // Request 5 frames (e.g., for animations)
|
|
2270
|
-
* scheduler.invalidate(5);
|
|
2271
|
-
*
|
|
2272
|
-
* @example
|
|
2273
|
-
* // Set pending frames to exactly 3 (don't stack with existing)
|
|
2274
|
-
* scheduler.invalidate(3, false);
|
|
2275
|
-
*
|
|
2276
|
-
* @example
|
|
2277
|
-
* // Add 2 more frames to existing pending count
|
|
2278
|
-
* scheduler.invalidate(2, true);
|
|
2279
|
-
*/
|
|
2280
|
-
invalidate(frames?: number, stackFrames?: boolean): void;
|
|
2281
|
-
/**
|
|
2282
|
-
* Reset timing state for deterministic testing.
|
|
2283
|
-
* Preserves jobs and roots but resets lastTime, frameCount, elapsedTime, etc.
|
|
2284
|
-
* @returns {void}
|
|
2285
|
-
*/
|
|
2286
|
-
resetTiming(): void;
|
|
2287
|
-
/**
|
|
2288
|
-
* Manually execute a single frame for all roots.
|
|
2289
|
-
* Useful for frameloop='never' mode or testing scenarios.
|
|
2290
|
-
* @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
|
|
2291
|
-
* @returns {void}
|
|
2292
|
-
* @example
|
|
2293
|
-
* // Manual control mode
|
|
2294
|
-
* scheduler.frameloop = 'never';
|
|
2295
|
-
* scheduler.step(); // Execute one frame
|
|
2296
|
-
*/
|
|
2297
|
-
step(timestamp?: number): void;
|
|
2298
|
-
/**
|
|
2299
|
-
* Manually execute a single job by its ID.
|
|
2300
|
-
* Useful for testing individual job callbacks in isolation.
|
|
2301
|
-
* @param {string} id - The job ID to step
|
|
2302
|
-
* @param {number} [timestamp] - Optional timestamp (defaults to performance.now())
|
|
2303
|
-
* @returns {void}
|
|
2304
|
-
*/
|
|
2305
|
-
stepJob(id: string, timestamp?: number): void;
|
|
2306
|
-
/**
|
|
2307
|
-
* Main RAF loop callback.
|
|
2308
|
-
* Executes frame, handles demand mode, and schedules next frame.
|
|
2309
|
-
* @param {number} timestamp - RAF timestamp in milliseconds
|
|
2310
|
-
* @returns {void}
|
|
2311
|
-
* @private
|
|
2312
|
-
*/
|
|
2313
|
-
private loop;
|
|
2314
|
-
/**
|
|
2315
|
-
* Execute a single frame across all roots.
|
|
2316
|
-
* Order: globalBefore → each root's jobs → globalAfter
|
|
2317
|
-
* @param {number} timestamp - RAF timestamp in milliseconds
|
|
2318
|
-
* @returns {void}
|
|
2319
|
-
* @private
|
|
2320
|
-
*/
|
|
2321
|
-
private executeFrame;
|
|
2322
|
-
/**
|
|
2323
|
-
* Run all global jobs from a job map.
|
|
2324
|
-
* Catches and logs errors without stopping execution.
|
|
2325
|
-
* @param {Map<string, GlobalJob>} jobs - The global jobs map to execute
|
|
2326
|
-
* @param {number} timestamp - RAF timestamp in milliseconds
|
|
2327
|
-
* @returns {void}
|
|
2328
|
-
* @private
|
|
2329
|
-
*/
|
|
2330
|
-
private runGlobalJobs;
|
|
2331
|
-
/**
|
|
2332
|
-
* Execute all jobs for a single root in sorted order.
|
|
2333
|
-
* Rebuilds sorted job list if needed, then dispatches each job.
|
|
2334
|
-
* Errors are caught and propagated via triggerError.
|
|
2335
|
-
* @param {RootEntry} root - The root entry to tick
|
|
2336
|
-
* @param {number} timestamp - RAF timestamp in milliseconds
|
|
2337
|
-
* @param {number} delta - Time since last frame in seconds
|
|
2338
|
-
* @returns {void}
|
|
2339
|
-
* @private
|
|
2340
|
-
*/
|
|
2341
|
-
private tickRoot;
|
|
2342
|
-
/**
|
|
2343
|
-
* Get the total number of registered jobs across all roots.
|
|
2344
|
-
* Includes both per-root jobs and global before/after jobs.
|
|
2345
|
-
* @returns {number} Total job count
|
|
2346
|
-
*/
|
|
2347
|
-
getJobCount(): number;
|
|
2348
|
-
/**
|
|
2349
|
-
* Get all registered job IDs across all roots.
|
|
2350
|
-
* Includes both per-root jobs and global before/after jobs.
|
|
2351
|
-
* @returns {string[]} Array of all job IDs
|
|
2352
|
-
*/
|
|
2353
|
-
getJobIds(): string[];
|
|
2354
|
-
/**
|
|
2355
|
-
* Get the number of registered roots (Canvas instances).
|
|
2356
|
-
* @returns {number} Number of registered roots
|
|
2357
|
-
*/
|
|
2358
|
-
getRootCount(): number;
|
|
2359
|
-
/**
|
|
2360
|
-
* Check if any user (non-system) jobs are registered in a specific phase.
|
|
2361
|
-
* Used by the default render job to know if a user has taken over rendering.
|
|
2362
|
-
*
|
|
2363
|
-
* @param phase The phase to check
|
|
2364
|
-
* @param rootId Optional root ID to check (checks all roots if not provided)
|
|
2365
|
-
* @returns true if any user jobs exist in the phase
|
|
2366
|
-
*/
|
|
2367
|
-
hasUserJobsInPhase(phase: string, rootId?: string): boolean;
|
|
2368
|
-
/**
|
|
2369
|
-
* Generate a unique root ID for automatic root registration.
|
|
2370
|
-
* @returns {string} A unique root ID in the format 'root_N'
|
|
2371
|
-
*/
|
|
2372
|
-
generateRootId(): string;
|
|
2373
|
-
/**
|
|
2374
|
-
* Generate a unique job ID.
|
|
2375
|
-
* @returns {string} A unique job ID in the format 'job_N'
|
|
2376
|
-
* @private
|
|
2377
|
-
*/
|
|
2378
|
-
private generateJobId;
|
|
2379
|
-
/**
|
|
2380
|
-
* Normalize before/after constraints to a Set.
|
|
2381
|
-
* Handles undefined, single string, or array inputs.
|
|
2382
|
-
* @param {string | string[] | undefined} value - The constraint value(s)
|
|
2383
|
-
* @returns {Set<string>} Normalized Set of constraint strings
|
|
2384
|
-
* @private
|
|
2385
|
-
*/
|
|
2386
|
-
private normalizeConstraints;
|
|
2387
|
-
}
|
|
2388
|
-
/**
|
|
2389
|
-
* Get the global scheduler instance.
|
|
2390
|
-
* Creates one if it doesn't exist.
|
|
2391
|
-
*/
|
|
2392
|
-
declare const getScheduler: () => Scheduler;
|
|
2393
|
-
|
|
2394
|
-
/**
|
|
2395
|
-
* Frame hook with phase-based ordering, priority, and FPS throttling.
|
|
2396
|
-
*
|
|
2397
|
-
* Works both inside and outside Canvas context:
|
|
2398
|
-
* - Inside Canvas: Full RootState (gl, scene, camera, etc.)
|
|
2399
|
-
* - Outside Canvas (waiting mode): Waits for Canvas to mount, then gets full state
|
|
2400
|
-
* - Outside Canvas (independent mode): Fires immediately with timing-only state
|
|
2401
|
-
*
|
|
2402
|
-
* Returns a controls object for manual stepping, pausing, and resuming.
|
|
2403
|
-
*
|
|
2404
|
-
* @param callback - Function called each frame with (state, delta). Optional if you only need scheduler access.
|
|
2405
|
-
* @param priorityOrOptions - Either a priority number (backwards compat) or options object
|
|
2406
|
-
* @returns Controls object with step(), stepAll(), pause(), resume(), isPaused, id, scheduler
|
|
2407
|
-
*
|
|
2408
|
-
* @example
|
|
2409
|
-
* // Simple priority (backwards compat)
|
|
2410
|
-
* useFrame((state, delta) => { ... }, 5)
|
|
2411
|
-
*
|
|
2412
|
-
* @example
|
|
2413
|
-
* // With phase-based ordering
|
|
2414
|
-
* useFrame((state, delta) => { ... }, { phase: 'physics' })
|
|
2415
|
-
*
|
|
2416
|
-
* @example
|
|
2417
|
-
* // Outside Canvas - waits for Canvas to mount
|
|
2418
|
-
* function UI() {
|
|
2419
|
-
* useFrame((state, delta) => { syncUI(state.camera) });
|
|
2420
|
-
* return <button>...</button>;
|
|
2421
|
-
* }
|
|
2422
|
-
*
|
|
2423
|
-
* @example
|
|
2424
|
-
* // Independent mode - no Canvas needed
|
|
2425
|
-
* getScheduler().independent = true;
|
|
2426
|
-
* useFrame((state, delta) => { updateGame(delta) });
|
|
2427
|
-
*
|
|
2428
|
-
* @example
|
|
2429
|
-
* // Scheduler-only access (no callback)
|
|
2430
|
-
* const { scheduler } = useFrame()
|
|
2431
|
-
* scheduler.pauseJob('some-job-id')
|
|
2432
|
-
*
|
|
2433
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useframe
|
|
2434
|
-
*/
|
|
2435
|
-
declare function useFrame(callback?: FrameNextCallback, priorityOrOptions?: number | UseFrameNextOptions): FrameNextControls;
|
|
2436
|
-
|
|
2437
1899
|
declare const IsObject: (url: unknown) => url is Record<string, string>;
|
|
2438
1900
|
type TextureArray<T> = T extends string[] ? Texture$1[] : never;
|
|
2439
1901
|
type TextureRecord<T> = T extends Record<string, string> ? {
|
|
@@ -2446,11 +1908,16 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
|
|
|
2446
1908
|
/** Callback when texture(s) finish loading */
|
|
2447
1909
|
onLoad?: (texture: MappedTextureType<Url>) => void;
|
|
2448
1910
|
/**
|
|
2449
|
-
*
|
|
2450
|
-
* When true:
|
|
1911
|
+
* Register the texture(s) in R3F's global texture registry for access via useTextures().
|
|
1912
|
+
* When true (the default):
|
|
2451
1913
|
* - Textures persist until explicitly disposed
|
|
2452
|
-
* -
|
|
2453
|
-
*
|
|
1914
|
+
* - On mount, returns existing registered textures if available (preserving modifications like colorSpace)
|
|
1915
|
+
*
|
|
1916
|
+
* Reads are taken once at mount — a mounted `useTexture` does not re-render when the registry
|
|
1917
|
+
* changes. To react to registry swaps, use `useTextures(s => s.get(key))` instead.
|
|
1918
|
+
*
|
|
1919
|
+
* Pass `false` to opt out of registry enrollment entirely.
|
|
1920
|
+
* @default true
|
|
2454
1921
|
*/
|
|
2455
1922
|
cache?: boolean;
|
|
2456
1923
|
};
|
|
@@ -2474,15 +1941,18 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
|
|
|
2474
1941
|
* normal: '/normal.png'
|
|
2475
1942
|
* })
|
|
2476
1943
|
*
|
|
2477
|
-
* //
|
|
2478
|
-
* //
|
|
2479
|
-
* const diffuse = useTexture('/diffuse.png'
|
|
1944
|
+
* // Textures are registered in the global registry by default — the same texture
|
|
1945
|
+
* // object is shared across components and modifications (colorSpace, wrapS, etc.) are preserved
|
|
1946
|
+
* const diffuse = useTexture('/diffuse.png')
|
|
2480
1947
|
* diffuse.colorSpace = THREE.SRGBColorSpace
|
|
2481
1948
|
*
|
|
2482
1949
|
* // Another component gets the SAME texture with colorSpace already set
|
|
2483
|
-
* const sameDiffuse = useTexture('/diffuse.png'
|
|
1950
|
+
* const sameDiffuse = useTexture('/diffuse.png')
|
|
1951
|
+
*
|
|
1952
|
+
* // Opt out of registry enrollment for a one-off texture
|
|
1953
|
+
* const scratch = useTexture('/scratch.png', { cache: false })
|
|
2484
1954
|
*
|
|
2485
|
-
* // Access
|
|
1955
|
+
* // Access the registry directly
|
|
2486
1956
|
* const { get } = useTextures()
|
|
2487
1957
|
* const cached = get('/diffuse.png')
|
|
2488
1958
|
* ```
|
|
@@ -2499,63 +1969,80 @@ declare const Texture: ({ children, input, onLoad, cache, }: {
|
|
|
2499
1969
|
cache?: boolean;
|
|
2500
1970
|
}) => react_jsx_runtime.JSX.Element;
|
|
2501
1971
|
|
|
2502
|
-
|
|
2503
|
-
|
|
2504
|
-
|
|
1972
|
+
/** Accepted shapes for a registry read: a single key, a list of keys, or a name→key map. */
|
|
1973
|
+
type TextureInput = string | string[] | Record<string, string>;
|
|
1974
|
+
/** Result of a `get()` read, mirroring the input shape. */
|
|
1975
|
+
type TextureResult<Input extends TextureInput> = Input extends string ? Texture$1 | undefined : Input extends string[] ? (Texture$1 | undefined)[] : {
|
|
1976
|
+
[K in keyof Input]: Texture$1 | undefined;
|
|
2505
1977
|
};
|
|
1978
|
+
/** Options for `dispose()`. */
|
|
1979
|
+
interface DisposeOptions {
|
|
1980
|
+
/** Dispose even if the texture still has active references (default false). */
|
|
1981
|
+
force?: boolean;
|
|
1982
|
+
}
|
|
2506
1983
|
interface UseTexturesReturn {
|
|
2507
|
-
/** Map
|
|
2508
|
-
|
|
2509
|
-
/**
|
|
2510
|
-
get
|
|
2511
|
-
/** Check
|
|
2512
|
-
has
|
|
2513
|
-
/**
|
|
2514
|
-
|
|
2515
|
-
|
|
2516
|
-
|
|
2517
|
-
|
|
2518
|
-
|
|
2519
|
-
|
|
2520
|
-
|
|
2521
|
-
|
|
2522
|
-
|
|
2523
|
-
|
|
2524
|
-
|
|
2525
|
-
|
|
2526
|
-
|
|
1984
|
+
/** The live registry Map (key → Texture). Treat as read-only. */
|
|
1985
|
+
readonly all: Map<string, Texture$1>;
|
|
1986
|
+
/** Read one texture, an array of textures, or a name→texture record (mirrors the input shape). */
|
|
1987
|
+
get<Input extends TextureInput>(input: Input): TextureResult<Input>;
|
|
1988
|
+
/** Check whether a key exists in the registry. */
|
|
1989
|
+
has(key: string): boolean;
|
|
1990
|
+
/**
|
|
1991
|
+
* Register a texture (or a record of textures) that has no URL — e.g. a render
|
|
1992
|
+
* target or procedural texture. URL-loaded textures are registered automatically
|
|
1993
|
+
* by `useTexture` (registry enrollment is on by default).
|
|
1994
|
+
*/
|
|
1995
|
+
add(key: string, texture: Texture$1): void;
|
|
1996
|
+
add(record: Record<string, Texture$1>): void;
|
|
1997
|
+
/**
|
|
1998
|
+
* Dispose a texture's GPU resources and remove it from the registry.
|
|
1999
|
+
* Refcount-aware: if the key is still in use by a mounted `useTexture` consumer it is
|
|
2000
|
+
* skipped (with a warning) unless `{ force: true }` is passed.
|
|
2001
|
+
* @returns true if disposed, false if skipped.
|
|
2002
|
+
*/
|
|
2003
|
+
dispose(key: string, options?: DisposeOptions): boolean;
|
|
2004
|
+
/** Dispose every texture in the registry and clear it. Use on scene teardown. */
|
|
2005
|
+
disposeAll(): void;
|
|
2527
2006
|
}
|
|
2528
2007
|
/**
|
|
2529
|
-
*
|
|
2008
|
+
* Reactive Texture registry — load once with `useTexture`, reach the textures from anywhere.
|
|
2530
2009
|
*
|
|
2531
|
-
*
|
|
2532
|
-
*
|
|
2010
|
+
* This is a registry of plain `Texture` objects (not TSL nodes), so the same texture can feed
|
|
2011
|
+
* a material map, a heightmap sampler, or anything else. It does **not** load — pair it with
|
|
2012
|
+
* `useTexture` for loading (registry enrollment is on by default); `useTextures` is for access and lifecycle.
|
|
2013
|
+
*
|
|
2014
|
+
* The returned handle is **reactive**: the calling component re-renders when the registry
|
|
2015
|
+
* changes. Pass a selector to scope the subscription to a single read.
|
|
2533
2016
|
*
|
|
2534
2017
|
* @example
|
|
2535
2018
|
* ```tsx
|
|
2536
|
-
*
|
|
2019
|
+
* // Load + register once (anywhere in the tree) — registered by default
|
|
2020
|
+
* useTexture({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
|
|
2537
2021
|
*
|
|
2538
|
-
* //
|
|
2539
|
-
*
|
|
2540
|
-
*
|
|
2541
|
-
* const tex = useTexture('/textures/diffuse.png', { cache: true })
|
|
2542
|
-
* }
|
|
2022
|
+
* // Reach them from another component — record form lands straight into a material
|
|
2023
|
+
* const { map, normalMap } = useTextures().get({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
|
|
2024
|
+
* return <meshStandardMaterial map={map} normalMap={normalMap} />
|
|
2543
2025
|
*
|
|
2544
|
-
* //
|
|
2545
|
-
* const
|
|
2546
|
-
* if (diffuse) material.map = diffuse
|
|
2026
|
+
* // A set of heightmaps at once
|
|
2027
|
+
* const [a, b, c] = useTextures().get(['/h0.png', '/h1.png', '/h2.png'])
|
|
2547
2028
|
*
|
|
2548
|
-
* //
|
|
2549
|
-
*
|
|
2029
|
+
* // Register a non-URL texture (render target / procedural)
|
|
2030
|
+
* useTextures().add('rt-main', renderTarget.texture)
|
|
2550
2031
|
*
|
|
2551
|
-
* //
|
|
2552
|
-
* dispose('/
|
|
2553
|
-
*
|
|
2554
|
-
* // Nuclear option - dispose everything
|
|
2555
|
-
* disposeAll()
|
|
2032
|
+
* // Deliberate GPU cleanup (refcount-aware; force to override)
|
|
2033
|
+
* useTextures().dispose('/diffuse.jpg')
|
|
2034
|
+
* useTextures().disposeAll() // scene teardown
|
|
2556
2035
|
* ```
|
|
2036
|
+
*
|
|
2037
|
+
* @remarks
|
|
2038
|
+
* **Future expansion:** an imperative async loader (e.g. `await useTextures().load('/x.jpg')`) is
|
|
2039
|
+
* intentionally not included yet. It would let non-React code (loading screens, dynamic streaming)
|
|
2040
|
+
* populate the registry without Suspense, at the cost of putting loading back into this hook. It
|
|
2041
|
+
* will be added only if a concrete consumer needs imperative loading; for now, loading lives in
|
|
2042
|
+
* `useTexture`.
|
|
2557
2043
|
*/
|
|
2558
2044
|
declare function useTextures(): UseTexturesReturn;
|
|
2045
|
+
declare function useTextures<T>(selector: (registry: UseTexturesReturn) => T): T;
|
|
2559
2046
|
|
|
2560
2047
|
/**
|
|
2561
2048
|
* Creates a render target compatible with the current renderer.
|
|
@@ -2585,20 +2072,15 @@ declare function useTextures(): UseTexturesReturn;
|
|
|
2585
2072
|
* const fbo = useRenderTarget(512, 256, { samples: 4 })
|
|
2586
2073
|
* ```
|
|
2587
2074
|
*/
|
|
2588
|
-
declare function useRenderTarget(options?: RenderTargetOptions): RenderTarget
|
|
2589
|
-
declare function useRenderTarget(size: number, options?: RenderTargetOptions): RenderTarget
|
|
2590
|
-
declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): RenderTarget
|
|
2075
|
+
declare function useRenderTarget(options?: RenderTargetOptions): RenderTarget;
|
|
2076
|
+
declare function useRenderTarget(size: number, options?: RenderTargetOptions): RenderTarget;
|
|
2077
|
+
declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): RenderTarget;
|
|
2591
2078
|
|
|
2592
2079
|
/**
|
|
2593
2080
|
* Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
|
|
2594
2081
|
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usestore
|
|
2595
2082
|
*/
|
|
2596
2083
|
declare function useStore(): RootStore;
|
|
2597
|
-
/**
|
|
2598
|
-
* Accesses R3F's internal state, containing renderer, canvas, scene, etc.
|
|
2599
|
-
* @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usethree
|
|
2600
|
-
*/
|
|
2601
|
-
declare function useThree<T = RootState>(selector?: (state: RootState) => T, equalityFn?: <T>(state: T, newState: T) => boolean): T;
|
|
2602
2084
|
/**
|
|
2603
2085
|
* Exposes an object's {@link Instance}.
|
|
2604
2086
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#useInstanceHandle
|
|
@@ -2674,7 +2156,10 @@ declare function addTail(callback: GlobalRenderCallback): () => void;
|
|
|
2674
2156
|
* Invalidates the view, requesting a frame to be rendered.
|
|
2675
2157
|
* In demand mode, this triggers the scheduler to run frames.
|
|
2676
2158
|
*
|
|
2677
|
-
*
|
|
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
|
|
2678
2163
|
* @param frames - Number of frames to request (default: 1)
|
|
2679
2164
|
* @param stackFrames - If false, sets pendingFrames to frames. If true, adds to existing pendingFrames (default: false)
|
|
2680
2165
|
*
|
|
@@ -2685,14 +2170,16 @@ declare function invalidate(state?: RootState, frames?: number, stackFrames?: bo
|
|
|
2685
2170
|
* Advances the frameloop and runs render effects.
|
|
2686
2171
|
* Useful for when manually rendering via `frameloop="never"`.
|
|
2687
2172
|
*
|
|
2173
|
+
* With a state argument, only that root is stepped. Without one, every
|
|
2174
|
+
* registered root is stepped for backwards compatibility.
|
|
2175
|
+
*
|
|
2688
2176
|
* @param timestamp - The timestamp to use for this frame
|
|
2689
2177
|
* @param runGlobalEffects - Ignored (kept for backwards compat, global effects always run)
|
|
2690
|
-
* @param state -
|
|
2691
|
-
* @param frame - Ignored (kept for backwards compat)
|
|
2178
|
+
* @param state - Optional root state; targets the manual step at that root
|
|
2692
2179
|
*
|
|
2693
2180
|
* @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
|
|
2694
2181
|
*/
|
|
2695
|
-
declare function advance(timestamp: number): void;
|
|
2182
|
+
declare function advance(timestamp: number, runGlobalEffects?: boolean, state?: RootState): void;
|
|
2696
2183
|
|
|
2697
2184
|
/* eslint-disable @definitelytyped/no-unnecessary-generics */
|
|
2698
2185
|
declare function ReactReconciler<
|
|
@@ -3763,11 +3250,6 @@ declare function flushSync<R>(fn: () => R): R;
|
|
|
3763
3250
|
declare const context: React$1.Context<RootStore>;
|
|
3764
3251
|
declare const createStore: (invalidate: (state?: RootState, frames?: number, stackFrames?: boolean) => void, advance: (timestamp: number, runGlobalEffects?: boolean, state?: RootState, frame?: XRFrame) => void) => RootStore;
|
|
3765
3252
|
|
|
3766
|
-
/**
|
|
3767
|
-
* Safely flush async effects when testing, simulating a legacy root.
|
|
3768
|
-
* @deprecated Import from React instead. import { act } from 'react'
|
|
3769
|
-
*/
|
|
3770
|
-
declare const act: typeof React$1.act;
|
|
3771
3253
|
/**
|
|
3772
3254
|
* An SSR-friendly useLayoutEffect.
|
|
3773
3255
|
*
|
|
@@ -4300,13 +3782,17 @@ type ScopedStoreType<T> = {
|
|
|
4300
3782
|
declare function createScopedStore<T>(data: Record<string, any>): ScopedStoreType<T>;
|
|
4301
3783
|
/**
|
|
4302
3784
|
* State type passed to creator functions with ScopedStore wrappers.
|
|
4303
|
-
* Provides type-safe access to uniforms and
|
|
3785
|
+
* Provides type-safe access to uniforms, nodes, buffers, and gpuStorage without manual casting.
|
|
4304
3786
|
*/
|
|
4305
|
-
type CreatorState = Omit<RootState, 'uniforms' | 'nodes'> & {
|
|
3787
|
+
type CreatorState = Omit<RootState, 'uniforms' | 'nodes' | 'buffers' | 'gpuStorage'> & {
|
|
4306
3788
|
/** Type-safe uniform access - property access returns UniformNode */
|
|
4307
3789
|
uniforms: ScopedStoreType<UniformNode>;
|
|
4308
3790
|
/** Type-safe node access - property access returns TSLNodeType (Node | ShaderCallable | ShaderNodeObject) */
|
|
4309
3791
|
nodes: ScopedStoreType<TSLNodeType>;
|
|
3792
|
+
/** Type-safe buffer access - property access returns BufferLike (TypedArrays, BufferAttributes, TSL nodes) */
|
|
3793
|
+
buffers: ScopedStoreType<BufferLike>;
|
|
3794
|
+
/** Type-safe GPU storage access - property access returns StorageLike (StorageTexture, TSL nodes) */
|
|
3795
|
+
gpuStorage: ScopedStoreType<StorageLike>;
|
|
4310
3796
|
};
|
|
4311
3797
|
|
|
4312
3798
|
/** Creator function that returns uniform inputs (can be raw values or UniformNodes) */
|
|
@@ -4331,9 +3817,12 @@ declare function useUniforms<T extends UniformInputRecord>(uniforms: T): Uniform
|
|
|
4331
3817
|
declare function useUniforms<T extends UniformInputRecord>(uniforms: T, scope: string): UniformsWithUtils<UniformRecord<UniformNode>>;
|
|
4332
3818
|
/**
|
|
4333
3819
|
* Global rebuildUniforms function for HMR integration.
|
|
4334
|
-
*
|
|
3820
|
+
* Invalidates cached uniforms and increments _hmrVersion to trigger re-creation.
|
|
4335
3821
|
* Call this when HMR is detected to refresh all uniform creators.
|
|
4336
3822
|
*
|
|
3823
|
+
* Resolves to the primary store so shared TSL resources rebuild on the
|
|
3824
|
+
* authoritative store.
|
|
3825
|
+
*
|
|
4337
3826
|
* @param store - The R3F store (from useStore or context)
|
|
4338
3827
|
* @param scope - Optional scope to rebuild ('root' for root only, string for specific scope, undefined for all)
|
|
4339
3828
|
*/
|
|
@@ -4417,9 +3906,12 @@ declare function useNodes<T extends Record<string, TSLNodeLike>>(creator: NodeCr
|
|
|
4417
3906
|
declare function useNodes<T extends Record<string, TSLNodeLike>>(creator: NodeCreator<T>, scope: string): NodesWithUtils<T>;
|
|
4418
3907
|
/**
|
|
4419
3908
|
* Global rebuildNodes function for HMR integration.
|
|
4420
|
-
*
|
|
3909
|
+
* Invalidates cached nodes and increments _hmrVersion to trigger re-creation.
|
|
4421
3910
|
* Call this when HMR is detected to refresh all node creators.
|
|
4422
3911
|
*
|
|
3912
|
+
* Resolves to the primary store so shared TSL resources rebuild on the
|
|
3913
|
+
* authoritative store.
|
|
3914
|
+
*
|
|
4423
3915
|
* @param store - The R3F store (from useStore or context)
|
|
4424
3916
|
* @param scope - Optional scope to rebuild ('root' for root only, string for specific scope, undefined for all)
|
|
4425
3917
|
*/
|
|
@@ -4470,6 +3962,97 @@ type LocalNodeCreator<T extends Record<string, unknown>> = (state: CreatorState)
|
|
|
4470
3962
|
*/
|
|
4471
3963
|
declare function useLocalNodes<T extends Record<string, unknown>>(creator: LocalNodeCreator<T>): T;
|
|
4472
3964
|
|
|
3965
|
+
/**
|
|
3966
|
+
* Creator function that returns a record of buffers.
|
|
3967
|
+
* Receives CreatorState with access to existing buffers, gpuStorage, uniforms, nodes, etc.
|
|
3968
|
+
*/
|
|
3969
|
+
type BufferCreator<T extends Record<string, BufferLike>> = (state: CreatorState) => T;
|
|
3970
|
+
/** Function signature for removeBuffers util */
|
|
3971
|
+
type RemoveBuffersFn = (names: string | string[], scope?: string) => void;
|
|
3972
|
+
/** Function signature for clearBuffers util */
|
|
3973
|
+
type ClearBuffersFn = (scope?: string) => void;
|
|
3974
|
+
/** Function signature for rebuildBuffers util */
|
|
3975
|
+
type RebuildBuffersFn = (scope?: string) => void;
|
|
3976
|
+
/** Function signature for disposeBuffers util - releases GPU resources */
|
|
3977
|
+
type DisposeBuffersFn = (names: string | string[], scope?: string) => void;
|
|
3978
|
+
/** Return type with utils included */
|
|
3979
|
+
type BuffersWithUtils<T extends Record<string, BufferLike> = Record<string, BufferLike>> = T & {
|
|
3980
|
+
removeBuffers: RemoveBuffersFn;
|
|
3981
|
+
clearBuffers: ClearBuffersFn;
|
|
3982
|
+
rebuildBuffers: RebuildBuffersFn;
|
|
3983
|
+
disposeBuffers: DisposeBuffersFn;
|
|
3984
|
+
};
|
|
3985
|
+
declare function useBuffers(): BuffersWithUtils<Record<string, BufferLike> & Record<string, Record<string, BufferLike>>>;
|
|
3986
|
+
declare function useBuffers(scope: string): BuffersWithUtils<Record<string, BufferLike>>;
|
|
3987
|
+
declare function useBuffers<T extends Record<string, BufferLike>>(creator: BufferCreator<T>): BuffersWithUtils<T>;
|
|
3988
|
+
declare function useBuffers<T extends Record<string, BufferLike>>(creator: BufferCreator<T>, scope: string): BuffersWithUtils<T>;
|
|
3989
|
+
/**
|
|
3990
|
+
* Global rebuildBuffers function for HMR integration.
|
|
3991
|
+
* Invalidates cached buffers and increments _hmrVersion to trigger re-creation.
|
|
3992
|
+
* Call this when HMR is detected to refresh all buffer creators.
|
|
3993
|
+
*
|
|
3994
|
+
* Resolves to the primary store so shared TSL resources rebuild on the
|
|
3995
|
+
* authoritative store.
|
|
3996
|
+
*
|
|
3997
|
+
* @param store - The R3F store (from useStore or context)
|
|
3998
|
+
* @param scope - Optional scope to rebuild ('root' for root only, string for specific scope, undefined for all)
|
|
3999
|
+
*/
|
|
4000
|
+
declare function rebuildAllBuffers(store: ReturnType<typeof useStore>, scope?: string): void;
|
|
4001
|
+
|
|
4002
|
+
/**
|
|
4003
|
+
* Creator function that returns a record of GPU storage objects.
|
|
4004
|
+
* Receives CreatorState with access to existing buffers, gpuStorage, uniforms, nodes, etc.
|
|
4005
|
+
*/
|
|
4006
|
+
type StorageCreator<T extends Record<string, StorageLike>> = (state: CreatorState) => T;
|
|
4007
|
+
/** Function signature for removeStorage util */
|
|
4008
|
+
type RemoveStorageFn = (names: string | string[], scope?: string) => void;
|
|
4009
|
+
/** Function signature for clearStorage util */
|
|
4010
|
+
type ClearStorageFn = (scope?: string) => void;
|
|
4011
|
+
/** Function signature for rebuildStorage util */
|
|
4012
|
+
type RebuildStorageFn = (scope?: string) => void;
|
|
4013
|
+
/** Function signature for disposeStorage util - releases GPU resources */
|
|
4014
|
+
type DisposeStorageFn = (names: string | string[], scope?: string) => void;
|
|
4015
|
+
/** Return type with utils included */
|
|
4016
|
+
type StorageWithUtils<T extends Record<string, StorageLike> = Record<string, StorageLike>> = T & {
|
|
4017
|
+
removeStorage: RemoveStorageFn;
|
|
4018
|
+
clearStorage: ClearStorageFn;
|
|
4019
|
+
rebuildStorage: RebuildStorageFn;
|
|
4020
|
+
disposeStorage: DisposeStorageFn;
|
|
4021
|
+
};
|
|
4022
|
+
declare function useGPUStorage(): StorageWithUtils<Record<string, StorageLike> & Record<string, Record<string, StorageLike>>>;
|
|
4023
|
+
declare function useGPUStorage(scope: string): StorageWithUtils<Record<string, StorageLike>>;
|
|
4024
|
+
declare function useGPUStorage<T extends Record<string, StorageLike>>(creator: StorageCreator<T>): StorageWithUtils<T>;
|
|
4025
|
+
declare function useGPUStorage<T extends Record<string, StorageLike>>(creator: StorageCreator<T>, scope: string): StorageWithUtils<T>;
|
|
4026
|
+
/**
|
|
4027
|
+
* Global rebuildStorage function for HMR integration.
|
|
4028
|
+
* Invalidates cached storage and increments _hmrVersion to trigger re-creation.
|
|
4029
|
+
* Call this when HMR is detected to refresh all storage creators.
|
|
4030
|
+
*
|
|
4031
|
+
* Resolves to the primary store so shared TSL resources rebuild on the
|
|
4032
|
+
* authoritative store.
|
|
4033
|
+
*
|
|
4034
|
+
* @param store - The R3F store (from useStore or context)
|
|
4035
|
+
* @param scope - Optional scope to rebuild ('root' for root only, string for specific scope, undefined for all)
|
|
4036
|
+
*/
|
|
4037
|
+
declare function rebuildAllStorage(store: ReturnType<typeof useStore>, scope?: string): void;
|
|
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
|
+
|
|
4473
4056
|
interface TextureOperations {
|
|
4474
4057
|
add: (key: string, value: any) => void;
|
|
4475
4058
|
addMultiple: (items: Map<string, any> | Record<string, any>) => void;
|
|
@@ -4479,32 +4062,36 @@ interface TextureOperations {
|
|
|
4479
4062
|
declare function createTextureOperations(set: StoreApi<RootState>['setState']): TextureOperations;
|
|
4480
4063
|
|
|
4481
4064
|
/**
|
|
4482
|
-
* Hook for managing WebGPU
|
|
4065
|
+
* Hook for managing WebGPU RenderPipeline with automatic scenePass setup.
|
|
4483
4066
|
*
|
|
4484
4067
|
* Features:
|
|
4485
|
-
* - Creates
|
|
4068
|
+
* - Creates RenderPipeline instance if not exists
|
|
4486
4069
|
* - Creates default scenePass (no MRT) automatically
|
|
4487
4070
|
* - Callbacks receive full RootState for flexibility
|
|
4488
4071
|
* - No auto-cleanup on unmount - use reset() for explicit cleanup
|
|
4489
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
|
|
4490
4077
|
*
|
|
4491
4078
|
* @param mainCB - Main callback to configure outputNode and create effect passes
|
|
4492
4079
|
* @param setupCB - Optional setup callback to configure MRT on scenePass
|
|
4493
|
-
* @returns { passes,
|
|
4080
|
+
* @returns { passes, renderPipeline, clearPasses, reset, rebuild }
|
|
4494
4081
|
*
|
|
4495
4082
|
* @example
|
|
4496
4083
|
* ```tsx
|
|
4497
4084
|
* // Simple effect
|
|
4498
|
-
*
|
|
4499
|
-
*
|
|
4085
|
+
* useRenderPipeline(({ renderPipeline, passes }) => {
|
|
4086
|
+
* renderPipeline.outputNode = bloom(passes.scenePass.getTextureNode())
|
|
4500
4087
|
* })
|
|
4501
4088
|
*
|
|
4502
4089
|
* // With MRT setup
|
|
4503
|
-
*
|
|
4504
|
-
* ({
|
|
4090
|
+
* useRenderPipeline(
|
|
4091
|
+
* ({ renderPipeline, passes }) => {
|
|
4505
4092
|
* const beauty = passes.scenePass.getTextureNode().toInspector('Color')
|
|
4506
4093
|
* const vel = passes.scenePass.getTextureNode('velocity')
|
|
4507
|
-
*
|
|
4094
|
+
* renderPipeline.outputNode = motionBlur(beauty, vel)
|
|
4508
4095
|
* },
|
|
4509
4096
|
* ({ passes }) => {
|
|
4510
4097
|
* passes.scenePass.setMRT(mrt({ output, velocity }))
|
|
@@ -4512,10 +4099,10 @@ declare function createTextureOperations(set: StoreApi<RootState>['setState']):
|
|
|
4512
4099
|
* )
|
|
4513
4100
|
*
|
|
4514
4101
|
* // Read-only access
|
|
4515
|
-
* const {
|
|
4102
|
+
* const { renderPipeline, passes } = useRenderPipeline()
|
|
4516
4103
|
* ```
|
|
4517
4104
|
*/
|
|
4518
|
-
declare function
|
|
4105
|
+
declare function useRenderPipeline(mainCB?: RenderPipelineMainCallback, setupCB?: RenderPipelineSetupCallback): UseRenderPipelineReturn;
|
|
4519
4106
|
|
|
4520
4107
|
//* Renderer Props ========================================
|
|
4521
4108
|
|
|
@@ -4564,5 +4151,23 @@ interface WebGPURootState extends Omit<RootState, 'renderer' | 'gl' | 'internal'
|
|
|
4564
4151
|
internal: WebGPUInternalState
|
|
4565
4152
|
}
|
|
4566
4153
|
|
|
4567
|
-
|
|
4568
|
-
|
|
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 };
|