@react-three/fiber 8.12.2 → 8.13.1

package/dist/declarations/src/web/Canvas.d.ts

@@ -1,11 +1,13 @@
-import * as React from 'react';
-import type { Options as ResizeOptions } from 'react-use-measure';
-import { RenderProps } from '../core';
-export interface Props extends Omit<RenderProps<HTMLCanvasElement>, 'size'>, React.HTMLAttributes<HTMLDivElement> {
-    children: React.ReactNode;
-    fallback?: React.ReactNode;
-    resize?: ResizeOptions;
-    eventSource?: HTMLElement | React.MutableRefObject<HTMLElement>;
-    eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen';
-}
-export declare const Canvas: React.ForwardRefExoticComponent<Props & React.RefAttributes<HTMLCanvasElement>>;
+import * as React from 'react';
+import type { Options as ResizeOptions } from 'react-use-measure';
+import { RenderProps } from '../core';
+export interface CanvasProps extends Omit<RenderProps<HTMLCanvasElement>, 'size'>, React.HTMLAttributes<HTMLDivElement> {
+    children: React.ReactNode;
+    fallback?: React.ReactNode;
+    resize?: ResizeOptions;
+    eventSource?: HTMLElement | React.MutableRefObject<HTMLElement>;
+    eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen';
+}
+export interface Props extends CanvasProps {
+}
+export declare const Canvas: React.ForwardRefExoticComponent<Props & React.RefAttributes<HTMLCanvasElement>>;

package/dist/declarations/src/web/events.d.ts

@@ -1,4 +1,4 @@
-import { UseBoundStore } from 'zustand';
-import { RootState } from '../core/store';
-import { EventManager } from '../core/events';
-export declare function createPointerEvents(store: UseBoundStore<RootState>): EventManager<HTMLElement>;
+import { UseBoundStore } from 'zustand';
+import { RootState } from '../core/store';
+import { EventManager } from '../core/events';
+export declare function createPointerEvents(store: UseBoundStore<RootState>): EventManager<HTMLElement>;

package/dist/{index-21bbaaf9.esm.js → index-13b06ff5.esm.js}

@@ -150,13 +150,7 @@ function createRenderer(_roots, _getEventPriority) {
       }
 
       // Remove references
