Skip to content

Commit

Permalink
migration path
Browse files Browse the repository at this point in the history
  • Loading branch information
abernier committed Dec 5, 2024
1 parent 6b2111a commit 8d6748a
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion docs/controls/face-controls.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,29 @@ export type FaceControlsApi = THREE.EventDispatcher & {
/** <Facemesh> ref api */
facemeshApiRef: RefObject<FacemeshApi>
}
```
```
## Breaking changes
### 9.120.0
<details>
<summary>`FaceControls` was [simplified](https://github.com/pmndrs/drei/pull/2242).</summary>
Following props were deleted:
- `autostart`: now use `videoTexture.start`
- `webcam`: instead of `webcam: false`, you can now [`manualDetect`](http://localhost:6006/?path=/story/controls-facecontrols--face-controls-st-2)
- `webcamVideoTextureSrc`: now use `videoTexture.src` (or instantiate your own video-texture[^1] outside)
- `onVideoFrame`: now use `videoTexture.onVideoFrame` (or instantiate your own video-texture[^1] outside)
Following api methods/fields were deleted:
- `detect`: you can now [`manualDetect`](http://localhost:6006/?path=/story/controls-facecontrols--face-controls-st-2) outside and pass `faceLandmarkerResult`
- `webcamApiRef`: if you need `videoTextureRef`, instantiate your own video-texture[^1] outside
- `play`/`pause`: same, if you need the `video` object, instantiate your own video-texture[^1] outside
[^1]: `<VideoTexture>` or `<WebcamVideoTexture>`
</details>

0 comments on commit 8d6748a

Please sign in to comment.