@bis-toolkit/bcn 1.0.0

package/README.md

@@ -0,0 +1,63 @@
+# @bis-toolkit/bcn
+
+Block Compression (BC1-BC5, BC7) texture decoders for TypeScript.
+
+## Features
+
+- **BC1 (DXT1)**: RGB/RGBA compression with 1-bit alpha
+- **BC2 (DXT3)**: RGBA compression with explicit alpha
+- **BC3 (DXT5)**: RGBA compression with interpolated alpha
+- **BC4**: Single channel compression
+- **BC5**: Two channel compression (normal maps)
+- **BC6H**: HDR compression _(not yet implemented - complex 14-mode HDR format)_
+- **BC7**: High quality RGBA compression
+
+## Installation
+
+```bash
+npm install @bis-toolkit/bcn
+```
+
+## Usage
+
+```typescript
+import { decodeBC1, decodeBC3, decodeBC7 } from '@bis-toolkit/bcn';
+
+// Decode BC7 compressed data
+const rgba = decodeBC7(compressedData, width, height);
+
+// Decode BC1 (DXT1)
+const rgba = decodeBC1(compressedData, width, height);
+
+// Decode BC3 (DXT5)
+const rgba = decodeBC3(compressedData, width, height);
+```
+
+All decoders return a `Uint8Array` containing RGBA data (4 bytes per pixel).
+
+## API
+
+### decodeBC1(data: DataView, width: number, height: number, useAlpha?: boolean): Uint8Array
+### decodeBC2(data: DataView, width: number, height: number): Uint8Array
+### decodeBC3(data: DataView, width: number, height: number): Uint8Array
+### decodeBC4(data: DataView, width: number, height: number, channel?: 'r' | 'g' | 'b' | 'a'): Uint8Array
+### decodeBC5(data: DataView, width: number, height: number, channel1?: 'r' | 'g' | 'b' | 'a', channel2?: 'r' | 'g' | 'b' | 'a'): Uint8Array
+### decodeBC7(data: DataView, width: number, height: number): Uint8Array
+
+**Note:** BC6H (HDR) decoder is not yet implemented due to its complexity (14 modes with signed/unsigned variants).
+
+## Attribution
+
+This library is a direct TypeScript port of [BCnEncoder.NET](https://github.com/Nominom/BCnEncoder.NET), originally created by Nominom and licensed under the MIT License.
+
+```
+Copyright © 2025 Nominom
+Licensed under the MIT License
+```
+
+## License
+
+GPLv3 © Alpine Labs - see [LICENSE](LICENSE).
+
+This work is derived from BCnEncoder.NET (MIT License) and is redistributed under GPLv3.
+

package/dist/bc1.d.ts

@@ -0,0 +1,5 @@
+/**
+ * BC1 (DXT1) Decoder
+ * Source: https://github.com/Nominom/BCnEncoder.NET
+ */
+export declare function decodeBC1(data: DataView, width: number, height: number, useAlpha?: boolean): Uint8Array;

package/dist/bc2.d.ts

@@ -0,0 +1,5 @@
+/**
+ * BC2 (DXT3) Decoder - RGBA with explicit alpha
+ * Source: https://github.com/Nominom/BCnEncoder.NET
+ */
+export declare function decodeBC2(data: DataView, width: number, height: number): Uint8Array;

package/dist/bc3.d.ts

@@ -0,0 +1,5 @@
+/**
+ * BC3 (DXT5) Decoder - RGBA with interpolated alpha
+ * Source: https://github.com/Nominom/BCnEncoder.NET
+ */
+export declare function decodeBC3(data: DataView, width: number, height: number): Uint8Array;

package/dist/bc4.d.ts

@@ -0,0 +1,5 @@
+/**
+ * BC4 Decoder - Single channel compression
+ * Source: https://github.com/Nominom/BCnEncoder.NET
+ */
+export declare function decodeBC4(data: DataView, width: number, height: number, channel?: 'r' | 'g' | 'b' | 'a'): Uint8Array;

package/dist/bc5.d.ts

@@ -0,0 +1,5 @@
+/**
+ * BC5 Decoder - Two channel compression (typically for normal maps)
+ * Source: https://github.com/Nominom/BCnEncoder.NET
+ */
+export declare function decodeBC5(data: DataView, width: number, height: number, channel1?: 'r' | 'g' | 'b' | 'a', channel2?: 'r' | 'g' | 'b' | 'a'): Uint8Array;

package/dist/bc7.d.ts

@@ -0,0 +1,5 @@
+/**
+ * BC7 Decoder - Direct port from BCnEnc.Net
+ * Source: https://github.com/Nominom/BCnEncoder.NET
+ */
+export declare function decodeBC7(imageData: DataView, width: number, height: number): Uint8Array;

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * BCn (BC1-BC7) Texture Decoders
+ * Source: https://github.com/Nominom/BCnEncoder.NET
+ */
+export { decodeBC1 } from './bc1';
+export { decodeBC2 } from './bc2';
+export { decodeBC3 } from './bc3';
+export { decodeBC4 } from './bc4';
+export { decodeBC5 } from './bc5';
+export { decodeBC7 } from './bc7';
+export type { ColorRgba32, ColorRgb24 } from './utils';