-      if (child.__r3f) {
-        delete child.__r3f.root;
-        delete child.__r3f.objects;
-        delete child.__r3f.handlers;
-        delete child.__r3f.memoizedProps;
-        if (!isPrimitive) delete child.__r3f;
-      }
+      delete child.__r3f;
 
       // Dispose item whenever the reconciler feels like it
       if (shouldDispose && child.dispose && child.type !== 'Scene') {
@@ -350,6 +344,10 @@ function createRenderer(_roots, _getEventPriority) {
 }
 
 var _window$document, _window$navigator;
+/**
+ * Returns `true` with correct TS type inference if an object has a configurable color space (since r152).
+ */
+const hasColorSpace = object => 'colorSpace' in object || 'outputColorSpace' in object;
 /**
  * The current THREE.ColorManagement instance, if present.
  */
@@ -635,6 +633,21 @@ function applyProps$1(instance, data) {
   if (instance.__r3f) instance.__r3f.memoizedProps = memoized;
   for (let i = 0; i < changes.length; i++) {
     let [key, value, isEvent, keys] = changes[i];
+
+    // Alias (output)encoding => (output)colorSpace (since r152)
+    // https://github.com/pmndrs/react-three-fiber/pull/2829
+    if (hasColorSpace(instance)) {
+      const sRGBEncoding = 3001;
+      const SRGBColorSpace = 'srgb';
+      const LinearSRGBColorSpace = 'srgb-linear';
+      if (key === 'encoding') {
+        key = 'colorSpace';
+        value = value === sRGBEncoding ? SRGBColorSpace : LinearSRGBColorSpace;
+      } else if (key === 'outputEncoding') {
+        key = 'outputColorSpace';
+        value = value === sRGBEncoding ? SRGBColorSpace : LinearSRGBColorSpace;
+      }
+    }
     let currentInstance = instance;
     let targetProp = currentInstance[key];
 
@@ -703,12 +716,14 @@ function applyProps$1(instance, data) {
       // Else, just overwrite the value
     } else {
       currentInstance[key] = value;
+
       // Auto-convert sRGB textures, for now ...
       // https://github.com/pmndrs/react-three-fiber/issues/344
-      if (!rootState.linear && currentInstance[key] instanceof THREE.Texture &&
+      if (currentInstance[key] instanceof THREE.Texture &&
       // sRGB textures must be RGBA8 since r137 https://github.com/mrdoob/three.js/pull/23129
       currentInstance[key].format === THREE.RGBAFormat && currentInstance[key].type === THREE.UnsignedByteType) {
-        currentInstance[key].encoding = THREE.sRGBEncoding;
+        const texture = currentInstance[key];
+        if (hasColorSpace(texture) && hasColorSpace(rootState.gl)) texture.colorSpace = rootState.gl.outputColorSpace;else texture.encoding = rootState.gl.outputEncoding;
       }
     }
     invalidateInstance(instance);
@@ -1185,8 +1200,6 @@ function createEvents(store) {
   };
 }
 
-// Keys that shouldn't be copied between R3F stores
-const privateKeys = ['set', 'get', 'setSize', 'setFrameloop', 'setDpr', 'events', 'invalidate', 'advance', 'size', 'viewport'];
 const isRenderer = def => !!(def != null && def.render);
 const context = /*#__PURE__*/React.createContext(null);
 const createStore = (invalidate, advance) => {
@@ -1888,10 +1901,14 @@ function createRoot(canvas) {
       if (ColorManagement) {
         if ('enabled' in ColorManagement) ColorManagement.enabled = !legacy;else if ('legacyMode' in ColorManagement) ColorManagement.legacyMode = legacy;
       }
-      const outputEncoding = linear ? THREE.LinearEncoding : THREE.sRGBEncoding;
-      const toneMapping = flat ? THREE.NoToneMapping : THREE.ACESFilmicToneMapping;
-      if (gl.outputEncoding !== outputEncoding) gl.outputEncoding = outputEncoding;
-      if (gl.toneMapping !== toneMapping) gl.toneMapping = toneMapping;
+
+      // Set color space and tonemapping preferences
+      const LinearEncoding = 3000;
+      const sRGBEncoding = 3001;
+      applyProps(gl, {
+        outputEncoding: linear ? LinearEncoding : sRGBEncoding,
+        toneMapping: flat ? THREE.NoToneMapping : THREE.ACESFilmicToneMapping
+      });
 
       // Update color management state
       if (state.legacy !== legacy) state.set(() => ({
@@ -2012,7 +2029,6 @@ function unmountComponentAtNode(canvas, callback) {
 }
 function createPortal(children, container, state) {
   return /*#__PURE__*/React.createElement(Portal, {
-    key: container.uuid,
     children: children,
     container: container,
     state: state
@@ -2036,26 +2052,9 @@ function Portal({
   const previousRoot = useStore();
   const [raycaster] = React.useState(() => new THREE.Raycaster());
   const [pointer] = React.useState(() => new THREE.Vector2());
-  const inject = React.useCallback((rootState, injectState) => {
-    const intersect = {
-      ...rootState
-    }; // all prev state props
-
-    // Only the fields of "rootState" that do not differ from injectState
-    // Some props should be off-limits
-    // Otherwise filter out the props that are different and let the inject layer take precedence
-    Object.keys(rootState).forEach(key => {
-      if (
-      // Some props should be off-limits
-      privateKeys.includes(key) ||
-      // Otherwise filter out the props that are different and let the inject layer take precedence
-      // Unless the inject layer props is undefined, then we keep the root layer
-      rootState[key] !== injectState[key] && injectState[key]) {
-        delete intersect[key];
-      }
-    });
-    let viewport = undefined;
-    if (injectState && size) {
+  const inject = useMutableCallback((rootState, injectState) => {
+    let viewport;
+    if (injectState.camera && size) {
       const camera = injectState.camera;
       // Calculate the override viewport, if present
       viewport = rootState.viewport.getCurrentViewport(camera, new THREE.Vector3(), size);
@@ -2064,7 +2063,9 @@ function Portal({
     }
     return {
       // The intersect consists of the previous root state
-      ...intersect,
+      ...rootState,
+      get: injectState.get,
+      set: injectState.set,
       // Portals have their own scene, which forms the root, a raycaster and a pointer
       scene: container,
       raycaster,
@@ -2075,7 +2076,7 @@ function Portal({
       // Events, size and viewport can be overridden by the inject layer
       events: {
         ...rootState.events,
-        ...(injectState == null ? void 0 : injectState.events),
+        ...injectState.events,
         ...events
       },
       size: {
@@ -2086,53 +2087,33 @@ function Portal({
         ...rootState.viewport,
         ...viewport
       },
-      ...rest
-    };
-  }, [state]);
-  const [usePortalStore] = React.useState(() => {
-    // Create a mirrored store, based on the previous root with a few overrides ...
-    const previousState = previousRoot.getState();
-    const store = create((set, get) => ({
-      ...previousState,
-      scene: container,
-      raycaster,
-      pointer,
-      mouse: pointer,
-      previousRoot,
-      events: {
-        ...previousState.events,
-        ...events
-      },
-      size: {
-        ...previousState.size,
-        ...size
-      },
-      ...rest,
-      // Set and get refer to this root-state
-      set,
-      get,
       // Layers are allowed to override events
-      setEvents: events => set(state => ({
+      setEvents: events => injectState.set(state => ({
         ...state,
         events: {
           ...state.events,
           ...events
         }
       }))
-    }));
-    return store;
+    };
   });
-  React.useEffect(() => {
+  const usePortalStore = React.useMemo(() => {
+    const store = create((set, get) => ({
+      ...rest,
+      set,
+      get
+    }));
+
     // Subscribe to previous root-state and copy changes over to the mirrored portal-state
-    const unsub = previousRoot.subscribe(prev => usePortalStore.setState(state => inject(prev, state)));
-    return () => {
-      unsub();
-      usePortalStore.destroy();
-    };
-  }, []);
+    const onMutate = prev => store.setState(state => inject.current(prev, state));
+    onMutate(previousRoot.getState());
+    previousRoot.subscribe(onMutate);
+    return store;
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [previousRoot, container]);
   React.useEffect(() => {
-    usePortalStore.setState(injectState => inject(previousRoot.getState(), injectState));
-  }, [inject]);
+    return () => usePortalStore.destroy();
+  }, [usePortalStore]);
   return /*#__PURE__*/React.createElement(React.Fragment, null, reconciler.createPortal( /*#__PURE__*/React.createElement(context.Provider, {
     value: usePortalStore
   }, children), usePortalStore, null));

package/dist/{index-1fcbd5a8.cjs.prod.js → index-948f4806.cjs.prod.js}

@@ -177,13 +177,7 @@ function createRenderer(_roots, _getEventPriority) {
       }
 
       // Remove references
-      if (child.__r3f) {
-        delete child.__r3f.root;
-        delete child.__r3f.objects;
-        delete child.__r3f.handlers;
-        delete child.__r3f.memoizedProps;
-        if (!isPrimitive) delete child.__r3f;
-      }
+      delete child.__r3f;
 
       // Dispose item whenever the reconciler feels like it
       if (shouldDispose && child.dispose && child.type !== 'Scene') {
@@ -377,6 +371,10 @@ function createRenderer(_roots, _getEventPriority) {
 }
 
 var _window$document, _window$navigator;
+/**
+ * Returns `true` with correct TS type inference if an object has a configurable color space (since r152).
+ */
+const hasColorSpace = object => 'colorSpace' in object || 'outputColorSpace' in object;
 /**
  * The current THREE.ColorManagement instance, if present.
  */
@@ -662,6 +660,21 @@ function applyProps$1(instance, data) {
   if (instance.__r3f) instance.__r3f.memoizedProps = memoized;
   for (let i = 0; i < changes.length; i++) {
     let [key, value, isEvent, keys] = changes[i];
+
+    // Alias (output)encoding => (output)colorSpace (since r152)
+    // https://github.com/pmndrs/react-three-fiber/pull/2829
+    if (hasColorSpace(instance)) {
+      const sRGBEncoding = 3001;
+      const SRGBColorSpace = 'srgb';
+      const LinearSRGBColorSpace = 'srgb-linear';
+      if (key === 'encoding') {
+        key = 'colorSpace';
+        value = value === sRGBEncoding ? SRGBColorSpace : LinearSRGBColorSpace;
+      } else if (key === 'outputEncoding') {
+        key = 'outputColorSpace';
+        value = value === sRGBEncoding ? SRGBColorSpace : LinearSRGBColorSpace;
+      }
+    }
     let currentInstance = instance;
     let targetProp = currentInstance[key];
 
@@ -730,12 +743,14 @@ function applyProps$1(instance, data) {
       // Else, just overwrite the value
     } else {
       currentInstance[key] = value;
+
       // Auto-convert sRGB textures, for now ...
       // https://github.com/pmndrs/react-three-fiber/issues/344
-      if (!rootState.linear && currentInstance[key] instanceof THREE__namespace.Texture &&
+      if (currentInstance[key] instanceof THREE__namespace.Texture &&
       // sRGB textures must be RGBA8 since r137 https://github.com/mrdoob/three.js/pull/23129
       currentInstance[key].format === THREE__namespace.RGBAFormat && currentInstance[key].type === THREE__namespace.UnsignedByteType) {
-        currentInstance[key].encoding = THREE__namespace.sRGBEncoding;
+        const texture = currentInstance[key];
+        if (hasColorSpace(texture) && hasColorSpace(rootState.gl)) texture.colorSpace = rootState.gl.outputColorSpace;else texture.encoding = rootState.gl.outputEncoding;
       }
     }
     invalidateInstance(instance);
@@ -1212,8 +1227,6 @@ function createEvents(store) {
   };
 }
 
-// Keys that shouldn't be copied between R3F stores
-const privateKeys = ['set', 'get', 'setSize', 'setFrameloop', 'setDpr', 'events', 'invalidate', 'advance', 'size', 'viewport'];
 const isRenderer = def => !!(def != null && def.render);
 const context = /*#__PURE__*/React__namespace.createContext(null);
 const createStore = (invalidate, advance) => {
@@ -1915,10 +1928,14 @@ function createRoot(canvas) {
       if (ColorManagement) {
         if ('enabled' in ColorManagement) ColorManagement.enabled = !legacy;else if ('legacyMode' in ColorManagement) ColorManagement.legacyMode = legacy;
       }
-      const outputEncoding = linear ? THREE__namespace.LinearEncoding : THREE__namespace.sRGBEncoding;
-      const toneMapping = flat ? THREE__namespace.NoToneMapping : THREE__namespace.ACESFilmicToneMapping;
-      if (gl.outputEncoding !== outputEncoding) gl.outputEncoding = outputEncoding;
-      if (gl.toneMapping !== toneMapping) gl.toneMapping = toneMapping;
+
+      // Set color space and tonemapping preferences
+      const LinearEncoding = 3000;
+      const sRGBEncoding = 3001;
+      applyProps(gl, {
+        outputEncoding: linear ? LinearEncoding : sRGBEncoding,
+        toneMapping: flat ? THREE__namespace.NoToneMapping : THREE__namespace.ACESFilmicToneMapping
+      });
 
       // Update color management state
       if (state.legacy !== legacy) state.set(() => ({
@@ -2039,7 +2056,6 @@ function unmountComponentAtNode(canvas, callback) {
 }
 function createPortal(children, container, state) {
   return /*#__PURE__*/React__namespace.createElement(Portal, {
-    key: container.uuid,
     children: children,
     container: container,
     state: state
@@ -2063,26 +2079,9 @@ function Portal({
   const previousRoot = useStore();
   const [raycaster] = React__namespace.useState(() => new THREE__namespace.Raycaster());
   const [pointer] = React__namespace.useState(() => new THREE__namespace.Vector2());
-  const inject = React__namespace.useCallback((rootState, injectState) => {
-    const intersect = {
-      ...rootState
-    }; // all prev state props
-
-    // Only the fields of "rootState" that do not differ from injectState
-    // Some props should be off-limits
-    // Otherwise filter out the props that are different and let the inject layer take precedence
-    Object.keys(rootState).forEach(key => {
-      if (
-      // Some props should be off-limits
-      privateKeys.includes(key) ||
-      // Otherwise filter out the props that are different and let the inject layer take precedence
-      // Unless the inject layer props is undefined, then we keep the root layer
-      rootState[key] !== injectState[key] && injectState[key]) {
-        delete intersect[key];
-      }
-    });
-    let viewport = undefined;
-    if (injectState && size) {
+  const inject = useMutableCallback((rootState, injectState) => {
+    let viewport;
+    if (injectState.camera && size) {
       const camera = injectState.camera;
       // Calculate the override viewport, if present
       viewport = rootState.viewport.getCurrentViewport(camera, new THREE__namespace.Vector3(), size);
@@ -2091,7 +2090,9 @@ function Portal({
     }
     return {
       // The intersect consists of the previous root state
-      ...intersect,
+      ...rootState,
+      get: injectState.get,
+      set: injectState.set,
       // Portals have their own scene, which forms the root, a raycaster and a pointer
       scene: container,
       raycaster,
@@ -2102,7 +2103,7 @@ function Portal({
       // Events, size and viewport can be overridden by the inject layer
       events: {
         ...rootState.events,
-        ...(injectState == null ? void 0 : injectState.events),
+        ...injectState.events,
         ...events
       },
       size: {
@@ -2113,53 +2114,33 @@ function Portal({
         ...rootState.viewport,
         ...viewport
       },
-      ...rest
-    };
-  }, [state]);
-  const [usePortalStore] = React__namespace.useState(() => {
-    // Create a mirrored store, based on the previous root with a few overrides ...
-    const previousState = previousRoot.getState();
-    const store = create__default["default"]((set, get) => ({
-      ...previousState,
-      scene: container,
-      raycaster,
-      pointer,
-      mouse: pointer,
-      previousRoot,
-      events: {
-        ...previousState.events,
-        ...events
-      },
-      size: {
-        ...previousState.size,
-        ...size
-      },
-      ...rest,
-      // Set and get refer to this root-state
-      set,
-      get,
       // Layers are allowed to override events
-      setEvents: events => set(state => ({
+      setEvents: events => injectState.set(state => ({
         ...state,
         events: {
           ...state.events,
           ...events
         }
       }))
-    }));
-    return store;
+    };
   });
-  React__namespace.useEffect(() => {
+  const usePortalStore = React__namespace.useMemo(() => {
+    const store = create__default["default"]((set, get) => ({
+      ...rest,
+      set,
+      get
+    }));
+
     // Subscribe to previous root-state and copy changes over to the mirrored portal-state
-    const unsub = previousRoot.subscribe(prev => usePortalStore.setState(state => inject(prev, state)));
-    return () => {
-      unsub();
-      usePortalStore.destroy();
-    };
-  }, []);
+    const onMutate = prev => store.setState(state => inject.current(prev, state));
+    onMutate(previousRoot.getState());
+    previousRoot.subscribe(onMutate);
+    return store;
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [previousRoot, container]);
   React__namespace.useEffect(() => {
-    usePortalStore.setState(injectState => inject(previousRoot.getState(), injectState));
-  }, [inject]);
+    return () => usePortalStore.destroy();
+  }, [usePortalStore]);
   return /*#__PURE__*/React__namespace.createElement(React__namespace.Fragment, null, reconciler.createPortal( /*#__PURE__*/React__namespace.createElement(context.Provider, {
     value: usePortalStore
   }, children), usePortalStore, null));