@needle-tools/image-3d 0.0.0-stage → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/LICENSES/README.md +19 -0
- package/LICENSES/mesh-effects-MIT.txt +21 -0
- package/LICENSES/three-MIT.txt +21 -0
- package/README.md +166 -2
- package/dist/img-3d-xuastc.js +825 -0
- package/dist/img-3d.js +574 -0
- package/package.json +66 -4
- package/src/runtime.d.ts +64 -0
package/package.json
CHANGED
|
@@ -1,6 +1,68 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@needle-tools/image-3d",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Interactive 3D images in a single WebP, with native image fallback and a tiny, dependency-free WebGPU/WebGL runtime.",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"license": "MIT",
|
|
7
|
+
"engines": {
|
|
8
|
+
"node": ">=22"
|
|
9
|
+
},
|
|
10
|
+
"repository": {
|
|
11
|
+
"type": "git",
|
|
12
|
+
"url": "git+https://github.com/needle-tools/image-3d.git"
|
|
13
|
+
},
|
|
14
|
+
"sideEffects": [
|
|
15
|
+
"./dist/img-3d.js",
|
|
16
|
+
"./dist/img-3d-xuastc.js"
|
|
17
|
+
],
|
|
18
|
+
"exports": {
|
|
19
|
+
".": {
|
|
20
|
+
"types": "./src/runtime.d.ts",
|
|
21
|
+
"import": "./dist/img-3d.js"
|
|
22
|
+
},
|
|
23
|
+
"./xuastc": {
|
|
24
|
+
"types": "./src/runtime.d.ts",
|
|
25
|
+
"import": "./dist/img-3d-xuastc.js"
|
|
26
|
+
},
|
|
27
|
+
"./package.json": "./package.json"
|
|
28
|
+
},
|
|
29
|
+
"files": [
|
|
30
|
+
"dist/",
|
|
31
|
+
"src/runtime.d.ts",
|
|
32
|
+
"README.md",
|
|
33
|
+
"LICENSES/"
|
|
34
|
+
],
|
|
35
|
+
"scripts": {
|
|
36
|
+
"build": "node scripts/build.mjs",
|
|
37
|
+
"build:demo": "npm run build && node tools/demo.mjs",
|
|
38
|
+
"dev": "npm run build:demo && vite preview --config demo/vite.config.js",
|
|
39
|
+
"convert": "node tools/export.mjs",
|
|
40
|
+
"validate": "node tools/validate.mjs",
|
|
41
|
+
"matrix": "node tools/matrix.mjs",
|
|
42
|
+
"test": "vitest run tests/converter.test.js && node --test --test-concurrency=1 tests/capture-input.test.mjs tests/thumbnail.test.mjs tests/retina-posters.test.mjs tests/camera-motion.test.mjs tests/scene-camera.test.mjs tests/scene.test.mjs tests/browser.test.mjs tests/responsive.test.mjs tests/framing.test.mjs tests/webgpu.test.mjs tests/webgpu-upload.test.mjs tests/lighting.test.mjs tests/antialias.test.mjs tests/studio-quality.test.mjs tests/many-elements.test.mjs tests/xuastc.test.mjs tests/surface-search.test.mjs tests/source-quality.test.mjs tests/demo-state.test.mjs tests/demo.test.mjs tests/native-demo.test.mjs",
|
|
43
|
+
"test:native": "node --test tests/baked.test.mjs",
|
|
44
|
+
"gpu:install": "npm install --no-save webgpu",
|
|
45
|
+
"prepare": "npm run build",
|
|
46
|
+
"prepack": "npm run build",
|
|
47
|
+
"pretest": "npm run build:demo",
|
|
48
|
+
"test:release": "node --test tests/release.test.mjs",
|
|
49
|
+
"check:package": "node scripts/check-package.mjs"
|
|
50
|
+
},
|
|
51
|
+
"devDependencies": {
|
|
52
|
+
"@gltf-transform/core": "4.4.2",
|
|
53
|
+
"@gltf-transform/extensions": "4.4.2",
|
|
54
|
+
"@playwright/test": "1.62.1",
|
|
55
|
+
"esbuild": "0.25.12",
|
|
56
|
+
"sharp": "0.35.5",
|
|
57
|
+
"vite": "6.4.4",
|
|
58
|
+
"vitest": "4.1.10",
|
|
59
|
+
"typescript": "5.9.3",
|
|
60
|
+
"draco3d": "1.5.7",
|
|
61
|
+
"meshoptimizer": "1.2.0",
|
|
62
|
+
"three": "npm:@needle-tools/three@0.186.2-alpha.0"
|
|
63
|
+
},
|
|
64
|
+
"publishConfig": {
|
|
65
|
+
"access": "public",
|
|
66
|
+
"registry": "https://registry.npmjs.org/"
|
|
67
|
+
}
|
|
68
|
+
}
|
package/src/runtime.d.ts
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
/** Registers <img-3d>. Browser-only; static I3D1 captures; experimental format. */
|
|
2
|
+
export declare class Img3d extends HTMLElement {
|
|
3
|
+
static observedAttributes: string[];
|
|
4
|
+
/** Shared renderer usage. WebGPU is preferred (one device; `contexts` counts WebGL contexts only). Entry/byte limits apply to inactive assets; visible assets stay resident. */
|
|
5
|
+
static readonly statistics: { sceneCount:number; sceneRenders:number; backend:'webgpu'|'webgl2'|null; adapter:{vendor:string;architecture:string;description:string;fallback:boolean}|null; devices:number; canvasContexts:number; attachmentBytes:number; environmentBytes:number; validationErrors:number; surfaceCaches:number; surfaceBytes:number; surfaceBuilds:number; surfaceReuses:number; viewRenders:number; contexts:number; assets:number; textureBytes:number; cachedBytes:number; activeAssets:number; inactiveAssets:number; activeTextureBytes:number; inactiveTextureBytes:number; activeCachedBytes:number; inactiveCachedBytes:number; renders:number; decodes:number; pending:number; fetching:number; entries:number; cpuBytes:number; gpuBytes:number };
|
|
6
|
+
/** The single-file capture URL, including data URLs. */
|
|
7
|
+
src: string;
|
|
8
|
+
/** Candidate widths are converter-measured usable frame pixels, not atlas sizes. */
|
|
9
|
+
srcset: string;
|
|
10
|
+
readonly currentSrc: string;
|
|
11
|
+
/** Reflects data-orbit-fit: keep capture framing fixed by default, or opt into auto framing to avoid clipping during orbit. */
|
|
12
|
+
orbitFit: 'auto' | 'fixed';
|
|
13
|
+
readonly naturalWidth: number;
|
|
14
|
+
readonly naturalHeight: number;
|
|
15
|
+
width: number;
|
|
16
|
+
height: number;
|
|
17
|
+
alt: string;
|
|
18
|
+
/** Uploaded texture payload; excludes driver overhead and raster canvases. */
|
|
19
|
+
readonly textureBytes: number;
|
|
20
|
+
readonly textureFormat: string | null;
|
|
21
|
+
readonly transcodeMilliseconds: number;
|
|
22
|
+
/** Live PBR lighting. The optional studio path uses ACES and up to three colored lights; baked captures ignore lighting. Environment data is immutable and shared across elements. */
|
|
23
|
+
get lighting(): {direction: [number,number,number]; intensity: number; ambient: number; lights?: Array<{direction:[number,number,number];color:[number,number,number];intensity:number}>;environment?:Img3dEnvironment;environmentIntensity?:number;environmentRotation?:number;environmentPitch?:number};
|
|
24
|
+
set lighting(value: {direction?: [number, number, number]; intensity?: number; ambient?: number;lights?:Array<{direction:[number,number,number];color?:[number,number,number];intensity?:number}>;environment?:Img3dEnvironment;environmentIntensity?:number;environmentRotation?:number;environmentPitch?:number} | null);
|
|
25
|
+
/** Optional cached soft ground footprint; off by default. Not a ray-traced contact shadow. */
|
|
26
|
+
groundShadow: boolean;
|
|
27
|
+
readonly canvas: HTMLCanvasElement;
|
|
28
|
+
yaw: number;
|
|
29
|
+
pitch: number;
|
|
30
|
+
distance: number;
|
|
31
|
+
/** After load, establish fixed padded framing from captured surface bounds. Does not refit during orbit. */
|
|
32
|
+
fitToBounds(options?: {aspect?:number;fov?:number;padding?:number}): number;
|
|
33
|
+
/** Apply the requested pose immediately, finish camera easing, and allow canvas readback. */
|
|
34
|
+
draw(): Promise<boolean>;
|
|
35
|
+
/** Restore the initial orbit and zoom. */
|
|
36
|
+
reset(): void;
|
|
37
|
+
}
|
|
38
|
+
/** Six octahedral roughness slices followed by a 16×16 BRDF integration table, linear RGBA16F. */
|
|
39
|
+
export interface Img3dEnvironment {size:number;levels:number;data:Uint16Array}
|
|
40
|
+
declare global {
|
|
41
|
+
interface HTMLElementTagNameMap { 'img-3d': Img3d; }
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
/** Registers a trusted application decoder; capture files never provide executable code. */
|
|
45
|
+
export declare function registerImg3dDecoder(decoder: {
|
|
46
|
+
decode(bytes: Uint8Array, target: {width: number; height: number; astc: boolean; bptc: boolean}): Promise<{data: Uint8Array; width: number; height: number; format: string; internalFormat?: number; milliseconds: number}>;
|
|
47
|
+
dispose(): void;
|
|
48
|
+
}): void;
|
|
49
|
+
|
|
50
|
+
/** Enhance a native WebP img/picture using currentSrc and the img's data-orbit-fit attribute; disconnect restores the original image. */
|
|
51
|
+
export declare function enhanceImage(target:HTMLImageElement|HTMLPictureElement):{image:HTMLImageElement;element:Img3d;disconnect():void};
|
|
52
|
+
|
|
53
|
+
export interface Img3dSceneItem {src:string;position:[number,number,number];yaw?:number;scale?:number;opacity?:number}
|
|
54
|
+
export interface Img3dSceneCamera {eye:[number,number,number];target:[number,number,number];fov?:number;fit?:boolean|'width';fitReference?:{eye:[number,number,number];target:[number,number,number]};padding?:number;align?:'center'|'bottom';fog?:{near:number;far:number;opacity:number}}
|
|
55
|
+
/** Experimental shared-camera scenes use the runtime's existing WebGPU device. */
|
|
56
|
+
export declare function createImg3dScene(canvas:HTMLCanvasElement,options?:{lighting?:Partial<Img3d['lighting']>;signal?:AbortSignal}):Promise<{
|
|
57
|
+
load(items:readonly Img3dSceneItem[],options?:{progressive?:boolean;onLoad?:(index:number)=>void;onError?:(index:number,error:unknown)=>void}):Promise<void>;
|
|
58
|
+
setOpacity(index:number,opacity:number):void;
|
|
59
|
+
draw(camera:Img3dSceneCamera|(()=>Img3dSceneCamera)):Promise<boolean>;
|
|
60
|
+
setYaw(index:number,yaw:number):void;
|
|
61
|
+
/** Bounding-box hit in destination canvas pixel coordinates; nearest instance wins. */
|
|
62
|
+
hitTest(x:number,y:number):number;
|
|
63
|
+
dispose():void;
|
|
64
|
+
}>;
|