From be4f7bf85fe1fd71ba722e89d34409f3a077302e Mon Sep 17 00:00:00 2001
From: Marc Rousavy <me@mrousavy.com>
Date: Mon, 22 Apr 2024 12:03:00 +0200
Subject: [PATCH] docs: Update Skia docs

---
 package/src/skia/useSkiaFrameProcessor.ts | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/package/src/skia/useSkiaFrameProcessor.ts b/package/src/skia/useSkiaFrameProcessor.ts
index b78e97135c..3feb33630d 100644
--- a/package/src/skia/useSkiaFrameProcessor.ts
+++ b/package/src/skia/useSkiaFrameProcessor.ts
@@ -85,6 +85,21 @@ type SurfaceCache = Record<
  * Also make sure to memoize the returned object, so that the Camera doesn't reset the Frame Processor Context each time.
  *
  * @worklet
+ * @example
+ * ```ts
+ * const surfaceHolder = Worklets.createSharedValue<SurfaceCache>({})
+ * const offscreenTextures = Worklets.createSharedValue<SkImage[]>([])
+ * const frameProcessor = createSkiaFrameProcessor((frame) => {
+ *   'worklet'
+ *   const faces = scanFaces(frame)
+ *
+ *   frame.render()
+ *   for (const face of faces) {
+ *     const rect = Skia.XYWHRect(face.x, face.y, face.width, face.height)
+ *     frame.drawRect(rect)
+ *   }
+ * }, surfaceHolder, offscreenTextures)
+ * ```
  */
 export function createSkiaFrameProcessor(
   frameProcessor: (frame: DrawableFrame) => void,