@remotion/three 3.3.54 → 3.3.55

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.
@@ -5,4 +5,8 @@ export declare type ThreeCanvasProps = React.ComponentProps<typeof Canvas> & {
5
5
  height: number;
6
6
  children: React.ReactNode;
7
7
  };
8
+ /**
9
+ * @description A wrapper for React Three Fiber's <Canvas /> which synchronizes with Remotions useCurrentFrame().
10
+ * @see [Documentation](https://www.remotion.dev/docs/three-canvas)
11
+ */
8
12
  export declare const ThreeCanvas: (props: ThreeCanvasProps) => JSX.Element;
@@ -16,6 +16,10 @@ const Scale = ({ width, height }) => {
16
16
  }, [setSize, width, height, set]);
17
17
  return null;
18
18
  };
19
+ /**
20
+ * @description A wrapper for React Three Fiber's <Canvas /> which synchronizes with Remotions useCurrentFrame().
21
+ * @see [Documentation](https://www.remotion.dev/docs/three-canvas)
22
+ */
19
23
  const ThreeCanvas = (props) => {
20
24
  const { children, width, height, style, onCreated, ...rest } = props;
21
25
  const [waitForCreated] = (0, react_1.useState)(() => (0, remotion_1.delayRender)('Waiting for <ThreeCanvas/> to be created'));
@@ -2,4 +2,8 @@ import React from 'react';
2
2
  import type { Video } from 'remotion';
3
3
  import { VideoTexture } from 'three/src/textures/VideoTexture';
4
4
  export declare type UseVideoTextureOptions = React.ComponentProps<typeof Video>;
5
+ /**
6
+ * @description Allows you to use a video in React Three Fiber that is synchronized with Remotion's useCurrentFrame().
7
+ * @see [Documentation](https://www.remotion.dev/docs/use-video-texture)
8
+ */
5
9
  export declare const useVideoTexture: (videoRef: React.RefObject<HTMLVideoElement>) => VideoTexture | null;
@@ -35,6 +35,10 @@ const warnAboutRequestVideoFrameCallback = () => {
35
35
  warned = true;
36
36
  console.warn('Browser does not support requestVideoFrameCallback. Cannot display video.');
37
37
  };
38
+ /**
39
+ * @description Allows you to use a video in React Three Fiber that is synchronized with Remotion's useCurrentFrame().
40
+ * @see [Documentation](https://www.remotion.dev/docs/use-video-texture)
41
+ */
38
42
  const useVideoTexture = (videoRef) => {
39
43
  const [loaded] = (0, react_1.useState)(() => (0, remotion_1.delayRender)(`Waiting for texture in useVideoTexture() to be loaded`));
40
44
  const [videoTexture, setVideoTexture] = (0, react_1.useState)(null);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@remotion/three",
3
- "version": "3.3.54",
3
+ "version": "3.3.55",
4
4
  "description": "Utility functions for using react-three-fiber with remotion",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -20,7 +20,7 @@
20
20
  "url": "https://github.com/remotion-dev/remotion/issues"
21
21
  },
22
22
  "dependencies": {
23
- "remotion": "3.3.54"
23
+ "remotion": "3.3.55"
24
24
  },
25
25
  "peerDependencies": {
26
26
  "@react-three/fiber": ">=8.0.0",
@@ -55,5 +55,5 @@
55
55
  "publishConfig": {
56
56
  "access": "public"
57
57
  },
58
- "gitHead": "3a004e0b0e2a805fb276c35dd5922e3389c9f53c"
58
+ "gitHead": "4cecccc293e9c906c693f55fac65df8f1cfd2338"
59
59
  }