@loaders.gl/textures 3.1.8 → 3.2.0-alpha.1

package/src/lib/parsers/parse-basis.ts

@@ -1,9 +1,36 @@
+/* eslint-disable indent */
+import type {TextureLevel} from '@loaders.gl/schema';
 import {loadBasisEncoderModule, loadBasisTrascoderModule} from './basis-module-loader';
 import {GL_EXTENSIONS_CONSTANTS} from '../gl-extensions';
 import {getSupportedGPUTextureFormats} from '../utils/texture-formats';
 import {isKTX} from './parse-ktx';
 
-const OutputFormat = {
+export type BasisFormat =
+  | 'etc1'
+  | 'etc2'
+  | 'bc1'
+  | 'bc3'
+  | 'bc4'
+  | 'bc5'
+  | 'bc7-m6-opaque-only'
+  | 'bc7-m5'
+  | 'pvrtc1-4-rgb'
+  | 'pvrtc1-4-rgba'
+  | 'astc-4x4'
+  | 'atc-rgb'
+  | 'atc-rgba-interpolated-alpha'
+  | 'rgba32'
+  | 'rgb565'
+  | 'bgr565'
+  | 'rgba4444';
+
+type BasisOutputOptions = {
+  basisFormat: number;
+  compressed: boolean;
+  format?: number;
+};
+
+const OutputFormat: Record<string, BasisOutputOptions> = {
   etc1: {
     basisFormat: 0,
     compressed: true,
@@ -49,11 +76,11 @@ const OutputFormat = {
 
 /**
  * parse data with a Binomial Basis_Universal module
- * @param {ArrayBuffer} data
- * @param {*} options
+ * @param data
+ * @param options
  * @returns compressed texture data
  */
-export default async function parseBasis(data, options) {
+export default async function parseBasis(data: ArrayBuffer, options): Promise<TextureLevel[][]> {
   if (options.basis.containerFormat === 'auto') {
     if (isKTX(data)) {
       const fileConstructors = await loadBasisEncoderModule(options);
@@ -81,25 +108,25 @@ export default async function parseBasis(data, options) {
 
 /**
  * Parse *.basis file data
- * @param {*} BasisFile - initialized transcoder module
- * @param {*} data
- * @param {*} options
+ * @param BasisFile - initialized transcoder module
+ * @param data
+ * @param options
  * @returns compressed texture data
  */
-function parseBasisFile(BasisFile, data, options) {
+function parseBasisFile(BasisFile, data, options): TextureLevel[][] {
   const basisFile = new BasisFile(new Uint8Array(data));
 
   try {
     if (!basisFile.startTranscoding()) {
-      return null;
+      throw new Error('Failed to start basis transcoding');
     }
 
     const imageCount = basisFile.getNumImages();
-    const images: any[] = [];
+    const images: TextureLevel[][] = [];
 
     for (let imageIndex = 0; imageIndex < imageCount; imageIndex++) {
       const levelsCount = basisFile.getNumLevels(imageIndex);
-      const levels: any[] = [];
+      const levels: TextureLevel[] = [];
 
       for (let levelIndex = 0; levelIndex < levelsCount; levelIndex++) {
         levels.push(transcodeImage(basisFile, imageIndex, levelIndex, options));
@@ -117,13 +144,13 @@ function parseBasisFile(BasisFile, data, options) {
 
 /**
  * Parse the particular level image of a basis file
- * @param {*} basisFile
- * @param {*} imageIndex
- * @param {*} levelIndex
- * @param {*} options
+ * @param basisFile
+ * @param imageIndex
+ * @param levelIndex
+ * @param options
  * @returns compressed texture data
  */
-function transcodeImage(basisFile, imageIndex, levelIndex, options) {
+function transcodeImage(basisFile, imageIndex, levelIndex, options): TextureLevel {
   const width = basisFile.getImageWidth(imageIndex, levelIndex);
   const height = basisFile.getImageHeight(imageIndex, levelIndex);
 
@@ -137,7 +164,7 @@ function transcodeImage(basisFile, imageIndex, levelIndex, options) {
   const decodedData = new Uint8Array(decodedSize);
 
   if (!basisFile.transcodeImage(decodedData, imageIndex, levelIndex, basisFormat, 0, 0)) {
-    return null;
+    throw new Error('failed to start Basis transcoding');
   }
 
   return {
@@ -146,37 +173,37 @@ function transcodeImage(basisFile, imageIndex, levelIndex, options) {
     height,
     data: decodedData,
     compressed,
+    format,
 
     // Additional fields
     // Add levelSize field.
-    hasAlpha,
-    format
+    hasAlpha
   };
 }
 
 /**
  * Parse *.ktx2 file data
- * @param {*} KTX2File
- * @param {*} data
- * @param {*} options
+ * @param KTX2File
+ * @param data
+ * @param options
  * @returns compressed texture data
  */
-function parseKTX2File(KTX2File, data, options) {
+function parseKTX2File(KTX2File, data: ArrayBuffer, options): TextureLevel[][] {
   const ktx2File = new KTX2File(new Uint8Array(data));
 
   try {
     if (!ktx2File.startTranscoding()) {
-      return null;
+      throw new Error('failed to start KTX2 transcoding');
     }
     const levelsCount = ktx2File.getLevels();
-    const levels: any[] = [];
+    const levels: TextureLevel[] = [];
 
     for (let levelIndex = 0; levelIndex < levelsCount; levelIndex++) {
       levels.push(transcodeKTX2Image(ktx2File, levelIndex, options));
       break; // texture app can only show one level for some reason
     }
 
-    return levels;
+    return [levels];
   } finally {
     ktx2File.close();
     ktx2File.delete();
@@ -185,12 +212,12 @@ function parseKTX2File(KTX2File, data, options) {
 
 /**
  * Parse the particular level image of a ktx2 file
- * @param {*} ktx2File
- * @param {*} levelIndex
- * @param {*} options
+ * @param ktx2File
+ * @param levelIndex
+ * @param options
  * @returns
  */
-function transcodeKTX2Image(ktx2File, levelIndex, options) {
+function transcodeKTX2Image(ktx2File, levelIndex: number, options): TextureLevel {
   const {alphaFlag, height, width} = ktx2File.getImageLevelInfo(levelIndex, 0, 0);
 
   // Check options for output format etc
@@ -216,7 +243,7 @@ function transcodeKTX2Image(ktx2File, levelIndex, options) {
       -1 /* channel1 */
     )
   ) {
-    return null;
+    throw new Error('Failed to transcode KTX2 image');
   }
 
   return {
@@ -228,18 +255,18 @@ function transcodeKTX2Image(ktx2File, levelIndex, options) {
 
     // Additional fields
     // Add levelSize field.
-    alphaFlag,
+    hasAlpha: alphaFlag,
     format
   };
 }
 
 /**
  * Get BasisFormat by loader format option
- * @param {*} options
- * @param {*} hasAlpha
+ * @param options
+ * @param hasAlpha
  * @returns BasisFormat data
  */
-function getBasisOptions(options, hasAlpha) {
+function getBasisOptions(options, hasAlpha: boolean): BasisOutputOptions {
   let format = options && options.basis && options.basis.format;
   if (format === 'auto') {
     format = selectSupportedBasisFormat();
@@ -255,7 +282,12 @@ function getBasisOptions(options, hasAlpha) {
  * Select transcode format from the list of supported formats
  * @returns key for OutputFormat map
  */
-export function selectSupportedBasisFormat() {
+export function selectSupportedBasisFormat():
+  | BasisFormat
+  | {
+      alpha: BasisFormat;
+      noAlpha: BasisFormat;
+    } {
   const supportedFormats = getSupportedGPUTextureFormats();
   if (supportedFormats.has('astc')) {
     return 'astc-4x4';

package/src/lib/parsers/parse-compressed-texture.ts

@@ -1,4 +1,4 @@
-import type {TextureLevel} from '../../types';
+import type {TextureLevel} from '@loaders.gl/schema';
 import {isKTX, parseKTX} from './parse-ktx';
 import {isDDS, parseDDS} from './parse-dds';
 import {isPVR, parsePVR} from './parse-pvr';

package/src/lib/parsers/parse-crunch.ts

@@ -1,4 +1,4 @@
-import type {TextureLevel} from '../../types';
+import type {TextureLevel} from '@loaders.gl/schema';
 import {loadCrunchModule} from './crunch-module-loader';
 import {GL_EXTENSIONS_CONSTANTS} from '../gl-extensions';
 import {assert} from '@loaders.gl/loader-utils';
@@ -17,19 +17,20 @@ const CRN_FORMAT = {
   // Crunch supports more formats than this.
 };
 
-// Mapping of Crunch formats to DXT formats.
-const DXT_FORMAT_MAP = {};
-DXT_FORMAT_MAP[CRN_FORMAT.cCRNFmtDXT1] = {
-  pixelFormat: GL_EXTENSIONS_CONSTANTS.COMPRESSED_RGB_S3TC_DXT1_EXT,
-  sizeFunction: getDxt1LevelSize
-};
-DXT_FORMAT_MAP[CRN_FORMAT.cCRNFmtDXT3] = {
-  pixelFormat: GL_EXTENSIONS_CONSTANTS.COMPRESSED_RGBA_S3TC_DXT3_EXT,
-  sizeFunction: getDxtXLevelSize
-};
-DXT_FORMAT_MAP[CRN_FORMAT.cCRNFmtDXT5] = {
-  pixelFormat: GL_EXTENSIONS_CONSTANTS.COMPRESSED_RGBA_S3TC_DXT5_EXT,
-  sizeFunction: getDxtXLevelSize
+/** Mapping of Crunch formats to DXT formats. */
+const DXT_FORMAT_MAP = {
+  [CRN_FORMAT.cCRNFmtDXT1]: {
+    pixelFormat: GL_EXTENSIONS_CONSTANTS.COMPRESSED_RGB_S3TC_DXT1_EXT,
+    sizeFunction: getDxt1LevelSize
+  },
+  [CRN_FORMAT.cCRNFmtDXT3]: {
+    pixelFormat: GL_EXTENSIONS_CONSTANTS.COMPRESSED_RGBA_S3TC_DXT3_EXT,
+    sizeFunction: getDxtXLevelSize
+  },
+  [CRN_FORMAT.cCRNFmtDXT5]: {
+    pixelFormat: GL_EXTENSIONS_CONSTANTS.COMPRESSED_RGBA_S3TC_DXT5_EXT,
+    sizeFunction: getDxtXLevelSize
+  }
 };
 
 let cachedDstSize = 0;

package/src/lib/parsers/parse-dds.ts

@@ -1,4 +1,4 @@
-import type {TextureLevel} from '../../types';
+import type {TextureLevel} from '@loaders.gl/schema';
 import {assert} from '@loaders.gl/loader-utils';
 import {GL_EXTENSIONS_CONSTANTS} from '../gl-extensions';
 import {extractMipmapImages} from '../utils/extract-mipmap-images';

package/src/lib/parsers/parse-ktx.ts

@@ -1,3 +1,4 @@
+import type {TextureLevel} from '@loaders.gl/schema';
 import {read} from 'ktx-parse';
 import {extractMipmapImages} from '../utils/extract-mipmap-images';
 import {mapVkFormatToWebGL} from '../utils/ktx-format-helper';
@@ -29,7 +30,7 @@ export function isKTX(data: ArrayBuffer) {
   return !notKTX;
 }
 
-export function parseKTX(arrayBuffer: ArrayBuffer) {
+export function parseKTX(arrayBuffer: ArrayBuffer): TextureLevel[] {
   const uint8Array = new Uint8Array(arrayBuffer);
   const ktx = read(uint8Array);
   const mipMapLevels = Math.max(1, ktx.levels.length);

package/src/lib/parsers/parse-npy.ts

@@ -1,3 +1,5 @@
+// import type {TextureLevel} from '@loaders.gl/schema';
+
 type NumpyHeader = {descr: string; shape: number[]};
 
 function systemIsLittleEndian() {

package/src/lib/parsers/parse-pvr.ts

@@ -1,7 +1,8 @@
-import {TextureLevel} from '../../types';
 /* eslint-disable camelcase */
 // Forked from PicoGL: https://github.com/tsherif/picogl.js/blob/master/examples/utils/utils.js
 // Copyright (c) 2017 Tarek Sherif, The MIT License (MIT)
+
+import type {TextureLevel} from '@loaders.gl/schema';
 import {GL_EXTENSIONS_CONSTANTS} from '../gl-extensions';
 import {extractMipmapImages} from '../utils/extract-mipmap-images';
 

package/src/lib/utils/extract-mipmap-images.ts

@@ -1,4 +1,12 @@
-import {CompressedTextureExtractOptions, TextureLevel} from '../../types';
+import type {TextureLevel} from '@loaders.gl/schema';
+
+export type CompressedTextureExtractOptions = {
+  mipMapLevels: number;
+  width: number;
+  height: number;
+  sizeFunction: Function;
+  internalFormat: number;
+};
 
 /**
  * Extract mipmap images from compressed texture buffer

package/src/lib/utils/texture-formats.ts

@@ -1,4 +1,4 @@
-import type {GPUTextureFormat} from '../../types';
+import type {GPUTextureFormat} from '@loaders.gl/schema';
 
 const BROWSER_PREFIXES = ['', 'WEBKIT_', 'MOZ_'];
 

package/src/lib/utils/version.ts

@@ -1,4 +1,5 @@
 // Version constant cannot be imported, it needs to correspond to the build version of **this** module.
 // __VERSION__ is injected by babel-plugin-version-inline
+// TODO: use 'latest' instead of 'beta' when 3.0.0 version is released as 'latest'
 // @ts-ignore TS2304: Cannot find name '__VERSION__'.
-export const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
+export const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'beta';

package/src/types.ts

@@ -1,30 +0,0 @@
-/**
- * These represent the main compressed texture formats
- * Each format typically has a number of more specific subformats
- */
-export type GPUTextureFormat =
-  | 'dxt'
-  | 'dxt-srgb'
-  | 'etc1'
-  | 'etc2'
-  | 'pvrtc'
-  | 'atc'
-  | 'astc'
-  | 'rgtc';
-
-export interface TextureLevel {
-  compressed: boolean;
-  format: number;
-  data: Uint8Array;
-  witdh: number;
-  height: number;
-  levelSize?: number;
-}
-
-export interface CompressedTextureExtractOptions {
-  mipMapLevels: number;
-  width: number;
-  height: number;
-  sizeFunction: Function;
-  internalFormat: number;
-}