@react-three/fiber 10.0.0-canary.2b511a5 → 10.0.0-canary.2c50459
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 +529 -1305
- package/dist/index.d.cts +246 -785
- package/dist/index.d.mts +246 -785
- package/dist/index.d.ts +246 -785
- package/dist/index.mjs +503 -1278
- package/dist/legacy.cjs +523 -1305
- package/dist/legacy.d.cts +246 -785
- package/dist/legacy.d.mts +246 -785
- package/dist/legacy.d.ts +246 -785
- package/dist/legacy.mjs +497 -1278
- package/dist/webgpu/index.cjs +937 -1331
- package/dist/webgpu/index.d.cts +331 -798
- package/dist/webgpu/index.d.mts +331 -798
- package/dist/webgpu/index.d.ts +331 -798
- package/dist/webgpu/index.mjs +906 -1303
- package/package.json +2 -1
- package/readme.md +2 -2
package/dist/webgpu/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as three_webgpu from 'three/webgpu';
|
|
2
|
-
import { RenderTarget, WebGPURenderer,
|
|
2
|
+
import { RenderTarget, WebGPURenderer, Node, StorageTexture, Data3DTexture, CanvasTarget, ShaderNodeObject, Euler as Euler$2, Color as Color$2, ColorRepresentation as ColorRepresentation$1, Layers as Layers$1, Raycaster, Intersection as Intersection$1, BufferGeometry, Matrix4 as Matrix4$1, Quaternion as Quaternion$1, Vector2 as Vector2$1, Vector3 as Vector3$1, Vector4 as Vector4$1, Matrix3 as Matrix3$1, Loader as Loader$1, ColorSpace, Texture as Texture$1, CubeTexture, Scene, Object3D, Frustum, OrthographicCamera, WebGPURendererParameters } from 'three/webgpu';
|
|
3
3
|
import { Inspector } from 'three/addons/inspector/Inspector.js';
|
|
4
4
|
import * as THREE$1 from 'three';
|
|
5
5
|
import { Color as Color$1, ColorRepresentation, Euler as Euler$1, Loader, RenderTargetOptions as RenderTargetOptions$1 } from 'three';
|
|
@@ -7,6 +7,8 @@ import * as React$1 from 'react';
|
|
|
7
7
|
import { ReactNode, Component, RefObject, JSX } from 'react';
|
|
8
8
|
import { StoreApi } from 'zustand';
|
|
9
9
|
import { UseBoundStoreWithEqualityFn } from 'zustand/traditional';
|
|
10
|
+
import { FrameTimingState, FrameCallback as FrameCallback$1, SchedulerApi, UseFrameNextOptions, FrameNextControls } from '@pmndrs/scheduler';
|
|
11
|
+
export { AddPhaseOptions, FrameControls, FrameNextControls, FrameTimingState, RootOptions, Scheduler, SchedulerApi, UseFrameNextOptions, UseFrameOptions, getScheduler } from '@pmndrs/scheduler';
|
|
10
12
|
import { Options } from 'react-use-measure';
|
|
11
13
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
12
14
|
import { ThreeElement as ThreeElement$1, Euler as Euler$3 } from '@react-three/fiber';
|
|
@@ -151,6 +153,8 @@ interface IntersectionEvent<TSourceEvent> extends Intersection {
|
|
|
151
153
|
unprojectedPoint: THREE$1.Vector3
|
|
152
154
|
/** Normalized event coordinates */
|
|
153
155
|
pointer: THREE$1.Vector2
|
|
156
|
+
/** pointerId of the original event for multiple pointer events */
|
|
157
|
+
pointerId: number
|
|
154
158
|
/** Delta between first click and this event */
|
|
155
159
|
delta: number
|
|
156
160
|
/** The ray that pierced it */
|
|
@@ -227,6 +231,18 @@ interface EventHandlers {
|
|
|
227
231
|
type FilterFunction = (items: THREE$1.Intersection[], state: RootState) => THREE$1.Intersection[]
|
|
228
232
|
type ComputeFunction = (event: DomEvent, root: RootState, previous?: RootState) => void
|
|
229
233
|
|
|
234
|
+
/** Configuration for XR pointer registration (controllers/hands) */
|
|
235
|
+
interface XRPointerConfig {
|
|
236
|
+
/** Ray origin (updated each frame by XR system) */
|
|
237
|
+
ray: THREE$1.Ray
|
|
238
|
+
/** Optional: custom compute function for this pointer */
|
|
239
|
+
compute?: (state: RootState) => void
|
|
240
|
+
/** Pointer type identifier */
|
|
241
|
+
type: 'controller' | 'hand' | 'gaze'
|
|
242
|
+
/** Which hand (for controller/hand types) */
|
|
243
|
+
handedness?: 'left' | 'right'
|
|
244
|
+
}
|
|
245
|
+
|
|
230
246
|
interface EventManager<TTarget> {
|
|
231
247
|
/** Determines if the event layer is active */
|
|
232
248
|
enabled: boolean
|
|
@@ -246,8 +262,21 @@ interface EventManager<TTarget> {
|
|
|
246
262
|
disconnect?: () => void
|
|
247
263
|
/** Triggers a onPointerMove with the last known event. This can be useful to enable raycasting without
|
|
248
264
|
* explicit user interaction, for instance when the camera moves a hoverable object underneath the cursor.
|
|
265
|
+
* @param pointerId - Optional pointer ID to update specific pointer only
|
|
249
266
|
*/
|
|
250
|
-
update?: () => void
|
|
267
|
+
update?: (pointerId?: number) => void
|
|
268
|
+
/** Defer pointer move raycasting to frame start (default: true) */
|
|
269
|
+
frameTimedRaycasts?: boolean
|
|
270
|
+
/** Always fire raycaster immediately on scroll events (default: true) */
|
|
271
|
+
alwaysFireOnScroll?: boolean
|
|
272
|
+
/** Automatically re-raycast every frame to detect hover changes from moving objects/camera (default: false) */
|
|
273
|
+
updateOnFrame?: boolean
|
|
274
|
+
/** Flush deferred pointer raycasts. Called by scheduler at frame start (input phase). */
|
|
275
|
+
flush?: () => void
|
|
276
|
+
/** Register an XR pointer (controller/hand). Returns assigned pointerId */
|
|
277
|
+
registerPointer?: (config: XRPointerConfig) => number
|
|
278
|
+
/** Unregister an XR pointer */
|
|
279
|
+
unregisterPointer?: (pointerId: number) => void
|
|
251
280
|
}
|
|
252
281
|
|
|
253
282
|
interface PointerCaptureTarget {
|
|
@@ -267,227 +296,94 @@ interface VisibilityEntry {
|
|
|
267
296
|
}
|
|
268
297
|
|
|
269
298
|
//* Scheduler Types (useFrame) ==============================
|
|
299
|
+
//
|
|
300
|
+
// The generic, framework-agnostic scheduler types now live in @pmndrs/scheduler.
|
|
301
|
+
// This file re-exports them and layers r3f's RootState-aware frame state on top,
|
|
302
|
+
// so existing `#types` imports across the codebase keep resolving unchanged.
|
|
270
303
|
|
|
271
304
|
|
|
272
305
|
|
|
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
|
-
}
|
|
306
|
+
// Frame State (r3f-specific) --------------------------------
|
|
325
307
|
|
|
326
308
|
/**
|
|
327
|
-
* State passed to useFrame callbacks (extends RootState with timing)
|
|
309
|
+
* State passed to useFrame callbacks (extends RootState with timing).
|
|
328
310
|
*/
|
|
329
311
|
interface FrameNextState extends RootState, FrameTimingState {}
|
|
330
312
|
|
|
331
313
|
/** Alias for FrameNextState */
|
|
332
314
|
type FrameState = FrameNextState
|
|
333
315
|
|
|
334
|
-
//
|
|
316
|
+
// Callback Types (r3f-specific) --------------------------------
|
|
335
317
|
|
|
336
318
|
/**
|
|
337
|
-
*
|
|
319
|
+
* Callback function for useFrame. Receives the full r3f RootState plus timing.
|
|
338
320
|
*/
|
|
339
|
-
|
|
340
|
-
/** State provider for callbacks. Optional in independent mode. */
|
|
341
|
-
getState?: () => any
|
|
342
|
-
/** Error handler for job errors. Falls back to console.error if not provided. */
|
|
343
|
-
onError?: (error: Error) => void
|
|
344
|
-
}
|
|
321
|
+
type FrameNextCallback = FrameCallback$1<RootState>
|
|
345
322
|
|
|
346
|
-
|
|
323
|
+
/** Alias for FrameNextCallback */
|
|
324
|
+
type FrameCallback = FrameNextCallback
|
|
325
|
+
|
|
326
|
+
//* Buffer Types (useBuffers) ========================================
|
|
347
327
|
|
|
348
328
|
/**
|
|
349
|
-
*
|
|
329
|
+
* Buffer-like types for GPU compute and storage operations.
|
|
330
|
+
* Includes raw CPU arrays, Three.js buffer attributes, and TSL buffer nodes.
|
|
331
|
+
*
|
|
332
|
+
* @example
|
|
333
|
+
* ```tsx
|
|
334
|
+
* const { positions, velocities } = useBuffers(() => ({
|
|
335
|
+
* positions: instancedArray(count, 'vec3'), // StorageBufferNode
|
|
336
|
+
* velocities: new Float32Array(count * 3), // TypedArray
|
|
337
|
+
* }), 'particles')
|
|
338
|
+
* ```
|
|
350
339
|
*/
|
|
351
|
-
type
|
|
340
|
+
type BufferLike =
|
|
341
|
+
| Float32Array
|
|
342
|
+
| Uint32Array
|
|
343
|
+
| Int32Array
|
|
344
|
+
| Float64Array
|
|
345
|
+
| Uint8Array
|
|
346
|
+
| Int8Array
|
|
347
|
+
| Uint16Array
|
|
348
|
+
| Int16Array
|
|
349
|
+
| THREE$1.BufferAttribute // Base class for all buffer attributes
|
|
350
|
+
| Node // TSL buffer nodes (instancedArray, storage)
|
|
351
|
+
|
|
352
|
+
/** Flat record of buffer-like values (no nested scopes) */
|
|
353
|
+
type BufferRecord = Record<string, BufferLike>
|
|
352
354
|
|
|
353
|
-
/**
|
|
354
|
-
|
|
355
|
+
/**
|
|
356
|
+
* Buffer store that can contain both root-level buffers and scoped buffer objects.
|
|
357
|
+
* Structure: { positions: Float32Array, particles: { vel: StorageBufferNode } }
|
|
358
|
+
*/
|
|
359
|
+
type BufferStore = Record<string, BufferLike | BufferRecord>
|
|
355
360
|
|
|
356
|
-
|
|
361
|
+
//* Storage Types (useGPUStorage) ========================================
|
|
357
362
|
|
|
358
363
|
/**
|
|
359
|
-
*
|
|
364
|
+
* GPU storage types for texture-based storage operations.
|
|
365
|
+
* Includes Three.js storage textures and TSL storage texture nodes.
|
|
366
|
+
*
|
|
367
|
+
* @example
|
|
368
|
+
* ```tsx
|
|
369
|
+
* const { heightMap } = useGPUStorage(() => ({
|
|
370
|
+
* heightMap: new StorageTexture(512, 512),
|
|
371
|
+
* }), 'terrain')
|
|
372
|
+
* ```
|
|
360
373
|
*/
|
|
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
|
-
}
|
|
374
|
+
type StorageLike =
|
|
375
|
+
| StorageTexture // GPU storage texture
|
|
376
|
+
| Data3DTexture // 3D texture (can be used as storage)
|
|
377
|
+
| Node // TSL storage texture nodes (storageTexture)
|
|
377
378
|
|
|
378
|
-
/**
|
|
379
|
-
type
|
|
380
|
-
|
|
381
|
-
// Scheduler Interface --------------------------------
|
|
379
|
+
/** Flat record of storage-like values (no nested scopes) */
|
|
380
|
+
type StorageRecord = Record<string, StorageLike>
|
|
382
381
|
|
|
383
382
|
/**
|
|
384
|
-
*
|
|
383
|
+
* Storage store that can contain both root-level storage and scoped storage objects.
|
|
384
|
+
* Structure: { heightMap: StorageTexture, terrain: { normal: StorageTextureNode } }
|
|
385
385
|
*/
|
|
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
|
-
}
|
|
386
|
+
type StorageStore = Record<string, StorageLike | StorageRecord>
|
|
491
387
|
|
|
492
388
|
//* Renderer Types ========================================
|
|
493
389
|
|
|
@@ -502,6 +398,18 @@ type Subscription = {
|
|
|
502
398
|
store: RootStore
|
|
503
399
|
}
|
|
504
400
|
|
|
401
|
+
/** Per-pointer state for multi-touch and XR support */
|
|
402
|
+
type PointerState = {
|
|
403
|
+
/** Objects currently hovered by this pointer */
|
|
404
|
+
hovered: Map<string, ThreeEvent<DomEvent>>
|
|
405
|
+
/** Objects capturing this pointer */
|
|
406
|
+
captured: Map<THREE$1.Object3D, PointerCaptureTarget>
|
|
407
|
+
/** Initial click position [x, y] */
|
|
408
|
+
initialClick: [x: number, y: number]
|
|
409
|
+
/** Objects hit on initial click */
|
|
410
|
+
initialHits: THREE$1.Object3D[]
|
|
411
|
+
}
|
|
412
|
+
|
|
505
413
|
type Dpr = number | [min: number, max: number]
|
|
506
414
|
|
|
507
415
|
interface Size {
|
|
@@ -543,12 +451,21 @@ interface Performance {
|
|
|
543
451
|
|
|
544
452
|
interface InternalState {
|
|
545
453
|
interaction: THREE$1.Object3D[]
|
|
546
|
-
hovered: Map<string, ThreeEvent<DomEvent>>
|
|
547
454
|
subscribers: Subscription[]
|
|
455
|
+
/** Per-pointer state (hover, capture, click tracking) - replaces hovered, capturedMap, initialClick, initialHits */
|
|
456
|
+
pointerMap: Map<number, PointerState>
|
|
457
|
+
/** Pointers needing raycast this frame (used with frameTimedRaycasts) */
|
|
458
|
+
pointerDirty: Map<number, DomEvent>
|
|
459
|
+
/** Last event received (for events.update() compatibility) */
|
|
460
|
+
lastEvent: React$1.RefObject<DomEvent | null>
|
|
461
|
+
/** @deprecated Use pointerMap.get(pointerId).hovered instead */
|
|
462
|
+
hovered: Map<string, ThreeEvent<DomEvent>>
|
|
463
|
+
/** @deprecated Use pointerMap.get(pointerId).captured instead */
|
|
548
464
|
capturedMap: Map<number, Map<THREE$1.Object3D, PointerCaptureTarget>>
|
|
465
|
+
/** @deprecated Use pointerMap.get(pointerId).initialClick instead */
|
|
549
466
|
initialClick: [x: number, y: number]
|
|
467
|
+
/** @deprecated Use pointerMap.get(pointerId).initialHits instead */
|
|
550
468
|
initialHits: THREE$1.Object3D[]
|
|
551
|
-
lastEvent: React$1.RefObject<DomEvent | null>
|
|
552
469
|
/** Visibility event registry (onFramed, onOccluded, onVisible) */
|
|
553
470
|
visibilityRegistry: Map<string, VisibilityEntry>
|
|
554
471
|
/** Whether occlusion queries are enabled (WebGPU only) */
|
|
@@ -689,11 +606,17 @@ interface RootState {
|
|
|
689
606
|
uniforms: UniformStore
|
|
690
607
|
/** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
|
|
691
608
|
nodes: Record<string, any>
|
|
692
|
-
/** Global TSL
|
|
693
|
-
|
|
694
|
-
/**
|
|
695
|
-
|
|
696
|
-
/** Global
|
|
609
|
+
/** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
|
|
610
|
+
buffers: BufferStore
|
|
611
|
+
/** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
|
|
612
|
+
gpuStorage: StorageStore
|
|
613
|
+
/** Global Texture registry (key → Texture, usually keyed by URL) - use useTextures() hook for access + lifecycle */
|
|
614
|
+
textures: Map<string, THREE$1.Texture>
|
|
615
|
+
/** Internal: refcount per texture key, driven by mounted useTexture consumers (registry enrollment is on by default) */
|
|
616
|
+
_textureRefs: Map<string, number>
|
|
617
|
+
/** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
|
|
618
|
+
renderPipeline: any | null // THREE.PostProcessing (will be THREE.RenderPipeline in future Three.js release)
|
|
619
|
+
/** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
|
|
697
620
|
passes: Record<string, any>
|
|
698
621
|
/** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
|
|
699
622
|
_hmrVersion: number
|
|
@@ -743,6 +666,20 @@ interface Renderer {
|
|
|
743
666
|
render: (scene: THREE$1.Scene, camera: THREE$1.Camera) => any
|
|
744
667
|
}
|
|
745
668
|
|
|
669
|
+
//* Color Management Config ==============================
|
|
670
|
+
|
|
671
|
+
/**
|
|
672
|
+
* Color management configuration shared by both WebGL and WebGPU renderers.
|
|
673
|
+
*/
|
|
674
|
+
interface ColorManagementConfig {
|
|
675
|
+
/**
|
|
676
|
+
* Color space assigned to 8-bit input textures (color maps).
|
|
677
|
+
* Defaults to sRGB. Most textures are authored in sRGB.
|
|
678
|
+
* @default THREE.SRGBColorSpace
|
|
679
|
+
*/
|
|
680
|
+
textureColorSpace?: THREE$1.ColorSpace
|
|
681
|
+
}
|
|
682
|
+
|
|
746
683
|
//* WebGL Renderer Props ==============================
|
|
747
684
|
|
|
748
685
|
type DefaultGLProps = Omit<THREE$1.WebGLRendererParameters, 'canvas'> & {
|
|
@@ -753,7 +690,7 @@ type GLProps =
|
|
|
753
690
|
| Renderer
|
|
754
691
|
| ((defaultProps: DefaultGLProps) => Renderer)
|
|
755
692
|
| ((defaultProps: DefaultGLProps) => Promise<Renderer>)
|
|
756
|
-
| Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters>
|
|
693
|
+
| (Partial<Properties<THREE$1.WebGLRenderer> | THREE$1.WebGLRendererParameters> & ColorManagementConfig)
|
|
757
694
|
|
|
758
695
|
//* WebGPU Renderer Props ==============================
|
|
759
696
|
|
|
@@ -779,9 +716,9 @@ interface CanvasSchedulerConfig {
|
|
|
779
716
|
}
|
|
780
717
|
|
|
781
718
|
/**
|
|
782
|
-
* Extended renderer configuration for multi-canvas support.
|
|
719
|
+
* Extended renderer configuration for multi-canvas support and color management.
|
|
783
720
|
*/
|
|
784
|
-
interface RendererConfigExtended {
|
|
721
|
+
interface RendererConfigExtended extends ColorManagementConfig {
|
|
785
722
|
/** Share renderer from another canvas (WebGPU only) */
|
|
786
723
|
primaryCanvas?: string
|
|
787
724
|
/** Canvas-level scheduler options */
|
|
@@ -846,8 +783,6 @@ interface RenderProps<TCanvas extends HTMLCanvasElement | OffscreenCanvas$1> {
|
|
|
846
783
|
* @see https://threejs.org/docs/#api/en/renderers/WebGLRenderer.shadowMap
|
|
847
784
|
*/
|
|
848
785
|
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
786
|
/** Creates an orthographic camera */
|
|
852
787
|
orthographic?: boolean
|
|
853
788
|
/**
|
|
@@ -1100,7 +1035,7 @@ interface CanvasProps
|
|
|
1100
1035
|
*/
|
|
1101
1036
|
resize?: Options
|
|
1102
1037
|
/** The target where events are being subscribed to, default: the div that wraps canvas */
|
|
1103
|
-
eventSource?: HTMLElement | React$1.RefObject<HTMLElement>
|
|
1038
|
+
eventSource?: HTMLElement | React$1.RefObject<HTMLElement | null>
|
|
1104
1039
|
/** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
|
|
1105
1040
|
eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen'
|
|
1106
1041
|
/** Enable/disable automatic HMR refresh for TSL nodes and uniforms, default: true in dev */
|
|
@@ -1314,6 +1249,7 @@ declare global {
|
|
|
1314
1249
|
| three_webgpu.Euler
|
|
1315
1250
|
| three_webgpu.Quaternion
|
|
1316
1251
|
| { x: number; y?: number; z?: number; w?: number } // Plain objects converted to vectors
|
|
1252
|
+
| { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
|
|
1317
1253
|
| Node // TSL nodes like color(), vec3(), float() for type casting
|
|
1318
1254
|
| UniformNode
|
|
1319
1255
|
|
|
@@ -1359,178 +1295,38 @@ declare module 'three/tsl' {
|
|
|
1359
1295
|
}
|
|
1360
1296
|
|
|
1361
1297
|
/**
|
|
1362
|
-
*
|
|
1298
|
+
* RenderPipeline Types for useRenderPipeline hook (WebGPU only)
|
|
1363
1299
|
*/
|
|
1364
1300
|
|
|
1365
1301
|
|
|
1366
1302
|
|
|
1367
1303
|
declare global {
|
|
1368
|
-
/** Pass record - stores TSL pass nodes for
|
|
1304
|
+
/** Pass record - stores TSL pass nodes for render pipeline */
|
|
1369
1305
|
type PassRecord = Record<string, any>
|
|
1370
1306
|
|
|
1371
1307
|
/** Setup callback - runs first to configure MRT, create additional passes */
|
|
1372
|
-
type
|
|
1308
|
+
type RenderPipelineSetupCallback = (state: RootState) => PassRecord | void
|
|
1373
1309
|
|
|
1374
1310
|
/** Main callback - runs second to configure outputNode, create effect passes */
|
|
1375
|
-
type
|
|
1311
|
+
type RenderPipelineMainCallback = (state: RootState) => PassRecord | void
|
|
1376
1312
|
|
|
1377
|
-
/** Return type for
|
|
1378
|
-
interface
|
|
1313
|
+
/** Return type for useRenderPipeline hook */
|
|
1314
|
+
interface UseRenderPipelineReturn {
|
|
1379
1315
|
/** Current passes from state */
|
|
1380
1316
|
passes: PassRecord
|
|
1381
|
-
/**
|
|
1382
|
-
|
|
1317
|
+
/** RenderPipeline instance (null if not initialized) */
|
|
1318
|
+
renderPipeline: any | null // THREE.PostProcessing (will be THREE.RenderPipeline in future Three.js release)
|
|
1383
1319
|
/** Clear all passes from state */
|
|
1384
1320
|
clearPasses: () => void
|
|
1385
|
-
/** Reset
|
|
1321
|
+
/** Reset RenderPipeline entirely (clears PP + passes) */
|
|
1386
1322
|
reset: () => void
|
|
1387
1323
|
/** Re-run setup/main callbacks with current closure values */
|
|
1388
1324
|
rebuild: () => void
|
|
1389
|
-
/** True when
|
|
1325
|
+
/** True when RenderPipeline is configured and ready */
|
|
1390
1326
|
isReady: boolean
|
|
1391
1327
|
}
|
|
1392
1328
|
}
|
|
1393
1329
|
|
|
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
1330
|
type MutableOrReadonlyParameters<T extends (...args: any) => any> = Parameters<T> | Readonly<Parameters<T>>
|
|
1535
1331
|
|
|
1536
1332
|
interface MathRepresentation {
|
|
@@ -2006,6 +1802,8 @@ declare function Environment(props: EnvironmentProps): react_jsx_runtime.JSX.Ele
|
|
|
2006
1802
|
declare function removeInteractivity(store: RootStore, object: Object3D): void;
|
|
2007
1803
|
declare function createEvents(store: RootStore): {
|
|
2008
1804
|
handlePointer: (name: string) => (event: DomEvent) => void;
|
|
1805
|
+
flushDeferredPointers: () => void;
|
|
1806
|
+
processDeferredPointer: (event: DomEvent, pointerId: number) => void;
|
|
2009
1807
|
};
|
|
2010
1808
|
/** Default R3F event manager for web */
|
|
2011
1809
|
declare function createPointerEvents(store: RootStore): EventManager<HTMLElement>;
|
|
@@ -2028,376 +1826,14 @@ declare namespace useLoader {
|
|
|
2028
1826
|
var loader: typeof getLoader;
|
|
2029
1827
|
}
|
|
2030
1828
|
|
|
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
1829
|
/**
|
|
2395
1830
|
* Frame hook with phase-based ordering, priority, and FPS throttling.
|
|
2396
1831
|
*
|
|
2397
|
-
*
|
|
2398
|
-
* - Inside Canvas: Full RootState (
|
|
2399
|
-
* - Outside Canvas
|
|
2400
|
-
*
|
|
1832
|
+
* Always delivers full RootState — works both inside and outside Canvas context:
|
|
1833
|
+
* - Inside Canvas: Full RootState (renderer, scene, camera, etc.)
|
|
1834
|
+
* - Outside Canvas: The job registers immediately but the callback is held until a
|
|
1835
|
+
* Canvas adopts it, then runs with full RootState. For hostless / standalone
|
|
1836
|
+
* frame loops with no Canvas, use `@pmndrs/scheduler` directly.
|
|
2401
1837
|
*
|
|
2402
1838
|
* Returns a controls object for manual stepping, pausing, and resuming.
|
|
2403
1839
|
*
|
|
@@ -2414,16 +1850,16 @@ declare const getScheduler: () => Scheduler;
|
|
|
2414
1850
|
* useFrame((state, delta) => { ... }, { phase: 'physics' })
|
|
2415
1851
|
*
|
|
2416
1852
|
* @example
|
|
2417
|
-
* // Outside Canvas - waits for Canvas
|
|
1853
|
+
* // Outside Canvas - callback waits for a Canvas, then always has full state
|
|
2418
1854
|
* function UI() {
|
|
2419
1855
|
* useFrame((state, delta) => { syncUI(state.camera) });
|
|
2420
1856
|
* return <button>...</button>;
|
|
2421
1857
|
* }
|
|
2422
1858
|
*
|
|
2423
1859
|
* @example
|
|
2424
|
-
* //
|
|
2425
|
-
* getScheduler
|
|
2426
|
-
*
|
|
1860
|
+
* // Hostless / standalone loop (no Canvas) - use @pmndrs/scheduler directly
|
|
1861
|
+
* import { getScheduler } from '@pmndrs/scheduler'
|
|
1862
|
+
* getScheduler().register((state, delta) => { updateGame(delta) })
|
|
2427
1863
|
*
|
|
2428
1864
|
* @example
|
|
2429
1865
|
* // Scheduler-only access (no callback)
|
|
@@ -2446,11 +1882,16 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
|
|
|
2446
1882
|
/** Callback when texture(s) finish loading */
|
|
2447
1883
|
onLoad?: (texture: MappedTextureType<Url>) => void;
|
|
2448
1884
|
/**
|
|
2449
|
-
*
|
|
2450
|
-
* When true:
|
|
1885
|
+
* Register the texture(s) in R3F's global texture registry for access via useTextures().
|
|
1886
|
+
* When true (the default):
|
|
2451
1887
|
* - Textures persist until explicitly disposed
|
|
2452
|
-
* -
|
|
2453
|
-
*
|
|
1888
|
+
* - On mount, returns existing registered textures if available (preserving modifications like colorSpace)
|
|
1889
|
+
*
|
|
1890
|
+
* Reads are taken once at mount — a mounted `useTexture` does not re-render when the registry
|
|
1891
|
+
* changes. To react to registry swaps, use `useTextures(s => s.get(key))` instead.
|
|
1892
|
+
*
|
|
1893
|
+
* Pass `false` to opt out of registry enrollment entirely.
|
|
1894
|
+
* @default true
|
|
2454
1895
|
*/
|
|
2455
1896
|
cache?: boolean;
|
|
2456
1897
|
};
|
|
@@ -2474,15 +1915,18 @@ type UseTextureOptions<Url extends string[] | string | Record<string, string>> =
|
|
|
2474
1915
|
* normal: '/normal.png'
|
|
2475
1916
|
* })
|
|
2476
1917
|
*
|
|
2477
|
-
* //
|
|
2478
|
-
* //
|
|
2479
|
-
* const diffuse = useTexture('/diffuse.png'
|
|
1918
|
+
* // Textures are registered in the global registry by default — the same texture
|
|
1919
|
+
* // object is shared across components and modifications (colorSpace, wrapS, etc.) are preserved
|
|
1920
|
+
* const diffuse = useTexture('/diffuse.png')
|
|
2480
1921
|
* diffuse.colorSpace = THREE.SRGBColorSpace
|
|
2481
1922
|
*
|
|
2482
1923
|
* // Another component gets the SAME texture with colorSpace already set
|
|
2483
|
-
* const sameDiffuse = useTexture('/diffuse.png'
|
|
1924
|
+
* const sameDiffuse = useTexture('/diffuse.png')
|
|
2484
1925
|
*
|
|
2485
|
-
* //
|
|
1926
|
+
* // Opt out of registry enrollment for a one-off texture
|
|
1927
|
+
* const scratch = useTexture('/scratch.png', { cache: false })
|
|
1928
|
+
*
|
|
1929
|
+
* // Access the registry directly
|
|
2486
1930
|
* const { get } = useTextures()
|
|
2487
1931
|
* const cached = get('/diffuse.png')
|
|
2488
1932
|
* ```
|
|
@@ -2499,63 +1943,80 @@ declare const Texture: ({ children, input, onLoad, cache, }: {
|
|
|
2499
1943
|
cache?: boolean;
|
|
2500
1944
|
}) => react_jsx_runtime.JSX.Element;
|
|
2501
1945
|
|
|
2502
|
-
|
|
2503
|
-
|
|
2504
|
-
|
|
1946
|
+
/** Accepted shapes for a registry read: a single key, a list of keys, or a name→key map. */
|
|
1947
|
+
type TextureInput = string | string[] | Record<string, string>;
|
|
1948
|
+
/** Result of a `get()` read, mirroring the input shape. */
|
|
1949
|
+
type TextureResult<Input extends TextureInput> = Input extends string ? Texture$1 | undefined : Input extends string[] ? (Texture$1 | undefined)[] : {
|
|
1950
|
+
[K in keyof Input]: Texture$1 | undefined;
|
|
2505
1951
|
};
|
|
1952
|
+
/** Options for `dispose()`. */
|
|
1953
|
+
interface DisposeOptions {
|
|
1954
|
+
/** Dispose even if the texture still has active references (default false). */
|
|
1955
|
+
force?: boolean;
|
|
1956
|
+
}
|
|
2506
1957
|
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
|
-
|
|
1958
|
+
/** The live registry Map (key → Texture). Treat as read-only. */
|
|
1959
|
+
readonly all: Map<string, Texture$1>;
|
|
1960
|
+
/** Read one texture, an array of textures, or a name→texture record (mirrors the input shape). */
|
|
1961
|
+
get<Input extends TextureInput>(input: Input): TextureResult<Input>;
|
|
1962
|
+
/** Check whether a key exists in the registry. */
|
|
1963
|
+
has(key: string): boolean;
|
|
1964
|
+
/**
|
|
1965
|
+
* Register a texture (or a record of textures) that has no URL — e.g. a render
|
|
1966
|
+
* target or procedural texture. URL-loaded textures are registered automatically
|
|
1967
|
+
* by `useTexture` (registry enrollment is on by default).
|
|
1968
|
+
*/
|
|
1969
|
+
add(key: string, texture: Texture$1): void;
|
|
1970
|
+
add(record: Record<string, Texture$1>): void;
|
|
1971
|
+
/**
|
|
1972
|
+
* Dispose a texture's GPU resources and remove it from the registry.
|
|
1973
|
+
* Refcount-aware: if the key is still in use by a mounted `useTexture` consumer it is
|
|
1974
|
+
* skipped (with a warning) unless `{ force: true }` is passed.
|
|
1975
|
+
* @returns true if disposed, false if skipped.
|
|
1976
|
+
*/
|
|
1977
|
+
dispose(key: string, options?: DisposeOptions): boolean;
|
|
1978
|
+
/** Dispose every texture in the registry and clear it. Use on scene teardown. */
|
|
1979
|
+
disposeAll(): void;
|
|
2527
1980
|
}
|
|
2528
1981
|
/**
|
|
2529
|
-
*
|
|
1982
|
+
* Reactive Texture registry — load once with `useTexture`, reach the textures from anywhere.
|
|
2530
1983
|
*
|
|
2531
|
-
*
|
|
2532
|
-
*
|
|
1984
|
+
* This is a registry of plain `Texture` objects (not TSL nodes), so the same texture can feed
|
|
1985
|
+
* a material map, a heightmap sampler, or anything else. It does **not** load — pair it with
|
|
1986
|
+
* `useTexture` for loading (registry enrollment is on by default); `useTextures` is for access and lifecycle.
|
|
1987
|
+
*
|
|
1988
|
+
* The returned handle is **reactive**: the calling component re-renders when the registry
|
|
1989
|
+
* changes. Pass a selector to scope the subscription to a single read.
|
|
2533
1990
|
*
|
|
2534
1991
|
* @example
|
|
2535
1992
|
* ```tsx
|
|
2536
|
-
*
|
|
2537
|
-
*
|
|
2538
|
-
* // Check if texture is already cached
|
|
2539
|
-
* if (!has('/textures/diffuse.png')) {
|
|
2540
|
-
* // Load with useTexture and cache: true, or manually add
|
|
2541
|
-
* const tex = useTexture('/textures/diffuse.png', { cache: true })
|
|
2542
|
-
* }
|
|
1993
|
+
* // Load + register once (anywhere in the tree) — registered by default
|
|
1994
|
+
* useTexture({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
|
|
2543
1995
|
*
|
|
2544
|
-
* //
|
|
2545
|
-
* const
|
|
2546
|
-
*
|
|
1996
|
+
* // Reach them from another component — record form lands straight into a material
|
|
1997
|
+
* const { map, normalMap } = useTextures().get({ map: '/diffuse.jpg', normalMap: '/normal.jpg' })
|
|
1998
|
+
* return <meshStandardMaterial map={map} normalMap={normalMap} />
|
|
2547
1999
|
*
|
|
2548
|
-
* //
|
|
2549
|
-
*
|
|
2000
|
+
* // A set of heightmaps at once
|
|
2001
|
+
* const [a, b, c] = useTextures().get(['/h0.png', '/h1.png', '/h2.png'])
|
|
2550
2002
|
*
|
|
2551
|
-
* //
|
|
2552
|
-
*
|
|
2003
|
+
* // Register a non-URL texture (render target / procedural)
|
|
2004
|
+
* useTextures().add('rt-main', renderTarget.texture)
|
|
2553
2005
|
*
|
|
2554
|
-
* //
|
|
2555
|
-
*
|
|
2006
|
+
* // Deliberate GPU cleanup (refcount-aware; force to override)
|
|
2007
|
+
* useTextures().dispose('/diffuse.jpg')
|
|
2008
|
+
* useTextures().disposeAll() // scene teardown
|
|
2556
2009
|
* ```
|
|
2010
|
+
*
|
|
2011
|
+
* @remarks
|
|
2012
|
+
* **Future expansion:** an imperative async loader (e.g. `await useTextures().load('/x.jpg')`) is
|
|
2013
|
+
* intentionally not included yet. It would let non-React code (loading screens, dynamic streaming)
|
|
2014
|
+
* populate the registry without Suspense, at the cost of putting loading back into this hook. It
|
|
2015
|
+
* will be added only if a concrete consumer needs imperative loading; for now, loading lives in
|
|
2016
|
+
* `useTexture`.
|
|
2557
2017
|
*/
|
|
2558
2018
|
declare function useTextures(): UseTexturesReturn;
|
|
2019
|
+
declare function useTextures<T>(selector: (registry: UseTexturesReturn) => T): T;
|
|
2559
2020
|
|
|
2560
2021
|
/**
|
|
2561
2022
|
* Creates a render target compatible with the current renderer.
|
|
@@ -2585,9 +2046,9 @@ declare function useTextures(): UseTexturesReturn;
|
|
|
2585
2046
|
* const fbo = useRenderTarget(512, 256, { samples: 4 })
|
|
2586
2047
|
* ```
|
|
2587
2048
|
*/
|
|
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
|
|
2049
|
+
declare function useRenderTarget(options?: RenderTargetOptions): RenderTarget;
|
|
2050
|
+
declare function useRenderTarget(size: number, options?: RenderTargetOptions): RenderTarget;
|
|
2051
|
+
declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): RenderTarget;
|
|
2591
2052
|
|
|
2592
2053
|
/**
|
|
2593
2054
|
* Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
|
|
@@ -4300,13 +3761,17 @@ type ScopedStoreType<T> = {
|
|
|
4300
3761
|
declare function createScopedStore<T>(data: Record<string, any>): ScopedStoreType<T>;
|
|
4301
3762
|
/**
|
|
4302
3763
|
* State type passed to creator functions with ScopedStore wrappers.
|
|
4303
|
-
* Provides type-safe access to uniforms and
|
|
3764
|
+
* Provides type-safe access to uniforms, nodes, buffers, and gpuStorage without manual casting.
|
|
4304
3765
|
*/
|
|
4305
|
-
type CreatorState = Omit<RootState, 'uniforms' | 'nodes'> & {
|
|
3766
|
+
type CreatorState = Omit<RootState, 'uniforms' | 'nodes' | 'buffers' | 'gpuStorage'> & {
|
|
4306
3767
|
/** Type-safe uniform access - property access returns UniformNode */
|
|
4307
3768
|
uniforms: ScopedStoreType<UniformNode>;
|
|
4308
3769
|
/** Type-safe node access - property access returns TSLNodeType (Node | ShaderCallable | ShaderNodeObject) */
|
|
4309
3770
|
nodes: ScopedStoreType<TSLNodeType>;
|
|
3771
|
+
/** Type-safe buffer access - property access returns BufferLike (TypedArrays, BufferAttributes, TSL nodes) */
|
|
3772
|
+
buffers: ScopedStoreType<BufferLike>;
|
|
3773
|
+
/** Type-safe GPU storage access - property access returns StorageLike (StorageTexture, TSL nodes) */
|
|
3774
|
+
gpuStorage: ScopedStoreType<StorageLike>;
|
|
4310
3775
|
};
|
|
4311
3776
|
|
|
4312
3777
|
/** Creator function that returns uniform inputs (can be raw values or UniformNodes) */
|
|
@@ -4470,6 +3935,74 @@ type LocalNodeCreator<T extends Record<string, unknown>> = (state: CreatorState)
|
|
|
4470
3935
|
*/
|
|
4471
3936
|
declare function useLocalNodes<T extends Record<string, unknown>>(creator: LocalNodeCreator<T>): T;
|
|
4472
3937
|
|
|
3938
|
+
/**
|
|
3939
|
+
* Creator function that returns a record of buffers.
|
|
3940
|
+
* Receives CreatorState with access to existing buffers, gpuStorage, uniforms, nodes, etc.
|
|
3941
|
+
*/
|
|
3942
|
+
type BufferCreator<T extends Record<string, BufferLike>> = (state: CreatorState) => T;
|
|
3943
|
+
/** Function signature for removeBuffers util */
|
|
3944
|
+
type RemoveBuffersFn = (names: string | string[], scope?: string) => void;
|
|
3945
|
+
/** Function signature for clearBuffers util */
|
|
3946
|
+
type ClearBuffersFn = (scope?: string) => void;
|
|
3947
|
+
/** Function signature for rebuildBuffers util */
|
|
3948
|
+
type RebuildBuffersFn = (scope?: string) => void;
|
|
3949
|
+
/** Function signature for disposeBuffers util - releases GPU resources */
|
|
3950
|
+
type DisposeBuffersFn = (names: string | string[], scope?: string) => void;
|
|
3951
|
+
/** Return type with utils included */
|
|
3952
|
+
type BuffersWithUtils<T extends Record<string, BufferLike> = Record<string, BufferLike>> = T & {
|
|
3953
|
+
removeBuffers: RemoveBuffersFn;
|
|
3954
|
+
clearBuffers: ClearBuffersFn;
|
|
3955
|
+
rebuildBuffers: RebuildBuffersFn;
|
|
3956
|
+
disposeBuffers: DisposeBuffersFn;
|
|
3957
|
+
};
|
|
3958
|
+
declare function useBuffers(): BuffersWithUtils<Record<string, BufferLike> & Record<string, Record<string, BufferLike>>>;
|
|
3959
|
+
declare function useBuffers(scope: string): BuffersWithUtils<Record<string, BufferLike>>;
|
|
3960
|
+
declare function useBuffers<T extends Record<string, BufferLike>>(creator: BufferCreator<T>): BuffersWithUtils<T>;
|
|
3961
|
+
declare function useBuffers<T extends Record<string, BufferLike>>(creator: BufferCreator<T>, scope: string): BuffersWithUtils<T>;
|
|
3962
|
+
/**
|
|
3963
|
+
* Global rebuildBuffers function for HMR integration.
|
|
3964
|
+
* Clears cached buffers and increments _hmrVersion to trigger re-creation.
|
|
3965
|
+
* Call this when HMR is detected to refresh all buffer creators.
|
|
3966
|
+
*
|
|
3967
|
+
* @param store - The R3F store (from useStore or context)
|
|
3968
|
+
* @param scope - Optional scope to rebuild ('root' for root only, string for specific scope, undefined for all)
|
|
3969
|
+
*/
|
|
3970
|
+
declare function rebuildAllBuffers(store: ReturnType<typeof useStore>, scope?: string): void;
|
|
3971
|
+
|
|
3972
|
+
/**
|
|
3973
|
+
* Creator function that returns a record of GPU storage objects.
|
|
3974
|
+
* Receives CreatorState with access to existing buffers, gpuStorage, uniforms, nodes, etc.
|
|
3975
|
+
*/
|
|
3976
|
+
type StorageCreator<T extends Record<string, StorageLike>> = (state: CreatorState) => T;
|
|
3977
|
+
/** Function signature for removeStorage util */
|
|
3978
|
+
type RemoveStorageFn = (names: string | string[], scope?: string) => void;
|
|
3979
|
+
/** Function signature for clearStorage util */
|
|
3980
|
+
type ClearStorageFn = (scope?: string) => void;
|
|
3981
|
+
/** Function signature for rebuildStorage util */
|
|
3982
|
+
type RebuildStorageFn = (scope?: string) => void;
|
|
3983
|
+
/** Function signature for disposeStorage util - releases GPU resources */
|
|
3984
|
+
type DisposeStorageFn = (names: string | string[], scope?: string) => void;
|
|
3985
|
+
/** Return type with utils included */
|
|
3986
|
+
type StorageWithUtils<T extends Record<string, StorageLike> = Record<string, StorageLike>> = T & {
|
|
3987
|
+
removeStorage: RemoveStorageFn;
|
|
3988
|
+
clearStorage: ClearStorageFn;
|
|
3989
|
+
rebuildStorage: RebuildStorageFn;
|
|
3990
|
+
disposeStorage: DisposeStorageFn;
|
|
3991
|
+
};
|
|
3992
|
+
declare function useGPUStorage(): StorageWithUtils<Record<string, StorageLike> & Record<string, Record<string, StorageLike>>>;
|
|
3993
|
+
declare function useGPUStorage(scope: string): StorageWithUtils<Record<string, StorageLike>>;
|
|
3994
|
+
declare function useGPUStorage<T extends Record<string, StorageLike>>(creator: StorageCreator<T>): StorageWithUtils<T>;
|
|
3995
|
+
declare function useGPUStorage<T extends Record<string, StorageLike>>(creator: StorageCreator<T>, scope: string): StorageWithUtils<T>;
|
|
3996
|
+
/**
|
|
3997
|
+
* Global rebuildStorage function for HMR integration.
|
|
3998
|
+
* Clears cached storage and increments _hmrVersion to trigger re-creation.
|
|
3999
|
+
* Call this when HMR is detected to refresh all storage creators.
|
|
4000
|
+
*
|
|
4001
|
+
* @param store - The R3F store (from useStore or context)
|
|
4002
|
+
* @param scope - Optional scope to rebuild ('root' for root only, string for specific scope, undefined for all)
|
|
4003
|
+
*/
|
|
4004
|
+
declare function rebuildAllStorage(store: ReturnType<typeof useStore>, scope?: string): void;
|
|
4005
|
+
|
|
4473
4006
|
interface TextureOperations {
|
|
4474
4007
|
add: (key: string, value: any) => void;
|
|
4475
4008
|
addMultiple: (items: Map<string, any> | Record<string, any>) => void;
|
|
@@ -4479,10 +4012,10 @@ interface TextureOperations {
|
|
|
4479
4012
|
declare function createTextureOperations(set: StoreApi<RootState>['setState']): TextureOperations;
|
|
4480
4013
|
|
|
4481
4014
|
/**
|
|
4482
|
-
* Hook for managing WebGPU
|
|
4015
|
+
* Hook for managing WebGPU RenderPipeline with automatic scenePass setup.
|
|
4483
4016
|
*
|
|
4484
4017
|
* Features:
|
|
4485
|
-
* - Creates
|
|
4018
|
+
* - Creates RenderPipeline instance if not exists
|
|
4486
4019
|
* - Creates default scenePass (no MRT) automatically
|
|
4487
4020
|
* - Callbacks receive full RootState for flexibility
|
|
4488
4021
|
* - No auto-cleanup on unmount - use reset() for explicit cleanup
|
|
@@ -4490,21 +4023,21 @@ declare function createTextureOperations(set: StoreApi<RootState>['setState']):
|
|
|
4490
4023
|
*
|
|
4491
4024
|
* @param mainCB - Main callback to configure outputNode and create effect passes
|
|
4492
4025
|
* @param setupCB - Optional setup callback to configure MRT on scenePass
|
|
4493
|
-
* @returns { passes,
|
|
4026
|
+
* @returns { passes, renderPipeline, clearPasses, reset, rebuild }
|
|
4494
4027
|
*
|
|
4495
4028
|
* @example
|
|
4496
4029
|
* ```tsx
|
|
4497
4030
|
* // Simple effect
|
|
4498
|
-
*
|
|
4499
|
-
*
|
|
4031
|
+
* useRenderPipeline(({ renderPipeline, passes }) => {
|
|
4032
|
+
* renderPipeline.outputNode = bloom(passes.scenePass.getTextureNode())
|
|
4500
4033
|
* })
|
|
4501
4034
|
*
|
|
4502
4035
|
* // With MRT setup
|
|
4503
|
-
*
|
|
4504
|
-
* ({
|
|
4036
|
+
* useRenderPipeline(
|
|
4037
|
+
* ({ renderPipeline, passes }) => {
|
|
4505
4038
|
* const beauty = passes.scenePass.getTextureNode().toInspector('Color')
|
|
4506
4039
|
* const vel = passes.scenePass.getTextureNode('velocity')
|
|
4507
|
-
*
|
|
4040
|
+
* renderPipeline.outputNode = motionBlur(beauty, vel)
|
|
4508
4041
|
* },
|
|
4509
4042
|
* ({ passes }) => {
|
|
4510
4043
|
* passes.scenePass.setMRT(mrt({ output, velocity }))
|
|
@@ -4512,10 +4045,10 @@ declare function createTextureOperations(set: StoreApi<RootState>['setState']):
|
|
|
4512
4045
|
* )
|
|
4513
4046
|
*
|
|
4514
4047
|
* // Read-only access
|
|
4515
|
-
* const {
|
|
4048
|
+
* const { renderPipeline, passes } = useRenderPipeline()
|
|
4516
4049
|
* ```
|
|
4517
4050
|
*/
|
|
4518
|
-
declare function
|
|
4051
|
+
declare function useRenderPipeline(mainCB?: RenderPipelineMainCallback, setupCB?: RenderPipelineSetupCallback): UseRenderPipelineReturn;
|
|
4519
4052
|
|
|
4520
4053
|
//* Renderer Props ========================================
|
|
4521
4054
|
|
|
@@ -4564,5 +4097,5 @@ interface WebGPURootState extends Omit<RootState, 'renderer' | 'gl' | 'internal'
|
|
|
4564
4097
|
internal: WebGPUInternalState
|
|
4565
4098
|
}
|
|
4566
4099
|
|
|
4567
|
-
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,
|
|
4568
|
-
export type { Act,
|
|
4100
|
+
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, act, 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, 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 };
|
|
4101
|
+
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, TextureInput, TextureOperations, TextureResult, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UniformCreator, UniformValue, UniformsWithUtils, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, WebGPUDefaultProps, WebGPUProps, WebGPUShadowConfig, XRManager, XRPointerConfig };
|