@renderlayer/textures 0.0.11 → 0.0.14

package/README.md

@@ -1,6 +1,21 @@
 # @renderlayer/textures
 
+Texture abstractions used by `@renderlayer` packages.
+
 [![NPM version][npm-badge]][npm-url]
+[![License][license-badge]][license-url]
+
+## Install
+
+```bash
+npm i @renderlayer/textures
+```
+
+## License
+
+This package is released under the [MIT License][license-url]
 
 [npm-badge]: https://img.shields.io/npm/v/@renderlayer/textures
 [npm-url]: https://www.npmjs.com/package/@renderlayer/textures
+[license-badge]: https://img.shields.io/npm/l/renderlayer.svg?cacheSeconds=2592000
+[license-url]: https://github.com/epreston/renderlayer/blob/main/LICENSE

package/dist/textures.esm-bundler.js

@@ -1,29 +1,31 @@
-import { ImageUtils, ClampToEdgeWrapping, LinearFilter, LinearMipmapLinearFilter, RGBAFormat, UnsignedByteType, NoColorSpace, UVMapping, MirroredRepeatWrapping, RepeatWrapping, CubeReflectionMapping, NearestFilter } from '@renderlayer/shared';
+import { ImageUtils, UVMapping, ClampToEdgeWrapping, LinearFilter, LinearMipmapLinearFilter, RGBAFormat, UnsignedByteType, NoColorSpace, MirroredRepeatWrapping, RepeatWrapping, CubeReflectionMapping, NearestFilter } from '@renderlayer/shared';
 import { EventDispatcher } from '@renderlayer/core';
 import { generateUUID, Vector2, Matrix3 } from '@renderlayer/math';
 
