dxt

README

dxt

DXT decompression library written in Go. It supports DXT1, DXT3 and DXT5 decompression to RGBA

Installation

go get -u github.com/mauserzjeh/dxt

Tests

go test -v

Usage

// import the library
import "github.com/mauserzjeh/dxt"

var dxtBytes []byte
var width uint
var height uint

// ...read the DXT encoded data...
// ...and also obtain the width and height of the image...

// decompress DXT1 to RGBA
rgbaBytes, err := dxt.DecodeDXT1(dxtBytes, width, height)

// or

// decompress DXT3 to RGBA
rgbaBytes, err := dxt.DecodeDXT3(dxtBytes, width, height)

// or

// decompress DXT5 to RGBA
rgbaBytes, err := dxt.DecodeDXT5(dxtBytes, width, height)

// check for errors
if err != nil {
    log.Fatal(err)
}

// rgbaBytes should hold the decompressed RGBA data if no error happened
//             R    G   B    A    R   G    B  ...
// ie. []byte{123, 23, 234, 212, 21, 128, 52, ...}

Documentation

Index

• func DecodeDXT1(input []byte, width, height uint) (output []byte, err error)
• func DecodeDXT3(input []byte, width, height uint) (output []byte, err error)
• func DecodeDXT5(input []byte, width, height uint) (output []byte, err error)

Functions

func DecodeDXT1

func DecodeDXT1(input []byte, width, height uint) (output []byte, err error)

DecodeDXT1 decodes a DXT1 encoded byte slice to a RGBA byte slice

func DecodeDXT3

func DecodeDXT3(input []byte, width, height uint) (output []byte, err error)

DecodeDXT3 decodes a DXT3 encoded byte slice to a RGBA byte slice

func DecodeDXT5

func DecodeDXT5(input []byte, width, height uint) (output []byte, err error)

DecodeDXT5 decodes a DXT5 encoded byte slice to a RGBA byte slice