@react-three/fiber 10.0.0-canary.2b511a5 → 10.0.0-canary.aecbafb

package/dist/legacy.d.ts

@@ -3,7 +3,7 @@ import { WebGLRenderTarget, Color as Color$1, ColorRepresentation, Euler as Eule
 import * as React$1 from 'react';
 import { ReactNode, Component, RefObject, JSX } from 'react';
 import * as three_webgpu from 'three/webgpu';
-import { WebGPURenderer as WebGPURenderer$1, CanvasTarget, Node, ShaderNodeObject } from 'three/webgpu';
+import { WebGPURenderer as WebGPURenderer$1, Node, StorageTexture, Data3DTexture, CanvasTarget, ShaderNodeObject } from 'three/webgpu';
 import { StoreApi } from 'zustand';
 import { UseBoundStoreWithEqualityFn } from 'zustand/traditional';
 import { Options } from 'react-use-measure';
@@ -148,6 +148,8 @@ interface IntersectionEvent<TSourceEvent> extends Intersection {
   unprojectedPoint: THREE$1.Vector3
   /** Normalized event coordinates */
   pointer: THREE$1.Vector2
+  /** pointerId of the original event for multiple pointer events */
+  pointerId: number
   /** Delta between first click and this event */
   delta: number
   /** The ray that pierced it */
@@ -224,6 +226,18 @@ interface EventHandlers {
 type FilterFunction = (items: THREE$1.Intersection[], state: RootState) => THREE$1.Intersection[]
 type ComputeFunction = (event: DomEvent, root: RootState, previous?: RootState) => void
 
+/** Configuration for XR pointer registration (controllers/hands) */
+interface XRPointerConfig {
+  /** Ray origin (updated each frame by XR system) */
+  ray: THREE$1.Ray
+  /** Optional: custom compute function for this pointer */
+  compute?: (state: RootState) => void
+  /** Pointer type identifier */
+  type: 'controller' | 'hand' | 'gaze'
+  /** Which hand (for controller/hand types) */
+  handedness?: 'left' | 'right'
+}
+
 interface EventManager<TTarget> {
   /** Determines if the event layer is active */
   enabled: boolean
@@ -243,8 +257,21 @@ interface EventManager<TTarget> {
   disconnect?: () => void
   /** Triggers a onPointerMove with the last known event. This can be useful to enable raycasting without
    *  explicit user interaction, for instance when the camera moves a hoverable object underneath the cursor.
+   *  @param pointerId - Optional pointer ID to update specific pointer only
    */
-  update?: () => void
+  update?: (pointerId?: number) => void
+  /** Defer pointer move raycasting to frame start (default: true) */
+  frameTimedRaycasts?: boolean
+  /** Always fire raycaster immediately on scroll events (default: true) */
+  alwaysFireOnScroll?: boolean
+  /** Automatically re-raycast every frame to detect hover changes from moving objects/camera (default: false) */
+  updateOnFrame?: boolean
+  /** Flush deferred pointer raycasts. Called by scheduler at frame start (input phase). */
+  flush?: () => void
+  /** Register an XR pointer (controller/hand). Returns assigned pointerId */
+  registerPointer?: (config: XRPointerConfig) => number
+  /** Unregister an XR pointer */
+  unregisterPointer?: (pointerId: number) => void
 }
 
 interface PointerCaptureTarget {
@@ -486,6 +513,68 @@ interface SchedulerApi {
   subscribeJobState(id: string, listener: () => void): () => void
 }
 
+//* Buffer Types (useBuffers) ========================================
+
+/**
+ * Buffer-like types for GPU compute and storage operations.
+ * Includes raw CPU arrays, Three.js buffer attributes, and TSL buffer nodes.
+ *
+ * @example
+ * ```tsx
+ * const { positions, velocities } = useBuffers(() => ({
+ *   positions: instancedArray(count, 'vec3'),       // StorageBufferNode
+ *   velocities: new Float32Array(count * 3),        // TypedArray
+ * }), 'particles')
+ * ```
+ */
+type BufferLike =
+  | Float32Array
+  | Uint32Array
+  | Int32Array
+  | Float64Array
+  | Uint8Array
+  | Int8Array
+  | Uint16Array
+  | Int16Array
+  | THREE$1.BufferAttribute // Base class for all buffer attributes
+  | Node // TSL buffer nodes (instancedArray, storage)
+
+/** Flat record of buffer-like values (no nested scopes) */
+type BufferRecord = Record<string, BufferLike>
+
+/**
+ * Buffer store that can contain both root-level buffers and scoped buffer objects.
+ * Structure: { positions: Float32Array, particles: { vel: StorageBufferNode } }
+ */
+type BufferStore = Record<string, BufferLike | BufferRecord>
+
+//* Storage Types (useGPUStorage) ========================================
+
+/**
+ * GPU storage types for texture-based storage operations.
+ * Includes Three.js storage textures and TSL storage texture nodes.
+ *
+ * @example
+ * ```tsx
+ * const { heightMap } = useGPUStorage(() => ({
+ *   heightMap: new StorageTexture(512, 512),
+ * }), 'terrain')
+ * ```
+ */
+type StorageLike =
+  | StorageTexture // GPU storage texture
+  | Data3DTexture // 3D texture (can be used as storage)
+  | Node // TSL storage texture nodes (storageTexture)
+
+/** Flat record of storage-like values (no nested scopes) */
+type StorageRecord = Record<string, StorageLike>
+
+/**
+ * Storage store that can contain both root-level storage and scoped storage objects.
+ * Structure: { heightMap: StorageTexture, terrain: { normal: StorageTextureNode } }
+ */
+type StorageStore = Record<string, StorageLike | StorageRecord>
+
 //* Renderer Types ========================================
 
 /** Default renderer type - union of WebGL and WebGPU renderers */
@@ -499,6 +588,18 @@ type Subscription = {
   store: RootStore
 }
 
+/** Per-pointer state for multi-touch and XR support */
+type PointerState = {
+  /** Objects currently hovered by this pointer */
+  hovered: Map<string, ThreeEvent<DomEvent>>
+  /** Objects capturing this pointer */
+  captured: Map<THREE$1.Object3D, PointerCaptureTarget>
+  /** Initial click position [x, y] */
+  initialClick: [x: number, y: number]
+  /** Objects hit on initial click */
+  initialHits: THREE$1.Object3D[]
+}
+
 type Dpr = number | [min: number, max: number]
 
 interface Size {
@@ -540,12 +641,21 @@ interface Performance {
 
 interface InternalState {
   interaction: THREE$1.Object3D[]
-  hovered: Map<string, ThreeEvent<DomEvent>>
   subscribers: Subscription[]
+  /** Per-pointer state (hover, capture, click tracking) - replaces hovered, capturedMap, initialClick, initialHits */
+  pointerMap: Map<number, PointerState>
+  /** Pointers needing raycast this frame (used with frameTimedRaycasts) */
+  pointerDirty: Map<number, DomEvent>
+  /** Last event received (for events.update() compatibility) */
+  lastEvent: React$1.RefObject<DomEvent | null>
+  /** @deprecated Use pointerMap.get(pointerId).hovered instead */
+  hovered: Map<string, ThreeEvent<DomEvent>>
+  /** @deprecated Use pointerMap.get(pointerId).captured instead */
   capturedMap: Map<number, Map<THREE$1.Object3D, PointerCaptureTarget>>
+  /** @deprecated Use pointerMap.get(pointerId).initialClick instead */
   initialClick: [x: number, y: number]
+  /** @deprecated Use pointerMap.get(pointerId).initialHits instead */
   initialHits: THREE$1.Object3D[]
-  lastEvent: React$1.RefObject<DomEvent | null>
   /** Visibility event registry (onFramed, onOccluded, onVisible) */
   visibilityRegistry: Map<string, VisibilityEntry>
   /** Whether occlusion queries are enabled (WebGPU only) */
@@ -686,11 +796,15 @@ interface RootState {
   uniforms: UniformStore
   /** Global TSL nodes - root-level nodes + scoped sub-objects. Use useNodes() hook */
   nodes: Record<string, any>
+  /** Global TSL buffer nodes - root-level buffers + scoped sub-objects. Use useBuffers() hook */
+  buffers: BufferStore
+  /** Global GPU storage (textures, etc.) - root-level storage + scoped sub-objects. Use useGPUStorage() hook */
+  gpuStorage: StorageStore
   /** Global TSL texture nodes - use useTextures() hook for operations */
   textures: Map<string, any>
-  /** WebGPU PostProcessing instance - use usePostProcessing() hook */
-  postProcessing: any | null // THREE.PostProcessing when available
-  /** Global TSL pass nodes for post-processing - use usePostProcessing() hook */
+  /** WebGPU RenderPipeline instance - use useRenderPipeline() hook */
+  renderPipeline: any | null // THREE.PostProcessing (will be THREE.RenderPipeline in future Three.js release)
+  /** Global TSL pass nodes for render pipeline - use useRenderPipeline() hook */
   passes: Record<string, any>
   /** Internal version counter for HMR - incremented by rebuildNodes/rebuildUniforms to bust memoization */
   _hmrVersion: number
@@ -1311,6 +1425,7 @@ declare global {
     | three_webgpu.Euler
     | three_webgpu.Quaternion
     | { x: number; y?: number; z?: number; w?: number } // Plain objects converted to vectors
+    | { r: number; g: number; b: number; a?: number } // Plain objects converted to Color
     | Node // TSL nodes like color(), vec3(), float() for type casting
     | UniformNode
 
@@ -1356,34 +1471,34 @@ declare module 'three/tsl' {
 }
 
 /**
- * PostProcessing Types for usePostProcessing hook (WebGPU only)
+ * RenderPipeline Types for useRenderPipeline hook (WebGPU only)
  */
 
 
 
 declare global {
-  /** Pass record - stores TSL pass nodes for post-processing */
+  /** Pass record - stores TSL pass nodes for render pipeline */
   type PassRecord = Record<string, any>
 
   /** Setup callback - runs first to configure MRT, create additional passes */
-  type PostProcessingSetupCallback = (state: RootState) => PassRecord | void
+  type RenderPipelineSetupCallback = (state: RootState) => PassRecord | void
 
   /** Main callback - runs second to configure outputNode, create effect passes */
-  type PostProcessingMainCallback = (state: RootState) => PassRecord | void
+  type RenderPipelineMainCallback = (state: RootState) => PassRecord | void
 
-  /** Return type for usePostProcessing hook */
-  interface UsePostProcessingReturn {
+  /** Return type for useRenderPipeline hook */
+  interface UseRenderPipelineReturn {
     /** Current passes from state */
     passes: PassRecord
-    /** PostProcessing instance (null if not initialized) */
-    postProcessing: any | null // THREE.PostProcessing
+    /** RenderPipeline instance (null if not initialized) */
+    renderPipeline: any | null // THREE.PostProcessing (will be THREE.RenderPipeline in future Three.js release)
     /** Clear all passes from state */
     clearPasses: () => void
-    /** Reset PostProcessing entirely (clears PP + passes) */
+    /** Reset RenderPipeline entirely (clears PP + passes) */
     reset: () => void
     /** Re-run setup/main callbacks with current closure values */
     rebuild: () => void
-    /** True when PostProcessing is configured and ready */
+    /** True when RenderPipeline is configured and ready */
     isReady: boolean
   }
 }
@@ -2003,6 +2118,8 @@ declare function Environment(props: EnvironmentProps): react_jsx_runtime.JSX.Ele
 declare function removeInteractivity(store: RootStore, object: Object3D): void;
 declare function createEvents(store: RootStore): {
     handlePointer: (name: string) => (event: DomEvent) => void;
+    flushDeferredPointers: () => void;
+    processDeferredPointer: (event: DomEvent, pointerId: number) => void;
 };
 /** Default R3F event manager for web */
 declare function createPointerEvents(store: RootStore): EventManager<HTMLElement>;
@@ -2582,9 +2699,9 @@ declare function useTextures(): UseTexturesReturn;
  * const fbo = useRenderTarget(512, 256, { samples: 4 })
  * ```
  */
-declare function useRenderTarget(options?: RenderTargetOptions): RenderTarget | WebGLRenderTarget;
-declare function useRenderTarget(size: number, options?: RenderTargetOptions): RenderTarget | WebGLRenderTarget;
-declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): RenderTarget | WebGLRenderTarget;
+declare function useRenderTarget(options?: RenderTargetOptions): WebGLRenderTarget;
+declare function useRenderTarget(size: number, options?: RenderTargetOptions): WebGLRenderTarget;
+declare function useRenderTarget(width: number, height: number, options?: RenderTargetOptions): WebGLRenderTarget;
 
 /**
  * Returns the R3F Canvas' Zustand store. Useful for [transient updates](https://github.com/pmndrs/zustand#transient-updates-for-often-occurring-state-changes).
@@ -4249,4 +4366,4 @@ declare function isOnce(value: unknown): value is {
 declare function Canvas(props: CanvasProps): react_jsx_runtime.JSX.Element;
 
 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, Scheduler, Texture, _roots, act, addAfterEffect, addEffect, addTail, advance, applyProps, attach, buildGraph, calculateDpr, context, createEvents, createPointerEvents, createPortal, createRoot, createStore, detach, diffProps, dispose, createPointerEvents as events, extend, findInitialRoot, flushSync, fromRef, getInstanceProps, getPrimary, getPrimaryIds, getRootState, getScheduler, getUuidPrefix, hasConstructor, hasPrimary, invalidate, invalidateInstance, is, isColorRepresentation, isCopyable, isFromRef, isObject3D, isOnce, isOrthographicCamera, isRef, isRenderer, isTexture, isVectorLike, once, prepare, presetsObj, reconciler, registerPrimary, removeInteractivity, resolve, unmountComponentAtNode, unregisterPrimary, updateCamera, updateFrustum, useBridge, useEnvironment, useFrame, useGraph, useInstanceHandle, useIsomorphicLayoutEffect, useLoader, useMutableCallback, useRenderTarget, useStore, useTexture, useTextures, useThree, waitForPrimary };
-export type { Act, AddPhaseOptions, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameControls, FrameNextCallback, FrameNextControls, FrameNextState, FrameState, FrameTimingState, Frameloop, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, LegacyInternalState as InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeProps, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, LegacyRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootOptions, LegacyRootState as RootState, RootStore, SchedulerApi, SetBlock, Size, Subscription, TSLNodeInput, TextureEntry, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseFrameNextOptions, UseFrameOptions, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager };
+export type { Act, AddPhaseOptions, Args, ArgsProp, AttachFnType, AttachType, BackgroundConfig, BackgroundProp, BaseRendererProps, Bridge, BufferLike, BufferRecord, BufferStore, Camera, CameraProps, CanvasProps, CanvasSchedulerConfig, Catalogue, Color, ComputeFunction, ConstructorRepresentation, DefaultGLProps, DefaultRendererProps, Disposable, DomEvent, Dpr, ElementProps, EnvironmentLoaderProps, EnvironmentProps, EquConfig, Euler, EventHandlers, EventManager, EventProps, Events, Extensions, FiberRoot, FilterFunction, FrameCallback, FrameControls, FrameNextCallback, FrameNextControls, FrameNextState, FrameState, FrameTimingState, Frameloop, GLProps, GLTFLike, GeometryProps, GeometryTransformProps, GlobalEffectType, GlobalRenderCallback, HostConfig, InferLoadResult, InjectState, InputLike, Instance, InstanceProps, LegacyInternalState as InternalState, Intersection, IntersectionEvent, IsAllOptional, IsOptional, Layers, LegacyInternalState, LegacyRenderer, LegacyRootState, LoaderInstance, LoaderLike, LoaderResult, MappedTextureType, MathProps, MathRepresentation, MathType, MathTypes, Matrix3, Matrix4, Mutable, MutableOrReadonlyParameters, NodeProps, NonFunctionKeys, ObjectMap, OffscreenCanvas$1 as OffscreenCanvas, Overwrite, Performance, PointerCaptureTarget, PointerState, PresetsType, PrimaryCanvasEntry, Properties, Quaternion, LegacyRenderer as R3FRenderer, RaycastableRepresentation, ReactProps, ReconcilerRoot, RenderCallback, RenderProps, RenderTargetOptions, Renderer, RendererConfigExtended, RendererFactory, RendererProps, Root, RootOptions, LegacyRootState as RootState, RootStore, SchedulerApi, SetBlock, Size, StorageLike, StorageRecord, StorageStore, Subscription, TSLNodeInput, TextureEntry, ThreeCamera, ThreeElement, ThreeElements, ThreeElementsImpl, ThreeEvent, ThreeExports, ThreeToJSXElements, UnblockProps, UseFrameNextOptions, UseFrameOptions, UseTextureOptions, UseTexturesReturn, Vector2, Vector3, Vector4, VectorRepresentation, Viewport, VisibilityEntry, WebGLDefaultProps, WebGLProps, WebGLShadowConfig, XRManager, XRPointerConfig };