-let _sourceId = 0;
 class Source {
+  #id = _sourceId++;
+  uuid = generateUUID();
+  data;
+  // obj or array
+  version = 0;
   constructor(data = null) {
-    this.isSource = true;
-    Object.defineProperty(this, "id", { value: _sourceId++ });
-    this.uuid = generateUUID();
     this.data = data;
-    this.version = 0;
+  }
+  get isSource() {
+    return true;
+  }
+  get id() {
+    return this.#id;
   }
   set needsUpdate(value) {
-    if (value === true)
-      this.version++;
+    if (value === true) this.version++;
   }
   toJSON(meta) {
     const isRootObject = meta === void 0 || typeof meta === "string";
     if (!isRootObject && meta.images[this.uuid] !== void 0) {
       return meta.images[this.uuid];
     }
-    const output = {
-      uuid: this.uuid,
-      url: ""
-    };
+    const output = { uuid: this.uuid, url: "" };
     const data = this.data;
     if (data !== null) {
       let url;
@@ -31,13 +33,13 @@ class Source {
         url = [];
         for (let i = 0, l = data.length; i < l; i++) {
           if (data[i].isDataTexture) {
-            url.push(serializeImage(data[i].image));
+            url.push(_serializeImage(data[i].image));
           } else {
-            url.push(serializeImage(data[i]));
+            url.push(_serializeImage(data[i]));
           }
         }
       } else {
-        url = serializeImage(data);
+        url = _serializeImage(data);
       }
       output.url = url;
     }
@@ -47,7 +49,8 @@ class Source {
     return output;
   }
 }
-function serializeImage(image) {
+let _sourceId = 0;
+function _serializeImage(image) {
   if (typeof HTMLImageElement !== "undefined" && image instanceof HTMLImageElement || typeof HTMLCanvasElement !== "undefined" && image instanceof HTMLCanvasElement || typeof ImageBitmap !== "undefined" && image instanceof ImageBitmap) {
     return ImageUtils.getDataURL(image);
   } else {
@@ -65,42 +68,63 @@ function serializeImage(image) {
   }
 }
 
-let _textureId = 0;
 class Texture extends EventDispatcher {
+  static DEFAULT_IMAGE = null;
+  static DEFAULT_MAPPING = UVMapping;
+  static DEFAULT_ANISOTROPY = 1;
+  #id = _textureId++;
+  uuid = generateUUID();
+  name = "";
+  source;
+  mipmaps = [];
+  mapping = Texture.DEFAULT_MAPPING;
+  channel = 0;
+  wrapS = ClampToEdgeWrapping;
+  wrapT = ClampToEdgeWrapping;
+  magFilter = LinearFilter;
+  minFilter = LinearMipmapLinearFilter;
+  anisotropy = Texture.DEFAULT_ANISOTROPY;
+  format = RGBAFormat;
+  internalFormat = null;
+  type = UnsignedByteType;
+  offset = new Vector2(0, 0);
+  repeat = new Vector2(1, 1);
+  center = new Vector2(0, 0);
+  rotation = 0;
+  matrixAutoUpdate = true;
+  matrix = new Matrix3();
+  generateMipmaps = true;
+  premultiplyAlpha = false;
+  flipY = true;
+  // valid values: 1, 2, 4, 8
+  // see http://www.khronos.org/opengles/sdk/docs/man/xhtml/glPixelStorei.xml
+  unpackAlignment = 4;
+  colorSpace = NoColorSpace;
+  userData = {};
+  version = 0;
+  onUpdate = null;
+  isRenderTargetTexture = false;
+  // indicates whether this texture should be processed by
+  // PMREMGenerator or not (only relevant for render target textures)
+  needsPMREMUpdate = false;
   constructor(image = Texture.DEFAULT_IMAGE, mapping = Texture.DEFAULT_MAPPING, wrapS = ClampToEdgeWrapping, wrapT = ClampToEdgeWrapping, magFilter = LinearFilter, minFilter = LinearMipmapLinearFilter, format = RGBAFormat, type = UnsignedByteType, anisotropy = Texture.DEFAULT_ANISOTROPY, colorSpace = NoColorSpace) {
     super();
-    Object.defineProperty(this, "id", { value: _textureId++ });
-    this.uuid = generateUUID();
-    this.isTexture = true;
-    this.name = "";
     this.source = new Source(image);
-    this.mipmaps = [];
     this.mapping = mapping;
-    this.channel = 0;
     this.wrapS = wrapS;
     this.wrapT = wrapT;
     this.magFilter = magFilter;
     this.minFilter = minFilter;
     this.anisotropy = anisotropy;
     this.format = format;
-    this.internalFormat = null;
     this.type = type;
-    this.offset = new Vector2(0, 0);
-    this.repeat = new Vector2(1, 1);
-    this.center = new Vector2(0, 0);
-    this.rotation = 0;
-    this.matrixAutoUpdate = true;
-    this.matrix = new Matrix3();
-    this.generateMipmaps = true;
-    this.premultiplyAlpha = false;
-    this.flipY = true;
-    this.unpackAlignment = 4;
     this.colorSpace = colorSpace;
-    this.userData = {};
-    this.version = 0;
-    this.onUpdate = null;
-    this.isRenderTargetTexture = false;
-    this.needsPMREMUpdate = false;
+  }
+  get isTexture() {
+    return true;
+  }
+  get id() {
+    return this.#id;
   }
   get image() {
     return this.source.data;
@@ -108,6 +132,12 @@ class Texture extends EventDispatcher {
   set image(value) {
     this.source.data = value ? value : null;
   }
+  set needsUpdate(value) {
+    if (value === true) {
+      this.version++;
+      this.source.needsUpdate = true;
+    }
+  }
   updateMatrix() {
     this.matrix.setUvTransform(
       this.offset.x,
@@ -186,8 +216,7 @@ class Texture extends EventDispatcher {
       premultiplyAlpha: this.premultiplyAlpha,
       unpackAlignment: this.unpackAlignment
     };
-    if (Object.keys(this.userData).length > 0)
-      output.userData = this.userData;
+    if (Object.keys(this.userData).length > 0) output.userData = this.userData;
     if (!isRootObject) {
       meta.textures[this.uuid] = output;
     }
@@ -198,8 +227,7 @@ class Texture extends EventDispatcher {
   }
   /** @param {Vector2} uv */
   transformUv(uv) {
-    if (this.mapping !== UVMapping)
-      return uv;
+    if (this.mapping !== UVMapping) return uv;
     uv.applyMatrix3(this.matrix);
     if (uv.x < 0 || uv.x > 1) {
       switch (this.wrapS) {
@@ -240,16 +268,45 @@ class Texture extends EventDispatcher {
     }
     return uv;
   }
-  set needsUpdate(value) {
-    if (value === true) {
-      this.version++;
-      this.source.needsUpdate = true;
-    }
+}
+let _textureId = 0;
+
+class CompressedTexture extends Texture {
+  constructor(mipmaps, width, height, format, type, mapping, wrapS, wrapT, magFilter, minFilter, anisotropy, colorSpace) {
+    super(null, mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy, colorSpace);
+    this.image = { width, height };
+    this.mipmaps = mipmaps;
+    this.flipY = false;
+    this.generateMipmaps = false;
+  }
+  get isCompressedTexture() {
+    return true;
+  }
+}
+
+class CompressedArrayTexture extends CompressedTexture {
+  wrapR = ClampToEdgeWrapping;
+  constructor(mipmaps, width, height, depth, format, type) {
+    super(mipmaps, width, height, format, type);
+    this.image.depth = depth;
+  }
+  get isCompressedArrayTexture() {
+    return true;
+  }
+}
+
+class CompressedCubeTexture extends CompressedTexture {
+  constructor(images, format, type) {
+    super(void 0, images[0].width, images[0].height, format, type, CubeReflectionMapping);
+    this.image = images;
+  }
+  get isCompressedCubeTexture() {
+    return true;
+  }
+  get isCubeTexture() {
+    return true;
   }
 }
-Texture.DEFAULT_IMAGE = null;
-Texture.DEFAULT_MAPPING = UVMapping;
-Texture.DEFAULT_ANISOTROPY = 1;
 
 class CubeTexture extends Texture {
   constructor(images = [], mapping = CubeReflectionMapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy, colorSpace) {
@@ -265,9 +322,11 @@ class CubeTexture extends Texture {
       anisotropy,
       colorSpace
     );
-    this.isCubeTexture = true;
     this.flipY = false;
   }
+  get isCubeTexture() {
+    return true;
+  }
   get images() {
     return this.image;
   }
@@ -277,48 +336,53 @@ class CubeTexture extends Texture {
 }
 
 class Data3DTexture extends Texture {
+  wrapR = ClampToEdgeWrapping;
   constructor(data = null, width = 1, height = 1, depth = 1) {
     super(null);
-    this.isData3DTexture = true;
     this.image = { data, width, height, depth };
     this.magFilter = NearestFilter;
     this.minFilter = NearestFilter;
-    this.wrapR = ClampToEdgeWrapping;
     this.generateMipmaps = false;
     this.flipY = false;
     this.unpackAlignment = 1;
   }
+  get isData3DTexture() {
+    return true;
+  }
 }
 
 class DataArrayTexture extends Texture {
+  wrapR = ClampToEdgeWrapping;
   constructor(data = null, width = 1, height = 1, depth = 1) {
     super(null);
-    this.isDataArrayTexture = true;
     this.image = { data, width, height, depth };
     this.magFilter = NearestFilter;
     this.minFilter = NearestFilter;
-    this.wrapR = ClampToEdgeWrapping;
     this.generateMipmaps = false;
     this.flipY = false;
     this.unpackAlignment = 1;
   }
+  get isDataArrayTexture() {
+    return true;
+  }
 }
 
 class DataTexture extends Texture {
   constructor(data = null, width = 1, height = 1, format, type, mapping, wrapS, wrapT, magFilter = NearestFilter, minFilter = NearestFilter, anisotropy, colorSpace) {
     super(null, mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy, colorSpace);
-    this.isDataTexture = true;
     this.image = { data, width, height };
     this.generateMipmaps = false;
     this.flipY = false;
     this.unpackAlignment = 1;
   }
+  get isDataTexture() {
+    return true;
+  }
 }
 
 class VideoTexture extends Texture {
   constructor(video, mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy) {
     super(video, mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy);
-    this.isVideoTexture = true;
     this.minFilter = minFilter !== void 0 ? minFilter : LinearFilter;
     this.magFilter = magFilter !== void 0 ? magFilter : LinearFilter;
     this.generateMipmaps = false;
@@ -331,6 +395,9 @@ class VideoTexture extends Texture {
       video.requestVideoFrameCallback(updateVideo);
     }
   }
+  get isVideoTexture() {
+    return true;
+  }
   /** @returns {this} */
   clone() {
     return new this.constructor(this.image).copy(this);
@@ -344,4 +411,4 @@ class VideoTexture extends Texture {
   }
 }
 
-export { CubeTexture, Data3DTexture, DataArrayTexture, DataTexture, Source, Texture, VideoTexture };
+export { CompressedArrayTexture, CompressedCubeTexture, CompressedTexture, CubeTexture, Data3DTexture, DataArrayTexture, DataTexture, Source, Texture, VideoTexture };

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@renderlayer/textures",
-  "version": "0.0.11",
+  "version": "0.0.14",
   "description": "@renderlayer/textures",
   "module": "./dist/textures.esm-bundler.js",
   "exports": "./dist/textures.esm-bundler.js",
@@ -20,7 +20,9 @@
     "directory": "packages/textures"
   },
   "keywords": [
-    "renderlayer", "textures", "cube"
+    "renderlayer",
+    "textures",
+    "cube"
   ],
   "author": "Ed Preston",
   "license": "MIT",
@@ -29,8 +31,8 @@
   },
   "homepage": "https://github.com/epreston/renderlayer/blob/main/packages/textures#readme",
   "dependencies": {
-    "@renderlayer/core": "~0.0.7",
-    "@renderlayer/math": "~0.0.11",
-    "@renderlayer/shared": "~0.0.6"
+    "@renderlayer/core": "~0.0.9",
+    "@renderlayer/math": "~0.0.15",
+    "@renderlayer/shared": "~0.0.9"
   }
 }