@objectifthunes/three-book 0.1.5 → 0.2.0

package/dist/textureUtils.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Texture helpers for building book page content from canvas or images.
+ * All utilities are browser-only (require document / URL APIs).
+ */
+import * as THREE from 'three';
+/** How an image is scaled to fit a rectangular area. */
+export type ImageFitMode = 'contain' | 'cover' | 'fill';
+/** Resolved image ready to be passed to createPageTexture. */
+export interface LoadedImage {
+    image: HTMLImageElement;
+    /** Object URL created by URL.createObjectURL — revoke when no longer needed. */
+    objectUrl: string;
+}
+/** Pixels per world unit — used to compute canvas size from page dimensions. */
+export declare const PX_PER_UNIT = 256;
+/**
+ * Draws `image` into a 2D canvas context within the rectangle
+ * (x, y, width, height) using the given fit mode.
+ *
+ * - `'fill'`    — stretches to fill exactly, ignoring aspect ratio
+ * - `'contain'` — scales uniformly to fit inside, letterboxed
+ * - `'cover'`   — scales uniformly to fill, cropping the overflow
+ */
+export declare function drawImageWithFit(ctx: CanvasRenderingContext2D, image: HTMLImageElement, x: number, y: number, width: number, height: number, fit: ImageFitMode): void;
+/**
+ * Creates a `THREE.CanvasTexture` suitable for use as a book page.
+ *
+ * When `pageWidth` and `pageHeight` are given the canvas matches the page
+ * aspect ratio (256 px per world unit).  Otherwise defaults to 512×512.
+ *
+ * - Fills the background with `color`.
+ * - If `image` is provided, draws it using `fitMode` and `fullBleed`.
+ * - Otherwise, renders `label` as centred text (useful for debugging).
+ */
+export declare function createPageTexture(color: string, label: string, image: HTMLImageElement | null, fitMode: ImageFitMode, fullBleed: boolean, pageWidth?: number, pageHeight?: number): THREE.Texture;
+/**
+ * Loads a `File` into an `HTMLImageElement` and returns both the element
+ * and the object URL it was decoded from.
+ *
+ * The caller is responsible for calling `URL.revokeObjectURL(result.objectUrl)`
+ * when the image is no longer needed.
+ *
+ * Returns `null` if `file` is null/undefined or if decoding fails.
+ */
+export declare function loadImage(file: File | null | undefined): Promise<LoadedImage | null>;
+//# sourceMappingURL=textureUtils.d.ts.map

package/dist/textureUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"textureUtils.d.ts","sourceRoot":"","sources":["../src/textureUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAI/B,wDAAwD;AACxD,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,CAAC;AAExD,8DAA8D;AAC9D,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,gBAAgB,CAAC;IACxB,gFAAgF;IAChF,SAAS,EAAE,MAAM,CAAC;CACnB;AAID,gFAAgF;AAChF,eAAO,MAAM,WAAW,MAAM,CAAC;AAI/B;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,wBAAwB,EAC7B,KAAK,EAAE,gBAAgB,EACvB,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,YAAY,GAChB,IAAI,CAkBN;AAID;;;;;;;;;GASG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,gBAAgB,GAAG,IAAI,EAC9B,OAAO,EAAE,YAAY,EACrB,SAAS,EAAE,OAAO,EAClB,SAAS,CAAC,EAAE,MAAM,EAClB,UAAU,CAAC,EAAE,MAAM,GAClB,KAAK,CAAC,OAAO,CA2Bf;AAID;;;;;;;;GAQG;AACH,wBAAsB,SAAS,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,CAmB1F"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@objectifthunes/three-book",
-  "version": "0.1.5",
+  "version": "0.2.0",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",