three-mediapipe-rig 0.1.2 → 0.1.4

package/README.md

@@ -9,15 +9,20 @@ The motion from the webcam will be applied to a skeleton. Angle based so it work
 
 This will run 3 models: face, body, hands. So expect a FPS drop.
 
-Expolore the demos:
-- New! [**MeshCap Editor**](https://github.com/bandinopla/three-mediapipe-rig/blob/main/MESHCAP.md)
-- [Characters](https://bandinopla.github.io/three-mediapipe-rig) 
-- [Hands Demo](https://bandinopla.github.io/three-mediapipe-rig/?demo=hands)
+## Explore the demos:
+- Open the [PoseCap Editor](https://github.com/bandinopla/three-mediapipe-rig/blob/main/POSECAP.md), examples using it:
+	- [Bandinopla chibi](https://bandinopla.github.io/three-mediapipe-rig/?demo=bandinopla-chibi)  ( pose + face )
+- Open the [MeshCap Editor](https://github.com/bandinopla/three-mediapipe-rig/blob/main/MESHCAP.md), examples using it:
+	- [Loading .mcap files](https://bandinopla.github.io/three-mediapipe-rig/?demo=load-meshcap-files)
+	- [Clips with Audio: Memory game](https://bandinopla.github.io/three-mediapipe-rig/?demo=game-youtubers)
+- [Characters](https://bandinopla.github.io/three-mediapipe-rig)  ( pose + hands + face )
+- [Hands Demo](https://bandinopla.github.io/three-mediapipe-rig/?demo=hands) ( pose + hands )
 - [**Video to Face Geometry** !!](https://bandinopla.github.io/three-mediapipe-rig/?demo=face-uv)
 
 ---
 
 ## Table of Contents
+- New! [**PoseCap Editor**](https://github.com/bandinopla/three-mediapipe-rig/blob/main/POSECAP.md)
 - New! [**MeshCap Editor**](https://github.com/bandinopla/three-mediapipe-rig/blob/main/MESHCAP.md)
 - [Features](#features)
 - [Installation](#installation)

package/dist/meshcap/atlas-builder.d.ts

@@ -1,3 +1,4 @@
+import { Texture } from 'three';
 import { MeshCapAtlas, RecordedClip } from './types';
 /**
  * Builds a texture atlas from a list of recorded clips.
@@ -7,4 +8,12 @@ import { MeshCapAtlas, RecordedClip } from './types';
  * @returns The atlas
  */
 export declare function buildMeshCapAtlas(clips: RecordedClip[], atlasSize: number, padding?: number): MeshCapAtlas;
+/**
+ * Load an atlas from a URL or File. If will handle deobfuscation if the file is an .mcapatlas file.
+ * @param atlasSource URL or File of the atlas. If it is an .mcapatlas file, it will be deobfuscated.
+ * @param pass If the atlas is obfuscated, provide the passphrase to deobfuscate it.
+ * @returns
+ */
+export declare function loadMeshcapAtlas(atlasSource: string | File, pass?: string): Promise<Texture<HTMLImageElement>>;
+export declare function obfuscateImage(image: HTMLImageElement, pass: string): Promise<Blob>;
 //# sourceMappingURL=atlas-builder.d.ts.map

package/dist/meshcap/atlas-builder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"atlas-builder.d.ts","sourceRoot":"","sources":["../../src/meshcap/atlas-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAY,YAAY,EAAW,MAAM,SAAS,CAAC;AA0DxE;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAE,KAAK,EAAC,YAAY,EAAE,EAAE,SAAS,EAAC,MAAM,EAAE,OAAO,GAAC,MAAQ,GAAG,YAAY,CAsGzG"}
+{"version":3,"file":"atlas-builder.d.ts","sourceRoot":"","sources":["../../src/meshcap/atlas-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAiB,MAAM,OAAO,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAY,YAAY,EAAW,MAAM,SAAS,CAAC;AAsHxE;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAE,KAAK,EAAC,YAAY,EAAE,EAAE,SAAS,EAAC,MAAM,EAAE,OAAO,GAAC,MAAQ,GAAG,YAAY,CA2HzG;AAmCD;;;;;GAKG;AACH,wBAAsB,gBAAgB,CAAE,WAAW,EAAC,MAAM,GAAC,IAAI,EAAE,IAAI,CAAC,EAAC,MAAM,sCAwC5E;AA+BD,wBAAsB,cAAc,CAAC,KAAK,EAAC,gBAAgB,EAAE,IAAI,EAAC,MAAM,iBAyBvE"}

package/dist/meshcap/audio.d.ts

@@ -0,0 +1,27 @@
+import { MCapClip, RecordedClip } from './types';
+export type AudioSpriteAtlas = {
+    blob: Blob;
+    sprites: ([start: number, duration: number] | undefined)[];
+};
+/**
+ * Will complete the missing audio element on the clips by extracting the audio clip from the atlas.
+ *
+ * @param audioFile The audio file to extract sprites from.
+ * @param clips The clips to extract sprites for.
+ * @returns An array of audio elements, one for each clip ( undefined if no audio sprite is defined for that clip)
+ */
+export declare function extractAudioSprites(audioFile: File | Blob | string | ArrayBuffer, clips: RecordedClip[]): Promise<AudioSpriteAtlas>;
+export declare function audioBufferToWav(buffer: AudioBuffer): ArrayBuffer;
+export type AudioAtlasPlayer = {
+    stopCurrent: () => void;
+    playSprite: (clipIndex: number) => AudioBufferSourceNode | undefined;
+    setVolume: (value: number) => void;
+};
+/**
+ * Creates a player that can play the audio sprites of the clips.
+ * @param audioBuffer The audio buffer that contains the audio for the clips.
+ * @param clips The meshcap clips
+ * @returns A player that can play the audio sprites of the clips.
+ */
+export declare function createAudioAtlasPlayer(audioBuffer: AudioBuffer, clips: MCapClip[]): AudioAtlasPlayer;
+//# sourceMappingURL=audio.d.ts.map

package/dist/meshcap/audio.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"audio.d.ts","sourceRoot":"","sources":["../../src/meshcap/audio.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEjD,MAAM,MAAM,gBAAgB,GAAG;IAC9B,IAAI,EAAC,IAAI,CAAA;IACT,OAAO,EAAE,CAAC,CAAC,KAAK,EAAC,MAAM,EAAE,QAAQ,EAAC,MAAM,CAAC,GAAC,SAAS,CAAC,EAAE,CAAA;CACtD,CAAA;AAmBD;;;;;;GAMG;AACH,wBAAsB,mBAAmB,CAAC,SAAS,EAAC,IAAI,GAAG,IAAI,GAAG,MAAM,GAAG,WAAW,EAAE,KAAK,EAAC,YAAY,EAAE,GAAE,OAAO,CAAC,gBAAgB,CAAC,CA+CtI;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW,CA+BjE;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC9B,WAAW,EAAC,MAAI,IAAI,CAAA;IACpB,UAAU,EAAC,CAAC,SAAS,EAAC,MAAM,KAAG,qBAAqB,GAAC,SAAS,CAAA;IAC9D,SAAS,EAAC,CAAC,KAAK,EAAE,MAAM,KAAG,IAAI,CAAA;CAC/B,CAAA;AAKD;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAE,WAAW,EAAC,WAAW,EAAE,KAAK,EAAC,QAAQ,EAAE,GAAK,gBAAgB,CA+CrG"}

package/dist/meshcap/constants.d.ts

@@ -1,3 +1,10 @@
 export declare const MCAP_MAGIC = 1296253264;
-export declare const MCAP_FILE_VERSION = 1;
+/**
+ * 2 - added audio + timestamps of the frames
+ * 3 - fix: clip's frames length from 1 byte to 2 bytes.
+ * 	   + Also store frame deltas in 2 bytes instead of 1.
+ *     + Made the frameCrop and landmarksCropUVs to be stored as round(v * 10000) instead of round(v * 1000)
+ *     + added face transformation matrices (16 bytes per frame)
+ */
+export declare const MCAP_FILE_VERSION = 3;
 //# sourceMappingURL=constants.d.ts.map

package/dist/meshcap/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/meshcap/constants.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,UAAU,aAAa,CAAC;AACrC,eAAO,MAAM,iBAAiB,IAAI,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/meshcap/constants.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,UAAU,aAAa,CAAC;AAErC;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,IAAI,CAAC"}

package/dist/meshcap/material.d.ts

@@ -1,24 +1,56 @@
 import { Mesh, Texture } from 'three';
 import { MCapClip } from './types';
-import { NodeMaterial } from 'three/webgpu';
+import { Matrix4, NodeMaterial } from 'three/webgpu';
 export type MeshCapMaterialHandler = {
+    /**
+     * 4x4 transformation matrix from MediaPipe Face tracking.
+     * Represents the face pose in camera space (position, rotation, scale).
+     * Can be applied directly to 3D objects to align them with the tracked face.
+     *
+     * Returns the last known face transform matrix.
+     * Everytime you call `update` and the frames get evaluated, this will return the transformMatrix the face has in the
+     * current frame. You can use this to position hats, hair, etc. Remember this transformation is from the face's origin perspective.
+     * So if you do add a hat, make sure the origin point of it is at the same place as the origin point of the face mesh so the rotations look alright.
+     * @returns
+     */
+    getLastKnownFaceTransform: () => Matrix4 | undefined;
+    /**
+     * If it should play a sound or not (if it has one. Default: false )
+     */
+    muted: boolean;
+    /**
+     * This hook will be called everytime a clip starts playing.
+     * @param clipIndex Index of the clip that is starting to play
+     * @param clipStartTime Start time of sound clip withing the sound atlas (in seconds)
+     * @param clipDuration Duration of the clip (in seconds)
+     * @returns
+     */
+    playClipAudioHook?: (clipIndex: number, clipStartTime: number, clipDuration: number) => void;
     /**
      * Moves to a particular clip
      * @param clipIndex The index of the clip to move to
+     * @param _loop Optional: Whether the clip should loop
+     * @param _onEndReached Optional: Callback to be called when the clip reaches the end
      */
-    goto: (clipIndex: number | string, _loop?: boolean) => void;
+    goto: (clipIndex: number | string, _loop?: boolean, _onEndOrLoopReached?: (timeOffset: number) => void, playSound?: boolean) => void;
     /**
      * Play a clip and when it reaches the end, it will loop back
      * @param clipName Name of the clip
      * @returns
      */
-    gotoAndLoop: (clipIndex: number | string) => void;
+    gotoAndLoop: (clipIndex: number | string, _onLoop?: (timeOffset: number) => void) => void;
     /**
      * Play a clip and when it reaches the end, it will not loop back
      * @param clipName Name of the clip
      * @returns
      */
-    gotoAndPlay: (clipIndex: number | string) => void;
+    gotoAndPlay: (clipIndex: number | string, _onEndReached?: () => void) => void;
+    /**
+     * Moves to a particular clip and stops at the first frame
+     * @param clipIndex The index of the clip to move to
+     * @returns
+     */
+    gotoAndStop: (clipIndex: number | string, frame?: number) => void;
     /**
      * Updates the material with the given delta time
      * @param delta The time to add to the current time
@@ -43,11 +75,13 @@ export type MeshCapMaterialHandler = {
 };
 /**
  * Creates or setups a MeshCap material handler (not the material itself) for a given mesh.
- * @param atlasTexture The texture atlas that contains the frames used by the clips
+ *
+ * @param atlasTexture The texture atlas that contains the frames used by the clips. You may need to `flipY=false` on the texture atlas.
  * @param clips The clips previously obtained by loading an .mcap file
  * @param targetMesh The mesh to apply the material to. (It will be updated with a landmarkIndex attribute if it doesn't have one)
  * @param host Optional: The material to use as a base. Defaults to a MeshPhysicalNodeMaterial.
+ * @param audioAtlas Optional: The audio atlas that contains the audio for the clips if you want to let the handler play the audio clips automatically on it's own. Else you will have to hook on the `playClipAudioHook` callback from the returned handler and play them yourself.
  * @returns A handler that allows you to control the material.
  */
-export declare function createMeshCapMaterial(atlasTexture: Texture, clips: MCapClip[], targetMesh: Mesh, host?: NodeMaterial): MeshCapMaterialHandler;
+export declare function createMeshCapMaterial(atlasTexture: Texture, clips: MCapClip[], targetMesh: Mesh, host?: NodeMaterial, audioAtlas?: AudioBuffer): MeshCapMaterialHandler;
 //# sourceMappingURL=material.d.ts.map

package/dist/meshcap/material.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"material.d.ts","sourceRoot":"","sources":["../../src/meshcap/material.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAA4B,YAAY,EAAW,MAAM,cAAc,CAAC;AAM/E,MAAM,MAAM,sBAAsB,GAAG;IAEpC;;;OAGG;IACH,IAAI,EAAC,CAAE,SAAS,EAAC,MAAM,GAAC,MAAM,EAAE,KAAK,CAAC,EAAC,OAAO,KAAI,IAAI,CAAA;IAEtD;;;;OAIG;IACH,WAAW,EAAC,CAAE,SAAS,EAAC,MAAM,GAAC,MAAM,KAAI,IAAI,CAAA;IAE7C;;;;OAIG;IACH,WAAW,EAAC,CAAE,SAAS,EAAC,MAAM,GAAC,MAAM,KAAI,IAAI,CAAA;IAE7C;;;OAGG;IACH,MAAM,EAAC,CAAE,KAAK,EAAC,MAAM,KAAI,IAAI,CAAA;IAE7B;;OAEG;IACH,KAAK,EAAC,QAAQ,EAAE,CAAA;IAEhB;;OAEG;IACH,YAAY,EAAC,OAAO,CAAA;IAEpB;;OAEG;IACH,OAAO,EAAC,YAAY,CAAA;IAEpB;;OAEG;IACH,QAAQ,EAAC,YAAY,CAAA;CACrB,CAAA;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAE,YAAY,EAAC,OAAO,EAAE,KAAK,EAAC,QAAQ,EAAE,EAAE,UAAU,EAAC,IAAI,EAAE,IAAI,CAAC,EAAC,YAAY,GAAG,sBAAsB,CAkN1I"}
+{"version":3,"file":"material.d.ts","sourceRoot":"","sources":["../../src/meshcap/material.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,OAAO,EAA4B,YAAY,EAAW,MAAM,cAAc,CAAC;AAOxF,MAAM,MAAM,sBAAsB,GAAG;IAEpC;;;;;;;;;;OAUG;IACH,yBAAyB,EAAC,MAAI,OAAO,GAAC,SAAS,CAAC;IAEhD;;OAEG;IACH,KAAK,EAAC,OAAO,CAAC;IAEd;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAC,CAAC,SAAS,EAAC,MAAM,EAAE,aAAa,EAAC,MAAM,EAAE,YAAY,EAAC,MAAM,KAAG,IAAI,CAAC;IAGvF;;;;;OAKG;IACH,IAAI,EAAC,CAAE,SAAS,EAAC,MAAM,GAAC,MAAM,EAAE,KAAK,CAAC,EAAC,OAAO,EAAE,mBAAmB,CAAC,EAAC,CAAE,UAAU,EAAC,MAAM,KAAI,IAAI,EAAE,SAAS,CAAC,EAAC,OAAO,KAAI,IAAI,CAAA;IAE5H;;;;OAIG;IACH,WAAW,EAAC,CAAE,SAAS,EAAC,MAAM,GAAC,MAAM,EAAE,OAAO,CAAC,EAAC,CAAE,UAAU,EAAC,MAAM,KAAI,IAAI,KAAI,IAAI,CAAA;IAEnF;;;;OAIG;IACH,WAAW,EAAC,CAAE,SAAS,EAAC,MAAM,GAAC,MAAM,EAAE,aAAa,CAAC,EAAC,MAAI,IAAI,KAAI,IAAI,CAAA;IAEtE;;;;OAIG;IACH,WAAW,EAAC,CAAE,SAAS,EAAC,MAAM,GAAC,MAAM,EAAE,KAAK,CAAC,EAAC,MAAM,KAAI,IAAI,CAAA;IAE5D;;;OAGG;IACH,MAAM,EAAC,CAAE,KAAK,EAAC,MAAM,KAAI,IAAI,CAAA;IAE7B;;OAEG;IACH,KAAK,EAAC,QAAQ,EAAE,CAAA;IAEhB;;OAEG;IACH,YAAY,EAAC,OAAO,CAAA;IAEpB;;OAEG;IACH,OAAO,EAAC,YAAY,CAAA;IAEpB;;OAEG;IACH,QAAQ,EAAC,YAAY,CAAA;CACrB,CAAA;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CAAE,YAAY,EAAC,OAAO,EAAE,KAAK,EAAC,QAAQ,EAAE,EAAE,UAAU,EAAC,IAAI,EAAE,IAAI,CAAC,EAAC,YAAY,EAAE,UAAU,CAAC,EAAC,WAAW,GAAG,sBAAsB,CAmUnK"}

package/dist/meshcap/meshcap.d.ts

@@ -2,4 +2,5 @@ export type * from './types';
 export * from './parse-mcap-file';
 export * from './atlas-builder';
 export * from './material';
+export * from './audio';
 //# sourceMappingURL=meshcap.d.ts.map

package/dist/meshcap/meshcap.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"meshcap.d.ts","sourceRoot":"","sources":["../../src/meshcap/meshcap.ts"],"names":[],"mappings":"AAAA,mBAAmB,SAAS,CAAA;AAC5B,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA"}
+{"version":3,"file":"meshcap.d.ts","sourceRoot":"","sources":["../../src/meshcap/meshcap.ts"],"names":[],"mappings":"AAAA,mBAAmB,SAAS,CAAA;AAC5B,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA;AAC1B,cAAc,SAAS,CAAA"}

package/dist/meshcap/parse-mcap-file.d.ts

@@ -1,8 +1,9 @@
-import { MCapFile } from './types';
+import { MCapFile, MeshCapAtlas } from './types';
 /**
  * Loads a MeshCap (.mcap) file from a URL or File object. This is the file that contains the metadata for the clips.
  * @param mcapFileSource URL or File object
  * @returns
  */
 export declare function loadMeshCapFile(mcapFileSource: string | File): Promise<MCapFile>;
+export declare function readAsMCapFile(atlas: MeshCapAtlas): Promise<MCapFile>;
 //# sourceMappingURL=parse-mcap-file.d.ts.map

package/dist/meshcap/parse-mcap-file.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parse-mcap-file.d.ts","sourceRoot":"","sources":["../../src/meshcap/parse-mcap-file.ts"],"names":[],"mappings":"AACA,OAAO,EAAY,QAAQ,EAAyB,MAAM,SAAS,CAAC;AAOpE;;;;GAIG;AACH,wBAAsB,eAAe,CAAE,cAAc,EAAC,MAAM,GAAC,IAAI,GAAK,OAAO,CAAC,QAAQ,CAAC,CAmBtF"}
+{"version":3,"file":"parse-mcap-file.d.ts","sourceRoot":"","sources":["../../src/meshcap/parse-mcap-file.ts"],"names":[],"mappings":"AACA,OAAO,EAAY,QAAQ,EAAE,YAAY,EAAyB,MAAM,SAAS,CAAC;AAUlF;;;;GAIG;AACH,wBAAsB,eAAe,CAAE,cAAc,EAAC,MAAM,GAAC,IAAI,GAAK,OAAO,CAAC,QAAQ,CAAC,CAmBtF;AAgVD,wBAAsB,cAAc,CAAE,KAAK,EAAC,YAAY,qBAIvD"}

package/dist/meshcap/types.d.ts

@@ -1,4 +1,7 @@
-import { Vector3Like } from 'three';
+import { Mesh, Texture, Vector3Like } from 'three';
+import { AudioSpriteAtlas } from './audio';
+import { MeshCapMaterialHandler } from './material';
+import { Matrix4, NodeMaterial } from 'three/webgpu';
 export interface UVCoord {
     u: number;
     v: number;
@@ -11,18 +14,41 @@ export interface Clip {
     landmarks: Vector3Like[][];
     scale: number;
     aspectRatio: number;
+    audioSprite?: {
+        start: number;
+    };
+    /**
+     * Duration of this clip (in seconds)
+     */
+    duration: number;
 }
+export type FrameBase = {
+    /**
+     * This is the bounding box in atlas UV space in which the landmarks are expressed.
+     */
+    cropUV: UVCoord;
+    startTime: number;
+    /**
+     * The general transformation of the face in this frame.
+     */
+    transformMatrix?: Matrix4;
+};
 export interface RecordedClip extends Clip {
-    frames: {
+    frames: (FrameBase & {
         canvas: HTMLCanvasElement;
-        cropUV: UVCoord;
-    }[];
+    })[];
+    audioSprite?: {
+        domElement?: HTMLAudioElement;
+        /**
+         * Start time in the audio sprite atlas (seconds)
+         */
+        start: number;
+    };
 }
 export interface MCapClip extends Clip {
-    frames: {
-        cropUV: UVCoord;
+    frames: (FrameBase & {
         frameUV: UVCoord;
-    }[];
+    })[];
 }
 export interface MCapFile {
     clips: MCapClip[];
@@ -31,9 +57,21 @@ export interface MCapFile {
     atlasPadding: number;
     /**
      * Extract the clips from the atlas image using the metadata as a guide to know where the clips are.
+     * If the clips use a sound atlas, and one is provided, their audio clips will be reconstructed.
      * @param atlas
      */
-    unpackClips: (atlas: File | string | HTMLImageElement | HTMLCanvasElement) => Promise<RecordedClip[]>;
+    unpackClips: (atlas: File | string | HTMLImageElement | HTMLCanvasElement, audioFile?: File | Blob | string | ArrayBuffer) => Promise<{
+        clips: RecordedClip[];
+        audioAtlas?: AudioSpriteAtlas;
+    }>;
+    /**
+     * Creates a material on the mesh that updates its texture to match the clip frames.
+     * If you pass `audioAtlas`, the handler will play the audio for the clip when it is played.
+     * @param mesh
+     * @param atlasTexture
+     * @returns
+     */
+    createMaterialHandlerOnMesh: (mesh: Mesh, atlasTexture: Texture, host?: NodeMaterial, audioAtlas?: AudioBuffer) => MeshCapMaterialHandler;
 }
 export interface MeshCapAtlas {
     canvas: HTMLCanvasElement;
@@ -46,8 +84,20 @@ export interface MeshCapAtlas {
      */
     padding: number;
     /**
-     *
+     * prefered max atlas dimension
+     */
+    atlasSize: number;
+    /**
+     * Save the cuyrrent meshcap as a .mcap file.
+     * @param downloadFile If true, the file will be downloaded to the user's computer.
+     * @returns
      */
     save(downloadFile: boolean): Promise<Blob>;
+    /**
+     * Triggers a download of the atlas texture
+     * @param phrase Optional phrase to use to perform a simple obfuscation of the texture.
+     * 			If the phrase is not provided, the atlas will not be obfuscated. If you use one, you will have to provide it once again on your app or game when you try to load it calling `createMaterialHandlerOnMesh` by defining the `onAtlasKeyPhraseRequired` hook, which is a functionthat should return the phrase.
+     */
+    saveImageAtlas(phrase?: string, asJpg?: boolean): Promise<void>;
 }
 //# sourceMappingURL=types.d.ts.map

package/dist/meshcap/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/meshcap/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAA;AAInC,MAAM,WAAW,OAAO;IAAE,CAAC,EAAC,MAAM,CAAC;IAAA,CAAC,EAAC,MAAM,CAAC;IAAA,CAAC,EAAC,MAAM,CAAC;IAAA,CAAC,EAAC,MAAM,CAAA;CAAC;AAE9D,MAAM,WAAW,IAAI;IACpB,GAAG,EAAC,MAAM,CAAC;IACX,IAAI,EAAC,MAAM,CAAC;IACZ,SAAS,EAAC,WAAW,EAAE,EAAE,CAAC;IAC1B,KAAK,EAAC,MAAM,CAAA;IACZ,WAAW,EAAC,MAAM,CAAC;CACnB;AAGD,MAAM,WAAW,YAAa,SAAQ,IAAI;IACzC,MAAM,EAAC;QAAE,MAAM,EAAC,iBAAiB,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAE,EAAE,CAAC;CACvD;AAED,MAAM,WAAW,QAAS,SAAQ,IAAI;IACrC,MAAM,EAAE;QAAE,MAAM,EAAC,OAAO,CAAC;QAAC,OAAO,EAAC,OAAO,CAAA;KAAE,EAAE,CAAA;CAC7C;AAED,MAAM,WAAW,QAAQ;IACxB,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAC,MAAM,CAAC;IACjB,YAAY,EAAC,MAAM,CAAC;IAEpB;;;OAGG;IACH,WAAW,EAAE,CAAC,KAAK,EAAC,IAAI,GAAC,MAAM,GAAC,gBAAgB,GAAC,iBAAiB,KAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;CAC7F;AAED,MAAM,WAAW,YAAY;IACzB,MAAM,EAAE,iBAAiB,CAAC;IAE7B;;OAEG;IACA,KAAK,EAAE,QAAQ,EAAE,CAAC;IAErB;;OAEG;IACH,OAAO,EAAC,MAAM,CAAA;IAEd;;OAEG;IACH,IAAI,CAAE,YAAY,EAAC,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC1C"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/meshcap/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAA;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAC1C,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAA;AACnD,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAIpD,MAAM,WAAW,OAAO;IAAE,CAAC,EAAC,MAAM,CAAC;IAAA,CAAC,EAAC,MAAM,CAAC;IAAA,CAAC,EAAC,MAAM,CAAC;IAAA,CAAC,EAAC,MAAM,CAAA;CAAC;AAE9D,MAAM,WAAW,IAAI;IACpB,GAAG,EAAC,MAAM,CAAC;IACX,IAAI,EAAC,MAAM,CAAC;IACZ,SAAS,EAAC,WAAW,EAAE,EAAE,CAAC;IAC1B,KAAK,EAAC,MAAM,CAAA;IACZ,WAAW,EAAC,MAAM,CAAC;IACnB,WAAW,CAAC,EAAC;QACZ,KAAK,EAAC,MAAM,CAAC;KACb,CAAA;IAED;;OAEG;IACH,QAAQ,EAAC,MAAM,CAAA;CACf;AAGD,MAAM,MAAM,SAAS,GAAG;IAEvB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAC,MAAM,CAAC;IAEjB;;OAEG;IACH,eAAe,CAAC,EAAC,OAAO,CAAA;CACxB,CAAA;AAED,MAAM,WAAW,YAAa,SAAQ,IAAI;IACzC,MAAM,EAAC,CAAC,SAAS,GAAG;QACnB,MAAM,EAAC,iBAAiB,CAAC;KACzB,CAAC,EAAE,CAAC;IACL,WAAW,CAAC,EAAC;QACZ,UAAU,CAAC,EAAC,gBAAgB,CAAC;QAE7B;;WAEG;QACH,KAAK,EAAC,MAAM,CAAC;KACb,CAAA;CACD;AAED,MAAM,WAAW,QAAS,SAAQ,IAAI;IACrC,MAAM,EAAE,CAAC,SAAS,GAAG;QACpB,OAAO,EAAC,OAAO,CAAC;KAChB,CAAC,EAAE,CAAA;CACJ;AAED,MAAM,WAAW,QAAQ;IACxB,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAC,MAAM,CAAC;IACjB,YAAY,EAAC,MAAM,CAAC;IAEpB;;;;OAIG;IACH,WAAW,EAAE,CAAC,KAAK,EAAC,IAAI,GAAC,MAAM,GAAC,gBAAgB,GAAC,iBAAiB,EAAE,SAAS,CAAC,EAAC,IAAI,GAAC,IAAI,GAAC,MAAM,GAAC,WAAW,KAAG,OAAO,CAAC;QAAC,KAAK,EAAC,YAAY,EAAE,CAAC;QAAC,UAAU,CAAC,EAAC,gBAAgB,CAAA;KAAC,CAAC,CAAC;IAE5K;;;;;;OAMG;IACH,2BAA2B,EAAE,CAAC,IAAI,EAAC,IAAI,EAAE,YAAY,EAAC,OAAO,EAAE,IAAI,CAAC,EAAC,YAAY,EAAE,UAAU,CAAC,EAAC,WAAW,KAAG,sBAAsB,CAAC;CACpI;AAED,MAAM,WAAW,YAAY;IACzB,MAAM,EAAE,iBAAiB,CAAC;IAE7B;;OAEG;IACA,KAAK,EAAE,QAAQ,EAAE,CAAC;IAErB;;OAEG;IACH,OAAO,EAAC,MAAM,CAAA;IAEd;;OAEG;IACH,SAAS,EAAC,MAAM,CAAA;IAEhB;;;;OAIG;IACH,IAAI,CAAE,YAAY,EAAC,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE1C;;;;OAIG;IACH,cAAc,CAAE,MAAM,CAAC,EAAC,MAAM,EAAE,KAAK,CAAC,EAAC,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC9D"}

package/dist/meshcap/write-mcap-file.d.ts

@@ -1,3 +1,16 @@
 import { MeshCapAtlas } from './types';
+/**
+ * generates an .mcap binary from the atlas
+ * @param atlas
+ * @param useRelativeLandmarks Used internally to save space.
+ * @returns
+ */
 export declare function atlasToMCap(atlas: MeshCapAtlas, useRelativeLandmarks?: boolean): Promise<Blob>;
+/**
+ * generates an .mcap array buffer. Used for simulating ( in the meshcap editor ) opening the file in a real life situation
+ * @param atlas
+ * @param useRelativeLandmarks Used internally to save space.
+ * @returns
+ */
+export declare function atlasToMCapBuffer(atlas: MeshCapAtlas, useRelativeLandmarks?: boolean): Promise<ArrayBuffer>;
 //# sourceMappingURL=write-mcap-file.d.ts.map

package/dist/meshcap/write-mcap-file.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"write-mcap-file.d.ts","sourceRoot":"","sources":["../../src/meshcap/write-mcap-file.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAIvC,wBAAsB,WAAW,CAAC,KAAK,EAAE,YAAY,EAAE,oBAAoB,GAAC,OAAc,iBA2JzF"}
+{"version":3,"file":"write-mcap-file.d.ts","sourceRoot":"","sources":["../../src/meshcap/write-mcap-file.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAIvC;;;;;GAKG;AACH,wBAAsB,WAAW,CAAC,KAAK,EAAE,YAAY,EAAE,oBAAoB,GAAC,OAAc,iBAczF;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CAAC,KAAK,EAAE,YAAY,EAAE,oBAAoB,GAAC,OAAc,wBA4N/F"}