@loaders.gl/textures 4.2.0-alpha.4 → 4.2.0-alpha.5

package/dist/basis-loader.js

@@ -1,26 +1,34 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 import { VERSION } from "./lib/utils/version.js";
 import parseBasis from "./lib/parsers/parse-basis.js";
+/**
+ * Worker loader for Basis super compressed textures
+ */
 export const BasisWorkerLoader = {
-  name: 'Basis',
-  id: 'basis',
-  module: 'textures',
-  version: VERSION,
-  worker: true,
-  extensions: ['basis', 'ktx2'],
-  mimeTypes: ['application/octet-stream', 'image/ktx2'],
-  tests: ['sB'],
-  binary: true,
-  options: {
-    basis: {
-      format: 'auto',
-      libraryPath: 'libs/',
-      containerFormat: 'auto',
-      module: 'transcoder'
+    name: 'Basis',
+    id: 'basis',
+    module: 'textures',
+    version: VERSION,
+    worker: true,
+    extensions: ['basis', 'ktx2'],
+    mimeTypes: ['application/octet-stream', 'image/ktx2'],
+    tests: ['sB'],
+    binary: true,
+    options: {
+        basis: {
+            format: 'auto', // gl context doesn't exist on a worker thread
+            libraryPath: 'libs/',
+            containerFormat: 'auto', // 'basis' || 'ktx2' || 'auto'
+            module: 'transcoder' // 'transcoder' || 'encoder'
+        }
     }
-  }
 };
+/**
+ * Loader for Basis super compressed textures
+ */
 export const BasisLoader = {
-  ...BasisWorkerLoader,
-  parse: parseBasis
+    ...BasisWorkerLoader,
+    parse: parseBasis
 };
-//# sourceMappingURL=basis-loader.js.map

package/dist/compressed-texture-loader.js

@@ -1,40 +1,60 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 import { VERSION } from "./lib/utils/version.js";
 import { parseCompressedTexture } from "./lib/parsers/parse-compressed-texture.js";
 import parseBasis from "./lib/parsers/parse-basis.js";
+/**
+ * Worker Loader for KTX, DDS, and PVR texture container formats
+ */
 export const CompressedTextureWorkerLoader = {
-  name: 'Texture Containers',
-  id: 'compressed-texture',
-  module: 'textures',
-  version: VERSION,
-  worker: true,
-  extensions: ['ktx', 'ktx2', 'dds', 'pvr'],
-  mimeTypes: ['image/ktx2', 'image/ktx', 'image/vnd-ms.dds', 'image/x-dds', 'application/octet-stream'],
-  binary: true,
-  options: {
-    'compressed-texture': {
-      libraryPath: 'libs/',
-      useBasis: false
+    name: 'Texture Containers',
+    id: 'compressed-texture',
+    module: 'textures',
+    version: VERSION,
+    worker: true,
+    extensions: [
+        'ktx',
+        'ktx2',
+        'dds', // WEBGL_compressed_texture_s3tc, WEBGL_compressed_texture_atc
+        'pvr' // WEBGL_compressed_texture_pvrtc
+    ],
+    mimeTypes: [
+        'image/ktx2',
+        'image/ktx',
+        'image/vnd-ms.dds',
+        'image/x-dds',
+        'application/octet-stream'
+    ],
+    binary: true,
+    options: {
+        'compressed-texture': {
+            libraryPath: 'libs/',
+            useBasis: false
+        }
     }
-  }
 };
+/**
+ * Loader for KTX, DDS, and PVR texture container formats
+ */
 export const CompressedTextureLoader = {
-  ...CompressedTextureWorkerLoader,
-  parse: async (arrayBuffer, options) => {
-    var _options$compressedT;
-    if (options !== null && options !== void 0 && (_options$compressedT = options['compressed-texture']) !== null && _options$compressedT !== void 0 && _options$compressedT.useBasis) {
-      options.basis = {
-        format: {
-          alpha: 'BC3',
-          noAlpha: 'BC1'
-        },
-        ...options.basis,
-        containerFormat: 'ktx2',
-        module: 'encoder'
-      };
-      const result = await parseBasis(arrayBuffer, options);
-      return result[0];
+    ...CompressedTextureWorkerLoader,
+    parse: async (arrayBuffer, options) => {
+        if (options?.['compressed-texture']?.useBasis) {
+            // @ts-expect-error TODO not allowed to modify inputs
+            options.basis = {
+                format: {
+                    alpha: 'BC3',
+                    noAlpha: 'BC1'
+                },
+                // @ts-expect-error TODO not allowed to modify inputs
+                ...options.basis,
+                containerFormat: 'ktx2',
+                module: 'encoder'
+            };
+            const result = await parseBasis(arrayBuffer, options);
+            return result[0];
+        }
+        return parseCompressedTexture(arrayBuffer);
     }
-    return parseCompressedTexture(arrayBuffer);
-  }
 };
-//# sourceMappingURL=compressed-texture-loader.js.map

package/dist/compressed-texture-writer.js

@@ -1,24 +1,37 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 import { VERSION } from "./lib/utils/version.js";
 import { encodeImageURLToCompressedTextureURL } from "./lib/encoders/encode-texture.js";
+/**
+ * DDS Texture Container Exporter
+ */
 export const CompressedTextureWriter = {
-  name: 'DDS Texture Container',
-  id: 'dds',
-  module: 'textures',
-  version: VERSION,
-  extensions: ['dds'],
-  options: {
-    texture: {
-      format: 'auto',
-      compression: 'auto',
-      quality: 'auto',
-      mipmap: false,
-      flipY: false,
-      toolFlags: ''
+    name: 'DDS Texture Container',
+    id: 'dds',
+    module: 'textures',
+    version: VERSION,
+    extensions: ['dds'],
+    options: {
+        texture: {
+            format: 'auto',
+            compression: 'auto',
+            quality: 'auto',
+            mipmap: false,
+            flipY: false,
+            toolFlags: ''
+        }
+    },
+    encodeURLtoURL: encodeImageURLToCompressedTextureURL,
+    encode() {
+        throw new Error('Not implemented');
     }
-  },
-  encodeURLtoURL: encodeImageURLToCompressedTextureURL,
-  encode() {
-    throw new Error('Not implemented');
-  }
 };
-//# sourceMappingURL=compressed-texture-writer.js.map
+// TYPE TESTS - TODO find a better way than exporting junk
+// export const _TypecheckCompressedTextureWriter: typeof CompressedTextureWriter & {
+//   encodeURLtoURL: (
+//     inputUrl: string,
+//     outputUrl: string,
+//     options?: CompressedTextureWriterOptions
+//   ) => Promise<string>;
+// } = CompressedTextureWriter;

package/dist/crunch-loader.js

@@ -1,17 +1,23 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 import { VERSION } from "./lib/utils/version.js";
+/**
+ * Worker loader for the Crunch compressed texture container format
+ * @note We avoid bundling crunch - it is a rare format and large lib, so we only offer worker loader
+ */
 export const CrunchLoader = {
-  id: 'crunch',
-  name: 'Crunch',
-  module: 'textures',
-  version: VERSION,
-  worker: true,
-  extensions: ['crn'],
-  mimeTypes: ['image/crn', 'image/x-crn', 'application/octet-stream'],
-  binary: true,
-  options: {
-    crunch: {
-      libraryPath: 'libs/'
+    id: 'crunch',
+    name: 'Crunch',
+    module: 'textures',
+    version: VERSION,
+    worker: true,
+    extensions: ['crn'],
+    mimeTypes: ['image/crn', 'image/x-crn', 'application/octet-stream'],
+    binary: true,
+    options: {
+        crunch: {
+            libraryPath: 'libs/'
+        }
     }
-  }
 };
-//# sourceMappingURL=crunch-loader.js.map