@needle-tools/gltf-progressive 4.0.0-alpha.6 → 4.0.0-alpha.8

package/README.md

@@ -217,3 +217,7 @@ Read more about Needle Progressive GLTF loading in the [Needle Engine documentat
 [Twitter](https://twitter.com/NeedleTools) • 
 [Discord](https://discord.needle.tools) • 
 [Forum](https://forum.needle.tools)
+
+### Renderer types
+
+Progressive loading accepts both WebGLRenderer and initialized WebGPURenderer instances. The exported ProgressiveRenderer type is shared by loader setup, the LOD manager, and plugin callbacks. Initialize a WebGPU renderer before configuring its loaders. Run npm run test:types to verify both public renderer contracts.

package/lib/index.d.ts

@@ -1,10 +1,11 @@
+export type { ProgressiveRenderer } from './renderer.js';
+import type { ProgressiveRenderer } from './renderer.js';
 export { version as VERSION } from "./version.js";
 export * from "./extension.js";
 export * from "./plugins/index.js";
 export { LODsManager, calculateMeshLODLevel, getLODColor, lodDebugColors, type LOD_Results, type MeshLODSelectionOptions, type MeshLODSelectionResult } from "./lods.manager.js";
 export { setDracoDecoderLocation, setKTX2TranscoderLocation, createLoaders, disposeLoaders, addDracoAndKTX2Loaders, configureLoader } from "./loaders.js";
 export { getRaycastMesh, registerRaycastMesh, useRaycastMeshes } from "./utils.js";
-import { WebGLRenderer } from "three";
 import { GLTFLoader } from "three/examples/jsm/loaders/GLTFLoader.js";
 import { SmartLoadingHints } from "./loaders.js";
 declare type UseNeedleGLTFProgressiveOptions = {
@@ -18,5 +19,5 @@ declare type UseNeedleGLTFProgressiveOptions = {
     hints?: Omit<SmartLoadingHints, "progressive">;
 };
 /** @deprecated Use `useNeedleProgressive(loader, renderer)` - this method will be removed in gltf-progressive 4 */
-export declare function useNeedleProgressive(url: string, renderer: WebGLRenderer, loader: GLTFLoader, opts?: UseNeedleGLTFProgressiveOptions): any;
-export declare function useNeedleProgressive(loader: GLTFLoader, renderer: WebGLRenderer, opts?: UseNeedleGLTFProgressiveOptions): any;
+export declare function useNeedleProgressive(url: string, renderer: ProgressiveRenderer, loader: GLTFLoader, opts?: UseNeedleGLTFProgressiveOptions): any;
+export declare function useNeedleProgressive(loader: GLTFLoader, renderer: ProgressiveRenderer, opts?: UseNeedleGLTFProgressiveOptions): any;

package/lib/loaders.d.ts

@@ -1,4 +1,4 @@
-import { WebGLRenderer } from 'three';
+import type { ProgressiveRenderer } from './renderer.js';
 import { DRACOLoader } from 'three/examples/jsm/loaders/DRACOLoader.js';
 import { GLTFLoader } from 'three/examples/jsm/loaders/GLTFLoader.js';
 import { KTX2Loader } from 'three/examples/jsm/loaders/KTX2Loader.js';
@@ -25,7 +25,7 @@ export declare function setKTX2TranscoderLocation(location: string): void;
  * @param renderer - Provide a renderer to detect KTX2 support.
  * @returns The loaders/decoders.
  */
-export declare function createLoaders(renderer: WebGLRenderer | null): {
+export declare function createLoaders(renderer: ProgressiveRenderer | null): {
     dracoLoader: DRACOLoader;
     ktx2Loader: KTX2Loader;
     meshoptDecoder: any;

package/lib/lods.manager.d.ts

@@ -1,4 +1,5 @@
-import { Box3, BufferGeometry, Camera, Color, Material, Matrix4, Object3D, Scene, Texture, Vector3, WebGLRenderer } from "three";
+import type { ProgressiveRenderer } from './renderer.js';
+import { Box3, BufferGeometry, Camera, Color, Material, Matrix4, Object3D, Scene, Texture, Vector3 } from "three";
 import { NEEDLE_progressive_plugin } from "./plugins/plugin.js";
 import { PromiseGroupOptions } from "./lods.promise.js";
 export type LODManagerContext = {
@@ -82,8 +83,8 @@ export declare class LODsManager {
      * @param renderer The renderer to get the LODsManager for.
      * @returns The LODsManager instance.
      */
-    static get(renderer: WebGLRenderer, context?: LODManagerContext): LODsManager;
-    readonly renderer: WebGLRenderer;
+    static get(renderer: ProgressiveRenderer, context?: LODManagerContext): LODsManager;
+    readonly renderer: ProgressiveRenderer;
     private readonly context;
     private readonly projectionScreenMatrix;
     /** @deprecated use static `LODsManager.addPlugin()` method. This getter will be removed in later versions */

package/lib/plugins/plugin.d.ts

@@ -1,13 +1,14 @@
-import { WebGLRenderer, Scene, Camera, Mesh } from 'three';
+import type { ProgressiveRenderer } from '../renderer.js';
+import { Scene, Camera, Mesh } from 'three';
 import { NEEDLE_ext_progressive_mesh } from '../extension.model.js';
 /**
  * This interface is used to define a plugin for the progressive extension. It can be registered using the `registerPlugin` function.
  */
 export interface NEEDLE_progressive_plugin {
     /** Called before the LOD level will be requested/updated for a object */
-    onBeforeUpdateLOD?(renderer: WebGLRenderer, scene: Scene, camera: Camera, object: Mesh): void;
+    onBeforeUpdateLOD?(renderer: ProgressiveRenderer, scene: Scene, camera: Camera, object: Mesh): void;
     /** Called after the LOD level has been requested */
-    onAfterUpdatedLOD?(renderer: WebGLRenderer, scene: Scene, camera: Camera, object: Mesh, level: {
+    onAfterUpdatedLOD?(renderer: ProgressiveRenderer, scene: Scene, camera: Camera, object: Mesh, level: {
         mesh_lod: number;
         texture_lod: number;
     }): void;

package/lib/renderer.d.ts

@@ -0,0 +1,4 @@
+import type { WebGLRenderer } from 'three';
+import type WebGPURenderer from 'three/src/renderers/webgpu/WebGPURenderer.js';
+/** Renderers supported by Progressive loading and LOD updates. */
+export type ProgressiveRenderer = WebGLRenderer | WebGPURenderer;

package/lib/renderer.js

@@ -0,0 +1 @@
+export {};

package/lib/version.js

@@ -1,4 +1,4 @@
 // replaced at build time
-export const version = "4.0.0-alpha.6";
+export const version = "4.0.0-alpha.8";
 globalThis["GLTF_PROGRESSIVE_VERSION"] = version;
 console.debug(`[gltf-progressive] version ${version || "-"}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@needle-tools/gltf-progressive",
-  "version": "4.0.0-alpha.6",
+  "version": "4.0.0-alpha.8",
   "description": "three.js support for loading glTF or GLB files that contain progressive loading data",
   "homepage": "https://needle.tools",
   "author": {
@@ -56,7 +56,7 @@
     }
   },
   "peerDependencies": {
-    "three": ">= 0.183.0"
+    "three": "*"
   },
   "devDependencies": {
     "@needle-tools/engine": "^5.1.0-alpha.6",