refactor(pixel): update IPixelBuffer, extract format defs

- make IPixelBuffer fields readonly, expose stride - move all format related defs to /format subdir
thi-ng · Feb 1, 2021 · 3416ff7 · 3416ff7
1 parent 6b5fed9
commit 3416ff7
Show file tree

Hide file tree

Showing 25 changed files with 478 additions and 395 deletions.
diff --git a/packages/pixel/package.json b/packages/pixel/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@thi.ng/pixel",
     "version": "0.6.0",
-    "description": "Typed array backed, packed integer and unpacked floating point pixel buffers w/ customizable formats, blitting, dithering, conversions",
+    "description": "Typed array backed, integer and floating point pixel buffers w/ customizable formats, blitting, dithering, conversions",
     "module": "./index.js",
     "main": "./lib/index.js",
     "umd:main": "./lib/index.umd.js",
@@ -57,7 +57,8 @@
     "files": [
         "*.js",
         "*.d.ts",
-        "lib"
+        "lib",
+        "format"
     ],
     "keywords": [
         "alpha",
@@ -73,6 +74,7 @@
         "datastructure",
         "dither",
         "float",
+        "format",
         "grayscale",
         "image",
         "interval",

diff --git a/packages/pixel/src/api.ts b/packages/pixel/src/api.ts
@@ -206,11 +206,12 @@ export interface RawPixelBuffer extends CanvasContext {
     pixels: Uint32Array;
 }
 
-export interface IPixelBuffer<T extends TypedArray, P> {
-    width: number;
-    height: number;
-    format: IABGRConvert<any>;
-    pixels: T;
+export interface IPixelBuffer<T extends TypedArray = TypedArray, P = any> {
+    readonly width: number;
+    readonly height: number;
+    readonly format: IABGRConvert<any>;
+    readonly stride: number;
+    readonly pixels: T;
 
     /**
      * Returns pixel value at given position. If pos is outside the

diff --git a/packages/pixel/src/float.ts b/packages/pixel/src/float.ts
@@ -9,7 +9,8 @@ import type {
     IPixelBuffer,
     PackedFormat,
 } from "./api";
-import { defFloatFormat, FLOAT_GRAY } from "./format";
+import { defFloatFormat } from "./format/float-format";
+import { FLOAT_GRAY } from "./format/float-gray";
 import { PackedBuffer } from "./packed";
 import { clampRegion, ensureChannel, ensureSize, prepRegions } from "./utils";
 
@@ -49,12 +50,12 @@ export class FloatBuffer implements IPixelBuffer<Float32Array, NumericArray> {
         return dest;
     }
 
-    width: number;
-    height: number;
-    stride: number;
-    rowStride: number;
-    pixels: Float32Array;
-    format: FloatFormat;
+    readonly width: number;
+    readonly height: number;
+    readonly stride: number;
+    readonly rowStride: number;
+    readonly pixels: Float32Array;
+    readonly format: FloatFormat;
     protected __empty: NumericArray;
 
     constructor(