dds-ktx-parser
v1.0.1
Published
Parse image files with DDS and KTX format and decode some of formats to RGB/RGBA array.
Downloads
10
Readme
dds-ktx-parser
HEADER PARSING
Parse .DDS and .KTX files and return ImageInfo about format, mipmaps and shape of image
- [x] DDS file parse
- [X] KTX file parse
On ERROR function will return undefined
interface ImageInfo {
readonly shape: ImageShape // width and height
readonly layers: Array<LayerInfo> // mipmap info
readonly format: ImageFormat // format of image
}
Supported parse Image formats:
- [x] Compressed (BC1, BC2, BC3, BC4, BC5, BC6H, BC7)
- [ ] Raw formats (RGBA, RGB, RG, R) (TODO)
DATA PARSING
Image can be decoded to RGBA Buffer layer by layer without external dependencies (only CPU usage) Supproted decode formats:
- [x] BC1
- [x] BC2
- [x] BC3
- [x] BC4
- [x] BC5
- [X] BC6H
- [X] BC7
- [ ] Raw formats - R, RG, RGB (TODO)
EXAMPLE
import { parseDDSHeader, decodeImage } from './src'
import * as fs from "fs"
const buffer = fs.readFileSync('./tests/resources/dds/bc1.dds')
const imageInfo = parseDDSHeader(buffer)
if (imageInfo) {
const rgbaBuffer = decodeImage(buffer, imageInfo.format, imageInfo.layers[0])
}
const buffer = fs.readFileSync('./tests/resources/ktx/bc1.ktx')
const imageInfo = parseKTXHeader(buffer)
if (imageInfo) {
const rgbaBuffer = decodeImage(buffer, imageInfo.format, imageInfo.layers[0])
}