docs: Update Skia docs

mrousavy · Apr 22, 2024 · be4f7bf · be4f7bf
1 parent 629e23e
commit be4f7bf
Showing 1 changed file with 15 additions and 0 deletions.
diff --git 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,